@imtbl/sdk 0.19.0-alpha → 0.20.1-alpha.1

package/dist/index.d.ts

@@ -1048,6 +1048,56 @@ interface GetCollectionResult {
     'result': Collection$1;
 }
 
+/**
+ * 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.
+ */
+/**
+ * @type NFTMetadataAttributeValue
+ * The metadata trait value
+ * @export
+ */
+type NFTMetadataAttributeValue = boolean | number | string;
+
+/**
+ * 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.
+ */
+
+/**
+ *
+ * @export
+ * @interface NFTMetadataAttribute
+ */
+interface NFTMetadataAttribute {
+    /**
+     * The metadata trait type
+     * @type {string}
+     * @memberof NFTMetadataAttribute
+     */
+    'trait_type': string;
+    /**
+     *
+     * @type {NFTMetadataAttributeValue}
+     * @memberof NFTMetadataAttribute
+     */
+    'value': NFTMetadataAttributeValue;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1096,6 +1146,12 @@ interface NFT {
      * @memberof NFT
      */
     'metadata_synced_at': string | null;
+    /**
+     * The id of the metadata of this NFT
+     * @type {string}
+     * @memberof NFT
+     */
+    'metadata_id'?: string | null;
     /**
      * The name of the NFT
      * @type {string}
@@ -1140,56 +1196,6 @@ interface NFT {
     'mint_activity_id': string | null;
 }
 
-/**
- * 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.
- */
-/**
- * @type NFTMetadataAttributeValue
- * The metadata trait value
- * @export
- */
-type NFTMetadataAttributeValue = boolean | number | string;
-
-/**
- * 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.
- */
-
-/**
- *
- * @export
- * @interface NFTMetadataAttribute
- */
-interface NFTMetadataAttribute {
-    /**
-     * The metadata trait type
-     * @type {string}
-     * @memberof NFTMetadataAttribute
-     */
-    'trait_type': string;
-    /**
-     *
-     * @type {NFTMetadataAttributeValue}
-     * @memberof NFTMetadataAttribute
-     */
-    'value': NFTMetadataAttributeValue;
-}
-
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -13420,8 +13426,8 @@ declare namespace Fee$1 {
      */
     enum fee_type {
         ROYALTY = "ROYALTY",
-        MAKER_MARKETPLACE = "MAKER_MARKETPLACE",
-        TAKER_MARKETPLACE = "TAKER_MARKETPLACE",
+        MAKER_ECOSYSTEM = "MAKER_ECOSYSTEM",
+        TAKER_ECOSYSTEM = "TAKER_ECOSYSTEM",
         PROTOCOL = "PROTOCOL"
     }
 }
@@ -13514,7 +13520,7 @@ type CreateListingRequestBody = {
     /**
      * Time after which the Order is considered expired
      */
-    end_time: string;
+    end_at: string;
     protocol_data: ProtocolData;
     /**
      * A random value added to the create Order request
@@ -13531,7 +13537,7 @@ type CreateListingRequestBody = {
     /**
      * Time after which Order is considered active
      */
-    start_time: string;
+    start_at: string;
 };
 
 type FulfillmentDataRequest = {
@@ -13573,11 +13579,11 @@ type Order$1 = {
     /**
      * Time the Order is created
      */
-    create_time: string;
+    created_at: string;
     /**
      * Time after which the Order is considered expired
      */
-    end_time: string;
+    end_at: string;
     /**
      * Global Order identifier
      */
@@ -13595,12 +13601,12 @@ type Order$1 = {
     /**
      * Time after which Order is considered active
      */
-    start_time: string;
+    start_at: string;
     status: OrderStatus;
     /**
      * Time the Order is last updated
      */
-    update_time: string;
+    updated_at: string;
 };
 
 type FulfillmentDataResult = {
@@ -13788,7 +13794,7 @@ declare class OrdersService {
         /**
          * Trade field to sort by
          */
-        sortBy?: 'created_at';
+        sortBy?: 'indexed_at';
         /**
          * Ascending or descending direction for sort
          */
@@ -13851,8 +13857,8 @@ interface CreateListingParams {
 type ListListingsParams = Omit<Parameters<typeof OrdersService.prototype.listListings>[0], 'chainName'>;
 type ListTradesParams = Omit<Parameters<typeof OrdersService.prototype.listTrades>[0], 'chainName'>;
 declare enum FeeType {
-    MAKER_MARKETPLACE = "MAKER_MARKETPLACE",
-    TAKER_MARKETPLACE = "TAKER_MARKETPLACE",
+    MAKER_ECOSYSTEM = "MAKER_ECOSYSTEM",
+    TAKER_ECOSYSTEM = "TAKER_ECOSYSTEM",
     PROTOCOL = "PROTOCOL",
     ROYALTY = "ROYALTY"
 }
@@ -13912,16 +13918,16 @@ interface Order {
         id: string;
         name: string;
     };
-    createTime: string;
-    updateTime: string;
+    createdAt: string;
+    updatedAt: string;
     /**
      * Time after which the Order is considered active
      */
-    startTime: string;
+    startAt: string;
     /**
      * Time after which the Order is expired
      */
-    endTime: string;
+    endAt: string;
     protocolData: {
         orderType: 'FULL_RESTRICTED';
         zoneAddress: string;
@@ -14283,13 +14289,29 @@ interface GetAllBalancesResult {
  * Interface representing the parameters for {@link Checkout.smartCheckout}
  * @property {Web3Provider} provider - The provider to use for smart checkout.
  * @property {ItemRequirement[]} itemRequirements - The item requirements for the transaction.
- * @property {FulfilmentTransaction | GasAmount} transactionOrGasAmount - The transaction or gas amount.
+ * @property {FulfillmentTransaction | GasAmount} transactionOrGasAmount - The transaction or gas amount.
  */
 interface SmartCheckoutParams {
     provider: Web3Provider;
-    itemRequirements: ItemRequirement[];
-    transactionOrGasAmount: FulfilmentTransaction | GasAmount;
+    itemRequirements: (NativeItemRequirement | ERC20ItemRequirement | ERC721ItemRequirement)[];
+    transactionOrGasAmount: FulfillmentTransaction | GasAmount;
 }
+type NativeItemRequirement = {
+    type: ItemType.NATIVE;
+    amount: string;
+};
+type ERC20ItemRequirement = {
+    type: ItemType.ERC20;
+    contractAddress: string;
+    amount: string;
+    spenderAddress: string;
+};
+type ERC721ItemRequirement = {
+    type: ItemType.ERC721;
+    contractAddress: string;
+    id: string;
+    spenderAddress: string;
+};
 /**
  * Represents the item requirements for a transaction.
  * NativeItem, ERC20Item or ERC721Item {@link Checkout.smartCheckout}.
@@ -14353,11 +14375,11 @@ declare enum TransactionOrGasType {
     GAS = "GAS"
 }
 /**
- * The fulfilment transaction which contains the transaction to send.
- * @property {TransactionOrGasType} type - The type to indicate this is a fulfilment transaction.
+ * The fulfillment transaction which contains the transaction to send.
+ * @property {TransactionOrGasType} type - The type to indicate this is a fulfillment transaction.
  * @property {TransactionRequest} transaction - The transaction to send.
  */
-type FulfilmentTransaction = {
+type FulfillmentTransaction = {
     type: TransactionOrGasType.TRANSACTION;
     transaction: TransactionRequest;
 };
@@ -14466,14 +14488,33 @@ type BalanceDelta = {
     balance: BigNumber;
     formattedBalance: string;
 };
+interface OrderFee {
+    amount: FeeToken | FeePercentage;
+    recipient: string;
+}
+interface FeeToken {
+    token: string;
+}
+interface FeePercentage {
+    percentageDecimal: number;
+}
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
- * @property {string} orderId - The order ID.
+ * @property {Array<BuyOrder>} orders - The orders to buy
  */
 interface BuyParams {
     provider: Web3Provider;
-    orderId: string;
+    orders: Array<BuyOrder>;
+}
+/**
+ * Interface representing the order to buy
+ * @property {string} orderId - the id of the order to buy
+ * @property {Array<OrderFee>} takerFees - array of order fees to apply to the order
+ */
+interface BuyOrder {
+    id: string;
+    takerFees?: Array<OrderFee>;
 }
 /**
  * Interface representing the result of the buy
@@ -14522,11 +14563,11 @@ declare enum BuyStatusType {
 /**
  * Interface representing the parameters for {@link Checkout.cancel}
  * @property {Web3Provider} provider - The provider to use for the cancel.
- * @property {string} orderId - The order ID.
+ * @property {string[]} orderIds - The order IDs to cancel.
  */
 interface CancelParams {
     provider: Web3Provider;
-    orderId: string;
+    orderIds: string[];
 }
 interface CheckoutOverrides {
 }
@@ -14549,6 +14590,7 @@ type RemoteConfiguration = {
     bridge: BridgeConfig;
     allowedNetworks: AllowedNetworkConfig[];
     gasEstimateTokens?: GasEstimateTokenConfig;
+    imxAddressMapping?: ImxAddressConfig;
 };
 /**
  * A type representing the fee structure for an OnRamp provider
@@ -14602,6 +14644,13 @@ type BridgeConfig = {
 type AllowedNetworkConfig = {
     chainId: number;
 };
+/**
+ * A type representing the IMX address mappings across available networks.
+ * @type {{ [chainId: string]: string }}
+ */
+type ImxAddressConfig = {
+    [chainId: string]: string;
+};
 /**
  * A type representing the required information to estimate gas for a transaction.
  * @type {{ [key: string]: { bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig, swapAddresses?: GasEstimateSwapTokenConfig } }}
@@ -14689,16 +14738,6 @@ interface CheckConnectionResult {
     isConnected: boolean;
     walletAddress: string;
 }
-interface OrderFee {
-    amount: FeeToken | FeePercentage;
-    recipient: string;
-}
-interface FeeToken {
-    token: string;
-}
-interface FeePercentage {
-    percentageDecimal: number;
-}
 /**
  * An enum representing the type of gas estimate.
  * @enum {string}
@@ -14827,11 +14866,22 @@ interface SellParams {
     provider: Web3Provider;
     orders: Array<SellOrder>;
 }
+/**
+ * Interface of the SellOrder to create a listing from, includes makerFees
+ * @property {SellToken} sellToken - the token to be listed for sale
+ * @property {BuyToken} buyToken - the token info of the price of the item
+ * @property {OrderFee[]} makerFees - option array of makerFees to be applied to the listing
+ */
 interface SellOrder {
     sellToken: SellToken;
     buyToken: BuyToken;
     makerFees?: Array<OrderFee>;
 }
+/**
+ * Interface of the SellToken
+ * @property {string} id - The ERC721 token id
+ * @property {string} collectionAddress - The ERC721 contract address
+ */
 interface SellToken {
     id: string;
     collectionAddress: string;
@@ -14891,7 +14941,7 @@ type BuyToken = NativeBuyToken | ERC20BuyToken;
 /**
  * Represents a native buy token
  * @property {ItemType} type - The type indicate this is a native token.
- * @property {BigNumber} amount - The amount of native token.
+ * @property {string} amount - The amount of native token.
  */
 type NativeBuyToken = {
     type: ItemType.NATIVE;
@@ -14900,7 +14950,7 @@ type NativeBuyToken = {
 /**
  * Represents a ERC20 buy token
  * @property {ItemType} type - The type indicate this is a ERC20 token.
- * @property {BigNumber} amount - The amount of native token.
+ * @property {string} amount - The amount of native token.
  * @property {string} contractAddress - The contract address of the ERC20.
  */
 type ERC20BuyToken = {
@@ -15097,14 +15147,16 @@ declare enum CheckoutErrorType {
     CANCEL_ORDER_LISTING_ERROR = "CANCEL_ORDER_LISTING_ERROR",
     PREPARE_ORDER_LISTING_ERROR = "PREPARE_ORDER_LISTING_ERROR",
     CREATE_ORDER_LISTING_ERROR = "CREATE_ORDER_LISTING_ERROR",
+    FULFILL_ORDER_LISTING_ERROR = "FULFILL_ORDER_LISTING_ERROR",
     SWITCH_NETWORK_UNSUPPORTED = "SWITCH_NETWORK_UNSUPPORTED",
     GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR",
     GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR",
     EXECUTE_APPROVAL_TRANSACTION_ERROR = "EXECUTE_APPROVAL_TRANSACTION_ERROR",
-    EXECUTE_FULFILMENT_TRANSACTION_ERROR = "EXECUTE_FULFILMENT_TRANSACTION_ERROR",
+    EXECUTE_FULFILLMENT_TRANSACTION_ERROR = "EXECUTE_FULFILLMENT_TRANSACTION_ERROR",
     SIGN_MESSAGE_ERROR = "SIGN_MESSAGE_ERROR",
     BRIDGE_GAS_ESTIMATE_ERROR = "BRIDGE_GAS_ESTIMATE_ERROR",
-    ORDER_FEE_ERROR = "ORDER_FEE_ERROR"
+    ORDER_FEE_ERROR = "ORDER_FEE_ERROR",
+    ITEM_REQUIREMENTS_ERROR = "ITEM_REQUIREMENTS_ERROR"
 }
 /**
  * Represents an error object with a specific type, optional message, and optional data.
@@ -15298,6 +15350,8 @@ type checkout_sdk_d_CheckoutModuleConfiguration = CheckoutModuleConfiguration;
 type checkout_sdk_d_ConnectParams = ConnectParams;
 type checkout_sdk_d_ConnectResult = ConnectResult;
 type checkout_sdk_d_DexConfig = DexConfig;
+type checkout_sdk_d_ERC20ItemRequirement = ERC20ItemRequirement;
+type checkout_sdk_d_ERC721ItemRequirement = ERC721ItemRequirement;
 type checkout_sdk_d_ErrorType = ErrorType;
 type checkout_sdk_d_ExchangeType = ExchangeType;
 declare const checkout_sdk_d_ExchangeType: typeof ExchangeType;
@@ -15323,8 +15377,10 @@ type checkout_sdk_d_GetTokenAllowListParams = GetTokenAllowListParams;
 type checkout_sdk_d_GetTokenAllowListResult = GetTokenAllowListResult;
 type checkout_sdk_d_GetWalletAllowListParams = GetWalletAllowListParams;
 type checkout_sdk_d_GetWalletAllowListResult = GetWalletAllowListResult;
+type checkout_sdk_d_ItemRequirement = ItemRequirement;
 type checkout_sdk_d_ItemType = ItemType;
 declare const checkout_sdk_d_ItemType: typeof ItemType;
+type checkout_sdk_d_NativeItemRequirement = NativeItemRequirement;
 type checkout_sdk_d_NetworkFilter = NetworkFilter;
 type checkout_sdk_d_NetworkFilterTypes = NetworkFilterTypes;
 declare const checkout_sdk_d_NetworkFilterTypes: typeof NetworkFilterTypes;
@@ -15369,6 +15425,8 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_ConnectParams as ConnectParams,
     checkout_sdk_d_ConnectResult as ConnectResult,
     checkout_sdk_d_DexConfig as DexConfig,
+    checkout_sdk_d_ERC20ItemRequirement as ERC20ItemRequirement,
+    checkout_sdk_d_ERC721ItemRequirement as ERC721ItemRequirement,
     checkout_sdk_d_ErrorType as ErrorType,
     checkout_sdk_d_ExchangeType as ExchangeType,
     checkout_sdk_d_FeePercentage as FeePercentage,
@@ -15391,7 +15449,9 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_GetTokenAllowListResult as GetTokenAllowListResult,
     checkout_sdk_d_GetWalletAllowListParams as GetWalletAllowListParams,
     checkout_sdk_d_GetWalletAllowListResult as GetWalletAllowListResult,
+    checkout_sdk_d_ItemRequirement as ItemRequirement,
     checkout_sdk_d_ItemType as ItemType,
+    checkout_sdk_d_NativeItemRequirement as NativeItemRequirement,
     checkout_sdk_d_NetworkFilter as NetworkFilter,
     checkout_sdk_d_NetworkFilterTypes as NetworkFilterTypes,
     checkout_sdk_d_NetworkInfo as NetworkInfo,