@imtbl/sdk 0.3.0 → 0.3.2-alpha

package/dist/blockchain-data.d.ts

@@ -0,0 +1,1893 @@
+import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1 } from 'config';
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface BasicAPIError
+ */
+interface BasicAPIError {
+    /**
+     * Error Message
+     * @type {string}
+     * @memberof BasicAPIError
+     */
+    'message': string;
+    /**
+     * Link to IMX documentation that can help resolve this error
+     * @type {string}
+     * @memberof BasicAPIError
+     */
+    'link': string;
+    /**
+     * Trace ID of the initial request
+     * @type {string}
+     * @memberof BasicAPIError
+     */
+    'trace_id': string;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The contract type for an NFT
+ * @export
+ * @enum {string}
+ */
+declare const NFTContractType: {
+    readonly Erc721: "ERC721";
+};
+type NFTContractType = typeof NFTContractType[keyof typeof NFTContractType];
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ActivityNFT
+ */
+interface ActivityNFT {
+    /**
+     *
+     * @type {NFTContractType}
+     * @memberof ActivityNFT
+     */
+    'contract_type': NFTContractType;
+    /**
+     * The token contract address
+     * @type {string}
+     * @memberof ActivityNFT
+     */
+    'contract_address': string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof ActivityNFT
+     */
+    'token_id': string;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The contract type for a token
+ * @export
+ * @enum {string}
+ */
+declare const TokenContractType: {
+    readonly Erc20: "ERC20";
+};
+type TokenContractType = typeof TokenContractType[keyof typeof TokenContractType];
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ActivityToken
+ */
+interface ActivityToken {
+    /**
+     *
+     * @type {TokenContractType}
+     * @memberof ActivityToken
+     */
+    'contract_type': TokenContractType;
+    /**
+     * The contract address
+     * @type {string}
+     * @memberof ActivityToken
+     */
+    'contract_address': string;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type ActivityAsset
+ * The contract and asset details for this activity
+ * @export
+ */
+type ActivityAsset = ActivityNFT | ActivityToken;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The burn activity details
+ * @export
+ * @interface Burn
+ */
+interface Burn {
+    /**
+     * The account address the asset was transferred from
+     * @type {string}
+     * @memberof Burn
+     */
+    'from': string;
+    /**
+     * The amount of assets burnt
+     * @type {string}
+     * @memberof Burn
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Burn
+     */
+    'asset': ActivityAsset;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The mint activity details
+ * @export
+ * @interface Mint
+ */
+interface Mint {
+    /**
+     * The account address the asset was minted to
+     * @type {string}
+     * @memberof Mint
+     */
+    'to': string;
+    /**
+     * The minted amount
+     * @type {string}
+     * @memberof Mint
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Mint
+     */
+    'asset': ActivityAsset;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SaleFee
+ */
+interface SaleFee {
+    /**
+     * Fee payable to recipient upon settlement
+     * @type {string}
+     * @memberof SaleFee
+     */
+    'amount'?: string;
+    /**
+     * Fee type
+     * @type {string}
+     * @memberof SaleFee
+     */
+    'type'?: SaleFeeTypeEnum;
+    /**
+     * Wallet address of fee recipient
+     * @type {string}
+     * @memberof SaleFee
+     */
+    'recipient'?: string;
+}
+declare const SaleFeeTypeEnum: {
+    readonly Royalty: "ROYALTY";
+};
+type SaleFeeTypeEnum = typeof SaleFeeTypeEnum[keyof typeof SaleFeeTypeEnum];
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ActivityNativeToken
+ */
+interface ActivityNativeToken {
+    /**
+     * The token symbol
+     * @type {string}
+     * @memberof ActivityNativeToken
+     */
+    'symbol': string;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type SalePaymentToken
+ * The type of payment token
+ * @export
+ */
+type SalePaymentToken = ActivityNativeToken | ActivityToken;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface SalePayment
+ */
+interface SalePayment {
+    /**
+     *
+     * @type {SalePaymentToken}
+     * @memberof SalePayment
+     */
+    'token': SalePaymentToken;
+    /**
+     * The base price of the sale not including any fees
+     * @type {string}
+     * @memberof SalePayment
+     */
+    'price_excluding_fees': string;
+    /**
+     * The total price of the sale. Includes the sum of all fees
+     * @type {string}
+     * @memberof SalePayment
+     */
+    'price_including_fees': string;
+    /**
+     * The fees associated with this sale
+     * @type {Array<SaleFee>}
+     * @memberof SalePayment
+     */
+    'fees': Array<SaleFee>;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The NFT Sale activity details
+ * @export
+ * @interface NFTSale
+ */
+interface NFTSale {
+    /**
+     * The id of order
+     * @type {string}
+     * @memberof NFTSale
+     */
+    'order_id': string;
+    /**
+     * The account address of buyer
+     * @type {string}
+     * @memberof NFTSale
+     */
+    'to': string;
+    /**
+     * The account address of seller
+     * @type {string}
+     * @memberof NFTSale
+     */
+    'from': string;
+    /**
+     *
+     * @type {Array<ActivityNFT>}
+     * @memberof NFTSale
+     */
+    'asset': Array<ActivityNFT>;
+    /**
+     *
+     * @type {SalePayment}
+     * @memberof NFTSale
+     */
+    'payment': SalePayment;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * The transfer activity details
+ * @export
+ * @interface Transfer
+ */
+interface Transfer {
+    /**
+     * The account address the asset was transferred from
+     * @type {string}
+     * @memberof Transfer
+     */
+    'from': string;
+    /**
+     * The account address the asset was transferred to
+     * @type {string}
+     * @memberof Transfer
+     */
+    'to': string;
+    /**
+     * The amount of assets transferred
+     * @type {string}
+     * @memberof Transfer
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Transfer
+     */
+    'asset': ActivityAsset;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type ActivityDetails
+ * The activity details
+ * @export
+ */
+type ActivityDetails = Burn | Mint | NFTSale | Transfer;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The activity type
+ * @export
+ * @enum {string}
+ */
+declare const ActivityType$1: {
+    readonly Mint: "mint";
+    readonly Burn: "burn";
+    readonly Transfer: "transfer";
+    readonly Sale: "sale";
+};
+type ActivityType$1 = typeof ActivityType$1[keyof typeof ActivityType$1];
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The metadata related to blockchain transaction
+ * @export
+ * @interface BlockchainMetadata
+ */
+interface BlockchainMetadata {
+    /**
+     * The transaction hash of the activity
+     * @type {string}
+     * @memberof BlockchainMetadata
+     */
+    'transaction_hash': string;
+    /**
+     * EVM block number (uint64 as string)
+     * @type {string}
+     * @memberof BlockchainMetadata
+     */
+    'block_number': string;
+    /**
+     * Transaction index in a block (uint32 as string)
+     * @type {string}
+     * @memberof BlockchainMetadata
+     */
+    'transaction_index': string;
+    /**
+     * The log index of activity in a block (uint32 as string)
+     * @type {string}
+     * @memberof BlockchainMetadata
+     */
+    'log_index': string | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The chain details
+ * @export
+ * @interface Chain
+ */
+interface Chain {
+    /**
+     * The id of chain
+     * @type {string}
+     * @memberof Chain
+     */
+    'id': string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof Chain
+     */
+    'name': string;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface Activity
+ */
+interface Activity {
+    /**
+     * Activity ID in UUIDv4 format
+     * @type {string}
+     * @memberof Activity
+     */
+    'id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Activity
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {ActivityType}
+     * @memberof Activity
+     */
+    'type': ActivityType$1;
+    /**
+     *
+     * @type {ActivityDetails}
+     * @memberof Activity
+     */
+    'details': ActivityDetails;
+    /**
+     * The time activity was indexed
+     * @type {string}
+     * @memberof Activity
+     */
+    'indexed_at': string;
+    /**
+     *
+     * @type {BlockchainMetadata}
+     * @memberof Activity
+     */
+    'blockchain_metadata': BlockchainMetadata | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ChainWithDetailsAllOf
+ */
+interface ChainWithDetailsAllOf {
+    /**
+     * URL for RPC node
+     * @type {string}
+     * @memberof ChainWithDetailsAllOf
+     */
+    'rpc_url': string | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type ChainWithDetails
+ * @export
+ */
+type ChainWithDetails = Chain & ChainWithDetailsAllOf;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The collection contract type
+ * @export
+ * @enum {string}
+ */
+declare const CollectionContractType: {
+    readonly Erc721: "ERC721";
+};
+type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface Collection
+ */
+interface Collection {
+    /**
+     *
+     * @type {Chain}
+     * @memberof Collection
+     */
+    'chain': Chain;
+    /**
+     * The name of the collection
+     * @type {string}
+     * @memberof Collection
+     */
+    'name': string | null;
+    /**
+     * The symbol of contract
+     * @type {string}
+     * @memberof Collection
+     */
+    'symbol': string | null;
+    /**
+     *
+     * @type {CollectionContractType}
+     * @memberof Collection
+     */
+    'contract_type': CollectionContractType;
+    /**
+     * The address of the contract
+     * @type {string}
+     * @memberof Collection
+     */
+    'contract_address': string;
+    /**
+     * The description of collection
+     * @type {string}
+     * @memberof Collection
+     */
+    'description': string | null;
+    /**
+     * The url of the collection image
+     * @type {string}
+     * @memberof Collection
+     */
+    'image': string | null;
+    /**
+     * The url of external link
+     * @type {string}
+     * @memberof Collection
+     */
+    'external_link': string | null;
+    /**
+     * The uri for the metadata of the collection
+     * @type {string}
+     * @memberof Collection
+     */
+    'contract_uri'?: string | null;
+    /**
+     * The metadata uri for nft
+     * @type {string}
+     * @memberof Collection
+     */
+    'base_uri': string | null;
+    /**
+     * When the collection was first indexed
+     * @type {string}
+     * @memberof Collection
+     */
+    'indexed_at': string;
+    /**
+     * When the collection was last updated
+     * @type {string}
+     * @memberof Collection
+     */
+    'updated_at': string;
+    /**
+     * When the collection metadata was last synced
+     * @type {string}
+     * @memberof Collection
+     */
+    'last_metadata_synced_at': string | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Single activity
+ * @export
+ * @interface GetActivityResult
+ */
+interface GetActivityResult {
+    /**
+     *
+     * @type {Activity}
+     * @memberof GetActivityResult
+     */
+    'result': Activity;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Single Collection
+ * @export
+ * @interface GetCollectionResult
+ */
+interface GetCollectionResult {
+    /**
+     *
+     * @type {Collection}
+     * @memberof GetCollectionResult
+     */
+    'result': Collection;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface NFT
+ */
+interface NFT {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFT
+     */
+    'chain': Chain;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof NFT
+     */
+    'token_id': string;
+    /**
+     * The contract address of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'contract_address': string;
+    /**
+     * When the NFT was first indexed
+     * @type {string}
+     * @memberof NFT
+     */
+    'indexed_at': string;
+    /**
+     * When NFT metadata was last synced
+     * @type {string}
+     * @memberof NFT
+     */
+    'metadata_synced_at': string | null;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'image': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'external_link': string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'youtube_url': string | null;
+    /**
+     * The id of mint activity of this NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'mint_activity_id': string | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * @type NFTMetadataAttributeValue
+ * The metadata trait value
+ * @export
+ */
+type NFTMetadataAttributeValue = boolean | number | string;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface NFTMetadataAttribute
+ */
+interface NFTMetadataAttribute {
+    /**
+     * The metadata trait type
+     * @type {string}
+     * @memberof NFTMetadataAttribute
+     */
+    'trait_type': string;
+    /**
+     *
+     * @type {NFTMetadataAttributeValue}
+     * @memberof NFTMetadataAttribute
+     */
+    'value': NFTMetadataAttributeValue;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * List of normalized NFT metadata attributes
+ * @export
+ * @interface NFTMetadataAttributes
+ */
+interface NFTMetadataAttributes {
+    /**
+     * List of NFT Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof NFTMetadataAttributes
+     */
+    'attributes': Array<NFTMetadataAttribute>;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type NFTWithMetadataAttributes
+ * A single NFT with metadata attributes
+ * @export
+ */
+type NFTWithMetadataAttributes = NFT & NFTMetadataAttributes;
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Single NFT
+ * @export
+ * @interface GetNFTResult
+ */
+interface GetNFTResult {
+    /**
+     *
+     * @type {NFTWithMetadataAttributes}
+     * @memberof GetNFTResult
+     */
+    'result': NFTWithMetadataAttributes;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface Token
+ */
+interface Token {
+    /**
+     *
+     * @type {Chain}
+     * @memberof Token
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {string}
+     * @memberof Token
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Token
+     */
+    'root_contract_address': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Token
+     */
+    'symbol': string | null;
+    /**
+     *
+     * @type {number}
+     * @memberof Token
+     */
+    'decimals': number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Token
+     */
+    'image_url': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof Token
+     */
+    'name': string | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * Single Token
+ * @export
+ * @interface GetTokenResult
+ */
+interface GetTokenResult {
+    /**
+     *
+     * @type {Token}
+     * @memberof GetTokenResult
+     */
+    'result': Token;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Pagination properties
+ * @export
+ * @interface Page
+ */
+interface Page {
+    /**
+     * First item as an encoded string
+     * @type {string}
+     * @memberof Page
+     */
+    'previous_cursor': string | null;
+    /**
+     * Last item as an encoded string
+     * @type {string}
+     * @memberof Page
+     */
+    'next_cursor': string | null;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * List activities response
+ * @export
+ * @interface ListActivitiesResult
+ */
+interface ListActivitiesResult {
+    /**
+     * List of activities
+     * @type {Array<Activity>}
+     * @memberof ListActivitiesResult
+     */
+    'result': Array<Activity>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListActivitiesResult
+     */
+    'page': Page;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ListChainsResult
+ */
+interface ListChainsResult {
+    /**
+     * List of chains
+     * @type {Array<ChainWithDetails>}
+     * @memberof ListChainsResult
+     */
+    'result': Array<ChainWithDetails>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListChainsResult
+     */
+    'page': Page;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ListCollectionsResult
+ */
+interface ListCollectionsResult {
+    /**
+     * List of collections
+     * @type {Array<Collection>}
+     * @memberof ListCollectionsResult
+     */
+    'result': Array<Collection>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListCollectionsResult
+     */
+    'page': Page;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface NFTOwner
+ */
+interface NFTOwner {
+    /**
+     *
+     * @type {Chain}
+     * @memberof NFTOwner
+     */
+    'chain': Chain;
+    /**
+     * The address of NFT contract
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'contract_address': string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'token_id': string;
+    /**
+     * The account address of the owner of the NFT
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'account_address': string;
+    /**
+     * The quantity of owned tokens (uint256 as string)
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'quantity': string;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ListNFTOwnersResult
+ */
+interface ListNFTOwnersResult {
+    /**
+     * List of nft owners
+     * @type {Array<NFTOwner>}
+     * @memberof ListNFTOwnersResult
+     */
+    'result': Array<NFTOwner>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListNFTOwnersResult
+     */
+    'page': Page;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ListNFTsResult
+ */
+interface ListNFTsResult {
+    /**
+     * List of nfts
+     * @type {Array<NFT>}
+     * @memberof ListNFTsResult
+     */
+    'result': Array<NFT>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListNFTsResult
+     */
+    'page': Page;
+}
+
+/**
+ * Immutable X API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ *
+ * @export
+ * @interface ListTokensResult
+ */
+interface ListTokensResult {
+    /**
+     * List of tokens
+     * @type {Array<Token>}
+     * @memberof ListTokensResult
+     */
+    'result': Array<Token>;
+    /**
+     *
+     * @type {Page}
+     * @memberof ListTokensResult
+     */
+    'page': Page;
+}
+
+/**
+ * Request parameters for getActivity operation in ActivitiesApi.
+ * @export
+ * @interface ActivitiesApiGetActivityRequest
+ */
+interface ActivitiesApiGetActivityRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ActivitiesApiGetActivity
+     */
+    readonly chainName: string;
+    /**
+     * The id of activity
+     * @type {string}
+     * @memberof ActivitiesApiGetActivity
+     */
+    readonly activityId: string;
+}
+/**
+ * Request parameters for listActivities operation in ActivitiesApi.
+ * @export
+ * @interface ActivitiesApiListActivitiesRequest
+ */
+interface ActivitiesApiListActivitiesRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly chainName: string;
+    /**
+     * The contract address of NFT or ERC20 Token
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly contractAddress?: string;
+    /**
+     * An &#x60;uint256&#x60; token id as string
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly tokenId?: string;
+    /**
+     * The account address activity contains
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly accountAddress?: string;
+    /**
+     * The activity type
+     * @type {ActivityType}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly activityType?: ActivityType$1;
+    /**
+     * From indexed at including given date
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly fromIndexedAt?: string;
+    /**
+     * To indexed at including given date
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly toIndexedAt?: string;
+    /**
+     * The transaction hash of activity
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly transactionHash?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly pageSize?: number;
+}
+
+/**
+ * Request parameters for listChains operation in ChainsApi.
+ * @export
+ * @interface ChainsApiListChainsRequest
+ */
+interface ChainsApiListChainsRequest {
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ChainsApiListChains
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ChainsApiListChains
+     */
+    readonly pageSize?: number;
+}
+
+/**
+ * Request parameters for getCollection operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiGetCollectionRequest
+ */
+interface CollectionsApiGetCollectionRequest {
+    /**
+     * The address contract
+     * @type {string}
+     * @memberof CollectionsApiGetCollection
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiGetCollection
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listCollections operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiListCollectionsRequest
+ */
+interface CollectionsApiListCollectionsRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly pageSize?: number;
+}
+
+/**
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
+ * @export
+ * @interface NftOwnersApiListNFTOwnersRequest
+ */
+interface NftOwnersApiListNFTOwnersRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly contractAddress: string;
+    /**
+     * An &#x60;uint256&#x60; token id as string
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly tokenId: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftOwnersApiListNFTOwners
+     */
+    readonly pageSize?: number;
+}
+
+/**
+ * Request parameters for getNFT operation in NftsApi.
+ * @export
+ * @interface NftsApiGetNFTRequest
+ */
+interface NftsApiGetNFTRequest {
+    /**
+     * The address of NFT contract
+     * @type {string}
+     * @memberof NftsApiGetNFT
+     */
+    readonly contractAddress: string;
+    /**
+     * An &#x60;uint256&#x60; token id as string
+     * @type {string}
+     * @memberof NftsApiGetNFT
+     */
+    readonly tokenId: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiGetNFT
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listNFTs operation in NftsApi.
+ * @export
+ * @interface NftsApiListNFTsRequest
+ */
+interface NftsApiListNFTsRequest {
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListNFTs
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListNFTs
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
+ * @export
+ * @interface NftsApiListNFTsByAccountAddressRequest
+ */
+interface NftsApiListNFTsByAccountAddressRequest {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly chainName: string;
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly contractAddress?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof NftsApiListNFTsByAccountAddress
+     */
+    readonly pageSize?: number;
+}
+
+/**
+ * Request parameters for getERC20Token operation in TokensApi.
+ * @export
+ * @interface TokensApiGetERC20TokenRequest
+ */
+interface TokensApiGetERC20TokenRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof TokensApiGetERC20Token
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof TokensApiGetERC20Token
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listERC20Tokens operation in TokensApi.
+ * @export
+ * @interface TokensApiListERC20TokensRequest
+ */
+interface TokensApiListERC20TokensRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly pageSize?: number;
+}
+
+interface OpenAPIError extends BasicAPIError {
+    code: string;
+    details: {
+        [key: string]: any;
+    } | null;
+}
+/**
+ * Custom Error class that is returned from the API when a request fails
+ */
+declare class APIError extends Error {
+    readonly code: string;
+    readonly details: {
+        [key: string]: any;
+    } | null;
+    readonly link: string;
+    readonly traceId: string;
+    constructor({ message, code, details, link, trace_id: traceId, }: OpenAPIError);
+}
+
+declare class BlockchainData {
+    readonly config: BlockchainDataConfiguration;
+    private readonly activities;
+    private readonly chains;
+    private readonly collections;
+    private readonly nfts;
+    private readonly nftOwners;
+    private readonly tokens;
+    constructor(moduleConfig: BlockchainDataModuleConfiguration$1);
+    /**
+     * List all activities
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of activities
+     * @throws {@link index.APIError}
+     */
+    listActivities(request: ActivitiesApiListActivitiesRequest): Promise<ListActivitiesResult>;
+    /**
+     * Get a single activity by ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single activity
+     * @throws {@link index.APIError}
+     */
+    getActivity(request: ActivitiesApiGetActivityRequest): Promise<GetActivityResult>;
+    /**
+     * List supported chains
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of supported chains
+     * @throws {@link index.APIError}
+     */
+    listChains(request: ChainsApiListChainsRequest): Promise<ListChainsResult>;
+    /**
+     * List all collections
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of collections
+     * @throws {@link index.APIError}
+     */
+    listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
+    /**
+     * Get collection by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single collection
+     * @throws {@link index.APIError}
+     */
+    getCollection(request: CollectionsApiGetCollectionRequest): Promise<GetCollectionResult>;
+    /**
+     * Get NFT by token ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a single NFT
+     * @throws {@link index.APIError}
+     */
+    getNFT(request: NftsApiGetNFTRequest): Promise<GetNFTResult>;
+    /**
+     * List NFTs by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listNFTs(request: NftsApiListNFTsRequest): Promise<ListNFTsResult>;
+    /**
+     * List NFTs by account address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFTs
+     * @throws {@link index.APIError}
+     */
+    listNFTsByAccountAddress(request: NftsApiListNFTsByAccountAddressRequest): Promise<ListNFTsResult>;
+    /**
+     * List NFT owners by token ID
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of NFT owners
+     * @throws {@link index.APIError}
+     */
+    listNFTOwners(request: NftOwnersApiListNFTOwnersRequest): Promise<ListNFTOwnersResult>;
+    /**
+     * List ERC20 Token contracts
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of ERC20 Tokens
+     * @throws {@link index.APIError}
+     */
+    listTokens(request: TokensApiListERC20TokensRequest): Promise<ListTokensResult>;
+    /**
+     * Get details for an ERC20 Token by contract address
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of ERC20 Tokens
+     * @throws {@link index.APIError}
+     */
+    getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
+}
+
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
+interface APIConfigurationParams {
+    basePath: string;
+    headers?: Record<string, string>;
+}
+interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
+}
+
+type ActivityType = ActivityType$1;
+
+export { APIError, ActivityType, BlockchainData, BlockchainDataModuleConfiguration };