@imtbl/sdk 0.1.8-alpha.2 → 0.1.9-alpha

package/dist/blockchain-data.d.ts

@@ -49,17 +49,52 @@ interface BasicAPIError {
  * Do not edit the class manually.
  */
 /**
- * The activity type
+ * The contract type for an NFT
  * @export
  * @enum {string}
  */
-declare const ActivityType: {
-    readonly Mint: "mint";
-    readonly Burn: "burn";
-    readonly Transfer: "transfer";
-    readonly Sale: "sale";
+declare const NFTContractType: {
+    readonly Erc721: "ERC721";
 };
-type ActivityType = typeof ActivityType[keyof typeof ActivityType];
+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
@@ -73,15 +108,14 @@ type ActivityType = typeof ActivityType[keyof typeof ActivityType];
  * Do not edit the class manually.
  */
 /**
- * The contract type
+ * The contract type for a token
  * @export
  * @enum {string}
  */
-declare const ContractType: {
-    readonly Erc721: "ERC721";
+declare const TokenContractType: {
     readonly Erc20: "ERC20";
 };
-type ContractType = typeof ContractType[keyof typeof ContractType];
+type TokenContractType = typeof TokenContractType[keyof typeof TokenContractType];
 
 /**
  * Immutable X API
@@ -98,33 +132,21 @@ type ContractType = typeof ContractType[keyof typeof ContractType];
 /**
  *
  * @export
- * @interface ERC20
+ * @interface ActivityToken
  */
-interface ERC20 {
+interface ActivityToken {
     /**
      *
-     * @type {ContractType}
-     * @memberof ERC20
+     * @type {TokenContractType}
+     * @memberof ActivityToken
      */
-    'contract_type': ContractType;
+    'contract_type': TokenContractType;
     /**
-     * The token contract address
+     * The contract address
      * @type {string}
-     * @memberof ERC20
+     * @memberof ActivityToken
      */
     'contract_address': string;
-    /**
-     * The symbol of the token
-     * @type {string}
-     * @memberof ERC20
-     */
-    'symbol': string | null;
-    /**
-     * The decimal places of a token
-     * @type {number}
-     * @memberof ERC20
-     */
-    'decimals': number | null;
 }
 
 /**
@@ -140,30 +162,11 @@ interface ERC20 {
  */
 
 /**
- *
+ * @type ActivityAsset
+ * The contract and asset details for this activity
  * @export
- * @interface ERC721Token
  */
-interface ERC721Token {
-    /**
-     *
-     * @type {ContractType}
-     * @memberof ERC721Token
-     */
-    'contract_type': ContractType;
-    /**
-     * The token contract address
-     * @type {string}
-     * @memberof ERC721Token
-     */
-    'contract_address': string;
-    /**
-     * An `uint256` token id as string
-     * @type {string}
-     * @memberof ERC721Token
-     */
-    'token_id': string;
-}
+type ActivityAsset = ActivityNFT | ActivityToken;
 
 /**
  * Immutable X API
@@ -176,13 +179,18 @@ interface ERC721Token {
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-
 /**
- * @type Token
- * The token details
+ * The activity type
  * @export
+ * @enum {string}
  */
-type Token = ERC20 | ERC721Token;
+declare const ActivityType: {
+    readonly Mint: "mint";
+    readonly Burn: "burn";
+    readonly Transfer: "transfer";
+    readonly Sale: "sale";
+};
+type ActivityType = typeof ActivityType[keyof typeof ActivityType];
 
 /**
  * Immutable X API
@@ -209,23 +217,23 @@ interface Burn {
      */
     'activity_type': ActivityType;
     /**
-     * The account address the token was transferred from
+     * The account address the asset was transferred from
      * @type {string}
      * @memberof Burn
      */
     'from': string;
     /**
-     * The amount of tokens burnt
+     * The amount of assets burnt
      * @type {string}
      * @memberof Burn
      */
     'amount': string;
     /**
      *
-     * @type {Token}
+     * @type {ActivityAsset}
      * @memberof Burn
      */
-    'token': Token;
+    'asset': ActivityAsset;
 }
 
 /**
@@ -253,23 +261,23 @@ interface Mint {
      */
     'activity_type': ActivityType;
     /**
-     * The account address token minted to
+     * The account address the asset was minted to
      * @type {string}
      * @memberof Mint
      */
     'to': string;
     /**
-     * The minted token amount
+     * The minted amount
      * @type {string}
      * @memberof Mint
      */
     'amount': string;
     /**
      *
-     * @type {Token}
+     * @type {ActivityAsset}
      * @memberof Mint
      */
-    'token': Token;
+    'asset': ActivityAsset;
 }
 
 /**
@@ -286,13 +294,54 @@ interface Mint {
 /**
  *
  * @export
- * @interface NativeToken
+ * @interface SaleFee
  */
-interface NativeToken {
+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 NativeToken
+     * @memberof ActivityNativeToken
      */
     'symbol': string;
 }
@@ -310,11 +359,55 @@ interface NativeToken {
  */
 
 /**
- * @type NFTSalePaymentToken
+ * @type SalePaymentToken
  * The type of payment token
  * @export
  */
-type NFTSalePaymentToken = ERC20 | NativeToken;
+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
@@ -351,37 +444,25 @@ interface NFTSale {
      * @type {string}
      * @memberof NFTSale
      */
-    'buyer_address': string;
+    'to': string;
     /**
      * The account address of seller
      * @type {string}
      * @memberof NFTSale
      */
-    'seller_address': string;
-    /**
-     * The quantity of tokens sold
-     * @type {number}
-     * @memberof NFTSale
-     */
-    'quantity': number;
+    'from': string;
     /**
      *
-     * @type {ERC721Token}
+     * @type {Array<ActivityNFT>}
      * @memberof NFTSale
      */
-    'token': ERC721Token;
-    /**
-     * The amount of payment
-     * @type {string}
-     * @memberof NFTSale
-     */
-    'payment_amount': string;
+    'asset': Array<ActivityNFT>;
     /**
      *
-     * @type {NFTSalePaymentToken}
+     * @type {SalePayment}
      * @memberof NFTSale
      */
-    'payment_token': NFTSalePaymentToken;
+    'payment': SalePayment;
 }
 
 /**
@@ -409,29 +490,29 @@ interface Transfer {
      */
     'activity_type': ActivityType;
     /**
-     * The account address the token was transferred from
+     * The account address the asset was transferred from
      * @type {string}
      * @memberof Transfer
      */
     'from': string;
     /**
-     * The account address the token was transferred to
+     * The account address the asset was transferred to
      * @type {string}
      * @memberof Transfer
      */
     'to': string;
     /**
-     * The amount of tokens transferred
+     * The amount of assets transferred
      * @type {string}
      * @memberof Transfer
      */
     'amount': string;
     /**
      *
-     * @type {Token}
+     * @type {ActivityAsset}
      * @memberof Transfer
      */
-    'token': Token;
+    'asset': ActivityAsset;
 }
 
 /**
@@ -583,6 +664,49 @@ interface 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
@@ -875,12 +999,6 @@ interface NFTMetadataAttribute {
      * @memberof NFTMetadataAttribute
      */
     'value': string;
-    /**
-     * The metadata trait display type
-     * @type {string}
-     * @memberof NFTMetadataAttribute
-     */
-    'display_type': string;
 }
 
 /**
@@ -954,6 +1072,88 @@ interface 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
+     */
+    '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
@@ -972,17 +1172,17 @@ interface GetNFTResult {
  */
 interface Page {
     /**
-     * First item as base64 encoded string
+     * First item as an encoded string
      * @type {string}
      * @memberof Page
      */
-    'previous_cursor': string;
+    'previous_cursor': string | null;
     /**
-     * Last item as base64 encoded string
+     * Last item as an encoded string
      * @type {string}
      * @memberof Page
      */
-    'next_cursor': string;
+    'next_cursor': string | null;
 }
 
 /**
@@ -1037,10 +1237,10 @@ interface ListActivitiesResult {
 interface ListChainsResult {
     /**
      * List of chains
-     * @type {Array<Chain>}
+     * @type {Array<ChainWithDetails>}
      * @memberof ListChainsResult
      */
-    'result': Array<Chain>;
+    'result': Array<ChainWithDetails>;
     /**
      *
      * @type {Page}
@@ -1195,6 +1395,38 @@ interface 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
@@ -1269,7 +1501,7 @@ interface ActivitiesApiListActivitiesRequest {
      */
     readonly transactionHash?: string;
     /**
-     * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
      * @memberof ActivitiesApiListActivities
      */
@@ -1289,7 +1521,7 @@ interface ActivitiesApiListActivitiesRequest {
  */
 interface ChainsApiListChainsRequest {
     /**
-     * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
      * @memberof ChainsApiListChains
      */
@@ -1334,7 +1566,7 @@ interface CollectionsApiListCollectionsRequest {
      */
     readonly chainName: string;
     /**
-     * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
      * @memberof CollectionsApiListCollections
      */
@@ -1372,7 +1604,7 @@ interface NftOwnersApiListNFTOwnersRequest {
      */
     readonly chainName: string;
     /**
-     * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
      * @memberof NftOwnersApiListNFTOwners
      */
@@ -1429,7 +1661,7 @@ interface NftsApiListNFTsRequest {
      */
     readonly chainName: string;
     /**
-     * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
      * @memberof NftsApiListNFTs
      */
@@ -1466,7 +1698,7 @@ interface NftsApiListNFTsByAccountAddressRequest {
      */
     readonly contractAddress?: string;
     /**
-     * Base64 encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}
      * @memberof NftsApiListNFTsByAccountAddress
      */
@@ -1479,6 +1711,51 @@ interface NftsApiListNFTsByAccountAddressRequest {
     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: {
@@ -1505,6 +1782,7 @@ declare class BlockchainData {
     private readonly collections;
     private readonly nfts;
     private readonly nftOwners;
+    private readonly tokens;
     constructor(moduleConfig: BlockchainDataModuleConfiguration$1);
     /**
      * List all activities
@@ -1569,6 +1847,20 @@ declare class BlockchainData {
      * @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 {