@avalabs/glacier-sdk 3.1.0-canary.801d1a5.0 → 3.1.0-canary.85a0322.0

package/dist/index.d.ts

@@ -2602,6 +2602,221 @@ declare class HealthCheckService {
     }>;
 }
 
+type IcmDestinationTransaction = {
+    txHash: string;
+    timestamp: number;
+    gasSpent: string;
+    rewardRedeemer: string;
+    delivererAddress: string;
+};
+
+type IcmReceipt = {
+    receivedMessageNonce: string;
+    relayerRewardAddress: string;
+};
+
+type IcmRewardDetails = {
+    /**
+     * A wallet or contract address in mixed-case checksum encoding.
+     */
+    address: string;
+    /**
+     * The contract name.
+     */
+    name: string;
+    /**
+     * The contract symbol.
+     */
+    symbol: string;
+    /**
+     * The number of decimals the token uses. For example `6`, means to divide the token amount by `1000000` to get its user representation.
+     */
+    decimals: number;
+    /**
+     * The logo uri for the address.
+     */
+    logoUri?: string;
+    ercType: IcmRewardDetails.ercType;
+    /**
+     * The token price, if available.
+     */
+    price?: Money;
+    value: string;
+};
+declare namespace IcmRewardDetails {
+    enum ercType {
+        ERC_20 = "ERC-20"
+    }
+}
+
+type IcmSourceTransaction = {
+    txHash: string;
+    timestamp: number;
+    gasSpent: string;
+};
+
+type DeliveredIcmMessage = {
+    messageId: string;
+    icmContractAddress: string;
+    sourceBlockchainId: string;
+    destinationBlockchainId: string;
+    sourceEvmChainId: string;
+    destinationEvmChainId: string;
+    messageNonce: string;
+    from: string;
+    to: string;
+    data?: string;
+    messageExecuted: boolean;
+    receipts: Array<IcmReceipt>;
+    receiptDelivered: boolean;
+    rewardDetails: IcmRewardDetails;
+    sourceTransaction: IcmSourceTransaction;
+    destinationTransaction: IcmDestinationTransaction;
+    status: DeliveredIcmMessage.status;
+};
+declare namespace DeliveredIcmMessage {
+    enum status {
+        DELIVERED = "delivered"
+    }
+}
+
+type DeliveredSourceNotIndexedIcmMessage = {
+    messageId: string;
+    icmContractAddress: string;
+    sourceBlockchainId: string;
+    destinationBlockchainId: string;
+    sourceEvmChainId: string;
+    destinationEvmChainId: string;
+    messageNonce: string;
+    from: string;
+    to: string;
+    data?: string;
+    messageExecuted: boolean;
+    receipts: Array<IcmReceipt>;
+    receiptDelivered: boolean;
+    rewardDetails: IcmRewardDetails;
+    destinationTransaction: IcmDestinationTransaction;
+    status: DeliveredSourceNotIndexedIcmMessage.status;
+};
+declare namespace DeliveredSourceNotIndexedIcmMessage {
+    enum status {
+        DELIVERED_SOURCE_NOT_INDEXED = "delivered_source_not_indexed"
+    }
+}
+
+type PendingIcmMessage = {
+    messageId: string;
+    icmContractAddress: string;
+    sourceBlockchainId: string;
+    destinationBlockchainId: string;
+    sourceEvmChainId: string;
+    destinationEvmChainId: string;
+    messageNonce: string;
+    from: string;
+    to: string;
+    data?: string;
+    messageExecuted: boolean;
+    receipts: Array<IcmReceipt>;
+    receiptDelivered: boolean;
+    rewardDetails: IcmRewardDetails;
+    sourceTransaction: IcmSourceTransaction;
+    status: PendingIcmMessage.status;
+};
+declare namespace PendingIcmMessage {
+    enum status {
+        PENDING = "pending"
+    }
+}
+
+type ListIcmMessagesResponse = {
+    /**
+     * 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.
+     */
+    nextPageToken?: string;
+    messages: Array<(PendingIcmMessage | DeliveredIcmMessage)>;
+};
+
+declare class InterchainMessagingService {
+    readonly httpRequest: BaseHttpRequest;
+    constructor(httpRequest: BaseHttpRequest);
+    /**
+     * Get an ICM message
+     * Gets an ICM message by message ID.
+     * @returns any Successful response
+     * @throws ApiError
+     */
+    getIcmMessage({ messageId, }: {
+        /**
+         * The message ID of the ICM message.
+         */
+        messageId: string;
+    }): CancelablePromise<(PendingIcmMessage | DeliveredIcmMessage | DeliveredSourceNotIndexedIcmMessage)>;
+    /**
+     * List ICM messages
+     * Lists ICM messages. Ordered by timestamp in descending order.
+     * @returns ListIcmMessagesResponse Successful response
+     * @throws ApiError
+     */
+    listIcmMessages({ pageToken, pageSize, sourceBlockchainId, destinationBlockchainId, blockchainId, to, from, network, }: {
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * The base58 encoded blockchain ID or evm chain ID of the source chain that the ICM message was sent from.
+         */
+        sourceBlockchainId?: string;
+        /**
+         * The base58 encoded blockchain ID or evm chain ID of the destination chain that the ICM message was sent to.
+         */
+        destinationBlockchainId?: string;
+        /**
+         * The base58 encoded blockchain ID of either source or destination chain that one ICM message interacts with.
+         */
+        blockchainId?: string;
+        /**
+         * The address of the recipient of the ICM message.
+         */
+        to?: string;
+        /**
+         * The address of the sender of the ICM message.
+         */
+        from?: string;
+        /**
+         * Either mainnet or testnet/fuji.
+         */
+        network?: Network;
+    }): CancelablePromise<ListIcmMessagesResponse>;
+    /**
+     * List ICM messages by address
+     * Lists ICM messages by address. Ordered by timestamp in descending order.
+     * @returns ListIcmMessagesResponse Successful response
+     * @throws ApiError
+     */
+    listIcmMessagesByAddress({ address, pageToken, pageSize, network, }: {
+        /**
+         * An EVM address.
+         */
+        address: string;
+        /**
+         * A page token, received from a previous list call. Provide this to retrieve the subsequent page.
+         */
+        pageToken?: string;
+        /**
+         * The maximum number of items to return. The minimum page size is 1. The maximum pageSize is 100.
+         */
+        pageSize?: number;
+        /**
+         * Either mainnet or testnet/fuji.
+         */
+        network?: Network;
+    }): CancelablePromise<ListIcmMessagesResponse>;
+}
+
 type ListNftTokens = {
     /**
      * 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.
@@ -5272,8 +5487,10 @@ declare class TeleporterService {
     readonly httpRequest: BaseHttpRequest;
     constructor(httpRequest: BaseHttpRequest);
     /**
-     * Get a teleporter message
-     * Gets a teleporter message by message ID.
+     * @deprecated
+     * **[Deprecated]** Gets a teleporter message by message ID.
+     *
+     * ⚠️ **This operation will be removed in a future release.  Please use /v1/icm/messages/:messageId endpoint instead** .
      * @returns any Successful response
      * @throws ApiError
      */
@@ -5284,8 +5501,10 @@ declare class TeleporterService {
         messageId: string;
     }): CancelablePromise<(PendingTeleporterMessage | DeliveredTeleporterMessage | DeliveredSourceNotIndexedTeleporterMessage)>;
     /**
-     * List teleporter messages
-     * Lists teleporter messages. Ordered by timestamp in descending order.
+     * @deprecated
+     * **[Deprecated]** Lists teleporter messages. Ordered by timestamp in  descending order.
+     *
+     * ⚠️ **This operation will be removed in a future release.  Please use /v1/icm/messages endpoint instead** .
      * @returns ListTeleporterMessagesResponse Successful response
      * @throws ApiError
      */
@@ -5324,8 +5543,10 @@ declare class TeleporterService {
         network?: Network;
     }): CancelablePromise<ListTeleporterMessagesResponse>;
     /**
-     * List teleporter messages by address
-     * Lists teleporter messages by address. Ordered by timestamp in descending order.
+     * @deprecated
+     * **[Deprecated]** Lists teleporter messages by address. Ordered by  timestamp in descending order.
+     *
+     * ⚠️ **This operation will be removed in a future release.  Please use /v1/icm/addresses/:address/messages endpoint instead** .
      * @returns ListTeleporterMessagesResponse Successful response
      * @throws ApiError
      */
@@ -5592,6 +5813,7 @@ declare class Glacier {
     readonly evmContracts: EvmContractsService;
     readonly evmTransactions: EvmTransactionsService;
     readonly healthCheck: HealthCheckService;
+    readonly interchainMessaging: InterchainMessagingService;
     readonly nfTs: NfTsService;
     readonly operations: OperationsService;
     readonly primaryNetwork: PrimaryNetworkService;
@@ -5756,4 +5978,4 @@ type Unauthorized = {
     error: string;
 };
 
-export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, ApiFeature, AssetAmount, AssetWithPriceInfo, BadGateway, BadRequest, BalanceOwner, 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, CreateWebhookRequest, CurrencyCode, DataApiUsageMetricsService, DataListChainsResponse, 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, Forbidden, FullNativeTransactionDetails, GetChainResponse, GetEvmBlockResponse, GetNativeBalanceResponse, GetNetworkDetailsResponse, GetPrimaryNetworkBlockResponse, GetTransactionResponse, Glacier, HealthCheckService, HistoricalReward, ImageAsset, InternalServerError, InternalTransaction, InternalTransactionDetails, InternalTransactionOpCall, L1ValidatorDetailsFull, L1ValidatorDetailsTransaction, L1ValidatorManagerDetails, ListAddressChainsResponse, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListInternalTransactionsResponse, ListL1ValidatorsResponse, ListNativeTransactionsResponse, ListNftTokens, ListPChainBalancesResponse, ListPChainTransactionsResponse, ListPChainUtxosResponse, ListPendingRewardsResponse, ListPrimaryNetworkBlocksResponse, ListSubnetsResponse, ListTeleporterMessagesResponse, ListTransactionDetailsResponse, ListTransfersResponse, ListUtxosResponse, ListValidatorDetailsResponse, ListWebhookAddressesResponse, ListWebhooksResponse, ListXChainBalancesResponse, ListXChainTransactionsResponse, ListXChainVerticesResponse, LogsFormat, LogsFormatMetadata, LogsResponseDTO, Method, Metric, Money, NativeTokenBalance, NativeTransaction, Network, NetworkToken, NetworkTokenDetails, NextPageToken, NfTsService, NftTokenMetadataStatus, NotFound, OpenAPI, OpenAPIConfig, OperationStatus, OperationStatusCode, OperationStatusResponse, OperationType, OperationsService, PChainBalance, PChainId, PChainSharedAsset, PChainTransaction, PChainTransactionType, PChainUtxo, PendingDelegatorDetails, PendingReward, PendingTeleporterMessage, PendingValidatorDetails, PricingProviders, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkRpcMetricsGroupByEnum, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RemovedValidatorDetails, RequestType, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcMetrics, RpcUsageMetricsGroupByEnum, RpcUsageMetricsValueAggregated, ServiceUnavailable, SharedSecretsResponse, SignatureAggregationResponse, SignatureAggregatorRequest, SignatureAggregatorService, SortByOption, SortOrder, StakingDistribution, Subnet, SubnetOwnershipInfo, SubnetRpcTimeIntervalGranularity, SubnetRpcUsageMetricsResponseDTO, TeleporterDestinationTransaction, TeleporterMessageInfo, TeleporterReceipt, TeleporterRewardDetails, TeleporterService, TeleporterSourceTransaction, TimeIntervalGranularityExtended, TooManyRequests, TransactionDetails, TransactionDirectionType, TransactionExportMetadata, TransactionMethodType, TransactionStatus, TransactionVertexDetail, Unauthorized, UnknownContract, UpdateContractResponse, UpdateWebhookRequest, UsageMetricsGroupByEnum, UsageMetricsResponseDTO, UsageMetricsValueDTO, UtilityAddresses, Utxo, UtxoCredential, UtxoType, ValidationStatusType, ValidatorHealthDetails, ValidatorsDetails, VmName, WebhookResponse, WebhookStatus, WebhookStatusType, WebhooksService, XChainAssetDetails, XChainBalances, XChainId, XChainLinearTransaction, XChainNonLinearTransaction, XChainSharedAssetBalance, XChainTransactionType, XChainVertex };
+export { ActiveDelegatorDetails, ActiveValidatorDetails, AddressActivityMetadata, AddressesChangeRequest, AggregatedAssetAmount, ApiError, ApiFeature, AssetAmount, AssetWithPriceInfo, BadGateway, BadRequest, BalanceOwner, 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, CreateWebhookRequest, CurrencyCode, DataApiUsageMetricsService, DataListChainsResponse, DefaultService, DelegationStatusType, DelegatorsDetails, DeliveredIcmMessage, DeliveredSourceNotIndexedIcmMessage, 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, Forbidden, FullNativeTransactionDetails, GetChainResponse, GetEvmBlockResponse, GetNativeBalanceResponse, GetNetworkDetailsResponse, GetPrimaryNetworkBlockResponse, GetTransactionResponse, Glacier, HealthCheckService, HistoricalReward, IcmDestinationTransaction, IcmReceipt, IcmRewardDetails, IcmSourceTransaction, ImageAsset, InterchainMessagingService, InternalServerError, InternalTransaction, InternalTransactionDetails, InternalTransactionOpCall, L1ValidatorDetailsFull, L1ValidatorDetailsTransaction, L1ValidatorManagerDetails, ListAddressChainsResponse, ListBlockchainsResponse, ListCChainAtomicBalancesResponse, ListCChainAtomicTransactionsResponse, ListChainsResponse, ListCollectibleBalancesResponse, ListContractsResponse, ListDelegatorDetailsResponse, ListErc1155BalancesResponse, ListErc1155TransactionsResponse, ListErc20BalancesResponse, ListErc20TransactionsResponse, ListErc721BalancesResponse, ListErc721TransactionsResponse, ListEvmBlocksResponse, ListHistoricalRewardsResponse, ListIcmMessagesResponse, ListInternalTransactionsResponse, ListL1ValidatorsResponse, ListNativeTransactionsResponse, ListNftTokens, ListPChainBalancesResponse, ListPChainTransactionsResponse, ListPChainUtxosResponse, ListPendingRewardsResponse, ListPrimaryNetworkBlocksResponse, ListSubnetsResponse, ListTeleporterMessagesResponse, ListTransactionDetailsResponse, ListTransfersResponse, ListUtxosResponse, ListValidatorDetailsResponse, ListWebhookAddressesResponse, ListWebhooksResponse, ListXChainBalancesResponse, ListXChainTransactionsResponse, ListXChainVerticesResponse, LogsFormat, LogsFormatMetadata, LogsResponseDTO, Method, Metric, Money, NativeTokenBalance, NativeTransaction, Network, NetworkToken, NetworkTokenDetails, NextPageToken, NfTsService, NftTokenMetadataStatus, NotFound, OpenAPI, OpenAPIConfig, OperationStatus, OperationStatusCode, OperationStatusResponse, OperationType, OperationsService, PChainBalance, PChainId, PChainSharedAsset, PChainTransaction, PChainTransactionType, PChainUtxo, PendingDelegatorDetails, PendingIcmMessage, PendingReward, PendingTeleporterMessage, PendingValidatorDetails, PricingProviders, PrimaryNetworkAssetCap, PrimaryNetworkAssetType, PrimaryNetworkBalancesService, PrimaryNetworkBlock, PrimaryNetworkBlocksService, PrimaryNetworkChainInfo, PrimaryNetworkChainName, PrimaryNetworkOperationType, PrimaryNetworkOptions, PrimaryNetworkRewardsService, PrimaryNetworkRpcMetricsGroupByEnum, PrimaryNetworkService, PrimaryNetworkTransactionsService, PrimaryNetworkTxType, PrimaryNetworkUtxOsService, PrimaryNetworkVerticesService, ProposerDetails, RemovedValidatorDetails, RequestType, ResourceLink, ResourceLinkType, RewardType, Rewards, RichAddress, RpcMetrics, RpcUsageMetricsGroupByEnum, RpcUsageMetricsValueAggregated, ServiceUnavailable, SharedSecretsResponse, SignatureAggregationResponse, SignatureAggregatorRequest, SignatureAggregatorService, SortByOption, SortOrder, StakingDistribution, Subnet, SubnetOwnershipInfo, SubnetRpcTimeIntervalGranularity, SubnetRpcUsageMetricsResponseDTO, TeleporterDestinationTransaction, TeleporterMessageInfo, TeleporterReceipt, TeleporterRewardDetails, TeleporterService, TeleporterSourceTransaction, TimeIntervalGranularityExtended, TooManyRequests, TransactionDetails, TransactionDirectionType, TransactionExportMetadata, TransactionMethodType, TransactionStatus, TransactionVertexDetail, Unauthorized, UnknownContract, UpdateContractResponse, UpdateWebhookRequest, UsageMetricsGroupByEnum, UsageMetricsResponseDTO, UsageMetricsValueDTO, UtilityAddresses, Utxo, UtxoCredential, UtxoType, ValidationStatusType, ValidatorHealthDetails, ValidatorsDetails, VmName, WebhookResponse, WebhookStatus, WebhookStatusType, WebhooksService, XChainAssetDetails, XChainBalances, XChainId, XChainLinearTransaction, XChainNonLinearTransaction, XChainSharedAssetBalance, XChainTransactionType, XChainVertex };