@avalabs/glacier-sdk 2.8.0-alpha.12 → 2.8.0-alpha.121

package/esm/generated/services/EvmService.d.ts

@@ -0,0 +1,616 @@
+import { CollectionSortByOption } from '../models/CollectionSortByOption.js';
+import { CurrencyCode } from '../models/CurrencyCode.js';
+import { Erc1155Token } from '../models/Erc1155Token.js';
+import { Erc721Token } from '../models/Erc721Token.js';
+import { GetChainResponse } from '../models/GetChainResponse.js';
+import { GetEvmBlockResponse } from '../models/GetEvmBlockResponse.js';
+import { GetNativeBalanceResponse } from '../models/GetNativeBalanceResponse.js';
+import { GetTransactionResponse } from '../models/GetTransactionResponse.js';
+import { ListChainsResponse } from '../models/ListChainsResponse.js';
+import { ListCollectibleBalancesResponse } from '../models/ListCollectibleBalancesResponse.js';
+import { ListErc1155BalancesResponse } from '../models/ListErc1155BalancesResponse.js';
+import { ListErc1155TransactionsResponse } from '../models/ListErc1155TransactionsResponse.js';
+import { ListErc20BalancesResponse } from '../models/ListErc20BalancesResponse.js';
+import { ListErc20TransactionsResponse } from '../models/ListErc20TransactionsResponse.js';
+import { ListErc721BalancesResponse } from '../models/ListErc721BalancesResponse.js';
+import { ListErc721TransactionsResponse } from '../models/ListErc721TransactionsResponse.js';
+import { ListEvmBlocksResponse } from '../models/ListEvmBlocksResponse.js';
+import { ListInternalTransactionsResponse } from '../models/ListInternalTransactionsResponse.js';
+import { ListNativeTransactionsResponse } from '../models/ListNativeTransactionsResponse.js';
+import { ListNftCollectionWithMetricsResponse } from '../models/ListNftCollectionWithMetricsResponse.js';
+import { ListTransactionDetailsResponse } from '../models/ListTransactionDetailsResponse.js';
+import { ListTransfersResponse } from '../models/ListTransfersResponse.js';
+import { NetworkType } from '../models/NetworkType.js';
+import { NftCollectionWithMetrics } from '../models/NftCollectionWithMetrics.js';
+import { SortOrder } from '../models/SortOrder.js';
+import { TransactionStatus } from '../models/TransactionStatus.js';
+import { TrendingTimeframe } from '../models/TrendingTimeframe.js';
+import { CancelablePromise } from '../core/CancelablePromise.js';
+import { BaseHttpRequest } from '../core/BaseHttpRequest.js';
+
+declare class EvmService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Get native token balance
+     * Gets native token balance of a wallet address.
+     *
+     * Balance at a given block can be retrieved with the `blockNumber` parameter.
+     * @returns GetNativeBalanceResponse
+     * @throws ApiError
+     */
+    getNativeBalance({ chainId, address, blockNumber, currency, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        /**
+         * The block number, if not defined the block number will be the latest block.
+         */
+        blockNumber?: string;
+        /**
+         * The currency that return values should use. Defaults to USD.
+         */
+        currency?: CurrencyCode;
+    }): CancelablePromise<GetNativeBalanceResponse>;
+    /**
+     * List ERC-20 balances
+     * Lists ERC-20 token balances of a wallet address.
+     *
+     * Balance at a given block can be retrieved with the `blockNumber` parameter.
+     *
+     * Balance for specific contracts can be retrieved with the `contractAddresses` parameter.
+     * @returns ListErc20BalancesResponse
+     * @throws ApiError
+     */
+    listErc20Balances({ chainId, address, blockNumber, pageSize, pageToken, contractAddresses, currency, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        /**
+         * The block number, if not defined the block number will be the latest block.
+         */
+        blockNumber?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * A comma separated list of contract addresses to filter by.
+         */
+        contractAddresses?: string;
+        /**
+         * The currency that return values should use. Defaults to USD.
+         */
+        currency?: CurrencyCode;
+    }): CancelablePromise<ListErc20BalancesResponse>;
+    /**
+     * List ERC-721 balances
+     * Lists ERC-721 token balances of a wallet address.
+     *
+     * Balance for a specific contract can be retrieved with the `contractAddress` parameter.
+     * @returns ListErc721BalancesResponse
+     * @throws ApiError
+     */
+    listErc721Balances({ chainId, address, pageSize, pageToken, contractAddress, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * A contract addresses to filter by.
+         */
+        contractAddress?: string;
+    }): CancelablePromise<ListErc721BalancesResponse>;
+    /**
+     * List ERC-1155 balances
+     * Lists ERC-1155 token balances of a wallet address.
+     *
+     * Balance at a given block can be retrieved with the `blockNumber` parameter.
+     *
+     * Balance for a specific contract can be retrieved with the `contractAddress` parameter.
+     * @returns ListErc1155BalancesResponse
+     * @throws ApiError
+     */
+    listErc1155Balances({ chainId, address, blockNumber, pageSize, pageToken, contractAddress, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        /**
+         * The block number, if not defined the block number will be the latest block.
+         */
+        blockNumber?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * A contract addresses to filter by.
+         */
+        contractAddress?: string;
+    }): CancelablePromise<ListErc1155BalancesResponse>;
+    /**
+     * List collectible (ERC-721/ERC-1155) balances
+     * Lists ERC-721 and ERC-1155 token balances of a wallet address.
+     *
+     * Balance for a specific contract can be retrieved with the `contractAddress` parameter.
+     * @returns ListCollectibleBalancesResponse
+     * @throws ApiError
+     */
+    listCollectibleBalances({ chainId, address, pageSize, pageToken, contractAddress, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * A contract addresses to filter by.
+         */
+        contractAddress?: string;
+    }): CancelablePromise<ListCollectibleBalancesResponse>;
+    /**
+     * List latest blocks
+     * Lists the latest indexed blocks on the EVM-compatible chain sorted in descending order by block timestamp.
+     * @returns ListEvmBlocksResponse
+     * @throws ApiError
+     */
+    getLatestBlocks({ chainId, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListEvmBlocksResponse>;
+    /**
+     * Get block
+     * Gets the details of an individual block on the EVM-compatible chain.
+     * @returns GetEvmBlockResponse
+     * @throws ApiError
+     */
+    getBlock({ chainId, blockId, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A block identifier which is either a block number or the block hash.
+         */
+        blockId: string;
+    }): CancelablePromise<GetEvmBlockResponse>;
+    /**
+     * Get deployment transaction
+     * If the address is a smart contract, returns the transaction in which it was deployed.
+     * @returns GetTransactionResponse
+     * @throws ApiError
+     */
+    getDeploymentTransaction({ chainId, address, currency, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * Contract address on the relevant chain.
+         */
+        address: string;
+        /**
+         * The currency that return values should use. Defaults to USD.
+         */
+        currency?: CurrencyCode;
+    }): CancelablePromise<GetTransactionResponse>;
+    /**
+     * List chains
+     * Lists the supported EVM-compatible chains. Filterable by network.
+     * @returns ListChainsResponse
+     * @throws ApiError
+     */
+    supportedChains({ network, }: {
+        /**
+         * mainnet or testnet.
+         */
+        network?: NetworkType;
+    }): CancelablePromise<ListChainsResponse>;
+    /**
+     * Get chain information
+     * Gets chain information for the EVM-compatible chain if supported by the api.
+     * @returns GetChainResponse
+     * @throws ApiError
+     */
+    getChainInfo({ chainId, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+    }): CancelablePromise<GetChainResponse>;
+    /**
+     * Reindex NFT metadata
+     * Triggers reindexing of token metadata for NFT contracts. Will return 400 if the NFT has been indexed within the last hour.
+     * @returns any
+     * @throws ApiError
+     */
+    reindexNft({ chainId, address, tokenId, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * Contract address on the relevant chain.
+         */
+        address: string;
+        /**
+         * TokenId on the contract
+         */
+        tokenId: string;
+    }): CancelablePromise<any>;
+    /**
+     * Get collection details
+     * Get collection details for a specific contract.
+     * @returns NftCollectionWithMetrics
+     * @throws ApiError
+     */
+    getCollection({ chainId, address, timeframe, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * Contract address on the relevant chain.
+         */
+        address: string;
+        /**
+         * The timeframe to use for trending listings. Use "DAY" for 24 hours, "WEEK" for 7 days, "MONTH" for 30 days.
+         */
+        timeframe?: TrendingTimeframe;
+    }): CancelablePromise<NftCollectionWithMetrics>;
+    /**
+     * List collections
+     * Lists details and metrics for collections.
+     * @returns ListNftCollectionWithMetricsResponse
+     * @throws ApiError
+     */
+    listCollections({ chainId, pageSize, pageToken, timeframe, sortBy, sortOrder, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The timeframe to use for trending listings. Use "DAY" for 24 hours, "WEEK" for 7 days, "MONTH" for 30 days.
+         */
+        timeframe?: TrendingTimeframe;
+        /**
+         * Which property to sort by, in conjunction with sortOrder.
+         */
+        sortBy?: CollectionSortByOption;
+        /**
+         * The order by which to sort results. Use "asc" for ascending order, "desc" for descending order. Sorted by timestamp or the `sortBy` query parameter, if provided.
+         */
+        sortOrder?: SortOrder;
+    }): CancelablePromise<ListNftCollectionWithMetricsResponse>;
+    /**
+     * Get token details
+     * Get token details for a specific token of a contract.
+     * @returns any
+     * @throws ApiError
+     */
+    getTokenDetails({ chainId, address, tokenId, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * Contract address on the relevant chain.
+         */
+        address: string;
+        /**
+         * TokenId on the contract
+         */
+        tokenId: string;
+    }): CancelablePromise<(Erc721Token | Erc1155Token)>;
+    /**
+     * List ERC transfers
+     * Lists ERC transfers for an ERC-20, ERC-721, or ERC-1155 contract address.
+     * @returns ListTransfersResponse
+     * @throws ApiError
+     */
+    listTransfers({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListTransfersResponse>;
+    /**
+     * List transactions
+     * Returns a list of transactions where the given wallet address had an on-chain interaction for the given chain. The ERC-20 transfers, ERC-721 transfers, ERC-1155, and internal transactions returned are only those where the input address had an interaction. Specifically, those lists only inlcude entries where the input address was the sender (`from` field) or the receiver (`to` field) for the sub-transaction. Therefore the transactions returned from this list may not be complete representations of the on-chain data. For a complete view of a transaction use the `/chains/:chainId/transactions/:txHash` endpoint.
+     *
+     * Filterable by block ranges.
+     * @returns ListTransactionDetailsResponse
+     * @throws ApiError
+     */
+    listTransactions({ chainId, address, pageSize, pageToken, startBlock, endBlock, sortOrder, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The order by which to sort results. Use "asc" for ascending order, "desc" for descending order. Sorted by timestamp or the `sortBy` query parameter, if provided.
+         */
+        sortOrder?: SortOrder;
+    }): CancelablePromise<ListTransactionDetailsResponse>;
+    /**
+     * List native transactions
+     * Lists native transactions for an address. Filterable by block range.
+     * @returns ListNativeTransactionsResponse
+     * @throws ApiError
+     */
+    listNativeTransactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListNativeTransactionsResponse>;
+    /**
+     * List ERC-20 transfers
+     * Lists ERC-20 transfers for an address. Filterable by block range.
+     * @returns ListErc20TransactionsResponse
+     * @throws ApiError
+     */
+    listErc20Transactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListErc20TransactionsResponse>;
+    /**
+     * List ERC-721 transfers
+     * Lists ERC-721 transfers for an address. Filterable by block range.
+     * @returns ListErc721TransactionsResponse
+     * @throws ApiError
+     */
+    listErc721Transactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListErc721TransactionsResponse>;
+    /**
+     * List ERC-1155 transfers
+     * Lists ERC-1155 transfers for an address. Filterable by block range.
+     * @returns ListErc1155TransactionsResponse
+     * @throws ApiError
+     */
+    listErc1155Transactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListErc1155TransactionsResponse>;
+    /**
+     * List internal transactions
+     * Returns a list of internal transactions for an address and chain. Filterable by block range.
+     *
+     * Note that the internal transactions list only contains `CALL` or `CALLCODE` transactions with a non-zero value and `CREATE`/`CREATE2` transactions. To get a complete list of internal transactions use the `debug_` prefixed RPC methods on an archive node.
+     * @returns ListInternalTransactionsResponse
+     * @throws ApiError
+     */
+    listInternalTransactions({ chainId, address, startBlock, endBlock, pageSize, pageToken, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A wallet address.
+         */
+        address: string;
+        startBlock?: number;
+        endBlock?: number;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+    }): CancelablePromise<ListInternalTransactionsResponse>;
+    /**
+     * Get transaction
+     * Gets the details of a single transaction.
+     * @returns GetTransactionResponse
+     * @throws ApiError
+     */
+    getTransaction({ chainId, txHash, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A transaction hash.
+         */
+        txHash: string;
+    }): CancelablePromise<GetTransactionResponse>;
+    /**
+     * List transactions for a block
+     * Lists the transactions that occured in a given block.
+     * @returns ListNativeTransactionsResponse
+     * @throws ApiError
+     */
+    getTransactionsForBlock({ chainId, blockId, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * A block identifier which is either a block number or the block hash.
+         */
+        blockId: string;
+    }): CancelablePromise<ListNativeTransactionsResponse>;
+    /**
+     * List latest transactions
+     * Lists the latest transactions. Filterable by status.
+     * @returns ListNativeTransactionsResponse
+     * @throws ApiError
+     */
+    listLatestTransactions({ chainId, pageSize, pageToken, status, }: {
+        /**
+         * A supported evm chain id. Use the `/chains` endpoint to get a list of supported chain ids.
+         */
+        chainId: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * A status filter for listed transactions.
+         */
+        status?: TransactionStatus;
+    }): CancelablePromise<ListNativeTransactionsResponse>;
+}
+
+export { EvmService };