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;
        }>;
        getAuctionEntryByName(...args): Promise<{
            endsAt: string;
            highestBid: string;
            highestBidder: string;
            id: string;
            startedAt?: string;
        }>;
        getChainEnds(...args): Promise<{
            body: string[];
        }>;
        getChannelByPubkey(...args): Promise<{
            channelAmount: bigint;
            channelReserve: bigint;
            delegateIds: {
                initiator?: string[];
                responder?: string[];
            };
            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;
        }>;
        getCurrency(...args): Promise<{
            fiatConverstionUrl?: string;
            logo?: {
                data?: string;
                type?: string;
            };
            name: string;
            networkName: string;
            primaryColour: string;
            secondaryColour: string;
            subunit: string;
            subunitsPerUnit: string;
            symbol: string;
        }>;
        getCurrentGeneration(...args): Promise<{
            keyBlock: {
                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;
            };
            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: {
                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;
            };
            microBlocks: string[];
        }>;
        getGenerationByHeight(...args): Promise<{
            keyBlock: {
                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;
            };
            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;
            encodedTx?: string;
            hash: string;
            signatures: string[];
            tx: {
                abiVersion?: string;
                accountId?: string;
                amount?: bigint;
                authData?: string;
                authFun?: string;
                callData?: string;
                callerId?: string;
                channelId?: string;
                channelReserve?: bigint;
                clientTtl?: number;
                code?: string;
                commitmentId?: string;
                contractId?: string;
                delegateIds?: {
                    initiator?: string[];
                    responder?: string[];
                };
                deposit?: bigint;
                fee: bigint;
                fromId?: string;
                gaId?: string;
                gas?: number;
                gasPrice?: bigint;
                initiatorAmount?: bigint;
                initiatorAmountFinal?: bigint;
                initiatorDelegateIds?: string[];
                initiatorId?: string;
                lockPeriod?: string;
                name?: string;
                nameFee?: bigint;
                nameId?: string;
                nameSalt?: number;
                nameTtl?: number;
                nonce?: number;
                offchainTrees?: string;
                oracleId?: string;
                oracleTtl?: {
                    type: "delta";
                    value: string;
                };
                ownerId?: string;
                payerId?: string;
                payload?: string;
                poi?: string;
                pointers?: {
                    id: string;
                    key: string;
                }[];
                query?: string;
                queryFee?: bigint;
                queryFormat?: string;
                queryId?: string;
                queryTtl?: {
                    type: TTLType;
                    value: string;
                };
                recipientId?: string;
                responderAmount?: bigint;
                responderAmountFinal?: bigint;
                responderDelegateIds?: string[];
                responderId?: string;
                response?: string;
                responseFormat?: string;
                responseTtl?: {
                    type: "delta";
                    value: string;
                };
                round?: number;
                senderId?: string;
                stateHash?: string;
                toId?: string;
                ttl?: number;
                tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
                type: TxType;
                update?: {
                    op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainTransfer";
                    to: string;
                } | {
                    amount: bigint;
                    op: "OffChainWithdrawal";
                    to: string;
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainDeposit";
                } | {
                    abiVersion: string;
                    callData: string;
                    code: {
                        bytecode: `cb_${string}`;
                    };
                    deposit: bigint;
                    op: "OffChainNewContract";
                    owner: string;
                    vmVersion: string;
                } | {
                    abiVersion: string;
                    amount: bigint;
                    callData: string;
                    caller: string;
                    contract: string;
                    gas: number;
                    gasPrice: bigint;
                    op: "OffChainCallContract";
                };
                version: number;
                vmVersion?: string;
            };
        }>;
        getMicroBlockTransactionsByHash(...args): Promise<{
            transactions: {
                blockHash: string;
                blockHeight: number;
                encodedTx?: string;
                hash: string;
                signatures: string[];
                tx: {
                    abiVersion?: string;
                    accountId?: string;
                    amount?: bigint;
                    authData?: string;
                    authFun?: string;
                    callData?: string;
                    callerId?: string;
                    channelId?: string;
                    channelReserve?: bigint;
                    clientTtl?: number;
                    code?: string;
                    commitmentId?: string;
                    contractId?: string;
                    delegateIds?: {
                        initiator?: (...)[];
                        responder?: (...)[];
                    };
                    deposit?: bigint;
                    fee: bigint;
                    fromId?: string;
                    gaId?: string;
                    gas?: number;
                    gasPrice?: bigint;
                    initiatorAmount?: bigint;
                    initiatorAmountFinal?: bigint;
                    initiatorDelegateIds?: string[];
                    initiatorId?: string;
                    lockPeriod?: string;
                    name?: string;
                    nameFee?: bigint;
                    nameId?: string;
                    nameSalt?: number;
                    nameTtl?: number;
                    nonce?: number;
                    offchainTrees?: string;
                    oracleId?: string;
                    oracleTtl?: {
                        type: "delta";
                        value: string;
                    };
                    ownerId?: string;
                    payerId?: string;
                    payload?: string;
                    poi?: string;
                    pointers?: {
                        id: string;
                        key: string;
                    }[];
                    query?: string;
                    queryFee?: bigint;
                    queryFormat?: string;
                    queryId?: string;
                    queryTtl?: {
                        type: TTLType;
                        value: string;
                    };
                    recipientId?: string;
                    responderAmount?: bigint;
                    responderAmountFinal?: bigint;
                    responderDelegateIds?: string[];
                    responderId?: string;
                    response?: string;
                    responseFormat?: string;
                    responseTtl?: {
                        type: "delta";
                        value: string;
                    };
                    round?: number;
                    senderId?: string;
                    stateHash?: string;
                    toId?: string;
                    ttl?: number;
                    tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
                    type: TxType;
                    update?: {
                        op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
                    } | {
                        amount: bigint;
                        from: string;
                        op: "OffChainTransfer";
                        to: string;
                    } | {
                        amount: bigint;
                        op: "OffChainWithdrawal";
                        to: string;
                    } | {
                        amount: bigint;
                        from: string;
                        op: "OffChainDeposit";
                    } | {
                        abiVersion: string;
                        callData: string;
                        code: {
                            bytecode: `cb_${(...)}`;
                        };
                        deposit: bigint;
                        op: "OffChainNewContract";
                        owner: string;
                        vmVersion: string;
                    } | {
                        abiVersion: string;
                        amount: bigint;
                        callData: string;
                        caller: string;
                        contract: string;
                        gas: number;
                        gasPrice: bigint;
                        op: "OffChainCallContract";
                    };
                    version: number;
                    vmVersion?: string;
                };
            }[];
        }>;
        getMicroBlockTransactionsCountByHash(...args): Promise<{
            count: string;
        }>;
        getNameEntryByName(...args): Promise<{
            id: string;
            owner?: string;
            pointers: {
                id: string;
                key: string;
            }[];
            ttl: number;
        }>;
        getOracleByPubkey(...args): Promise<{
            abiVersion: string;
            id: string;
            queryFee: bigint;
            queryFormat: string;
            responseFormat: string;
            ttl: number;
        }>;
        getOracleQueriesByPubkey(...args): Promise<{
            oracleQueries: {
                fee: bigint;
                id: string;
                oracleId: string;
                query: string;
                response: string;
                responseTtl: {
                    type: TTLType;
                    value: string;
                };
                senderId: string;
                senderNonce: string;
                ttl: number;
            }[];
        }>;
        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: {
                blockHash: string;
                blockHeight: number;
                encodedTx?: string;
                hash: string;
                signatures: string[];
                tx: {
                    abiVersion?: string;
                    accountId?: string;
                    amount?: bigint;
                    authData?: string;
                    authFun?: string;
                    callData?: string;
                    callerId?: string;
                    channelId?: string;
                    channelReserve?: bigint;
                    clientTtl?: number;
                    code?: string;
                    commitmentId?: string;
                    contractId?: string;
                    delegateIds?: {
                        initiator?: (...)[];
                        responder?: (...)[];
                    };
                    deposit?: bigint;
                    fee: bigint;
                    fromId?: string;
                    gaId?: string;
                    gas?: number;
                    gasPrice?: bigint;
                    initiatorAmount?: bigint;
                    initiatorAmountFinal?: bigint;
                    initiatorDelegateIds?: string[];
                    initiatorId?: string;
                    lockPeriod?: string;
                    name?: string;
                    nameFee?: bigint;
                    nameId?: string;
                    nameSalt?: number;
                    nameTtl?: number;
                    nonce?: number;
                    offchainTrees?: string;
                    oracleId?: string;
                    oracleTtl?: {
                        type: "delta";
                        value: string;
                    };
                    ownerId?: string;
                    payerId?: string;
                    payload?: string;
                    poi?: string;
                    pointers?: {
                        id: string;
                        key: string;
                    }[];
                    query?: string;
                    queryFee?: bigint;
                    queryFormat?: string;
                    queryId?: string;
                    queryTtl?: {
                        type: TTLType;
                        value: string;
                    };
                    recipientId?: string;
                    responderAmount?: bigint;
                    responderAmountFinal?: bigint;
                    responderDelegateIds?: string[];
                    responderId?: string;
                    response?: string;
                    responseFormat?: string;
                    responseTtl?: {
                        type: "delta";
                        value: string;
                    };
                    round?: number;
                    senderId?: string;
                    stateHash?: string;
                    toId?: string;
                    ttl?: number;
                    tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
                    type: TxType;
                    update?: {
                        op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
                    } | {
                        amount: bigint;
                        from: string;
                        op: "OffChainTransfer";
                        to: string;
                    } | {
                        amount: bigint;
                        op: "OffChainWithdrawal";
                        to: string;
                    } | {
                        amount: bigint;
                        from: string;
                        op: "OffChainDeposit";
                    } | {
                        abiVersion: string;
                        callData: string;
                        code: {
                            bytecode: `cb_${(...)}`;
                        };
                        deposit: bigint;
                        op: "OffChainNewContract";
                        owner: string;
                        vmVersion: string;
                    } | {
                        abiVersion: string;
                        amount: bigint;
                        callData: string;
                        caller: string;
                        contract: string;
                        gas: number;
                        gasPrice: bigint;
                        op: "OffChainCallContract";
                    };
                    version: number;
                    vmVersion?: string;
                };
            }[];
        }>;
        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;
        }>;
        getRecentGasPrices(...args): Promise<{
            minGasPrice: bigint;
            minutes: number;
            utilization: number;
        }[]>;
        getStatus(...args): Promise<{
            difficulty: number;
            genesisKeyBlockHash: string;
            hashrate: number;
            listening: boolean;
            networkId: string;
            nodeRevision: string;
            nodeVersion: string;
            peerConnections: {
                inbound: number;
                outbound: number;
            };
            peerCount: number;
            peerPubkey: string;
            pendingTransactionsCount: number;
            protocols: {
                effectiveAtHeight: number;
                version: number;
            }[];
            solutions: number;
            syncProgress?: number;
            syncing: boolean;
            topBlockHeight: number;
            topKeyBlockHash: string;
            uptime: string;
        }>;
        getSyncStatus(...args): Promise<{
            estimate: string;
            progress: number;
            speed: number;
            target: 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;
            encodedTx?: string;
            hash: string;
            signatures: string[];
            tx: {
                abiVersion?: string;
                accountId?: string;
                amount?: bigint;
                authData?: string;
                authFun?: string;
                callData?: string;
                callerId?: string;
                channelId?: string;
                channelReserve?: bigint;
                clientTtl?: number;
                code?: string;
                commitmentId?: string;
                contractId?: string;
                delegateIds?: {
                    initiator?: string[];
                    responder?: string[];
                };
                deposit?: bigint;
                fee: bigint;
                fromId?: string;
                gaId?: string;
                gas?: number;
                gasPrice?: bigint;
                initiatorAmount?: bigint;
                initiatorAmountFinal?: bigint;
                initiatorDelegateIds?: string[];
                initiatorId?: string;
                lockPeriod?: string;
                name?: string;
                nameFee?: bigint;
                nameId?: string;
                nameSalt?: number;
                nameTtl?: number;
                nonce?: number;
                offchainTrees?: string;
                oracleId?: string;
                oracleTtl?: {
                    type: "delta";
                    value: string;
                };
                ownerId?: string;
                payerId?: string;
                payload?: string;
                poi?: string;
                pointers?: {
                    id: string;
                    key: string;
                }[];
                query?: string;
                queryFee?: bigint;
                queryFormat?: string;
                queryId?: string;
                queryTtl?: {
                    type: TTLType;
                    value: string;
                };
                recipientId?: string;
                responderAmount?: bigint;
                responderAmountFinal?: bigint;
                responderDelegateIds?: string[];
                responderId?: string;
                response?: string;
                responseFormat?: string;
                responseTtl?: {
                    type: "delta";
                    value: string;
                };
                round?: number;
                senderId?: string;
                stateHash?: string;
                toId?: string;
                ttl?: number;
                tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
                type: TxType;
                update?: {
                    op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainTransfer";
                    to: string;
                } | {
                    amount: bigint;
                    op: "OffChainWithdrawal";
                    to: string;
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainDeposit";
                } | {
                    abiVersion: string;
                    callData: string;
                    code: {
                        bytecode: `cb_${string}`;
                    };
                    deposit: bigint;
                    op: "OffChainNewContract";
                    owner: string;
                    vmVersion: string;
                } | {
                    abiVersion: string;
                    amount: bigint;
                    callData: string;
                    caller: string;
                    contract: string;
                    gas: number;
                    gasPrice: bigint;
                    op: "OffChainCallContract";
                };
                version: number;
                vmVersion?: string;
            };
        }>;
        getTransactionInfoByHash(...args): Promise<{
            callInfo?: {
                callerId: string;
                callerNonce: string;
                contractId: string;
                gasPrice: bigint;
                gasUsed: number;
                height: number;
                log: {
                    address: string;
                    data: string;
                    topics: string[];
                }[];
                returnType: ContractCallReturnType;
                returnValue: string;
            };
            gaInfo?: {
                callerId: string;
                gasPrice: bigint;
                gasUsed: number;
                height: number;
                innerObject?: { callInfo?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; } | undefined; gaInfo?: { ...; } | undefined; txInfo?: string | undefined; };
                returnType: GAReturnType;
                returnValue: string;
            };
            txInfo?: string;
        }>;
        postTransaction(...args): Promise<{
            txHash: `th_${string}`;
        }>;
        protectedDryRunTxs(...args): Promise<{
            results: {
                callObj?: {
                    callerId: string;
                    callerNonce: string;
                    contractId: string;
                    gasPrice: bigint;
                    gasUsed: number;
                    height: number;
                    log: {
                        address: string;
                        data: string;
                        topics: (...)[];
                    }[];
                    returnType: ContractCallReturnType;
                    returnValue: string;
                };
                reason?: string;
                result: string;
                type: string;
            }[];
            txEvents?: {}[];
        }>;
    }
    • Node

Constructors

  • Parameters

    • url: string

      Url for node API

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

      Options

    Returns Node

Properties

$host: string
intAsString?: boolean

Methods

  • Parameters

    • Optional options: OperationOptions

    Returns Promise<{
        difficulty: number;
        genesisKeyBlockHash: string;
        hashrate: number;
        listening: boolean;
        networkId: string;
        nodeRevision: string;
        nodeVersion: string;
        peerConnections: {
            inbound: number;
            outbound: number;
        };
        peerCount: number;
        peerPubkey: string;
        pendingTransactionsCount: number;
        protocols: {
            effectiveAtHeight: number;
            version: number;
        }[];
        solutions: number;
        syncProgress?: number;
        syncing: boolean;
        topBlockHeight: number;
        topKeyBlockHash: string;
        uptime: string;
    }>

  • 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;
    }>

  • 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;
    }>

  • 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;
    }>

  • 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

    Returns Promise<{
        nextNonce: number;
    }>

  • Get auction entry from naming system

    Parameters

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

    Returns Promise<{
        endsAt: string;
        highestBid: string;
        highestBidder: string;
        id: string;
        startedAt?: string;
    }>

  • Get oldest keyblock hashes counting from genesis including orphans

    Parameters

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

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

  • Get channel by public key

    Parameters

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

    Returns Promise<{
        channelAmount: bigint;
        channelReserve: bigint;
        delegateIds: {
            initiator?: string[];
            responder?: string[];
        };
        id: string;
        initiatorAmount: bigint;
        initiatorId: string;
        lockPeriod: string;
        lockedUntil: string;
        responderAmount: bigint;
        responderId: string;
        round: number;
        soloRound: string;
        stateHash: 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;
    }>

  • Get contract code by pubkey

    Parameters

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

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

  • Get a proof of inclusion for a contract

    Parameters

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

    Returns Promise<{
        poi: string;
    }>

  • Get the currency metadata of a node

    Parameters

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

    Returns Promise<{
        fiatConverstionUrl?: string;
        logo?: {
            data?: string;
            type?: string;
        };
        name: string;
        networkName: string;
        primaryColour: string;
        secondaryColour: string;
        subunit: string;
        subunitsPerUnit: string;
        symbol: string;
    }>

  • Get the current generation

    Parameters

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

    Returns Promise<{
        keyBlock: {
            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;
        };
        microBlocks: string[];
    }>

  • 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;
    }>

  • Get the hash of the current key block

    Parameters

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

    Returns Promise<{
        hash: string;
    }>

  • Get the height of the current key block

    Parameters

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

    Returns Promise<{
        height: number;
    }>

  • Get a generation by hash

    Parameters

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

    Returns Promise<{
        keyBlock: {
            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;
        };
        microBlocks: string[];
    }>

  • Get a generation by height

    Parameters

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

    Returns Promise<{
        keyBlock: {
            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;
        };
        microBlocks: string[];
    }>

  • 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;
    }>

  • 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;
    }>

  • 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;
    }>

  • Get a micro block transaction by hash and index

    Parameters

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

    Returns Promise<{
        blockHash: string;
        blockHeight: number;
        encodedTx?: string;
        hash: string;
        signatures: string[];
        tx: {
            abiVersion?: string;
            accountId?: string;
            amount?: bigint;
            authData?: string;
            authFun?: string;
            callData?: string;
            callerId?: string;
            channelId?: string;
            channelReserve?: bigint;
            clientTtl?: number;
            code?: string;
            commitmentId?: string;
            contractId?: string;
            delegateIds?: {
                initiator?: string[];
                responder?: string[];
            };
            deposit?: bigint;
            fee: bigint;
            fromId?: string;
            gaId?: string;
            gas?: number;
            gasPrice?: bigint;
            initiatorAmount?: bigint;
            initiatorAmountFinal?: bigint;
            initiatorDelegateIds?: string[];
            initiatorId?: string;
            lockPeriod?: string;
            name?: string;
            nameFee?: bigint;
            nameId?: string;
            nameSalt?: number;
            nameTtl?: number;
            nonce?: number;
            offchainTrees?: string;
            oracleId?: string;
            oracleTtl?: {
                type: "delta";
                value: string;
            };
            ownerId?: string;
            payerId?: string;
            payload?: string;
            poi?: string;
            pointers?: {
                id: string;
                key: string;
            }[];
            query?: string;
            queryFee?: bigint;
            queryFormat?: string;
            queryId?: string;
            queryTtl?: {
                type: TTLType;
                value: string;
            };
            recipientId?: string;
            responderAmount?: bigint;
            responderAmountFinal?: bigint;
            responderDelegateIds?: string[];
            responderId?: string;
            response?: string;
            responseFormat?: string;
            responseTtl?: {
                type: "delta";
                value: string;
            };
            round?: number;
            senderId?: string;
            stateHash?: string;
            toId?: string;
            ttl?: number;
            tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
            type: TxType;
            update?: {
                op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
            } | {
                amount: bigint;
                from: string;
                op: "OffChainTransfer";
                to: string;
            } | {
                amount: bigint;
                op: "OffChainWithdrawal";
                to: string;
            } | {
                amount: bigint;
                from: string;
                op: "OffChainDeposit";
            } | {
                abiVersion: string;
                callData: string;
                code: {
                    bytecode: `cb_${string}`;
                };
                deposit: bigint;
                op: "OffChainNewContract";
                owner: string;
                vmVersion: string;
            } | {
                abiVersion: string;
                amount: bigint;
                callData: string;
                caller: string;
                contract: string;
                gas: number;
                gasPrice: bigint;
                op: "OffChainCallContract";
            };
            version: number;
            vmVersion?: string;
        };
    }>

  • Get micro block transactions by hash

    Parameters

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

    Returns Promise<{
        transactions: {
            blockHash: string;
            blockHeight: number;
            encodedTx?: string;
            hash: string;
            signatures: string[];
            tx: {
                abiVersion?: string;
                accountId?: string;
                amount?: bigint;
                authData?: string;
                authFun?: string;
                callData?: string;
                callerId?: string;
                channelId?: string;
                channelReserve?: bigint;
                clientTtl?: number;
                code?: string;
                commitmentId?: string;
                contractId?: string;
                delegateIds?: {
                    initiator?: string[];
                    responder?: string[];
                };
                deposit?: bigint;
                fee: bigint;
                fromId?: string;
                gaId?: string;
                gas?: number;
                gasPrice?: bigint;
                initiatorAmount?: bigint;
                initiatorAmountFinal?: bigint;
                initiatorDelegateIds?: string[];
                initiatorId?: string;
                lockPeriod?: string;
                name?: string;
                nameFee?: bigint;
                nameId?: string;
                nameSalt?: number;
                nameTtl?: number;
                nonce?: number;
                offchainTrees?: string;
                oracleId?: string;
                oracleTtl?: {
                    type: "delta";
                    value: string;
                };
                ownerId?: string;
                payerId?: string;
                payload?: string;
                poi?: string;
                pointers?: {
                    id: string;
                    key: string;
                }[];
                query?: string;
                queryFee?: bigint;
                queryFormat?: string;
                queryId?: string;
                queryTtl?: {
                    type: TTLType;
                    value: string;
                };
                recipientId?: string;
                responderAmount?: bigint;
                responderAmountFinal?: bigint;
                responderDelegateIds?: string[];
                responderId?: string;
                response?: string;
                responseFormat?: string;
                responseTtl?: {
                    type: "delta";
                    value: string;
                };
                round?: number;
                senderId?: string;
                stateHash?: string;
                toId?: string;
                ttl?: number;
                tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
                type: TxType;
                update?: {
                    op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainTransfer";
                    to: string;
                } | {
                    amount: bigint;
                    op: "OffChainWithdrawal";
                    to: string;
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainDeposit";
                } | {
                    abiVersion: string;
                    callData: string;
                    code: {
                        bytecode: `cb_${string}`;
                    };
                    deposit: bigint;
                    op: "OffChainNewContract";
                    owner: string;
                    vmVersion: string;
                } | {
                    abiVersion: string;
                    amount: bigint;
                    callData: string;
                    caller: string;
                    contract: string;
                    gas: number;
                    gasPrice: bigint;
                    op: "OffChainCallContract";
                };
                version: number;
                vmVersion?: string;
            };
        }[];
    }>

  • Get micro block transaction count by hash

    Parameters

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

    Returns Promise<{
        count: string;
    }>

  • Get name entry from naming system

    Parameters

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

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

  • Returns network ID provided by node. This method won't do extra requests on subsequent calls.

    Returns Promise<string>

  • 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;
    }>

  • Get oracle queries by public key

    Parameters

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

    Returns Promise<{
        oracleQueries: {
            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;
    }>

  • Get peer public key

    Parameters

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

    Returns Promise<{
        pubkey: string;
    }>

  • Get pending account transactions by public key

    Parameters

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

    Returns Promise<{
        transactions: {
            blockHash: string;
            blockHeight: number;
            encodedTx?: string;
            hash: string;
            signatures: string[];
            tx: {
                abiVersion?: string;
                accountId?: string;
                amount?: bigint;
                authData?: string;
                authFun?: string;
                callData?: string;
                callerId?: string;
                channelId?: string;
                channelReserve?: bigint;
                clientTtl?: number;
                code?: string;
                commitmentId?: string;
                contractId?: string;
                delegateIds?: {
                    initiator?: string[];
                    responder?: string[];
                };
                deposit?: bigint;
                fee: bigint;
                fromId?: string;
                gaId?: string;
                gas?: number;
                gasPrice?: bigint;
                initiatorAmount?: bigint;
                initiatorAmountFinal?: bigint;
                initiatorDelegateIds?: string[];
                initiatorId?: string;
                lockPeriod?: string;
                name?: string;
                nameFee?: bigint;
                nameId?: string;
                nameSalt?: number;
                nameTtl?: number;
                nonce?: number;
                offchainTrees?: string;
                oracleId?: string;
                oracleTtl?: {
                    type: "delta";
                    value: string;
                };
                ownerId?: string;
                payerId?: string;
                payload?: string;
                poi?: string;
                pointers?: {
                    id: string;
                    key: string;
                }[];
                query?: string;
                queryFee?: bigint;
                queryFormat?: string;
                queryId?: string;
                queryTtl?: {
                    type: TTLType;
                    value: string;
                };
                recipientId?: string;
                responderAmount?: bigint;
                responderAmountFinal?: bigint;
                responderDelegateIds?: string[];
                responderId?: string;
                response?: string;
                responseFormat?: string;
                responseTtl?: {
                    type: "delta";
                    value: string;
                };
                round?: number;
                senderId?: string;
                stateHash?: string;
                toId?: string;
                ttl?: number;
                tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
                type: TxType;
                update?: {
                    op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainTransfer";
                    to: string;
                } | {
                    amount: bigint;
                    op: "OffChainWithdrawal";
                    to: string;
                } | {
                    amount: bigint;
                    from: string;
                    op: "OffChainDeposit";
                } | {
                    abiVersion: string;
                    callData: string;
                    code: {
                        bytecode: `cb_${string}`;
                    };
                    deposit: bigint;
                    op: "OffChainNewContract";
                    owner: string;
                    vmVersion: string;
                } | {
                    abiVersion: string;
                    amount: bigint;
                    callData: string;
                    caller: string;
                    contract: string;
                    gas: number;
                    gasPrice: bigint;
                    op: "OffChainCallContract";
                };
                version: number;
                vmVersion?: string;
            };
        }[];
    }>

  • 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;
    }>

  • Get minimum gas prices in recent blocks

    Parameters

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

    Returns Promise<{
        minGasPrice: bigint;
        minutes: number;
        utilization: number;
    }[]>

  • @ts-expect-error use code generation to create node class?

    Parameters

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

    Returns Promise<{
        difficulty: number;
        genesisKeyBlockHash: string;
        hashrate: number;
        listening: boolean;
        networkId: string;
        nodeRevision: string;
        nodeVersion: string;
        peerConnections: {
            inbound: number;
            outbound: number;
        };
        peerCount: number;
        peerPubkey: string;
        pendingTransactionsCount: number;
        protocols: {
            effectiveAtHeight: number;
            version: number;
        }[];
        solutions: number;
        syncProgress?: number;
        syncing: boolean;
        topBlockHeight: number;
        topKeyBlockHash: string;
        uptime: string;
    }>

  • Get the sync status of a node

    Parameters

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

    Returns Promise<{
        estimate: string;
        progress: number;
        speed: number;
        target: string;
    }>

  • 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;
    }>

  • Get a transaction by hash

    Parameters

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

    Returns Promise<{
        blockHash: string;
        blockHeight: number;
        encodedTx?: string;
        hash: string;
        signatures: string[];
        tx: {
            abiVersion?: string;
            accountId?: string;
            amount?: bigint;
            authData?: string;
            authFun?: string;
            callData?: string;
            callerId?: string;
            channelId?: string;
            channelReserve?: bigint;
            clientTtl?: number;
            code?: string;
            commitmentId?: string;
            contractId?: string;
            delegateIds?: {
                initiator?: string[];
                responder?: string[];
            };
            deposit?: bigint;
            fee: bigint;
            fromId?: string;
            gaId?: string;
            gas?: number;
            gasPrice?: bigint;
            initiatorAmount?: bigint;
            initiatorAmountFinal?: bigint;
            initiatorDelegateIds?: string[];
            initiatorId?: string;
            lockPeriod?: string;
            name?: string;
            nameFee?: bigint;
            nameId?: string;
            nameSalt?: number;
            nameTtl?: number;
            nonce?: number;
            offchainTrees?: string;
            oracleId?: string;
            oracleTtl?: {
                type: "delta";
                value: string;
            };
            ownerId?: string;
            payerId?: string;
            payload?: string;
            poi?: string;
            pointers?: {
                id: string;
                key: string;
            }[];
            query?: string;
            queryFee?: bigint;
            queryFormat?: string;
            queryId?: string;
            queryTtl?: {
                type: TTLType;
                value: string;
            };
            recipientId?: string;
            responderAmount?: bigint;
            responderAmountFinal?: bigint;
            responderDelegateIds?: string[];
            responderId?: string;
            response?: string;
            responseFormat?: string;
            responseTtl?: {
                type: "delta";
                value: string;
            };
            round?: number;
            senderId?: string;
            stateHash?: string;
            toId?: string;
            ttl?: number;
            tx?: { tx: { recipientId?: string | undefined; amount?: bigint | undefined; fee: bigint; ttl?: number | undefined; senderId?: string | undefined; nonce?: number | undefined; payload?: string | undefined; ... 54 more ...; type: TxType; }; ... 4 more ...; signatures: string[]; };
            type: TxType;
            update?: {
                op: "OffChainTransfer" | "OffChainWithdrawal" | "OffChainDeposit" | "OffChainNewContract" | "OffChainCallContract";
            } | {
                amount: bigint;
                from: string;
                op: "OffChainTransfer";
                to: string;
            } | {
                amount: bigint;
                op: "OffChainWithdrawal";
                to: string;
            } | {
                amount: bigint;
                from: string;
                op: "OffChainDeposit";
            } | {
                abiVersion: string;
                callData: string;
                code: {
                    bytecode: `cb_${string}`;
                };
                deposit: bigint;
                op: "OffChainNewContract";
                owner: string;
                vmVersion: string;
            } | {
                abiVersion: string;
                amount: bigint;
                callData: string;
                caller: string;
                contract: string;
                gas: number;
                gasPrice: bigint;
                op: "OffChainCallContract";
            };
            version: number;
            vmVersion?: string;
        };
    }>

  • Parameters

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

    Returns Promise<{
        callInfo?: {
            callerId: string;
            callerNonce: string;
            contractId: string;
            gasPrice: bigint;
            gasUsed: number;
            height: number;
            log: {
                address: string;
                data: string;
                topics: string[];
            }[];
            returnType: ContractCallReturnType;
            returnValue: string;
        };
        gaInfo?: {
            callerId: string;
            gasPrice: bigint;
            gasUsed: number;
            height: number;
            innerObject?: { callInfo?: { callerId: string; callerNonce: string; height: number; contractId: string; gasPrice: bigint; gasUsed: number; log: { address: string; topics: string[]; data: string; }[]; returnValue: string; returnType: ContractCallReturnType; } | undefined; gaInfo?: { ...; } | undefined; txInfo?: string | undefined; };
            returnType: GAReturnType;
            returnValue: string;
        };
        txInfo?: string;
    }>

  • Post a new transaction

    Parameters

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

    Returns Promise<{
        txHash: `th_${string}`;
    }>

  • Dry-run unsigned 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?: {
              amount: bigint;
              pubKey: string;
          }[];
          top?: string;
          txEvents?: boolean;
          txs: {
              callReq?: {
                  abiVersion?: string;
                  amount?: bigint;
                  calldata: string;
                  caller?: string;
                  context?: {
                      stateful?: boolean;
                      tx?: string;
                      txHash?: `th_${string}`;
                  };
                  contract: string;
                  gas?: number;
                  nonce?: number;
              };
              tx?: string;
              txHash?: `th_${string}`;
          }[];
      }, ...(undefined | {})[]]

    Returns Promise<{
        results: {
            callObj?: {
                callerId: string;
                callerNonce: string;
                contractId: string;
                gasPrice: bigint;
                gasUsed: number;
                height: number;
                log: {
                    address: string;
                    data: string;
                    topics: string[];
                }[];
                returnType: ContractCallReturnType;
                returnValue: string;
            };
            reason?: string;
            result: string;
            type: string;
        }[];
        txEvents?: {}[];
    }>

Generated using TypeDoc