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

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

@@ -0,0 +1,458 @@
+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 { ListPChainBalancesResponse } from '../models/ListPChainBalancesResponse.js';
+import { ListPChainTransactionsResponse } from '../models/ListPChainTransactionsResponse.js';
+import { ListPChainUtxosResponse } from '../models/ListPChainUtxosResponse.js';
+import { ListPrimaryNetworkBlocksResponse } from '../models/ListPrimaryNetworkBlocksResponse.js';
+import { ListSubnetsResponse } from '../models/ListSubnetsResponse.js';
+import { ListUtxosResponse } from '../models/ListUtxosResponse.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 { 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);
+    /**
+     * Returns the details of the supplied transaction hash.
+     * @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)>;
+    /**
+     * Returns latest transactions. If addresses are supplied, returns transactions for those addresses.
+     * @returns any
+     * @throws ApiError
+     */
+    listLatestPrimaryNetworkTransactions({ blockchainId, network, addresses, 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;
+        /**
+         * 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)>;
+    /**
+     * Returns active staking transactions for supplied addresses.
+     * @returns ListPChainTransactionsResponse
+     * @throws ApiError
+     */
+    listActivePrimaryNetworkStakingTransactions({ blockchainId, network, addresses, 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;
+        /**
+         * 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>;
+    /**
+     * Returns a list of UTXOs 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)>;
+    /**
+     * Returns balance for P-Chain, X-Chain, and C-Chain (only shared memory balance for C-Chain).
+     * @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 as of 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)>;
+    /**
+     * Returns block by block_height or block_hash on P-Chain, X-Chain (Cortina), C-Chain (hexadecimal for C-Chain).
+     * @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>;
+    /**
+     * Returns latest blocks proposed by a given NodeID, up to user defined limit.
+     * @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>;
+    /**
+     * Returns latest blocks, up to user defined limit on P-Chain, X-Chain or C-Chain.
+     * @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>;
+    /**
+     * Returns latest vertices, up to user defined limit on 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>;
+    /**
+     * Returns one vertex with the provided vertex hash on 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>;
+    /**
+     * Returns vertices with the provided vertex height on 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>;
+    /**
+     * Returns asset details corresponding to the asset id on 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>;
+    /**
+     * Returns asset transactions corresponding to the asset id on X-Chain.
+     * @returns ListXChainTransactionsResponse
+     * @throws ApiError
+     */
+    getAssetTransactions({ blockchainId, network, assetId, 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;
+        /**
+         * 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>;
+    /**
+     * Return all address-mapped chain IDs that an address has been seen on chain before.
+     * @returns ChainAddressChainIdMapListResponse
+     * @throws ApiError
+     */
+    getChainAddresses({ 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 validators and delegators stats for a given network
+     * @returns GetNetworkDetailsResponse
+     * @throws ApiError
+     */
+    getValidatorsAndDelegatorsStats({ network, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+    }): CancelablePromise<GetNetworkDetailsResponse>;
+    /**
+     * Returns 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>;
+    /**
+     * Returns 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>;
+}
+
+export { PrimaryNetworkService };