@imtbl/sdk 0.16.0-alpha.1 → 0.17.0

package/dist/checkout_sdk.d.ts

@@ -11141,6 +11141,68 @@ type ERC20Gas = {
     contractAddress: string;
     limit: BigNumber;
 };
+/**
+ * Represents the result of {@link Checkout.smartCheckout}.
+ * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
+ * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements.
+ */
+interface SmartCheckoutResult {
+    sufficient: boolean;
+    transactionRequirements: TransactionRequirement[];
+}
+/**
+ * Represents the transaction requirement for a transaction.
+ * @property {ItemType} type - The type of the transaction requirement.
+ * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
+ * @property {TransactionRequirementItem} required - The required item balance.
+ * @property {TransactionRequirementItem} current - The current item balance.
+ * @property {TransactionRequirementDelta} delta - The delta between the required and current balances.
+ */
+type TransactionRequirement = {
+    type: ItemType;
+    sufficient: boolean;
+    required: ItemBalance;
+    current: ItemBalance;
+    delta: BalanceDelta;
+};
+/**
+ * Represents the balance for either a native or ERC20 token.
+ * @property {BigNumber} balance - The balance of the item.
+ * @property {string} formattedBalance - The formatted balance of the item.
+ * @property {TokenInfo} token - The token info of the item.
+ */
+type TokenBalance = {
+    type: ItemType.NATIVE | ItemType.ERC20;
+    balance: BigNumber;
+    formattedBalance: string;
+    token: TokenInfo;
+};
+/**
+ * Represents the balance for an ERC20.
+ * @property {BigNumber} balance - The balance of the item.
+ * @property {string} formattedBalance - The formatted balance of the item.
+ * @property {TokenInfo} token - The token info of the item.
+ */
+interface ERC721Balance {
+    type: ItemType.ERC721;
+    balance: BigNumber;
+    formattedBalance: string;
+    contractAddress: string;
+    id: string;
+}
+/**
+ * Type representing the balance of an item.
+ */
+type ItemBalance = ERC721Balance | TokenBalance;
+/**
+ * Represents the delta between two balances.
+ * @property {BigNumber} balance - The delta of the balance.
+ * @property {string} formattedBalance - The formatted balance of the delta.
+ */
+type BalanceDelta = {
+    balance: BigNumber;
+    formattedBalance: string;
+};
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
@@ -11150,9 +11212,65 @@ interface BuyParams {
     provider: Web3Provider;
     orderId: string;
 }
+/**
+ * Interface representing the result of the buy
+ * @property {SmartCheckoutResult} smartCheckoutResult - The result of smart checkout.
+ * @property {string} orderId - The order ID.
+ * @property {BuyStatus} status - The status of the buy, present when smart checkout balances are sufficient
+ * and the transactions were executed
+ */
+type BuyResult = {
+    smartCheckoutResult: SmartCheckoutResult;
+    orderId: string;
+    status?: BuyStatus;
+};
+/**
+ * Represents the status of the transaction for the Buy
+ */
+type BuyStatus = BuySuccessStatus | BuyFailedStatus;
+/**
+ * Represents the status of a successful Buy
+ * @property {string} type - The success buy status type.
+ */
+interface BuySuccessStatus {
+    type: BuyStatusType.SUCCESS;
+}
+/**
+ * Represents the status of a failed Buy
+ * @property {string} type - The failed buy status type.
+ * @property {string} transactionHash - The transaction hash of the failed transaction.
+ * @property {string} reason - The reason for the failed transaction.
+ */
+interface BuyFailedStatus {
+    type: BuyStatusType.FAILED;
+    transactionHash: string;
+    reason: string;
+}
+/**
+ * A type representing the status of the transaction for the Buy
+ * @enum {string}
+ * @property {string} SUCCESS - All the transactions were successful.
+ * @property {string} FAILED - At least one of the transactions failed.
+ */
+declare enum BuyStatusType {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED"
+}
+/**
+ * Interface representing the parameters for {@link Checkout.cancel}
+ * @property {Web3Provider} provider - The provider to use for the cancel.
+ * @property {string} orderId - The order ID.
+ */
+interface CancelParams {
+    provider: Web3Provider;
+    orderId: string;
+}
 interface CheckoutOverrides {
 }
 interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverrides> {
+    isOnRampEnabled?: boolean;
+    isSwapEnabled?: boolean;
+    isBridgeEnabled?: boolean;
 }
 /**
  * A type representing various remotely defined configurations which are
@@ -11387,6 +11505,91 @@ declare enum NetworkFilterTypes {
 interface NetworkFilter {
     chainId: ChainId;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.sell}
+ * @property {Web3Provider} provider - The provider to use for the sell.
+ * @property {string} id - The ERC721 ID.
+ * @property {string} collectionAddress - The contract address of the ERC721s collection.
+ * @property {BuyToken} buyToken - The token to buy the item with.
+ */
+interface SellParams {
+    provider: Web3Provider;
+    id: string;
+    collectionAddress: string;
+    buyToken: BuyToken;
+}
+/**
+ * Interface representing the result of the sell
+ * @property {string} id - The ERC721 ID.
+ * @property {string} collectionAddress - The contract address of the ERC721s collection.
+ * @property {SmartCheckoutResult} smartCheckoutResult - The result of the smart checkout.
+ * @property {SellStatus} status - The status of the sell, present when smart checkout balances are sufficient
+ */
+type SellResult = {
+    id: string;
+    collectionAddress: string;
+    smartCheckoutResult: SmartCheckoutResult;
+    status?: SellStatus;
+};
+/**
+ * Represents the status of the transaction for the Sell
+ */
+type SellStatus = SellSuccessStatus | SellFailedStatus;
+/**
+ * Represents the status of a successful Sell
+ * @property {string} type - The success sell status type.
+ * @property {string} orderId - The order ID of the listing.
+ */
+interface SellSuccessStatus {
+    type: SellStatusType.SUCCESS;
+    orderId: string;
+}
+/**
+ * Represents the status of a failed Sell
+ * @property {string} type - The failed sell status type.
+ * @property {string} transactionHash - The transaction hash of the failed transaction.
+ * @property {string} reason - The reason for the failed transaction.
+ */
+interface SellFailedStatus {
+    type: SellStatusType.FAILED;
+    transactionHash: string;
+    reason: string;
+}
+/**
+ * A type representing the status of the transaction for the Sell
+ * @enum {string}
+ * @property {string} SUCCESS - All the transactions were successful.
+ * @property {string} FAILED - At least one of the transactions failed.
+ */
+declare enum SellStatusType {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED"
+}
+/**
+ * Represents the token that the item can be bought with once listed for sale.
+ * NativeBuyToken or ERC20BuyToken {@link Checkout.smartCheckout}.
+ */
+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.
+ */
+type NativeBuyToken = {
+    type: ItemType.NATIVE;
+    amount: BigNumber;
+};
+/**
+ * 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} contractAddress - The contract address of the ERC20.
+ */
+type ERC20BuyToken = {
+    type: ItemType.ERC20;
+    amount: BigNumber;
+    contractAddress: string;
+};
 /**
  * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
  * @property {TokenFilterTypes} type - The type of token to retrieve.
@@ -11549,10 +11752,15 @@ declare enum CheckoutErrorType {
     UNSUPPORTED_TOKEN_TYPE_ERROR = "UNSUPPORTED_TOKEN_TYPE_ERROR",
     UNSUPPORTED_BALANCE_REQUIREMENT_ERROR = "UNSUPPORTED_BALANCE_REQUIREMENT_ERROR",
     GET_ORDER_LISTING_ERROR = "GET_ORDER_LISTING_ERROR",
+    CANCEL_ORDER_LISTING_ERROR = "CANCEL_ORDER_LISTING_ERROR",
     PREPARE_ORDER_LISTING_ERROR = "PREPARE_ORDER_LISTING_ERROR",
+    CREATE_ORDER_LISTING_ERROR = "CREATE_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"
+    GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR",
+    EXECUTE_APPROVAL_TRANSACTION_ERROR = "EXECUTE_APPROVAL_TRANSACTION_ERROR",
+    EXECUTE_FULFILMENT_TRANSACTION_ERROR = "EXECUTE_FULFILMENT_TRANSACTION_ERROR",
+    SIGN_MESSAGE_ERROR = "SIGN_MESSAGE_ERROR"
 }
 /**
  * Represents an error object with a specific type, optional message, and optional data.
@@ -11579,49 +11787,14 @@ declare class RemoteConfigFetcher {
 declare class CheckoutConfiguration {
     readonly isDevelopment: boolean;
     readonly isProduction: boolean;
+    readonly isOnRampEnabled: boolean;
+    readonly isSwapEnabled: boolean;
+    readonly isBridgeEnabled: boolean;
     readonly remote: RemoteConfigFetcher;
     readonly environment: Environment;
     readonly networkMap: NetworkMap;
     constructor(config: CheckoutModuleConfiguration);
 }
-/**
- * Interface representing the parameters for {@link Checkout.sell}
- * @property {Web3Provider} provider - The provider to use for the sell.
- * @property {string} id - The ERC721 ID.
- * @property {string} collectionAddress - The contract address of the ERC721s collection.
- * @property {BuyToken} buyToken - The token to buy the item with.
- */
-interface SellParams {
-    provider: Web3Provider;
-    id: string;
-    collectionAddress: string;
-    buyToken: BuyToken;
-}
-/**
- * Represents the token that the item can be bought with once listed for sale.
- * NativeBuyToken or ERC20BuyToken {@link Checkout.smartCheckout}.
- */
-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.
- */
-type NativeBuyToken = {
-    type: ItemType.NATIVE;
-    amount: BigNumber;
-};
-/**
- * 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} contractAddress - The contract address of the ERC20.
- */
-type ERC20BuyToken = {
-    type: ItemType.ERC20;
-    amount: BigNumber;
-    contractAddress: string;
-};
 declare class Checkout {
     readonly config: CheckoutConfiguration;
     /**
@@ -11706,6 +11879,11 @@ declare class Checkout {
      * @param {SellParams} params - The parameters for the sell.
     */
     sell(params: SellParams): Promise<void>;
+    /**
+     * Cancels a sell.
+     * @param {CancelParams} params - The parameters for the cancel.
+     */
+    cancel(params: CancelParams): Promise<void>;
     /**
      * Determines the transaction requirements to complete a purchase.
      * @params {SmartCheckoutParams} params - The parameters for smart checkout.
@@ -11725,4 +11903,4 @@ declare class Checkout {
     gasEstimate(params: GasEstimateParams): Promise<GasEstimateSwapResult | GasEstimateBridgeToL2Result>;
 }
 
-export { AllowedNetworkConfig, BuyParams, CHECKOUT_API_BASE_URL, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, ConnectParams, ConnectResult, DexConfig, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, ItemType, NetworkFilter, NetworkFilterTypes, NetworkInfo, RemoteConfiguration, 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, ErrorType, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasTokenType, GetAllBalancesParams, GetAllBalancesResult, GetBalanceParams, GetBalanceResult, GetNetworkAllowListParams, GetNetworkAllowListResult, GetNetworkParams, GetTokenAllowListParams, GetTokenAllowListResult, GetWalletAllowListParams, GetWalletAllowListResult, ItemType, NetworkFilter, NetworkFilterTypes, NetworkInfo, RemoteConfiguration, SellParams, SellResult, SendTransactionParams, SendTransactionResult, SmartCheckoutParams, SwitchNetworkParams, SwitchNetworkResult, TokenFilter, TokenFilterTypes, TokenInfo, TransactionOrGasType, WalletFilter, WalletFilterTypes, WalletInfo, WalletProviderName };