From 3b5fde204fd4b1b5b23653c613aab4d789dbdd4b Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Mon, 11 Aug 2025 12:20:20 +0000 Subject: [PATCH] Auto-generate SDK Docs and Readme --- sdk/README.md | 137 ++++++++++++------ .../listicmmessagesresponsemessage.md | 34 ++--- .../listteleportermessagesresponsemessage.md | 26 ++-- sdk/docs/models/components/validator.md | 28 ++-- .../operations/getcontractmetadataresponse.md | 20 +-- sdk/docs/sdks/addressbalances/README.md | 5 + sdk/docs/sdks/addresschains/README.md | 1 + sdk/docs/sdks/addresscontracts/README.md | 1 + sdk/docs/sdks/addresses/README.md | 3 + sdk/docs/sdks/addresstransactions/README.md | 6 + sdk/docs/sdks/contracts/README.md | 3 + sdk/docs/sdks/data/README.md | 1 + sdk/docs/sdks/evmblocks/README.md | 4 + sdk/docs/sdks/evmchains/README.md | 5 + sdk/docs/sdks/evmtransactions/README.md | 3 + sdk/docs/sdks/icm/README.md | 3 + sdk/docs/sdks/l1validators/README.md | 4 + sdk/docs/sdks/metrics/README.md | 1 + sdk/docs/sdks/metricschains/README.md | 8 + sdk/docs/sdks/networks/README.md | 1 + sdk/docs/sdks/nfts/README.md | 3 + sdk/docs/sdks/operations/README.md | 2 + sdk/docs/sdks/primarynetwork/README.md | 11 ++ .../sdks/primarynetworkbalances/README.md | 1 + sdk/docs/sdks/primarynetworkblocks/README.md | 3 + .../sdks/primarynetworktransactions/README.md | 4 + sdk/docs/sdks/rewards/README.md | 2 + sdk/docs/sdks/signatureaggregator/README.md | 2 + sdk/docs/sdks/subnets/README.md | 1 + sdk/docs/sdks/teleporter/README.md | 3 + sdk/docs/sdks/usagemetrics/README.md | 4 + sdk/docs/sdks/utxos/README.md | 1 + sdk/docs/sdks/vertices/README.md | 3 + sdk/docs/sdks/webhooks/README.md | 7 + .../metricsL1ValidatorsGetMetricsByNodeId.ts | 1 + ...metricsL1ValidatorsGetMetricsBySubnetId.ts | 1 + ...icsL1ValidatorsGetMetricsByValidationId.ts | 1 + .../funcs/metricsL1ValidatorsListMetrics.ts | 1 + 38 files changed, 244 insertions(+), 101 deletions(-) create mode 100644 sdk/src/funcs/metricsL1ValidatorsGetMetricsByNodeId.ts create mode 100644 sdk/src/funcs/metricsL1ValidatorsGetMetricsBySubnetId.ts create mode 100644 sdk/src/funcs/metricsL1ValidatorsGetMetricsByValidationId.ts create mode 100644 sdk/src/funcs/metricsL1ValidatorsListMetrics.ts diff --git a/sdk/README.md b/sdk/README.md index c4b34cb2..43ffd218 100644 --- a/sdk/README.md +++ b/sdk/README.md @@ -12,27 +12,32 @@ + ## 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](#sdk-installation) - * [Requirements](#requirements) - * [SDK Example Usage](#sdk-example-usage) - * [Authentication](#authentication) - * [Available Resources and Operations](#available-resources-and-operations) - * [Standalone functions](#standalone-functions) - * [Global Parameters](#global-parameters) - * [Pagination](#pagination) - * [Retries](#retries) - * [Error Handling](#error-handling) - * [Server Selection](#server-selection) - * [Custom HTTP Client](#custom-http-client) - * [Debugging](#debugging) + +* [SDK Installation](#sdk-installation) +* [Requirements](#requirements) +* [SDK Example Usage](#sdk-example-usage) +* [Authentication](#authentication) +* [Available Resources and Operations](#available-resources-and-operations) +* [Standalone functions](#standalone-functions) +* [Global Parameters](#global-parameters) +* [Pagination](#pagination) +* [Retries](#retries) +* [Error Handling](#error-handling) +* [Server Selection](#server-selection) +* [Custom HTTP Client](#custom-http-client) +* [Debugging](#debugging) * [Development](#development) * [Maturity](#maturity) * [Contributions](#contributions) @@ -40,6 +45,7 @@ Data, Metrics, and Webhooks API: The Avalanche API suite offers powerful tools f + ## SDK Installation The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers. @@ -74,7 +80,6 @@ yarn add @avalanche-sdk/sdk zod > [!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 @@ -142,7 +147,6 @@ 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}"`. - ```json { "mcpServers": { @@ -161,15 +165,19 @@ For a full list of server arguments, run: ```sh npx -y --package @avalanche-sdk/sdk -- mcp start --help ``` + + ## Requirements For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md). + + ## SDK Example Usage ### Example @@ -200,20 +208,23 @@ async function run() { run(); ``` + + ## Authentication ### Per-Client Security Schemes This SDK supports the following security scheme globally: -| Name | Type | Scheme | -| -------- | ------ | ------- | +| 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: + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -230,15 +241,16 @@ async function run() { run(); ``` + + ## Available Resources and Operations
Available methods - ### [data](docs/sdks/data/README.md) * [healthCheck](docs/sdks/data/README.md#healthcheck) - Get the health of the service @@ -281,13 +293,15 @@ run(); * [get](docs/sdks/evmchains/README.md#get) - Get chain information * [~~getAddressChains~~](docs/sdks/evmchains/README.md#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/address/:address/chains endpoint instead** . ⚠️ **Deprecated** + * [~~listAllLatestTransactions~~](docs/sdks/evmchains/README.md#listalllatesttransactions) - **[Deprecated]** Lists the latest transactions for all supported EVM chains. Filterable by status. -⚠️ **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/transactions endpoint instead** . ⚠️ **Deprecated** + * [~~listAllLatestBlocks~~](docs/sdks/evmchains/README.md#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** +⚠️ **This operation will be removed in a future release. Please use /v1/blocks endpoint instead** . ⚠️ **Deprecated** #### [data.evm.contracts](docs/sdks/contracts/README.md) @@ -373,13 +387,15 @@ run(); * [~~getTeleporterMessage~~](docs/sdks/teleporter/README.md#getteleportermessage) - **[Deprecated]** Gets a teleporter message by message ID. -⚠️ **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/:messageId endpoint instead** . ⚠️ **Deprecated** + * [~~listTeleporterMessages~~](docs/sdks/teleporter/README.md#listteleportermessages) - **[Deprecated]** Lists teleporter messages. Ordered by timestamp in descending order. -⚠️ **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/messages endpoint instead** . ⚠️ **Deprecated** + * [~~listTeleporterMessagesByAddress~~](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress) - **[Deprecated]** Lists teleporter messages by address. Ordered by timestamp in descending order. -⚠️ **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/icm/addresses/:address/messages endpoint instead** . ⚠️ **Deprecated** #### [data.usageMetrics](docs/sdks/usagemetrics/README.md) @@ -388,7 +404,7 @@ run(); * [getSubnetRpcUsage](docs/sdks/usagemetrics/README.md#getsubnetrpcusage) - Get usage metrics for the Subnet RPC * [~~getRpcUsageMetrics~~](docs/sdks/usagemetrics/README.md#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** +⚠️ **This operation will be removed in a future release. Please use /v1/subnetRpcUsageMetrics endpoint instead**. ⚠️ **Deprecated** ### [metrics](docs/sdks/metrics/README.md) @@ -440,6 +456,7 @@ run(); + ## Standalone functions All the methods listed above are available as standalone functions. These @@ -545,37 +562,43 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md). - [`webhooksUpdate`](docs/sdks/webhooks/README.md#update) - Update a webhook - ~~[`dataEvmChainsGetAddressChains`](docs/sdks/evmchains/README.md#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/address/:address/chains endpoint instead** . ⚠️ **Deprecated** + - ~~[`dataEvmChainsListAllLatestBlocks`](docs/sdks/evmchains/README.md#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** +⚠️ **This operation will be removed in a future release. Please use /v1/blocks endpoint instead** . ⚠️ **Deprecated** + - ~~[`dataEvmChainsListAllLatestTransactions`](docs/sdks/evmchains/README.md#listalllatesttransactions)~~ - **[Deprecated]** Lists the latest transactions for all supported EVM chains. Filterable by status. -⚠️ **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/transactions endpoint instead** . ⚠️ **Deprecated** + - ~~[`dataTeleporterGetTeleporterMessage`](docs/sdks/teleporter/README.md#getteleportermessage)~~ - **[Deprecated]** Gets a teleporter message by message ID. -⚠️ **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/:messageId endpoint instead** . ⚠️ **Deprecated** + - ~~[`dataTeleporterListTeleporterMessages`](docs/sdks/teleporter/README.md#listteleportermessages)~~ - **[Deprecated]** Lists teleporter messages. Ordered by timestamp in descending order. -⚠️ **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/messages endpoint instead** . ⚠️ **Deprecated** + - ~~[`dataTeleporterListTeleporterMessagesByAddress`](docs/sdks/teleporter/README.md#listteleportermessagesbyaddress)~~ - **[Deprecated]** Lists teleporter messages by address. Ordered by timestamp in descending order. -⚠️ **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/icm/addresses/:address/messages endpoint instead** . ⚠️ **Deprecated** + - ~~[`dataUsageMetricsGetRpcUsageMetrics`](docs/sdks/usagemetrics/README.md#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** +⚠️ **This operation will be removed in a future release. Please use /v1/subnetRpcUsageMetrics endpoint instead**. ⚠️ **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. @@ -608,18 +631,18 @@ async function run() { 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`][for-await-of] +async iterable that can be consumed using the syntax. -[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of - Here's an example of one such pagination call: ```typescript @@ -640,14 +663,17 @@ async function run() { 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: + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -675,6 +701,7 @@ 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: + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -700,23 +727,26 @@ async function run() { run(); ``` + + ## Error Handling [`AvalancheError`](./src/models/errors/avalancheerror.ts) 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](#error-classes). | +| 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](#error-classes). | ### Example + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; import * as errors from "@avalanche-sdk/sdk/models/errors"; @@ -754,7 +784,9 @@ run(); ``` ### Error Classes + **Primary errors:** + * [`AvalancheError`](./src/models/errors/avalancheerror.ts): The base class for HTTP error responses. * [`BadRequestError`](./src/models/errors/badrequesterror.ts): 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`](./src/models/errors/unauthorizederror.ts): 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`. @@ -770,25 +802,28 @@ run();
**Network errors:** + * [`ConnectionError`](./src/models/errors/httpclienterrors.ts): HTTP client was unable to make a request to a server. * [`RequestTimeoutError`](./src/models/errors/httpclienterrors.ts): HTTP request timed out due to an AbortSignal signal. * [`RequestAbortedError`](./src/models/errors/httpclienterrors.ts): HTTP request was aborted by the client. * [`InvalidRequestError`](./src/models/errors/httpclienterrors.ts): Any input used to create a request is invalid. * [`UnexpectedClientError`](./src/models/errors/httpclienterrors.ts): Unrecognised or unexpected error. - **Inherit from [`AvalancheError`](./src/models/errors/avalancheerror.ts)**: + * [`ResponseValidationError`](./src/models/errors/responsevalidationerror.ts): 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: + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -809,6 +844,7 @@ 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: + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -825,9 +861,11 @@ async function run() { run(); ``` + + ## Custom HTTP Client The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native @@ -874,9 +912,11 @@ httpClient.addHook("requestError", (error, request) => { const sdk = new Avalanche({ httpClient }); ``` + + ## Debugging You can setup your SDK to emit debug logs for SDK requests and responses. @@ -891,6 +931,7 @@ import { Avalanche } from "@avalanche-sdk/sdk"; const sdk = new Avalanche({ debugLogger: console }); ``` + @@ -905,5 +946,7 @@ 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. \ No newline at end of file +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. + +[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of diff --git a/sdk/docs/models/components/listicmmessagesresponsemessage.md b/sdk/docs/models/components/listicmmessagesresponsemessage.md index a3b31c6b..af41e97f 100644 --- a/sdk/docs/models/components/listicmmessagesresponsemessage.md +++ b/sdk/docs/models/components/listicmmessagesresponsemessage.md @@ -3,10 +3,10 @@ ## Supported Types -### `components.DeliveredIcmMessage` +### `components.PendingIcmMessage` ```typescript -const value: components.DeliveredIcmMessage = { +const value: components.PendingIcmMessage = { messageId: "", icmContractAddress: "", sourceBlockchainId: "", @@ -16,9 +16,9 @@ const value: components.DeliveredIcmMessage = { messageNonce: "", from: "", to: "", - messageExecuted: true, + messageExecuted: false, receipts: [], - receiptDelivered: true, + receiptDelivered: false, rewardDetails: { address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F", name: "Wrapped AVAX", @@ -38,21 +38,14 @@ const value: components.DeliveredIcmMessage = { timestamp: 6459.73, gasSpent: "", }, - destinationTransaction: { - txHash: "", - timestamp: 8250.11, - gasSpent: "", - rewardRedeemer: "", - delivererAddress: "", - }, - status: "delivered", + status: "pending", }; ``` -### `components.PendingIcmMessage` +### `components.DeliveredIcmMessage` ```typescript -const value: components.PendingIcmMessage = { +const value: components.DeliveredIcmMessage = { messageId: "", icmContractAddress: "", sourceBlockchainId: "", @@ -62,9 +55,9 @@ const value: components.PendingIcmMessage = { messageNonce: "", from: "", to: "", - messageExecuted: false, + messageExecuted: true, receipts: [], - receiptDelivered: false, + receiptDelivered: true, rewardDetails: { address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F", name: "Wrapped AVAX", @@ -84,7 +77,14 @@ const value: components.PendingIcmMessage = { timestamp: 6459.73, gasSpent: "", }, - status: "pending", + destinationTransaction: { + txHash: "", + timestamp: 8250.11, + gasSpent: "", + rewardRedeemer: "", + delivererAddress: "", + }, + status: "delivered", }; ``` diff --git a/sdk/docs/models/components/listteleportermessagesresponsemessage.md b/sdk/docs/models/components/listteleportermessagesresponsemessage.md index b4ae0f2a..4a094612 100644 --- a/sdk/docs/models/components/listteleportermessagesresponsemessage.md +++ b/sdk/docs/models/components/listteleportermessagesresponsemessage.md @@ -3,10 +3,10 @@ ## Supported Types -### `components.DeliveredTeleporterMessage` +### `components.PendingTeleporterMessage` ```typescript -const value: components.DeliveredTeleporterMessage = { +const value: components.PendingTeleporterMessage = { messageId: "", teleporterContractAddress: "", sourceBlockchainId: "", @@ -38,21 +38,14 @@ const value: components.DeliveredTeleporterMessage = { timestamp: 1403.23, gasSpent: "", }, - destinationTransaction: { - txHash: "", - timestamp: 4770.43, - gasSpent: "", - rewardRedeemer: "", - delivererAddress: "", - }, - status: "delivered", + status: "pending", }; ``` -### `components.PendingTeleporterMessage` +### `components.DeliveredTeleporterMessage` ```typescript -const value: components.PendingTeleporterMessage = { +const value: components.DeliveredTeleporterMessage = { messageId: "", teleporterContractAddress: "", sourceBlockchainId: "", @@ -84,7 +77,14 @@ const value: components.PendingTeleporterMessage = { timestamp: 1403.23, gasSpent: "", }, - status: "pending", + destinationTransaction: { + txHash: "", + timestamp: 4770.43, + gasSpent: "", + rewardRedeemer: "", + delivererAddress: "", + }, + status: "delivered", }; ``` diff --git a/sdk/docs/models/components/validator.md b/sdk/docs/models/components/validator.md index 554224df..36994455 100644 --- a/sdk/docs/models/components/validator.md +++ b/sdk/docs/models/components/validator.md @@ -31,6 +31,20 @@ const value: components.ActiveValidatorDetails = { }; ``` +### `components.PendingValidatorDetails` + +```typescript +const value: components.PendingValidatorDetails = { + txHash: "", + nodeId: "", + subnetId: "", + amountStaked: "", + startTimestamp: 9843.29, + endTimestamp: 5112.58, + validationStatus: "pending", +}; +``` + ### `components.CompletedValidatorDetails` ```typescript @@ -66,17 +80,3 @@ const value: components.RemovedValidatorDetails = { }; ``` -### `components.PendingValidatorDetails` - -```typescript -const value: components.PendingValidatorDetails = { - txHash: "", - nodeId: "", - subnetId: "", - amountStaked: "", - startTimestamp: 9843.29, - endTimestamp: 5112.58, - validationStatus: "pending", -}; -``` - diff --git a/sdk/docs/models/operations/getcontractmetadataresponse.md b/sdk/docs/models/operations/getcontractmetadataresponse.md index c41ce055..e4fdbf1d 100644 --- a/sdk/docs/models/operations/getcontractmetadataresponse.md +++ b/sdk/docs/models/operations/getcontractmetadataresponse.md @@ -5,37 +5,37 @@ Successful response ## Supported Types -### `components.Erc20Contract` +### `components.Erc721Contract` ```typescript -const value: components.Erc20Contract = { +const value: components.Erc721Contract = { name: "Wrapped AVAX", address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F", - ercType: "ERC-20", + ercType: "ERC-721", symbol: "WAVAX", - decimals: 18, }; ``` -### `components.Erc721Contract` +### `components.Erc1155Contract` ```typescript -const value: components.Erc721Contract = { +const value: components.Erc1155Contract = { name: "Wrapped AVAX", address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F", - ercType: "ERC-721", + ercType: "ERC-1155", symbol: "WAVAX", }; ``` -### `components.Erc1155Contract` +### `components.Erc20Contract` ```typescript -const value: components.Erc1155Contract = { +const value: components.Erc20Contract = { name: "Wrapped AVAX", address: "0x71C7656EC7ab88b098defB751B7401B5f6d8976F", - ercType: "ERC-1155", + ercType: "ERC-20", symbol: "WAVAX", + decimals: 18, }; ``` diff --git a/sdk/docs/sdks/addressbalances/README.md b/sdk/docs/sdks/addressbalances/README.md index b7c4b8f8..60ddfbc3 100644 --- a/sdk/docs/sdks/addressbalances/README.md +++ b/sdk/docs/sdks/addressbalances/README.md @@ -19,6 +19,7 @@ Balance at a given block can be retrieved with the `blockNumber` parameter. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -108,6 +109,7 @@ Balance for specific contracts can be retrieved with the `contractAddresses` par ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -201,6 +203,7 @@ Balance for a specific contract can be retrieved with the `contractAddress` para ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -292,6 +295,7 @@ Balance for a specific contract can be retrieved with the `contractAddress` para ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -383,6 +387,7 @@ Balance for a specific contract can be retrieved with the `contractAddress` para ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/addresschains/README.md b/sdk/docs/sdks/addresschains/README.md index 3a8c0c61..49d36c2c 100644 --- a/sdk/docs/sdks/addresschains/README.md +++ b/sdk/docs/sdks/addresschains/README.md @@ -13,6 +13,7 @@ Lists the chains where the specified address has participated in transactions o ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/addresscontracts/README.md b/sdk/docs/sdks/addresscontracts/README.md index 62efcaaa..62345578 100644 --- a/sdk/docs/sdks/addresscontracts/README.md +++ b/sdk/docs/sdks/addresscontracts/README.md @@ -13,6 +13,7 @@ Lists all contracts deployed by the given address. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/addresses/README.md b/sdk/docs/sdks/addresses/README.md index 3856c71b..573bf0b2 100644 --- a/sdk/docs/sdks/addresses/README.md +++ b/sdk/docs/sdks/addresses/README.md @@ -15,6 +15,7 @@ List adresses by webhook. Only valid for EVM activity webhooks. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -96,6 +97,7 @@ Remove addresses from webhook. Only valid for EVM activity webhooks. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -183,6 +185,7 @@ Add addresses to webhook. Only valid for EVM activity webhooks. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/addresstransactions/README.md b/sdk/docs/sdks/addresstransactions/README.md index 9954ad89..30a4ff6b 100644 --- a/sdk/docs/sdks/addresstransactions/README.md +++ b/sdk/docs/sdks/addresstransactions/README.md @@ -20,6 +20,7 @@ Filterable by block ranges. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -111,6 +112,7 @@ Lists native transactions for an address. Filterable by block range. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -200,6 +202,7 @@ Lists ERC-20 transfers for an address. Filterable by block range. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -289,6 +292,7 @@ Lists ERC-721 transfers for an address. Filterable by block range. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -378,6 +382,7 @@ Lists ERC-1155 transfers for an address. Filterable by block range. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -469,6 +474,7 @@ Note that the internal transactions list only contains `CALL` or `CALLCODE` tran ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/contracts/README.md b/sdk/docs/sdks/contracts/README.md index 16a58d6e..d67d357e 100644 --- a/sdk/docs/sdks/contracts/README.md +++ b/sdk/docs/sdks/contracts/README.md @@ -15,6 +15,7 @@ If the address is a smart contract, returns the transaction in which it was depl ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -98,6 +99,7 @@ Gets metadata about the contract at the given address. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -179,6 +181,7 @@ Lists ERC transfers for an ERC-20, ERC-721, or ERC-1155 contract address. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/data/README.md b/sdk/docs/sdks/data/README.md index 89c6ce97..249c990c 100644 --- a/sdk/docs/sdks/data/README.md +++ b/sdk/docs/sdks/data/README.md @@ -13,6 +13,7 @@ Check the health of the service. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/evmblocks/README.md b/sdk/docs/sdks/evmblocks/README.md index d1b81123..c9074bd0 100644 --- a/sdk/docs/sdks/evmblocks/README.md +++ b/sdk/docs/sdks/evmblocks/README.md @@ -16,6 +16,7 @@ Lists the most recent blocks from all supported EVM-compatible chains. The resu ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -97,6 +98,7 @@ Lists the latest indexed blocks on the EVM-compatible chain sorted in descending ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -178,6 +180,7 @@ Gets the details of an individual block on the EVM-compatible chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -259,6 +262,7 @@ Lists the transactions that occured in a given block. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/evmchains/README.md b/sdk/docs/sdks/evmchains/README.md index 43a3f403..1a1d5eb7 100644 --- a/sdk/docs/sdks/evmchains/README.md +++ b/sdk/docs/sdks/evmchains/README.md @@ -23,6 +23,7 @@ Lists the AvaCloud supported EVM-compatible chains. Filterable by network. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -102,6 +103,7 @@ Gets chain information for the EVM-compatible chain if supported by AvaCloud. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -183,6 +185,7 @@ run(); ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -264,6 +267,7 @@ run(); ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -349,6 +353,7 @@ run(); ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/evmtransactions/README.md b/sdk/docs/sdks/evmtransactions/README.md index d3ed90dd..ce29c69e 100644 --- a/sdk/docs/sdks/evmtransactions/README.md +++ b/sdk/docs/sdks/evmtransactions/README.md @@ -15,6 +15,7 @@ Lists the most recent transactions from all supported EVM-compatible chains. Th ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -96,6 +97,7 @@ Gets the details of a single transaction. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -177,6 +179,7 @@ Lists the latest transactions. Filterable by status. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/icm/README.md b/sdk/docs/sdks/icm/README.md index e01097ed..98340b03 100644 --- a/sdk/docs/sdks/icm/README.md +++ b/sdk/docs/sdks/icm/README.md @@ -15,6 +15,7 @@ Gets an ICM message by teleporter message ID. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -92,6 +93,7 @@ Lists ICM messages. Ordered by timestamp in descending order. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -181,6 +183,7 @@ Lists ICM messages by address. Ordered by timestamp in descending order. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/l1validators/README.md b/sdk/docs/sdks/l1validators/README.md index a2300093..3ed0164f 100644 --- a/sdk/docs/sdks/l1validators/README.md +++ b/sdk/docs/sdks/l1validators/README.md @@ -16,6 +16,7 @@ Get given metric's value for all validators. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -97,6 +98,7 @@ Get given metric values for a given validation id with or without a timestamp ra ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -180,6 +182,7 @@ Get given metric values for a given node id with or without a timestamp range. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -263,6 +266,7 @@ Get given metric values for a given subnet ID with or without a timestamp range. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/metrics/README.md b/sdk/docs/sdks/metrics/README.md index 4f150b6e..93dc8baa 100644 --- a/sdk/docs/sdks/metrics/README.md +++ b/sdk/docs/sdks/metrics/README.md @@ -13,6 +13,7 @@ Check the health of the service. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/metricschains/README.md b/sdk/docs/sdks/metricschains/README.md index 13b135d3..30c36e5a 100644 --- a/sdk/docs/sdks/metricschains/README.md +++ b/sdk/docs/sdks/metricschains/README.md @@ -20,6 +20,7 @@ Get a list of Metrics API supported blockchains. This endpoint is paginated and ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -101,6 +102,7 @@ Get chain information for Metrics API supported blockchain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -212,6 +214,7 @@ All metrics are updated several times every hour. Each metric data point has a ` ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -305,6 +308,7 @@ Gets teleporter metrics for an EVM chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -386,6 +390,7 @@ Gets the rolling window metrics for an EVM chain for the last hour, day, month, ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -467,6 +472,7 @@ Get list of NFT holders and number of NFTs held by contract address. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -554,6 +560,7 @@ Get list of addresses and their latest balances that have held more than a certa ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -647,6 +654,7 @@ Get list of addresses and their net bridged amounts that have bridged more than ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/networks/README.md b/sdk/docs/sdks/networks/README.md index 8a036182..774dbf34 100644 --- a/sdk/docs/sdks/networks/README.md +++ b/sdk/docs/sdks/networks/README.md @@ -13,6 +13,7 @@ Gets staking metrics for a given subnet. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/nfts/README.md b/sdk/docs/sdks/nfts/README.md index df75d8ce..865b83b9 100644 --- a/sdk/docs/sdks/nfts/README.md +++ b/sdk/docs/sdks/nfts/README.md @@ -15,6 +15,7 @@ Triggers reindexing of token metadata for an NFT token. Reindexing can only be c ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -98,6 +99,7 @@ Lists tokens for an NFT contract. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -183,6 +185,7 @@ Gets token details for a specific token of an NFT contract. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/operations/README.md b/sdk/docs/sdks/operations/README.md index a403ac09..58c15413 100644 --- a/sdk/docs/sdks/operations/README.md +++ b/sdk/docs/sdks/operations/README.md @@ -14,6 +14,7 @@ Gets operation details for the given operation id. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -93,6 +94,7 @@ The transaction export operation runs asynchronously in the background. The stat ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/primarynetwork/README.md b/sdk/docs/sdks/primarynetwork/README.md index 9ddb058a..56f0aed2 100644 --- a/sdk/docs/sdks/primarynetwork/README.md +++ b/sdk/docs/sdks/primarynetwork/README.md @@ -23,6 +23,7 @@ Gets asset details corresponding to the given asset id on the X-Chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -106,6 +107,7 @@ Returns Primary Network chains that each address has touched in the form of an a ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -187,6 +189,7 @@ Gets network details such as validator and delegator stats. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -264,6 +267,7 @@ Lists all blockchains registered on the network. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -351,6 +355,7 @@ Get details of the blockchain registered on the network. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -432,6 +437,7 @@ Lists all subnets registered on the network. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -519,6 +525,7 @@ Get details of the Subnet registered on the network. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -600,6 +607,7 @@ Lists details for validators. By default, returns details for all validators. T ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -707,6 +715,7 @@ List validator details for a single validator. Filterable by validation status. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -796,6 +805,7 @@ Lists details for delegators. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -887,6 +897,7 @@ Lists details for L1 validators. By default, returns details for all active L1 v ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/primarynetworkbalances/README.md b/sdk/docs/sdks/primarynetworkbalances/README.md index 4e9a476b..5f84f09b 100644 --- a/sdk/docs/sdks/primarynetworkbalances/README.md +++ b/sdk/docs/sdks/primarynetworkbalances/README.md @@ -15,6 +15,7 @@ C-Chain balances returned are only the shared atomic memory balance. For EVM bal ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/primarynetworkblocks/README.md b/sdk/docs/sdks/primarynetworkblocks/README.md index 18146de6..75017ef0 100644 --- a/sdk/docs/sdks/primarynetworkblocks/README.md +++ b/sdk/docs/sdks/primarynetworkblocks/README.md @@ -15,6 +15,7 @@ Gets a block by block height or block hash on one of the Primary Network chains. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -98,6 +99,7 @@ Lists the latest blocks proposed by a given NodeID on one of the Primary Network ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -189,6 +191,7 @@ Lists latest blocks on one of the Primary Network chains. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/primarynetworktransactions/README.md b/sdk/docs/sdks/primarynetworktransactions/README.md index 5a986dc1..f1fb7b94 100644 --- a/sdk/docs/sdks/primarynetworktransactions/README.md +++ b/sdk/docs/sdks/primarynetworktransactions/README.md @@ -16,6 +16,7 @@ Gets the details of a single transaction on one of the Primary Network chains. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -105,6 +106,7 @@ Given that each transaction may return a large number of UTXO objects, bounded o ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -204,6 +206,7 @@ Lists active staking transactions on the P-Chain for the supplied addresses. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -303,6 +306,7 @@ Lists asset transactions corresponding to the given asset id on the X-Chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/rewards/README.md b/sdk/docs/sdks/rewards/README.md index 9101e834..71508d39 100644 --- a/sdk/docs/sdks/rewards/README.md +++ b/sdk/docs/sdks/rewards/README.md @@ -14,6 +14,7 @@ Lists pending rewards on the Primary Network for the supplied addresses. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -103,6 +104,7 @@ Lists historical rewards on the Primary Network for the supplied addresses. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/signatureaggregator/README.md b/sdk/docs/sdks/signatureaggregator/README.md index ffd06435..bf3f9d0c 100644 --- a/sdk/docs/sdks/signatureaggregator/README.md +++ b/sdk/docs/sdks/signatureaggregator/README.md @@ -14,6 +14,7 @@ Aggregates Signatures for a Warp message from Subnet validators. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -105,6 +106,7 @@ Get Aggregated Signatures for a P-Chain L1 related Warp Message. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/subnets/README.md b/sdk/docs/sdks/subnets/README.md index a7c38e9f..019ffa2f 100644 --- a/sdk/docs/sdks/subnets/README.md +++ b/sdk/docs/sdks/subnets/README.md @@ -13,6 +13,7 @@ Get list of addresses and AddValidatorTx timestamps set to receive awards for va ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/teleporter/README.md b/sdk/docs/sdks/teleporter/README.md index 9ae0135f..95c90b1c 100644 --- a/sdk/docs/sdks/teleporter/README.md +++ b/sdk/docs/sdks/teleporter/README.md @@ -25,6 +25,7 @@ ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -106,6 +107,7 @@ run(); ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -199,6 +201,7 @@ run(); ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/usagemetrics/README.md b/sdk/docs/sdks/usagemetrics/README.md index f3b9e3ba..ef487b76 100644 --- a/sdk/docs/sdks/usagemetrics/README.md +++ b/sdk/docs/sdks/usagemetrics/README.md @@ -18,6 +18,7 @@ Gets metrics for Data API usage over a specified time interval aggregated at the ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -101,6 +102,7 @@ Gets logs for requests made by client over a specified time interval for a speci ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -184,6 +186,7 @@ Gets metrics for public Subnet RPC usage over a specified time interval aggregat ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -271,6 +274,7 @@ run(); ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/utxos/README.md b/sdk/docs/sdks/utxos/README.md index 324d7f1a..4513bd9f 100644 --- a/sdk/docs/sdks/utxos/README.md +++ b/sdk/docs/sdks/utxos/README.md @@ -13,6 +13,7 @@ Lists UTXOs on one of the Primary Network chains for the supplied addresses. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/vertices/README.md b/sdk/docs/sdks/vertices/README.md index 5f2685c9..4370d876 100644 --- a/sdk/docs/sdks/vertices/README.md +++ b/sdk/docs/sdks/vertices/README.md @@ -15,6 +15,7 @@ Lists latest vertices on the X-Chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -100,6 +101,7 @@ Gets a single vertex on the X-Chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -183,6 +185,7 @@ Lists vertices at the given vertex height on the X-Chain. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/docs/sdks/webhooks/README.md b/sdk/docs/sdks/webhooks/README.md index a1462120..c9a002f0 100644 --- a/sdk/docs/sdks/webhooks/README.md +++ b/sdk/docs/sdks/webhooks/README.md @@ -19,6 +19,7 @@ Lists webhooks for the user. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -100,6 +101,7 @@ Create a new webhook. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -197,6 +199,7 @@ Retrieves a webhook by ID. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -274,6 +277,7 @@ Deactivates a webhook by ID. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -351,6 +355,7 @@ Updates an existing webhook. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -430,6 +435,7 @@ Generates a new shared secret or rotate an existing one. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; @@ -502,6 +508,7 @@ Get a previously generated shared secret. ### Example Usage + ```typescript import { Avalanche } from "@avalanche-sdk/sdk"; diff --git a/sdk/src/funcs/metricsL1ValidatorsGetMetricsByNodeId.ts b/sdk/src/funcs/metricsL1ValidatorsGetMetricsByNodeId.ts new file mode 100644 index 00000000..f23aec46 --- /dev/null +++ b/sdk/src/funcs/metricsL1ValidatorsGetMetricsByNodeId.ts @@ -0,0 +1 @@ +export * from "@avalanche-sdk/chainkit/funcs/metricsL1ValidatorsGetMetricsByNodeId.js"; diff --git a/sdk/src/funcs/metricsL1ValidatorsGetMetricsBySubnetId.ts b/sdk/src/funcs/metricsL1ValidatorsGetMetricsBySubnetId.ts new file mode 100644 index 00000000..e5d6139c --- /dev/null +++ b/sdk/src/funcs/metricsL1ValidatorsGetMetricsBySubnetId.ts @@ -0,0 +1 @@ +export * from "@avalanche-sdk/chainkit/funcs/metricsL1ValidatorsGetMetricsBySubnetId.js"; diff --git a/sdk/src/funcs/metricsL1ValidatorsGetMetricsByValidationId.ts b/sdk/src/funcs/metricsL1ValidatorsGetMetricsByValidationId.ts new file mode 100644 index 00000000..b83a15eb --- /dev/null +++ b/sdk/src/funcs/metricsL1ValidatorsGetMetricsByValidationId.ts @@ -0,0 +1 @@ +export * from "@avalanche-sdk/chainkit/funcs/metricsL1ValidatorsGetMetricsByValidationId.js"; diff --git a/sdk/src/funcs/metricsL1ValidatorsListMetrics.ts b/sdk/src/funcs/metricsL1ValidatorsListMetrics.ts new file mode 100644 index 00000000..51a44b6c --- /dev/null +++ b/sdk/src/funcs/metricsL1ValidatorsListMetrics.ts @@ -0,0 +1 @@ +export * from "@avalanche-sdk/chainkit/funcs/metricsL1ValidatorsListMetrics.js";