@avalabs/avalanche-sdk
Advanced tools
The Avalanche SDK is a powerful and flexible toolset designed to simplify the integration with Avalanche's suite of blockchain services. Currently, this SDK is focused on providing robust support for Glacier APIs.
npm add @avalabs/avalanche-sdk
pnpm add @avalabs/avalanche-sdk
bun add @avalabs/avalanche-sdk
yarn add @avalabs/avalanche-sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
For supported JavaScript runtimes, please consult RUNTIMES.md.
import { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.healthCheck.glacierHealthCheck();
// Handle the result
console.log(result);
}
run();
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.
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 reindexNft. But if you want to do so you may, which will locally override the global setting. See the example code below for a demonstration.
The following global parameters are available.
| Name | Type | Required | Description |
|---|---|---|---|
| chainId | string | A supported EVM chain id, chain alias, or blockchain id. | |
| network | components.Network | A supported network type mainnet or a testnet. |
import { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
await avalancheSDK.glacier.nfts.reindexNft({
address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
tokenId: "145",
});
}
run();
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 { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.nfts.listTokens({
pageSize: 10,
address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
});
for await (const page of result) {
// handle page
}
}
run();
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 { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.healthCheck.glacierHealthCheck({
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 { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
retryConfig: {
strategy: "backoff",
backoff: {
initialInterval: 1,
maxInterval: 50,
exponent: 1.1,
maxElapsedTime: 100,
},
retryConnectionErrors: false,
},
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.healthCheck.glacierHealthCheck();
// Handle the result
console.log(result);
}
run();
All SDK methods return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.
| Error Object | Status Code | Content Type |
|---|---|---|
| errors.BadRequest | 400 | application/json |
| errors.Unauthorized | 401 | application/json |
| errors.Forbidden | 403 | application/json |
| errors.NotFound | 404 | application/json |
| errors.TooManyRequests | 429 | application/json |
| errors.InternalServerError | 500 | application/json |
| errors.BadGateway | 502 | application/json |
| errors.ServiceUnavailable | 503 | application/json |
| errors.SDKError | 4xx-5xx | / |
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 string since validation errors can list many issues and the plain error string may be difficult read when debugging.
import { AvalancheSDK } from "@avalabs/avalanche-sdk";
import { SDKValidationError } from "@avalabs/avalanche-sdk/models/errors";
const avalancheSDK = new AvalancheSDK({
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
try {
await avalancheSDK.glacier.nfts.reindexNft({
address: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
tokenId: "145",
});
} catch (err) {
switch (true) {
case err instanceof SDKValidationError: {
// Validation errors can be pretty-printed
console.error(err.pretty());
// Raw value may also be inspected
console.error(err.rawValue);
return;
}
case err instanceof errors.BadRequest: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Unauthorized: {
console.error(err); // handle exception
return;
}
case err instanceof errors.Forbidden: {
console.error(err); // handle exception
return;
}
case err instanceof errors.NotFound: {
console.error(err); // handle exception
return;
}
case err instanceof errors.TooManyRequests: {
console.error(err); // handle exception
return;
}
case err instanceof errors.InternalServerError: {
console.error(err); // handle exception
return;
}
case err instanceof errors.BadGateway: {
console.error(err); // handle exception
return;
}
case err instanceof errors.ServiceUnavailable: {
console.error(err); // handle exception
return;
}
default: {
throw err;
}
}
}
}
run();
You can override the default server globally by passing a server index to the serverIdx optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://glacier-api.avax.network | None |
import { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
serverIdx: 0,
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.healthCheck.glacierHealthCheck();
// Handle the result
console.log(result);
}
run();
The default server can also be overridden globally by passing a URL to the serverURL optional parameter when initializing the SDK client instance. For example:
import { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
serverURL: "https://glacier-api.avax.network",
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.healthCheck.glacierHealthCheck();
// Handle the result
console.log(result);
}
run();
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 { AvalancheSDK } from "@avalabs/avalanche-sdk";
import { HTTPClient } from "@avalabs/avalanche-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 AvalancheSDK({ httpClient });
This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
glacierApiKey | apiKey | API key |
To authenticate with the API the glacierApiKey parameter must be set when initializing the SDK client instance. For example:
import { AvalancheSDK } from "@avalabs/avalanche-sdk";
const avalancheSDK = new AvalancheSDK({
glacierApiKey: "<YOUR_API_KEY_HERE>",
chainId: "43114",
network: "mainnet",
});
async function run() {
const result = await avalancheSDK.glacier.healthCheck.glacierHealthCheck();
// Handle the result
console.log(result);
}
run();
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 { AvalancheSDK } from "@avalabs/avalanche-sdk";
const sdk = new AvalancheSDK({ debugLogger: console });
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.
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.
FAQs
Unknown package
The npm package @avalabs/avalanche-sdk receives a total of 0 weekly downloads. As such, @avalabs/avalanche-sdk popularity was classified as not popular.
We found that @avalabs/avalanche-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
pnpm 10 blocks lifecycle scripts by default to improve security, addressing supply chain attack risks but sparking debate over compatibility and workflow changes.
Product
Socket now supports uv.lock files to ensure consistent, secure dependency resolution for Python projects and enhance supply chain security.
Research
Security News
Socket researchers have discovered multiple malicious npm packages targeting Solana private keys, abusing Gmail to exfiltrate the data and drain Solana wallets.