@imtbl/sdk 0.4.1-alpha → 0.4.2-alpha.1

package/dist/index.d.ts

@@ -23,7 +23,7 @@ interface ModuleConfiguration<T> {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -60,7 +60,7 @@ interface BasicAPIError {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -81,7 +81,7 @@ declare const NFTContractType: {
 type NFTContractType = typeof NFTContractType[keyof typeof NFTContractType];
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -119,7 +119,7 @@ interface ActivityNFT {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -140,7 +140,7 @@ declare const TokenContractType: {
 type TokenContractType = typeof TokenContractType[keyof typeof TokenContractType];
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -172,7 +172,7 @@ interface ActivityToken {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -191,7 +191,7 @@ interface ActivityToken {
 type ActivityAsset = ActivityNFT | ActivityToken;
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -229,7 +229,45 @@ interface Burn {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM 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 deposit activity details
+ * @export
+ * @interface Deposit
+ */
+interface Deposit$1 {
+    /**
+     * The account address the asset was deposited to
+     * @type {string}
+     * @memberof Deposit
+     */
+    'to': string;
+    /**
+     * The deposited amount
+     * @type {string}
+     * @memberof Deposit
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Deposit
+     */
+    'asset': ActivityAsset;
+}
+
+/**
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -267,7 +305,7 @@ interface Mint$1 {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -308,7 +346,7 @@ declare const SaleFeeTypeEnum: {
 type SaleFeeTypeEnum = typeof SaleFeeTypeEnum[keyof typeof SaleFeeTypeEnum];
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -333,7 +371,7 @@ interface ActivityNativeToken {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -352,7 +390,7 @@ interface ActivityNativeToken {
 type SalePaymentToken = ActivityNativeToken | ActivityToken;
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -396,7 +434,7 @@ interface SalePayment {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -446,7 +484,7 @@ interface NFTSale {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -490,7 +528,45 @@ interface Transfer$1 {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM 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 withdrawal activity details
+ * @export
+ * @interface Withdrawal
+ */
+interface Withdrawal$1 {
+    /**
+     * The account address the asset was withdrawn from
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'from': string;
+    /**
+     * The amount of assets withdrawn
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Withdrawal
+     */
+    'asset': ActivityAsset;
+}
+
+/**
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -506,10 +582,10 @@ interface Transfer$1 {
  * The activity details
  * @export
  */
-type ActivityDetails = Burn | Mint$1 | NFTSale | Transfer$1;
+type ActivityDetails = Burn | Deposit$1 | Mint$1 | NFTSale | Transfer$1 | Withdrawal$1;
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -529,11 +605,13 @@ declare const ActivityType$1: {
     readonly Burn: "burn";
     readonly Transfer: "transfer";
     readonly Sale: "sale";
+    readonly Deposit: "deposit";
+    readonly Withdrawal: "withdrawal";
 };
 type ActivityType$1 = typeof ActivityType$1[keyof typeof ActivityType$1];
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -576,7 +654,7 @@ interface BlockchainMetadata {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -607,7 +685,7 @@ interface Chain {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -663,7 +741,7 @@ interface Activity {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -688,7 +766,7 @@ interface ChainWithDetailsAllOf {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -706,7 +784,7 @@ interface ChainWithDetailsAllOf {
 type ChainWithDetails = Chain & ChainWithDetailsAllOf;
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -727,7 +805,7 @@ declare const CollectionContractType: {
 type CollectionContractType = typeof CollectionContractType[keyof typeof CollectionContractType];
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -825,7 +903,7 @@ interface Collection$1 {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -851,7 +929,7 @@ interface GetActivityResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -877,7 +955,7 @@ interface GetCollectionResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -969,7 +1047,7 @@ interface NFT {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -987,7 +1065,7 @@ interface NFT {
 type NFTMetadataAttributeValue = boolean | number | string;
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1019,7 +1097,7 @@ interface NFTMetadataAttribute {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1045,7 +1123,7 @@ interface NFTMetadataAttributes {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1064,7 +1142,7 @@ interface NFTMetadataAttributes {
 type NFTWithMetadataAttributes = NFT & NFTMetadataAttributes;
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1090,7 +1168,7 @@ interface GetNFTResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1114,37 +1192,37 @@ interface Token$1 {
      */
     'chain': Chain;
     /**
-     *
+     * The address of token contract
      * @type {string}
      * @memberof Token
      */
     'contract_address': string;
     /**
-     *
+     * The address of root token contract
      * @type {string}
      * @memberof Token
      */
     'root_contract_address': string | null;
     /**
-     *
+     * The symbol of token
      * @type {string}
      * @memberof Token
      */
     'symbol': string | null;
     /**
-     *
+     * The decimals of token
      * @type {number}
      * @memberof Token
      */
     'decimals': number | null;
     /**
-     *
+     * The image url of token
      * @type {string}
      * @memberof Token
      */
     'image_url': string | null;
     /**
-     *
+     * The name of token
      * @type {string}
      * @memberof Token
      */
@@ -1152,7 +1230,7 @@ interface Token$1 {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1178,7 +1256,7 @@ interface GetTokenResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1209,7 +1287,7 @@ interface Page {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1241,7 +1319,7 @@ interface ListActivitiesResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1273,7 +1351,7 @@ interface ListChainsResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1305,7 +1383,7 @@ interface ListCollectionsResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1355,7 +1433,7 @@ interface NFTOwner {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1387,7 +1465,7 @@ interface ListNFTOwnersResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -1419,7 +1497,7 @@ interface ListNFTsResult {
 }
 
 /**
- * Immutable X API
+ * Immutable zkEVM API
  * Immutable Multi Rollup API
  *
  * The version of the OpenAPI document: 1.0.0
@@ -13028,16 +13106,6 @@ interface CancelOrderResponse {
 
 declare const module = "orderbook";
 
-/**
- * Interface representing the secondary fees for a swap
- * @property {string} feeRecipient - The fee recipient address
- * @property {number} feeBasisPoints - The fee percentage in basis points
- * @example 100 basis points = 1%
- */
-type SecondaryFee = {
-    feeRecipient: string;
-    feeBasisPoints: number;
-};
 /**
  * Interface representing a token
  * @property {number} chainId - The chain ID
@@ -13058,7 +13126,6 @@ interface ExchangeOverrides {
     exchangeContracts: ExchangeContracts;
     commonRoutingTokens: TokenInfo$1[];
     nativeToken: TokenInfo$1;
-    secondaryFees?: SecondaryFee[];
 }
 
 /**