Function createPChainClient

Returns {
    extend: <const client extends { [key: string]: unknown }>(
        fn: (
            client: {
                extend: ...;
                getBalance: ...;
                getBlock: ...;
                getBlockByHeight: ...;
                getBlockchains: ...;
                getBlockchainStatus: ...;
                getCurrentSupply: ...;
                getCurrentValidators: ...;
                getFeeConfig: ...;
                getFeeState: ...;
                getHeight: ...;
                getL1Validator: ...;
                getMinStake: ...;
                getProposedHeight: ...;
                getRewardUTXOs: ...;
                getStake: ...;
                getStakingAssetID: ...;
                getSubnet: ...;
                getSubnets: ...;
                getTimestamp: ...;
                getTotalStake: ...;
                getTx: ...;
                getTxStatus: ...;
                getUTXOs: ...;
                getValidatorsAt: ...;
                issueTx: ...;
                sampleValidators: ...;
                validatedBy: ...;
                validates: ...;
            },
        ) => client,
    ) => { [K in (...)
    | (...)
    | (...)]: (...)[(...)] };
    getBalance: (args: GetBalanceParameters) => Promise<GetBalanceReturnType>;
    getBlock: (args: GetBlockParameters) => Promise<PChainBlockType>;
    getBlockByHeight: (args: GetBlockByHeightParameters) => Promise<PChainBlockType>;
    getBlockchains: () => Promise<GetBlockchainsReturnType>;
    getBlockchainStatus: (args: GetBlockchainStatusParameters) => Promise<GetBlockchainStatusReturnType>;
    getCurrentSupply: (args: GetCurrentSupplyParameters) => Promise<GetCurrentSupplyReturnType>;
    getCurrentValidators: (args: GetCurrentValidatorsParameters) => Promise<GetCurrentValidatorsReturnType>;
    getFeeConfig: () => Promise<GetFeeConfigReturnType>;
    getFeeState: () => Promise<GetFeeStateReturnType>;
    getHeight: () => Promise<GetHeightReturnType>;
    getL1Validator: (args: GetL1ValidatorParameters) => Promise<GetL1ValidatorReturnType>;
    getMinStake: (args: GetMinStakeParameters) => Promise<GetMinStakeReturnType>;
    getProposedHeight: () => Promise<GetProposedHeightReturnType>;
    getRewardUTXOs: (args: GetRewardUTXOsParameters) => Promise<GetRewardUTXOsReturnType>;
    getStake: (args: GetStakeParameters) => Promise<GetStakeReturnType>;
    getStakingAssetID: (args: GetStakingAssetIDParameters) => Promise<GetStakingAssetIDReturnType>;
    getSubnet: (args: GetSubnetParameters) => Promise<GetSubnetReturnType>;
    getSubnets: (args: GetSubnetsParameters) => Promise<GetSubnetsReturnType>;
    getTimestamp: () => Promise<GetTimestampReturnType>;
    getTotalStake: (args: GetTotalStakeParameters) => Promise<GetTotalStakeReturnType>;
    getTx: (args: GetTxParameters) => Promise<PChainTransactionType>;
    getTxStatus: (args: GetTxStatusParameters) => Promise<GetTxStatusReturnType>;
    getUTXOs: (args: GetUTXOsParameters) => Promise<GetUTXOsReturnType>;
    getValidatorsAt: (args: GetValidatorsAtParameters) => Promise<GetValidatorsAtReturnType>;
    issueTx: (args: IssueTxParameters) => Promise<IssueTxReturnType>;
    sampleValidators: (args: SampleValidatorsParameters) => Promise<SampleValidatorsReturnType>;
    validatedBy: (args: ValidatedByParameters) => Promise<ValidatedByReturnType>;
    validates: (args: ValidatesParameters) => Promise<ValidatesReturnType>;
}

A P-Chain Client. PChainClient

• extend: <const client extends { [key: string]: unknown }>(
      fn: (
          client: {
              extend: ...;
              getBalance: ...;
              getBlock: ...;
              getBlockByHeight: ...;
              getBlockchains: ...;
              getBlockchainStatus: ...;
              getCurrentSupply: ...;
              getCurrentValidators: ...;
              getFeeConfig: ...;
              getFeeState: ...;
              getHeight: ...;
              getL1Validator: ...;
              getMinStake: ...;
              getProposedHeight: ...;
              getRewardUTXOs: ...;
              getStake: ...;
              getStakingAssetID: ...;
              getSubnet: ...;
              getSubnets: ...;
              getTimestamp: ...;
              getTotalStake: ...;
              getTx: ...;
              getTxStatus: ...;
              getUTXOs: ...;
              getValidatorsAt: ...;
              issueTx: ...;
              sampleValidators: ...;
              validatedBy: ...;
              validates: ...;
          },
      ) => client,
  ) => { [K in (...)
  | (...)
  | (...)]: (...)[(...)] }

• getBalance: (args: GetBalanceParameters) => Promise<GetBalanceReturnType>

  Get the balance of AVAX controlled by a given address.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetbalance

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const balance = await client.pChain.getBalance({
    addresses: ["P-custom18jma8ppw3nhx5r4ap8clazz0dps7rv5u9xde7p"]
  })
  Copy

• getBlock: (args: GetBlockParameters) => Promise<PChainBlockType>

  Get a block by its ID.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetblock

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const block = await client.pChain.getBlock({
    blockID: "d7WYmb8VeZNHsny3EJCwMm6QA37s1EHwMxw1Y71V3FqPZ5EFG",
    encoding: "hex"
  })
  Copy

• getBlockByHeight: (args: GetBlockByHeightParameters) => Promise<PChainBlockType>

  Get a block by its height.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetblockbyheight

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const block = await client.pChain.getBlockByHeight({
    height: 1000001,
    encoding: "hex"
  })
  Copy

• getBlockchains: () => Promise<GetBlockchainsReturnType>

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

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetblockchains

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const blockchains = await client.pChain.getBlockchains()
  Copy

• getBlockchainStatus: (args: GetBlockchainStatusParameters) => Promise<GetBlockchainStatusReturnType>

  Get the status of a blockchain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetblockchainstatus

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const status = await client.pChain.getBlockchainStatus({
    blockchainID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getCurrentSupply: (args: GetCurrentSupplyParameters) => Promise<GetCurrentSupplyReturnType>

  Get the current supply of an asset.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetcurrentsupply

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const supply = await client.pChain.getCurrentSupply({
    assetID: "FvwEAhmxKfeiG8SnEvq42hc6whRyY3EFYAvebMqDNDGCgxN5Z"
  })
  Copy

• getCurrentValidators: (args: GetCurrentValidatorsParameters) => Promise<GetCurrentValidatorsReturnType>

  Get the current validators of the specified Subnet.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetcurrentvalidators

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const validators = await client.pChain.getCurrentValidators({
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getFeeConfig: () => Promise<GetFeeConfigReturnType>

  Get the fee configuration for the P-Chain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetfeeconfig

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const feeConfig = await client.pChain.getFeeConfig()
  Copy

• getFeeState: () => Promise<GetFeeStateReturnType>

  Get the current fee state of the P-Chain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetfeestate

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const feeState = await client.pChain.getFeeState()
  Copy

• getHeight: () => Promise<GetHeightReturnType>

  Get the height of the last accepted block.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetheight

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const height = await client.pChain.getHeight()
  Copy

• getL1Validator: (args: GetL1ValidatorParameters) => Promise<GetL1ValidatorReturnType>

  Get the L1 validator information.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetl1validator

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const validator = await client.pChain.getL1Validator({
    nodeID: "NodeID-111111111111111111111111111111111111111"
  })
  Copy

• getMinStake: (args: GetMinStakeParameters) => Promise<GetMinStakeReturnType>

  Get the minimum stake amount for a subnet.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetminstake

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const minStake = await client.pChain.getMinStake({
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getProposedHeight: () => Promise<GetProposedHeightReturnType>

  Get the proposed height of the P-Chain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetproposedheight

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const proposedHeight = await client.pChain.getProposedHeight()
  Copy

• getRewardUTXOs: (args: GetRewardUTXOsParameters) => Promise<GetRewardUTXOsReturnType>

  Get the reward UTXOs for a transaction.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetrewardutxos

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const rewardUTXOs = await client.pChain.getRewardUTXOs({
    txID: "11111111111111111111111111111111LpoYY",
    encoding: "hex"
  })
  Copy

• getStake: (args: GetStakeParameters) => Promise<GetStakeReturnType>

  Get the stake amount for a set of addresses.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetstake

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const stake = await client.pChain.getStake({
    addresses: ["P-custom18jma8ppw3nhx5r4ap8clazz0dps7rv5u9xde7p"],
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getStakingAssetID: (args: GetStakingAssetIDParameters) => Promise<GetStakingAssetIDReturnType>

  Get the staking asset ID for a subnet.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetstakingassetid

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const stakingAssetID = await client.pChain.getStakingAssetID({
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getSubnet: (args: GetSubnetParameters) => Promise<GetSubnetReturnType>

  Get information about a subnet.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetsubnet

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const subnet = await client.pChain.getSubnet({
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getSubnets: (args: GetSubnetsParameters) => Promise<GetSubnetsReturnType>

  Get all subnets.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetsubnets

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const subnets = await client.pChain.getSubnets()
  Copy

• getTimestamp: () => Promise<GetTimestampReturnType>

  Get the current timestamp of the P-Chain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgettimestamp

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const timestamp = await client.pChain.getTimestamp()
  Copy

• getTotalStake: (args: GetTotalStakeParameters) => Promise<GetTotalStakeReturnType>

  Get the total stake amount for a subnet.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgettotalstake

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const totalStake = await client.pChain.getTotalStake({
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getTx: (args: GetTxParameters) => Promise<PChainTransactionType>

  Get a transaction by its ID.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgettx

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const tx = await client.pChain.getTx({
    txID: "11111111111111111111111111111111LpoYY",
    encoding: "hex"
  })
  Copy

• getTxStatus: (args: GetTxStatusParameters) => Promise<GetTxStatusReturnType>

  Get the status of a transaction.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgettxstatus

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const status = await client.pChain.getTxStatus({
    txID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• getUTXOs: (args: GetUTXOsParameters) => Promise<GetUTXOsReturnType>

  Get the UTXOs for a set of addresses.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetutxos

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const utxos = await client.pChain.getUTXOs({
    addresses: ["P-custom18jma8ppw3nhx5r4ap8clazz0dps7rv5u9xde7p"],
    sourceChain: "X"
  })
  Copy

• getValidatorsAt: (args: GetValidatorsAtParameters) => Promise<GetValidatorsAtReturnType>

  Get the validators at a specific height.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformgetvalidatorsat

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const validators = await client.pChain.getValidatorsAt({
    height: 1000001,
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• issueTx: (args: IssueTxParameters) => Promise<IssueTxReturnType>

  Issue a transaction to the Platform Chain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformissuetx

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const txID = await client.pChain.issueTx({
    tx: "0x00000009de31b4d8b22991d51aa6aa1fc733f23a851a8c9400000000000186a0000000005f041280000000005f9ca900000030390000000000000001fceda8f90fcb5d30614b99d79fc4baa29307762668f16eb0259a57c2d3b78c875c86ec2045792d4df2d926c40f829196e0bb97ee697af71f5b0a966dabff749634c8b729855e937715b0e44303fd1014daedc752006011b730",
    encoding: "hex"
  })
  Copy

• sampleValidators: (args: SampleValidatorsParameters) => Promise<SampleValidatorsReturnType>

  Sample validators from the specified Subnet.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformsamplevalidators

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const validators = await client.pChain.sampleValidators({
    size: 2,
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• validatedBy: (args: ValidatedByParameters) => Promise<ValidatedByReturnType>

  Get the Subnet that validates a given blockchain.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformvalidatedby

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const subnetID = await client.pChain.validatedBy({
    blockchainID: "11111111111111111111111111111111LpoYY"
  })
  Copy

• validates: (args: ValidatesParameters) => Promise<ValidatesReturnType>

  Get the IDs of the blockchains a Subnet validates.

  • Docs: https://build.avax.network/docs/api-reference/p-chain/api#platformvalidates

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const blockchainIDs = await client.pChain.validates({
    subnetID: "11111111111111111111111111111111LpoYY"
  })
  Copy

import { createPChainClient} from '@avalanche-sdk/client'
import { avalanche } from '@avalanche-sdk/client/chains'

const client = createPChainClient({
  chain: avalanche,
  transport: {
    type: "http",
  },
})

// Get the current validators
const validators = await client.getCurrentValidators({})

// Get subnet information
const subnet = await client.getSubnet({ subnetID: 'subnet-id' })
Copy