Function createIndexApiClient

Returns {
    extend: <const client extends { [key: string]: unknown }>(
        fn: (client: { extend: ...; getContainerByID: ...; getContainerByIndex: ...; getContainerRange: ...; getIndex: ...; getLastAccepted: ...; isAccepted: ... }) => client,
    ) => { [K in (...) | (...) | (...)]: (...)[(...)] };
    getContainerByID: (args: GetContainerByIDParameters) => Promise<GetContainerByIDReturnType>;
    getContainerByIndex: (args: GetContainerByIndexParameters) => Promise<GetContainerByIndexReturnType>;
    getContainerRange: (args: GetContainerRangeParameters) => Promise<GetContainerRangeReturnType>;
    getIndex: (args: GetIndexParameters) => Promise<GetIndexReturnType>;
    getLastAccepted: (args: GetLastAcceptedParameters) => Promise<GetLastAcceptedReturnType>;
    isAccepted: (args: IsAcceptedParameters) => Promise<IsAcceptedReturnType>;
}

An Index API Client. IndexApiClient

• extend: <const client extends { [key: string]: unknown }>(
      fn: (client: { extend: ...; getContainerByID: ...; getContainerByIndex: ...; getContainerRange: ...; getIndex: ...; getLastAccepted: ...; isAccepted: ... }) => client,
  ) => { [K in (...) | (...) | (...)]: (...)[(...)] }

• getContainerByID: (args: GetContainerByIDParameters) => Promise<GetContainerByIDReturnType>

  Get container by ID.

  • Docs: https://build.avax.network/docs/api-reference/index-api#indexgetcontainerbyid

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const container = await client.indexPChainBlock.getContainerByID({
    id: "6fXf5hncR8LXvwtM8iezFQBpK5cubV6y1dWgpJCcNyzGB1EzY",
    encoding: "hex"
  })
  Copy

• getContainerByIndex: (args: GetContainerByIndexParameters) => Promise<GetContainerByIndexReturnType>

  Get container by index.

  • Docs: https://build.avax.network/docs/api-reference/index-api#indexgetcontainerbyindex

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const container = await client.indexPChainBlock.getContainerByIndex({
    index: 1,
    encoding: "hex"
  })
  Copy

• getContainerRange: (args: GetContainerRangeParameters) => Promise<GetContainerRangeReturnType>

  Get a range of containers by their indices.

  • Docs: https://build.avax.network/docs/api-reference/index-api#indexgetcontainerrange

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const containers = await client.indexPChainBlock.getContainerRange({
    startIndex: 0,
    endIndex: 10,
    encoding: "hex"
  })
  Copy

• getIndex: (args: GetIndexParameters) => Promise<GetIndexReturnType>

  Get the index of a container by its ID.

  • Docs: https://build.avax.network/docs/api-reference/index-api#indexgetindex

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const index = await client.indexPChainBlock.getIndex({
    id: "6fXf5hncR8LXvwtM8iezFQBpK5cubV6y1dWgpJCcNyzGB1EzY",
    encoding: "hex"
  })
  Copy

• getLastAccepted: (args: GetLastAcceptedParameters) => Promise<GetLastAcceptedReturnType>

  Get the last accepted container.

  • Docs: https://build.avax.network/docs/api-reference/index-api#indexgetlastaccepted

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const lastAccepted = await client.indexPChainBlock.getLastAccepted({
    encoding: "hex"
  })
  Copy

• isAccepted: (args: IsAcceptedParameters) => Promise<IsAcceptedReturnType>

  Check if a container is accepted.

  • Docs: https://build.avax.network/docs/api-reference/index-api#indexisaccepted

  Example

  import { createAvalancheClient} from '@avalanche-sdk/client'
  import { avalanche } from '@avalanche-sdk/client/chains'
  
  const client = createAvalancheClient({
    chain: avalanche,
    transport: {
      type: "http",
    },
  })
  
  const isAccepted = await client.indexPChainBlock.isAccepted({
    id: "6fXf5hncR8LXvwtM8iezFQBpK5cubV6y1dWgpJCcNyzGB1EzY",
    encoding: "hex"
  })
  Copy

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

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

// Get index P-Chain block
const block = await client.indexPChainBlock.getContainerByID({
  id: '0x1',
  encoding: 'hex'
})
Copy