Avalanche SDK Client
    Preparing search index...

    Function createAvalancheClient

    • Creates an Avalanche Client with a given transport configured for a Chain.

      The Avalanche Client is an interface to interact with the Avalanche network through various JSON-RPC API methods. It provides access to multiple sub-clients for different chains and APIs:

      • P-Chain (Platform Chain)
      • X-Chain (Exchange Chain)
      • C-Chain (Contract Chain)
      • Admin API
      • Info API
      • Health API
      • Index API

      Type Parameters

      • transport extends Transport
      • chain extends undefined | Chain = undefined
      • accountOrAddress extends undefined | `0x${string}` | Account = undefined
      • rpcSchema extends undefined | RpcSchema = undefined
      • raw extends boolean = false

      Parameters

      Returns { [K in string | number | symbol]: (Client_Base<(...), (...), (...), (...)> & AvalanchePublicActions & PublicActions & {} & ((...) extends (...) ? (...) : (...)))[K] }

      An Avalanche Client with access to all sub-clients. AvalancheClient

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

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

      // Access different chain clients
      const pChainClient = client.pChain
      const xChainClient = client.xChain
      const cChainClient = client.cChain

      // Access API clients
      const adminClient = client.admin
      const infoClient = client.info
      const healthClient = client.health
      const indexPChainBlockClient = client.indexPChainBlock

      // Get the latest block number
      const blockNumber = await client.pChain.getBlockNumber()

      // Get base fee
      const baseFee = await client.getBaseFee()

    Settings

    Member Visibility