AvaCloud SDK TypeScript

The AvaCloud SDK is a powerful and flexible toolset designed to simplify the integration with AvaCloud's suite of blockchain services. Currently, this SDK is focused on providing robust support for Data APIs.

SDK Installation

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

NPM

npm add @avalabs/avacloud-sdk

PNPM

pnpm add @avalabs/avacloud-sdk

Bun

bun add @avalabs/avacloud-sdk

Yarn

yarn add @avalabs/avacloud-sdk zod

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

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.

{
  "mcpServers": {
    "AvaCloudSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "@avalabs/avacloud-sdk",
        "--",
        "mcp", "start",
        "--server-url", "...",
        "--api-key", "...",
        "--chain-id", "...",
        "--network", "..."
      ]
    }
  }
}

{
  "mcpServers": {
    "AvaCloudSDK": {
      "command": "npx",
      "args": [
        "-y", "--package", "@avalabs/avacloud-sdk",
        "--",
        "mcp", "start",
        "--server-url", "...",
        "--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 @avalabs/avacloud-sdk -- mcp start --help

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
});

async function run() {
  await avaCloudSDK.sendAddressActivityWebhook({
    webhookId: "401da7d9-d6d7-46c8-b431-72ff1e1543f4",
    eventType: "address_activity",
    messageId: "bc9732db-2430-4296-afc3-c51267beb14a",
    event: {
      transaction: {
        blockHash:
          "0x2a47bebed93db4a21cc8339980f004cc67f17d0dff4a368001e450e7be2edaa0",
        blockNumber: "45396106",
        from: "0x737F6b0b8A04e8462d0fC7076451298F0dA9a972",
        gas: "80000",
        gasPrice: "52000000000",
        maxFeePerGas: "52000000000",
        maxPriorityFeePerGas: "2000000000",
        txHash:
          "0xfd91150d236ec5c3b1ee325781affad5b0b4d7eb0187c84c220ab115eaa563e8",
        txStatus: "1",
        input:
          "0xa9059cbb00000000000000000000000040e832c3df9562dfae5a86a4849f27f687a9b46b00000000000000000000000000000000000000000000000000000000c68b2a69",
        nonce: "0",
        to: "0x9702230a8ea53601f5cd2dc00fdbc13d4df4a8c7",
        transactionIndex: 1,
        value: "0",
        type: 2,
        chainId: "43114",
        receiptCumulativeGasUsed: "668508",
        receiptGasUsed: "44038",
        receiptEffectiveGasPrice: "27000000000",
        receiptRoot:
          "0xe5b018c29a77c8a92c4ea2f2d7e58820283041a52e14a0620d90d13b881e1ee3",
        blockTimestamp: 1715621840,
        contractAddress: "0x0000000000000000000000000000000000000000",
        erc20Transfers: [
          {
            transactionHash:
              "0xfd91150d236ec5c3b1ee325781affad5b0b4d7eb0187c84c220ab115eaa563e8",
            type: "ERC20",
            from: "0x737F6b0b8A04e8462d0fC7076451298F0dA9a972",
            to: "0x40E832C3Df9562DfaE5A86A4849F27F687A9B46B",
            value: "3331009129",
            tokenId: "2",
            blockTimestamp: 1640995200,
            logIndex: 5,
            erc20Token: {
              address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
              name: "TetherToken",
              symbol: "USDt",
              decimals: 6,
              valueWithDecimals: "3331.009129",
            },
            erc721Token: {
              address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
              name: "TetherToken",
              symbol: "USDt",
              decimals: 6,
              valueWithDecimals: "3331.009129",
            },
            erc1155Token: {
              address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
              name: "TetherToken",
              symbol: "USDt",
              decimals: 6,
              valueWithDecimals: "3331.009129",
            },
          },
          {
            transactionHash:
              "0xfd91150d236ec5c3b1ee325781affad5b0b4d7eb0187c84c220ab115eaa563e8",
            type: "ERC20",
            from: "0x737F6b0b8A04e8462d0fC7076451298F0dA9a972",
            to: "0x40E832C3Df9562DfaE5A86A4849F27F687A9B46B",
            value: "3331009129",
            tokenId: "2",
            blockTimestamp: 1640995200,
            logIndex: 5,
            erc20Token: {
              address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
              name: "TetherToken",
              symbol: "USDt",
              decimals: 6,
              valueWithDecimals: "3331.009129",
            },
            erc721Token: {
              address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
              name: "TetherToken",
              symbol: "USDt",
              decimals: 6,
              valueWithDecimals: "3331.009129",
            },
            erc1155Token: {
              address: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
              name: "TetherToken",
              symbol: "USDt",
              decimals: 6,
              valueWithDecimals: "3331.009129",
            },
          },
        ],
        erc721Transfers: [],
        erc1155Transfers: [],
        internalTransactions: [
          {
            from: "0x737F6b0b8A04e8462d0fC7076451298F0dA9a972",
            to: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
            internalTxType: "call",
            value: "50000000000000000",
            gasUsed: "44038",
            gasLimit: "50000",
            transactionHash:
              "0xfd91150d236ec5c3b1ee325781affad5b0b4d7eb0187c84c220ab115eaa563e8",
          },
          {
            from: "0x737F6b0b8A04e8462d0fC7076451298F0dA9a972",
            to: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
            internalTxType: "call",
            value: "50000000000000000",
            gasUsed: "44038",
            gasLimit: "50000",
            transactionHash:
              "0xfd91150d236ec5c3b1ee325781affad5b0b4d7eb0187c84c220ab115eaa563e8",
          },
          {
            from: "0x737F6b0b8A04e8462d0fC7076451298F0dA9a972",
            to: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
            internalTxType: "call",
            value: "50000000000000000",
            gasUsed: "44038",
            gasLimit: "50000",
            transactionHash:
              "0xfd91150d236ec5c3b1ee325781affad5b0b4d7eb0187c84c220ab115eaa563e8",
          },
        ],
        accessList: [
          {
            accessAddresses: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
            storageKeys: [
              "<value 1>",
              "<value 2>",
            ],
          },
          {
            accessAddresses: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
            storageKeys: [
              "<value 1>",
              "<value 2>",
            ],
          },
          {
            accessAddresses: "0x9702230A8Ea53601f5cD2dc00fDBc13d4dF4A8c7",
            storageKeys: [
              "<value 1>",
              "<value 2>",
            ],
          },
        ],
        networkToken: {
          tokenName: "TetherToken",
          tokenSymbol: "USDt",
          tokenDecimals: 6,
          valueWithDecimals: "3331.009129",
        },
      },
      logs: [
        {
          address: "0x54C800d2331E10467143911aabCa092d68bF4166",
          topic0:
            "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
          topic1:
            "0x0000000000000000000000000000333883f313ad709f583d0a3d2e18a44ef29b",
          topic2:
            "0x0000000000000000000000000000000000000000000000000000000000000000",
          topic3:
            "0x0000000000000000000000000000000000000000000000000000000000001350",
          data: "0x",
          transactionIndex: 2,
          logIndex: 10,
          removed: false,
        },
        {
          address: "0x54C800d2331E10467143911aabCa092d68bF4166",
          topic0:
            "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
          topic1:
            "0x0000000000000000000000000000333883f313ad709f583d0a3d2e18a44ef29b",
          topic2:
            "0x0000000000000000000000000000000000000000000000000000000000000000",
          topic3:
            "0x0000000000000000000000000000000000000000000000000000000000001350",
          data: "0x",
          transactionIndex: 2,
          logIndex: 10,
          removed: false,
        },
        {
          address: "0x54C800d2331E10467143911aabCa092d68bF4166",
          topic0:
            "0x8c5be1e5ebec7d5bd14f71427d1e84f3dd0314c0f7b2291e5b200ac8c7c3b925",
          topic1:
            "0x0000000000000000000000000000333883f313ad709f583d0a3d2e18a44ef29b",
          topic2:
            "0x0000000000000000000000000000000000000000000000000000000000000000",
          topic3:
            "0x0000000000000000000000000000000000000000000000000000000000001350",
          data: "0x",
          transactionIndex: 2,
          logIndex: 10,
          removed: false,
        },
      ],
    },
  });
}

run();

Available Resources and Operations

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.

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.

Example

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
  network: "mainnet",
});

async function run() {
  const result = await avaCloudSDK.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 { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await avaCloudSDK.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 { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
});

async function run() {
  const result = await avaCloudSDK.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 { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

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

  console.log(result);
}

run();

Error Handling

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

Example

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";
import * as errors from "@avalabs/avacloud-sdk/models/errors";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  chainId: "43114",
});

async function run() {
  try {
    await avaCloudSDK.data.nfts.reindex({
      address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
      tokenId: "145",
    });
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AvaCloudSDKError) {
      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.BadRequest) {
        console.log(error.data$.message); // errors.Message
        console.log(error.data$.statusCode); // number
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• AvaCloudSDKError: The base class for HTTP error responses.
  • BadRequest: 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.
  • Unauthorized: 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.
  • Forbidden: 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.
  • NotFound: 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.
  • TooManyRequests: 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.
  • BadGateway: This is an internal error indicating invalid response received by the client-facing proxy or gateway from the upstream server. Status code 502.
  • ServiceUnavailable: 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.

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 { AvaCloudSDK } from "@avalabs/avacloud-sdk";
import { HTTPClient } from "@avalabs/avacloud-sdk/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 AvaCloudSDK({ httpClient });

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

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

import { AvaCloudSDK } from "@avalabs/avacloud-sdk";

const avaCloudSDK = new AvaCloudSDK({
  serverURL: "https://api.example.com",
  apiKey: "<YOUR_API_KEY_HERE>",
});

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

  console.log(result);
}

run();

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 { AvaCloudSDK } from "@avalabs/avacloud-sdk";

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

Summary

Data API: The Data API provides web3 application developers with multi-chain data related to Avalanche's primary network, Avalanche subnets, and Ethereum. With Data API, you can easily build products that leverage real-time and historical transaction and transfer history, native and token balances, and various types of token metadata. The API is in Beta and may be subject to change.

If you have feedback or feature requests for the API, please submit them here. Bug reports can be submitted here, and any potential security issues can be reported here.

Table of Contents

• SDK Installation
• Requirements
• SDK Example Usage
• Available Resources and Operations
• Standalone functions
• Global Parameters
• Pagination
• Retries
• Error Handling
• Custom HTTP Client
• Authentication
• Debugging
• Verify Webhook Signature
• Development
  • Maturity
  • Contributions

Verify Webhook Signature

The isValidSignature function is a utility function in the Avalanche SDK that verifies the authenticity and integrity of incoming webhook requests from AvaCloud. This function ensures that the requests are coming from a trusted source by validating the HMAC SHA-256 signature provided in the request header.Usage

Import and use the isValidSignature function:

import { isValidSignature } from '@avalabs/avacloud-sdk/utils';
import express from 'express';

const app = express();
app.use(express.json());

const signingSecret = 'your-signing-secret'; // Replace with your signing secret

app.post('/webhook', (req, res) => {
    const signature = req.headers['x-signature'];
    const payload = req.body;

    if (isValidSignature(signingSecret, signature, payload)) {
        console.log('Valid signature');
        // Process the request
    } else {
        console.log('Invalid signature');
    }

    res.json({ received: true });
});

app.listen(8000, () => console.log('Server running on port 8000'));

Parameters

• signingSecret: The secret key for signing.
• signature: The HMAC SHA-256 signature from the request header.
• payload: The JSON payload of the request.

More Information

Use this function to securely validate webhooks from AvaCloud.

For more information, visit the AvaCloud Developers documentation.

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.