@avalabs/glacier-sdk 2.8.0-alpha.19 → 2.8.0-alpha.191
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +10 -0
- package/dist/index.d.ts +4494 -321
- package/dist/index.js +2253 -108
- package/esm/generated/Glacier.d.ts +48 -0
- package/esm/generated/Glacier.js +77 -0
- package/esm/generated/core/ApiError.d.ts +13 -0
- package/esm/generated/core/ApiError.js +18 -0
- package/esm/generated/core/ApiRequestOptions.d.ts +15 -0
- package/esm/generated/core/ApiResult.d.ts +9 -0
- package/esm/generated/core/BaseHttpRequest.d.ts +11 -0
- package/esm/generated/core/BaseHttpRequest.js +7 -0
- package/esm/generated/core/CancelablePromise.d.ts +22 -0
- package/esm/generated/core/CancelablePromise.js +93 -0
- package/esm/generated/core/FetchHttpRequest.js +13 -0
- package/esm/generated/core/OpenAPI.d.ts +18 -0
- package/esm/generated/core/OpenAPI.js +13 -0
- package/esm/generated/core/request.js +228 -0
- package/esm/generated/models/ActiveDelegatorDetails.d.ts +19 -0
- package/esm/generated/models/ActiveDelegatorDetails.js +8 -0
- package/esm/generated/models/ActiveValidatorDetails.d.ts +33 -0
- package/esm/generated/models/ActiveValidatorDetails.js +8 -0
- package/esm/generated/models/AddressActivityMetadata.d.ts +12 -0
- package/esm/generated/models/AddressesChangeRequest.d.ts +8 -0
- package/esm/generated/models/AggregatedAssetAmount.d.ts +28 -0
- package/esm/generated/models/AssetAmount.d.ts +27 -0
- package/esm/generated/models/AssetWithPriceInfo.d.ts +32 -0
- package/esm/generated/models/Blockchain.d.ts +10 -0
- package/esm/generated/models/BlockchainId.d.ts +12 -0
- package/esm/generated/models/BlockchainId.js +13 -0
- package/esm/generated/models/BlockchainIds.d.ts +9 -0
- package/esm/generated/models/BlockchainIds.js +10 -0
- package/esm/generated/models/BlockchainInfo.d.ts +5 -0
- package/esm/generated/models/BlsCredentials.d.ts +6 -0
- package/esm/generated/models/CChainAtomicBalances.d.ts +8 -0
- package/esm/generated/models/CChainExportTransaction.d.ts +58 -0
- package/esm/generated/models/CChainExportTransaction.js +8 -0
- package/esm/generated/models/CChainImportTransaction.d.ts +58 -0
- package/esm/generated/models/CChainImportTransaction.js +8 -0
- package/esm/generated/models/CChainSharedAssetBalance.d.ts +29 -0
- package/esm/generated/models/ChainAddressChainIdMap.d.ts +8 -0
- package/esm/generated/models/ChainAddressChainIdMapListResponse.d.ts +7 -0
- package/esm/generated/models/ChainInfo.d.ts +26 -0
- package/esm/generated/models/ChainStatus.d.ts +9 -0
- package/esm/generated/models/ChainStatus.js +7 -0
- package/esm/generated/models/CompletedDelegatorDetails.d.ts +19 -0
- package/esm/generated/models/CompletedDelegatorDetails.js +8 -0
- package/esm/generated/models/CompletedValidatorDetails.d.ts +26 -0
- package/esm/generated/models/CompletedValidatorDetails.js +8 -0
- package/esm/generated/models/ContractDeploymentDetails.d.ts +13 -0
- package/esm/generated/models/ContractSubmissionBody.d.ts +10 -0
- package/esm/generated/models/ContractSubmissionErc1155.d.ts +31 -0
- package/esm/generated/models/ContractSubmissionErc1155.js +8 -0
- package/esm/generated/models/ContractSubmissionErc20.d.ts +31 -0
- package/esm/generated/models/ContractSubmissionErc20.js +8 -0
- package/esm/generated/models/ContractSubmissionErc721.d.ts +29 -0
- package/esm/generated/models/ContractSubmissionErc721.js +8 -0
- package/esm/generated/models/ContractSubmissionUnknown.d.ts +25 -0
- package/esm/generated/models/ContractSubmissionUnknown.js +8 -0
- package/esm/generated/models/CreateEvmTransactionExportRequest.d.ts +19 -0
- package/esm/generated/models/CreatePrimaryNetworkTransactionExportRequest.d.ts +19 -0
- package/esm/generated/models/CurrencyCode.d.ts +21 -0
- package/esm/generated/models/CurrencyCode.js +19 -0
- package/esm/generated/models/DelegationStatusType.d.ts +7 -0
- package/esm/generated/models/DelegationStatusType.js +8 -0
- package/esm/generated/models/DelegatorsDetails.d.ts +6 -0
- package/esm/generated/models/DeliveredSourceNotIndexedTeleporterMessage.d.ts +29 -0
- package/esm/generated/models/DeliveredSourceNotIndexedTeleporterMessage.js +8 -0
- package/esm/generated/models/DeliveredTeleporterMessage.d.ts +31 -0
- package/esm/generated/models/DeliveredTeleporterMessage.js +8 -0
- package/esm/generated/models/EVMInput.d.ts +19 -0
- package/esm/generated/models/EVMOperationType.d.ts +5 -0
- package/esm/generated/models/EVMOperationType.js +6 -0
- package/esm/generated/models/EVMOutput.d.ts +14 -0
- package/esm/generated/models/Erc1155Contract.d.ts +37 -0
- package/esm/generated/models/Erc1155Contract.js +8 -0
- package/esm/generated/models/Erc1155Token.d.ts +19 -0
- package/esm/generated/models/Erc1155Token.js +8 -0
- package/esm/generated/models/Erc1155TokenBalance.d.ts +27 -0
- package/esm/generated/models/Erc1155TokenBalance.js +8 -0
- package/esm/generated/models/Erc1155TokenMetadata.d.ts +17 -0
- package/esm/generated/models/Erc1155Transfer.d.ts +28 -0
- package/esm/generated/models/Erc1155TransferDetails.d.ts +12 -0
- package/esm/generated/models/Erc20Contract.d.ts +41 -0
- package/esm/generated/models/Erc20Contract.js +8 -0
- package/esm/generated/models/Erc20Token.d.ts +36 -0
- package/esm/generated/models/Erc20Token.js +8 -0
- package/esm/generated/models/Erc20TokenBalance.d.ts +48 -0
- package/esm/generated/models/Erc20TokenBalance.js +8 -0
- package/esm/generated/models/Erc20Transfer.d.ts +28 -0
- package/esm/generated/models/Erc20TransferDetails.d.ts +12 -0
- package/esm/generated/models/Erc721Contract.d.ts +35 -0
- package/esm/generated/models/Erc721Contract.js +8 -0
- package/esm/generated/models/Erc721Token.d.ts +31 -0
- package/esm/generated/models/Erc721Token.js +8 -0
- package/esm/generated/models/Erc721TokenBalance.d.ts +35 -0
- package/esm/generated/models/Erc721TokenBalance.js +8 -0
- package/esm/generated/models/Erc721TokenMetadata.d.ts +16 -0
- package/esm/generated/models/Erc721Transfer.d.ts +27 -0
- package/esm/generated/models/Erc721TransferDetails.d.ts +11 -0
- package/esm/generated/models/EventType.d.ts +5 -0
- package/esm/generated/models/EventType.js +6 -0
- package/esm/generated/models/EvmBlock.d.ts +45 -0
- package/esm/generated/models/EvmNetworkOptions.d.ts +6 -0
- package/esm/generated/models/FullNativeTransactionDetails.d.ts +62 -0
- package/esm/generated/models/GetChainResponse.d.ts +26 -0
- package/esm/generated/models/GetEvmBlockResponse.d.ts +45 -0
- package/esm/generated/models/GetNativeBalanceResponse.d.ts +10 -0
- package/esm/generated/models/GetNetworkDetailsResponse.d.ts +9 -0
- package/esm/generated/models/GetPrimaryNetworkBlockResponse.d.ts +16 -0
- package/esm/generated/models/GetTransactionResponse.d.ts +29 -0
- package/esm/generated/models/GlacierApiFeature.d.ts +6 -0
- package/esm/generated/models/GlacierApiFeature.js +7 -0
- package/esm/generated/models/HistoricalReward.d.ts +21 -0
- package/esm/generated/models/ImageAsset.d.ts +9 -0
- package/esm/generated/models/InternalTransaction.d.ts +33 -0
- package/esm/generated/models/InternalTransactionDetails.d.ts +17 -0
- package/esm/generated/models/InternalTransactionOpCall.d.ts +11 -0
- package/esm/generated/models/InternalTransactionOpCall.js +12 -0
- package/esm/generated/models/ListBlockchainsResponse.d.ts +11 -0
- package/esm/generated/models/ListCChainAtomicBalancesResponse.d.ts +9 -0
- package/esm/generated/models/ListCChainAtomicTransactionsResponse.d.ts +14 -0
- package/esm/generated/models/ListChainsResponse.d.ts +7 -0
- package/esm/generated/models/ListCollectibleBalancesResponse.d.ts +15 -0
- package/esm/generated/models/ListContractsResponse.d.ts +14 -0
- package/esm/generated/models/ListDelegatorDetailsResponse.d.ts +16 -0
- package/esm/generated/models/ListErc1155BalancesResponse.d.ts +14 -0
- package/esm/generated/models/ListErc1155TransactionsResponse.d.ts +11 -0
- package/esm/generated/models/ListErc20BalancesResponse.d.ts +14 -0
- package/esm/generated/models/ListErc20TransactionsResponse.d.ts +11 -0
- package/esm/generated/models/ListErc721BalancesResponse.d.ts +14 -0
- package/esm/generated/models/ListErc721TransactionsResponse.d.ts +11 -0
- package/esm/generated/models/ListEvmBlocksResponse.d.ts +11 -0
- package/esm/generated/models/ListHistoricalRewardsResponse.d.ts +11 -0
- package/esm/generated/models/ListInternalTransactionsResponse.d.ts +11 -0
- package/esm/generated/models/ListNativeTransactionsResponse.d.ts +11 -0
- package/esm/generated/models/ListNftTokens.d.ts +12 -0
- package/esm/generated/models/ListPChainBalancesResponse.d.ts +9 -0
- package/esm/generated/models/ListPChainTransactionsResponse.d.ts +13 -0
- package/esm/generated/models/ListPChainUtxosResponse.d.ts +13 -0
- package/esm/generated/models/ListPendingRewardsResponse.d.ts +11 -0
- package/esm/generated/models/ListPrimaryNetworkBlocksResponse.d.ts +13 -0
- package/esm/generated/models/ListSubnetsResponse.d.ts +11 -0
- package/esm/generated/models/ListTeleporterMessagesResponse.d.ts +12 -0
- package/esm/generated/models/ListTransactionDetailsResponse.d.ts +11 -0
- package/esm/generated/models/ListTransfersResponse.d.ts +13 -0
- package/esm/generated/models/ListUtxosResponse.d.ts +13 -0
- package/esm/generated/models/ListValidatorDetailsResponse.d.ts +17 -0
- package/esm/generated/models/ListWebhookAddressesResponse.d.ts +10 -0
- package/esm/generated/models/ListWebhooksResponse.d.ts +11 -0
- package/esm/generated/models/ListXChainBalancesResponse.d.ts +9 -0
- package/esm/generated/models/ListXChainTransactionsResponse.d.ts +14 -0
- package/esm/generated/models/ListXChainVerticesResponse.d.ts +13 -0
- package/esm/generated/models/Method.d.ts +15 -0
- package/esm/generated/models/Money.d.ts +11 -0
- package/esm/generated/models/NativeTokenBalance.d.ts +38 -0
- package/esm/generated/models/NativeTransaction.d.ts +55 -0
- package/esm/generated/models/Network.d.ts +6 -0
- package/esm/generated/models/Network.js +7 -0
- package/esm/generated/models/NetworkToken.d.ts +21 -0
- package/esm/generated/models/NetworkTokenDetails.d.ts +16 -0
- package/esm/generated/models/NetworkType.d.ts +6 -0
- package/esm/generated/models/NetworkType.js +7 -0
- package/esm/generated/models/NextPageToken.d.ts +8 -0
- package/esm/generated/models/NftTokenMetadataStatus.d.ts +18 -0
- package/esm/generated/models/NftTokenMetadataStatus.js +16 -0
- package/esm/generated/models/OperationStatus.d.ts +8 -0
- package/esm/generated/models/OperationStatus.js +9 -0
- package/esm/generated/models/OperationStatusCode.d.ts +7 -0
- package/esm/generated/models/OperationStatusCode.js +8 -0
- package/esm/generated/models/OperationStatusResponse.d.ts +15 -0
- package/esm/generated/models/OperationType.d.ts +8 -0
- package/esm/generated/models/OperationType.js +9 -0
- package/esm/generated/models/PChainBalance.d.ts +39 -0
- package/esm/generated/models/PChainId.d.ts +6 -0
- package/esm/generated/models/PChainId.js +7 -0
- package/esm/generated/models/PChainSharedAsset.d.ts +30 -0
- package/esm/generated/models/PChainTransaction.d.ts +82 -0
- package/esm/generated/models/PChainTransactionType.d.ts +20 -0
- package/esm/generated/models/PChainTransactionType.js +21 -0
- package/esm/generated/models/PChainUtxo.d.ts +51 -0
- package/esm/generated/models/PendingDelegatorDetails.d.ts +19 -0
- package/esm/generated/models/PendingDelegatorDetails.js +8 -0
- package/esm/generated/models/PendingReward.d.ts +22 -0
- package/esm/generated/models/PendingTeleporterMessage.d.ts +29 -0
- package/esm/generated/models/PendingTeleporterMessage.js +8 -0
- package/esm/generated/models/PendingValidatorDetails.d.ts +23 -0
- package/esm/generated/models/PendingValidatorDetails.js +8 -0
- package/esm/generated/models/PricingProviders.d.ts +5 -0
- package/esm/generated/models/PrimaryNetwork.d.ts +6 -0
- package/esm/generated/models/PrimaryNetwork.js +7 -0
- package/esm/generated/models/PrimaryNetworkAssetCap.d.ts +9 -0
- package/esm/generated/models/PrimaryNetworkAssetCap.js +7 -0
- package/esm/generated/models/PrimaryNetworkAssetType.d.ts +9 -0
- package/esm/generated/models/PrimaryNetworkAssetType.js +7 -0
- package/esm/generated/models/PrimaryNetworkBlock.d.ts +16 -0
- package/esm/generated/models/PrimaryNetworkChainInfo.d.ts +9 -0
- package/esm/generated/models/PrimaryNetworkChainName.d.ts +7 -0
- package/esm/generated/models/PrimaryNetworkChainName.js +8 -0
- package/esm/generated/models/PrimaryNetworkOperationType.d.ts +7 -0
- package/esm/generated/models/PrimaryNetworkOperationType.js +8 -0
- package/esm/generated/models/PrimaryNetworkOptions.d.ts +7 -0
- package/esm/generated/models/PrimaryNetworkTxType.d.ts +22 -0
- package/esm/generated/models/PrimaryNetworkTxType.js +23 -0
- package/esm/generated/models/ProposerDetails.d.ts +9 -0
- package/esm/generated/models/RegisterWebhookRequest.d.ts +19 -0
- package/esm/generated/models/RemovedValidatorDetails.d.ts +25 -0
- package/esm/generated/models/RemovedValidatorDetails.js +8 -0
- package/esm/generated/models/ResourceLink.d.ts +8 -0
- package/esm/generated/models/ResourceLinkType.d.ts +22 -0
- package/esm/generated/models/ResourceLinkType.js +23 -0
- package/esm/generated/models/RewardType.d.ts +7 -0
- package/esm/generated/models/RewardType.js +8 -0
- package/esm/generated/models/Rewards.d.ts +8 -0
- package/esm/generated/models/RichAddress.d.ts +24 -0
- package/esm/generated/models/RpcErrorDto.d.ts +7 -0
- package/esm/generated/models/RpcErrorResponseDto.d.ts +9 -0
- package/esm/generated/models/RpcRequestBodyDto.d.ts +8 -0
- package/esm/generated/models/RpcSuccessResponseDto.d.ts +7 -0
- package/esm/generated/models/SharedSecretsResponse.d.ts +5 -0
- package/esm/generated/models/SortByOption.d.ts +9 -0
- package/esm/generated/models/SortByOption.js +10 -0
- package/esm/generated/models/SortOrder.d.ts +6 -0
- package/esm/generated/models/SortOrder.js +7 -0
- package/esm/generated/models/StakingDistribution.d.ts +7 -0
- package/esm/generated/models/Subnet.d.ts +30 -0
- package/esm/generated/models/SubnetOwnershipInfo.d.ts +16 -0
- package/esm/generated/models/TeleporterDestinationTransaction.d.ts +9 -0
- package/esm/generated/models/TeleporterReceipt.d.ts +6 -0
- package/esm/generated/models/TeleporterRewardDetails.d.ts +37 -0
- package/esm/generated/models/TeleporterRewardDetails.js +8 -0
- package/esm/generated/models/TeleporterSourceTransaction.d.ts +7 -0
- package/esm/generated/models/TransactionDetails.d.ts +30 -0
- package/esm/generated/models/TransactionExportMetadata.d.ts +15 -0
- package/esm/generated/models/TransactionMethodType.d.ts +10 -0
- package/esm/generated/models/TransactionMethodType.js +8 -0
- package/esm/generated/models/TransactionStatus.d.ts +6 -0
- package/esm/generated/models/TransactionStatus.js +7 -0
- package/esm/generated/models/TransactionVertexDetail.d.ts +16 -0
- package/esm/generated/models/UnknownContract.d.ts +31 -0
- package/esm/generated/models/UnknownContract.js +8 -0
- package/esm/generated/models/UpdateContractResponse.d.ts +10 -0
- package/esm/generated/models/UpdateWebhookRequest.d.ts +12 -0
- package/esm/generated/models/UtilityAddresses.d.ts +5 -0
- package/esm/generated/models/Utxo.d.ts +68 -0
- package/esm/generated/models/UtxoCredential.d.ts +12 -0
- package/esm/generated/models/UtxoType.d.ts +6 -0
- package/esm/generated/models/UtxoType.js +7 -0
- package/esm/generated/models/ValidationStatusType.d.ts +8 -0
- package/esm/generated/models/ValidationStatusType.js +9 -0
- package/esm/generated/models/ValidatorHealthDetails.d.ts +20 -0
- package/esm/generated/models/ValidatorsDetails.d.ts +11 -0
- package/esm/generated/models/VmName.d.ts +7 -0
- package/esm/generated/models/VmName.js +8 -0
- package/esm/generated/models/WebhookResponse.d.ts +25 -0
- package/esm/generated/models/WebhookStatus.d.ts +6 -0
- package/esm/generated/models/WebhookStatus.js +7 -0
- package/esm/generated/models/WebhookStatusType.d.ts +6 -0
- package/esm/generated/models/WebhookStatusType.js +7 -0
- package/esm/generated/models/XChainAssetDetails.d.ts +29 -0
- package/esm/generated/models/XChainBalances.d.ts +17 -0
- package/esm/generated/models/XChainId.d.ts +7 -0
- package/esm/generated/models/XChainId.js +8 -0
- package/esm/generated/models/XChainLinearTransaction.d.ts +65 -0
- package/esm/generated/models/XChainLinearTransaction.js +9 -0
- package/esm/generated/models/XChainNonLinearTransaction.d.ts +62 -0
- package/esm/generated/models/XChainNonLinearTransaction.js +9 -0
- package/esm/generated/models/XChainSharedAssetBalance.d.ts +29 -0
- package/esm/generated/models/XChainTransactionType.d.ts +13 -0
- package/esm/generated/models/XChainTransactionType.js +11 -0
- package/esm/generated/models/XChainVertex.d.ts +12 -0
- package/esm/generated/services/DefaultService.d.ts +14 -0
- package/esm/generated/services/DefaultService.js +13 -0
- package/esm/generated/services/EvmBalancesService.d.ts +181 -0
- package/esm/generated/services/EvmBalancesService.js +118 -0
- package/esm/generated/services/EvmBlocksService.d.ts +47 -0
- package/esm/generated/services/EvmBlocksService.js +37 -0
- package/esm/generated/services/EvmChainsService.d.ts +41 -0
- package/esm/generated/services/EvmChainsService.js +31 -0
- package/esm/generated/services/EvmContractsService.d.ts +48 -0
- package/esm/generated/services/EvmContractsService.js +36 -0
- package/esm/generated/services/EvmTransactionsService.d.ts +353 -0
- package/esm/generated/services/EvmTransactionsService.js +251 -0
- package/esm/generated/services/HealthCheckService.d.ts +20 -0
- package/esm/generated/services/HealthCheckService.js +16 -0
- package/esm/generated/services/NfTsService.d.ts +76 -0
- package/esm/generated/services/NfTsService.js +56 -0
- package/esm/generated/services/OperationsService.d.ts +35 -0
- package/esm/generated/services/OperationsService.js +28 -0
- package/esm/generated/services/PrimaryNetworkBalancesService.d.ts +40 -0
- package/esm/generated/services/PrimaryNetworkBalancesService.js +26 -0
- package/esm/generated/services/PrimaryNetworkBlocksService.d.ts +85 -0
- package/esm/generated/services/PrimaryNetworkBlocksService.js +62 -0
- package/esm/generated/services/PrimaryNetworkRewardsService.d.ts +82 -0
- package/esm/generated/services/PrimaryNetworkRewardsService.js +55 -0
- package/esm/generated/services/PrimaryNetworkService.d.ts +260 -0
- package/esm/generated/services/PrimaryNetworkService.js +177 -0
- package/esm/generated/services/PrimaryNetworkTransactionsService.d.ts +175 -0
- package/esm/generated/services/PrimaryNetworkTransactionsService.js +107 -0
- package/esm/generated/services/PrimaryNetworkUtxOsService.d.ts +54 -0
- package/esm/generated/services/PrimaryNetworkUtxOsService.js +34 -0
- package/esm/generated/services/PrimaryNetworkVerticesService.d.ts +90 -0
- package/esm/generated/services/PrimaryNetworkVerticesService.js +64 -0
- package/esm/generated/services/RpcService.d.ts +25 -0
- package/esm/generated/services/RpcService.js +24 -0
- package/esm/generated/services/TeleporterService.d.ts +62 -0
- package/esm/generated/services/TeleporterService.js +41 -0
- package/esm/generated/services/WebhooksService.d.ts +143 -0
- package/esm/generated/services/WebhooksService.js +125 -0
- package/esm/index.d.ts +212 -2
- package/esm/index.js +89 -2
- package/package.json +5 -11
- package/esm/generated/models.d.ts +0 -386
- package/esm/generated/models.js +0 -46
- package/esm/glacierClient.d.ts +0 -95
- package/esm/glacierClient.js +0 -83
- package/esm/types.d.ts +0 -14
package/dist/index.d.ts
CHANGED
|
@@ -1,61 +1,143 @@
|
|
|
1
|
-
|
|
1
|
+
type ApiRequestOptions = {
|
|
2
|
+
readonly method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'OPTIONS' | 'HEAD' | 'PATCH';
|
|
3
|
+
readonly url: string;
|
|
4
|
+
readonly path?: Record<string, any>;
|
|
5
|
+
readonly cookies?: Record<string, any>;
|
|
6
|
+
readonly headers?: Record<string, any>;
|
|
7
|
+
readonly query?: Record<string, any>;
|
|
8
|
+
readonly formData?: Record<string, any>;
|
|
9
|
+
readonly body?: any;
|
|
10
|
+
readonly mediaType?: string;
|
|
11
|
+
readonly responseHeader?: string;
|
|
12
|
+
readonly errors?: Record<number, string>;
|
|
13
|
+
};
|
|
2
14
|
|
|
3
|
-
declare
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
15
|
+
declare class CancelError extends Error {
|
|
16
|
+
constructor(message: string);
|
|
17
|
+
get isCancelled(): boolean;
|
|
18
|
+
}
|
|
19
|
+
interface OnCancel {
|
|
20
|
+
readonly isResolved: boolean;
|
|
21
|
+
readonly isRejected: boolean;
|
|
22
|
+
readonly isCancelled: boolean;
|
|
23
|
+
(cancelHandler: () => void): void;
|
|
24
|
+
}
|
|
25
|
+
declare class CancelablePromise<T> implements Promise<T> {
|
|
26
|
+
#private;
|
|
27
|
+
constructor(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void, onCancel: OnCancel) => void);
|
|
28
|
+
get [Symbol.toStringTag](): string;
|
|
29
|
+
then<TResult1 = T, TResult2 = never>(onFulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | null, onRejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | null): Promise<TResult1 | TResult2>;
|
|
30
|
+
catch<TResult = never>(onRejected?: ((reason: any) => TResult | PromiseLike<TResult>) | null): Promise<T | TResult>;
|
|
31
|
+
finally(onFinally?: (() => void) | null): Promise<T>;
|
|
32
|
+
cancel(): void;
|
|
33
|
+
get isCancelled(): boolean;
|
|
34
|
+
}
|
|
35
|
+
|
|
36
|
+
type Resolver<T> = (options: ApiRequestOptions) => Promise<T>;
|
|
37
|
+
type Headers = Record<string, string>;
|
|
38
|
+
type OpenAPIConfig = {
|
|
39
|
+
BASE: string;
|
|
40
|
+
VERSION: string;
|
|
41
|
+
WITH_CREDENTIALS: boolean;
|
|
42
|
+
CREDENTIALS: 'include' | 'omit' | 'same-origin';
|
|
43
|
+
TOKEN?: string | Resolver<string>;
|
|
44
|
+
USERNAME?: string | Resolver<string>;
|
|
45
|
+
PASSWORD?: string | Resolver<string>;
|
|
46
|
+
HEADERS?: Headers | Resolver<Headers>;
|
|
47
|
+
ENCODE_PATH?: (path: string) => string;
|
|
48
|
+
};
|
|
49
|
+
declare const OpenAPI: OpenAPIConfig;
|
|
50
|
+
|
|
51
|
+
declare abstract class BaseHttpRequest {
|
|
52
|
+
readonly config: OpenAPIConfig;
|
|
53
|
+
constructor(config: OpenAPIConfig);
|
|
54
|
+
abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
declare class DefaultService {
|
|
58
|
+
readonly httpRequest: BaseHttpRequest;
|
|
59
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
60
|
+
/**
|
|
61
|
+
* @returns any
|
|
62
|
+
* @throws ApiError
|
|
20
63
|
*/
|
|
64
|
+
mediaControllerUploadImage(): CancelablePromise<any>;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
/**
|
|
68
|
+
* ISO 4217 currency code.
|
|
69
|
+
*/
|
|
70
|
+
declare enum CurrencyCode {
|
|
71
|
+
USD = "usd",
|
|
72
|
+
EUR = "eur",
|
|
73
|
+
AUD = "aud",
|
|
74
|
+
CAD = "cad",
|
|
75
|
+
CHF = "chf",
|
|
76
|
+
CLP = "clp",
|
|
77
|
+
CNY = "cny",
|
|
78
|
+
CZK = "czk",
|
|
79
|
+
DKK = "dkk",
|
|
80
|
+
GBP = "gbp",
|
|
81
|
+
HKD = "hkd",
|
|
82
|
+
HUF = "huf",
|
|
83
|
+
JPY = "jpy",
|
|
84
|
+
NZD = "nzd"
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
type Money = {
|
|
21
88
|
currencyCode: CurrencyCode;
|
|
22
89
|
/**
|
|
23
90
|
* Monetary value in base 10 decimals.
|
|
24
|
-
* @example 42.42
|
|
25
91
|
*/
|
|
26
92
|
value: number;
|
|
27
|
-
}
|
|
28
|
-
|
|
93
|
+
};
|
|
94
|
+
|
|
95
|
+
type NativeTokenBalance = {
|
|
96
|
+
/**
|
|
97
|
+
* The contract name.
|
|
98
|
+
*/
|
|
29
99
|
name: string;
|
|
100
|
+
/**
|
|
101
|
+
* The contract symbol.
|
|
102
|
+
*/
|
|
30
103
|
symbol: string;
|
|
104
|
+
/**
|
|
105
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
106
|
+
*/
|
|
31
107
|
decimals: number;
|
|
108
|
+
/**
|
|
109
|
+
* The logo uri for the address.
|
|
110
|
+
*/
|
|
32
111
|
logoUri?: string;
|
|
112
|
+
/**
|
|
113
|
+
* The evm chain id.
|
|
114
|
+
*/
|
|
33
115
|
chainId: string;
|
|
116
|
+
/**
|
|
117
|
+
* The token price, if available.
|
|
118
|
+
*/
|
|
34
119
|
price?: Money;
|
|
120
|
+
/**
|
|
121
|
+
* The address balance for the token, in units specified by the `decimals` value for the contract.
|
|
122
|
+
*/
|
|
35
123
|
balance: string;
|
|
124
|
+
/**
|
|
125
|
+
* The monetary value of the balance, if a price is available for the token.
|
|
126
|
+
*/
|
|
36
127
|
balanceValue?: Money;
|
|
37
|
-
}
|
|
38
|
-
|
|
128
|
+
};
|
|
129
|
+
|
|
130
|
+
type GetNativeBalanceResponse = {
|
|
131
|
+
/**
|
|
132
|
+
* The native token balance for the address.
|
|
133
|
+
*/
|
|
39
134
|
nativeTokenBalance: NativeTokenBalance;
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
decimals: number;
|
|
47
|
-
logoUri?: string;
|
|
48
|
-
price?: Money;
|
|
49
|
-
chainId: string;
|
|
50
|
-
balance: string;
|
|
51
|
-
balanceValue?: Money;
|
|
52
|
-
}
|
|
53
|
-
interface Erc20Balances {
|
|
54
|
-
/** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
|
|
55
|
-
nextPageToken?: string;
|
|
56
|
-
erc20TokenBalances: Erc20TokenBalance[];
|
|
57
|
-
}
|
|
58
|
-
declare enum Erc721MetadataStatus {
|
|
135
|
+
};
|
|
136
|
+
|
|
137
|
+
/**
|
|
138
|
+
* The metadata indexing status of the nft.
|
|
139
|
+
*/
|
|
140
|
+
declare enum NftTokenMetadataStatus {
|
|
59
141
|
UNKNOWN = "UNKNOWN",
|
|
60
142
|
MISSING_TOKEN = "MISSING_TOKEN",
|
|
61
143
|
INVALID_TOKEN_URI = "INVALID_TOKEN_URI",
|
|
@@ -68,12 +150,47 @@ declare enum Erc721MetadataStatus {
|
|
|
68
150
|
INDEXED = "INDEXED",
|
|
69
151
|
UNINDEXED = "UNINDEXED"
|
|
70
152
|
}
|
|
71
|
-
|
|
153
|
+
|
|
154
|
+
type Erc1155TokenMetadata = {
|
|
155
|
+
indexStatus: NftTokenMetadataStatus;
|
|
156
|
+
metadataLastUpdatedTimestamp?: number;
|
|
157
|
+
name?: string;
|
|
158
|
+
symbol?: string;
|
|
159
|
+
imageUri?: string;
|
|
160
|
+
description?: string;
|
|
161
|
+
animationUri?: string;
|
|
162
|
+
externalUrl?: string;
|
|
163
|
+
background?: string;
|
|
164
|
+
decimals?: number;
|
|
165
|
+
properties?: string;
|
|
166
|
+
};
|
|
167
|
+
|
|
168
|
+
type Erc1155TokenBalance = {
|
|
169
|
+
/**
|
|
170
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
171
|
+
*/
|
|
172
|
+
address: string;
|
|
173
|
+
ercType: Erc1155TokenBalance.ercType;
|
|
174
|
+
tokenId: string;
|
|
175
|
+
tokenUri: string;
|
|
176
|
+
metadata: Erc1155TokenMetadata;
|
|
177
|
+
/**
|
|
178
|
+
* The evm chain id.
|
|
179
|
+
*/
|
|
180
|
+
chainId: string;
|
|
72
181
|
/**
|
|
73
|
-
* The
|
|
74
|
-
* @example indexed
|
|
182
|
+
* The address balance for the token, in units specified by the `decimals` value for the contract.
|
|
75
183
|
*/
|
|
76
|
-
|
|
184
|
+
balance: string;
|
|
185
|
+
};
|
|
186
|
+
declare namespace Erc1155TokenBalance {
|
|
187
|
+
enum ercType {
|
|
188
|
+
ERC_1155 = "ERC-1155"
|
|
189
|
+
}
|
|
190
|
+
}
|
|
191
|
+
|
|
192
|
+
type Erc721TokenMetadata = {
|
|
193
|
+
indexStatus: NftTokenMetadataStatus;
|
|
77
194
|
metadataLastUpdatedTimestamp?: number;
|
|
78
195
|
name?: string;
|
|
79
196
|
symbol?: string;
|
|
@@ -83,409 +200,4465 @@ interface Erc721Metadata {
|
|
|
83
200
|
externalUrl?: string;
|
|
84
201
|
background?: string;
|
|
85
202
|
attributes?: string;
|
|
86
|
-
}
|
|
87
|
-
|
|
88
|
-
|
|
203
|
+
};
|
|
204
|
+
|
|
205
|
+
type Erc721TokenBalance = {
|
|
206
|
+
/**
|
|
207
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
208
|
+
*/
|
|
89
209
|
address: string;
|
|
210
|
+
/**
|
|
211
|
+
* The contract name.
|
|
212
|
+
*/
|
|
90
213
|
name: string;
|
|
214
|
+
/**
|
|
215
|
+
* The contract symbol.
|
|
216
|
+
*/
|
|
91
217
|
symbol: string;
|
|
218
|
+
ercType: Erc721TokenBalance.ercType;
|
|
92
219
|
tokenId: string;
|
|
93
220
|
tokenUri: string;
|
|
94
|
-
metadata:
|
|
221
|
+
metadata: Erc721TokenMetadata;
|
|
222
|
+
/**
|
|
223
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
224
|
+
*/
|
|
225
|
+
ownerAddress?: string;
|
|
226
|
+
/**
|
|
227
|
+
* The evm chain id.
|
|
228
|
+
*/
|
|
229
|
+
chainId: string;
|
|
230
|
+
};
|
|
231
|
+
declare namespace Erc721TokenBalance {
|
|
232
|
+
enum ercType {
|
|
233
|
+
ERC_721 = "ERC-721"
|
|
234
|
+
}
|
|
235
|
+
}
|
|
236
|
+
|
|
237
|
+
type ListCollectibleBalancesResponse = {
|
|
238
|
+
/**
|
|
239
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
240
|
+
*/
|
|
241
|
+
nextPageToken?: string;
|
|
242
|
+
/**
|
|
243
|
+
* The list of ERC-721 and ERC-1155 token balances for the address.
|
|
244
|
+
*/
|
|
245
|
+
collectibleBalances: Array<(Erc721TokenBalance | Erc1155TokenBalance)>;
|
|
246
|
+
};
|
|
247
|
+
|
|
248
|
+
type ListErc1155BalancesResponse = {
|
|
249
|
+
/**
|
|
250
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
251
|
+
*/
|
|
252
|
+
nextPageToken?: string;
|
|
253
|
+
/**
|
|
254
|
+
* The list of ERC-1155 token balances for the address.
|
|
255
|
+
*/
|
|
256
|
+
erc1155TokenBalances: Array<Erc1155TokenBalance>;
|
|
257
|
+
};
|
|
258
|
+
|
|
259
|
+
type Erc20TokenBalance = {
|
|
260
|
+
/**
|
|
261
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
262
|
+
*/
|
|
263
|
+
address: string;
|
|
264
|
+
/**
|
|
265
|
+
* The contract name.
|
|
266
|
+
*/
|
|
267
|
+
name: string;
|
|
268
|
+
/**
|
|
269
|
+
* The contract symbol.
|
|
270
|
+
*/
|
|
271
|
+
symbol: string;
|
|
272
|
+
/**
|
|
273
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
274
|
+
*/
|
|
275
|
+
decimals: number;
|
|
276
|
+
/**
|
|
277
|
+
* The logo uri for the address.
|
|
278
|
+
*/
|
|
279
|
+
logoUri?: string;
|
|
280
|
+
ercType: Erc20TokenBalance.ercType;
|
|
281
|
+
/**
|
|
282
|
+
* The token price, if available.
|
|
283
|
+
*/
|
|
284
|
+
price?: Money;
|
|
285
|
+
/**
|
|
286
|
+
* The evm chain id.
|
|
287
|
+
*/
|
|
95
288
|
chainId: string;
|
|
289
|
+
/**
|
|
290
|
+
* The address balance for the token, in units specified by the `decimals` value for the contract.
|
|
291
|
+
*/
|
|
292
|
+
balance: string;
|
|
293
|
+
/**
|
|
294
|
+
* The monetary value of the balance, if a price is available for the token.
|
|
295
|
+
*/
|
|
296
|
+
balanceValue?: Money;
|
|
297
|
+
};
|
|
298
|
+
declare namespace Erc20TokenBalance {
|
|
299
|
+
enum ercType {
|
|
300
|
+
ERC_20 = "ERC-20"
|
|
301
|
+
}
|
|
96
302
|
}
|
|
97
|
-
|
|
98
|
-
|
|
303
|
+
|
|
304
|
+
type ListErc20BalancesResponse = {
|
|
305
|
+
/**
|
|
306
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
307
|
+
*/
|
|
99
308
|
nextPageToken?: string;
|
|
100
|
-
|
|
309
|
+
/**
|
|
310
|
+
* The list of ERC-20 token balances for the address.
|
|
311
|
+
*/
|
|
312
|
+
erc20TokenBalances: Array<Erc20TokenBalance>;
|
|
313
|
+
};
|
|
314
|
+
|
|
315
|
+
type ListErc721BalancesResponse = {
|
|
316
|
+
/**
|
|
317
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
318
|
+
*/
|
|
319
|
+
nextPageToken?: string;
|
|
320
|
+
/**
|
|
321
|
+
* The list of ERC-721 token balances for the address.
|
|
322
|
+
*/
|
|
323
|
+
erc721TokenBalances: Array<Erc721TokenBalance>;
|
|
324
|
+
};
|
|
325
|
+
|
|
326
|
+
declare class EvmBalancesService {
|
|
327
|
+
readonly httpRequest: BaseHttpRequest;
|
|
328
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
329
|
+
/**
|
|
330
|
+
* Get native token balance
|
|
331
|
+
* Gets native token balance of a wallet address.
|
|
332
|
+
*
|
|
333
|
+
* Balance at a given block can be retrieved with the `blockNumber` parameter.
|
|
334
|
+
* @returns GetNativeBalanceResponse
|
|
335
|
+
* @throws ApiError
|
|
336
|
+
*/
|
|
337
|
+
getNativeBalance({ chainId, address, blockNumber, currency, }: {
|
|
338
|
+
/**
|
|
339
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
340
|
+
*/
|
|
341
|
+
chainId: string;
|
|
342
|
+
/**
|
|
343
|
+
* A wallet address.
|
|
344
|
+
*/
|
|
345
|
+
address: string;
|
|
346
|
+
/**
|
|
347
|
+
* The block number, if not defined the block number will be the latest block.
|
|
348
|
+
*/
|
|
349
|
+
blockNumber?: string;
|
|
350
|
+
/**
|
|
351
|
+
* The currency that return values should use. Defaults to USD.
|
|
352
|
+
*/
|
|
353
|
+
currency?: CurrencyCode;
|
|
354
|
+
}): CancelablePromise<GetNativeBalanceResponse>;
|
|
355
|
+
/**
|
|
356
|
+
* List ERC-20 balances
|
|
357
|
+
* Lists ERC-20 token balances of a wallet address.
|
|
358
|
+
*
|
|
359
|
+
* Balance at a given block can be retrieved with the `blockNumber` parameter.
|
|
360
|
+
*
|
|
361
|
+
* Balance for specific contracts can be retrieved with the `contractAddresses` parameter.
|
|
362
|
+
* @returns ListErc20BalancesResponse
|
|
363
|
+
* @throws ApiError
|
|
364
|
+
*/
|
|
365
|
+
listErc20Balances({ chainId, address, blockNumber, pageToken, pageSize, filterSpamTokens, contractAddresses, currency, }: {
|
|
366
|
+
/**
|
|
367
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
368
|
+
*/
|
|
369
|
+
chainId: string;
|
|
370
|
+
/**
|
|
371
|
+
* A wallet address.
|
|
372
|
+
*/
|
|
373
|
+
address: string;
|
|
374
|
+
/**
|
|
375
|
+
* The block number, if not defined the block number will be the latest block.
|
|
376
|
+
*/
|
|
377
|
+
blockNumber?: string;
|
|
378
|
+
/**
|
|
379
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
380
|
+
*/
|
|
381
|
+
pageToken?: string;
|
|
382
|
+
/**
|
|
383
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
384
|
+
*/
|
|
385
|
+
pageSize?: number;
|
|
386
|
+
/**
|
|
387
|
+
* whether to filter out spam tokens from the response. Default is true.
|
|
388
|
+
*/
|
|
389
|
+
filterSpamTokens?: boolean;
|
|
390
|
+
/**
|
|
391
|
+
* A comma separated list of contract addresses to filter by.
|
|
392
|
+
*/
|
|
393
|
+
contractAddresses?: string;
|
|
394
|
+
/**
|
|
395
|
+
* The currency that return values should use. Defaults to USD.
|
|
396
|
+
*/
|
|
397
|
+
currency?: CurrencyCode;
|
|
398
|
+
}): CancelablePromise<ListErc20BalancesResponse>;
|
|
399
|
+
/**
|
|
400
|
+
* List ERC-721 balances
|
|
401
|
+
* Lists ERC-721 token balances of a wallet address.
|
|
402
|
+
*
|
|
403
|
+
* Balance for a specific contract can be retrieved with the `contractAddress` parameter.
|
|
404
|
+
* @returns ListErc721BalancesResponse
|
|
405
|
+
* @throws ApiError
|
|
406
|
+
*/
|
|
407
|
+
listErc721Balances({ chainId, address, pageToken, pageSize, contractAddress, }: {
|
|
408
|
+
/**
|
|
409
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
410
|
+
*/
|
|
411
|
+
chainId: string;
|
|
412
|
+
/**
|
|
413
|
+
* A wallet address.
|
|
414
|
+
*/
|
|
415
|
+
address: string;
|
|
416
|
+
/**
|
|
417
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
418
|
+
*/
|
|
419
|
+
pageToken?: string;
|
|
420
|
+
/**
|
|
421
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
422
|
+
*/
|
|
423
|
+
pageSize?: number;
|
|
424
|
+
/**
|
|
425
|
+
* A contract addresses to filter by.
|
|
426
|
+
*/
|
|
427
|
+
contractAddress?: string;
|
|
428
|
+
}): CancelablePromise<ListErc721BalancesResponse>;
|
|
429
|
+
/**
|
|
430
|
+
* List ERC-1155 balances
|
|
431
|
+
* Lists ERC-1155 token balances of a wallet address.
|
|
432
|
+
*
|
|
433
|
+
* Balance at a given block can be retrieved with the `blockNumber` parameter.
|
|
434
|
+
*
|
|
435
|
+
* Balance for a specific contract can be retrieved with the `contractAddress` parameter.
|
|
436
|
+
* @returns ListErc1155BalancesResponse
|
|
437
|
+
* @throws ApiError
|
|
438
|
+
*/
|
|
439
|
+
listErc1155Balances({ chainId, address, blockNumber, pageToken, pageSize, contractAddress, }: {
|
|
440
|
+
/**
|
|
441
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
442
|
+
*/
|
|
443
|
+
chainId: string;
|
|
444
|
+
/**
|
|
445
|
+
* A wallet address.
|
|
446
|
+
*/
|
|
447
|
+
address: string;
|
|
448
|
+
/**
|
|
449
|
+
* The block number, if not defined the block number will be the latest block.
|
|
450
|
+
*/
|
|
451
|
+
blockNumber?: string;
|
|
452
|
+
/**
|
|
453
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
454
|
+
*/
|
|
455
|
+
pageToken?: string;
|
|
456
|
+
/**
|
|
457
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
458
|
+
*/
|
|
459
|
+
pageSize?: number;
|
|
460
|
+
/**
|
|
461
|
+
* A contract addresses to filter by.
|
|
462
|
+
*/
|
|
463
|
+
contractAddress?: string;
|
|
464
|
+
}): CancelablePromise<ListErc1155BalancesResponse>;
|
|
465
|
+
/**
|
|
466
|
+
* List collectible (ERC-721/ERC-1155) balances
|
|
467
|
+
* Lists ERC-721 and ERC-1155 token balances of a wallet address.
|
|
468
|
+
*
|
|
469
|
+
* Balance for a specific contract can be retrieved with the `contractAddress` parameter.
|
|
470
|
+
* @returns ListCollectibleBalancesResponse
|
|
471
|
+
* @throws ApiError
|
|
472
|
+
*/
|
|
473
|
+
listCollectibleBalances({ chainId, address, pageToken, pageSize, contractAddress, }: {
|
|
474
|
+
/**
|
|
475
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
476
|
+
*/
|
|
477
|
+
chainId: string;
|
|
478
|
+
/**
|
|
479
|
+
* A wallet address.
|
|
480
|
+
*/
|
|
481
|
+
address: string;
|
|
482
|
+
/**
|
|
483
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
484
|
+
*/
|
|
485
|
+
pageToken?: string;
|
|
486
|
+
/**
|
|
487
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
488
|
+
*/
|
|
489
|
+
pageSize?: number;
|
|
490
|
+
/**
|
|
491
|
+
* A contract addresses to filter by.
|
|
492
|
+
*/
|
|
493
|
+
contractAddress?: string;
|
|
494
|
+
}): CancelablePromise<ListCollectibleBalancesResponse>;
|
|
101
495
|
}
|
|
102
|
-
|
|
496
|
+
|
|
497
|
+
type GetEvmBlockResponse = {
|
|
103
498
|
/**
|
|
104
499
|
* The block number on the chain.
|
|
105
|
-
* @example 339
|
|
106
500
|
*/
|
|
107
501
|
blockNumber: string;
|
|
108
502
|
/**
|
|
109
503
|
* The block finality timestamp.
|
|
110
|
-
* @example 1648672486
|
|
111
504
|
*/
|
|
112
505
|
blockTimestamp: number;
|
|
113
506
|
/**
|
|
114
507
|
* The block hash identifier.
|
|
115
|
-
* @example 0x17533aeb5193378b9ff441d61728e7a2ebaf10f61fd5310759451627dfca2e7c
|
|
116
508
|
*/
|
|
117
509
|
blockHash: string;
|
|
118
|
-
/**
|
|
510
|
+
/**
|
|
511
|
+
* The number of evm transactions in the block.
|
|
512
|
+
*/
|
|
119
513
|
txCount: number;
|
|
120
|
-
/**
|
|
514
|
+
/**
|
|
515
|
+
* The base gas fee for a transaction to be included in the block.
|
|
516
|
+
*/
|
|
121
517
|
baseFee: string;
|
|
122
|
-
/**
|
|
518
|
+
/**
|
|
519
|
+
* The gas used for transactions in the block.
|
|
520
|
+
*/
|
|
123
521
|
gasUsed: string;
|
|
124
|
-
/**
|
|
522
|
+
/**
|
|
523
|
+
* The total gas limit set for transactions in the block.
|
|
524
|
+
*/
|
|
125
525
|
gasLimit: string;
|
|
126
526
|
gasCost: string;
|
|
127
|
-
/**
|
|
527
|
+
/**
|
|
528
|
+
* The hash of the parent block.
|
|
529
|
+
*/
|
|
128
530
|
parentHash: string;
|
|
129
|
-
/** The amount of fees spent/burned for transactions in the block. */
|
|
130
|
-
feesSpent: string;
|
|
131
|
-
/** The cumulative number of transactions for the chain including this block. */
|
|
132
|
-
cumulativeTransactions: string;
|
|
133
|
-
}
|
|
134
|
-
interface ListBlocks {
|
|
135
|
-
/** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
|
|
136
|
-
nextPageToken?: string;
|
|
137
|
-
blocks: Block[];
|
|
138
|
-
}
|
|
139
|
-
interface ListTransfers {
|
|
140
|
-
/** A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages. */
|
|
141
|
-
nextPageToken?: string;
|
|
142
|
-
transfers: Erc20Transfer[] | Erc721Transfer[];
|
|
143
|
-
}
|
|
144
|
-
interface RichAddress {
|
|
145
|
-
name?: string;
|
|
146
|
-
symbol?: string;
|
|
147
|
-
decimals?: number;
|
|
148
|
-
logoUri?: string;
|
|
149
|
-
/** @example 0x71C7656EC7ab88b098defB751B7401B5f6d8976F */
|
|
150
|
-
address: string;
|
|
151
|
-
}
|
|
152
|
-
interface Method {
|
|
153
531
|
/**
|
|
154
|
-
* The
|
|
155
|
-
* @example 0xa9059cbb
|
|
532
|
+
* The amount of fees spent/burned for transactions in the block.
|
|
156
533
|
*/
|
|
157
|
-
|
|
534
|
+
feesSpent: string;
|
|
158
535
|
/**
|
|
159
|
-
* The
|
|
160
|
-
* @example transfer(address,uint256)
|
|
536
|
+
* The cumulative number of transactions for the chain including this block.
|
|
161
537
|
*/
|
|
162
|
-
|
|
163
|
-
}
|
|
164
|
-
|
|
538
|
+
cumulativeTransactions: string;
|
|
539
|
+
};
|
|
540
|
+
|
|
541
|
+
type EvmBlock = {
|
|
165
542
|
/**
|
|
166
543
|
* The block number on the chain.
|
|
167
|
-
* @example 339
|
|
168
544
|
*/
|
|
169
545
|
blockNumber: string;
|
|
170
546
|
/**
|
|
171
547
|
* The block finality timestamp.
|
|
172
|
-
* @example 1648672486
|
|
173
548
|
*/
|
|
174
549
|
blockTimestamp: number;
|
|
175
550
|
/**
|
|
176
551
|
* The block hash identifier.
|
|
177
|
-
* @example 0x17533aeb5193378b9ff441d61728e7a2ebaf10f61fd5310759451627dfca2e7c
|
|
178
552
|
*/
|
|
179
553
|
blockHash: string;
|
|
180
554
|
/**
|
|
181
|
-
* The
|
|
182
|
-
* @example 0
|
|
555
|
+
* The number of evm transactions in the block.
|
|
183
556
|
*/
|
|
184
|
-
|
|
557
|
+
txCount: number;
|
|
185
558
|
/**
|
|
186
|
-
* The transaction
|
|
187
|
-
* @example 0x3e9303f81be00b4af28515dab7b914bf3dbff209ea10e7071fa24d4af0a112d4
|
|
559
|
+
* The base gas fee for a transaction to be included in the block.
|
|
188
560
|
*/
|
|
189
|
-
|
|
561
|
+
baseFee: string;
|
|
190
562
|
/**
|
|
191
|
-
* The
|
|
192
|
-
* @example 1
|
|
563
|
+
* The gas used for transactions in the block.
|
|
193
564
|
*/
|
|
194
|
-
|
|
565
|
+
gasUsed: string;
|
|
195
566
|
/**
|
|
196
|
-
* The
|
|
197
|
-
* @example 1
|
|
567
|
+
* The total gas limit set for transactions in the block.
|
|
198
568
|
*/
|
|
199
|
-
|
|
569
|
+
gasLimit: string;
|
|
570
|
+
gasCost: string;
|
|
200
571
|
/**
|
|
201
|
-
* The
|
|
202
|
-
* @example 51373
|
|
572
|
+
* The hash of the parent block.
|
|
203
573
|
*/
|
|
204
|
-
|
|
574
|
+
parentHash: string;
|
|
205
575
|
/**
|
|
206
|
-
* The amount of
|
|
207
|
-
* @example 51373
|
|
576
|
+
* The amount of fees spent/burned for transactions in the block.
|
|
208
577
|
*/
|
|
209
|
-
|
|
578
|
+
feesSpent: string;
|
|
210
579
|
/**
|
|
211
|
-
* The
|
|
212
|
-
* @example 470000000000
|
|
580
|
+
* The cumulative number of transactions for the chain including this block.
|
|
213
581
|
*/
|
|
214
|
-
|
|
582
|
+
cumulativeTransactions: string;
|
|
583
|
+
};
|
|
584
|
+
|
|
585
|
+
type ListEvmBlocksResponse = {
|
|
215
586
|
/**
|
|
216
|
-
*
|
|
217
|
-
* @example 1
|
|
587
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
218
588
|
*/
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
589
|
+
nextPageToken?: string;
|
|
590
|
+
blocks: Array<EvmBlock>;
|
|
591
|
+
};
|
|
592
|
+
|
|
593
|
+
declare class EvmBlocksService {
|
|
594
|
+
readonly httpRequest: BaseHttpRequest;
|
|
595
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
596
|
+
/**
|
|
597
|
+
* List latest blocks
|
|
598
|
+
* Lists the latest indexed blocks on the EVM-compatible chain sorted in descending order by block timestamp.
|
|
599
|
+
* @returns ListEvmBlocksResponse
|
|
600
|
+
* @throws ApiError
|
|
601
|
+
*/
|
|
602
|
+
getLatestBlocks({ chainId, pageToken, pageSize, }: {
|
|
603
|
+
/**
|
|
604
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
605
|
+
*/
|
|
606
|
+
chainId: string;
|
|
607
|
+
/**
|
|
608
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
609
|
+
*/
|
|
610
|
+
pageToken?: string;
|
|
611
|
+
/**
|
|
612
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
613
|
+
*/
|
|
614
|
+
pageSize?: number;
|
|
615
|
+
}): CancelablePromise<ListEvmBlocksResponse>;
|
|
616
|
+
/**
|
|
617
|
+
* Get block
|
|
618
|
+
* Gets the details of an individual block on the EVM-compatible chain.
|
|
619
|
+
* @returns GetEvmBlockResponse
|
|
620
|
+
* @throws ApiError
|
|
621
|
+
*/
|
|
622
|
+
getBlock({ chainId, blockId, }: {
|
|
623
|
+
/**
|
|
624
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
625
|
+
*/
|
|
626
|
+
chainId: string;
|
|
627
|
+
/**
|
|
628
|
+
* A block identifier which is either a block number or the block hash.
|
|
629
|
+
*/
|
|
630
|
+
blockId: string;
|
|
631
|
+
}): CancelablePromise<GetEvmBlockResponse>;
|
|
225
632
|
}
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
633
|
+
|
|
634
|
+
/**
|
|
635
|
+
* Status of chain nodes. Chain nodes can become temporarily `UNAVAILABLE` for several reasons, such as validator stake falling below threshold. If chain nodes are `UNAVAILABLE`, requests that rely on data from the chain nodes may return 503 errors.
|
|
636
|
+
*/
|
|
637
|
+
declare enum ChainStatus {
|
|
638
|
+
OK = "OK",
|
|
639
|
+
UNAVAILABLE = "UNAVAILABLE"
|
|
640
|
+
}
|
|
641
|
+
|
|
642
|
+
type NetworkToken = {
|
|
643
|
+
/**
|
|
644
|
+
* The contract name.
|
|
645
|
+
*/
|
|
229
646
|
name: string;
|
|
647
|
+
/**
|
|
648
|
+
* The contract symbol.
|
|
649
|
+
*/
|
|
230
650
|
symbol: string;
|
|
651
|
+
/**
|
|
652
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
653
|
+
*/
|
|
231
654
|
decimals: number;
|
|
655
|
+
/**
|
|
656
|
+
* The logo uri for the address.
|
|
657
|
+
*/
|
|
232
658
|
logoUri?: string;
|
|
233
|
-
|
|
659
|
+
description?: string;
|
|
660
|
+
};
|
|
661
|
+
|
|
662
|
+
type UtilityAddresses = {
|
|
663
|
+
multicall?: string;
|
|
664
|
+
};
|
|
665
|
+
|
|
666
|
+
declare enum VmName {
|
|
667
|
+
EVM = "EVM",
|
|
668
|
+
BITCOIN = "BITCOIN",
|
|
669
|
+
ETHEREUM = "ETHEREUM"
|
|
234
670
|
}
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
671
|
+
|
|
672
|
+
type GetChainResponse = {
|
|
673
|
+
chainId: string;
|
|
674
|
+
status: ChainStatus;
|
|
675
|
+
chainName: string;
|
|
676
|
+
description: string;
|
|
677
|
+
platformChainId?: string;
|
|
678
|
+
subnetId?: string;
|
|
679
|
+
vmId?: string;
|
|
680
|
+
vmName: VmName;
|
|
681
|
+
explorerUrl?: string;
|
|
682
|
+
rpcUrl: string;
|
|
683
|
+
wsUrl?: string;
|
|
684
|
+
isTestnet: boolean;
|
|
685
|
+
utilityAddresses?: UtilityAddresses;
|
|
686
|
+
networkToken: NetworkToken;
|
|
687
|
+
chainLogoUri?: string;
|
|
688
|
+
private?: boolean;
|
|
689
|
+
enabledFeatures?: Array<'nftIndexing' | 'webhooks'>;
|
|
690
|
+
};
|
|
691
|
+
|
|
692
|
+
declare enum GlacierApiFeature {
|
|
693
|
+
NFT_INDEXING = "nftIndexing",
|
|
694
|
+
WEBHOOKS = "webhooks"
|
|
241
695
|
}
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
696
|
+
|
|
697
|
+
type ChainInfo = {
|
|
698
|
+
chainId: string;
|
|
699
|
+
status: ChainStatus;
|
|
700
|
+
chainName: string;
|
|
701
|
+
description: string;
|
|
702
|
+
platformChainId?: string;
|
|
703
|
+
subnetId?: string;
|
|
704
|
+
vmId?: string;
|
|
705
|
+
vmName: VmName;
|
|
706
|
+
explorerUrl?: string;
|
|
707
|
+
rpcUrl: string;
|
|
708
|
+
wsUrl?: string;
|
|
709
|
+
isTestnet: boolean;
|
|
710
|
+
utilityAddresses?: UtilityAddresses;
|
|
711
|
+
networkToken: NetworkToken;
|
|
712
|
+
chainLogoUri?: string;
|
|
713
|
+
private?: boolean;
|
|
714
|
+
enabledFeatures?: Array<'nftIndexing' | 'webhooks'>;
|
|
715
|
+
};
|
|
716
|
+
|
|
717
|
+
type ListChainsResponse = {
|
|
718
|
+
chains: Array<ChainInfo>;
|
|
719
|
+
};
|
|
720
|
+
|
|
721
|
+
declare enum NetworkType {
|
|
722
|
+
MAINNET = "mainnet",
|
|
723
|
+
TESTNET = "testnet"
|
|
724
|
+
}
|
|
725
|
+
|
|
726
|
+
declare class EvmChainsService {
|
|
727
|
+
readonly httpRequest: BaseHttpRequest;
|
|
728
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
729
|
+
/**
|
|
730
|
+
* List chains
|
|
731
|
+
* Lists the supported EVM-compatible chains. Filterable by network.
|
|
732
|
+
* @returns ListChainsResponse
|
|
733
|
+
* @throws ApiError
|
|
734
|
+
*/
|
|
735
|
+
supportedChains({ network, feature, }: {
|
|
736
|
+
/**
|
|
737
|
+
* mainnet or testnet.
|
|
738
|
+
*/
|
|
739
|
+
network?: NetworkType;
|
|
740
|
+
/**
|
|
741
|
+
* Filter by feature.
|
|
742
|
+
*/
|
|
743
|
+
feature?: GlacierApiFeature;
|
|
744
|
+
}): CancelablePromise<ListChainsResponse>;
|
|
745
|
+
/**
|
|
746
|
+
* Get chain information
|
|
747
|
+
* Gets chain information for the EVM-compatible chain if supported by the api.
|
|
748
|
+
* @returns GetChainResponse
|
|
749
|
+
* @throws ApiError
|
|
750
|
+
*/
|
|
751
|
+
getChainInfo({ chainId, }: {
|
|
752
|
+
/**
|
|
753
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
754
|
+
*/
|
|
755
|
+
chainId: string;
|
|
756
|
+
}): CancelablePromise<GetChainResponse>;
|
|
757
|
+
}
|
|
758
|
+
|
|
759
|
+
type ImageAsset = {
|
|
760
|
+
assetId?: string;
|
|
761
|
+
/**
|
|
762
|
+
* OUTPUT ONLY
|
|
763
|
+
*/
|
|
764
|
+
imageUri?: string;
|
|
765
|
+
};
|
|
766
|
+
|
|
767
|
+
type PricingProviders = {
|
|
768
|
+
coingeckoCoinId?: string;
|
|
769
|
+
};
|
|
770
|
+
|
|
771
|
+
declare enum ResourceLinkType {
|
|
772
|
+
BLOG = "Blog",
|
|
773
|
+
COIN_GECKO = "CoinGecko",
|
|
774
|
+
COIN_MARKET_CAP = "CoinMarketCap",
|
|
775
|
+
DISCORD = "Discord",
|
|
776
|
+
DOCUMENTATION = "Documentation",
|
|
777
|
+
FACEBOOK = "Facebook",
|
|
778
|
+
GITHUB = "Github",
|
|
779
|
+
INSTAGRAM = "Instagram",
|
|
780
|
+
LINKED_IN = "LinkedIn",
|
|
781
|
+
MEDIUM = "Medium",
|
|
782
|
+
REDDIT = "Reddit",
|
|
783
|
+
SUPPORT = "Support",
|
|
784
|
+
TELEGRAM = "Telegram",
|
|
785
|
+
TIK_TOK = "TikTok",
|
|
786
|
+
TWITTER = "Twitter",
|
|
787
|
+
WEBSITE = "Website",
|
|
788
|
+
WHITEPAPER = "Whitepaper",
|
|
789
|
+
YOUTUBE = "Youtube"
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
type ResourceLink = {
|
|
793
|
+
type: ResourceLinkType;
|
|
794
|
+
url: string;
|
|
795
|
+
};
|
|
796
|
+
|
|
797
|
+
type ContractSubmissionErc1155 = {
|
|
798
|
+
description?: string;
|
|
799
|
+
officialSite?: string;
|
|
800
|
+
email?: string;
|
|
801
|
+
logoAsset?: ImageAsset;
|
|
802
|
+
bannerAsset?: ImageAsset;
|
|
803
|
+
color?: string;
|
|
804
|
+
resourceLinks?: Array<ResourceLink>;
|
|
805
|
+
tags?: Array<string>;
|
|
806
|
+
/**
|
|
807
|
+
* The contract name.
|
|
808
|
+
*/
|
|
809
|
+
name: string;
|
|
810
|
+
ercType: ContractSubmissionErc1155.ercType;
|
|
811
|
+
/**
|
|
812
|
+
* The contract symbol.
|
|
813
|
+
*/
|
|
814
|
+
symbol: string;
|
|
815
|
+
pricingProviders?: PricingProviders;
|
|
816
|
+
};
|
|
817
|
+
declare namespace ContractSubmissionErc1155 {
|
|
818
|
+
enum ercType {
|
|
819
|
+
ERC_1155 = "ERC-1155"
|
|
820
|
+
}
|
|
821
|
+
}
|
|
822
|
+
|
|
823
|
+
type ContractSubmissionErc20 = {
|
|
824
|
+
description?: string;
|
|
825
|
+
officialSite?: string;
|
|
826
|
+
email?: string;
|
|
827
|
+
logoAsset?: ImageAsset;
|
|
828
|
+
bannerAsset?: ImageAsset;
|
|
829
|
+
color?: string;
|
|
830
|
+
resourceLinks?: Array<ResourceLink>;
|
|
831
|
+
tags?: Array<string>;
|
|
832
|
+
/**
|
|
833
|
+
* The contract name.
|
|
834
|
+
*/
|
|
835
|
+
name: string;
|
|
836
|
+
ercType: ContractSubmissionErc20.ercType;
|
|
837
|
+
/**
|
|
838
|
+
* The contract symbol.
|
|
839
|
+
*/
|
|
840
|
+
symbol: string;
|
|
841
|
+
pricingProviders?: PricingProviders;
|
|
842
|
+
};
|
|
843
|
+
declare namespace ContractSubmissionErc20 {
|
|
844
|
+
enum ercType {
|
|
845
|
+
ERC_20 = "ERC-20"
|
|
846
|
+
}
|
|
847
|
+
}
|
|
848
|
+
|
|
849
|
+
type ContractSubmissionErc721 = {
|
|
850
|
+
description?: string;
|
|
851
|
+
officialSite?: string;
|
|
852
|
+
email?: string;
|
|
853
|
+
logoAsset?: ImageAsset;
|
|
854
|
+
bannerAsset?: ImageAsset;
|
|
855
|
+
color?: string;
|
|
856
|
+
resourceLinks?: Array<ResourceLink>;
|
|
857
|
+
tags?: Array<string>;
|
|
858
|
+
/**
|
|
859
|
+
* The contract name.
|
|
860
|
+
*/
|
|
245
861
|
name: string;
|
|
862
|
+
ercType: ContractSubmissionErc721.ercType;
|
|
863
|
+
/**
|
|
864
|
+
* The contract symbol.
|
|
865
|
+
*/
|
|
246
866
|
symbol: string;
|
|
867
|
+
};
|
|
868
|
+
declare namespace ContractSubmissionErc721 {
|
|
869
|
+
enum ercType {
|
|
870
|
+
ERC_721 = "ERC-721"
|
|
871
|
+
}
|
|
872
|
+
}
|
|
873
|
+
|
|
874
|
+
type ContractSubmissionUnknown = {
|
|
875
|
+
description?: string;
|
|
876
|
+
officialSite?: string;
|
|
877
|
+
email?: string;
|
|
878
|
+
logoAsset?: ImageAsset;
|
|
879
|
+
bannerAsset?: ImageAsset;
|
|
880
|
+
color?: string;
|
|
881
|
+
resourceLinks?: Array<ResourceLink>;
|
|
882
|
+
tags?: Array<string>;
|
|
883
|
+
/**
|
|
884
|
+
* The contract name.
|
|
885
|
+
*/
|
|
886
|
+
name: string;
|
|
887
|
+
ercType: ContractSubmissionUnknown.ercType;
|
|
888
|
+
};
|
|
889
|
+
declare namespace ContractSubmissionUnknown {
|
|
890
|
+
enum ercType {
|
|
891
|
+
UNKNOWN = "UNKNOWN"
|
|
892
|
+
}
|
|
893
|
+
}
|
|
894
|
+
|
|
895
|
+
type ContractSubmissionBody = {
|
|
896
|
+
contract: (ContractSubmissionErc1155 | ContractSubmissionErc20 | ContractSubmissionErc721 | ContractSubmissionUnknown);
|
|
897
|
+
};
|
|
898
|
+
|
|
899
|
+
type ContractDeploymentDetails = {
|
|
900
|
+
txHash: string;
|
|
901
|
+
/**
|
|
902
|
+
* The address that initiated the transaction which deployed this contract.
|
|
903
|
+
*/
|
|
904
|
+
deployerAddress: string;
|
|
905
|
+
/**
|
|
906
|
+
* The contract address which deployed this contract via smart contract. This field is only populated when the contract was deployed as part of smart contract execution.
|
|
907
|
+
*/
|
|
908
|
+
deployerContractAddress?: string;
|
|
909
|
+
};
|
|
910
|
+
|
|
911
|
+
type Erc1155Contract = {
|
|
912
|
+
/**
|
|
913
|
+
* The contract name.
|
|
914
|
+
*/
|
|
915
|
+
name?: string;
|
|
916
|
+
description?: string;
|
|
917
|
+
officialSite?: string;
|
|
918
|
+
email?: string;
|
|
919
|
+
logoAsset?: ImageAsset;
|
|
920
|
+
bannerAsset?: ImageAsset;
|
|
921
|
+
color?: string;
|
|
922
|
+
resourceLinks?: Array<ResourceLink>;
|
|
923
|
+
tags?: Array<string>;
|
|
924
|
+
/**
|
|
925
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
926
|
+
*/
|
|
927
|
+
address: string;
|
|
928
|
+
deploymentDetails: ContractDeploymentDetails;
|
|
929
|
+
ercType: Erc1155Contract.ercType;
|
|
930
|
+
/**
|
|
931
|
+
* The contract symbol.
|
|
932
|
+
*/
|
|
933
|
+
symbol?: string;
|
|
934
|
+
pricingProviders?: PricingProviders;
|
|
935
|
+
};
|
|
936
|
+
declare namespace Erc1155Contract {
|
|
937
|
+
enum ercType {
|
|
938
|
+
ERC_1155 = "ERC-1155"
|
|
939
|
+
}
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
type Erc20Contract = {
|
|
943
|
+
/**
|
|
944
|
+
* The contract name.
|
|
945
|
+
*/
|
|
946
|
+
name?: string;
|
|
947
|
+
description?: string;
|
|
948
|
+
officialSite?: string;
|
|
949
|
+
email?: string;
|
|
950
|
+
logoAsset?: ImageAsset;
|
|
951
|
+
bannerAsset?: ImageAsset;
|
|
952
|
+
color?: string;
|
|
953
|
+
resourceLinks?: Array<ResourceLink>;
|
|
954
|
+
tags?: Array<string>;
|
|
955
|
+
/**
|
|
956
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
957
|
+
*/
|
|
958
|
+
address: string;
|
|
959
|
+
deploymentDetails: ContractDeploymentDetails;
|
|
960
|
+
ercType: Erc20Contract.ercType;
|
|
961
|
+
/**
|
|
962
|
+
* The contract symbol.
|
|
963
|
+
*/
|
|
964
|
+
symbol?: string;
|
|
965
|
+
/**
|
|
966
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
967
|
+
*/
|
|
968
|
+
decimals: number;
|
|
969
|
+
pricingProviders?: PricingProviders;
|
|
970
|
+
};
|
|
971
|
+
declare namespace Erc20Contract {
|
|
972
|
+
enum ercType {
|
|
973
|
+
ERC_20 = "ERC-20"
|
|
974
|
+
}
|
|
975
|
+
}
|
|
976
|
+
|
|
977
|
+
type Erc721Contract = {
|
|
978
|
+
/**
|
|
979
|
+
* The contract name.
|
|
980
|
+
*/
|
|
981
|
+
name?: string;
|
|
982
|
+
description?: string;
|
|
983
|
+
officialSite?: string;
|
|
984
|
+
email?: string;
|
|
985
|
+
logoAsset?: ImageAsset;
|
|
986
|
+
bannerAsset?: ImageAsset;
|
|
987
|
+
color?: string;
|
|
988
|
+
resourceLinks?: Array<ResourceLink>;
|
|
989
|
+
tags?: Array<string>;
|
|
990
|
+
/**
|
|
991
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
992
|
+
*/
|
|
993
|
+
address: string;
|
|
994
|
+
deploymentDetails: ContractDeploymentDetails;
|
|
995
|
+
ercType: Erc721Contract.ercType;
|
|
996
|
+
/**
|
|
997
|
+
* The contract symbol.
|
|
998
|
+
*/
|
|
999
|
+
symbol?: string;
|
|
1000
|
+
};
|
|
1001
|
+
declare namespace Erc721Contract {
|
|
1002
|
+
enum ercType {
|
|
1003
|
+
ERC_721 = "ERC-721"
|
|
1004
|
+
}
|
|
1005
|
+
}
|
|
1006
|
+
|
|
1007
|
+
type UnknownContract = {
|
|
1008
|
+
/**
|
|
1009
|
+
* The contract name.
|
|
1010
|
+
*/
|
|
1011
|
+
name?: string;
|
|
1012
|
+
description?: string;
|
|
1013
|
+
officialSite?: string;
|
|
1014
|
+
email?: string;
|
|
1015
|
+
logoAsset?: ImageAsset;
|
|
1016
|
+
bannerAsset?: ImageAsset;
|
|
1017
|
+
color?: string;
|
|
1018
|
+
resourceLinks?: Array<ResourceLink>;
|
|
1019
|
+
tags?: Array<string>;
|
|
1020
|
+
/**
|
|
1021
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
1022
|
+
*/
|
|
1023
|
+
address: string;
|
|
1024
|
+
deploymentDetails: ContractDeploymentDetails;
|
|
1025
|
+
ercType: UnknownContract.ercType;
|
|
1026
|
+
};
|
|
1027
|
+
declare namespace UnknownContract {
|
|
1028
|
+
enum ercType {
|
|
1029
|
+
UNKNOWN = "UNKNOWN"
|
|
1030
|
+
}
|
|
1031
|
+
}
|
|
1032
|
+
|
|
1033
|
+
type UpdateContractResponse = {
|
|
1034
|
+
contract: (UnknownContract | Erc20Contract | Erc721Contract | Erc1155Contract);
|
|
1035
|
+
};
|
|
1036
|
+
|
|
1037
|
+
declare class EvmContractsService {
|
|
1038
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1039
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1040
|
+
/**
|
|
1041
|
+
* Get contract metadata
|
|
1042
|
+
* Gets metadata about the contract at the given address.
|
|
1043
|
+
* @returns any
|
|
1044
|
+
* @throws ApiError
|
|
1045
|
+
*/
|
|
1046
|
+
getContractMetadata({ chainId, address, }: {
|
|
1047
|
+
/**
|
|
1048
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1049
|
+
*/
|
|
1050
|
+
chainId: string;
|
|
1051
|
+
/**
|
|
1052
|
+
* Contract address on the relevant chain.
|
|
1053
|
+
*/
|
|
1054
|
+
address: string;
|
|
1055
|
+
}): CancelablePromise<(Erc721Contract | Erc1155Contract | Erc20Contract | UnknownContract)>;
|
|
1056
|
+
/**
|
|
1057
|
+
* Update contract information
|
|
1058
|
+
* Update contract information. Updates will be reviewed by the Ava Labs team before they are published.
|
|
1059
|
+
* @returns UpdateContractResponse
|
|
1060
|
+
* @throws ApiError
|
|
1061
|
+
*/
|
|
1062
|
+
updateContractInfo({ chainId, address, requestBody, }: {
|
|
1063
|
+
/**
|
|
1064
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1065
|
+
*/
|
|
1066
|
+
chainId: string;
|
|
1067
|
+
/**
|
|
1068
|
+
* Contract address on the relevant chain.
|
|
1069
|
+
*/
|
|
1070
|
+
address: string;
|
|
1071
|
+
requestBody: ContractSubmissionBody;
|
|
1072
|
+
}): CancelablePromise<UpdateContractResponse>;
|
|
1073
|
+
}
|
|
1074
|
+
|
|
1075
|
+
type Erc1155Token = {
|
|
1076
|
+
/**
|
|
1077
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
1078
|
+
*/
|
|
1079
|
+
address: string;
|
|
1080
|
+
ercType: Erc1155Token.ercType;
|
|
247
1081
|
tokenId: string;
|
|
248
1082
|
tokenUri: string;
|
|
249
|
-
metadata:
|
|
1083
|
+
metadata: Erc1155TokenMetadata;
|
|
1084
|
+
};
|
|
1085
|
+
declare namespace Erc1155Token {
|
|
1086
|
+
enum ercType {
|
|
1087
|
+
ERC_1155 = "ERC-1155"
|
|
1088
|
+
}
|
|
250
1089
|
}
|
|
251
|
-
|
|
1090
|
+
|
|
1091
|
+
type RichAddress = {
|
|
1092
|
+
/**
|
|
1093
|
+
* The contract name.
|
|
1094
|
+
*/
|
|
1095
|
+
name?: string;
|
|
1096
|
+
/**
|
|
1097
|
+
* The contract symbol.
|
|
1098
|
+
*/
|
|
1099
|
+
symbol?: string;
|
|
1100
|
+
/**
|
|
1101
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
1102
|
+
*/
|
|
1103
|
+
decimals?: number;
|
|
1104
|
+
/**
|
|
1105
|
+
* The logo uri for the address.
|
|
1106
|
+
*/
|
|
1107
|
+
logoUri?: string;
|
|
1108
|
+
/**
|
|
1109
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
1110
|
+
*/
|
|
1111
|
+
address: string;
|
|
1112
|
+
};
|
|
1113
|
+
|
|
1114
|
+
type Erc1155TransferDetails = {
|
|
252
1115
|
from: RichAddress;
|
|
253
1116
|
to: RichAddress;
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
1117
|
+
logIndex: number;
|
|
1118
|
+
value: string;
|
|
1119
|
+
erc1155Token: Erc1155Token;
|
|
1120
|
+
};
|
|
1121
|
+
|
|
1122
|
+
type Erc20Token = {
|
|
1123
|
+
/**
|
|
1124
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
1125
|
+
*/
|
|
1126
|
+
address: string;
|
|
1127
|
+
/**
|
|
1128
|
+
* The contract name.
|
|
1129
|
+
*/
|
|
1130
|
+
name: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* The contract symbol.
|
|
1133
|
+
*/
|
|
1134
|
+
symbol: string;
|
|
1135
|
+
/**
|
|
1136
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
1137
|
+
*/
|
|
1138
|
+
decimals: number;
|
|
1139
|
+
/**
|
|
1140
|
+
* The logo uri for the address.
|
|
1141
|
+
*/
|
|
1142
|
+
logoUri?: string;
|
|
1143
|
+
ercType: Erc20Token.ercType;
|
|
1144
|
+
/**
|
|
1145
|
+
* The token price, if available.
|
|
1146
|
+
*/
|
|
1147
|
+
price?: Money;
|
|
1148
|
+
};
|
|
1149
|
+
declare namespace Erc20Token {
|
|
1150
|
+
enum ercType {
|
|
1151
|
+
ERC_20 = "ERC-20"
|
|
1152
|
+
}
|
|
264
1153
|
}
|
|
265
|
-
|
|
1154
|
+
|
|
1155
|
+
type Erc20TransferDetails = {
|
|
266
1156
|
from: RichAddress;
|
|
267
1157
|
to: RichAddress;
|
|
268
|
-
|
|
269
|
-
/** @example 10000000000000000000 */
|
|
1158
|
+
logIndex: number;
|
|
270
1159
|
value: string;
|
|
271
|
-
|
|
1160
|
+
erc20Token: Erc20Token;
|
|
1161
|
+
};
|
|
1162
|
+
|
|
1163
|
+
type Erc721Token = {
|
|
1164
|
+
/**
|
|
1165
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
1166
|
+
*/
|
|
1167
|
+
address: string;
|
|
1168
|
+
/**
|
|
1169
|
+
* The contract name.
|
|
1170
|
+
*/
|
|
1171
|
+
name: string;
|
|
1172
|
+
/**
|
|
1173
|
+
* The contract symbol.
|
|
1174
|
+
*/
|
|
1175
|
+
symbol: string;
|
|
1176
|
+
ercType: Erc721Token.ercType;
|
|
1177
|
+
tokenId: string;
|
|
1178
|
+
tokenUri: string;
|
|
1179
|
+
metadata: Erc721TokenMetadata;
|
|
1180
|
+
/**
|
|
1181
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
1182
|
+
*/
|
|
1183
|
+
ownerAddress?: string;
|
|
1184
|
+
};
|
|
1185
|
+
declare namespace Erc721Token {
|
|
1186
|
+
enum ercType {
|
|
1187
|
+
ERC_721 = "ERC-721"
|
|
1188
|
+
}
|
|
1189
|
+
}
|
|
1190
|
+
|
|
1191
|
+
type Erc721TransferDetails = {
|
|
1192
|
+
from: RichAddress;
|
|
1193
|
+
to: RichAddress;
|
|
1194
|
+
logIndex: number;
|
|
1195
|
+
erc721Token: Erc721Token;
|
|
1196
|
+
};
|
|
1197
|
+
|
|
1198
|
+
/**
|
|
1199
|
+
* The contract call type. NATIVE_TRANSFER indicates a transfer of the native token without any smart-contract interaction. CONTRACT_CALL indicates a smart-contract interaction. CONTRACT_CREATION indicates a smart-contract creation.
|
|
1200
|
+
*/
|
|
1201
|
+
declare enum TransactionMethodType {
|
|
1202
|
+
NATIVE_TRANSFER = "NATIVE_TRANSFER",
|
|
1203
|
+
CONTRACT_CALL = "CONTRACT_CALL",
|
|
1204
|
+
CONTRACT_CREATION = "CONTRACT_CREATION"
|
|
1205
|
+
}
|
|
1206
|
+
|
|
1207
|
+
type Method = {
|
|
1208
|
+
callType: TransactionMethodType;
|
|
1209
|
+
/**
|
|
1210
|
+
* The contract method hash identifier. The method hash is only set if the `callType` is `CONTRACT_CALL`.
|
|
1211
|
+
*/
|
|
1212
|
+
methodHash: string;
|
|
1213
|
+
/**
|
|
1214
|
+
* The contract method name including parameter types. If the `callType` is `NATIVE_TRANSFER` this is set to 'Native Transfer'. If the `callType` is `CONTRACT_CREATION` this is set to 'Contract Created'.
|
|
1215
|
+
*/
|
|
1216
|
+
methodName?: string;
|
|
1217
|
+
};
|
|
1218
|
+
|
|
1219
|
+
type FullNativeTransactionDetails = {
|
|
1220
|
+
/**
|
|
1221
|
+
* The block number on the chain.
|
|
1222
|
+
*/
|
|
1223
|
+
blockNumber: string;
|
|
1224
|
+
/**
|
|
1225
|
+
* The block finality timestamp.
|
|
1226
|
+
*/
|
|
1227
|
+
blockTimestamp: number;
|
|
1228
|
+
/**
|
|
1229
|
+
* The block hash identifier.
|
|
1230
|
+
*/
|
|
1231
|
+
blockHash: string;
|
|
1232
|
+
/**
|
|
1233
|
+
* The index at which the transaction occured in the block (0-indexed).
|
|
1234
|
+
*/
|
|
1235
|
+
blockIndex: number;
|
|
1236
|
+
/**
|
|
1237
|
+
* The transaction hash identifier.
|
|
1238
|
+
*/
|
|
1239
|
+
txHash: string;
|
|
1240
|
+
/**
|
|
1241
|
+
* The transaction status, which is either 0 (failed) or 1 (successful).
|
|
1242
|
+
*/
|
|
1243
|
+
txStatus: string;
|
|
1244
|
+
/**
|
|
1245
|
+
* The transaction type.
|
|
1246
|
+
*/
|
|
1247
|
+
txType: number;
|
|
1248
|
+
/**
|
|
1249
|
+
* The gas limit set for the transaction.
|
|
1250
|
+
*/
|
|
1251
|
+
gasLimit: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* The amount of gas used.
|
|
1254
|
+
*/
|
|
1255
|
+
gasUsed: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* The gas price denominated by the number of decimals of the native token.
|
|
1258
|
+
*/
|
|
1259
|
+
gasPrice: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* The nonce used by the sender of the transaction.
|
|
1262
|
+
*/
|
|
1263
|
+
nonce: string;
|
|
1264
|
+
from: RichAddress;
|
|
1265
|
+
to: RichAddress;
|
|
1266
|
+
method?: Method;
|
|
1267
|
+
value: string;
|
|
1268
|
+
/**
|
|
1269
|
+
* The data sent for the transaction.
|
|
1270
|
+
*/
|
|
1271
|
+
input: string;
|
|
1272
|
+
baseFeePerGas: string;
|
|
1273
|
+
maxFeePerGas?: string;
|
|
1274
|
+
maxPriorityFeePerGas?: string;
|
|
1275
|
+
};
|
|
1276
|
+
|
|
1277
|
+
declare enum InternalTransactionOpCall {
|
|
1278
|
+
UNKNOWN = "UNKNOWN",
|
|
1279
|
+
CALL = "CALL",
|
|
1280
|
+
CREATE = "CREATE",
|
|
1281
|
+
CREATE2 = "CREATE2",
|
|
1282
|
+
CALLCODE = "CALLCODE",
|
|
1283
|
+
DELEGATECALL = "DELEGATECALL",
|
|
1284
|
+
STATICCALL = "STATICCALL"
|
|
1285
|
+
}
|
|
1286
|
+
|
|
1287
|
+
type InternalTransactionDetails = {
|
|
1288
|
+
from: RichAddress;
|
|
1289
|
+
to: RichAddress;
|
|
1290
|
+
internalTxType: InternalTransactionOpCall;
|
|
1291
|
+
value: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* True if the internal transaction was reverted.
|
|
1294
|
+
*/
|
|
1295
|
+
isReverted: boolean;
|
|
1296
|
+
gasUsed: string;
|
|
1297
|
+
gasLimit: string;
|
|
1298
|
+
};
|
|
1299
|
+
|
|
1300
|
+
type NetworkTokenDetails = {
|
|
1301
|
+
networkToken: NetworkToken;
|
|
1302
|
+
/**
|
|
1303
|
+
* The current token price, if available.
|
|
1304
|
+
*/
|
|
1305
|
+
currentPrice?: Money;
|
|
1306
|
+
/**
|
|
1307
|
+
* The historical token price at the time the transaction occured, if available. Note, this is only provided if the transaction occured more than 24 hours ago.
|
|
1308
|
+
*/
|
|
1309
|
+
historicalPrice?: Money;
|
|
1310
|
+
};
|
|
1311
|
+
|
|
1312
|
+
type GetTransactionResponse = {
|
|
1313
|
+
/**
|
|
1314
|
+
* The list of ERC-20 transfers.
|
|
1315
|
+
*/
|
|
1316
|
+
erc20Transfers?: Array<Erc20TransferDetails>;
|
|
1317
|
+
/**
|
|
1318
|
+
* The list of ERC-721 transfers.
|
|
1319
|
+
*/
|
|
1320
|
+
erc721Transfers?: Array<Erc721TransferDetails>;
|
|
1321
|
+
/**
|
|
1322
|
+
* The list of ERC-1155 transfers.
|
|
1323
|
+
*/
|
|
1324
|
+
erc1155Transfers?: Array<Erc1155TransferDetails>;
|
|
1325
|
+
/**
|
|
1326
|
+
* The list of internal transactions. Note that this list only includes CALL and CALLCODE internal transactions that had a non-zero value and CREATE/CREATE2 calls. Use a client provider to recieve a full debug trace of the transaction.
|
|
1327
|
+
*/
|
|
1328
|
+
internalTransactions?: Array<InternalTransactionDetails>;
|
|
1329
|
+
networkTokenDetails: NetworkTokenDetails;
|
|
1330
|
+
nativeTransaction: FullNativeTransactionDetails;
|
|
1331
|
+
};
|
|
1332
|
+
|
|
1333
|
+
type ListContractsResponse = {
|
|
1334
|
+
/**
|
|
1335
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1336
|
+
*/
|
|
1337
|
+
nextPageToken?: string;
|
|
1338
|
+
contracts: Array<(Erc721Contract | Erc1155Contract | Erc20Contract | UnknownContract)>;
|
|
1339
|
+
};
|
|
1340
|
+
|
|
1341
|
+
type Erc1155Transfer = {
|
|
1342
|
+
/**
|
|
1343
|
+
* The block number on the chain.
|
|
1344
|
+
*/
|
|
1345
|
+
blockNumber: string;
|
|
1346
|
+
/**
|
|
1347
|
+
* The block finality timestamp.
|
|
1348
|
+
*/
|
|
1349
|
+
blockTimestamp: number;
|
|
1350
|
+
/**
|
|
1351
|
+
* The block hash identifier.
|
|
1352
|
+
*/
|
|
1353
|
+
blockHash: string;
|
|
1354
|
+
/**
|
|
1355
|
+
* The transaction hash identifier.
|
|
1356
|
+
*/
|
|
1357
|
+
txHash: string;
|
|
1358
|
+
from: RichAddress;
|
|
1359
|
+
to: RichAddress;
|
|
1360
|
+
logIndex: number;
|
|
1361
|
+
value: string;
|
|
1362
|
+
erc1155Token: Erc1155Token;
|
|
1363
|
+
};
|
|
1364
|
+
|
|
1365
|
+
type ListErc1155TransactionsResponse = {
|
|
1366
|
+
/**
|
|
1367
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1368
|
+
*/
|
|
1369
|
+
nextPageToken?: string;
|
|
1370
|
+
transactions: Array<Erc1155Transfer>;
|
|
1371
|
+
};
|
|
1372
|
+
|
|
1373
|
+
type Erc20Transfer = {
|
|
1374
|
+
/**
|
|
1375
|
+
* The block number on the chain.
|
|
1376
|
+
*/
|
|
1377
|
+
blockNumber: string;
|
|
1378
|
+
/**
|
|
1379
|
+
* The block finality timestamp.
|
|
1380
|
+
*/
|
|
1381
|
+
blockTimestamp: number;
|
|
1382
|
+
/**
|
|
1383
|
+
* The block hash identifier.
|
|
1384
|
+
*/
|
|
1385
|
+
blockHash: string;
|
|
1386
|
+
/**
|
|
1387
|
+
* The transaction hash identifier.
|
|
1388
|
+
*/
|
|
1389
|
+
txHash: string;
|
|
1390
|
+
from: RichAddress;
|
|
1391
|
+
to: RichAddress;
|
|
1392
|
+
logIndex: number;
|
|
1393
|
+
value: string;
|
|
1394
|
+
erc20Token: Erc20Token;
|
|
1395
|
+
};
|
|
1396
|
+
|
|
1397
|
+
type ListErc20TransactionsResponse = {
|
|
1398
|
+
/**
|
|
1399
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1400
|
+
*/
|
|
1401
|
+
nextPageToken?: string;
|
|
1402
|
+
transactions: Array<Erc20Transfer>;
|
|
1403
|
+
};
|
|
1404
|
+
|
|
1405
|
+
type Erc721Transfer = {
|
|
1406
|
+
/**
|
|
1407
|
+
* The block number on the chain.
|
|
1408
|
+
*/
|
|
1409
|
+
blockNumber: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* The block finality timestamp.
|
|
1412
|
+
*/
|
|
1413
|
+
blockTimestamp: number;
|
|
1414
|
+
/**
|
|
1415
|
+
* The block hash identifier.
|
|
1416
|
+
*/
|
|
1417
|
+
blockHash: string;
|
|
1418
|
+
/**
|
|
1419
|
+
* The transaction hash identifier.
|
|
1420
|
+
*/
|
|
1421
|
+
txHash: string;
|
|
1422
|
+
from: RichAddress;
|
|
1423
|
+
to: RichAddress;
|
|
1424
|
+
logIndex: number;
|
|
1425
|
+
erc721Token: Erc721Token;
|
|
1426
|
+
};
|
|
1427
|
+
|
|
1428
|
+
type ListErc721TransactionsResponse = {
|
|
1429
|
+
/**
|
|
1430
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1431
|
+
*/
|
|
1432
|
+
nextPageToken?: string;
|
|
1433
|
+
transactions: Array<Erc721Transfer>;
|
|
1434
|
+
};
|
|
1435
|
+
|
|
1436
|
+
type InternalTransaction = {
|
|
1437
|
+
/**
|
|
1438
|
+
* The block number on the chain.
|
|
1439
|
+
*/
|
|
1440
|
+
blockNumber: string;
|
|
1441
|
+
/**
|
|
1442
|
+
* The block finality timestamp.
|
|
1443
|
+
*/
|
|
1444
|
+
blockTimestamp: number;
|
|
1445
|
+
/**
|
|
1446
|
+
* The block hash identifier.
|
|
1447
|
+
*/
|
|
1448
|
+
blockHash: string;
|
|
1449
|
+
/**
|
|
1450
|
+
* The transaction hash identifier.
|
|
1451
|
+
*/
|
|
1452
|
+
txHash: string;
|
|
1453
|
+
from: RichAddress;
|
|
1454
|
+
to: RichAddress;
|
|
1455
|
+
internalTxType: InternalTransactionOpCall;
|
|
1456
|
+
value: string;
|
|
1457
|
+
/**
|
|
1458
|
+
* True if the internal transaction was reverted.
|
|
1459
|
+
*/
|
|
1460
|
+
isReverted: boolean;
|
|
1461
|
+
gasUsed: string;
|
|
1462
|
+
gasLimit: string;
|
|
1463
|
+
};
|
|
1464
|
+
|
|
1465
|
+
type ListInternalTransactionsResponse = {
|
|
1466
|
+
/**
|
|
1467
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1468
|
+
*/
|
|
1469
|
+
nextPageToken?: string;
|
|
1470
|
+
transactions: Array<InternalTransaction>;
|
|
1471
|
+
};
|
|
1472
|
+
|
|
1473
|
+
type NativeTransaction = {
|
|
1474
|
+
/**
|
|
1475
|
+
* The block number on the chain.
|
|
1476
|
+
*/
|
|
1477
|
+
blockNumber: string;
|
|
1478
|
+
/**
|
|
1479
|
+
* The block finality timestamp.
|
|
1480
|
+
*/
|
|
1481
|
+
blockTimestamp: number;
|
|
1482
|
+
/**
|
|
1483
|
+
* The block hash identifier.
|
|
1484
|
+
*/
|
|
1485
|
+
blockHash: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* The index at which the transaction occured in the block (0-indexed).
|
|
1488
|
+
*/
|
|
1489
|
+
blockIndex: number;
|
|
1490
|
+
/**
|
|
1491
|
+
* The transaction hash identifier.
|
|
1492
|
+
*/
|
|
1493
|
+
txHash: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* The transaction status, which is either 0 (failed) or 1 (successful).
|
|
1496
|
+
*/
|
|
1497
|
+
txStatus: string;
|
|
1498
|
+
/**
|
|
1499
|
+
* The transaction type.
|
|
1500
|
+
*/
|
|
1501
|
+
txType: number;
|
|
1502
|
+
/**
|
|
1503
|
+
* The gas limit set for the transaction.
|
|
1504
|
+
*/
|
|
1505
|
+
gasLimit: string;
|
|
1506
|
+
/**
|
|
1507
|
+
* The amount of gas used.
|
|
1508
|
+
*/
|
|
1509
|
+
gasUsed: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* The gas price denominated by the number of decimals of the native token.
|
|
1512
|
+
*/
|
|
1513
|
+
gasPrice: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* The nonce used by the sender of the transaction.
|
|
1516
|
+
*/
|
|
1517
|
+
nonce: string;
|
|
1518
|
+
from: RichAddress;
|
|
1519
|
+
to: RichAddress;
|
|
1520
|
+
method?: Method;
|
|
1521
|
+
value: string;
|
|
1522
|
+
};
|
|
1523
|
+
|
|
1524
|
+
type ListNativeTransactionsResponse = {
|
|
1525
|
+
/**
|
|
1526
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1527
|
+
*/
|
|
1528
|
+
nextPageToken?: string;
|
|
1529
|
+
transactions: Array<NativeTransaction>;
|
|
1530
|
+
};
|
|
1531
|
+
|
|
1532
|
+
type TransactionDetails = {
|
|
1533
|
+
/**
|
|
1534
|
+
* The native (top-level) transaction details.
|
|
1535
|
+
*/
|
|
1536
|
+
nativeTransaction: NativeTransaction;
|
|
1537
|
+
/**
|
|
1538
|
+
* The list of ERC-20 transfers.
|
|
1539
|
+
*/
|
|
1540
|
+
erc20Transfers?: Array<Erc20TransferDetails>;
|
|
1541
|
+
/**
|
|
1542
|
+
* The list of ERC-721 transfers.
|
|
1543
|
+
*/
|
|
1544
|
+
erc721Transfers?: Array<Erc721TransferDetails>;
|
|
1545
|
+
/**
|
|
1546
|
+
* The list of ERC-1155 transfers.
|
|
1547
|
+
*/
|
|
1548
|
+
erc1155Transfers?: Array<Erc1155TransferDetails>;
|
|
1549
|
+
/**
|
|
1550
|
+
* The list of internal transactions. Note that this list only includes CALL and CALLCODE internal transactions that had a non-zero value and CREATE/CREATE2 calls. Use a client provider to recieve a full debug trace of the transaction.
|
|
1551
|
+
*/
|
|
1552
|
+
internalTransactions?: Array<InternalTransactionDetails>;
|
|
1553
|
+
};
|
|
1554
|
+
|
|
1555
|
+
type ListTransactionDetailsResponse = {
|
|
1556
|
+
/**
|
|
1557
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1558
|
+
*/
|
|
1559
|
+
nextPageToken?: string;
|
|
1560
|
+
transactions: Array<TransactionDetails>;
|
|
1561
|
+
};
|
|
1562
|
+
|
|
1563
|
+
type ListTransfersResponse = {
|
|
1564
|
+
/**
|
|
1565
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1566
|
+
*/
|
|
1567
|
+
nextPageToken?: string;
|
|
1568
|
+
transfers: Array<(Erc20Transfer | Erc721Transfer | Erc1155Transfer)>;
|
|
1569
|
+
};
|
|
1570
|
+
|
|
1571
|
+
declare enum SortOrder {
|
|
1572
|
+
ASC = "asc",
|
|
1573
|
+
DESC = "desc"
|
|
1574
|
+
}
|
|
1575
|
+
|
|
1576
|
+
declare enum TransactionStatus {
|
|
1577
|
+
FAILED = "failed",
|
|
1578
|
+
SUCCESS = "success"
|
|
1579
|
+
}
|
|
1580
|
+
|
|
1581
|
+
declare class EvmTransactionsService {
|
|
1582
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1583
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1584
|
+
/**
|
|
1585
|
+
* Get deployment transaction
|
|
1586
|
+
* If the address is a smart contract, returns the transaction in which it was deployed.
|
|
1587
|
+
* @returns GetTransactionResponse
|
|
1588
|
+
* @throws ApiError
|
|
1589
|
+
*/
|
|
1590
|
+
getDeploymentTransaction({ chainId, address, currency, }: {
|
|
1591
|
+
/**
|
|
1592
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1593
|
+
*/
|
|
1594
|
+
chainId: string;
|
|
1595
|
+
/**
|
|
1596
|
+
* Contract address on the relevant chain.
|
|
1597
|
+
*/
|
|
1598
|
+
address: string;
|
|
1599
|
+
/**
|
|
1600
|
+
* The currency that return values should use. Defaults to USD.
|
|
1601
|
+
*/
|
|
1602
|
+
currency?: CurrencyCode;
|
|
1603
|
+
}): CancelablePromise<GetTransactionResponse>;
|
|
1604
|
+
/**
|
|
1605
|
+
* List deployed contracts
|
|
1606
|
+
* Lists all contracts deployed by the given address.
|
|
1607
|
+
* @returns ListContractsResponse
|
|
1608
|
+
* @throws ApiError
|
|
1609
|
+
*/
|
|
1610
|
+
listContractDeployments({ chainId, address, pageToken, pageSize, }: {
|
|
1611
|
+
/**
|
|
1612
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1613
|
+
*/
|
|
1614
|
+
chainId: string;
|
|
1615
|
+
/**
|
|
1616
|
+
* A wallet address.
|
|
1617
|
+
*/
|
|
1618
|
+
address: string;
|
|
1619
|
+
/**
|
|
1620
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1621
|
+
*/
|
|
1622
|
+
pageToken?: string;
|
|
1623
|
+
/**
|
|
1624
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1625
|
+
*/
|
|
1626
|
+
pageSize?: number;
|
|
1627
|
+
}): CancelablePromise<ListContractsResponse>;
|
|
1628
|
+
/**
|
|
1629
|
+
* List ERC transfers
|
|
1630
|
+
* Lists ERC transfers for an ERC-20, ERC-721, or ERC-1155 contract address.
|
|
1631
|
+
* @returns ListTransfersResponse
|
|
1632
|
+
* @throws ApiError
|
|
1633
|
+
*/
|
|
1634
|
+
listTransfers({ chainId, address, startBlock, endBlock, pageToken, pageSize, }: {
|
|
1635
|
+
/**
|
|
1636
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1637
|
+
*/
|
|
1638
|
+
chainId: string;
|
|
1639
|
+
/**
|
|
1640
|
+
* A wallet address.
|
|
1641
|
+
*/
|
|
1642
|
+
address: string;
|
|
1643
|
+
/**
|
|
1644
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1645
|
+
*/
|
|
1646
|
+
startBlock?: number;
|
|
1647
|
+
/**
|
|
1648
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1649
|
+
*/
|
|
1650
|
+
endBlock?: number;
|
|
1651
|
+
/**
|
|
1652
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1653
|
+
*/
|
|
1654
|
+
pageToken?: string;
|
|
1655
|
+
/**
|
|
1656
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1657
|
+
*/
|
|
1658
|
+
pageSize?: number;
|
|
1659
|
+
}): CancelablePromise<ListTransfersResponse>;
|
|
1660
|
+
/**
|
|
1661
|
+
* List transactions
|
|
1662
|
+
* 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.
|
|
1663
|
+
*
|
|
1664
|
+
* Filterable by block ranges.
|
|
1665
|
+
* @returns ListTransactionDetailsResponse
|
|
1666
|
+
* @throws ApiError
|
|
1667
|
+
*/
|
|
1668
|
+
listTransactions({ chainId, address, pageToken, pageSize, startBlock, endBlock, sortOrder, }: {
|
|
1669
|
+
/**
|
|
1670
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1671
|
+
*/
|
|
1672
|
+
chainId: string;
|
|
1673
|
+
/**
|
|
1674
|
+
* A wallet address.
|
|
1675
|
+
*/
|
|
1676
|
+
address: string;
|
|
1677
|
+
/**
|
|
1678
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1679
|
+
*/
|
|
1680
|
+
pageToken?: string;
|
|
1681
|
+
/**
|
|
1682
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1683
|
+
*/
|
|
1684
|
+
pageSize?: number;
|
|
1685
|
+
/**
|
|
1686
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1687
|
+
*/
|
|
1688
|
+
startBlock?: number;
|
|
1689
|
+
/**
|
|
1690
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1691
|
+
*/
|
|
1692
|
+
endBlock?: number;
|
|
1693
|
+
/**
|
|
1694
|
+
* 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.
|
|
1695
|
+
*/
|
|
1696
|
+
sortOrder?: SortOrder;
|
|
1697
|
+
}): CancelablePromise<ListTransactionDetailsResponse>;
|
|
1698
|
+
/**
|
|
1699
|
+
* List native transactions
|
|
1700
|
+
* Lists native transactions for an address. Filterable by block range.
|
|
1701
|
+
* @returns ListNativeTransactionsResponse
|
|
1702
|
+
* @throws ApiError
|
|
1703
|
+
*/
|
|
1704
|
+
listNativeTransactions({ chainId, address, startBlock, endBlock, pageToken, pageSize, }: {
|
|
1705
|
+
/**
|
|
1706
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1707
|
+
*/
|
|
1708
|
+
chainId: string;
|
|
1709
|
+
/**
|
|
1710
|
+
* A wallet address.
|
|
1711
|
+
*/
|
|
1712
|
+
address: string;
|
|
1713
|
+
/**
|
|
1714
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1715
|
+
*/
|
|
1716
|
+
startBlock?: number;
|
|
1717
|
+
/**
|
|
1718
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1719
|
+
*/
|
|
1720
|
+
endBlock?: number;
|
|
1721
|
+
/**
|
|
1722
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1723
|
+
*/
|
|
1724
|
+
pageToken?: string;
|
|
1725
|
+
/**
|
|
1726
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1727
|
+
*/
|
|
1728
|
+
pageSize?: number;
|
|
1729
|
+
}): CancelablePromise<ListNativeTransactionsResponse>;
|
|
1730
|
+
/**
|
|
1731
|
+
* List ERC-20 transfers
|
|
1732
|
+
* Lists ERC-20 transfers for an address. Filterable by block range.
|
|
1733
|
+
* @returns ListErc20TransactionsResponse
|
|
1734
|
+
* @throws ApiError
|
|
1735
|
+
*/
|
|
1736
|
+
listErc20Transactions({ chainId, address, startBlock, endBlock, pageToken, pageSize, }: {
|
|
1737
|
+
/**
|
|
1738
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1739
|
+
*/
|
|
1740
|
+
chainId: string;
|
|
1741
|
+
/**
|
|
1742
|
+
* A wallet address.
|
|
1743
|
+
*/
|
|
1744
|
+
address: string;
|
|
1745
|
+
/**
|
|
1746
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1747
|
+
*/
|
|
1748
|
+
startBlock?: number;
|
|
1749
|
+
/**
|
|
1750
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1751
|
+
*/
|
|
1752
|
+
endBlock?: number;
|
|
1753
|
+
/**
|
|
1754
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1755
|
+
*/
|
|
1756
|
+
pageToken?: string;
|
|
1757
|
+
/**
|
|
1758
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1759
|
+
*/
|
|
1760
|
+
pageSize?: number;
|
|
1761
|
+
}): CancelablePromise<ListErc20TransactionsResponse>;
|
|
1762
|
+
/**
|
|
1763
|
+
* List ERC-721 transfers
|
|
1764
|
+
* Lists ERC-721 transfers for an address. Filterable by block range.
|
|
1765
|
+
* @returns ListErc721TransactionsResponse
|
|
1766
|
+
* @throws ApiError
|
|
1767
|
+
*/
|
|
1768
|
+
listErc721Transactions({ chainId, address, startBlock, endBlock, pageToken, pageSize, }: {
|
|
1769
|
+
/**
|
|
1770
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1771
|
+
*/
|
|
1772
|
+
chainId: string;
|
|
1773
|
+
/**
|
|
1774
|
+
* A wallet address.
|
|
1775
|
+
*/
|
|
1776
|
+
address: string;
|
|
1777
|
+
/**
|
|
1778
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1779
|
+
*/
|
|
1780
|
+
startBlock?: number;
|
|
1781
|
+
/**
|
|
1782
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1783
|
+
*/
|
|
1784
|
+
endBlock?: number;
|
|
1785
|
+
/**
|
|
1786
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1787
|
+
*/
|
|
1788
|
+
pageToken?: string;
|
|
1789
|
+
/**
|
|
1790
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1791
|
+
*/
|
|
1792
|
+
pageSize?: number;
|
|
1793
|
+
}): CancelablePromise<ListErc721TransactionsResponse>;
|
|
1794
|
+
/**
|
|
1795
|
+
* List ERC-1155 transfers
|
|
1796
|
+
* Lists ERC-1155 transfers for an address. Filterable by block range.
|
|
1797
|
+
* @returns ListErc1155TransactionsResponse
|
|
1798
|
+
* @throws ApiError
|
|
1799
|
+
*/
|
|
1800
|
+
listErc1155Transactions({ chainId, address, startBlock, endBlock, pageToken, pageSize, }: {
|
|
1801
|
+
/**
|
|
1802
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1803
|
+
*/
|
|
1804
|
+
chainId: string;
|
|
1805
|
+
/**
|
|
1806
|
+
* A wallet address.
|
|
1807
|
+
*/
|
|
1808
|
+
address: string;
|
|
1809
|
+
/**
|
|
1810
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1811
|
+
*/
|
|
1812
|
+
startBlock?: number;
|
|
1813
|
+
/**
|
|
1814
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1815
|
+
*/
|
|
1816
|
+
endBlock?: number;
|
|
1817
|
+
/**
|
|
1818
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1819
|
+
*/
|
|
1820
|
+
pageToken?: string;
|
|
1821
|
+
/**
|
|
1822
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1823
|
+
*/
|
|
1824
|
+
pageSize?: number;
|
|
1825
|
+
}): CancelablePromise<ListErc1155TransactionsResponse>;
|
|
1826
|
+
/**
|
|
1827
|
+
* List internal transactions
|
|
1828
|
+
* Returns a list of internal transactions for an address and chain. Filterable by block range.
|
|
1829
|
+
*
|
|
1830
|
+
* 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.
|
|
1831
|
+
* @returns ListInternalTransactionsResponse
|
|
1832
|
+
* @throws ApiError
|
|
1833
|
+
*/
|
|
1834
|
+
listInternalTransactions({ chainId, address, startBlock, endBlock, pageToken, pageSize, }: {
|
|
1835
|
+
/**
|
|
1836
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1837
|
+
*/
|
|
1838
|
+
chainId: string;
|
|
1839
|
+
/**
|
|
1840
|
+
* A wallet address.
|
|
1841
|
+
*/
|
|
1842
|
+
address: string;
|
|
1843
|
+
/**
|
|
1844
|
+
* The block range start number, inclusive. If endBlock is not defined when startBlock is defined, the end of the range will be the most recent block.
|
|
1845
|
+
*/
|
|
1846
|
+
startBlock?: number;
|
|
1847
|
+
/**
|
|
1848
|
+
* The block range end number, exclusive. If startBlock is not defined when endBlock is defined, the start of the range will be the genesis block.
|
|
1849
|
+
*/
|
|
1850
|
+
endBlock?: number;
|
|
1851
|
+
/**
|
|
1852
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1853
|
+
*/
|
|
1854
|
+
pageToken?: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1857
|
+
*/
|
|
1858
|
+
pageSize?: number;
|
|
1859
|
+
}): CancelablePromise<ListInternalTransactionsResponse>;
|
|
1860
|
+
/**
|
|
1861
|
+
* Get transaction
|
|
1862
|
+
* Gets the details of a single transaction.
|
|
1863
|
+
* @returns GetTransactionResponse
|
|
1864
|
+
* @throws ApiError
|
|
1865
|
+
*/
|
|
1866
|
+
getTransaction({ chainId, txHash, }: {
|
|
1867
|
+
/**
|
|
1868
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1869
|
+
*/
|
|
1870
|
+
chainId: string;
|
|
1871
|
+
/**
|
|
1872
|
+
* A transaction hash.
|
|
1873
|
+
*/
|
|
1874
|
+
txHash: string;
|
|
1875
|
+
}): CancelablePromise<GetTransactionResponse>;
|
|
1876
|
+
/**
|
|
1877
|
+
* List transactions for a block
|
|
1878
|
+
* Lists the transactions that occured in a given block.
|
|
1879
|
+
* @returns ListNativeTransactionsResponse
|
|
1880
|
+
* @throws ApiError
|
|
1881
|
+
*/
|
|
1882
|
+
getTransactionsForBlock({ chainId, blockId, }: {
|
|
1883
|
+
/**
|
|
1884
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1885
|
+
*/
|
|
1886
|
+
chainId: string;
|
|
1887
|
+
/**
|
|
1888
|
+
* A block identifier which is either a block number or the block hash.
|
|
1889
|
+
*/
|
|
1890
|
+
blockId: string;
|
|
1891
|
+
}): CancelablePromise<ListNativeTransactionsResponse>;
|
|
1892
|
+
/**
|
|
1893
|
+
* List latest transactions
|
|
1894
|
+
* Lists the latest transactions. Filterable by status.
|
|
1895
|
+
* @returns ListNativeTransactionsResponse
|
|
1896
|
+
* @throws ApiError
|
|
1897
|
+
*/
|
|
1898
|
+
listLatestTransactions({ chainId, pageToken, pageSize, status, }: {
|
|
1899
|
+
/**
|
|
1900
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1901
|
+
*/
|
|
1902
|
+
chainId: string;
|
|
1903
|
+
/**
|
|
1904
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1905
|
+
*/
|
|
1906
|
+
pageToken?: string;
|
|
1907
|
+
/**
|
|
1908
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1909
|
+
*/
|
|
1910
|
+
pageSize?: number;
|
|
1911
|
+
/**
|
|
1912
|
+
* A status filter for listed transactions.
|
|
1913
|
+
*/
|
|
1914
|
+
status?: TransactionStatus;
|
|
1915
|
+
}): CancelablePromise<ListNativeTransactionsResponse>;
|
|
1916
|
+
}
|
|
1917
|
+
|
|
1918
|
+
declare class HealthCheckService {
|
|
1919
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1920
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1921
|
+
/**
|
|
1922
|
+
* Get the health of the service
|
|
1923
|
+
* @returns any The Health Check is successful
|
|
1924
|
+
* @throws ApiError
|
|
1925
|
+
*/
|
|
1926
|
+
healthCheck(): CancelablePromise<{
|
|
1927
|
+
status?: string;
|
|
1928
|
+
info?: Record<string, Record<string, string>> | null;
|
|
1929
|
+
error?: Record<string, Record<string, string>> | null;
|
|
1930
|
+
details?: Record<string, Record<string, string>>;
|
|
1931
|
+
}>;
|
|
1932
|
+
}
|
|
1933
|
+
|
|
1934
|
+
type ListNftTokens = {
|
|
1935
|
+
/**
|
|
1936
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
1937
|
+
*/
|
|
1938
|
+
nextPageToken?: string;
|
|
1939
|
+
tokens: Array<(Erc721Token | Erc1155Token)>;
|
|
1940
|
+
};
|
|
1941
|
+
|
|
1942
|
+
declare class NfTsService {
|
|
1943
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1944
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1945
|
+
/**
|
|
1946
|
+
* Reindex NFT metadata
|
|
1947
|
+
* Triggers reindexing of token metadata for an NFT token. Reindexing can only be called once per hour for each NFT token.
|
|
1948
|
+
* @returns any
|
|
1949
|
+
* @throws ApiError
|
|
1950
|
+
*/
|
|
1951
|
+
reindexNft({ chainId, address, tokenId, }: {
|
|
1952
|
+
/**
|
|
1953
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1954
|
+
*/
|
|
1955
|
+
chainId: string;
|
|
1956
|
+
/**
|
|
1957
|
+
* Contract address on the relevant chain.
|
|
1958
|
+
*/
|
|
1959
|
+
address: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* TokenId on the contract
|
|
1962
|
+
*/
|
|
1963
|
+
tokenId: string;
|
|
1964
|
+
}): CancelablePromise<any>;
|
|
1965
|
+
/**
|
|
1966
|
+
* List tokens
|
|
1967
|
+
* Lists tokens for an NFT contract.
|
|
1968
|
+
* @returns ListNftTokens
|
|
1969
|
+
* @throws ApiError
|
|
1970
|
+
*/
|
|
1971
|
+
listTokens({ chainId, address, pageToken, pageSize, }: {
|
|
1972
|
+
/**
|
|
1973
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1974
|
+
*/
|
|
1975
|
+
chainId: string;
|
|
1976
|
+
/**
|
|
1977
|
+
* Contract address on the relevant chain.
|
|
1978
|
+
*/
|
|
1979
|
+
address: string;
|
|
1980
|
+
/**
|
|
1981
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
1982
|
+
*/
|
|
1983
|
+
pageToken?: string;
|
|
1984
|
+
/**
|
|
1985
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
1986
|
+
*/
|
|
1987
|
+
pageSize?: number;
|
|
1988
|
+
}): CancelablePromise<ListNftTokens>;
|
|
1989
|
+
/**
|
|
1990
|
+
* Get token details
|
|
1991
|
+
* Gets token details for a specific token of an NFT contract.
|
|
1992
|
+
* @returns any
|
|
1993
|
+
* @throws ApiError
|
|
1994
|
+
*/
|
|
1995
|
+
getTokenDetails({ chainId, address, tokenId, }: {
|
|
1996
|
+
/**
|
|
1997
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
1998
|
+
*/
|
|
1999
|
+
chainId: string;
|
|
2000
|
+
/**
|
|
2001
|
+
* Contract address on the relevant chain.
|
|
2002
|
+
*/
|
|
2003
|
+
address: string;
|
|
2004
|
+
/**
|
|
2005
|
+
* TokenId on the contract
|
|
2006
|
+
*/
|
|
2007
|
+
tokenId: string;
|
|
2008
|
+
}): CancelablePromise<(Erc721Token | Erc1155Token)>;
|
|
2009
|
+
}
|
|
2010
|
+
|
|
2011
|
+
type EvmNetworkOptions = {
|
|
2012
|
+
addresses: Array<string>;
|
|
2013
|
+
includeChains: Array<string>;
|
|
2014
|
+
};
|
|
2015
|
+
|
|
2016
|
+
declare enum EVMOperationType {
|
|
2017
|
+
TRANSACTION_EXPORT_EVM = "TRANSACTION_EXPORT_EVM"
|
|
2018
|
+
}
|
|
2019
|
+
|
|
2020
|
+
type CreateEvmTransactionExportRequest = {
|
|
2021
|
+
type: EVMOperationType;
|
|
2022
|
+
firstDate: string;
|
|
2023
|
+
lastDate: string;
|
|
2024
|
+
/**
|
|
2025
|
+
* @deprecated
|
|
2026
|
+
*/
|
|
2027
|
+
startDate: string;
|
|
2028
|
+
/**
|
|
2029
|
+
* @deprecated
|
|
2030
|
+
*/
|
|
2031
|
+
endDate: string;
|
|
2032
|
+
options: EvmNetworkOptions;
|
|
2033
|
+
};
|
|
2034
|
+
|
|
2035
|
+
declare enum PrimaryNetworkOperationType {
|
|
2036
|
+
TRANSACTION_EXPORT_PRIMARY_NETWORK = "TRANSACTION_EXPORT_PRIMARY_NETWORK",
|
|
2037
|
+
TRANSACTION_EXPORT_PRIMARY_NETWORK_STAKING = "TRANSACTION_EXPORT_PRIMARY_NETWORK_STAKING",
|
|
2038
|
+
TRANSACTION_EXPORT_PRIMARY_NETWORK_SIMPLE = "TRANSACTION_EXPORT_PRIMARY_NETWORK_SIMPLE"
|
|
2039
|
+
}
|
|
2040
|
+
|
|
2041
|
+
type PrimaryNetworkOptions = {
|
|
2042
|
+
addresses?: Array<string>;
|
|
2043
|
+
cChainEvmAddresses?: Array<string>;
|
|
2044
|
+
includeChains: Array<'11111111111111111111111111111111LpoYY' | '2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM' | '2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm' | '2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5' | 'yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp' | 'p-chain' | 'x-chain' | 'c-chain'>;
|
|
2045
|
+
};
|
|
2046
|
+
|
|
2047
|
+
type CreatePrimaryNetworkTransactionExportRequest = {
|
|
2048
|
+
type: PrimaryNetworkOperationType;
|
|
2049
|
+
firstDate: string;
|
|
2050
|
+
lastDate: string;
|
|
2051
|
+
/**
|
|
2052
|
+
* @deprecated
|
|
2053
|
+
*/
|
|
2054
|
+
startDate: string;
|
|
2055
|
+
/**
|
|
2056
|
+
* @deprecated
|
|
2057
|
+
*/
|
|
2058
|
+
endDate: string;
|
|
2059
|
+
options: PrimaryNetworkOptions;
|
|
2060
|
+
};
|
|
2061
|
+
|
|
2062
|
+
declare enum OperationStatus {
|
|
2063
|
+
RUNNING = "RUNNING",
|
|
2064
|
+
COMPLETED = "COMPLETED",
|
|
2065
|
+
COMPLETED_WITH_WARNING = "COMPLETED_WITH_WARNING",
|
|
2066
|
+
FAILED = "FAILED"
|
|
2067
|
+
}
|
|
2068
|
+
|
|
2069
|
+
declare enum OperationType {
|
|
2070
|
+
TRANSACTION_EXPORT_PRIMARY_NETWORK = "TRANSACTION_EXPORT_PRIMARY_NETWORK",
|
|
2071
|
+
TRANSACTION_EXPORT_PRIMARY_NETWORK_STAKING = "TRANSACTION_EXPORT_PRIMARY_NETWORK_STAKING",
|
|
2072
|
+
TRANSACTION_EXPORT_PRIMARY_NETWORK_SIMPLE = "TRANSACTION_EXPORT_PRIMARY_NETWORK_SIMPLE",
|
|
2073
|
+
TRANSACTION_EXPORT_EVM = "TRANSACTION_EXPORT_EVM"
|
|
2074
|
+
}
|
|
2075
|
+
|
|
2076
|
+
declare enum OperationStatusCode {
|
|
2077
|
+
ERR_INVALID_REQUEST = "ErrInvalidRequest",
|
|
2078
|
+
ERR_INTERNAL = "ErrInternal",
|
|
2079
|
+
WARN_TRUNCATED_EXPORT = "WarnTruncatedExport"
|
|
2080
|
+
}
|
|
2081
|
+
|
|
2082
|
+
type TransactionExportMetadata = {
|
|
2083
|
+
code?: OperationStatusCode;
|
|
2084
|
+
/**
|
|
2085
|
+
* File download URL. Provided only for COMPLETED and COMPLETED_WITH_WARNING operations.
|
|
2086
|
+
*/
|
|
2087
|
+
downloadUrl?: string;
|
|
2088
|
+
/**
|
|
2089
|
+
* The next date (YYYY-MM-DD) to use as the firstDate in follow up requests if a request results in a transaction history exceeding the max size and has been reported as `COMPLETED_WITH_WARNING` with the warning 'WarnTruncatedExport'.
|
|
2090
|
+
*/
|
|
2091
|
+
nextDate?: string;
|
|
2092
|
+
};
|
|
2093
|
+
|
|
2094
|
+
type OperationStatusResponse = {
|
|
2095
|
+
operationId: string;
|
|
2096
|
+
operationType: OperationType;
|
|
2097
|
+
operationStatus: OperationStatus;
|
|
2098
|
+
message?: string;
|
|
2099
|
+
metadata: TransactionExportMetadata;
|
|
2100
|
+
createdAtTimestamp: number;
|
|
2101
|
+
updatedAtTimestamp: number;
|
|
2102
|
+
};
|
|
2103
|
+
|
|
2104
|
+
declare class OperationsService {
|
|
2105
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2106
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2107
|
+
/**
|
|
2108
|
+
* Get operation
|
|
2109
|
+
* Gets operation details for the given operation id.
|
|
2110
|
+
* @returns OperationStatusResponse
|
|
2111
|
+
* @throws ApiError
|
|
2112
|
+
*/
|
|
2113
|
+
getOperationResult({ operationId, }: {
|
|
2114
|
+
/**
|
|
2115
|
+
* UUID of given operation
|
|
2116
|
+
*/
|
|
2117
|
+
operationId: string;
|
|
2118
|
+
}): CancelablePromise<OperationStatusResponse>;
|
|
2119
|
+
/**
|
|
2120
|
+
* Create transaction export operation
|
|
2121
|
+
* Trigger a transaction export operation with given parameters.
|
|
2122
|
+
*
|
|
2123
|
+
* The transaction export operation runs asynchronously in the background. The status of the job can be retrieved from the `/v1/operations/:operationId` endpoint using the `operationId` returned from this endpoint.
|
|
2124
|
+
* @returns OperationStatusResponse
|
|
2125
|
+
* @throws ApiError
|
|
2126
|
+
*/
|
|
2127
|
+
postTransactionExportJob({ requestBody, }: {
|
|
2128
|
+
requestBody: (CreateEvmTransactionExportRequest | CreatePrimaryNetworkTransactionExportRequest);
|
|
2129
|
+
}): CancelablePromise<OperationStatusResponse>;
|
|
2130
|
+
}
|
|
2131
|
+
|
|
2132
|
+
declare enum BlockchainIds {
|
|
2133
|
+
_11111111111111111111111111111111LPO_YY = "11111111111111111111111111111111LpoYY",
|
|
2134
|
+
_2O_YMBNV4E_NHYQK2FJJ_V5N_VQLDBTM_NJZQ5S3QS3LO6FTN_C6FBY_M = "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
|
|
2135
|
+
_2JVSBOINJ9C2J33VNTVZ_YT_VJNZD_N2NKIWW_KJCUM_HUWEB5DB_BRM = "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm",
|
|
2136
|
+
_2Q9E4R6MU3U68N_U1F_YJGB_R6JVWR_RX36COHP_AX5UQXSE55X1Q5 = "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5",
|
|
2137
|
+
Y_H8D7TH_NJKXMTKUV2JG_BA4P1RN3QPR4P_PR7QYNFCDO_S6K6HWP = "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp"
|
|
2138
|
+
}
|
|
2139
|
+
|
|
2140
|
+
type ChainAddressChainIdMap = {
|
|
2141
|
+
address: string;
|
|
2142
|
+
blockchainIds: Array<BlockchainIds>;
|
|
2143
|
+
};
|
|
2144
|
+
|
|
2145
|
+
type ChainAddressChainIdMapListResponse = {
|
|
2146
|
+
addresses: Array<ChainAddressChainIdMap>;
|
|
2147
|
+
};
|
|
2148
|
+
|
|
2149
|
+
declare enum DelegationStatusType {
|
|
2150
|
+
COMPLETED = "completed",
|
|
2151
|
+
ACTIVE = "active",
|
|
2152
|
+
PENDING = "pending"
|
|
2153
|
+
}
|
|
2154
|
+
|
|
2155
|
+
type DelegatorsDetails = {
|
|
2156
|
+
delegatorCount: number;
|
|
2157
|
+
totalAmountStaked: string;
|
|
2158
|
+
};
|
|
2159
|
+
|
|
2160
|
+
type StakingDistribution = {
|
|
2161
|
+
version: string;
|
|
2162
|
+
amountStaked: string;
|
|
2163
|
+
validatorCount: number;
|
|
2164
|
+
};
|
|
2165
|
+
|
|
2166
|
+
type ValidatorsDetails = {
|
|
2167
|
+
validatorCount: number;
|
|
2168
|
+
totalAmountStaked: string;
|
|
2169
|
+
estimatedAnnualStakingReward: string;
|
|
2170
|
+
stakingDistributionByVersion: Array<StakingDistribution>;
|
|
2171
|
+
stakingRatio: string;
|
|
2172
|
+
};
|
|
2173
|
+
|
|
2174
|
+
type GetNetworkDetailsResponse = {
|
|
2175
|
+
validatorDetails: ValidatorsDetails;
|
|
2176
|
+
delegatorDetails: DelegatorsDetails;
|
|
2177
|
+
};
|
|
2178
|
+
|
|
2179
|
+
type Blockchain = {
|
|
2180
|
+
createBlockTimestamp: number;
|
|
2181
|
+
createBlockNumber: string;
|
|
2182
|
+
blockchainId: string;
|
|
2183
|
+
vmId: string;
|
|
2184
|
+
subnetId: string;
|
|
2185
|
+
blockchainName: string;
|
|
2186
|
+
};
|
|
2187
|
+
|
|
2188
|
+
type ListBlockchainsResponse = {
|
|
2189
|
+
/**
|
|
2190
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
2191
|
+
*/
|
|
2192
|
+
nextPageToken?: string;
|
|
2193
|
+
blockchains: Array<Blockchain>;
|
|
2194
|
+
};
|
|
2195
|
+
|
|
2196
|
+
type ActiveDelegatorDetails = {
|
|
2197
|
+
txHash: string;
|
|
2198
|
+
nodeId: string;
|
|
2199
|
+
rewardAddresses: Array<string>;
|
|
2200
|
+
amountDelegated: string;
|
|
2201
|
+
delegationFee: string;
|
|
2202
|
+
startTimestamp: number;
|
|
2203
|
+
endTimestamp: number;
|
|
2204
|
+
estimatedGrossReward: string;
|
|
2205
|
+
estimatedNetReward: string;
|
|
2206
|
+
delegationStatus: ActiveDelegatorDetails.delegationStatus;
|
|
2207
|
+
};
|
|
2208
|
+
declare namespace ActiveDelegatorDetails {
|
|
2209
|
+
enum delegationStatus {
|
|
2210
|
+
ACTIVE = "active"
|
|
2211
|
+
}
|
|
2212
|
+
}
|
|
2213
|
+
|
|
2214
|
+
type CompletedDelegatorDetails = {
|
|
2215
|
+
txHash: string;
|
|
2216
|
+
nodeId: string;
|
|
2217
|
+
rewardAddresses: Array<string>;
|
|
2218
|
+
amountDelegated: string;
|
|
2219
|
+
delegationFee: string;
|
|
2220
|
+
startTimestamp: number;
|
|
2221
|
+
endTimestamp: number;
|
|
2222
|
+
grossReward: string;
|
|
2223
|
+
netReward: string;
|
|
2224
|
+
delegationStatus: CompletedDelegatorDetails.delegationStatus;
|
|
2225
|
+
};
|
|
2226
|
+
declare namespace CompletedDelegatorDetails {
|
|
2227
|
+
enum delegationStatus {
|
|
2228
|
+
COMPLETED = "completed"
|
|
2229
|
+
}
|
|
2230
|
+
}
|
|
2231
|
+
|
|
2232
|
+
type PendingDelegatorDetails = {
|
|
2233
|
+
txHash: string;
|
|
2234
|
+
nodeId: string;
|
|
2235
|
+
rewardAddresses: Array<string>;
|
|
2236
|
+
amountDelegated: string;
|
|
2237
|
+
delegationFee: string;
|
|
2238
|
+
startTimestamp: number;
|
|
2239
|
+
endTimestamp: number;
|
|
2240
|
+
estimatedGrossReward: string;
|
|
2241
|
+
estimatedNetReward: string;
|
|
2242
|
+
delegationStatus: PendingDelegatorDetails.delegationStatus;
|
|
2243
|
+
};
|
|
2244
|
+
declare namespace PendingDelegatorDetails {
|
|
2245
|
+
enum delegationStatus {
|
|
2246
|
+
PENDING = "pending"
|
|
2247
|
+
}
|
|
2248
|
+
}
|
|
2249
|
+
|
|
2250
|
+
type ListDelegatorDetailsResponse = {
|
|
2251
|
+
/**
|
|
2252
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
2253
|
+
*/
|
|
2254
|
+
nextPageToken?: string;
|
|
2255
|
+
/**
|
|
2256
|
+
* The list of Delegator Details.
|
|
2257
|
+
*/
|
|
2258
|
+
delegators: Array<(CompletedDelegatorDetails | ActiveDelegatorDetails | PendingDelegatorDetails)>;
|
|
2259
|
+
};
|
|
2260
|
+
|
|
2261
|
+
type BlockchainInfo = {
|
|
2262
|
+
blockchainId: string;
|
|
2263
|
+
};
|
|
2264
|
+
|
|
2265
|
+
type SubnetOwnershipInfo = {
|
|
2266
|
+
/**
|
|
2267
|
+
* Locktime in seconds after which Subnet owners can control this Subnet.
|
|
2268
|
+
*/
|
|
2269
|
+
locktime: number;
|
|
2270
|
+
/**
|
|
2271
|
+
* Minimum number of signatures required to sign the Subnet update transactions.
|
|
2272
|
+
*/
|
|
2273
|
+
threshold: number;
|
|
2274
|
+
/**
|
|
2275
|
+
* Addresses that are eligible to sign the Subnet update transactions.
|
|
2276
|
+
*/
|
|
2277
|
+
addresses: Array<string>;
|
|
2278
|
+
};
|
|
2279
|
+
|
|
2280
|
+
type Subnet = {
|
|
2281
|
+
createBlockTimestamp: number;
|
|
2282
|
+
createBlockIndex: string;
|
|
2283
|
+
subnetId: string;
|
|
2284
|
+
/**
|
|
2285
|
+
* This field is deprecated. Use subnetOwnershipInfo instead.
|
|
2286
|
+
* @deprecated
|
|
2287
|
+
*/
|
|
2288
|
+
ownerAddresses: Array<string>;
|
|
2289
|
+
/**
|
|
2290
|
+
* This field is deprecated. Use subnetOwnershipInfo instead.
|
|
2291
|
+
* @deprecated
|
|
2292
|
+
*/
|
|
2293
|
+
threshold: number;
|
|
2294
|
+
/**
|
|
2295
|
+
* This field is deprecated. Use subnetOwnershipInfo instead.
|
|
2296
|
+
* @deprecated
|
|
2297
|
+
*/
|
|
2298
|
+
locktime: number;
|
|
2299
|
+
/**
|
|
2300
|
+
* Latest subnet owner details for this Subnet.
|
|
2301
|
+
*/
|
|
2302
|
+
subnetOwnershipInfo: SubnetOwnershipInfo;
|
|
2303
|
+
blockchains: Array<BlockchainInfo>;
|
|
2304
|
+
};
|
|
2305
|
+
|
|
2306
|
+
type ListSubnetsResponse = {
|
|
2307
|
+
/**
|
|
2308
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
2309
|
+
*/
|
|
2310
|
+
nextPageToken?: string;
|
|
2311
|
+
subnets: Array<Subnet>;
|
|
2312
|
+
};
|
|
2313
|
+
|
|
2314
|
+
type BlsCredentials = {
|
|
2315
|
+
publicKey: string;
|
|
2316
|
+
proofOfPossession: string;
|
|
2317
|
+
};
|
|
2318
|
+
|
|
2319
|
+
type Rewards = {
|
|
2320
|
+
validationRewardAmount: string;
|
|
2321
|
+
delegationRewardAmount: string;
|
|
2322
|
+
rewardAddresses?: Array<string>;
|
|
2323
|
+
rewardTxHash?: string;
|
|
2324
|
+
};
|
|
2325
|
+
|
|
2326
|
+
type ValidatorHealthDetails = {
|
|
2327
|
+
/**
|
|
2328
|
+
* Percent of requests responded to in last polling.
|
|
2329
|
+
*/
|
|
2330
|
+
reachabilityPercent: number;
|
|
2331
|
+
/**
|
|
2332
|
+
* Percent of requests benched on the P-Chain in last polling.
|
|
2333
|
+
*/
|
|
2334
|
+
benchedPChainRequestsPercent: number;
|
|
2335
|
+
/**
|
|
2336
|
+
* Percentage of requests benched on the X-Chain in last polling.
|
|
2337
|
+
*/
|
|
2338
|
+
benchedXChainRequestsPercent: number;
|
|
2339
|
+
/**
|
|
2340
|
+
* Percentage of requests benched on the C-Chain in last polling.
|
|
2341
|
+
*/
|
|
2342
|
+
benchedCChainRequestsPercent: number;
|
|
2343
|
+
};
|
|
2344
|
+
|
|
2345
|
+
type ActiveValidatorDetails = {
|
|
2346
|
+
txHash: string;
|
|
2347
|
+
nodeId: string;
|
|
2348
|
+
subnetId: string;
|
|
2349
|
+
amountStaked: string;
|
|
2350
|
+
delegationFee?: string;
|
|
2351
|
+
startTimestamp: number;
|
|
2352
|
+
endTimestamp: number;
|
|
2353
|
+
/**
|
|
2354
|
+
* Present for AddPermissionlessValidatorTx
|
|
2355
|
+
*/
|
|
2356
|
+
blsCredentials?: BlsCredentials;
|
|
2357
|
+
stakePercentage: number;
|
|
2358
|
+
delegatorCount: number;
|
|
2359
|
+
amountDelegated?: string;
|
|
2360
|
+
uptimePerformance: number;
|
|
2361
|
+
avalancheGoVersion?: string;
|
|
2362
|
+
delegationCapacity?: string;
|
|
2363
|
+
potentialRewards: Rewards;
|
|
2364
|
+
validationStatus: ActiveValidatorDetails.validationStatus;
|
|
2365
|
+
validatorHealth: ValidatorHealthDetails;
|
|
2366
|
+
};
|
|
2367
|
+
declare namespace ActiveValidatorDetails {
|
|
2368
|
+
enum validationStatus {
|
|
2369
|
+
ACTIVE = "active"
|
|
2370
|
+
}
|
|
2371
|
+
}
|
|
2372
|
+
|
|
2373
|
+
type CompletedValidatorDetails = {
|
|
2374
|
+
txHash: string;
|
|
2375
|
+
nodeId: string;
|
|
2376
|
+
subnetId: string;
|
|
2377
|
+
amountStaked: string;
|
|
2378
|
+
delegationFee?: string;
|
|
2379
|
+
startTimestamp: number;
|
|
2380
|
+
endTimestamp: number;
|
|
2381
|
+
/**
|
|
2382
|
+
* Present for AddPermissionlessValidatorTx
|
|
2383
|
+
*/
|
|
2384
|
+
blsCredentials?: BlsCredentials;
|
|
2385
|
+
delegatorCount: number;
|
|
2386
|
+
rewards: Rewards;
|
|
2387
|
+
validationStatus: CompletedValidatorDetails.validationStatus;
|
|
2388
|
+
};
|
|
2389
|
+
declare namespace CompletedValidatorDetails {
|
|
2390
|
+
enum validationStatus {
|
|
2391
|
+
COMPLETED = "completed"
|
|
2392
|
+
}
|
|
2393
|
+
}
|
|
2394
|
+
|
|
2395
|
+
type PendingValidatorDetails = {
|
|
2396
|
+
txHash: string;
|
|
2397
|
+
nodeId: string;
|
|
2398
|
+
subnetId: string;
|
|
2399
|
+
amountStaked: string;
|
|
2400
|
+
delegationFee?: string;
|
|
2401
|
+
startTimestamp: number;
|
|
2402
|
+
endTimestamp: number;
|
|
2403
|
+
/**
|
|
2404
|
+
* Present for AddPermissionlessValidatorTx
|
|
2405
|
+
*/
|
|
2406
|
+
blsCredentials?: BlsCredentials;
|
|
2407
|
+
validationStatus: PendingValidatorDetails.validationStatus;
|
|
2408
|
+
};
|
|
2409
|
+
declare namespace PendingValidatorDetails {
|
|
2410
|
+
enum validationStatus {
|
|
2411
|
+
PENDING = "pending"
|
|
2412
|
+
}
|
|
2413
|
+
}
|
|
2414
|
+
|
|
2415
|
+
type RemovedValidatorDetails = {
|
|
2416
|
+
txHash: string;
|
|
2417
|
+
nodeId: string;
|
|
2418
|
+
subnetId: string;
|
|
2419
|
+
amountStaked: string;
|
|
2420
|
+
delegationFee?: string;
|
|
2421
|
+
startTimestamp: number;
|
|
2422
|
+
endTimestamp: number;
|
|
2423
|
+
/**
|
|
2424
|
+
* Present for AddPermissionlessValidatorTx
|
|
2425
|
+
*/
|
|
2426
|
+
blsCredentials?: BlsCredentials;
|
|
2427
|
+
removeTxHash: string;
|
|
2428
|
+
removeTimestamp: number;
|
|
2429
|
+
validationStatus: RemovedValidatorDetails.validationStatus;
|
|
2430
|
+
};
|
|
2431
|
+
declare namespace RemovedValidatorDetails {
|
|
2432
|
+
enum validationStatus {
|
|
2433
|
+
REMOVED = "removed"
|
|
2434
|
+
}
|
|
2435
|
+
}
|
|
2436
|
+
|
|
2437
|
+
type ListValidatorDetailsResponse = {
|
|
2438
|
+
/**
|
|
2439
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
2440
|
+
*/
|
|
2441
|
+
nextPageToken?: string;
|
|
2442
|
+
/**
|
|
2443
|
+
* The list of validator Details.
|
|
2444
|
+
*/
|
|
2445
|
+
validators: Array<(CompletedValidatorDetails | ActiveValidatorDetails | PendingValidatorDetails | RemovedValidatorDetails)>;
|
|
2446
|
+
};
|
|
2447
|
+
|
|
2448
|
+
declare enum Network {
|
|
2449
|
+
MAINNET = "mainnet",
|
|
2450
|
+
FUJI = "fuji"
|
|
2451
|
+
}
|
|
2452
|
+
|
|
2453
|
+
declare enum SortByOption {
|
|
2454
|
+
BLOCK_INDEX = "blockIndex",
|
|
2455
|
+
DELEGATION_CAPACITY = "delegationCapacity",
|
|
2456
|
+
TIME_REMAINING = "timeRemaining",
|
|
2457
|
+
DELEGATION_FEE = "delegationFee",
|
|
2458
|
+
UPTIME_PERFORMANCE = "uptimePerformance"
|
|
2459
|
+
}
|
|
2460
|
+
|
|
2461
|
+
declare enum ValidationStatusType {
|
|
2462
|
+
COMPLETED = "completed",
|
|
2463
|
+
ACTIVE = "active",
|
|
2464
|
+
PENDING = "pending",
|
|
2465
|
+
REMOVED = "removed"
|
|
2466
|
+
}
|
|
2467
|
+
|
|
2468
|
+
/**
|
|
2469
|
+
* Cap represents if an asset is a variable or fixed cap asset.
|
|
2470
|
+
*/
|
|
2471
|
+
declare enum PrimaryNetworkAssetCap {
|
|
2472
|
+
FIXED = "fixed",
|
|
2473
|
+
VARIABLE = "variable"
|
|
2474
|
+
}
|
|
2475
|
+
|
|
2476
|
+
/**
|
|
2477
|
+
* Type of asset like SECP256K1 or NFT.
|
|
2478
|
+
*/
|
|
2479
|
+
declare enum PrimaryNetworkAssetType {
|
|
2480
|
+
SECP256K1 = "secp256k1",
|
|
2481
|
+
NFT = "nft"
|
|
2482
|
+
}
|
|
2483
|
+
|
|
2484
|
+
type XChainAssetDetails = {
|
|
2485
|
+
/**
|
|
2486
|
+
* Unique ID for an asset.
|
|
2487
|
+
*/
|
|
2488
|
+
assetId: string;
|
|
2489
|
+
/**
|
|
2490
|
+
* Name of this asset.
|
|
2491
|
+
*/
|
|
2492
|
+
name: string;
|
|
2493
|
+
/**
|
|
2494
|
+
* Symbol for this asset (max 4 characters).
|
|
2495
|
+
*/
|
|
2496
|
+
symbol: string;
|
|
2497
|
+
/**
|
|
2498
|
+
* Denomination of this asset to represent fungibility.
|
|
2499
|
+
*/
|
|
2500
|
+
denomination: number;
|
|
2501
|
+
type: PrimaryNetworkAssetType;
|
|
2502
|
+
/**
|
|
2503
|
+
* Timestamp in seconds this asset was created on.
|
|
2504
|
+
*/
|
|
2505
|
+
createdAtTimestamp: number;
|
|
2506
|
+
cap: PrimaryNetworkAssetCap;
|
|
2507
|
+
};
|
|
2508
|
+
|
|
2509
|
+
declare enum XChainId {
|
|
2510
|
+
_2O_YMBNV4E_NHYQK2FJJ_V5N_VQLDBTM_NJZQ5S3QS3LO6FTN_C6FBY_M = "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
|
|
2511
|
+
_2JVSBOINJ9C2J33VNTVZ_YT_VJNZD_N2NKIWW_KJCUM_HUWEB5DB_BRM = "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm",
|
|
2512
|
+
X_CHAIN = "x-chain"
|
|
2513
|
+
}
|
|
2514
|
+
|
|
2515
|
+
declare class PrimaryNetworkService {
|
|
2516
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2517
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2518
|
+
/**
|
|
2519
|
+
* Get asset details
|
|
2520
|
+
* Gets asset details corresponding to the given asset id on the X-Chain.
|
|
2521
|
+
* @returns XChainAssetDetails
|
|
2522
|
+
* @throws ApiError
|
|
2523
|
+
*/
|
|
2524
|
+
getAssetDetails({ blockchainId, network, assetId, }: {
|
|
2525
|
+
/**
|
|
2526
|
+
* A primary network blockchain id or alias.
|
|
2527
|
+
*/
|
|
2528
|
+
blockchainId: XChainId;
|
|
2529
|
+
/**
|
|
2530
|
+
* Either mainnet or a testnet.
|
|
2531
|
+
*/
|
|
2532
|
+
network: Network;
|
|
2533
|
+
/**
|
|
2534
|
+
* Asset ID for any asset on X-Chain
|
|
2535
|
+
*/
|
|
2536
|
+
assetId: string;
|
|
2537
|
+
}): CancelablePromise<XChainAssetDetails>;
|
|
2538
|
+
/**
|
|
2539
|
+
* Get chain interactions for addresses
|
|
2540
|
+
* 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.
|
|
2541
|
+
* @returns ChainAddressChainIdMapListResponse
|
|
2542
|
+
* @throws ApiError
|
|
2543
|
+
*/
|
|
2544
|
+
getChainIdsForAddresses({ addresses, network, }: {
|
|
2545
|
+
/**
|
|
2546
|
+
* 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".
|
|
2547
|
+
*/
|
|
2548
|
+
addresses: string;
|
|
2549
|
+
/**
|
|
2550
|
+
* Either mainnet or a testnet.
|
|
2551
|
+
*/
|
|
2552
|
+
network: Network;
|
|
2553
|
+
}): CancelablePromise<ChainAddressChainIdMapListResponse>;
|
|
2554
|
+
/**
|
|
2555
|
+
* Get network details
|
|
2556
|
+
* Gets network details such as validator and delegator stats.
|
|
2557
|
+
* @returns GetNetworkDetailsResponse
|
|
2558
|
+
* @throws ApiError
|
|
2559
|
+
*/
|
|
2560
|
+
getNetworkDetails({ network, }: {
|
|
2561
|
+
/**
|
|
2562
|
+
* Either mainnet or a testnet.
|
|
2563
|
+
*/
|
|
2564
|
+
network: Network;
|
|
2565
|
+
}): CancelablePromise<GetNetworkDetailsResponse>;
|
|
2566
|
+
/**
|
|
2567
|
+
* List blockchains
|
|
2568
|
+
* Lists all blockchains registered on the network.
|
|
2569
|
+
* @returns ListBlockchainsResponse
|
|
2570
|
+
* @throws ApiError
|
|
2571
|
+
*/
|
|
2572
|
+
listBlockchains({ network, pageToken, pageSize, sortOrder, }: {
|
|
2573
|
+
/**
|
|
2574
|
+
* Either mainnet or a testnet.
|
|
2575
|
+
*/
|
|
2576
|
+
network: Network;
|
|
2577
|
+
/**
|
|
2578
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
2579
|
+
*/
|
|
2580
|
+
pageToken?: string;
|
|
2581
|
+
/**
|
|
2582
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
2583
|
+
*/
|
|
2584
|
+
pageSize?: number;
|
|
2585
|
+
/**
|
|
2586
|
+
* 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.
|
|
2587
|
+
*/
|
|
2588
|
+
sortOrder?: SortOrder;
|
|
2589
|
+
}): CancelablePromise<ListBlockchainsResponse>;
|
|
2590
|
+
/**
|
|
2591
|
+
* List subnets
|
|
2592
|
+
* Lists all subnets registered on the network.
|
|
2593
|
+
* @returns ListSubnetsResponse
|
|
2594
|
+
* @throws ApiError
|
|
2595
|
+
*/
|
|
2596
|
+
listSubnets({ network, pageToken, pageSize, sortOrder, }: {
|
|
2597
|
+
/**
|
|
2598
|
+
* Either mainnet or a testnet.
|
|
2599
|
+
*/
|
|
2600
|
+
network: Network;
|
|
2601
|
+
/**
|
|
2602
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
2603
|
+
*/
|
|
2604
|
+
pageToken?: string;
|
|
2605
|
+
/**
|
|
2606
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
2607
|
+
*/
|
|
2608
|
+
pageSize?: number;
|
|
2609
|
+
/**
|
|
2610
|
+
* 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.
|
|
2611
|
+
*/
|
|
2612
|
+
sortOrder?: SortOrder;
|
|
2613
|
+
}): CancelablePromise<ListSubnetsResponse>;
|
|
2614
|
+
/**
|
|
2615
|
+
* List validators
|
|
2616
|
+
* Lists details for validators. By default, returns details for all validators. Filterable by validator node ids and minimum delegation capacity.
|
|
2617
|
+
* @returns ListValidatorDetailsResponse
|
|
2618
|
+
* @throws ApiError
|
|
2619
|
+
*/
|
|
2620
|
+
listValidators({ network, pageToken, pageSize, nodeIds, sortBy, sortOrder, validationStatus, minDelegationCapacity, maxDelegationCapacity, minTimeRemaining, maxTimeRemaining, minFeePercentage, maxFeePercentage, minUptimePerformance, maxUptimePerformance, subnetId, }: {
|
|
2621
|
+
/**
|
|
2622
|
+
* Either mainnet or a testnet.
|
|
2623
|
+
*/
|
|
2624
|
+
network: Network;
|
|
2625
|
+
/**
|
|
2626
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
2627
|
+
*/
|
|
2628
|
+
pageToken?: string;
|
|
2629
|
+
/**
|
|
2630
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
2631
|
+
*/
|
|
2632
|
+
pageSize?: number;
|
|
2633
|
+
/**
|
|
2634
|
+
* A comma separated list of node ids to filter by.
|
|
2635
|
+
*/
|
|
2636
|
+
nodeIds?: string;
|
|
2637
|
+
/**
|
|
2638
|
+
* Which property to sort by, in conjunction with sortOrder.
|
|
2639
|
+
*
|
|
2640
|
+
* Note: Delegation fee is only available for mainnet validators. Set `subnetId` to `11111111111111111111111111111111LpoYY` to use this option.
|
|
2641
|
+
*/
|
|
2642
|
+
sortBy?: SortByOption;
|
|
2643
|
+
/**
|
|
2644
|
+
* 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.
|
|
2645
|
+
*/
|
|
2646
|
+
sortOrder?: SortOrder;
|
|
2647
|
+
/**
|
|
2648
|
+
* Validation status of the node.
|
|
2649
|
+
*/
|
|
2650
|
+
validationStatus?: ValidationStatusType;
|
|
2651
|
+
/**
|
|
2652
|
+
* 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
|
|
2653
|
+
*/
|
|
2654
|
+
minDelegationCapacity?: string;
|
|
2655
|
+
/**
|
|
2656
|
+
* 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.
|
|
2657
|
+
*/
|
|
2658
|
+
maxDelegationCapacity?: string;
|
|
2659
|
+
/**
|
|
2660
|
+
* The minimum validation time remaining, in seconds, used to filter the set of nodes being returned.
|
|
2661
|
+
*/
|
|
2662
|
+
minTimeRemaining?: number;
|
|
2663
|
+
/**
|
|
2664
|
+
* The maximum validation time remaining, in seconds, used to filter the set of nodes being returned.
|
|
2665
|
+
*/
|
|
2666
|
+
maxTimeRemaining?: number;
|
|
2667
|
+
/**
|
|
2668
|
+
* 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.
|
|
2669
|
+
*/
|
|
2670
|
+
minFeePercentage?: number;
|
|
2671
|
+
/**
|
|
2672
|
+
* 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.
|
|
2673
|
+
*/
|
|
2674
|
+
maxFeePercentage?: number;
|
|
2675
|
+
/**
|
|
2676
|
+
* The minimum node uptime performance percentage, which represents node health, used to filter the set of nodes being returned Default is 90.
|
|
2677
|
+
*/
|
|
2678
|
+
minUptimePerformance?: number;
|
|
2679
|
+
/**
|
|
2680
|
+
* The maximum node uptime performance percentage, which represents node health, used to filter the set of nodes being returned. Default is 100.
|
|
2681
|
+
*/
|
|
2682
|
+
maxUptimePerformance?: number;
|
|
2683
|
+
/**
|
|
2684
|
+
* The subnet ID to filter by. If not provided, then all subnets will be returned.
|
|
2685
|
+
*/
|
|
2686
|
+
subnetId?: any;
|
|
2687
|
+
}): CancelablePromise<ListValidatorDetailsResponse>;
|
|
2688
|
+
/**
|
|
2689
|
+
* Get single validator details
|
|
2690
|
+
* List validator details for a single validator. Filterable by validation status.
|
|
2691
|
+
* @returns ListValidatorDetailsResponse
|
|
2692
|
+
* @throws ApiError
|
|
2693
|
+
*/
|
|
2694
|
+
getSingleValidatorDetails({ network, nodeId, pageToken, pageSize, validationStatus, sortOrder, }: {
|
|
2695
|
+
/**
|
|
2696
|
+
* Either mainnet or a testnet.
|
|
2697
|
+
*/
|
|
2698
|
+
network: Network;
|
|
2699
|
+
/**
|
|
2700
|
+
* A primary network (P or X chain) nodeId.
|
|
2701
|
+
*/
|
|
2702
|
+
nodeId: string;
|
|
2703
|
+
/**
|
|
2704
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
2705
|
+
*/
|
|
2706
|
+
pageToken?: string;
|
|
2707
|
+
/**
|
|
2708
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
2709
|
+
*/
|
|
2710
|
+
pageSize?: number;
|
|
2711
|
+
/**
|
|
2712
|
+
* Validation status of the node.
|
|
2713
|
+
*/
|
|
2714
|
+
validationStatus?: ValidationStatusType;
|
|
2715
|
+
/**
|
|
2716
|
+
* 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.
|
|
2717
|
+
*/
|
|
2718
|
+
sortOrder?: SortOrder;
|
|
2719
|
+
}): CancelablePromise<ListValidatorDetailsResponse>;
|
|
2720
|
+
/**
|
|
2721
|
+
* List delegators
|
|
2722
|
+
* Lists details for delegators.
|
|
2723
|
+
* @returns ListDelegatorDetailsResponse
|
|
2724
|
+
* @throws ApiError
|
|
2725
|
+
*/
|
|
2726
|
+
listDelegators({ network, pageToken, pageSize, rewardAddresses, sortOrder, delegationStatus, nodeIds, }: {
|
|
2727
|
+
/**
|
|
2728
|
+
* Either mainnet or a testnet.
|
|
2729
|
+
*/
|
|
2730
|
+
network: Network;
|
|
2731
|
+
/**
|
|
2732
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
2733
|
+
*/
|
|
2734
|
+
pageToken?: string;
|
|
2735
|
+
/**
|
|
2736
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
2737
|
+
*/
|
|
2738
|
+
pageSize?: number;
|
|
2739
|
+
/**
|
|
2740
|
+
* A comma separated list of reward addresses to filter by.
|
|
2741
|
+
*/
|
|
2742
|
+
rewardAddresses?: string;
|
|
2743
|
+
/**
|
|
2744
|
+
* 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.
|
|
2745
|
+
*/
|
|
2746
|
+
sortOrder?: SortOrder;
|
|
2747
|
+
/**
|
|
2748
|
+
* Delegation status of the node.
|
|
2749
|
+
*/
|
|
2750
|
+
delegationStatus?: DelegationStatusType;
|
|
2751
|
+
/**
|
|
2752
|
+
* A comma separated list of node ids to filter by.
|
|
2753
|
+
*/
|
|
2754
|
+
nodeIds?: string;
|
|
2755
|
+
}): CancelablePromise<ListDelegatorDetailsResponse>;
|
|
2756
|
+
}
|
|
2757
|
+
|
|
2758
|
+
declare enum BlockchainId {
|
|
2759
|
+
_11111111111111111111111111111111LPO_YY = "11111111111111111111111111111111LpoYY",
|
|
2760
|
+
_2O_YMBNV4E_NHYQK2FJJ_V5N_VQLDBTM_NJZQ5S3QS3LO6FTN_C6FBY_M = "2oYMBNV4eNHyqk2fjjV5nVQLDbtmNJzq5s3qs3Lo6ftnC6FByM",
|
|
2761
|
+
_2JVSBOINJ9C2J33VNTVZ_YT_VJNZD_N2NKIWW_KJCUM_HUWEB5DB_BRM = "2JVSBoinj9C2J33VntvzYtVJNZdN2NKiwwKjcumHUWEb5DbBrm",
|
|
2762
|
+
_2Q9E4R6MU3U68N_U1F_YJGB_R6JVWR_RX36COHP_AX5UQXSE55X1Q5 = "2q9e4r6Mu3U68nU1fYjgbR6JvwrRx36CohpAX5UQxse55x1Q5",
|
|
2763
|
+
Y_H8D7TH_NJKXMTKUV2JG_BA4P1RN3QPR4P_PR7QYNFCDO_S6K6HWP = "yH8D7ThNJkxmtkuv2jgBa4P1Rn3Qpr4pPr7QYNfcdoS6k6HWp",
|
|
2764
|
+
P_CHAIN = "p-chain",
|
|
2765
|
+
X_CHAIN = "x-chain",
|
|
2766
|
+
C_CHAIN = "c-chain"
|
|
2767
|
+
}
|
|
2768
|
+
|
|
2769
|
+
type CChainSharedAssetBalance = {
|
|
2770
|
+
/**
|
|
2771
|
+
* Unique ID for an asset.
|
|
2772
|
+
*/
|
|
2773
|
+
assetId: string;
|
|
2774
|
+
/**
|
|
2775
|
+
* Name of this asset.
|
|
2776
|
+
*/
|
|
2777
|
+
name: string;
|
|
2778
|
+
/**
|
|
2779
|
+
* Symbol for this asset (max 4 characters).
|
|
2780
|
+
*/
|
|
2781
|
+
symbol: string;
|
|
2782
|
+
/**
|
|
2783
|
+
* Denomination of this asset to represent fungibility.
|
|
2784
|
+
*/
|
|
2785
|
+
denomination: number;
|
|
2786
|
+
type: PrimaryNetworkAssetType;
|
|
2787
|
+
/**
|
|
2788
|
+
* Amount of the asset.
|
|
2789
|
+
*/
|
|
2790
|
+
amount: string;
|
|
2791
|
+
utxoCount: number;
|
|
2792
|
+
sharedWithChainId: string;
|
|
2793
|
+
};
|
|
2794
|
+
|
|
2795
|
+
type CChainAtomicBalances = {
|
|
2796
|
+
atomicMemoryUnlocked: Array<CChainSharedAssetBalance>;
|
|
2797
|
+
atomicMemoryLocked: Array<CChainSharedAssetBalance>;
|
|
2798
|
+
};
|
|
2799
|
+
|
|
2800
|
+
declare enum PrimaryNetwork {
|
|
2801
|
+
MAINNET = "mainnet",
|
|
2802
|
+
FUJI = "fuji"
|
|
2803
|
+
}
|
|
2804
|
+
|
|
2805
|
+
declare enum PrimaryNetworkChainName {
|
|
2806
|
+
P_CHAIN = "p-chain",
|
|
2807
|
+
X_CHAIN = "x-chain",
|
|
2808
|
+
C_CHAIN = "c-chain"
|
|
2809
|
+
}
|
|
2810
|
+
|
|
2811
|
+
type PrimaryNetworkChainInfo = {
|
|
2812
|
+
chainName: PrimaryNetworkChainName;
|
|
2813
|
+
network: PrimaryNetwork;
|
|
2814
|
+
};
|
|
2815
|
+
|
|
2816
|
+
type ListCChainAtomicBalancesResponse = {
|
|
2817
|
+
balances: CChainAtomicBalances;
|
|
2818
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
2819
|
+
};
|
|
2820
|
+
|
|
2821
|
+
type AggregatedAssetAmount = {
|
|
2822
|
+
/**
|
|
2823
|
+
* Unique ID for an asset.
|
|
2824
|
+
*/
|
|
2825
|
+
assetId: string;
|
|
2826
|
+
/**
|
|
2827
|
+
* Name of this asset.
|
|
2828
|
+
*/
|
|
2829
|
+
name: string;
|
|
2830
|
+
/**
|
|
2831
|
+
* Symbol for this asset (max 4 characters).
|
|
2832
|
+
*/
|
|
2833
|
+
symbol: string;
|
|
2834
|
+
/**
|
|
2835
|
+
* Denomination of this asset to represent fungibility.
|
|
2836
|
+
*/
|
|
2837
|
+
denomination: number;
|
|
2838
|
+
type: PrimaryNetworkAssetType;
|
|
2839
|
+
/**
|
|
2840
|
+
* Amount of the asset.
|
|
2841
|
+
*/
|
|
2842
|
+
amount: string;
|
|
2843
|
+
utxoCount: number;
|
|
2844
|
+
};
|
|
2845
|
+
|
|
2846
|
+
type PChainSharedAsset = {
|
|
2847
|
+
/**
|
|
2848
|
+
* Unique ID for an asset.
|
|
2849
|
+
*/
|
|
2850
|
+
assetId: string;
|
|
2851
|
+
/**
|
|
2852
|
+
* Name of this asset.
|
|
2853
|
+
*/
|
|
2854
|
+
name: string;
|
|
2855
|
+
/**
|
|
2856
|
+
* Symbol for this asset (max 4 characters).
|
|
2857
|
+
*/
|
|
2858
|
+
symbol: string;
|
|
2859
|
+
/**
|
|
2860
|
+
* Denomination of this asset to represent fungibility.
|
|
2861
|
+
*/
|
|
2862
|
+
denomination: number;
|
|
2863
|
+
type: PrimaryNetworkAssetType;
|
|
2864
|
+
/**
|
|
2865
|
+
* Amount of the asset.
|
|
2866
|
+
*/
|
|
2867
|
+
amount: string;
|
|
2868
|
+
utxoCount: number;
|
|
2869
|
+
sharedWithChainId: string;
|
|
2870
|
+
status: string;
|
|
2871
|
+
};
|
|
2872
|
+
|
|
2873
|
+
type PChainBalance = {
|
|
2874
|
+
/**
|
|
2875
|
+
* A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of unstaked Avax that is consumable by any transaction.
|
|
2876
|
+
*/
|
|
2877
|
+
unlockedUnstaked: Array<AggregatedAssetAmount>;
|
|
2878
|
+
/**
|
|
2879
|
+
* A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of staked Avax that is consumable by any transaction when the staking period ends.
|
|
2880
|
+
*/
|
|
2881
|
+
unlockedStaked: Array<AggregatedAssetAmount>;
|
|
2882
|
+
/**
|
|
2883
|
+
* A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of unstaked Avax that is locked at the platform level and not consumable by any transaction at the current time.
|
|
2884
|
+
*/
|
|
2885
|
+
lockedPlatform: Array<AggregatedAssetAmount>;
|
|
2886
|
+
/**
|
|
2887
|
+
* A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of unstaked Avax that is locked at the platform level and only consumeable for staking transactions.
|
|
2888
|
+
*/
|
|
2889
|
+
lockedStakeable: Array<AggregatedAssetAmount>;
|
|
2890
|
+
/**
|
|
2891
|
+
* A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of staked Avax that will be locked when the staking period ends.
|
|
2892
|
+
*/
|
|
2893
|
+
lockedStaked: Array<AggregatedAssetAmount>;
|
|
2894
|
+
/**
|
|
2895
|
+
* A list of objects containing P-chain Asset basic info, amount, and utxo count of that Asset ID. Denotes the amount of staked Avax whose staking period has not yet started.
|
|
2896
|
+
*/
|
|
2897
|
+
pendingStaked: Array<AggregatedAssetAmount>;
|
|
2898
|
+
/**
|
|
2899
|
+
* A list of objects containing P-chain Asset basic info, amount and utxo count of that Asset ID. Denotes the amount of unlocked Avax in the atomic memory between P-Chain and other chain.
|
|
2900
|
+
*/
|
|
2901
|
+
atomicMemoryUnlocked: Array<PChainSharedAsset>;
|
|
2902
|
+
/**
|
|
2903
|
+
* A list of objects containing P-chain Asset basic info, amount and utxo count of that Asset ID. Denotes the amount of locked Avax in the atomic memory between P-Chain and other chain.
|
|
2904
|
+
*/
|
|
2905
|
+
atomicMemoryLocked: Array<PChainSharedAsset>;
|
|
2906
|
+
};
|
|
2907
|
+
|
|
2908
|
+
type ListPChainBalancesResponse = {
|
|
2909
|
+
balances: PChainBalance;
|
|
2910
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
2911
|
+
};
|
|
2912
|
+
|
|
2913
|
+
type XChainSharedAssetBalance = {
|
|
2914
|
+
/**
|
|
2915
|
+
* Unique ID for an asset.
|
|
2916
|
+
*/
|
|
2917
|
+
assetId: string;
|
|
2918
|
+
/**
|
|
2919
|
+
* Name of this asset.
|
|
2920
|
+
*/
|
|
2921
|
+
name: string;
|
|
2922
|
+
/**
|
|
2923
|
+
* Symbol for this asset (max 4 characters).
|
|
2924
|
+
*/
|
|
2925
|
+
symbol: string;
|
|
2926
|
+
/**
|
|
2927
|
+
* Denomination of this asset to represent fungibility.
|
|
2928
|
+
*/
|
|
2929
|
+
denomination: number;
|
|
2930
|
+
type: PrimaryNetworkAssetType;
|
|
2931
|
+
/**
|
|
2932
|
+
* Amount of the asset.
|
|
2933
|
+
*/
|
|
2934
|
+
amount: string;
|
|
2935
|
+
utxoCount: number;
|
|
2936
|
+
sharedWithChainId: string;
|
|
2937
|
+
};
|
|
2938
|
+
|
|
2939
|
+
type XChainBalances = {
|
|
2940
|
+
/**
|
|
2941
|
+
* A list of objects containing X-chain Asset balance information.
|
|
2942
|
+
*/
|
|
2943
|
+
locked: Array<AggregatedAssetAmount>;
|
|
2944
|
+
/**
|
|
2945
|
+
* A list of objects containing X-chain Asset balance information.
|
|
2946
|
+
*/
|
|
2947
|
+
unlocked: Array<AggregatedAssetAmount>;
|
|
2948
|
+
atomicMemoryUnlocked: Array<XChainSharedAssetBalance>;
|
|
2949
|
+
atomicMemoryLocked: Array<XChainSharedAssetBalance>;
|
|
2950
|
+
};
|
|
2951
|
+
|
|
2952
|
+
type ListXChainBalancesResponse = {
|
|
2953
|
+
balances: XChainBalances;
|
|
2954
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
2955
|
+
};
|
|
2956
|
+
|
|
2957
|
+
declare class PrimaryNetworkBalancesService {
|
|
2958
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2959
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2960
|
+
/**
|
|
2961
|
+
* Get balances
|
|
2962
|
+
* Gets primary network balances for one of the Primary Network chains for the supplied addresses.
|
|
2963
|
+
*
|
|
2964
|
+
* C-Chain balances returned are only the shared atomic memory balance. For EVM balance, use the `/v1/chains/:chainId/addresses/:addressId/balances:getNative` endpoint.
|
|
2965
|
+
* @returns any
|
|
2966
|
+
* @throws ApiError
|
|
2967
|
+
*/
|
|
2968
|
+
getBalancesByAddresses({ blockchainId, network, blockTimestamp, addresses, }: {
|
|
2969
|
+
/**
|
|
2970
|
+
* A primary network blockchain id or alias.
|
|
2971
|
+
*/
|
|
2972
|
+
blockchainId: BlockchainId;
|
|
2973
|
+
/**
|
|
2974
|
+
* Either mainnet or a testnet.
|
|
2975
|
+
*/
|
|
2976
|
+
network: Network;
|
|
2977
|
+
/**
|
|
2978
|
+
* An epoch timestamp in seconds. Balance will be calculated at this timestamp.
|
|
2979
|
+
*/
|
|
2980
|
+
blockTimestamp?: number;
|
|
2981
|
+
/**
|
|
2982
|
+
* 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".
|
|
2983
|
+
*/
|
|
2984
|
+
addresses?: string;
|
|
2985
|
+
}): CancelablePromise<(ListPChainBalancesResponse | ListXChainBalancesResponse | ListCChainAtomicBalancesResponse)>;
|
|
2986
|
+
}
|
|
2987
|
+
|
|
2988
|
+
type ProposerDetails = {
|
|
2989
|
+
proposerId?: string;
|
|
2990
|
+
proposerParentId?: string;
|
|
2991
|
+
proposerNodeId?: string;
|
|
2992
|
+
proposerPChainHeight?: number;
|
|
2993
|
+
proposerTimestamp?: number;
|
|
2994
|
+
};
|
|
2995
|
+
|
|
2996
|
+
type GetPrimaryNetworkBlockResponse = {
|
|
2997
|
+
blockNumber: string;
|
|
2998
|
+
blockHash: string;
|
|
2999
|
+
parentHash: string;
|
|
3000
|
+
blockTimestamp: number;
|
|
3001
|
+
blockType: string;
|
|
3002
|
+
txCount: number;
|
|
3003
|
+
transactions: Array<string>;
|
|
3004
|
+
blockSizeBytes: number;
|
|
3005
|
+
currentSupply?: string;
|
|
3006
|
+
proposerDetails?: ProposerDetails;
|
|
3007
|
+
};
|
|
3008
|
+
|
|
3009
|
+
type PrimaryNetworkBlock = {
|
|
3010
|
+
blockNumber: string;
|
|
3011
|
+
blockHash: string;
|
|
3012
|
+
parentHash: string;
|
|
3013
|
+
blockTimestamp: number;
|
|
3014
|
+
blockType: string;
|
|
3015
|
+
txCount: number;
|
|
3016
|
+
transactions: Array<string>;
|
|
3017
|
+
blockSizeBytes: number;
|
|
3018
|
+
currentSupply?: string;
|
|
3019
|
+
proposerDetails?: ProposerDetails;
|
|
3020
|
+
};
|
|
3021
|
+
|
|
3022
|
+
type ListPrimaryNetworkBlocksResponse = {
|
|
3023
|
+
/**
|
|
3024
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3025
|
+
*/
|
|
3026
|
+
nextPageToken?: string;
|
|
3027
|
+
blocks: Array<PrimaryNetworkBlock>;
|
|
3028
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
3029
|
+
};
|
|
3030
|
+
|
|
3031
|
+
declare class PrimaryNetworkBlocksService {
|
|
3032
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3033
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3034
|
+
/**
|
|
3035
|
+
* Get block
|
|
3036
|
+
* Gets a block by block height or block hash on one of the Primary Network chains.
|
|
3037
|
+
* @returns GetPrimaryNetworkBlockResponse
|
|
3038
|
+
* @throws ApiError
|
|
3039
|
+
*/
|
|
3040
|
+
getBlockById({ blockchainId, network, blockId, }: {
|
|
3041
|
+
/**
|
|
3042
|
+
* A primary network blockchain id or alias.
|
|
3043
|
+
*/
|
|
3044
|
+
blockchainId: BlockchainId;
|
|
3045
|
+
/**
|
|
3046
|
+
* Either mainnet or a testnet.
|
|
3047
|
+
*/
|
|
3048
|
+
network: Network;
|
|
3049
|
+
/**
|
|
3050
|
+
* A block identifier which is either a block number or the block hash.
|
|
3051
|
+
*/
|
|
3052
|
+
blockId: string;
|
|
3053
|
+
}): CancelablePromise<GetPrimaryNetworkBlockResponse>;
|
|
3054
|
+
/**
|
|
3055
|
+
* List blocks proposed by node
|
|
3056
|
+
* Lists the latest blocks proposed by a given NodeID on one of the Primary Network chains.
|
|
3057
|
+
* @returns ListPrimaryNetworkBlocksResponse
|
|
3058
|
+
* @throws ApiError
|
|
3059
|
+
*/
|
|
3060
|
+
listPrimaryNetworkBlocksByNodeId({ blockchainId, network, nodeId, pageToken, pageSize, }: {
|
|
3061
|
+
/**
|
|
3062
|
+
* A primary network blockchain id or alias.
|
|
3063
|
+
*/
|
|
3064
|
+
blockchainId: BlockchainId;
|
|
3065
|
+
/**
|
|
3066
|
+
* Either mainnet or a testnet.
|
|
3067
|
+
*/
|
|
3068
|
+
network: Network;
|
|
3069
|
+
/**
|
|
3070
|
+
* A primary network (P or X chain) nodeId.
|
|
3071
|
+
*/
|
|
3072
|
+
nodeId: string;
|
|
3073
|
+
/**
|
|
3074
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3075
|
+
*/
|
|
3076
|
+
pageToken?: string;
|
|
3077
|
+
/**
|
|
3078
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3079
|
+
*/
|
|
3080
|
+
pageSize?: number;
|
|
3081
|
+
}): CancelablePromise<ListPrimaryNetworkBlocksResponse>;
|
|
3082
|
+
/**
|
|
3083
|
+
* List latest blocks
|
|
3084
|
+
* Lists latest blocks on one of the Primary Network chains.
|
|
3085
|
+
* @returns ListPrimaryNetworkBlocksResponse
|
|
3086
|
+
* @throws ApiError
|
|
3087
|
+
*/
|
|
3088
|
+
listLatestPrimaryNetworkBlocks({ blockchainId, network, pageToken, pageSize, }: {
|
|
3089
|
+
/**
|
|
3090
|
+
* A primary network blockchain id or alias.
|
|
3091
|
+
*/
|
|
3092
|
+
blockchainId: BlockchainId;
|
|
3093
|
+
/**
|
|
3094
|
+
* Either mainnet or a testnet.
|
|
3095
|
+
*/
|
|
3096
|
+
network: Network;
|
|
3097
|
+
/**
|
|
3098
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3099
|
+
*/
|
|
3100
|
+
pageToken?: string;
|
|
3101
|
+
/**
|
|
3102
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3103
|
+
*/
|
|
3104
|
+
pageSize?: number;
|
|
3105
|
+
}): CancelablePromise<ListPrimaryNetworkBlocksResponse>;
|
|
3106
|
+
}
|
|
3107
|
+
|
|
3108
|
+
type AssetWithPriceInfo = {
|
|
3109
|
+
/**
|
|
3110
|
+
* Unique ID for an asset.
|
|
3111
|
+
*/
|
|
3112
|
+
assetId: string;
|
|
3113
|
+
/**
|
|
3114
|
+
* Name of this asset.
|
|
3115
|
+
*/
|
|
3116
|
+
name: string;
|
|
3117
|
+
/**
|
|
3118
|
+
* Symbol for this asset (max 4 characters).
|
|
3119
|
+
*/
|
|
3120
|
+
symbol: string;
|
|
3121
|
+
/**
|
|
3122
|
+
* Denomination of this asset to represent fungibility.
|
|
3123
|
+
*/
|
|
3124
|
+
denomination: number;
|
|
3125
|
+
type: PrimaryNetworkAssetType;
|
|
3126
|
+
/**
|
|
3127
|
+
* Amount of the asset.
|
|
3128
|
+
*/
|
|
3129
|
+
amount: string;
|
|
3130
|
+
/**
|
|
3131
|
+
* The historical asset price at the time the reward was granted, if available. Note, this is only provided if the reward occured more than 24 hours ago.
|
|
3132
|
+
*/
|
|
3133
|
+
historicalPrice?: Money;
|
|
3134
|
+
};
|
|
3135
|
+
|
|
3136
|
+
declare enum RewardType {
|
|
3137
|
+
VALIDATOR = "VALIDATOR",
|
|
3138
|
+
DELEGATOR = "DELEGATOR",
|
|
3139
|
+
VALIDATOR_FEE = "VALIDATOR_FEE"
|
|
3140
|
+
}
|
|
3141
|
+
|
|
3142
|
+
type HistoricalReward = {
|
|
3143
|
+
/**
|
|
3144
|
+
* An array of P-Chain wallet addresses.
|
|
3145
|
+
*/
|
|
3146
|
+
addresses: Array<string>;
|
|
3147
|
+
txHash: string;
|
|
3148
|
+
amountStaked: string;
|
|
3149
|
+
nodeId: string;
|
|
3150
|
+
startTimestamp: number;
|
|
3151
|
+
endTimestamp: number;
|
|
3152
|
+
rewardType: RewardType;
|
|
3153
|
+
utxoId: string;
|
|
3154
|
+
outputIndex: number;
|
|
3155
|
+
reward: AssetWithPriceInfo;
|
|
3156
|
+
rewardTxHash: string;
|
|
3157
|
+
};
|
|
3158
|
+
|
|
3159
|
+
type ListHistoricalRewardsResponse = {
|
|
3160
|
+
/**
|
|
3161
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3162
|
+
*/
|
|
3163
|
+
nextPageToken?: string;
|
|
3164
|
+
historicalRewards: Array<HistoricalReward>;
|
|
3165
|
+
};
|
|
3166
|
+
|
|
3167
|
+
type AssetAmount = {
|
|
3168
|
+
/**
|
|
3169
|
+
* Unique ID for an asset.
|
|
3170
|
+
*/
|
|
3171
|
+
assetId: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* Name of this asset.
|
|
3174
|
+
*/
|
|
3175
|
+
name: string;
|
|
3176
|
+
/**
|
|
3177
|
+
* Symbol for this asset (max 4 characters).
|
|
3178
|
+
*/
|
|
3179
|
+
symbol: string;
|
|
3180
|
+
/**
|
|
3181
|
+
* Denomination of this asset to represent fungibility.
|
|
3182
|
+
*/
|
|
3183
|
+
denomination: number;
|
|
3184
|
+
type: PrimaryNetworkAssetType;
|
|
3185
|
+
/**
|
|
3186
|
+
* Amount of the asset.
|
|
3187
|
+
*/
|
|
3188
|
+
amount: string;
|
|
3189
|
+
};
|
|
3190
|
+
|
|
3191
|
+
type PendingReward = {
|
|
3192
|
+
/**
|
|
3193
|
+
* An array of P-Chain wallet addresses.
|
|
3194
|
+
*/
|
|
3195
|
+
addresses: Array<string>;
|
|
3196
|
+
txHash: string;
|
|
3197
|
+
amountStaked: string;
|
|
3198
|
+
nodeId: string;
|
|
3199
|
+
startTimestamp: number;
|
|
3200
|
+
endTimestamp: number;
|
|
3201
|
+
rewardType: RewardType;
|
|
3202
|
+
progress: number;
|
|
3203
|
+
/**
|
|
3204
|
+
* An object containing P-chain Asset basic info and the amount of that Asset ID.
|
|
3205
|
+
*/
|
|
3206
|
+
estimatedReward: AssetAmount;
|
|
3207
|
+
};
|
|
3208
|
+
|
|
3209
|
+
type ListPendingRewardsResponse = {
|
|
3210
|
+
/**
|
|
3211
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3212
|
+
*/
|
|
3213
|
+
nextPageToken?: string;
|
|
3214
|
+
pendingRewards: Array<PendingReward>;
|
|
3215
|
+
};
|
|
3216
|
+
|
|
3217
|
+
declare class PrimaryNetworkRewardsService {
|
|
3218
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3219
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3220
|
+
/**
|
|
3221
|
+
* List pending rewards
|
|
3222
|
+
* Lists pending rewards on the Primary Network for the supplied addresses.
|
|
3223
|
+
* @returns ListPendingRewardsResponse
|
|
3224
|
+
* @throws ApiError
|
|
3225
|
+
*/
|
|
3226
|
+
listPendingPrimaryNetworkRewards({ network, addresses, pageToken, pageSize, nodeIds, sortOrder, }: {
|
|
3227
|
+
/**
|
|
3228
|
+
* Either mainnet or a testnet.
|
|
3229
|
+
*/
|
|
3230
|
+
network: Network;
|
|
3231
|
+
/**
|
|
3232
|
+
* 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". One of addresses or nodeIds is required.
|
|
3233
|
+
*/
|
|
3234
|
+
addresses?: string;
|
|
3235
|
+
/**
|
|
3236
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3237
|
+
*/
|
|
3238
|
+
pageToken?: string;
|
|
3239
|
+
/**
|
|
3240
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3241
|
+
*/
|
|
3242
|
+
pageSize?: number;
|
|
3243
|
+
/**
|
|
3244
|
+
* A comma separated list of node ids to filter by. One of addresses or nodeIds is required.
|
|
3245
|
+
*/
|
|
3246
|
+
nodeIds?: string;
|
|
3247
|
+
/**
|
|
3248
|
+
* 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.
|
|
3249
|
+
*/
|
|
3250
|
+
sortOrder?: SortOrder;
|
|
3251
|
+
}): CancelablePromise<ListPendingRewardsResponse>;
|
|
3252
|
+
/**
|
|
3253
|
+
* List historical rewards
|
|
3254
|
+
* Lists historical rewards on the Primary Network for the supplied addresses.
|
|
3255
|
+
* @returns ListHistoricalRewardsResponse
|
|
3256
|
+
* @throws ApiError
|
|
3257
|
+
*/
|
|
3258
|
+
listHistoricalPrimaryNetworkRewards({ network, addresses, pageToken, pageSize, nodeIds, sortOrder, currency, }: {
|
|
3259
|
+
/**
|
|
3260
|
+
* Either mainnet or a testnet.
|
|
3261
|
+
*/
|
|
3262
|
+
network: Network;
|
|
3263
|
+
/**
|
|
3264
|
+
* 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". Optional, but at least one of addresses or nodeIds is required.
|
|
3265
|
+
*/
|
|
3266
|
+
addresses?: string;
|
|
3267
|
+
/**
|
|
3268
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3269
|
+
*/
|
|
3270
|
+
pageToken?: string;
|
|
3271
|
+
/**
|
|
3272
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3273
|
+
*/
|
|
3274
|
+
pageSize?: number;
|
|
3275
|
+
/**
|
|
3276
|
+
* A comma separated list of node ids to filter by. Optional, but at least one of addresses or nodeIds is required.
|
|
3277
|
+
*/
|
|
3278
|
+
nodeIds?: string;
|
|
3279
|
+
/**
|
|
3280
|
+
* 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.
|
|
3281
|
+
*/
|
|
3282
|
+
sortOrder?: SortOrder;
|
|
3283
|
+
/**
|
|
3284
|
+
* The currency that return values should use. Defaults to USD.
|
|
3285
|
+
*/
|
|
3286
|
+
currency?: CurrencyCode;
|
|
3287
|
+
}): CancelablePromise<ListHistoricalRewardsResponse>;
|
|
3288
|
+
}
|
|
3289
|
+
|
|
3290
|
+
type UtxoCredential = {
|
|
3291
|
+
/**
|
|
3292
|
+
* Signature provided to consume the output.
|
|
3293
|
+
*/
|
|
3294
|
+
signature?: string;
|
|
3295
|
+
/**
|
|
3296
|
+
* Public key associated with the signature.
|
|
3297
|
+
*/
|
|
3298
|
+
publicKey?: string;
|
|
3299
|
+
};
|
|
3300
|
+
|
|
3301
|
+
type EVMInput = {
|
|
3302
|
+
/**
|
|
3303
|
+
* EVM address from which the asset is exported in ExportTx.
|
|
3304
|
+
*/
|
|
3305
|
+
fromAddress: string;
|
|
3306
|
+
/**
|
|
3307
|
+
* AssetAmount details for the asset being transferred.
|
|
3308
|
+
*/
|
|
3309
|
+
asset: AssetAmount;
|
|
3310
|
+
/**
|
|
3311
|
+
* Credentials that signed this transaction.
|
|
3312
|
+
*/
|
|
3313
|
+
credentials: Array<UtxoCredential>;
|
|
3314
|
+
};
|
|
3315
|
+
|
|
3316
|
+
type Utxo = {
|
|
3317
|
+
/**
|
|
3318
|
+
* Addresses that are eligible to sign the consumption of this output.
|
|
3319
|
+
*/
|
|
3320
|
+
addresses: Array<string>;
|
|
3321
|
+
asset: AssetAmount;
|
|
3322
|
+
/**
|
|
3323
|
+
* Blockchain ID on which this output is consumed on.
|
|
3324
|
+
*/
|
|
3325
|
+
consumedOnChainId: string;
|
|
3326
|
+
/**
|
|
3327
|
+
* Transaction ID that consumed this output.
|
|
3328
|
+
*/
|
|
3329
|
+
consumingTxHash?: string;
|
|
3330
|
+
/**
|
|
3331
|
+
* Blockchain ID on which this output is created on.
|
|
3332
|
+
*/
|
|
3333
|
+
createdOnChainId: string;
|
|
3334
|
+
/**
|
|
3335
|
+
* UTXO ID for this output.
|
|
3336
|
+
*/
|
|
3337
|
+
utxoId: string;
|
|
3338
|
+
/**
|
|
3339
|
+
* Unix timestamp in seconds at which this output was consumed.
|
|
3340
|
+
*/
|
|
3341
|
+
consumingTxTimestamp?: number;
|
|
3342
|
+
/**
|
|
3343
|
+
* Transaction ID that created this output.
|
|
3344
|
+
*/
|
|
3345
|
+
creationTxHash: string;
|
|
3346
|
+
/**
|
|
3347
|
+
* Credentials that signed the transaction to consume this utxo
|
|
3348
|
+
*/
|
|
3349
|
+
credentials?: Array<UtxoCredential>;
|
|
3350
|
+
/**
|
|
3351
|
+
* Index representing the minting set for the NFT mint output.
|
|
3352
|
+
*/
|
|
3353
|
+
groupId?: number;
|
|
3354
|
+
/**
|
|
3355
|
+
* Locktime in seconds after which this output can be consumed.
|
|
3356
|
+
*/
|
|
3357
|
+
locktime: number;
|
|
3358
|
+
/**
|
|
3359
|
+
* Postion of this output in a list of lexiographically sorted outputs of a transaction.
|
|
3360
|
+
*/
|
|
3361
|
+
outputIndex: string;
|
|
3362
|
+
/**
|
|
3363
|
+
* Hex encoded data for NFT assets.
|
|
3364
|
+
*/
|
|
3365
|
+
payload?: string;
|
|
3366
|
+
/**
|
|
3367
|
+
* Minimum number of signatures required to consume this output.
|
|
3368
|
+
*/
|
|
3369
|
+
threshold: number;
|
|
3370
|
+
/**
|
|
3371
|
+
* Unix timestamp in seconds at which this outptut was created.
|
|
3372
|
+
*/
|
|
3373
|
+
timestamp: number;
|
|
3374
|
+
/**
|
|
3375
|
+
* Type of output.
|
|
3376
|
+
*/
|
|
3377
|
+
utxoType: string;
|
|
3378
|
+
};
|
|
3379
|
+
|
|
3380
|
+
type CChainExportTransaction = {
|
|
3381
|
+
/**
|
|
3382
|
+
* Unique ID for this transaction.
|
|
3383
|
+
*/
|
|
3384
|
+
txHash: string;
|
|
3385
|
+
/**
|
|
3386
|
+
* Height of the block this transaction belongs to.
|
|
3387
|
+
*/
|
|
3388
|
+
blockHeight: number;
|
|
3389
|
+
/**
|
|
3390
|
+
* Hash of the block this transaction belongs to.
|
|
3391
|
+
*/
|
|
3392
|
+
blockHash: string;
|
|
3393
|
+
/**
|
|
3394
|
+
* Latest timestamp in seconds this transaction was accepted.
|
|
3395
|
+
*/
|
|
3396
|
+
timestamp: number;
|
|
3397
|
+
/**
|
|
3398
|
+
* Hex encoded memo bytes for this transaction.
|
|
3399
|
+
*/
|
|
3400
|
+
memo: string;
|
|
3401
|
+
/**
|
|
3402
|
+
* Assets unlocked by inputs of this transaction.
|
|
3403
|
+
*/
|
|
3404
|
+
amountUnlocked: Array<AssetAmount>;
|
|
3405
|
+
/**
|
|
3406
|
+
* Assets created by outputs of this transaction.
|
|
3407
|
+
*/
|
|
3408
|
+
amountCreated: Array<AssetAmount>;
|
|
3409
|
+
/**
|
|
3410
|
+
* Source chain for an atomic transaction.
|
|
3411
|
+
*/
|
|
3412
|
+
sourceChain: string;
|
|
3413
|
+
/**
|
|
3414
|
+
* Destination chain for an atomic transaction.
|
|
3415
|
+
*/
|
|
3416
|
+
destinationChain: string;
|
|
3417
|
+
/**
|
|
3418
|
+
* Type of transaction.
|
|
3419
|
+
*/
|
|
3420
|
+
txType: CChainExportTransaction.txType;
|
|
3421
|
+
evmInputs: Array<EVMInput>;
|
|
3422
|
+
emittedUtxos: Array<Utxo>;
|
|
3423
|
+
};
|
|
3424
|
+
declare namespace CChainExportTransaction {
|
|
3425
|
+
/**
|
|
3426
|
+
* Type of transaction.
|
|
3427
|
+
*/
|
|
3428
|
+
enum txType {
|
|
3429
|
+
EXPORT_TX = "ExportTx"
|
|
3430
|
+
}
|
|
3431
|
+
}
|
|
3432
|
+
|
|
3433
|
+
type EVMOutput = {
|
|
3434
|
+
/**
|
|
3435
|
+
* EVM address to which the asset is imported in ImportTx
|
|
3436
|
+
*/
|
|
3437
|
+
toAddress: string;
|
|
3438
|
+
/**
|
|
3439
|
+
* AssetAmount details for the asset being transferred.
|
|
3440
|
+
*/
|
|
3441
|
+
asset: AssetAmount;
|
|
3442
|
+
};
|
|
3443
|
+
|
|
3444
|
+
type CChainImportTransaction = {
|
|
3445
|
+
/**
|
|
3446
|
+
* Unique ID for this transaction.
|
|
3447
|
+
*/
|
|
3448
|
+
txHash: string;
|
|
3449
|
+
/**
|
|
3450
|
+
* Height of the block this transaction belongs to.
|
|
3451
|
+
*/
|
|
3452
|
+
blockHeight: number;
|
|
3453
|
+
/**
|
|
3454
|
+
* Hash of the block this transaction belongs to.
|
|
3455
|
+
*/
|
|
3456
|
+
blockHash: string;
|
|
3457
|
+
/**
|
|
3458
|
+
* Latest timestamp in seconds this transaction was accepted.
|
|
3459
|
+
*/
|
|
3460
|
+
timestamp: number;
|
|
3461
|
+
/**
|
|
3462
|
+
* Hex encoded memo bytes for this transaction.
|
|
3463
|
+
*/
|
|
3464
|
+
memo: string;
|
|
3465
|
+
/**
|
|
3466
|
+
* Assets unlocked by inputs of this transaction.
|
|
3467
|
+
*/
|
|
3468
|
+
amountUnlocked: Array<AssetAmount>;
|
|
3469
|
+
/**
|
|
3470
|
+
* Assets created by outputs of this transaction.
|
|
3471
|
+
*/
|
|
3472
|
+
amountCreated: Array<AssetAmount>;
|
|
3473
|
+
/**
|
|
3474
|
+
* Source chain for an atomic transaction.
|
|
3475
|
+
*/
|
|
3476
|
+
sourceChain: string;
|
|
3477
|
+
/**
|
|
3478
|
+
* Destination chain for an atomic transaction.
|
|
3479
|
+
*/
|
|
3480
|
+
destinationChain: string;
|
|
3481
|
+
/**
|
|
3482
|
+
* Type of transaction.
|
|
3483
|
+
*/
|
|
3484
|
+
txType: CChainImportTransaction.txType;
|
|
3485
|
+
evmOutputs: Array<EVMOutput>;
|
|
3486
|
+
consumedUtxos: Array<Utxo>;
|
|
3487
|
+
};
|
|
3488
|
+
declare namespace CChainImportTransaction {
|
|
3489
|
+
/**
|
|
3490
|
+
* Type of transaction.
|
|
3491
|
+
*/
|
|
3492
|
+
enum txType {
|
|
3493
|
+
IMPORT_TX = "ImportTx"
|
|
3494
|
+
}
|
|
3495
|
+
}
|
|
3496
|
+
|
|
3497
|
+
type ListCChainAtomicTransactionsResponse = {
|
|
3498
|
+
/**
|
|
3499
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3500
|
+
*/
|
|
3501
|
+
nextPageToken?: string;
|
|
3502
|
+
transactions: Array<(CChainExportTransaction | CChainImportTransaction)>;
|
|
3503
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
3504
|
+
};
|
|
3505
|
+
|
|
3506
|
+
declare enum PChainTransactionType {
|
|
3507
|
+
ADD_VALIDATOR_TX = "AddValidatorTx",
|
|
3508
|
+
ADD_SUBNET_VALIDATOR_TX = "AddSubnetValidatorTx",
|
|
3509
|
+
ADD_DELEGATOR_TX = "AddDelegatorTx",
|
|
3510
|
+
CREATE_CHAIN_TX = "CreateChainTx",
|
|
3511
|
+
CREATE_SUBNET_TX = "CreateSubnetTx",
|
|
3512
|
+
IMPORT_TX = "ImportTx",
|
|
3513
|
+
EXPORT_TX = "ExportTx",
|
|
3514
|
+
ADVANCE_TIME_TX = "AdvanceTimeTx",
|
|
3515
|
+
REWARD_VALIDATOR_TX = "RewardValidatorTx",
|
|
3516
|
+
REMOVE_SUBNET_VALIDATOR_TX = "RemoveSubnetValidatorTx",
|
|
3517
|
+
TRANSFORM_SUBNET_TX = "TransformSubnetTx",
|
|
3518
|
+
ADD_PERMISSIONLESS_VALIDATOR_TX = "AddPermissionlessValidatorTx",
|
|
3519
|
+
ADD_PERMISSIONLESS_DELEGATOR_TX = "AddPermissionlessDelegatorTx",
|
|
3520
|
+
BASE_TX = "BaseTx",
|
|
3521
|
+
TRANSFER_SUBNET_OWNERSHIP_TX = "TransferSubnetOwnershipTx",
|
|
3522
|
+
UNKNOWN = "UNKNOWN"
|
|
3523
|
+
}
|
|
3524
|
+
|
|
3525
|
+
declare enum UtxoType {
|
|
3526
|
+
STAKE = "STAKE",
|
|
3527
|
+
TRANSFER = "TRANSFER"
|
|
3528
|
+
}
|
|
3529
|
+
|
|
3530
|
+
type PChainUtxo = {
|
|
3531
|
+
/**
|
|
3532
|
+
* Addresses that are eligible to sign the consumption of this output.
|
|
3533
|
+
*/
|
|
3534
|
+
addresses: Array<string>;
|
|
3535
|
+
asset: AssetAmount;
|
|
3536
|
+
/**
|
|
3537
|
+
* Blockchain ID on which this output is consumed on.
|
|
3538
|
+
*/
|
|
3539
|
+
consumedOnChainId: string;
|
|
3540
|
+
/**
|
|
3541
|
+
* Transaction ID that consumed this output.
|
|
3542
|
+
*/
|
|
3543
|
+
consumingTxHash?: string;
|
|
3544
|
+
/**
|
|
3545
|
+
* Blockchain ID on which this output is created on.
|
|
3546
|
+
*/
|
|
3547
|
+
createdOnChainId: string;
|
|
3548
|
+
/**
|
|
3549
|
+
* UTXO ID for this output.
|
|
3550
|
+
*/
|
|
3551
|
+
utxoId: string;
|
|
3552
|
+
/**
|
|
3553
|
+
* @deprecated
|
|
3554
|
+
*/
|
|
3555
|
+
amount: string;
|
|
3556
|
+
/**
|
|
3557
|
+
* @deprecated
|
|
3558
|
+
*/
|
|
3559
|
+
assetId: string;
|
|
3560
|
+
blockNumber: string;
|
|
3561
|
+
blockTimestamp: number;
|
|
3562
|
+
consumingBlockNumber?: string;
|
|
3563
|
+
consumingBlockTimestamp?: number;
|
|
3564
|
+
platformLocktime?: number;
|
|
3565
|
+
outputIndex: number;
|
|
3566
|
+
rewardType?: RewardType;
|
|
3567
|
+
stakeableLocktime?: number;
|
|
3568
|
+
staked?: boolean;
|
|
3569
|
+
threshold?: number;
|
|
3570
|
+
txHash: string;
|
|
3571
|
+
utxoEndTimestamp?: number;
|
|
3572
|
+
utxoStartTimestamp?: number;
|
|
3573
|
+
utxoType: UtxoType;
|
|
3574
|
+
};
|
|
3575
|
+
|
|
3576
|
+
type PChainTransaction = {
|
|
3577
|
+
/**
|
|
3578
|
+
* A P-Chain transaction hash.
|
|
3579
|
+
*/
|
|
3580
|
+
txHash: string;
|
|
3581
|
+
txType: PChainTransactionType;
|
|
3582
|
+
/**
|
|
3583
|
+
* The block finality timestamp.
|
|
3584
|
+
*/
|
|
3585
|
+
blockTimestamp: number;
|
|
3586
|
+
blockNumber: string;
|
|
3587
|
+
blockHash: string;
|
|
3588
|
+
consumedUtxos: Array<PChainUtxo>;
|
|
3589
|
+
emittedUtxos: Array<PChainUtxo>;
|
|
3590
|
+
/**
|
|
3591
|
+
* Source chain for an atomic transaction.
|
|
3592
|
+
*/
|
|
3593
|
+
sourceChain?: string;
|
|
3594
|
+
/**
|
|
3595
|
+
* Destination chain for an atomic transaction.
|
|
3596
|
+
*/
|
|
3597
|
+
destinationChain?: string;
|
|
3598
|
+
/**
|
|
3599
|
+
* A list of objects containing P-chain Asset basic info and the amount of that Asset ID.
|
|
3600
|
+
*/
|
|
3601
|
+
value: Array<AssetAmount>;
|
|
3602
|
+
/**
|
|
3603
|
+
* A list of objects containing P-chain Asset basic info and the amount of that Asset ID.
|
|
3604
|
+
*/
|
|
3605
|
+
amountBurned: Array<AssetAmount>;
|
|
3606
|
+
/**
|
|
3607
|
+
* A list of objects containing P-chain Asset basic info and the amount of that Asset ID. Present for AddValidatorTx, AddPermissionlessValidatorTx, AddDelegatorTx
|
|
3608
|
+
*/
|
|
3609
|
+
amountStaked: Array<AssetAmount>;
|
|
3610
|
+
/**
|
|
3611
|
+
* Present for AddValidatorTx, AddSubnetValidatorTx, AddPermissionlessValidatorTx, AddDelegatorTx
|
|
3612
|
+
*/
|
|
3613
|
+
startTimestamp?: number;
|
|
3614
|
+
/**
|
|
3615
|
+
* Present for AddValidatorTx, AddSubnetValidatorTx, AddPermissionlessValidatorTx, AddDelegatorTx
|
|
3616
|
+
*/
|
|
3617
|
+
endTimestamp?: number;
|
|
3618
|
+
/**
|
|
3619
|
+
* Present for AddValidatorTx, AddPermissionlessValidatorTx
|
|
3620
|
+
*/
|
|
3621
|
+
delegationFeePercent?: string;
|
|
3622
|
+
/**
|
|
3623
|
+
* Present for AddValidatorTx, AddSubnetValidatorTx, RemoveSubnetValidatorTx, AddPermissionlessValidatorTx, AddDelegatorTx
|
|
3624
|
+
*/
|
|
3625
|
+
nodeId?: string;
|
|
3626
|
+
/**
|
|
3627
|
+
* Present for AddValidatorTx, AddSubnetValidatorTx, RemoveSubnetValidatorTx, AddPermissionlessValidatorTx, AddDelegatorTx, CreateChainTx, CreateSubnetTx
|
|
3628
|
+
*/
|
|
3629
|
+
subnetId?: string;
|
|
3630
|
+
/**
|
|
3631
|
+
* Present for AddValidatorTx, AddPermissionlessValidatorTx, AddDelegatorTx
|
|
3632
|
+
*/
|
|
3633
|
+
estimatedReward?: string;
|
|
3634
|
+
rewardTxHash?: string;
|
|
3635
|
+
rewardAddresses?: Array<string>;
|
|
3636
|
+
memo?: string;
|
|
3637
|
+
/**
|
|
3638
|
+
* Present for RewardValidatorTx
|
|
3639
|
+
*/
|
|
3640
|
+
stakingTxHash?: string;
|
|
3641
|
+
/**
|
|
3642
|
+
* Subnet owner details for the CreateSubnetTx or TransferSubnetOwnershipTx
|
|
3643
|
+
*/
|
|
3644
|
+
subnetOwnershipInfo?: SubnetOwnershipInfo;
|
|
3645
|
+
/**
|
|
3646
|
+
* Present for AddPermissionlessValidatorTx
|
|
3647
|
+
*/
|
|
3648
|
+
blsCredentials?: BlsCredentials;
|
|
3649
|
+
};
|
|
3650
|
+
|
|
3651
|
+
type ListPChainTransactionsResponse = {
|
|
3652
|
+
/**
|
|
3653
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3654
|
+
*/
|
|
3655
|
+
nextPageToken?: string;
|
|
3656
|
+
transactions: Array<PChainTransaction>;
|
|
3657
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
3658
|
+
};
|
|
3659
|
+
|
|
3660
|
+
/**
|
|
3661
|
+
* Type of transaction.
|
|
3662
|
+
*/
|
|
3663
|
+
declare enum XChainTransactionType {
|
|
3664
|
+
BASE_TX = "BaseTx",
|
|
3665
|
+
CREATE_ASSET_TX = "CreateAssetTx",
|
|
3666
|
+
OPERATION_TX = "OperationTx",
|
|
3667
|
+
IMPORT_TX = "ImportTx",
|
|
3668
|
+
EXPORT_TX = "ExportTx",
|
|
3669
|
+
UNKNOWN = "UNKNOWN"
|
|
3670
|
+
}
|
|
3671
|
+
|
|
3672
|
+
type XChainLinearTransaction = {
|
|
3673
|
+
/**
|
|
3674
|
+
* Unique ID for this transaction.
|
|
3675
|
+
*/
|
|
3676
|
+
txHash: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* Represents chain format this transaction is included in.
|
|
3679
|
+
*/
|
|
3680
|
+
chainFormat: XChainLinearTransaction.chainFormat;
|
|
3681
|
+
/**
|
|
3682
|
+
* Latest timestamp in seconds this transaction was accepted out of the same transaction accepted in other vertices.
|
|
3683
|
+
*/
|
|
3684
|
+
timestamp: number;
|
|
3685
|
+
txType: XChainTransactionType;
|
|
3686
|
+
/**
|
|
3687
|
+
* Hex encoded memo bytes for this transaction.
|
|
3688
|
+
*/
|
|
3689
|
+
memo: string;
|
|
3690
|
+
consumedUtxos: Array<Utxo>;
|
|
3691
|
+
emittedUtxos: Array<Utxo>;
|
|
3692
|
+
/**
|
|
3693
|
+
* Assets unlocked by inputs of this transaction.
|
|
3694
|
+
*/
|
|
3695
|
+
amountUnlocked: Array<AssetAmount>;
|
|
3696
|
+
/**
|
|
3697
|
+
* Assets created by outputs of this transaction.
|
|
3698
|
+
*/
|
|
3699
|
+
amountCreated: Array<AssetAmount>;
|
|
3700
|
+
/**
|
|
3701
|
+
* Source chain for an atomic transaction.
|
|
3702
|
+
*/
|
|
3703
|
+
sourceChain?: string;
|
|
3704
|
+
/**
|
|
3705
|
+
* Destination chain for an atomic transaction.
|
|
3706
|
+
*/
|
|
3707
|
+
destinationChain?: string;
|
|
3708
|
+
/**
|
|
3709
|
+
* AssetAmount details of the asset created in CreateAssetTx
|
|
3710
|
+
*/
|
|
3711
|
+
assetCreated?: XChainAssetDetails;
|
|
3712
|
+
/**
|
|
3713
|
+
* Height of the block this transaction belongs to.
|
|
3714
|
+
*/
|
|
3715
|
+
blockHeight: number;
|
|
3716
|
+
/**
|
|
3717
|
+
* Hash of the block this transaction belongs to.
|
|
3718
|
+
*/
|
|
3719
|
+
blockHash: string;
|
|
3720
|
+
};
|
|
3721
|
+
declare namespace XChainLinearTransaction {
|
|
3722
|
+
/**
|
|
3723
|
+
* Represents chain format this transaction is included in.
|
|
3724
|
+
*/
|
|
3725
|
+
enum chainFormat {
|
|
3726
|
+
NON_LINEAR = "non-linear",
|
|
3727
|
+
LINEAR = "linear"
|
|
3728
|
+
}
|
|
272
3729
|
}
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
3730
|
+
|
|
3731
|
+
type TransactionVertexDetail = {
|
|
3732
|
+
/**
|
|
3733
|
+
* Vertex ID of the vertex this transaction belongs to.
|
|
3734
|
+
*/
|
|
3735
|
+
hash: string;
|
|
3736
|
+
/**
|
|
3737
|
+
* Vertex height of the vertex this transaction belongs to.
|
|
3738
|
+
*/
|
|
3739
|
+
height: number;
|
|
3740
|
+
/**
|
|
3741
|
+
* Timestamp in seconds this vertex was accepted.
|
|
3742
|
+
*/
|
|
3743
|
+
timestamp: number;
|
|
3744
|
+
};
|
|
3745
|
+
|
|
3746
|
+
type XChainNonLinearTransaction = {
|
|
3747
|
+
/**
|
|
3748
|
+
* Unique ID for this transaction.
|
|
3749
|
+
*/
|
|
3750
|
+
txHash: string;
|
|
3751
|
+
/**
|
|
3752
|
+
* Represents chain format this transaction is included in.
|
|
3753
|
+
*/
|
|
3754
|
+
chainFormat: XChainNonLinearTransaction.chainFormat;
|
|
3755
|
+
/**
|
|
3756
|
+
* Latest timestamp in seconds this transaction was accepted out of the same transaction accepted in other vertices.
|
|
3757
|
+
*/
|
|
3758
|
+
timestamp: number;
|
|
3759
|
+
txType: XChainTransactionType;
|
|
3760
|
+
/**
|
|
3761
|
+
* Hex encoded memo bytes for this transaction.
|
|
3762
|
+
*/
|
|
3763
|
+
memo: string;
|
|
3764
|
+
consumedUtxos: Array<Utxo>;
|
|
3765
|
+
emittedUtxos: Array<Utxo>;
|
|
3766
|
+
/**
|
|
3767
|
+
* Assets unlocked by inputs of this transaction.
|
|
3768
|
+
*/
|
|
3769
|
+
amountUnlocked: Array<AssetAmount>;
|
|
3770
|
+
/**
|
|
3771
|
+
* Assets created by outputs of this transaction.
|
|
3772
|
+
*/
|
|
3773
|
+
amountCreated: Array<AssetAmount>;
|
|
3774
|
+
/**
|
|
3775
|
+
* Source chain for an atomic transaction.
|
|
3776
|
+
*/
|
|
3777
|
+
sourceChain?: string;
|
|
3778
|
+
/**
|
|
3779
|
+
* Destination chain for an atomic transaction.
|
|
3780
|
+
*/
|
|
3781
|
+
destinationChain?: string;
|
|
3782
|
+
/**
|
|
3783
|
+
* AssetAmount details of the asset created in CreateAssetTx
|
|
3784
|
+
*/
|
|
3785
|
+
assetCreated?: XChainAssetDetails;
|
|
3786
|
+
/**
|
|
3787
|
+
* A transaction on X-Chain can be accepted over multiple vertices.
|
|
3788
|
+
*/
|
|
3789
|
+
vertices: Array<TransactionVertexDetail>;
|
|
3790
|
+
};
|
|
3791
|
+
declare namespace XChainNonLinearTransaction {
|
|
3792
|
+
/**
|
|
3793
|
+
* Represents chain format this transaction is included in.
|
|
3794
|
+
*/
|
|
3795
|
+
enum chainFormat {
|
|
3796
|
+
NON_LINEAR = "non-linear",
|
|
3797
|
+
LINEAR = "linear"
|
|
3798
|
+
}
|
|
278
3799
|
}
|
|
279
|
-
|
|
280
|
-
|
|
3800
|
+
|
|
3801
|
+
type ListXChainTransactionsResponse = {
|
|
3802
|
+
/**
|
|
3803
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3804
|
+
*/
|
|
281
3805
|
nextPageToken?: string;
|
|
282
|
-
transactions:
|
|
3806
|
+
transactions: Array<(XChainNonLinearTransaction | XChainLinearTransaction)>;
|
|
3807
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
3808
|
+
};
|
|
3809
|
+
|
|
3810
|
+
declare enum PChainId {
|
|
3811
|
+
_11111111111111111111111111111111LPO_YY = "11111111111111111111111111111111LpoYY",
|
|
3812
|
+
P_CHAIN = "p-chain"
|
|
283
3813
|
}
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
3814
|
+
|
|
3815
|
+
declare enum PrimaryNetworkTxType {
|
|
3816
|
+
ADD_VALIDATOR_TX = "AddValidatorTx",
|
|
3817
|
+
ADD_SUBNET_VALIDATOR_TX = "AddSubnetValidatorTx",
|
|
3818
|
+
ADD_DELEGATOR_TX = "AddDelegatorTx",
|
|
3819
|
+
CREATE_CHAIN_TX = "CreateChainTx",
|
|
3820
|
+
CREATE_SUBNET_TX = "CreateSubnetTx",
|
|
3821
|
+
IMPORT_TX = "ImportTx",
|
|
3822
|
+
EXPORT_TX = "ExportTx",
|
|
3823
|
+
ADVANCE_TIME_TX = "AdvanceTimeTx",
|
|
3824
|
+
REWARD_VALIDATOR_TX = "RewardValidatorTx",
|
|
3825
|
+
REMOVE_SUBNET_VALIDATOR_TX = "RemoveSubnetValidatorTx",
|
|
3826
|
+
TRANSFORM_SUBNET_TX = "TransformSubnetTx",
|
|
3827
|
+
ADD_PERMISSIONLESS_VALIDATOR_TX = "AddPermissionlessValidatorTx",
|
|
3828
|
+
ADD_PERMISSIONLESS_DELEGATOR_TX = "AddPermissionlessDelegatorTx",
|
|
3829
|
+
BASE_TX = "BaseTx",
|
|
3830
|
+
TRANSFER_SUBNET_OWNERSHIP_TX = "TransferSubnetOwnershipTx",
|
|
3831
|
+
UNKNOWN = "UNKNOWN",
|
|
3832
|
+
CREATE_ASSET_TX = "CreateAssetTx",
|
|
3833
|
+
OPERATION_TX = "OperationTx"
|
|
288
3834
|
}
|
|
289
|
-
|
|
3835
|
+
|
|
3836
|
+
declare class PrimaryNetworkTransactionsService {
|
|
3837
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3838
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
290
3839
|
/**
|
|
291
|
-
*
|
|
292
|
-
*
|
|
3840
|
+
* Get transaction
|
|
3841
|
+
* Gets the details of a single transaction on one of the Primary Network chains.
|
|
3842
|
+
* @returns any
|
|
3843
|
+
* @throws ApiError
|
|
293
3844
|
*/
|
|
294
|
-
|
|
3845
|
+
getTxByHash({ blockchainId, network, txHash, }: {
|
|
3846
|
+
/**
|
|
3847
|
+
* A primary network blockchain id or alias.
|
|
3848
|
+
*/
|
|
3849
|
+
blockchainId: BlockchainId;
|
|
3850
|
+
/**
|
|
3851
|
+
* Either mainnet or a testnet.
|
|
3852
|
+
*/
|
|
3853
|
+
network: Network;
|
|
3854
|
+
/**
|
|
3855
|
+
* A primary network (P or X chain) transaction hash.
|
|
3856
|
+
*/
|
|
3857
|
+
txHash: string;
|
|
3858
|
+
}): CancelablePromise<(PChainTransaction | XChainNonLinearTransaction | XChainLinearTransaction | CChainExportTransaction | CChainImportTransaction)>;
|
|
295
3859
|
/**
|
|
296
|
-
*
|
|
297
|
-
*
|
|
3860
|
+
* List latest transactions
|
|
3861
|
+
* Lists the latest transactions on one of the Primary Network chains.
|
|
3862
|
+
*
|
|
3863
|
+
* 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.
|
|
3864
|
+
*
|
|
3865
|
+
* 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.
|
|
3866
|
+
* @returns any
|
|
3867
|
+
* @throws ApiError
|
|
298
3868
|
*/
|
|
299
|
-
|
|
3869
|
+
listLatestPrimaryNetworkTransactions({ blockchainId, network, addresses, txTypes, startTimestamp, endTimestamp, pageToken, pageSize, sortOrder, }: {
|
|
3870
|
+
/**
|
|
3871
|
+
* A primary network blockchain id or alias.
|
|
3872
|
+
*/
|
|
3873
|
+
blockchainId: BlockchainId;
|
|
3874
|
+
/**
|
|
3875
|
+
* Either mainnet or a testnet.
|
|
3876
|
+
*/
|
|
3877
|
+
network: Network;
|
|
3878
|
+
/**
|
|
3879
|
+
* 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".
|
|
3880
|
+
*/
|
|
3881
|
+
addresses?: string;
|
|
3882
|
+
/**
|
|
3883
|
+
* Query param for filtering items based on transaction types.
|
|
3884
|
+
*/
|
|
3885
|
+
txTypes?: Array<PrimaryNetworkTxType>;
|
|
3886
|
+
/**
|
|
3887
|
+
* Query param for retrieving items after a specific timestamp.
|
|
3888
|
+
*/
|
|
3889
|
+
startTimestamp?: number;
|
|
3890
|
+
/**
|
|
3891
|
+
* Query param for retrieving items before a specific timestamp.
|
|
3892
|
+
*/
|
|
3893
|
+
endTimestamp?: number;
|
|
3894
|
+
/**
|
|
3895
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3896
|
+
*/
|
|
3897
|
+
pageToken?: string;
|
|
3898
|
+
/**
|
|
3899
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3900
|
+
*/
|
|
3901
|
+
pageSize?: number;
|
|
3902
|
+
/**
|
|
3903
|
+
* 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.
|
|
3904
|
+
*/
|
|
3905
|
+
sortOrder?: SortOrder;
|
|
3906
|
+
}): CancelablePromise<(ListPChainTransactionsResponse | ListXChainTransactionsResponse | ListCChainAtomicTransactionsResponse)>;
|
|
300
3907
|
/**
|
|
301
|
-
*
|
|
302
|
-
*
|
|
3908
|
+
* List staking transactions
|
|
3909
|
+
* Lists active staking transactions on the P-Chain for the supplied addresses.
|
|
3910
|
+
* @returns ListPChainTransactionsResponse
|
|
3911
|
+
* @throws ApiError
|
|
303
3912
|
*/
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
3913
|
+
listActivePrimaryNetworkStakingTransactions({ blockchainId, network, addresses, txTypes, startTimestamp, endTimestamp, pageToken, pageSize, sortOrder, }: {
|
|
3914
|
+
/**
|
|
3915
|
+
* A primary network blockchain id or alias.
|
|
3916
|
+
*/
|
|
3917
|
+
blockchainId: PChainId;
|
|
3918
|
+
/**
|
|
3919
|
+
* Either mainnet or a testnet.
|
|
3920
|
+
*/
|
|
3921
|
+
network: Network;
|
|
3922
|
+
/**
|
|
3923
|
+
* 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".
|
|
3924
|
+
*/
|
|
3925
|
+
addresses?: string;
|
|
3926
|
+
/**
|
|
3927
|
+
* Query param for filtering items based on transaction types.
|
|
3928
|
+
*/
|
|
3929
|
+
txTypes?: Array<PrimaryNetworkTxType>;
|
|
3930
|
+
/**
|
|
3931
|
+
* Query param for retrieving items after a specific timestamp.
|
|
3932
|
+
*/
|
|
3933
|
+
startTimestamp?: number;
|
|
3934
|
+
/**
|
|
3935
|
+
* Query param for retrieving items before a specific timestamp.
|
|
3936
|
+
*/
|
|
3937
|
+
endTimestamp?: number;
|
|
3938
|
+
/**
|
|
3939
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3940
|
+
*/
|
|
3941
|
+
pageToken?: string;
|
|
3942
|
+
/**
|
|
3943
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3944
|
+
*/
|
|
3945
|
+
pageSize?: number;
|
|
3946
|
+
/**
|
|
3947
|
+
* 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.
|
|
3948
|
+
*/
|
|
3949
|
+
sortOrder?: SortOrder;
|
|
3950
|
+
}): CancelablePromise<ListPChainTransactionsResponse>;
|
|
3951
|
+
/**
|
|
3952
|
+
* List asset transactions
|
|
3953
|
+
* Lists asset transactions corresponding to the given asset id on the X-Chain.
|
|
3954
|
+
* @returns ListXChainTransactionsResponse
|
|
3955
|
+
* @throws ApiError
|
|
3956
|
+
*/
|
|
3957
|
+
listAssetTransactions({ blockchainId, network, assetId, txTypes, startTimestamp, endTimestamp, pageToken, pageSize, }: {
|
|
3958
|
+
/**
|
|
3959
|
+
* A primary network blockchain id or alias.
|
|
3960
|
+
*/
|
|
3961
|
+
blockchainId: XChainId;
|
|
3962
|
+
/**
|
|
3963
|
+
* Either mainnet or a testnet.
|
|
3964
|
+
*/
|
|
3965
|
+
network: Network;
|
|
3966
|
+
/**
|
|
3967
|
+
* Asset ID for any asset on X-Chain
|
|
3968
|
+
*/
|
|
3969
|
+
assetId: string;
|
|
3970
|
+
/**
|
|
3971
|
+
* Query param for filtering items based on transaction types.
|
|
3972
|
+
*/
|
|
3973
|
+
txTypes?: Array<PrimaryNetworkTxType>;
|
|
3974
|
+
/**
|
|
3975
|
+
* Query param for retrieving items after a specific timestamp.
|
|
3976
|
+
*/
|
|
3977
|
+
startTimestamp?: number;
|
|
3978
|
+
/**
|
|
3979
|
+
* Query param for retrieving items before a specific timestamp.
|
|
3980
|
+
*/
|
|
3981
|
+
endTimestamp?: number;
|
|
3982
|
+
/**
|
|
3983
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
3984
|
+
*/
|
|
3985
|
+
pageToken?: string;
|
|
3986
|
+
/**
|
|
3987
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
3988
|
+
*/
|
|
3989
|
+
pageSize?: number;
|
|
3990
|
+
}): CancelablePromise<ListXChainTransactionsResponse>;
|
|
310
3991
|
}
|
|
311
|
-
|
|
312
|
-
|
|
3992
|
+
|
|
3993
|
+
type ListPChainUtxosResponse = {
|
|
3994
|
+
/**
|
|
3995
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
3996
|
+
*/
|
|
3997
|
+
nextPageToken?: string;
|
|
3998
|
+
utxos: Array<PChainUtxo>;
|
|
3999
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
4000
|
+
};
|
|
4001
|
+
|
|
4002
|
+
type ListUtxosResponse = {
|
|
4003
|
+
/**
|
|
4004
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
4005
|
+
*/
|
|
313
4006
|
nextPageToken?: string;
|
|
314
|
-
|
|
4007
|
+
utxos: Array<Utxo>;
|
|
4008
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
4009
|
+
};
|
|
4010
|
+
|
|
4011
|
+
declare class PrimaryNetworkUtxOsService {
|
|
4012
|
+
readonly httpRequest: BaseHttpRequest;
|
|
4013
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
4014
|
+
/**
|
|
4015
|
+
* List UTXOs
|
|
4016
|
+
* Lists UTXOs on one of the Primary Network chains for the supplied addresses.
|
|
4017
|
+
* @returns any
|
|
4018
|
+
* @throws ApiError
|
|
4019
|
+
*/
|
|
4020
|
+
getUtxosByAddresses({ blockchainId, network, addresses, pageToken, pageSize, assetId, includeSpent, sortOrder, }: {
|
|
4021
|
+
/**
|
|
4022
|
+
* A primary network blockchain id or alias.
|
|
4023
|
+
*/
|
|
4024
|
+
blockchainId: BlockchainId;
|
|
4025
|
+
/**
|
|
4026
|
+
* Either mainnet or a testnet.
|
|
4027
|
+
*/
|
|
4028
|
+
network: Network;
|
|
4029
|
+
/**
|
|
4030
|
+
* 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".
|
|
4031
|
+
*/
|
|
4032
|
+
addresses?: string;
|
|
4033
|
+
/**
|
|
4034
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
4035
|
+
*/
|
|
4036
|
+
pageToken?: string;
|
|
4037
|
+
/**
|
|
4038
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
4039
|
+
*/
|
|
4040
|
+
pageSize?: number;
|
|
4041
|
+
/**
|
|
4042
|
+
* Asset ID for any asset (only applicable X-Chain)
|
|
4043
|
+
*/
|
|
4044
|
+
assetId?: string;
|
|
4045
|
+
/**
|
|
4046
|
+
* Boolean filter to include spent UTXOs.
|
|
4047
|
+
*/
|
|
4048
|
+
includeSpent?: boolean;
|
|
4049
|
+
/**
|
|
4050
|
+
* 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.
|
|
4051
|
+
*/
|
|
4052
|
+
sortOrder?: SortOrder;
|
|
4053
|
+
}): CancelablePromise<(ListPChainUtxosResponse | ListUtxosResponse)>;
|
|
315
4054
|
}
|
|
316
|
-
|
|
4055
|
+
|
|
4056
|
+
type XChainVertex = {
|
|
4057
|
+
vertexHash: string;
|
|
4058
|
+
parentHashes: Array<string>;
|
|
4059
|
+
vertexHeight: number;
|
|
4060
|
+
vertexIndex: number;
|
|
4061
|
+
vertexTimestamp: number;
|
|
4062
|
+
txCount: number;
|
|
4063
|
+
transactions: Array<string>;
|
|
4064
|
+
vertexSizeBytes: number;
|
|
4065
|
+
};
|
|
4066
|
+
|
|
4067
|
+
type ListXChainVerticesResponse = {
|
|
317
4068
|
/**
|
|
318
|
-
*
|
|
319
|
-
* @example 339
|
|
4069
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
320
4070
|
*/
|
|
321
|
-
|
|
4071
|
+
nextPageToken?: string;
|
|
4072
|
+
vertices: Array<XChainVertex>;
|
|
4073
|
+
chainInfo: PrimaryNetworkChainInfo;
|
|
4074
|
+
};
|
|
4075
|
+
|
|
4076
|
+
declare class PrimaryNetworkVerticesService {
|
|
4077
|
+
readonly httpRequest: BaseHttpRequest;
|
|
4078
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
322
4079
|
/**
|
|
323
|
-
*
|
|
324
|
-
*
|
|
4080
|
+
* List vertices
|
|
4081
|
+
* Lists latest vertices on the X-Chain.
|
|
4082
|
+
* @returns ListXChainVerticesResponse
|
|
4083
|
+
* @throws ApiError
|
|
325
4084
|
*/
|
|
326
|
-
|
|
4085
|
+
listLatestXChainVertices({ blockchainId, network, pageToken, pageSize, }: {
|
|
4086
|
+
/**
|
|
4087
|
+
* A primary network blockchain id or alias.
|
|
4088
|
+
*/
|
|
4089
|
+
blockchainId: XChainId;
|
|
4090
|
+
/**
|
|
4091
|
+
* Either mainnet or a testnet.
|
|
4092
|
+
*/
|
|
4093
|
+
network: Network;
|
|
4094
|
+
/**
|
|
4095
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
4096
|
+
*/
|
|
4097
|
+
pageToken?: string;
|
|
4098
|
+
/**
|
|
4099
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
4100
|
+
*/
|
|
4101
|
+
pageSize?: number;
|
|
4102
|
+
}): CancelablePromise<ListXChainVerticesResponse>;
|
|
327
4103
|
/**
|
|
328
|
-
*
|
|
329
|
-
*
|
|
4104
|
+
* Get vertex
|
|
4105
|
+
* Gets a single vertex on the X-Chain.
|
|
4106
|
+
* @returns XChainVertex
|
|
4107
|
+
* @throws ApiError
|
|
330
4108
|
*/
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
4109
|
+
getVertexByHash({ vertexHash, blockchainId, network, }: {
|
|
4110
|
+
/**
|
|
4111
|
+
* A vertex hash string.
|
|
4112
|
+
*/
|
|
4113
|
+
vertexHash: string;
|
|
4114
|
+
/**
|
|
4115
|
+
* A primary network blockchain id or alias.
|
|
4116
|
+
*/
|
|
4117
|
+
blockchainId: XChainId;
|
|
4118
|
+
/**
|
|
4119
|
+
* Either mainnet or a testnet.
|
|
4120
|
+
*/
|
|
4121
|
+
network: Network;
|
|
4122
|
+
}): CancelablePromise<XChainVertex>;
|
|
4123
|
+
/**
|
|
4124
|
+
* List vertices by height
|
|
4125
|
+
* Lists vertices at the given vertex height on the X-Chain.
|
|
4126
|
+
* @returns ListXChainVerticesResponse
|
|
4127
|
+
* @throws ApiError
|
|
4128
|
+
*/
|
|
4129
|
+
getVertexByHeight({ vertexHeight, blockchainId, network, pageToken, pageSize, sortOrder, }: {
|
|
4130
|
+
/**
|
|
4131
|
+
* The height of a vertex.
|
|
4132
|
+
*/
|
|
4133
|
+
vertexHeight: number;
|
|
4134
|
+
/**
|
|
4135
|
+
* A primary network blockchain id or alias.
|
|
4136
|
+
*/
|
|
4137
|
+
blockchainId: XChainId;
|
|
4138
|
+
/**
|
|
4139
|
+
* Either mainnet or a testnet.
|
|
4140
|
+
*/
|
|
4141
|
+
network: Network;
|
|
4142
|
+
/**
|
|
4143
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
4144
|
+
*/
|
|
4145
|
+
pageToken?: string;
|
|
4146
|
+
/**
|
|
4147
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
4148
|
+
*/
|
|
4149
|
+
pageSize?: number;
|
|
4150
|
+
/**
|
|
4151
|
+
* 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.
|
|
4152
|
+
*/
|
|
4153
|
+
sortOrder?: SortOrder;
|
|
4154
|
+
}): CancelablePromise<ListXChainVerticesResponse>;
|
|
335
4155
|
}
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
4156
|
+
|
|
4157
|
+
type RpcErrorDto = {
|
|
4158
|
+
code: number;
|
|
4159
|
+
message: string;
|
|
4160
|
+
data?: Record<string, any>;
|
|
4161
|
+
};
|
|
4162
|
+
|
|
4163
|
+
type RpcErrorResponseDto = {
|
|
4164
|
+
jsonrpc: string;
|
|
4165
|
+
id?: (string | number);
|
|
4166
|
+
error: RpcErrorDto;
|
|
4167
|
+
};
|
|
4168
|
+
|
|
4169
|
+
type RpcRequestBodyDto = {
|
|
4170
|
+
method: string;
|
|
4171
|
+
params?: Record<string, any>;
|
|
4172
|
+
id?: (string | number);
|
|
4173
|
+
jsonrpc?: string;
|
|
4174
|
+
};
|
|
4175
|
+
|
|
4176
|
+
type RpcSuccessResponseDto = {
|
|
4177
|
+
jsonrpc: string;
|
|
4178
|
+
id?: (string | number);
|
|
4179
|
+
result: Record<string, any>;
|
|
4180
|
+
};
|
|
4181
|
+
|
|
4182
|
+
declare class RpcService {
|
|
4183
|
+
readonly httpRequest: BaseHttpRequest;
|
|
4184
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
4185
|
+
/**
|
|
4186
|
+
* Calls JSON-RPC method
|
|
4187
|
+
* Calls JSON-RPC method.
|
|
4188
|
+
* @returns any
|
|
4189
|
+
* @throws ApiError
|
|
4190
|
+
*/
|
|
4191
|
+
rpc({ chainId, requestBody, }: {
|
|
4192
|
+
/**
|
|
4193
|
+
* A supported evm chain id, chain alias or blockchain id. Use the `/chains` endpoint to get a list of supported chain ids.
|
|
4194
|
+
*/
|
|
4195
|
+
chainId: string;
|
|
4196
|
+
requestBody: (RpcRequestBodyDto | Array<RpcRequestBodyDto>);
|
|
4197
|
+
}): CancelablePromise<(RpcSuccessResponseDto | RpcErrorResponseDto)>;
|
|
340
4198
|
}
|
|
341
|
-
|
|
4199
|
+
|
|
4200
|
+
type TeleporterDestinationTransaction = {
|
|
4201
|
+
txHash: string;
|
|
4202
|
+
timestamp: number;
|
|
4203
|
+
gasSpent: string;
|
|
4204
|
+
rewardRedeemer: string;
|
|
4205
|
+
delivererAddress: string;
|
|
4206
|
+
};
|
|
4207
|
+
|
|
4208
|
+
type TeleporterReceipt = {
|
|
4209
|
+
receivedMessageNonce: string;
|
|
4210
|
+
relayerRewardAddress: string;
|
|
4211
|
+
};
|
|
4212
|
+
|
|
4213
|
+
type TeleporterRewardDetails = {
|
|
4214
|
+
/**
|
|
4215
|
+
* A wallet or contract address in mixed-case checksum encoding.
|
|
4216
|
+
*/
|
|
4217
|
+
address: string;
|
|
4218
|
+
/**
|
|
4219
|
+
* The contract name.
|
|
4220
|
+
*/
|
|
342
4221
|
name: string;
|
|
4222
|
+
/**
|
|
4223
|
+
* The contract symbol.
|
|
4224
|
+
*/
|
|
343
4225
|
symbol: string;
|
|
4226
|
+
/**
|
|
4227
|
+
* The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
|
|
4228
|
+
*/
|
|
344
4229
|
decimals: number;
|
|
4230
|
+
/**
|
|
4231
|
+
* The logo uri for the address.
|
|
4232
|
+
*/
|
|
345
4233
|
logoUri?: string;
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
4234
|
+
ercType: TeleporterRewardDetails.ercType;
|
|
4235
|
+
/**
|
|
4236
|
+
* The token price, if available.
|
|
4237
|
+
*/
|
|
4238
|
+
price?: Money;
|
|
4239
|
+
value: string;
|
|
4240
|
+
};
|
|
4241
|
+
declare namespace TeleporterRewardDetails {
|
|
4242
|
+
enum ercType {
|
|
4243
|
+
ERC_20 = "ERC-20"
|
|
4244
|
+
}
|
|
352
4245
|
}
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
4246
|
+
|
|
4247
|
+
type DeliveredSourceNotIndexedTeleporterMessage = {
|
|
4248
|
+
messageId: string;
|
|
4249
|
+
teleporterContractAddress: string;
|
|
4250
|
+
sourceBlockchainId: string;
|
|
4251
|
+
destinationBlockchainId: string;
|
|
4252
|
+
sourceEvmChainId: string;
|
|
4253
|
+
destinationEvmChainId: string;
|
|
4254
|
+
messageNonce: string;
|
|
4255
|
+
from: string;
|
|
4256
|
+
to: string;
|
|
4257
|
+
data?: string;
|
|
4258
|
+
messageExecuted: boolean;
|
|
4259
|
+
receipts: Array<TeleporterReceipt>;
|
|
4260
|
+
receiptDelivered: boolean;
|
|
4261
|
+
rewardDetails: TeleporterRewardDetails;
|
|
4262
|
+
destinationTransaction: TeleporterDestinationTransaction;
|
|
4263
|
+
status: DeliveredSourceNotIndexedTeleporterMessage.status;
|
|
4264
|
+
};
|
|
4265
|
+
declare namespace DeliveredSourceNotIndexedTeleporterMessage {
|
|
4266
|
+
enum status {
|
|
4267
|
+
DELIVERED_SOURCE_NOT_INDEXED = "delivered_source_not_indexed"
|
|
4268
|
+
}
|
|
359
4269
|
}
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
4270
|
+
|
|
4271
|
+
type TeleporterSourceTransaction = {
|
|
4272
|
+
txHash: string;
|
|
4273
|
+
timestamp: number;
|
|
4274
|
+
gasSpent: string;
|
|
4275
|
+
};
|
|
4276
|
+
|
|
4277
|
+
type DeliveredTeleporterMessage = {
|
|
4278
|
+
messageId: string;
|
|
4279
|
+
teleporterContractAddress: string;
|
|
4280
|
+
sourceBlockchainId: string;
|
|
4281
|
+
destinationBlockchainId: string;
|
|
4282
|
+
sourceEvmChainId: string;
|
|
4283
|
+
destinationEvmChainId: string;
|
|
4284
|
+
messageNonce: string;
|
|
4285
|
+
from: string;
|
|
4286
|
+
to: string;
|
|
4287
|
+
data?: string;
|
|
4288
|
+
messageExecuted: boolean;
|
|
4289
|
+
receipts: Array<TeleporterReceipt>;
|
|
4290
|
+
receiptDelivered: boolean;
|
|
4291
|
+
rewardDetails: TeleporterRewardDetails;
|
|
4292
|
+
sourceTransaction: TeleporterSourceTransaction;
|
|
4293
|
+
destinationTransaction: TeleporterDestinationTransaction;
|
|
4294
|
+
status: DeliveredTeleporterMessage.status;
|
|
4295
|
+
};
|
|
4296
|
+
declare namespace DeliveredTeleporterMessage {
|
|
4297
|
+
enum status {
|
|
4298
|
+
DELIVERED = "delivered"
|
|
4299
|
+
}
|
|
364
4300
|
}
|
|
365
|
-
|
|
366
|
-
|
|
4301
|
+
|
|
4302
|
+
type PendingTeleporterMessage = {
|
|
4303
|
+
messageId: string;
|
|
4304
|
+
teleporterContractAddress: string;
|
|
4305
|
+
sourceBlockchainId: string;
|
|
4306
|
+
destinationBlockchainId: string;
|
|
4307
|
+
sourceEvmChainId: string;
|
|
4308
|
+
destinationEvmChainId: string;
|
|
4309
|
+
messageNonce: string;
|
|
4310
|
+
from: string;
|
|
4311
|
+
to: string;
|
|
4312
|
+
data?: string;
|
|
4313
|
+
messageExecuted: boolean;
|
|
4314
|
+
receipts: Array<TeleporterReceipt>;
|
|
4315
|
+
receiptDelivered: boolean;
|
|
4316
|
+
rewardDetails: TeleporterRewardDetails;
|
|
4317
|
+
sourceTransaction: TeleporterSourceTransaction;
|
|
4318
|
+
status: PendingTeleporterMessage.status;
|
|
4319
|
+
};
|
|
4320
|
+
declare namespace PendingTeleporterMessage {
|
|
4321
|
+
enum status {
|
|
4322
|
+
PENDING = "pending"
|
|
4323
|
+
}
|
|
367
4324
|
}
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
4325
|
+
|
|
4326
|
+
type ListTeleporterMessagesResponse = {
|
|
4327
|
+
/**
|
|
4328
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
4329
|
+
*/
|
|
4330
|
+
nextPageToken?: string;
|
|
4331
|
+
messages: Array<(PendingTeleporterMessage | DeliveredTeleporterMessage)>;
|
|
4332
|
+
};
|
|
4333
|
+
|
|
4334
|
+
declare class TeleporterService {
|
|
4335
|
+
readonly httpRequest: BaseHttpRequest;
|
|
4336
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
4337
|
+
/**
|
|
4338
|
+
* Get a teleporter message
|
|
4339
|
+
* Gets a teleporter message by message ID.
|
|
4340
|
+
* @returns any
|
|
4341
|
+
* @throws ApiError
|
|
4342
|
+
*/
|
|
4343
|
+
getTeleporterMessage({ messageId, }: {
|
|
4344
|
+
/**
|
|
4345
|
+
* The message ID of the teleporter message.
|
|
4346
|
+
*/
|
|
4347
|
+
messageId: string;
|
|
4348
|
+
}): CancelablePromise<(PendingTeleporterMessage | DeliveredTeleporterMessage | DeliveredSourceNotIndexedTeleporterMessage)>;
|
|
4349
|
+
/**
|
|
4350
|
+
* List teleporter messages
|
|
4351
|
+
* Lists teleporter messages. Ordered by timestamp in descending order.
|
|
4352
|
+
* @returns ListTeleporterMessagesResponse
|
|
4353
|
+
* @throws ApiError
|
|
4354
|
+
*/
|
|
4355
|
+
listTeleporterMessages({ pageToken, pageSize, sourceBlockchainId, destinationBlockchainId, to, from, network, }: {
|
|
4356
|
+
/**
|
|
4357
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
4358
|
+
*/
|
|
4359
|
+
pageToken?: string;
|
|
4360
|
+
/**
|
|
4361
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
4362
|
+
*/
|
|
4363
|
+
pageSize?: number;
|
|
4364
|
+
/**
|
|
4365
|
+
* The base58 encoded blockchain ID or evm chain ID of the source chain that the teleporter message was sent from.
|
|
4366
|
+
*/
|
|
4367
|
+
sourceBlockchainId?: string;
|
|
4368
|
+
/**
|
|
4369
|
+
* The base58 encoded blockchain ID or evm chain ID of the destination chain that the teleporter message was sent to.
|
|
4370
|
+
*/
|
|
4371
|
+
destinationBlockchainId?: string;
|
|
4372
|
+
/**
|
|
4373
|
+
* The address of the recipient of the teleporter message.
|
|
4374
|
+
*/
|
|
4375
|
+
to?: string;
|
|
4376
|
+
/**
|
|
4377
|
+
* The address of the sender of the teleporter message.
|
|
4378
|
+
*/
|
|
4379
|
+
from?: string;
|
|
4380
|
+
/**
|
|
4381
|
+
* mainnet or testnet.
|
|
4382
|
+
*/
|
|
4383
|
+
network?: NetworkType;
|
|
4384
|
+
}): CancelablePromise<ListTeleporterMessagesResponse>;
|
|
383
4385
|
}
|
|
384
|
-
|
|
385
|
-
|
|
4386
|
+
|
|
4387
|
+
type AddressesChangeRequest = {
|
|
4388
|
+
/**
|
|
4389
|
+
* Ethereum address(es) for the address_activity event type
|
|
4390
|
+
*/
|
|
4391
|
+
addresses: Array<any[]>;
|
|
4392
|
+
};
|
|
4393
|
+
|
|
4394
|
+
type ListWebhookAddressesResponse = {
|
|
4395
|
+
/**
|
|
4396
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
4397
|
+
*/
|
|
4398
|
+
nextPageToken?: string;
|
|
4399
|
+
addresses: Array<string>;
|
|
4400
|
+
totalAddresses: number;
|
|
4401
|
+
};
|
|
4402
|
+
|
|
4403
|
+
type AddressActivityMetadata = {
|
|
4404
|
+
/**
|
|
4405
|
+
* Ethereum address(es) for the address_activity event type
|
|
4406
|
+
*/
|
|
4407
|
+
addresses: Array<any[]>;
|
|
4408
|
+
/**
|
|
4409
|
+
* Array of hexadecimal strings of the event signatures.
|
|
4410
|
+
*/
|
|
4411
|
+
eventSignatures?: Array<string>;
|
|
4412
|
+
};
|
|
4413
|
+
|
|
4414
|
+
declare enum EventType {
|
|
4415
|
+
ADDRESS_ACTIVITY = "address_activity"
|
|
386
4416
|
}
|
|
387
4417
|
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
status?: string;
|
|
392
|
-
}>;
|
|
393
|
-
error?: Record<string, {
|
|
394
|
-
status?: string;
|
|
395
|
-
}>;
|
|
396
|
-
details?: Record<string, {
|
|
397
|
-
status?: string;
|
|
398
|
-
}>;
|
|
4418
|
+
declare enum WebhookStatusType {
|
|
4419
|
+
ACTIVE = "active",
|
|
4420
|
+
INACTIVE = "inactive"
|
|
399
4421
|
}
|
|
400
4422
|
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
private httpClient;
|
|
406
|
-
constructor(baseUrl: string, version?: string, httpOptions?: HttpOptions | undefined);
|
|
4423
|
+
type WebhookResponse = {
|
|
4424
|
+
id: string;
|
|
4425
|
+
eventType: EventType;
|
|
4426
|
+
metadata: AddressActivityMetadata;
|
|
407
4427
|
/**
|
|
408
|
-
*
|
|
409
|
-
* @name HealthCheck
|
|
410
|
-
* @summary Get the health of the service.
|
|
411
|
-
* @request GET:/${version}/health-check
|
|
412
|
-
* @response `200` `{ status?: string, info?: Record<string, { status?: string }>, error?: Record<string, { status?: string }>, details?: Record<string, { status?: string }> }` The Health Check is successful
|
|
413
|
-
* @response `503` `{ status?: string, info?: Record<string, { status?: string }>, error?: Record<string, { status?: string }>, details?: Record<string, { status?: string }> }` The Health Check is not successful
|
|
4428
|
+
* Whether to include traces in the webhook payload.
|
|
414
4429
|
*/
|
|
415
|
-
|
|
4430
|
+
includeInternalTxs?: boolean;
|
|
416
4431
|
/**
|
|
417
|
-
*
|
|
418
|
-
*
|
|
419
|
-
* @name GetNativeBalance
|
|
420
|
-
* @summary Get native token balance of a wallet address for a given chain.
|
|
421
|
-
* @request GET:/v1/chains/{chainId}/addresses/{address}/balances:getNative
|
|
422
|
-
* @response `200` `NativeBalanceDto`
|
|
4432
|
+
* Whether to include logs in the webhook payload.
|
|
423
4433
|
*/
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
4434
|
+
includeLogs?: boolean;
|
|
4435
|
+
url: string;
|
|
4436
|
+
chainId: string;
|
|
4437
|
+
status: WebhookStatusType;
|
|
4438
|
+
createdAt: number;
|
|
4439
|
+
name: string;
|
|
4440
|
+
description: string;
|
|
4441
|
+
};
|
|
4442
|
+
|
|
4443
|
+
type ListWebhooksResponse = {
|
|
427
4444
|
/**
|
|
428
|
-
*
|
|
429
|
-
* @name ListErc20Balances
|
|
430
|
-
* @summary Get erc-20 token balances of a wallet address for a given chain.
|
|
431
|
-
* @request GET:/v1/chains/{chainId}/addresses/{address}/balances:listErc20
|
|
432
|
-
* @response `200` `Erc20BalancesDto`
|
|
4445
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
433
4446
|
*/
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
4447
|
+
nextPageToken?: string;
|
|
4448
|
+
webhooks: Array<WebhookResponse>;
|
|
4449
|
+
};
|
|
4450
|
+
|
|
4451
|
+
type RegisterWebhookRequest = {
|
|
4452
|
+
url: string;
|
|
4453
|
+
chainId: string;
|
|
4454
|
+
eventType: EventType;
|
|
4455
|
+
metadata: AddressActivityMetadata;
|
|
439
4456
|
/**
|
|
440
|
-
*
|
|
441
|
-
*
|
|
442
|
-
* @name ListErc721Balances
|
|
443
|
-
* @summary Get erc-721 token balances of a wallet address for a given chain.
|
|
444
|
-
* @request GET:/v1/chains/{chainId}/addresses/{address}/balances:listErc721
|
|
445
|
-
* @response `200` `Erc721BalancesDto`
|
|
4457
|
+
* Whether to include traces in the webhook payload.
|
|
446
4458
|
*/
|
|
447
|
-
|
|
448
|
-
pageSize?: number;
|
|
449
|
-
pageToken?: string;
|
|
450
|
-
currency?: CurrencyCode;
|
|
451
|
-
}, params?: Record<string, any>, customOptions?: HttpOptions): Promise<Erc721Balances>;
|
|
4459
|
+
includeInternalTxs?: boolean;
|
|
452
4460
|
/**
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
* @name ListTransactions
|
|
456
|
-
* @summary Gets a list of transactions for a wallet address and chain.
|
|
457
|
-
* @request GET:/v1/chains/{chainId}/addresses/{address}/transactions
|
|
458
|
-
* @response `200` `ListTransactionDetailsDto`
|
|
4461
|
+
* Whether to include logs in the webhook payload.
|
|
459
4462
|
*/
|
|
460
|
-
|
|
461
|
-
|
|
4463
|
+
includeLogs?: boolean;
|
|
4464
|
+
};
|
|
4465
|
+
|
|
4466
|
+
type SharedSecretsResponse = {
|
|
4467
|
+
secret: string;
|
|
4468
|
+
};
|
|
4469
|
+
|
|
4470
|
+
type UpdateWebhookRequest = {
|
|
4471
|
+
name?: string;
|
|
4472
|
+
description?: string;
|
|
4473
|
+
url?: string;
|
|
4474
|
+
status?: WebhookStatusType;
|
|
4475
|
+
includeInternalTxs?: boolean;
|
|
4476
|
+
includeLogs?: boolean;
|
|
4477
|
+
};
|
|
4478
|
+
|
|
4479
|
+
declare enum WebhookStatus {
|
|
4480
|
+
ACTIVE = "active",
|
|
4481
|
+
INACTIVE = "inactive"
|
|
4482
|
+
}
|
|
4483
|
+
|
|
4484
|
+
declare class WebhooksService {
|
|
4485
|
+
readonly httpRequest: BaseHttpRequest;
|
|
4486
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
4487
|
+
/**
|
|
4488
|
+
* Create a webhook
|
|
4489
|
+
* Create a new webhook.
|
|
4490
|
+
* @returns WebhookResponse
|
|
4491
|
+
* @throws ApiError
|
|
4492
|
+
*/
|
|
4493
|
+
registerWebhook({ requestBody, }: {
|
|
4494
|
+
requestBody: RegisterWebhookRequest;
|
|
4495
|
+
}): CancelablePromise<WebhookResponse>;
|
|
4496
|
+
/**
|
|
4497
|
+
* List webhooks
|
|
4498
|
+
* Lists webhooks for the user.
|
|
4499
|
+
* @returns ListWebhooksResponse
|
|
4500
|
+
* @throws ApiError
|
|
4501
|
+
*/
|
|
4502
|
+
listWebhooks({ pageToken, pageSize, status, }: {
|
|
4503
|
+
/**
|
|
4504
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
4505
|
+
*/
|
|
462
4506
|
pageToken?: string;
|
|
463
|
-
|
|
4507
|
+
/**
|
|
4508
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
4509
|
+
*/
|
|
4510
|
+
pageSize?: number;
|
|
4511
|
+
/**
|
|
4512
|
+
* Status of the webhook. Use "active" to return only active webhooks, "inactive" to return only inactive webhooks. Else if no status is provided, all configured webhooks will be returned.
|
|
4513
|
+
*/
|
|
4514
|
+
status?: WebhookStatus;
|
|
4515
|
+
}): CancelablePromise<ListWebhooksResponse>;
|
|
464
4516
|
/**
|
|
465
|
-
*
|
|
466
|
-
*
|
|
467
|
-
* @
|
|
468
|
-
* @
|
|
469
|
-
* @response `200` `TransactionDetailsDto`
|
|
4517
|
+
* Get a webhook by ID
|
|
4518
|
+
* Retrieves a webhook by ID.
|
|
4519
|
+
* @returns WebhookResponse
|
|
4520
|
+
* @throws ApiError
|
|
470
4521
|
*/
|
|
471
|
-
|
|
4522
|
+
getWebhook({ id, }: {
|
|
4523
|
+
/**
|
|
4524
|
+
* The webhook identifier.
|
|
4525
|
+
*/
|
|
4526
|
+
id: string;
|
|
4527
|
+
}): CancelablePromise<WebhookResponse>;
|
|
472
4528
|
/**
|
|
473
|
-
*
|
|
474
|
-
*
|
|
475
|
-
* @
|
|
476
|
-
* @
|
|
477
|
-
* @response `200` `ChainsDto`
|
|
4529
|
+
* Deactivate a webhook
|
|
4530
|
+
* Deactivates a webhook by ID.
|
|
4531
|
+
* @returns WebhookResponse
|
|
4532
|
+
* @throws ApiError
|
|
478
4533
|
*/
|
|
479
|
-
|
|
4534
|
+
deactivateWebhook({ id, }: {
|
|
4535
|
+
/**
|
|
4536
|
+
* The webhook identifier.
|
|
4537
|
+
*/
|
|
4538
|
+
id: string;
|
|
4539
|
+
}): CancelablePromise<WebhookResponse>;
|
|
480
4540
|
/**
|
|
481
|
-
*
|
|
482
|
-
*
|
|
483
|
-
* @
|
|
484
|
-
* @
|
|
485
|
-
|
|
486
|
-
|
|
4541
|
+
* Update a webhook
|
|
4542
|
+
* Updates an existing webhook.
|
|
4543
|
+
* @returns WebhookResponse
|
|
4544
|
+
* @throws ApiError
|
|
4545
|
+
*/
|
|
4546
|
+
updateWebhook({ id, requestBody, }: {
|
|
4547
|
+
/**
|
|
4548
|
+
* The webhook identifier.
|
|
4549
|
+
*/
|
|
4550
|
+
id: string;
|
|
4551
|
+
requestBody: UpdateWebhookRequest;
|
|
4552
|
+
}): CancelablePromise<WebhookResponse>;
|
|
4553
|
+
/**
|
|
4554
|
+
* Generate a shared secret
|
|
4555
|
+
* Generates a new shared secret.
|
|
4556
|
+
* @returns SharedSecretsResponse
|
|
4557
|
+
* @throws ApiError
|
|
4558
|
+
*/
|
|
4559
|
+
generateSharedSecret(): CancelablePromise<SharedSecretsResponse>;
|
|
4560
|
+
/**
|
|
4561
|
+
* Get a shared secret
|
|
4562
|
+
* Get a previously generated shared secret.
|
|
4563
|
+
* @returns SharedSecretsResponse
|
|
4564
|
+
* @throws ApiError
|
|
4565
|
+
*/
|
|
4566
|
+
getSharedSecret(): CancelablePromise<SharedSecretsResponse>;
|
|
4567
|
+
/**
|
|
4568
|
+
* Add addresses to webhook
|
|
4569
|
+
* Add addresses to webhook.
|
|
4570
|
+
* @returns WebhookResponse
|
|
4571
|
+
* @throws ApiError
|
|
4572
|
+
*/
|
|
4573
|
+
addAddressesToWebhook({ id, requestBody, }: {
|
|
4574
|
+
/**
|
|
4575
|
+
* The webhook identifier.
|
|
4576
|
+
*/
|
|
4577
|
+
id: string;
|
|
4578
|
+
requestBody: AddressesChangeRequest;
|
|
4579
|
+
}): CancelablePromise<WebhookResponse>;
|
|
4580
|
+
/**
|
|
4581
|
+
* Remove addresses from webhook
|
|
4582
|
+
* Remove addresses from webhook.
|
|
4583
|
+
* @returns WebhookResponse
|
|
4584
|
+
* @throws ApiError
|
|
4585
|
+
*/
|
|
4586
|
+
removeAddressesFromWebhook({ id, requestBody, }: {
|
|
4587
|
+
/**
|
|
4588
|
+
* The webhook identifier.
|
|
4589
|
+
*/
|
|
4590
|
+
id: string;
|
|
4591
|
+
requestBody: AddressesChangeRequest;
|
|
4592
|
+
}): CancelablePromise<WebhookResponse>;
|
|
4593
|
+
/**
|
|
4594
|
+
* List adresses by webhook
|
|
4595
|
+
* List adresses by webhook.
|
|
4596
|
+
* @returns ListWebhookAddressesResponse
|
|
4597
|
+
* @throws ApiError
|
|
487
4598
|
*/
|
|
488
|
-
|
|
4599
|
+
getAddressesFromWebhook({ id, pageToken, pageSize, }: {
|
|
4600
|
+
/**
|
|
4601
|
+
* The webhook identifier.
|
|
4602
|
+
*/
|
|
4603
|
+
id: string;
|
|
4604
|
+
/**
|
|
4605
|
+
* A page token, received from a previous list call. Provide this to retrieve the subsequent page.
|
|
4606
|
+
*/
|
|
4607
|
+
pageToken?: string;
|
|
4608
|
+
/**
|
|
4609
|
+
* The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
|
|
4610
|
+
*/
|
|
4611
|
+
pageSize?: number;
|
|
4612
|
+
}): CancelablePromise<ListWebhookAddressesResponse>;
|
|
4613
|
+
}
|
|
4614
|
+
|
|
4615
|
+
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
4616
|
+
declare class Glacier {
|
|
4617
|
+
readonly default: DefaultService;
|
|
4618
|
+
readonly evmBalances: EvmBalancesService;
|
|
4619
|
+
readonly evmBlocks: EvmBlocksService;
|
|
4620
|
+
readonly evmChains: EvmChainsService;
|
|
4621
|
+
readonly evmContracts: EvmContractsService;
|
|
4622
|
+
readonly evmTransactions: EvmTransactionsService;
|
|
4623
|
+
readonly healthCheck: HealthCheckService;
|
|
4624
|
+
readonly nfTs: NfTsService;
|
|
4625
|
+
readonly operations: OperationsService;
|
|
4626
|
+
readonly primaryNetwork: PrimaryNetworkService;
|
|
4627
|
+
readonly primaryNetworkBalances: PrimaryNetworkBalancesService;
|
|
4628
|
+
readonly primaryNetworkBlocks: PrimaryNetworkBlocksService;
|
|
4629
|
+
readonly primaryNetworkRewards: PrimaryNetworkRewardsService;
|
|
4630
|
+
readonly primaryNetworkTransactions: PrimaryNetworkTransactionsService;
|
|
4631
|
+
readonly primaryNetworkUtxOs: PrimaryNetworkUtxOsService;
|
|
4632
|
+
readonly primaryNetworkVertices: PrimaryNetworkVerticesService;
|
|
4633
|
+
readonly rpc: RpcService;
|
|
4634
|
+
readonly teleporter: TeleporterService;
|
|
4635
|
+
readonly webhooks: WebhooksService;
|
|
4636
|
+
readonly request: BaseHttpRequest;
|
|
4637
|
+
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
4638
|
+
}
|
|
4639
|
+
|
|
4640
|
+
type ApiResult = {
|
|
4641
|
+
readonly url: string;
|
|
4642
|
+
readonly ok: boolean;
|
|
4643
|
+
readonly status: number;
|
|
4644
|
+
readonly statusText: string;
|
|
4645
|
+
readonly body: any;
|
|
4646
|
+
};
|
|
4647
|
+
|
|
4648
|
+
declare class ApiError extends Error {
|
|
4649
|
+
readonly url: string;
|
|
4650
|
+
readonly status: number;
|
|
4651
|
+
readonly statusText: string;
|
|
4652
|
+
readonly body: any;
|
|
4653
|
+
readonly request: ApiRequestOptions;
|
|
4654
|
+
constructor(request: ApiRequestOptions, response: ApiResult, message: string);
|
|
489
4655
|
}
|
|
490
4656
|
|
|
491
|
-
|
|
4657
|
+
type NextPageToken = {
|
|
4658
|
+
/**
|
|
4659
|
+
* A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted or empty, there are no subsequent pages.
|
|
4660
|
+
*/
|
|
4661
|
+
nextPageToken?: string;
|
|
4662
|
+
};
|
|
4663
|
+
|
|
4664
|
+
export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, AssetAmount, AssetWithPriceInfo, BaseHttpRequest, Blockchain, BlockchainId, BlockchainIds, BlockchainInfo, BlsCredentials, CChainAtomicBalances, CChainExportTransaction, CChainImportTransaction, CChainSharedAssetBalance, CancelError, CancelablePromise, ChainAddressChainIdMap, ChainAddressChainIdMapListResponse, ChainInfo, ChainStatus, CompletedDelegatorDetails, CompletedValidatorDetails, ContractDeploymentDetails, ContractSubmissionBody, ContractSubmissionErc1155, ContractSubmissionErc20, ContractSubmissionErc721, ContractSubmissionUnknown, CreateEvmTransactionExportRequest, CreatePrimaryNetworkTransactionExportRequest, CurrencyCode, DefaultService, DelegationStatusType, DelegatorsDetails, DeliveredSourceNotIndexedTeleporterMessage, DeliveredTeleporterMessage, EVMInput, EVMOperationType, EVMOutput, Erc1155Contract, Erc1155Token, Erc1155TokenBalance, Erc1155TokenMetadata, Erc1155Transfer, Erc1155TransferDetails, Erc20Contract, Erc20Token, Erc20TokenBalance, Erc20Transfer, Erc20TransferDetails, Erc721Contract, Erc721Token, Erc721TokenBalance, Erc721TokenMetadata, Erc721Transfer, Erc721TransferDetails, EventType, EvmBalancesService, EvmBlock, EvmBlocksService, EvmChainsService, EvmContractsService, EvmNetworkOptions, EvmTransactionsService, FullNativeTransactionDetails, GetChainResponse, GetEvmBlockResponse, GetNativeBalanceResponse, GetNetworkDetailsResponse, GetPrimaryNetworkBlockResponse, GetTransactionResponse, Glacier, GlacierApiFeature, HealthCheckService, HistoricalReward, ImageAsset, InternalTransaction, InternalTransactionDetails, InternalTransactionOpCall, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListInternalTransactionsResponse, ListNativeTransactionsResponse, ListNftTokens, ListPChainBalancesResponse, ListPChainTransactionsResponse, ListPChainUtxosResponse, ListPendingRewardsResponse, ListPrimaryNetworkBlocksResponse, ListSubnetsResponse, ListTeleporterMessagesResponse, ListTransactionDetailsResponse, ListTransfersResponse, ListUtxosResponse, ListValidatorDetailsResponse, ListWebhookAddressesResponse, ListWebhooksResponse, ListXChainBalancesResponse, ListXChainTransactionsResponse, ListXChainVerticesResponse, Method, Money, NativeTokenBalance, NativeTransaction, Network, NetworkToken, NetworkTokenDetails, NetworkType, NextPageToken, NfTsService, NftTokenMetadataStatus, OpenAPI, OpenAPIConfig, OperationStatus, OperationStatusCode, OperationStatusResponse, OperationType, OperationsService, PChainBalance, PChainId, PChainSharedAsset, PChainTransaction, PChainTransactionType, PChainUtxo, PendingDelegatorDetails, PendingReward, PendingTeleporterMessage, PendingValidatorDetails, PricingProviders, PrimaryNetwork, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RegisterWebhookRequest, RemovedValidatorDetails, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcErrorDto, RpcErrorResponseDto, RpcRequestBodyDto, RpcService, RpcSuccessResponseDto, SharedSecretsResponse, SortByOption, SortOrder, StakingDistribution, Subnet, SubnetOwnershipInfo, TeleporterDestinationTransaction, TeleporterReceipt, TeleporterRewardDetails, TeleporterService, TeleporterSourceTransaction, TransactionDetails, TransactionExportMetadata, TransactionMethodType, TransactionStatus, TransactionVertexDetail, UnknownContract, UpdateContractResponse, UpdateWebhookRequest, UtilityAddresses, Utxo, UtxoCredential, UtxoType, ValidationStatusType, ValidatorHealthDetails, ValidatorsDetails, VmName, WebhookResponse, WebhookStatus, WebhookStatusType, WebhooksService, XChainAssetDetails, XChainBalances, XChainId, XChainLinearTransaction, XChainNonLinearTransaction, XChainSharedAssetBalance, XChainTransactionType, XChainVertex };
|