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.
The SDK can be installed with either npm, pnpm, bun or yarn package managers.
npm add @avalabs/avacloud-sdk
pnpm add @avalabs/avacloud-sdk
bun add @avalabs/avacloud-sdk
yarn add @avalabs/avacloud-sdk zod
# Note that Yarn does not install peer dependencies automatically. You will need
# to install zod as shown above.
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.
Claude installation steps
Add the following server definition to your claude_desktop_config.json
file:
{
"mcpServers": {
"AvaCloudSDK": {
"command": "npx",
"args": [
"-y", "--package", "@avalabs/avacloud-sdk",
"--",
"mcp", "start",
"--server-url", "...",
"--api-key", "...",
"--chain-id", "...",
"--network", "..."
]
}
}
}
Cursor installation steps
Create a .cursor/mcp.json
file in your project root with the following content:
{
"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
For supported JavaScript runtimes, please consult RUNTIMES.md.
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 methods
- healthCheck - Get the health of the service
- getNative - Get native token balance
- listErc20 - List ERC-20 balances
- listErc721 - List ERC-721 balances
- listErc1155 - List ERC-1155 balances
- listCollectibles - List collectible (ERC-721/ERC-1155) balances
- list - List all chains associated with a given address
- listDeployments - List deployed contracts
- list - List transactions
- listNative - List native transactions
- listErc20 - List ERC-20 transfers
- listErc721 - List ERC-721 transfers
- listErc1155 - List ERC-1155 transfers
- listInternal - List internal transactions
- listLatestAllChains - List latest blocks across all supported EVM chains
- listLatest - List latest blocks
- get - Get block
- listTransactions - List transactions for a block
- 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.
listAllLatestTransactions- [Deprecated] Lists the latest transactions for all supported EVM chains. Filterable by status.
listAllLatestBlocks- [Deprecated] Lists the latest blocks for all supported EVM chains. Filterable by network.
- getDeploymentTransaction - Get deployment transaction
- getMetadata - Get contract metadata
- listTransfers - List ERC transfers
- listLatestAllChains - List the latest transactions across all supported EVM chains
- get - Get transaction
- listLatest - List latest transactions
- get - Get an ICM message
- list - List ICM messages
- listByAddress - List ICM messages by address
- getResult - Get operation
- exportTransactions - Create transaction export operation
- getAssetDetails - Get asset details
- getChainIdsForAddresses - Get chain interactions for addresses
- getNetworkDetails - Get network details
- listBlockchains - List blockchains
- getBlockchainById - Get blockchain details by ID
- listSubnets - List subnets
- getSubnetById - Get Subnet details by ID
- listValidators - List validators
- getValidatorDetails - Get single validator details
- listDelegators - List delegators
- listL1Validators - List L1 validators
- listByAddresses - Get balances
- get - Get block
- listByNodeId - List blocks proposed by node
- listLatest - List latest blocks
- listPendingRewards - List pending rewards
- listHistoricalRewards - List historical rewards
- get - Get transaction
- listLatest - List latest transactions
- listActiveStakingTransactions - List staking transactions
- listAssetTransactions - List asset transactions
- listByAddresses - List UTXOs
- listLatest - List vertices
- getByHash - Get vertex
- listByHeight - List vertices by height
getTeleporterMessage- [Deprecated] Gets a teleporter message by message ID.
listTeleporterMessages- [Deprecated] Lists teleporter messages. Ordered by timestamp in descending order.
listTeleporterMessagesByAddress- [Deprecated] Lists teleporter messages by address. Ordered by timestamp in descending order.
- 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.
- compositeQuery - Composite query
- healthCheck - Get the health of the service
- list - Get a list of supported blockchains
- get - Get chain information for supported blockchain
- getMetrics - Get metrics for EVM chains
- getTeleporterMetrics - Get teleporter metrics for EVM chains
- getRollingWindowMetrics - Get rolling window metrics for EVM chains
- listNftHolders - Get NFT holders by contract address
- listTokenHoldersAboveThreshold - Get addresses by balance over time
- listBTCbBridgersAboveThreshold - Get addresses by BTCb bridged balance
- listMetrics - Get given metric for all validators
- getMetricsByValidationId - Get metric values with given validation id and timestamp range
- getMetricsByNodeId - Get metric values with given node id and timestamp range
- getMetricsBySubnetId - Get metric values with given subnet ID and timestamp range
- getStakingMetrics - Get staking metrics for a given subnet
- getValidators - Get addresses running validators during a given time frame
- list - List webhooks
- create - Create a webhook
- get - Get a webhook by ID
- deactivate - Deactivate a webhook
- update - Update a webhook
- generateOrRotateSharedSecret - Generate or rotate a shared secret
- getSharedSecret - Get a shared secret
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.
Available standalone functions
dataEvmAddressBalancesGetNative
- Get native token balancedataEvmAddressBalancesListCollectibles
- List collectible (ERC-721/ERC-1155) balancesdataEvmAddressBalancesListErc1155
- List ERC-1155 balancesdataEvmAddressBalancesListErc20
- List ERC-20 balancesdataEvmAddressBalancesListErc721
- List ERC-721 balancesdataEvmAddressChainsList
- List all chains associated with a given addressdataEvmAddressContractsListDeployments
- List deployed contractsdataEvmAddressTransactionsList
- List transactionsdataEvmAddressTransactionsListErc1155
- List ERC-1155 transfersdataEvmAddressTransactionsListErc20
- List ERC-20 transfersdataEvmAddressTransactionsListErc721
- List ERC-721 transfersdataEvmAddressTransactionsListInternal
- List internal transactionsdataEvmAddressTransactionsListNative
- List native transactionsdataEvmBlocksGet
- Get blockdataEvmBlocksListLatest
- List latest blocksdataEvmBlocksListLatestAllChains
- List latest blocks across all supported EVM chainsdataEvmBlocksListTransactions
- List transactions for a blockdataEvmChainsGet
- Get chain informationdataEvmChainsList
- List chainsdataEvmContractsGetDeploymentTransaction
- Get deployment transactiondataEvmContractsGetMetadata
- Get contract metadatadataEvmContractsListTransfers
- List ERC transfersdataEvmTransactionsGet
- Get transactiondataEvmTransactionsListLatest
- List latest transactionsdataEvmTransactionsListLatestAllChains
- List the latest transactions across all supported EVM chainsdataHealthCheck
- Get the health of the servicedataIcmGet
- Get an ICM messagedataIcmList
- List ICM messagesdataIcmListByAddress
- List ICM messages by addressdataNftsGet
- Get token detailsdataNftsList
- List tokensdataNftsReindex
- Reindex NFT metadatadataOperationsExportTransactions
- Create transaction export operationdataOperationsGetResult
- Get operationdataPrimaryNetworkBalancesListByAddresses
- Get balancesdataPrimaryNetworkBlocksGet
- Get blockdataPrimaryNetworkBlocksListByNodeId
- List blocks proposed by nodedataPrimaryNetworkBlocksListLatest
- List latest blocksdataPrimaryNetworkGetAssetDetails
- Get asset detailsdataPrimaryNetworkGetBlockchainById
- Get blockchain details by IDdataPrimaryNetworkGetChainIdsForAddresses
- Get chain interactions for addressesdataPrimaryNetworkGetNetworkDetails
- Get network detailsdataPrimaryNetworkGetSubnetById
- Get Subnet details by IDdataPrimaryNetworkGetValidatorDetails
- Get single validator detailsdataPrimaryNetworkListBlockchains
- List blockchainsdataPrimaryNetworkListDelegators
- List delegatorsdataPrimaryNetworkListL1Validators
- List L1 validatorsdataPrimaryNetworkListSubnets
- List subnetsdataPrimaryNetworkListValidators
- List validatorsdataPrimaryNetworkRewardsListHistoricalRewards
- List historical rewardsdataPrimaryNetworkRewardsListPendingRewards
- List pending rewardsdataPrimaryNetworkTransactionsGet
- Get transactiondataPrimaryNetworkTransactionsListActiveStakingTransactions
- List staking transactionsdataPrimaryNetworkTransactionsListAssetTransactions
- List asset transactionsdataPrimaryNetworkTransactionsListLatest
- List latest transactionsdataPrimaryNetworkUtxosListByAddresses
- List UTXOsdataPrimaryNetworkVerticesGetByHash
- Get vertexdataPrimaryNetworkVerticesListByHeight
- List vertices by heightdataPrimaryNetworkVerticesListLatest
- List verticesdataSignatureAggregatorAggregate
- Aggregate SignaturesdataSignatureAggregatorGet
- Get Aggregated SignaturesdataUsageMetricsGetLogs
- Get logs for requests made by clientdataUsageMetricsGetSubnetRpcUsage
- Get usage metrics for the Subnet RPCdataUsageMetricsGetUsage
- Get usage metrics for the Data APIlookingGlassCompositeQuery
- Composite querymetricsChainsGet
- Get chain information for supported blockchainmetricsChainsGetMetrics
- Get metrics for EVM chainsmetricsChainsGetRollingWindowMetrics
- Get rolling window metrics for EVM chainsmetricsChainsGetTeleporterMetrics
- Get teleporter metrics for EVM chainsmetricsChainsList
- Get a list of supported blockchainsmetricsChainsListBTCbBridgersAboveThreshold
- Get addresses by BTCb bridged balancemetricsChainsListNftHolders
- Get NFT holders by contract addressmetricsChainsListTokenHoldersAboveThreshold
- Get addresses by balance over timemetricsHealthCheck
- Get the health of the servicemetricsL1ValidatorsGetMetricsByNodeId
- Get metric values with given node id and timestamp rangemetricsL1ValidatorsGetMetricsBySubnetId
- Get metric values with given subnet ID and timestamp rangemetricsL1ValidatorsGetMetricsByValidationId
- Get metric values with given validation id and timestamp rangemetricsL1ValidatorsListMetrics
- Get given metric for all validatorsmetricsNetworksGetStakingMetrics
- Get staking metrics for a given subnetmetricsSubnetsGetValidators
- Get addresses running validators during a given time framewebhooksAddressesAdd
- Add addresses to EVM activity webhookwebhooksAddressesList
- List adresses by EVM activity webhookswebhooksAddressesRemove
- Remove addresses from EVM activity webhookwebhooksCreate
- Create a webhookwebhooksDeactivate
- Deactivate a webhookwebhooksGenerateOrRotateSharedSecret
- Generate or rotate a shared secretwebhooksGet
- Get a webhook by IDwebhooksGetSharedSecret
- Get a shared secretwebhooksList
- List webhookswebhooksUpdate
- Update a webhook- [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.dataEvmChainsGetAddressChains
- [Deprecated] Lists the latest blocks for all supported EVM chains. Filterable by network.dataEvmChainsListAllLatestBlocks
- [Deprecated] Lists the latest transactions for all supported EVM chains. Filterable by status.dataEvmChainsListAllLatestTransactions
- [Deprecated] Gets a teleporter message by message ID.dataTeleporterGetTeleporterMessage
- [Deprecated] Lists teleporter messages. Ordered by timestamp in descending order.dataTeleporterListTeleporterMessages
- [Deprecated] Lists teleporter messages by address. Ordered by timestamp in descending order.dataTeleporterListTeleporterMessagesByAddress
- [Deprecated] Gets metrics for public Subnet RPC usage over a specified time interval aggregated at the specified time-duration granularity.dataUsageMetricsGetRpcUsageMetrics
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.
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. |
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();
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();
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();
AvaCloudSDKError
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. |
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();
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 code400
.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 code401
.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 code403
.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 code404
.TooManyRequests
: This error is returned when the client has sent too many, and has hit the rate limit. Status code429
.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 code500
.BadGateway
: This is an internal error indicating invalid response received by the client-facing proxy or gateway from the upstream server. Status code502
.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 code503
.
Less common errors (6)
Network errors:
ConnectionError
: HTTP client was unable to make a request to a server.RequestTimeoutError
: HTTP request timed out due to an AbortSignal signal.RequestAbortedError
: HTTP request was aborted by the client.InvalidRequestError
: Any input used to create a request is invalid.UnexpectedClientError
: Unrecognised or unexpected error.
Inherit from AvaCloudSDKError
:
ResponseValidationError
: Type mismatch between the data returned from the server and the structure expected by the SDK. Seeerror.rawValue
for the raw value anderror.pretty()
for a nicely formatted multi-line string.
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 });
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 { 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();
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 });
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.
- 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
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'));
signingSecret
: The secret key for signing.signature
: The HMAC SHA-256 signature from the request header.payload
: The JSON payload of the request.
Use this function to securely validate webhooks from AvaCloud.
For more information, visit the AvaCloud Developers documentation.
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.