@avalabs/glacier-sdk 2.8.0-alpha.19 → 2.8.0-alpha.190

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

@@ -0,0 +1,260 @@
+import { ChainAddressChainIdMapListResponse } from '../models/ChainAddressChainIdMapListResponse.js';
+import { DelegationStatusType } from '../models/DelegationStatusType.js';
+import { GetNetworkDetailsResponse } from '../models/GetNetworkDetailsResponse.js';
+import { ListBlockchainsResponse } from '../models/ListBlockchainsResponse.js';
+import { ListDelegatorDetailsResponse } from '../models/ListDelegatorDetailsResponse.js';
+import { ListSubnetsResponse } from '../models/ListSubnetsResponse.js';
+import { ListValidatorDetailsResponse } from '../models/ListValidatorDetailsResponse.js';
+import { Network } from '../models/Network.js';
+import { SortByOption } from '../models/SortByOption.js';
+import { SortOrder } from '../models/SortOrder.js';
+import { ValidationStatusType } from '../models/ValidationStatusType.js';
+import { XChainAssetDetails } from '../models/XChainAssetDetails.js';
+import { XChainId } from '../models/XChainId.js';
+import { CancelablePromise } from '../core/CancelablePromise.js';
+import { BaseHttpRequest } from '../core/BaseHttpRequest.js';
+
+declare class PrimaryNetworkService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * 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>;
+    /**
+     * 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, pageToken, pageSize, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: 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<ListBlockchainsResponse>;
+    /**
+     * List subnets
+     * Lists all subnets registered on the network.
+     * @returns ListSubnetsResponse
+     * @throws ApiError
+     */
+    listSubnets({ network, pageToken, pageSize, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: 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<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, pageToken, pageSize, nodeIds, sortBy, sortOrder, validationStatus, minDelegationCapacity, maxDelegationCapacity, minTimeRemaining, maxTimeRemaining, minFeePercentage, maxFeePercentage, minUptimePerformance, maxUptimePerformance, subnetId, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A comma separated list of node ids to filter by.
+         */
+        nodeIds?: string;
+        /**
+         * Which property to sort by, in conjunction with sortOrder.
+         *
+         * Note: Delegation fee is only available for mainnet validators. Set `subnetId` to `11111111111111111111111111111111LpoYY`  to use this option.
+         */
+        sortBy?: SortByOption;
+        /**
+         * 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;
+        /**
+         * Validation status of the node.
+         */
+        validationStatus?: ValidationStatusType;
+        /**
+         * The minimum delegation capacity, in nAVAX, used to filter the set of nodes being returned. Accepts values between 0 and 720,000,000,000,000,000
+         */
+        minDelegationCapacity?: string;
+        /**
+         * The maximum delegation capacity, in nAVAX, used to filter the set of nodes being returned. Accepts values between 0 and 720,000,000,000,000,000.
+         */
+        maxDelegationCapacity?: string;
+        /**
+         * The minimum validation time remaining, in seconds, used to filter the set of nodes being returned.
+         */
+        minTimeRemaining?: number;
+        /**
+         * The maximum validation time remaining, in seconds, used to filter the set of nodes being returned.
+         */
+        maxTimeRemaining?: number;
+        /**
+         * The minimum fee percentage, used to filter the set of nodes being returned. If this field is populated no subnet validations will be returned, as their fee percentage is null, since subnet delegations are not supported. Default is 2.0, as per the Avalanche spec.
+         */
+        minFeePercentage?: number;
+        /**
+         * The maximum fee percentage, used to filter the set of nodes being returned. If this field is populated no subnet validations will be returned, as their fee percentage is null, since subnet delegations are not supported. Default is 100.0.
+         */
+        maxFeePercentage?: number;
+        /**
+         * The minimum node uptime performance percentage, which represents node health, used to filter the set of nodes being returned Default is 90.
+         */
+        minUptimePerformance?: number;
+        /**
+         * The maximum node uptime performance percentage, which represents node health, used to filter the set of nodes being returned. Default is 100.
+         */
+        maxUptimePerformance?: number;
+        /**
+         * The subnet ID to filter by. If not provided, then all subnets will be returned.
+         */
+        subnetId?: 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, pageToken, pageSize, validationStatus, sortOrder, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A primary network (P or X chain) nodeId.
+         */
+        nodeId: string;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * Validation status of the node.
+         */
+        validationStatus?: ValidationStatusType;
+        /**
+         * 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>;
+    /**
+     * List delegators
+     * Lists details for delegators.
+     * @returns ListDelegatorDetailsResponse
+     * @throws ApiError
+     */
+    listDelegators({ network, pageToken, pageSize, rewardAddresses, sortOrder, delegationStatus, nodeIds, }: {
+        /**
+         * Either mainnet or a testnet.
+         */
+        network: Network;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * A comma separated list of reward addresses to filter by.
+         */
+        rewardAddresses?: 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;
+        /**
+         * Delegation status of the node.
+         */
+        delegationStatus?: DelegationStatusType;
+        /**
+         * A comma separated list of node ids to filter by.
+         */
+        nodeIds?: string;
+    }): CancelablePromise<ListDelegatorDetailsResponse>;
+}
+
+export { PrimaryNetworkService };

package/esm/generated/services/PrimaryNetworkService.js

@@ -0,0 +1,177 @@
+class PrimaryNetworkService {
+  constructor(httpRequest) {
+    this.httpRequest = httpRequest;
+  }
+  getAssetDetails({
+    blockchainId,
+    network,
+    assetId
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/blockchains/{blockchainId}/assets/{assetId}",
+      path: {
+        "blockchainId": blockchainId,
+        "network": network,
+        "assetId": assetId
+      }
+    });
+  }
+  getChainIdsForAddresses({
+    addresses,
+    network
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/addresses:listChainIds",
+      path: {
+        "network": network
+      },
+      query: {
+        "addresses": addresses
+      }
+    });
+  }
+  getNetworkDetails({
+    network
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}",
+      path: {
+        "network": network
+      }
+    });
+  }
+  listBlockchains({
+    network,
+    pageToken,
+    pageSize = 10,
+    sortOrder
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/blockchains",
+      path: {
+        "network": network
+      },
+      query: {
+        "pageToken": pageToken,
+        "pageSize": pageSize,
+        "sortOrder": sortOrder
+      }
+    });
+  }
+  listSubnets({
+    network,
+    pageToken,
+    pageSize = 10,
+    sortOrder
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/subnets",
+      path: {
+        "network": network
+      },
+      query: {
+        "pageToken": pageToken,
+        "pageSize": pageSize,
+        "sortOrder": sortOrder
+      }
+    });
+  }
+  listValidators({
+    network,
+    pageToken,
+    pageSize = 10,
+    nodeIds,
+    sortBy,
+    sortOrder,
+    validationStatus,
+    minDelegationCapacity,
+    maxDelegationCapacity,
+    minTimeRemaining,
+    maxTimeRemaining,
+    minFeePercentage,
+    maxFeePercentage,
+    minUptimePerformance,
+    maxUptimePerformance,
+    subnetId
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/validators",
+      path: {
+        "network": network
+      },
+      query: {
+        "pageToken": pageToken,
+        "pageSize": pageSize,
+        "nodeIds": nodeIds,
+        "sortBy": sortBy,
+        "sortOrder": sortOrder,
+        "validationStatus": validationStatus,
+        "minDelegationCapacity": minDelegationCapacity,
+        "maxDelegationCapacity": maxDelegationCapacity,
+        "minTimeRemaining": minTimeRemaining,
+        "maxTimeRemaining": maxTimeRemaining,
+        "minFeePercentage": minFeePercentage,
+        "maxFeePercentage": maxFeePercentage,
+        "minUptimePerformance": minUptimePerformance,
+        "maxUptimePerformance": maxUptimePerformance,
+        "subnetId": subnetId
+      }
+    });
+  }
+  getSingleValidatorDetails({
+    network,
+    nodeId,
+    pageToken,
+    pageSize = 10,
+    validationStatus,
+    sortOrder
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/validators/{nodeId}",
+      path: {
+        "network": network,
+        "nodeId": nodeId
+      },
+      query: {
+        "pageToken": pageToken,
+        "pageSize": pageSize,
+        "validationStatus": validationStatus,
+        "sortOrder": sortOrder
+      }
+    });
+  }
+  listDelegators({
+    network,
+    pageToken,
+    pageSize = 10,
+    rewardAddresses,
+    sortOrder,
+    delegationStatus,
+    nodeIds
+  }) {
+    return this.httpRequest.request({
+      method: "GET",
+      url: "/v1/networks/{network}/delegators",
+      path: {
+        "network": network
+      },
+      query: {
+        "pageToken": pageToken,
+        "pageSize": pageSize,
+        "rewardAddresses": rewardAddresses,
+        "sortOrder": sortOrder,
+        "delegationStatus": delegationStatus,
+        "nodeIds": nodeIds
+      }
+    });
+  }
+}
+
+export { PrimaryNetworkService };

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

@@ -0,0 +1,175 @@
+import { BlockchainId } from '../models/BlockchainId.js';
+import { CChainExportTransaction } from '../models/CChainExportTransaction.js';
+import { CChainImportTransaction } from '../models/CChainImportTransaction.js';
+import { ListCChainAtomicTransactionsResponse } from '../models/ListCChainAtomicTransactionsResponse.js';
+import { ListPChainTransactionsResponse } from '../models/ListPChainTransactionsResponse.js';
+import { ListXChainTransactionsResponse } from '../models/ListXChainTransactionsResponse.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 { XChainId } from '../models/XChainId.js';
+import { XChainLinearTransaction } from '../models/XChainLinearTransaction.js';
+import { XChainNonLinearTransaction } from '../models/XChainNonLinearTransaction.js';
+import { CancelablePromise } from '../core/CancelablePromise.js';
+import { BaseHttpRequest } from '../core/BaseHttpRequest.js';
+
+declare class PrimaryNetworkTransactionsService {
+    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, txTypes, and timestamps. When querying for latest transactions without an address parameter, filtering by txTypes and timestamps is not supported. An address filter must be provided to utilize txTypes and timestamp filters.
+     *
+     * Given that each transaction may return a large number of UTXO objects, bounded only by the maximum transaction size, the query may return less transactions than the provided page size. The result will contain less results than the page size if the number of utxos contained in the resulting transactions reach a performance threshold.
+     * @returns any
+     * @throws ApiError
+     */
+    listLatestPrimaryNetworkTransactions({ blockchainId, network, addresses, txTypes, startTimestamp, endTimestamp, pageToken, pageSize, 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;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: 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<(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, pageToken, pageSize, 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;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: 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<ListPChainTransactionsResponse>;
+    /**
+     * 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, pageToken, pageSize, }: {
+        /**
+         * 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;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+    }): CancelablePromise<ListXChainTransactionsResponse>;
+}
+
+export { PrimaryNetworkTransactionsService };