Avalanche SDK Client
    Preparing search index...

    Module methods/pChain

    Type Aliases

    BlockchainStatus

    Describes the status of a blockchain.

    Encoding
    GetBalanceErrorType
    GetBalanceParameters

    Parameters for the platform.getBalance method. Get the balance of AVAX controlled by a given address.

    GetBalanceReturnType

    Return type for the platform.getBalance method.

    GetBlockByHeightErrorType
    GetBlockByHeightParameters

    Parameters for the platform.getBlockByHeight method. Get a block by its height.

    GetBlockByHeightReturnType

    The return type for the platform.getBlockByHeight method.

    GetBlockchainsErrorType
    GetBlockchainsReturnType

    Return type for the platform.getBlockchains method. Get all the blockchains that exist (excluding the P-Chain).

    GetBlockchainStatusErrorType
    GetBlockchainStatusParameters

    Parameters for the platform.getBlockchainStatus method. Get the status of a blockchain.

    GetBlockchainStatusReturnType

    Return type for the platform.getBlockchainStatus method.

    GetBlockErrorType
    GetBlockParameters

    Parameters for the platform.getBlock method. Get a block by its ID.

    GetBlockReturnType

    The return type for the platform.getBlock method.

    GetCurrentSupplyErrorType
    GetCurrentSupplyParameters

    Parameters for the platform.getCurrentSupply method. Get the current supply of a token.

    GetCurrentSupplyReturnType

    Return type for the platform.getCurrentSupply method.

    GetCurrentValidatorsErrorType
    GetCurrentValidatorsParameters

    Parameters for the platform.getCurrentValidators method. Get the current validators of a Subnet.

    GetCurrentValidatorsReturnType

    Return type for the platform.getCurrentValidators method.

    GetFeeConfigErrorType
    GetFeeConfigReturnType

    Return type for the platform.getFeeConfig method. Get the fee configuration for the P-Chain.

    GetFeeStateErrorType
    GetFeeStateReturnType

    Return type for the platform.getFeeState method. Get the current fee state of the P-Chain.

    GetHeightErrorType
    GetHeightReturnType

    Return type for the platform.getHeight method. Get the current height of the P-Chain.

    GetL1ValidatorErrorType
    GetL1ValidatorParameters

    Parameters for the platform.getL1Validator method. Get information about an L1 validator.

    GetL1ValidatorReturnType

    Return type for the platform.getL1Validator method.

    GetMinStakeErrorType
    GetMinStakeParameters

    Parameters for the platform.getMinStake method. Get the minimum stake required for validators and delegators.

    GetMinStakeReturnType

    Return type for the platform.getMinStake method.

    GetProposedHeightErrorType
    GetProposedHeightReturnType

    Return type for the platform.getProposedHeight method. Get the proposed height of the P-Chain.

    GetRewardUTXOsErrorType
    GetRewardUTXOsParameters

    Parameters for the platform.getRewardUTXOs method. Get the reward UTXOs for a transaction.

    GetRewardUTXOsReturnType

    Return type for the platform.getRewardUTXOs method.

    GetStakeErrorType
    GetStakeParameters

    Parameters for the platform.getStake method. Get the amount of stake for a set of addresses.

    GetStakeReturnType

    Return type for the platform.getStake method.

    GetStakingAssetIDErrorType
    GetStakingAssetIDParameters

    Parameters for the platform.getStakingAssetID method. Get the ID of the asset used for staking on a Subnet.

    GetStakingAssetIDReturnType

    Return type for the platform.getStakingAssetID method.

    GetSubnetErrorType
    GetSubnetParameters

    Parameters for the platform.getSubnet method. Get information about a Subnet.

    GetSubnetReturnType

    Return type for the platform.getSubnet method.

    GetSubnetsErrorType
    GetSubnetsParameters

    Parameters for the platform.getSubnets method. Get information about a set of Subnets.

    GetSubnetsReturnType

    Return type for the platform.getSubnets method.

    GetTimestampErrorType
    GetTimestampReturnType

    Return type for the platform.getTimestamp method. Get the current timestamp of the P-Chain.

    GetTotalStakeErrorType
    GetTotalStakeParameters

    Parameters for the platform.getTotalStake method. Get the total amount of stake on a Subnet.

    GetTotalStakeReturnType

    Return type for the platform.getTotalStake method.

    GetTxErrorType
    GetTxParameters

    Parameters for the platform.getTx method. Get a transaction by its ID.

    GetTxReturnType

    Return type for the platform.getTx method. Returns the transaction encoded to the specified format PChainTransactionType

    GetTxStatusErrorType
    GetTxStatusParameters

    Parameters for the platform.getTxStatus method. Get the status of a transaction.

    GetTxStatusReturnType

    Return type for the platform.getTxStatus method.

    GetUTXOsErrorType
    GetUTXOsParameters

    Parameters for the platform.getUTXOs method. Get the UTXOs that reference a given set of addresses.

    GetUTXOsReturnType

    Return type for the platform.getUTXOs method.

    GetValidatorsAtErrorType
    GetValidatorsAtParameters

    Parameters for the platform.getValidatorsAt method. Get the validators at a given height.

    GetValidatorsAtReturnType

    Return type for the platform.getValidatorsAt method.

    IssueTxErrorType
    IssueTxParameters

    Parameters for the platform.issueTx method. Issue a transaction to the Platform Chain.

    IssueTxReturnType

    Return type for the platform.issueTx method.

    PChainBlockType
    PChainTransactionStatus

    Represents the status of a transaction.

    PChainTransactionType
    SampleValidatorsErrorType
    SampleValidatorsParameters

    Parameters for the platform.sampleValidators method. Sample validators from the specified Subnet.

    SampleValidatorsReturnType

    Return type for the platform.sampleValidators method.

    ValidatedByErrorType
    ValidatedByParameters

    Parameters for the platform.validatedBy method. Get the Subnet that validates a given blockchain.

    ValidatedByReturnType

    Return type for the platform.validatedBy method.

    ValidatesErrorType
    ValidatesParameters

    Parameters for the platform.validates method. Get the IDs of the blockchains a Subnet validates.

    ValidatesReturnType

    Return type for the platform.validates method.

    Functions

    getBalance

    Get the balance of AVAX controlled by a given address.

    getBlock

    Get a block by its ID.

    getBlockByHeight

    Get a block by its height.

    getBlockchains

    Get all the blockchains that exist (excluding the P-Chain).

    getBlockchainStatus

    Get the status of a blockchain.

    getCurrentSupply

    Get the current supply of an asset.

    getCurrentValidators

    Get the current validators of the specified Subnet.

    getFeeConfig

    Get the fee configuration for the P-Chain.

    getFeeState

    Get the current fee state of the P-Chain.

    getHeight

    Get the height of the last accepted block.

    getL1Validator

    Get the L1 validator information.

    getMinStake

    Get the minimum stake amount for a subnet.

    getProposedHeight

    Get the proposed height of the P-Chain.

    getRewardUTXOs

    Get the reward UTXOs for a transaction.

    getStake

    Get the stake amount for a set of addresses.

    getStakingAssetID

    Get the staking asset ID for a subnet.

    getSubnet

    Get information about a subnet.

    getSubnets

    Get all subnets.

    getTimestamp

    Get the current timestamp of the P-Chain.

    getTotalStake

    Get the total stake amount for a subnet.

    getTx

    Get a transaction by its ID.

    getTxStatus

    Get the status of a transaction.

    getUTXOs

    Get the UTXOs for a set of addresses.

    getValidatorsAt

    Get the validators at a specific height.

    issueTx

    Issue a transaction to the Platform Chain.

    sampleValidators

    Sample validators from the specified Subnet.

    validatedBy

    Get the validators that validated a transaction.

    validates

    Validates a transaction.