Avalanche SDK Client
    Preparing search index...

    Type Alias IndexAPIActions

    type IndexAPIActions = {
        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>;
    }
    Index

    Properties

    getContainerByID getContainerByIndex getContainerRange getIndex getLastAccepted isAccepted

    Properties

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

    Get container by ID.

    Type declaration

    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"
    })
    getContainerByIndex: (args: GetContainerByIndexParameters) => Promise<GetContainerByIndexReturnType>

    Get container by index.

    Type declaration

    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"
    })
    getContainerRange: (args: GetContainerRangeParameters) => Promise<GetContainerRangeReturnType>

    Get a range of containers by their indices.

    Type declaration

    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"
    })
    getIndex: (args: GetIndexParameters) => Promise<GetIndexReturnType>

    Get the index of a container by its ID.

    Type declaration

    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"
    })
    getLastAccepted: (args: GetLastAcceptedParameters) => Promise<GetLastAcceptedReturnType>

    Get the last accepted container.

    Type declaration

    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"
    })
    isAccepted: (args: IsAcceptedParameters) => Promise<IsAcceptedReturnType>

    Check if a container is accepted.

    Type declaration

    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"
    })

    Settings

    Member Visibility

    On This Page

    Properties