Avalanche SDK Client
    Preparing search index...

    Function alias

    • Assign an API endpoint an alias, a different endpoint for the API. The original endpoint will still work. This change only affects this node.

      Type Parameters

      • chain extends undefined | Chain

      Parameters

      • client: { extend: <const client extends { [key: string]: unknown }>(fn: (client: { extend: ... }) => client) => { [K in (...) | (...) | (...)]: (...)[(...)] } }

        The client to use. AvalancheCoreClient

      • params: AliasParameters

        The endpoint and alias. AliasParameters

      Returns Promise<void>

      Promise that resolves when the alias is set

      import { createAvalancheCoreClient } from '@avalanche-sdk/client'
      import { avalanche } from '@avalanche-sdk/client/chains'
      import { alias } from '@avalanche-sdk/client/methods/admin'

      const client = createAvalancheCoreClient({
      chain: avalanche,
      transport: {
      type: "http",
      url: "<url>",
      },
      });

      await alias(client, {
      endpoint: "bc/X",
      alias: "myAlias"
      });