0.0.7 • Published 5 months ago

@avalanche-sdk/devtools v0.0.7

Weekly downloads
-
License
-
Repository
github
Last release
5 months ago

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/devtools

PNPM

pnpm add @avalanche-sdk/devtools

Bun

bun add @avalanche-sdk/devtools

Yarn

yarn add @avalanche-sdk/devtools zod

# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.

!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/devtools",
        "--",
        "mcp", "start",
        "--api-key", "...",
        "--chain-id", "...",
        "--network", "..."
      ]
    }
  }
}

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

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

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/devtools -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

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

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

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

  // Handle the result
  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

NameTypeScheme
apiKeyapiKeyAPI 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/devtools";

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

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

  // Handle the result
  console.log(result);
}

run();

Available Resources and Operations

data

data.evm

data.evm.address

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

⚠️ 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.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

⚠️ 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.

NameTypeDescription
chainIdstringA supported EVM chain id, chain alias, or blockchain id.
networkcomponents.GlobalParamNetworkA supported network type mainnet or testnet/fuji.

Example

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

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

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

  for await (const page of result) {
    // Handle the page
    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/devtools";

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

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

  for await (const page of result) {
    // Handle the page
    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/devtools";

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

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

  // Handle the result
  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/devtools";

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

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

  // Handle the result
  console.log(result);
}

run();

Error Handling

Some methods specify known errors which can be thrown. All the known errors are enumerated in the models/errors/errors.ts module. The known errors for a method are documented under the Errors tables in SDK docs. For example, the reindex method may throw the following errors:

Error TypeStatus CodeContent Type
errors.BadRequestError400application/json
errors.UnauthorizedError401application/json
errors.ForbiddenError403application/json
errors.NotFoundError404application/json
errors.TooManyRequestsError429application/json
errors.InternalServerError500application/json
errors.BadGatewayError502application/json
errors.ServiceUnavailableError503application/json
errors.AvalancheAPIError4XX, 5XX*/*

If the method throws an error and it is not captured by the known errors, it will default to throwing a AvalancheAPIError.

import { Avalanche } from "@avalanche-sdk/devtools";
import {
  BadGatewayError,
  BadRequestError,
  ForbiddenError,
  InternalServerError,
  NotFoundError,
  SDKValidationError,
  ServiceUnavailableError,
  TooManyRequestsError,
  UnauthorizedError,
} from "@avalanche-sdk/devtools/models/errors";

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

async function run() {
  try {
    await avalanche.data.nfts.reindex({
      chainId: "43114",
      address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
      tokenId: "145",
    });
  } catch (err) {
    switch (true) {
      // The server response does not match the expected SDK schema
      case (err instanceof SDKValidationError): {
        // Pretty-print will provide a human-readable multi-line error message
        console.error(err.pretty());
        // Raw value may also be inspected
        console.error(err.rawValue);
        return;
      }
      case (err instanceof BadRequestError): {
        // Handle err.data$: BadRequestErrorData
        console.error(err);
        return;
      }
      case (err instanceof UnauthorizedError): {
        // Handle err.data$: UnauthorizedErrorData
        console.error(err);
        return;
      }
      case (err instanceof ForbiddenError): {
        // Handle err.data$: ForbiddenErrorData
        console.error(err);
        return;
      }
      case (err instanceof NotFoundError): {
        // Handle err.data$: NotFoundErrorData
        console.error(err);
        return;
      }
      case (err instanceof TooManyRequestsError): {
        // Handle err.data$: TooManyRequestsErrorData
        console.error(err);
        return;
      }
      case (err instanceof InternalServerError): {
        // Handle err.data$: InternalServerErrorData
        console.error(err);
        return;
      }
      case (err instanceof BadGatewayError): {
        // Handle err.data$: BadGatewayErrorData
        console.error(err);
        return;
      }
      case (err instanceof ServiceUnavailableError): {
        // Handle err.data$: ServiceUnavailableErrorData
        console.error(err);
        return;
      }
      default: {
        // Other errors such as network errors, see HTTPClientErrors for more details
        throw err;
      }
    }
  }
}

run();

Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The SDKValidationError that is thrown as a result will capture the raw value that failed validation in an attribute called rawValue. Additionally, a pretty() method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.

In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the models/errors/httpclienterrors.ts module:

HTTP Client ErrorDescription
RequestAbortedErrorHTTP request was aborted by the client
RequestTimeoutErrorHTTP request timed out due to an AbortSignal signal
ConnectionErrorHTTP client was unable to make a request to a server
InvalidRequestErrorAny input used to create a request is invalid
UnexpectedClientErrorUnrecognised or unexpected error

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/devtools";

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

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

  // Handle the result
  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/devtools";

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

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

  // Handle the result
  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/devtools";
import { HTTPClient } from "@avalanche-sdk/devtools/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 });

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/devtools";

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.

json-canonicalize
0.0.7

5 months ago

0.0.6

5 months ago

0.0.5

6 months ago

0.0.4

7 months ago

0.0.3

7 months ago