Avalanche SDK Client
    Preparing search index...

    Module methods/xChain

    Type Aliases

    BuildGenesisErrorType
    BuildGenesisParameters

    The parameters for the avm.buildGenesis method.

    BuildGenesisReturnType

    The return type for the avm.buildGenesis method.

    GetAllBalancesErrorType
    GetAllBalancesParameters

    The parameters for the avm.getAllBalances method.

    GetAllBalancesReturnType

    The return type for the avm.getAllBalances method.

    GetAssetDescriptionErrorType
    GetAssetDescriptionParameters

    The parameters for the avm.getAssetDescription method.

    GetAssetDescriptionReturnType

    The return type for the avm.getAssetDescription method.

    GetBalanceErrorType
    GetBalanceParameters

    The parameters for the avm.getBalance method.

    GetBalanceReturnType

    The return type for the avm.getBalance method.

    GetBlockByHeightErrorType
    GetBlockByHeightParameters

    The parameters for the avm.getBlockByHeight method.

    GetBlockByHeightReturnType

    The return type for the avm.getBlockByHeight method.

    GetBlockErrorType
    GetBlockParameters

    The parameters for the avm.getBlock method.

    GetBlockReturnType

    The return type for the avm.getBlock method.

    GetHeightErrorType
    GetHeightReturnType

    The return type for the avm.getHeight method.

    GetTxErrorType
    GetTxFeeErrorType
    GetTxFeeReturnType

    The return type for the avm.getTxFee method.

    GetTxParameters

    Parameters for the avm.getTx method.

    GetTxReturnType

    Return type for the avm.getTx method. Returns the transaction in the requested format.

    GetTxStatusErrorType
    GetTxStatusParameters

    The parameters for the avm.getTxStatus method.

    GetTxStatusReturnType

    The return type for the avm.getTxStatus method.

    GetUTXOsErrorType
    GetUTXOsParameters

    The parameters for the avm.getUTXOs method.

    GetUTXOsReturnType

    The return type for the avm.getUTXOs method.

    IssueTxErrorType
    IssueTxParameters

    Parameters for the avm.issueTx method. This method sends a signed transaction to the network.

    IssueTxReturnType

    Return type for the avm.issueTx method. Returns the ID of the issued transaction.

    XChainBlockType

    Represents an X-Chain block in either JSON or hex format. The X-Chain is Avalanche's native platform for creating and trading assets.

    XChainTransactionStatus

    Represents the possible statuses of an X-Chain transaction.

    • Accepted: Transaction has been accepted and included in a block
    • Processing: Transaction is being processed
    • Rejected: Transaction was rejected
    • Unknown: Transaction status cannot be determined
    XChainTransactionType

    Represents an X-Chain transaction in either JSON or hex format. Transactions on the X-Chain can transfer assets between addresses or export assets to other chains.

    Functions

    buildGenesis

    Given a JSON representation of this Virtual Machine's genesis state, create the byte representation of that state.

    getAllBalances

    Get the balances of all assets controlled by given addresses.

    getAssetDescription

    Get information about an asset.

    getBalance

    Get the balance of an asset controlled by given addresses.

    getBlock

    Get a block by its ID.

    getBlockByHeight

    Get a block by its height.

    getHeight

    Get the height of the blockchain.

    getTx

    Get a transaction by its ID.

    getTxFee

    Get the transaction fee for a given transaction.

    getTxStatus

    Get the status of a transaction.

    getUTXOs

    Get the UTXOs for a set of addresses.

    issueTx

    Issue a transaction.