npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@avalanche-sdk/chainkit

v0.3.13

Published

<div align="center"> <h1> @avalanche-sdk/chainkit </h1> <p> The Avalanche ChainKit SDK is a powerful and flexible toolset designed to simplify the integration with Avalanche's suite of blockchain services. </p> <p>

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

sayankarsayankariamrajranjaniamrajranjan

Keywords

Readme

Summary

Data, Metrics, and Webhooks API: The Avalanche API suite offers powerful tools for real-time and historical blockchain data. The Webhooks API enables instant monitoring of on-chain events, including smart contract activity, NFT transfers, and wallet transactions, with customizable filters and secure notifications. The Metrics API (Beta) provides analytics on blockchain activity, while the Data API (Beta) delivers multi-chain data for Avalanche and Ethereum, including transaction history, token balances, and metadata. These APIs empower developers to build dynamic web3 applications with real-time insights and seamless integration.

Table of Contents

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @avalanche-sdk/chainkit

PNPM

pnpm add @avalanche-sdk/chainkit

Bun

bun add @avalanche-sdk/chainkit

Yarn

yarn add @avalanche-sdk/chainkit

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Model Context Protocol (MCP) Server

This SDK is also an installable MCP server where the various SDK methods are exposed as tools that can be invoked by AI applications.

Node.js v20 or greater is required to run the MCP server from npm.

Add the following server definition to your claude_desktop_config.json file:

{
  "mcpServers": {
    "Avalanche": {
      "command": "npx",
      "args": [
        "-y", "--package", "@avalanche-sdk/chainkit",
        "--",
        "mcp", "start",
        "--api-key", "...",
        "--chain-id", "...",
        "--network", "...",
        "--enable-telemetry", "...",
        "--avacloud", "..."
      ]
    }
  }
}

Create a .cursor/mcp.json file in your project root with the following content:

{
  "mcpServers": {
    "Avalanche": {
      "command": "npx",
      "args": [
        "-y", "--package", "@avalanche-sdk/chainkit",
        "--",
        "mcp", "start",
        "--api-key", "...",
        "--chain-id", "...",
        "--network", "...",
        "--enable-telemetry", "...",
        "--avacloud", "..."
      ]
    }
  }
}

You can also run MCP servers as a standalone binary with no additional dependencies. You must pull these binaries from available Github releases:

curl -L -o mcp-server \
    https://github.com/{org}/{repo}/releases/download/{tag}/mcp-server-bun-darwin-arm64 && \
chmod +x mcp-server

If the repo is a private repo you must add your Github PAT to download a release -H "Authorization: Bearer {GITHUB_PAT}".

{
  "mcpServers": {
    "Todos": {
      "command": "./DOWNLOAD/PATH/mcp-server",
      "args": [
        "start"
      ]
    }
  }
}

For a full list of server arguments, run:

npx -y --package @avalanche-sdk/chainkit -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

async function run() {
  const result = await avalanche.webhooks.create({
    eventType: "address_activity",
    url: "https://sophisticated-exterior.org/",
    chainId: "<id>",
    metadata: {
      eventSignatures: [
        "0x61cbb2a3dee0b6064c2e681aadd61677fb4ef319f0b547508d495626f5a62f64",
      ],
      addresses: [
        "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
      ],
    },
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

| Name | Type | Scheme | | -------- | ------ | ------- | | apiKey | apiKey | API key |

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await avalanche.metrics.healthCheck();

  console.log(result);
}

run();

Available Resources and Operations

AVAXSupply

  • get - Get AVAX supply information

Data

  • healthCheck - Get the health of the service
  • liveCheck - Get the liveliness of the service (reads only)

Data.Evm.Address.Balances

Data.Evm.Address.Chains

  • list - List all chains associated with a given address

Data.Evm.Address.Contracts

Data.Evm.Address.Transactions

Data.Evm.Blocks

Data.Evm.Chains

  • list - List chains
  • get - Get chain information
  • ~~getAddressChains~~ - [Deprecated] Gets a list of all chains where the address was either a sender or receiver in a transaction or ERC transfer. The list is currently updated every 15 minutes.

⚠️ This operation will be removed in a future release. Please use /v1/address/:address/chains endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/transactions endpoint instead . :warning: Deprecated

  • ~~listAllLatestBlocks~~ - [Deprecated] Lists the latest blocks for all supported EVM chains. Filterable by network.

⚠️ This operation will be removed in a future release. Please use /v1/blocks endpoint instead . :warning: Deprecated

Data.Evm.Contracts

Data.Evm.Transactions

Data.Icm

Data.Nfts

  • reindex - Reindex NFT metadata
  • list - List tokens
  • get - Get token details

Data.Operations

Data.PrimaryNetwork

Data.PrimaryNetwork.Balances
Data.PrimaryNetwork.Blocks
Data.PrimaryNetwork.Rewards
Data.PrimaryNetwork.Transactions
Data.PrimaryNetwork.Utxos
Data.PrimaryNetwork.Vertices

Data.SignatureAggregator

  • aggregate - Aggregate Signatures
  • get - Get Aggregated Signatures

~~Data.Teleporter~~

⚠️ This operation will be removed in a future release. Please use /v1/icm/messages/:messageId endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/icm/messages endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/icm/addresses/:address/messages endpoint instead . :warning: Deprecated

Data.UsageMetrics

  • getUsage - Get usage metrics for the Data API
  • getLogs - Get logs for requests made by client
  • getSubnetRpcUsage - Get usage metrics for the Subnet RPC
  • ~~getRpcUsageMetrics~~ - [Deprecated] Gets metrics for public Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.

⚠️ This operation will be removed in a future release. Please use /v1/subnetRpcUsageMetrics endpoint instead. :warning: Deprecated

Metrics

Metrics.Chains

Metrics.L1Validators

Metrics.Networks

Metrics.Subnets

  • getValidators - Get addresses running validators during a given time frame

Webhooks

Webhooks.Addresses

  • list - List adresses by EVM activity webhooks
  • remove - Remove addresses from EVM activity webhook
  • add - Add addresses to EVM activity webhook

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

⚠️ This operation will be removed in a future release. Please use /v1/address/:address/chains endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/blocks endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/transactions endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/icm/messages/:messageId endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/icm/messages endpoint instead . :warning: Deprecated

⚠️ This operation will be removed in a future release. Please use /v1/icm/addresses/:address/messages endpoint instead . :warning: Deprecated

  • ~~dataUsageMetricsGetRpcUsageMetrics~~ - [Deprecated] Gets metrics for public Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.

⚠️ This operation will be removed in a future release. Please use /v1/subnetRpcUsageMetrics endpoint instead. :warning: Deprecated

Global Parameters

Certain parameters are configured globally. These parameters may be set on the SDK client instance itself during initialization. When configured as an option during SDK initialization, These global values will be used as defaults on the operations that use them. When such operations are called, there is a place in each to override the global value, if needed.

For example, you can set chainId to "43114" at SDK initialization and then you do not have to pass the same value on calls to operations like list. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.

Available Globals

The following global parameters are available.

| Name | Type | Description | | --------------- | ----------------------------- | -------------------------------------------------------- | | chainId | string | A supported EVM chain id, chain alias, or blockchain id. | | network | components.GlobalParamNetwork | A supported network type mainnet or testnet/fuji. | | enableTelemetry | boolean | A flag to enable or disable telemetry | | avacloud | boolean | A flag to use represent a avacloud api key holder |

Example

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche({
  chainId: "43114",
  network: "mainnet",
  enableTelemetry: false,
  avacloud: true,
});

async function run() {
  const result = await avalanche.metrics.chains.list({
    network: "mainnet",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

async function run() {
  const result = await avalanche.metrics.chains.list({
    network: "mainnet",
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

async function run() {
  const result = await avalanche.metrics.healthCheck({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await avalanche.metrics.healthCheck();

  console.log(result);
}

run();

Error Handling

AvalancheError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Avalanche } from "@avalanche-sdk/chainkit";
import * as errors from "@avalanche-sdk/chainkit/models/errors";

const avalanche = new Avalanche({
  chainId: "43114",
});

async function run() {
  try {
    await avalanche.data.nfts.reindex({
      address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
      tokenId: "145",
    });
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AvalancheError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.BadRequestError) {
        console.log(error.data$.message); // errors.BadRequestMessage
        console.log(error.data$.statusCode); // number
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

  • AvalancheError: The base class for HTTP error responses.
    • BadRequestError: Bad requests generally mean the client has passed invalid or malformed parameters. Error messages in the response could help in evaluating the error. Status code 400.
    • UnauthorizedError: When a client attempts to access resources that require authorization credentials but the client lacks proper authentication in the request, the server responds with 401. Status code 401.
    • ForbiddenError: When a client attempts to access resources with valid credentials but doesn't have the privilege to perform that action, the server responds with 403. Status code 403.
    • NotFoundError: The error is mostly returned when the client requests with either mistyped URL, or the passed resource is moved or deleted, or the resource doesn't exist. Status code 404.
    • TooManyRequestsError: This error is returned when the client has sent too many, and has hit the rate limit. Status code 429.
    • InternalServerError: The error is a generic server side error that is returned for any uncaught and unexpected issues on the server side. This should be very rare, and you may reach out to us if the problem persists for a longer duration. Status code 500.
    • BadGatewayError: This is an internal error indicating invalid response received by the client-facing proxy or gateway from the upstream server. Status code 502.
    • ServiceUnavailableError: The error is returned for certain routes on a particular Subnet. This indicates an internal problem with our Subnet node, and may not necessarily mean the Subnet is down or affected. Status code 503.

Network errors:

Inherit from AvalancheError:

  • ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche({
  serverURL: "https://data-api.avax.network",
});

async function run() {
  const result = await avalanche.metrics.healthCheck();

  console.log(result);
}

run();

Override Server URL Per-Operation

The server URL can also be overridden on a per-operation basis, provided a server list was specified for the operation. For example:

import { Avalanche } from "@avalanche-sdk/chainkit";

const avalanche = new Avalanche();

async function run() {
  const result = await avalanche.metrics.healthCheck({
    serverURL: "https://metrics.avax.network",
  });

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Avalanche } from "@avalanche-sdk/chainkit";
import { HTTPClient } from "@avalanche-sdk/chainkit/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Avalanche({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

[!WARNING] Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Avalanche } from "@avalanche-sdk/chainkit";

const sdk = new Avalanche({ debugLogger: console });

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.