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

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

@@ -0,0 +1,618 @@
+import { BlockchainId } from '../models/BlockchainId.js';
+import { CChainExportTransaction } from '../models/CChainExportTransaction.js';
+import { CChainImportTransaction } from '../models/CChainImportTransaction.js';
+import { ChainAddressChainIdMapListResponse } from '../models/ChainAddressChainIdMapListResponse.js';
+import { GetNetworkDetailsResponse } from '../models/GetNetworkDetailsResponse.js';
+import { GetPrimaryNetworkBlockResponse } from '../models/GetPrimaryNetworkBlockResponse.js';
+import { ListBlockchainsResponse } from '../models/ListBlockchainsResponse.js';
+import { ListCChainAtomicBalancesResponse } from '../models/ListCChainAtomicBalancesResponse.js';
+import { ListCChainAtomicTransactionsResponse } from '../models/ListCChainAtomicTransactionsResponse.js';
+import { ListHistoricalRewardsResponse } from '../models/ListHistoricalRewardsResponse.js';
+import { ListPChainBalancesResponse } from '../models/ListPChainBalancesResponse.js';
+import { ListPChainTransactionsResponse } from '../models/ListPChainTransactionsResponse.js';
+import { ListPChainUtxosResponse } from '../models/ListPChainUtxosResponse.js';
+import { ListPendingRewardsResponse } from '../models/ListPendingRewardsResponse.js';
+import { ListPrimaryNetworkBlocksResponse } from '../models/ListPrimaryNetworkBlocksResponse.js';
+import { ListSubnetsResponse } from '../models/ListSubnetsResponse.js';
+import { ListUtxosResponse } from '../models/ListUtxosResponse.js';
+import { ListValidatorDetailsResponse } from '../models/ListValidatorDetailsResponse.js';
+import { ListXChainBalancesResponse } from '../models/ListXChainBalancesResponse.js';
+import { ListXChainTransactionsResponse } from '../models/ListXChainTransactionsResponse.js';
+import { ListXChainVerticesResponse } from '../models/ListXChainVerticesResponse.js';
+import { Network } from '../models/Network.js';
+import { PChainId } from '../models/PChainId.js';
+import { PChainTransaction } from '../models/PChainTransaction.js';
+import { PrimaryNetworkTxType } from '../models/PrimaryNetworkTxType.js';
+import { SortOrder } from '../models/SortOrder.js';
+import { XChainAssetDetails } from '../models/XChainAssetDetails.js';
+import { XChainId } from '../models/XChainId.js';
+import { XChainLinearTransaction } from '../models/XChainLinearTransaction.js';
+import { XChainNonLinearTransaction } from '../models/XChainNonLinearTransaction.js';
+import { XChainVertex } from '../models/XChainVertex.js';
+import { CancelablePromise } from '../core/CancelablePromise.js';
+import { BaseHttpRequest } from '../core/BaseHttpRequest.js';
+
+declare class PrimaryNetworkService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Get transaction
+     * Gets the details of a single transaction on one of the Primary Network chains.
+     * @returns any
+     * @throws ApiError
+     */
+    getTxByHash({ blockchainId, network, txHash, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A primary network (P or X chain) transaction hash.
+         */
+        txHash: string;
+    }): CancelablePromise<(PChainTransaction | XChainNonLinearTransaction | XChainLinearTransaction | CChainExportTransaction | CChainImportTransaction)>;
+    /**
+     * List latest transactions
+     * Lists the latest transactions on one of the Primary Network chains. Transactions are filterable by addresses.
+     * @returns any
+     * @throws ApiError
+     */
+    listLatestPrimaryNetworkTransactions({ blockchainId, network, addresses, txTypes, startTimestamp, endTimestamp, pageSize, pageToken, sortOrder, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses?: string;
+        /**
+         * Query param for filtering items based on transaction types.
+         */
+        txTypes?: Array<PrimaryNetworkTxType>;
+        /**
+         * Query param for retrieving items after a specific timestamp.
+         */
+        startTimestamp?: number;
+        /**
+         * Query param for retrieving items before a specific timestamp.
+         */
+        endTimestamp?: 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;
+        /**
+         * 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<(ListPChainTransactionsResponse | ListXChainTransactionsResponse | ListCChainAtomicTransactionsResponse)>;
+    /**
+     * List staking transactions
+     * Lists active staking transactions on the P-Chain for the supplied addresses.
+     * @returns ListPChainTransactionsResponse
+     * @throws ApiError
+     */
+    listActivePrimaryNetworkStakingTransactions({ blockchainId, network, addresses, txTypes, startTimestamp, endTimestamp, pageSize, pageToken, sortOrder, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: PChainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses?: string;
+        /**
+         * Query param for filtering items based on transaction types.
+         */
+        txTypes?: Array<PrimaryNetworkTxType>;
+        /**
+         * Query param for retrieving items after a specific timestamp.
+         */
+        startTimestamp?: number;
+        /**
+         * Query param for retrieving items before a specific timestamp.
+         */
+        endTimestamp?: 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;
+        /**
+         * 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<ListPChainTransactionsResponse>;
+    /**
+     * List pending rewards
+     * Lists pending rewards on the Primary Network for the supplied addresses.
+     * @returns ListPendingRewardsResponse
+     * @throws ApiError
+     */
+    listPendingPrimaryNetworkRewards({ network, addresses, pageSize, pageToken, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses?: 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 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<ListPendingRewardsResponse>;
+    /**
+     * List historical rewards
+     * Lists historical rewards on the Primary Network for the supplied addresses.
+     * @returns ListHistoricalRewardsResponse
+     * @throws ApiError
+     */
+    listHistoricalPrimaryNetworkRewards({ network, addresses, pageSize, pageToken, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses?: 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 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<ListHistoricalRewardsResponse>;
+    /**
+     * List UTXOs
+     * Lists UTXOs on one of the Primary Network chains for the supplied addresses.
+     * @returns any
+     * @throws ApiError
+     */
+    getUtxosByAddresses({ blockchainId, network, addresses, pageSize, pageToken, assetId, sortOrder, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses?: 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;
+        /**
+         * Asset ID for any asset (only applicable X-Chain)
+         */
+        assetId?: string;
+        /**
+         * 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<(ListPChainUtxosResponse | ListUtxosResponse)>;
+    /**
+     * Get balances
+     * Gets primary network balances for one of the Primary Network chains for the supplied addresses.
+     *
+     * C-Chain balances returned are only the shared atomic memory balance. For EVM balance, use the `/v1/chains/:chainId/addresses/:addressId/balances:getNative` endpoint.
+     * @returns any
+     * @throws ApiError
+     */
+    getBalancesByAddresses({ blockchainId, network, blockTimestamp, addresses, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * An epoch timestamp in seconds. Balance will be calculated at this timestamp.
+         */
+        blockTimestamp?: number;
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses?: string;
+    }): CancelablePromise<(ListPChainBalancesResponse | ListXChainBalancesResponse | ListCChainAtomicBalancesResponse)>;
+    /**
+     * Get block
+     * Gets a block by block height or block hash on one of the Primary Network chains.
+     * @returns GetPrimaryNetworkBlockResponse
+     * @throws ApiError
+     */
+    getBlockById({ blockchainId, network, blockId, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A block identifier which is either a block number or the block hash.
+         */
+        blockId: string;
+    }): CancelablePromise<GetPrimaryNetworkBlockResponse>;
+    /**
+     * List blocks proposed by node
+     * Lists the latest blocks proposed by a given NodeID on one of the Primary Network chains.
+     * @returns ListPrimaryNetworkBlocksResponse
+     * @throws ApiError
+     */
+    listPrimaryNetworkBlocksByNodeId({ blockchainId, network, nodeId, pageSize, pageToken, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A primary network (P or X chain) nodeId.
+         */
+        nodeId: 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<ListPrimaryNetworkBlocksResponse>;
+    /**
+     * List latest blocks
+     * Lists latest blocks on one of the Primary Network chains.
+     * @returns ListPrimaryNetworkBlocksResponse
+     * @throws ApiError
+     */
+    listLatestPrimaryNetworkBlocks({ blockchainId, network, pageSize, pageToken, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: BlockchainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * 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<ListPrimaryNetworkBlocksResponse>;
+    /**
+     * List vertices
+     * Lists latest vertices on the X-Chain.
+     * @returns ListXChainVerticesResponse
+     * @throws ApiError
+     */
+    listLatestXChainVertices({ blockchainId, network, pageSize, pageToken, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: XChainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * 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<ListXChainVerticesResponse>;
+    /**
+     * Get vertex
+     * Gets a single vertex on the X-Chain.
+     * @returns XChainVertex
+     * @throws ApiError
+     */
+    getVertexByHash({ vertexHash, blockchainId, network, }: {
+        /**
+         * A vertex hash string.
+         */
+        vertexHash: string;
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: XChainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+    }): CancelablePromise<XChainVertex>;
+    /**
+     * List vertices by height
+     * Lists vertices at the given vertex height on the X-Chain.
+     * @returns ListXChainVerticesResponse
+     * @throws ApiError
+     */
+    getVertexByHeight({ vertexHeight, blockchainId, network, pageSize, pageToken, sortOrder, }: {
+        /**
+         * The height of a vertex.
+         */
+        vertexHeight: number;
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: XChainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * 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 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<ListXChainVerticesResponse>;
+    /**
+     * Get asset details
+     * Gets asset details corresponding to the given asset id on the X-Chain.
+     * @returns XChainAssetDetails
+     * @throws ApiError
+     */
+    getAssetDetails({ blockchainId, network, assetId, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: XChainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * Asset ID for any asset on X-Chain
+         */
+        assetId: string;
+    }): CancelablePromise<XChainAssetDetails>;
+    /**
+     * List asset transactions
+     * Lists asset transactions corresponding to the given asset id on the X-Chain.
+     * @returns ListXChainTransactionsResponse
+     * @throws ApiError
+     */
+    listAssetTransactions({ blockchainId, network, assetId, txTypes, startTimestamp, endTimestamp, pageSize, pageToken, }: {
+        /**
+         * A primary network blockchain id or alias.
+         */
+        blockchainId: XChainId;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * Asset ID for any asset on X-Chain
+         */
+        assetId: string;
+        /**
+         * Query param for filtering items based on transaction types.
+         */
+        txTypes?: Array<PrimaryNetworkTxType>;
+        /**
+         * Query param for retrieving items after a specific timestamp.
+         */
+        startTimestamp?: number;
+        /**
+         * Query param for retrieving items before a specific timestamp.
+         */
+        endTimestamp?: 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<ListXChainTransactionsResponse>;
+    /**
+     * Get chain interactions for addresses
+     * Returns Primary Network chains that each address has touched in the form of an address mapped array. If an address has had any on-chain interaction for a chain, that chain's chain id will be returned.
+     * @returns ChainAddressChainIdMapListResponse
+     * @throws ApiError
+     */
+    getChainIdsForAddresses({ addresses, network, }: {
+        /**
+         * A comma separated list of X-Chain or P-Chain wallet addresses, starting with "avax"/"fuji", "P-avax"/"P-fuji" or "X-avax"/"X-fuji".
+         */
+        addresses: string;
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+    }): CancelablePromise<ChainAddressChainIdMapListResponse>;
+    /**
+     * Get network details
+     * Gets network details such as validator and delegator stats.
+     * @returns GetNetworkDetailsResponse
+     * @throws ApiError
+     */
+    getNetworkDetails({ network, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+    }): CancelablePromise<GetNetworkDetailsResponse>;
+    /**
+     * List blockchains
+     * Lists all blockchains registered on the network.
+     * @returns ListBlockchainsResponse
+     * @throws ApiError
+     */
+    listBlockchains({ network, pageSize, pageToken, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * 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 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<ListBlockchainsResponse>;
+    /**
+     * List subnets
+     * Lists all subnets registered on the network.
+     * @returns ListSubnetsResponse
+     * @throws ApiError
+     */
+    listSubnets({ network, pageSize, pageToken, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * 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 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<ListSubnetsResponse>;
+    /**
+     * List validators
+     * Lists details for validators. By default, returns details for all validators. Filterable by validator node ids and minimum delegation capacity.
+     * @returns ListValidatorDetailsResponse
+     * @throws ApiError
+     */
+    listValidators({ network, validationStatus, pageSize, pageToken, nodeIds, sortOrder, minDelegationCapacity, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * Validation status of the node.
+         */
+        validationStatus: 'completed' | 'active' | 'pending';
+        /**
+         * 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 node ids to filter by.
+         */
+        nodeIds?: string;
+        /**
+         * 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;
+        /**
+         * The minimum delegation capacity, used to filter the set of nodes being returned (Units - nAVAX). Default is 0.
+         */
+        minDelegationCapacity?: any;
+    }): CancelablePromise<ListValidatorDetailsResponse>;
+    /**
+     * Get single validator details
+     * List validator details for a single validator.  Filterable by validation status.
+     * @returns ListValidatorDetailsResponse
+     * @throws ApiError
+     */
+    getSingleValidatorDetails({ network, nodeId, validationStatus, pageSize, pageToken, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A primary network (P or X chain) nodeId.
+         */
+        nodeId: string;
+        /**
+         * Validation status of the node.
+         */
+        validationStatus: 'completed' | 'active' | 'pending';
+        /**
+         * 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 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<ListValidatorDetailsResponse>;
+}
+
+export { PrimaryNetworkService };