@imtbl/sdk 0.20.0 → 0.20.1-alpha.1

package/dist/checkout_sdk.d.ts

@@ -11020,13 +11020,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}.
@@ -11090,11 +11106,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;
 };
@@ -11203,14 +11219,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
@@ -11259,11 +11294,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 {
 }
@@ -11286,6 +11321,7 @@ type RemoteConfiguration = {
     bridge: BridgeConfig;
     allowedNetworks: AllowedNetworkConfig[];
     gasEstimateTokens?: GasEstimateTokenConfig;
+    imxAddressMapping?: ImxAddressConfig;
 };
 /**
  * A type representing the fee structure for an OnRamp provider
@@ -11339,6 +11375,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 } }}
@@ -11426,16 +11469,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}
@@ -11564,11 +11597,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;
@@ -11628,7 +11672,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;
@@ -11637,7 +11681,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 = {
@@ -11834,14 +11878,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.
@@ -12016,4 +12062,4 @@ declare class Checkout {
     getExchangeFeeEstimate(): Promise<OnRampProviderFees>;
 }
 
-export { AllowedNetworkConfig, BuyParams, BuyResult, CHECKOUT_API_BASE_URL, CancelParams, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, ConnectParams, ConnectResult, DexConfig, ErrorType, ExchangeType, FeePercentage, FeeToken, FiatRampParams, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, ItemType, NetworkFilter, NetworkFilterTypes, NetworkInfo, OrderFee, RemoteConfiguration, SellOrder, SellParams, SellResult, SellToken, SendTransactionParams, SendTransactionResult, SmartCheckoutParams, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, WalletFilter, WalletFilterTypes, WalletInfo, WalletProviderName };
+export { AllowedNetworkConfig, BuyParams, BuyResult, CHECKOUT_API_BASE_URL, CancelParams, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, ConnectParams, ConnectResult, DexConfig, ERC20ItemRequirement, ERC721ItemRequirement, ErrorType, ExchangeType, FeePercentage, FeeToken, FiatRampParams, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, ItemRequirement, ItemType, NativeItemRequirement, NetworkFilter, NetworkFilterTypes, NetworkInfo, OrderFee, RemoteConfiguration, SellOrder, SellParams, SellResult, SellToken, SendTransactionParams, SendTransactionResult, SmartCheckoutParams, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, WalletFilter, WalletFilterTypes, WalletInfo, WalletProviderName };