Class Node

Hierarchy

{
    $host: string;
    intAsString?: boolean;
    getAccountByPubkey(...args) => Promise<{
        authFun?: string;
        balance: bigint;
        contractId?: string;
        id: string;
        kind?: AccountKind;
        nonce: number;
        payable?: boolean;
    }>;
    getAccountByPubkeyAndHash(...args) => Promise<{
        authFun?: string;
        balance: bigint;
        contractId?: string;
        id: string;
        kind?: AccountKind;
        nonce: number;
        payable?: boolean;
    }>;
    getAccountByPubkeyAndHeight(...args) => Promise<{
        authFun?: string;
        balance: bigint;
        contractId?: string;
        id: string;
        kind?: AccountKind;
        nonce: number;
        payable?: boolean;
    }>;
    getAccountNextNonce(...args) => Promise<{
        nextNonce: number;
    }>;
    getChainEnds(...args) => Promise<{
        body: string[];
    }>;
    getChannelByPubkey(...args) => Promise<{
        channelAmount: bigint;
        channelReserve: bigint;
        delegateIds: { initiator?: string[] | undefined; responder?: string[] | undefined; };
        id: string;
        initiatorAmount: bigint;
        initiatorId: string;
        lockPeriod: string;
        lockedUntil: string;
        responderAmount: bigint;
        responderId: string;
        round: number;
        soloRound: string;
        stateHash: string;
    }>;
    getContract(...args) => Promise<{
        abiVersion: string;
        active: boolean;
        deposit: bigint;
        id: string;
        ownerId: string;
        referrerIds: string[];
        vmVersion: string;
    }>;
    getContractCode(...args) => Promise<{
        bytecode: `cb_${string}`;
    }>;
    getContractPoI(...args) => Promise<{
        poi: string;
    }>;
    getCurrentGeneration(...args) => Promise<{
        keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
        microBlocks: string[];
    }>;
    getCurrentKeyBlock(...args) => Promise<{
        beneficiary: string;
        hash: string;
        height: number;
        info: string;
        miner: string;
        nonce?: number;
        pow?: string[];
        prevHash: string;
        prevKeyHash: string;
        stateHash: string;
        target: string;
        time: number;
        version: number;
    }>;
    getCurrentKeyBlockHash(...args) => Promise<{
        hash: string;
    }>;
    getCurrentKeyBlockHeight(...args) => Promise<{
        height: number;
    }>;
    getGenerationByHash(...args) => Promise<{
        keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
        microBlocks: string[];
    }>;
    getGenerationByHeight(...args) => Promise<{
        keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
        microBlocks: string[];
    }>;
    getKeyBlockByHash(...args) => Promise<{
        beneficiary: string;
        hash: string;
        height: number;
        info: string;
        miner: string;
        nonce?: number;
        pow?: string[];
        prevHash: string;
        prevKeyHash: string;
        stateHash: string;
        target: string;
        time: number;
        version: number;
    }>;
    getKeyBlockByHeight(...args) => Promise<{
        beneficiary: string;
        hash: string;
        height: number;
        info: string;
        miner: string;
        nonce?: number;
        pow?: string[];
        prevHash: string;
        prevKeyHash: string;
        stateHash: string;
        target: string;
        time: number;
        version: number;
    }>;
    getMicroBlockHeaderByHash(...args) => Promise<{
        hash: string;
        height: number;
        pofHash: string;
        prevHash: string;
        prevKeyHash: string;
        signature: string;
        stateHash: string;
        time: number;
        txsHash: string;
        version: number;
    }>;
    getMicroBlockTransactionByHashAndIndex(...args) => Promise<{
        blockHash: string;
        blockHeight: number;
        hash: string;
        signatures: string[];
        tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
    }>;
    getMicroBlockTransactionsByHash(...args) => Promise<{
        transactions: ({ tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...)[];
    }>;
    getMicroBlockTransactionsCountByHash(...args) => Promise<{
        count: string;
    }>;
    getNameEntryByName(...args) => Promise<{
        id: string;
        owner?: string;
        pointers: ({ key: string; id: string; })[];
        ttl: number;
    }>;
    getOracleByPubkey(...args) => Promise<{
        abiVersion: string;
        id: string;
        queryFee: bigint;
        queryFormat: string;
        responseFormat: string;
        ttl: number;
    }>;
    getOracleQueriesByPubkey(...args) => Promise<{
        oracleQueries: ({ id: string; senderId: string; senderNonce: string; oracleId: string; query: string; response: string; ttl: number; responseTtl: { type: TTLType; value: string; }; fee: bigint; })[];
    }>;
    getOracleQueryByPubkeyAndQueryId(...args) => Promise<{
        fee: bigint;
        id: string;
        oracleId: string;
        query: string;
        response: string;
        responseTtl: { type: TTLType; value: string; };
        senderId: string;
        senderNonce: string;
        ttl: number;
    }>;
    getPeerPubkey(...args) => Promise<{
        pubkey: string;
    }>;
    getPendingAccountTransactionsByPubkey(...args) => Promise<{
        transactions: ({ tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...)[];
    }>;
    getPendingKeyBlock(...args) => Promise<{
        beneficiary: string;
        hash: string;
        height: number;
        info: string;
        miner: string;
        nonce?: number;
        pow?: string[];
        prevHash: string;
        prevKeyHash: string;
        stateHash: string;
        target: string;
        time: number;
        version: number;
    }>;
    getStatus(...args) => Promise<{
        difficulty: string;
        genesisKeyBlockHash: string;
        listening: boolean;
        networkId: string;
        nodeRevision: string;
        nodeVersion: string;
        peerConnections: { inbound: number; outbound: number; };
        peerCount: number;
        peerPubkey: string;
        pendingTransactionsCount: number;
        protocols: ({ version: number; effectiveAtHeight: number; })[];
        solutions: number;
        syncProgress?: number;
        syncing: boolean;
        topBlockHeight: number;
        topKeyBlockHash: string;
    }>;
    getTopHeader(...args) => Promise<{
        beneficiary?: string;
        hash: string;
        height: number;
        info?: string;
        miner?: string;
        nonce?: number;
        pofHash?: string;
        pow?: string[];
        prevHash: string;
        prevKeyHash: string;
        signature?: string;
        stateHash: string;
        target?: string;
        time: number;
        txsHash?: string;
        version: number;
    }>;
    getTransactionByHash(...args) => Promise<{
        blockHash: string;
        blockHeight: number;
        hash: string;
        signatures: string[];
        tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
    }>;
    getTransactionInfoByHash(...args) => Promise<{
        callInfo?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; };
        gaInfo?: { callerId: string; height: number; gasPrice: bigint; gasUsed: number; returnValue: string; returnType: GAReturnType; innerObject?: { callInfo?: { callerId: string; callerNonce: string; ... 6 more ...; returnType: ContractCallReturnType; } | undefined; gaInfo?: ... | undefined; txInfo?: string | undefined; } | undef...;
        txInfo?: string;
    }>;
    postTransaction(...args) => Promise<{
        txHash: `th_${string}`;
    }>;
    protectedDryRunTxs(...args) => Promise<{
        results: ({ type: string; result: string; reason?: string | undefined; callObj?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; } | undefined; })[];
        txEvents?: ({ [x: string]: unknown; })[];
    }>;
}
- Node

Index

Constructors

constructor

new Node(url, options?): Node
Parameters
- url: string
  
  Url for node API
- options: NodeOptionalParams & {
      ignoreVersion?: boolean;
      retryCount?: number;
      retryOverallDelay?: number;
  } = {}
  
  Options
Returns Node
Overrides (NodeTransformed as unknown as NodeTransformedApi).constructor
- Defined in Node.ts:123

Properties

$host

$host: string

`Optional` intAsString

intAsString?: boolean

Methods

getAccountByPubkey

getAccountByPubkey(...args): Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>
Get an account by public key
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getAccountByPubkey
- Defined in Node.ts:79

getAccountByPubkeyAndHash

getAccountByPubkeyAndHash(...args): Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>
Get an account by public key after the block indicated by hash. Can be either a micro block or a keyblock hash
Parameters
- Rest ...args: [string, string, ...(undefined | {})[]]
Returns Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getAccountByPubkeyAndHash
- Defined in Node.ts:79

getAccountByPubkeyAndHeight

getAccountByPubkeyAndHeight(...args): Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>
Get an account by public key after the opening key block of the generation at height
Parameters
- Rest ...args: [string, number, ...(undefined | {})[]]
Returns Promise<{
    authFun?: string;
    balance: bigint;
    contractId?: string;
    id: string;
    kind?: AccountKind;
    nonce: number;
    payable?: boolean;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getAccountByPubkeyAndHeight
- Defined in Node.ts:79

getAccountNextNonce

getAccountNextNonce(...args): Promise<{
nextNonce: number;
}>
Get an account's next nonce; This is computed according to whatever is the current account nonce and what transactions are currently present in the transaction pool
Parameters
- Rest ...args: [string, ...(undefined | {
  strategy?: NextNonceStrategy;
  })[]]
Returns Promise<{
nextNonce: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getAccountNextNonce
- Defined in Node.ts:79

getChainEnds

getChainEnds(...args): Promise<{
body: string[];
}>
Get oldest keyblock hashes counting from genesis including orphans
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
body: string[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getChainEnds
- Defined in Node.ts:79

getChannelByPubkey

getChannelByPubkey(...args): Promise<{
    channelAmount: bigint;
    channelReserve: bigint;
    delegateIds: { initiator?: string[] | undefined; responder?: string[] | undefined; };
    id: string;
    initiatorAmount: bigint;
    initiatorId: string;
    lockPeriod: string;
    lockedUntil: string;
    responderAmount: bigint;
    responderId: string;
    round: number;
    soloRound: string;
    stateHash: string;
}>
Get channel by public key
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    channelAmount: bigint;
    channelReserve: bigint;
    delegateIds: { initiator?: string[] | undefined; responder?: string[] | undefined; };
    id: string;
    initiatorAmount: bigint;
    initiatorId: string;
    lockPeriod: string;
    lockedUntil: string;
    responderAmount: bigint;
    responderId: string;
    round: number;
    soloRound: string;
    stateHash: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getChannelByPubkey
- Defined in Node.ts:79

getContract

getContract(...args): Promise<{
    abiVersion: string;
    active: boolean;
    deposit: bigint;
    id: string;
    ownerId: string;
    referrerIds: string[];
    vmVersion: string;
}>
Get a contract by pubkey
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    abiVersion: string;
    active: boolean;
    deposit: bigint;
    id: string;
    ownerId: string;
    referrerIds: string[];
    vmVersion: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getContract
- Defined in Node.ts:79

getContractCode

getContractCode(...args): Promise<{
bytecode: `cb_${string}`;
}>
Get contract code by pubkey
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
bytecode: `cb_${string}`;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getContractCode
- Defined in Node.ts:79

getContractPoI

getContractPoI(...args): Promise<{
poi: string;
}>
Get a proof of inclusion for a contract
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
poi: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getContractPoI
- Defined in Node.ts:79

getCurrentGeneration

getCurrentGeneration(...args): Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>
Get the current generation
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getCurrentGeneration
- Defined in Node.ts:79

getCurrentKeyBlock

getCurrentKeyBlock(...args): Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Get the current key block
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getCurrentKeyBlock
- Defined in Node.ts:79

getCurrentKeyBlockHash

getCurrentKeyBlockHash(...args): Promise<{
hash: string;
}>
Get the hash of the current key block
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
hash: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getCurrentKeyBlockHash
- Defined in Node.ts:79

getCurrentKeyBlockHeight

getCurrentKeyBlockHeight(...args): Promise<{
height: number;
}>
Get the height of the current key block
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
height: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getCurrentKeyBlockHeight
- Defined in Node.ts:79

getGenerationByHash

getGenerationByHash(...args): Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>
Get a generation by hash
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getGenerationByHash
- Defined in Node.ts:79

getGenerationByHeight

getGenerationByHeight(...args): Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>
Get a generation by height
Parameters
- Rest ...args: [number, ...(undefined | {})[]]
Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getGenerationByHeight
- Defined in Node.ts:79

getKeyBlockByHash

getKeyBlockByHash(...args): Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Get a key block by hash
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getKeyBlockByHash
- Defined in Node.ts:79

getKeyBlockByHeight

getKeyBlockByHeight(...args): Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Get a key block by height
Parameters
- Rest ...args: [number, ...(undefined | {})[]]
Returns Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getKeyBlockByHeight
- Defined in Node.ts:79

getMicroBlockHeaderByHash

getMicroBlockHeaderByHash(...args): Promise<{
    hash: string;
    height: number;
    pofHash: string;
    prevHash: string;
    prevKeyHash: string;
    signature: string;
    stateHash: string;
    time: number;
    txsHash: string;
    version: number;
}>
Get a micro block header by hash
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    hash: string;
    height: number;
    pofHash: string;
    prevHash: string;
    prevKeyHash: string;
    signature: string;
    stateHash: string;
    time: number;
    txsHash: string;
    version: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getMicroBlockHeaderByHash
- Defined in Node.ts:79

getMicroBlockTransactionByHashAndIndex

getMicroBlockTransactionByHashAndIndex(...args): Promise<{
    blockHash: string;
    blockHeight: number;
    hash: string;
    signatures: string[];
    tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
}>
Get a micro block transaction by hash and index
Parameters
- Rest ...args: [string, number, ...(undefined | {})[]]
Returns Promise<{
    blockHash: string;
    blockHeight: number;
    hash: string;
    signatures: string[];
    tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getMicroBlockTransactionByHashAndIndex
- Defined in Node.ts:79

getMicroBlockTransactionsByHash

getMicroBlockTransactionsByHash(...args): Promise<{
transactions: ({ tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...)[];
}>
Get micro block transactions by hash
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
transactions: ({ tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...)[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getMicroBlockTransactionsByHash
- Defined in Node.ts:79

getMicroBlockTransactionsCountByHash

getMicroBlockTransactionsCountByHash(...args): Promise<{
count: string;
}>
Get micro block transaction count by hash
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
count: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getMicroBlockTransactionsCountByHash
- Defined in Node.ts:79

getNameEntryByName

getNameEntryByName(...args): Promise<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
}>
Get name entry from naming system
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    id: string;
    owner?: string;
    pointers: ({ key: string; id: string; })[];
    ttl: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getNameEntryByName
- Defined in Node.ts:79

getNetworkId

getNetworkId(): Promise<string>
Returns Promise<string>
- Defined in Node.ts:155

getNodeInfo

getNodeInfo(): Promise<NodeInfo>
Returns Promise<NodeInfo>
- Defined in Node.ts:162

getOracleByPubkey

getOracleByPubkey(...args): Promise<{
    abiVersion: string;
    id: string;
    queryFee: bigint;
    queryFormat: string;
    responseFormat: string;
    ttl: number;
}>
Get an oracle by public key
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    abiVersion: string;
    id: string;
    queryFee: bigint;
    queryFormat: string;
    responseFormat: string;
    ttl: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getOracleByPubkey
- Defined in Node.ts:79

getOracleQueriesByPubkey

getOracleQueriesByPubkey(...args): Promise<{
oracleQueries: ({ id: string; senderId: string; senderNonce: string; oracleId: string; query: string; response: string; ttl: number; responseTtl: { type: TTLType; value: string; }; fee: bigint; })[];
}>
Get oracle queries by public key
Parameters
- Rest ...args: [string, ...(undefined | {
      from?: string;
      limit?: number;
      type?: OracleQueryType;
  })[]]
Returns Promise<{
oracleQueries: ({ id: string; senderId: string; senderNonce: string; oracleId: string; query: string; response: string; ttl: number; responseTtl: { type: TTLType; value: string; }; fee: bigint; })[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getOracleQueriesByPubkey
- Defined in Node.ts:79

getOracleQueryByPubkeyAndQueryId

getOracleQueryByPubkeyAndQueryId(...args): Promise<{
    fee: bigint;
    id: string;
    oracleId: string;
    query: string;
    response: string;
    responseTtl: { type: TTLType; value: string; };
    senderId: string;
    senderNonce: string;
    ttl: number;
}>
Get an oracle query by public key and query ID
Parameters
- Rest ...args: [string, string, ...(undefined | {})[]]
Returns Promise<{
    fee: bigint;
    id: string;
    oracleId: string;
    query: string;
    response: string;
    responseTtl: { type: TTLType; value: string; };
    senderId: string;
    senderNonce: string;
    ttl: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getOracleQueryByPubkeyAndQueryId
- Defined in Node.ts:79

getPeerPubkey

getPeerPubkey(...args): Promise<{
pubkey: string;
}>
Get peer public key
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
pubkey: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getPeerPubkey
- Defined in Node.ts:79

getPendingAccountTransactionsByPubkey

getPendingAccountTransactionsByPubkey(...args): Promise<{
transactions: ({ tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...)[];
}>
Get pending account transactions by public key
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
transactions: ({ tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; }; blockHeight: number; blockHash: string; hash: string; signatures: str...)[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getPendingAccountTransactionsByPubkey
- Defined in Node.ts:79

getPendingKeyBlock

getPendingKeyBlock(...args): Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Get the pending key block
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
    beneficiary: string;
    hash: string;
    height: number;
    info: string;
    miner: string;
    nonce?: number;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    stateHash: string;
    target: string;
    time: number;
    version: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getPendingKeyBlock
- Defined in Node.ts:79

getStatus

getStatus(...args): Promise<{
    difficulty: string;
    genesisKeyBlockHash: string;
    listening: boolean;
    networkId: string;
    nodeRevision: string;
    nodeVersion: string;
    peerConnections: { inbound: number; outbound: number; };
    peerCount: number;
    peerPubkey: string;
    pendingTransactionsCount: number;
    protocols: ({ version: number; effectiveAtHeight: number; })[];
    solutions: number;
    syncProgress?: number;
    syncing: boolean;
    topBlockHeight: number;
    topKeyBlockHash: string;
}>
Get the status of a node
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
    difficulty: string;
    genesisKeyBlockHash: string;
    listening: boolean;
    networkId: string;
    nodeRevision: string;
    nodeVersion: string;
    peerConnections: { inbound: number; outbound: number; };
    peerCount: number;
    peerPubkey: string;
    pendingTransactionsCount: number;
    protocols: ({ version: number; effectiveAtHeight: number; })[];
    solutions: number;
    syncProgress?: number;
    syncing: boolean;
    topBlockHeight: number;
    topKeyBlockHash: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getStatus
- Defined in Node.ts:79

getTopHeader

getTopHeader(...args): Promise<{
    beneficiary?: string;
    hash: string;
    height: number;
    info?: string;
    miner?: string;
    nonce?: number;
    pofHash?: string;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    signature?: string;
    stateHash: string;
    target?: string;
    time: number;
    txsHash?: string;
    version: number;
}>
Get the top header (either key or micro block)
Parameters
- Rest ...args: (undefined | {})[]
Returns Promise<{
    beneficiary?: string;
    hash: string;
    height: number;
    info?: string;
    miner?: string;
    nonce?: number;
    pofHash?: string;
    pow?: string[];
    prevHash: string;
    prevKeyHash: string;
    signature?: string;
    stateHash: string;
    target?: string;
    time: number;
    txsHash?: string;
    version: number;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getTopHeader
- Defined in Node.ts:79

getTransactionByHash

getTransactionByHash(...args): Promise<{
    blockHash: string;
    blockHeight: number;
    hash: string;
    signatures: string[];
    tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
}>
Get a transaction by hash
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    blockHash: string;
    blockHeight: number;
    hash: string;
    signatures: string[];
    tx: { type: "Tx"; recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 53 more ...; version: number; };
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getTransactionByHash
- Defined in Node.ts:79

getTransactionInfoByHash

getTransactionInfoByHash(...args): Promise<{
    callInfo?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; };
    gaInfo?: { callerId: string; height: number; gasPrice: bigint; gasUsed: number; returnValue: string; returnType: GAReturnType; innerObject?: { callInfo?: { callerId: string; callerNonce: string; ... 6 more ...; returnType: ContractCallReturnType; } | undefined; gaInfo?: ... | undefined; txInfo?: string | undefined; } | undef...;
    txInfo?: string;
}>
Parameters
- Rest ...args: [string, ...(undefined | {})[]]
Returns Promise<{
    callInfo?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; };
    gaInfo?: { callerId: string; height: number; gasPrice: bigint; gasUsed: number; returnValue: string; returnType: GAReturnType; innerObject?: { callInfo?: { callerId: string; callerNonce: string; ... 6 more ...; returnType: ContractCallReturnType; } | undefined; gaInfo?: ... | undefined; txInfo?: string | undefined; } | undef...;
    txInfo?: string;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).getTransactionInfoByHash
- Defined in Node.ts:79

postTransaction

postTransaction(...args): Promise<{
txHash: `th_${string}`;
}>
Post a new transaction
Parameters
- Rest ...args: [{
  tx: string;
  }, ...(undefined | {})[]]
Returns Promise<{
txHash: `th_${string}`;
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).postTransaction
- Defined in Node.ts:79

protectedDryRunTxs

protectedDryRunTxs(...args): Promise<{
results: ({ type: string; result: string; reason?: string | undefined; callObj?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; } | undefined; })[];
txEvents?: ({ [x: string]: unknown; })[];
}>
Dry-run transactions on top of a given block. Supports all TXs except GAMetaTx, PayingForTx and OffchainTx. The maximum gas limit of all calls is capped. The maximum gas limit per request is a global node setting. Since DryRunCallReq object do not have a mandatory gas field, if not set a default value of 1000000 is being used instead.
Parameters
- Rest ...args: [{
      accounts?: ({ pubKey: string; amount: bigint; })[];
      top?: string;
      txEvents?: boolean;
      txs: ({ tx?: string | undefined; callReq?: { calldata: string; contract: string; amount?: bigint | undefined; gas?: number | undefined; caller?: string | undefined; nonce?: number | undefined; abiVersion?: string | undefined; context?: { ...; } | undefined; } | undefined; })[];
  }, ...(undefined | {})[]]
Returns Promise<{
results: ({ type: string; result: string; reason?: string | undefined; callObj?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; } | undefined; })[];
txEvents?: ({ [x: string]: unknown; })[];
}>
Inherited from (NodeTransformed as unknown as NodeTransformedApi).protectedDryRunTxs
- Defined in Node.ts:79

Class Node

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string

options: NodeOptionalParams & { ignoreVersion?: boolean; retryCount?: number; retryOverallDelay?: number; } = {}

Returns Node

Properties

$host

Optional intAsString

Methods

getAccountByPubkey

Parameters

Rest ...args: [string, ...(undefined | {})[]]

Returns Promise<{ authFun?: string; balance: bigint; contractId?: string; id: string; kind?: AccountKind; nonce: number; payable?: boolean; }>

getAccountByPubkeyAndHash

Parameters

Rest ...args: [string, string, ...(undefined | {})[]]

Returns Promise<{ authFun?: string; balance: bigint; contractId?: string; id: string; kind?: AccountKind; nonce: number; payable?: boolean; }>

getAccountByPubkeyAndHeight

Parameters

Rest ...args: [string, number, ...(undefined | {})[]]

Returns Promise<{ authFun?: string; balance: bigint; contractId?: string; id: string; kind?: AccountKind; nonce: number; payable?: boolean; }>

getAccountNextNonce

Parameters

Rest ...args: [string, ...(undefined | { strategy?: NextNonceStrategy; })[]]

Returns Promise<{ nextNonce: number; }>

getChainEnds

Parameters

Rest ...args: (undefined | {})[]

Returns Promise<{ body: string[]; }>

getChannelByPubkey

Parameters

Rest ...args: [string, ...(undefined | {})[]]

getContract

Parameters

Rest ...args: [string, ...(undefined | {})[]]

Returns Promise<{ abiVersion: string; active: boolean; deposit: bigint; id: string; ownerId: string; referrerIds: string[]; vmVersion: string; }>

getContractCode

Parameters

Rest ...args: [string, ...(undefined | {})[]]

Returns Promise<{ bytecode: `cb_${string}`; }>

getContractPoI

Parameters

Rest ...args: [string, ...(undefined | {})[]]

Returns Promise<{ poi: string; }>

getCurrentGeneration

Parameters

Rest ...args: (undefined | {})[]

Returns Promise<{ keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; }; microBlocks: string[]; }>

getCurrentKeyBlock

Parameters

Rest ...args: (undefined | {})[]

Returns Promise<{ beneficiary: string; hash: string; height: number; info: string; miner: string; nonce?: number; pow?: string[]; prevHash: string; prevKeyHash: string; stateHash: string; target: string; time: number; version: number; }>

getCurrentKeyBlockHash

Parameters

Rest ...args: (undefined | {})[]

Returns Promise<{ hash: string; }>

getCurrentKeyBlockHeight

Parameters

Rest ...args: (undefined | {})[]

Returns Promise<{ height: number; }>

getGenerationByHash

Parameters

Rest ...args: [string, ...(undefined | {})[]]

Returns Promise<{ keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; }; microBlocks: string[]; }>

getGenerationByHeight

Parameters

Rest ...args: [number, ...(undefined | {})[]]

Returns Promise<{ keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; }; microBlocks: string[]; }>

getKeyBlockByHash

Parameters

Rest ...args: [string, ...(undefined | {})[]]

Returns Promise<{ beneficiary: string; hash: string; height: number; info: string; miner: string; nonce?: number; pow?: string[]; prevHash: string; prevKeyHash: string; stateHash: string; target: string; time: number; version: number; }>

getKeyBlockByHeight

options: NodeOptionalParams & {
ignoreVersion?: boolean;
retryCount?: number;
retryOverallDelay?: number;
} = {}

`Optional` intAsString

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
authFun?: string;
balance: bigint;
contractId?: string;
id: string;
kind?: AccountKind;
nonce: number;
payable?: boolean;
}>

`Rest` ...args: [string, string, ...(undefined | {})[]]

Returns Promise<{
authFun?: string;
balance: bigint;
contractId?: string;
id: string;
kind?: AccountKind;
nonce: number;
payable?: boolean;
}>

`Rest` ...args: [string, number, ...(undefined | {})[]]

Returns Promise<{
authFun?: string;
balance: bigint;
contractId?: string;
id: string;
kind?: AccountKind;
nonce: number;
payable?: boolean;
}>

`Rest` ...args: [string, ...(undefined | {
strategy?: NextNonceStrategy;
})[]]

Returns Promise<{
nextNonce: number;
}>

`Rest` ...args: (undefined | {})[]

Returns Promise<{
body: string[];
}>

`Rest` ...args: [string, ...(undefined | {})[]]

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
abiVersion: string;
active: boolean;
deposit: bigint;
id: string;
ownerId: string;
referrerIds: string[];
vmVersion: string;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
bytecode: `cb_${string}`;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
poi: string;
}>

`Rest` ...args: (undefined | {})[]

Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>

`Rest` ...args: (undefined | {})[]

Returns Promise<{
beneficiary: string;
hash: string;
height: number;
info: string;
miner: string;
nonce?: number;
pow?: string[];
prevHash: string;
prevKeyHash: string;
stateHash: string;
target: string;
time: number;
version: number;
}>

`Rest` ...args: (undefined | {})[]

Returns Promise<{
hash: string;
}>

`Rest` ...args: (undefined | {})[]

Returns Promise<{
height: number;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>

`Rest` ...args: [number, ...(undefined | {})[]]

Returns Promise<{
keyBlock: { hash: string; height: number; prevHash: string; prevKeyHash: string; stateHash: string; miner: string; beneficiary: string; target: string; pow?: string[] | undefined; nonce?: number | undefined; time: number; version: number; info: string; };
microBlocks: string[];
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
beneficiary: string;
hash: string;
height: number;
info: string;
miner: string;
nonce?: number;
pow?: string[];
prevHash: string;
prevKeyHash: string;
stateHash: string;
target: string;
time: number;
version: number;
}>

`Rest` ...args: [number, ...(undefined | {})[]]

Returns Promise<{
beneficiary: string;
hash: string;
height: number;
info: string;
miner: string;
nonce?: number;
pow?: string[];
prevHash: string;
prevKeyHash: string;
stateHash: string;
target: string;
time: number;
version: number;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
hash: string;
height: number;
pofHash: string;
prevHash: string;
prevKeyHash: string;
signature: string;
stateHash: string;
time: number;
txsHash: string;
version: number;
}>

`Rest` ...args: [string, number, ...(undefined | {})[]]

`Rest` ...args: [string, ...(undefined | {})[]]

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
count: string;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
id: string;
owner?: string;
pointers: ({ key: string; id: string; })[];
ttl: number;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

Returns Promise<{
abiVersion: string;
id: string;
queryFee: bigint;
queryFormat: string;
responseFormat: string;
ttl: number;
}>

`Rest` ...args: [string, ...(undefined | {
from?: string;
limit?: number;
type?: OracleQueryType;
})[]]

Returns Promise<{
oracleQueries: ({ id: string; senderId: string; senderNonce: string; oracleId: string; query: string; response: string; ttl: number; responseTtl: { type: TTLType; value: string; }; fee: bigint; })[];
}>

`Rest` ...args: [string, string, ...(undefined | {})[]]

Returns Promise<{
fee: bigint;
id: string;
oracleId: string;
query: string;
response: string;
responseTtl: { type: TTLType; value: string; };
senderId: string;
senderNonce: string;
ttl: number;
}>

`Rest` ...args: (undefined | {})[]

Returns Promise<{
pubkey: string;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

`Rest` ...args: (undefined | {})[]

Returns Promise<{
beneficiary: string;
hash: string;
height: number;
info: string;
miner: string;
nonce?: number;
pow?: string[];
prevHash: string;
prevKeyHash: string;
stateHash: string;
target: string;
time: number;
version: number;
}>

`Rest` ...args: (undefined | {})[]

`Rest` ...args: (undefined | {})[]

Returns Promise<{
beneficiary?: string;
hash: string;
height: number;
info?: string;
miner?: string;
nonce?: number;
pofHash?: string;
pow?: string[];
prevHash: string;
prevKeyHash: string;
signature?: string;
stateHash: string;
target?: string;
time: number;
txsHash?: string;
version: number;
}>

`Rest` ...args: [string, ...(undefined | {})[]]

`Rest` ...args: [string, ...(undefined | {})[]]