@imtbl/sdk 0.22.1 → 0.22.3

package/dist/checkout_sdk.d.ts

@@ -1458,7 +1458,7 @@ interface ApiRegisterPassportUserRequest {
  * @export
  * @interface Fee
  */
-interface Fee {
+interface Fee$1 {
     /**
      * Wallet address
      * @type {string}
@@ -1551,7 +1551,7 @@ interface Asset {
      * @type {Array<Fee>}
      * @memberof Asset
      */
-    'fees'?: Array<Fee>;
+    'fees'?: Array<Fee$1>;
     /**
      * [DEPRECATED] Internal Immutable X Token ID
      * @type {string}
@@ -1661,7 +1661,7 @@ interface AssetWithOrders {
      * @type {Array<Fee>}
      * @memberof AssetWithOrders
      */
-    'fees'?: Array<Fee>;
+    'fees'?: Array<Fee$1>;
     /**
      * [DEPRECATED] Internal Immutable X Token ID
      * @type {string}
@@ -5093,7 +5093,7 @@ interface Mint {
      * @type {Array<Fee>}
      * @memberof Mint
      */
-    'fees'?: Array<Fee>;
+    'fees'?: Array<Fee$1>;
     /**
      * Status of this mint
      * @type {string}
@@ -11016,6 +11016,166 @@ interface GetAllBalancesParams {
 interface GetAllBalancesResult {
     balances: GetBalanceResult[];
 }
+interface OrderFee {
+    amount: FeeToken | FeePercentage;
+    recipient: string;
+}
+interface FeeToken {
+    token: string;
+}
+interface FeePercentage {
+    percentageDecimal: number;
+}
+type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultInsufficientFunds;
+/**
+ * Represents the result of {@link Checkout.buy}
+ * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
+ * @property {SmartCheckoutSufficient[]} smartCheckoutResult - The sufficient result of smart checkout
+ */
+type BuyResultSuccess = {
+    status: CheckoutStatus.SUCCESS;
+    smartCheckoutResult: SmartCheckoutSufficient[];
+};
+/**
+ * Represents the result of {@link Checkout.buy}
+ * @property {CheckoutStatus.FAILED} status - The status to indicate failure
+ * @property {string} transactionHash - The transaction hash of the failed transaction
+ * @property {string} reason - The reason for the failure
+ * @property {SmartCheckoutSufficient[]} smartCheckoutResult - The sufficient result of smart checkout
+ */
+type BuyResultFailed = {
+    status: CheckoutStatus.FAILED;
+    transactionHash: string;
+    reason: string;
+    smartCheckoutResult: SmartCheckoutSufficient[];
+};
+/**
+ * Represents the result of {@link Checkout.buy}
+ * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status - The status to indicate insufficient funds
+ * @property {SmartCheckoutInsufficient[]} smartCheckoutResult - The insufficient result of smart checkout
+ */
+type BuyResultInsufficientFunds = {
+    status: CheckoutStatus.INSUFFICIENT_FUNDS;
+    smartCheckoutResult: SmartCheckoutInsufficient[];
+};
+type SellResult = SellResultSuccess | SellResultFailed | SellResultInsufficientFunds;
+/**
+ * Represents the result of {@link Checkout.sell}
+ * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
+ * @property {SmartCheckoutSufficient[]} smartCheckoutResult - The sufficient result of smart checkout
+ */
+type SellResultSuccess = {
+    status: CheckoutStatus.SUCCESS;
+    orderIds: string[];
+    smartCheckoutResult: SmartCheckoutSufficient[];
+};
+/**
+ * Represents the result of {@link Checkout.sell}
+ * @property {CheckoutStatus.FAILED} status - The status to indicate failure
+ * @property {string} transactionHash - The transaction hash of the failed transaction
+ * @property {string} reason - The reason for the failure
+ * @property {SmartCheckoutSufficient[]} smartCheckoutResult - The sufficient result of smart checkout
+ */
+type SellResultFailed = {
+    status: CheckoutStatus.FAILED;
+    transactionHash: string;
+    reason: string;
+    smartCheckoutResult: SmartCheckoutSufficient[];
+};
+/**
+ * Represents the result of {@link Checkout.sell}
+ * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status - The status to indicate insufficient funds
+ * @property {SmartCheckoutInsufficient[]} smartCheckoutResult - The insufficient result of smart checkout
+ */
+type SellResultInsufficientFunds = {
+    status: CheckoutStatus.INSUFFICIENT_FUNDS;
+    smartCheckoutResult: SmartCheckoutInsufficient[];
+};
+type CancelResult = CancelResultSuccess | CancelResultFailed;
+/**
+ * Represents the result of {@link Checkout.cancel}
+ * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
+ */
+type CancelResultSuccess = {
+    status: CheckoutStatus.SUCCESS;
+};
+/**
+ * Represents the result of {@link Checkout.cancel}
+ * @property {CheckoutStatus.FAILED} status - The status to indicate failure
+ * @property {string} transactionHash - The transaction hash of the failed transaction
+ * @property {string} reason - The reason for the failure
+ */
+type CancelResultFailed = {
+    status: CheckoutStatus.FAILED;
+    transactionHash: string;
+    reason: string;
+};
+/**
+ * An enum representing the checkout status types
+ * @enum {string}
+ * @property {string} SUCCESS - If checkout succeeded as the transactions were able to be processed
+ * @property {string} FAILED - If checkout failed due to transactions not settling on chain
+ * @property {string} INSUFFICIENT_FUNDS - If checkout failed due to insufficient funds
+ */
+declare enum CheckoutStatus {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED",
+    INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS"
+}
+/**
+ * The type 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
+ */
+type BuyOrder = {
+    id: string;
+    takerFees?: OrderFee[];
+};
+/**
+ * The type representing the sell order to create a listing from
+ * @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
+ */
+type SellOrder = {
+    sellToken: SellToken;
+    buyToken: BuyToken;
+    makerFees?: OrderFee[];
+};
+/**
+ * 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 {string} amount - The amount of native token.
+ */
+type NativeBuyToken = {
+    type: ItemType.NATIVE;
+    amount: string;
+};
+/**
+ * Represents a ERC20 buy token
+ * @property {ItemType} type - The type indicate this is a ERC20 token.
+ * @property {string} amount - The amount of native token.
+ * @property {string} contractAddress - The contract address of the ERC20.
+ */
+type ERC20BuyToken = {
+    type: ItemType.ERC20;
+    amount: string;
+    contractAddress: string;
+};
+/**
+ * Interface of the SellToken
+ * @property {string} id - The ERC721 token id
+ * @property {string} collectionAddress - The ERC721 collection address
+ */
+type SellToken = {
+    id: string;
+    collectionAddress: string;
+};
 /**
  * Interface representing the parameters for {@link Checkout.smartCheckout}
  * @property {Web3Provider} provider - The provider to use for smart checkout.
@@ -11027,16 +11187,35 @@ interface SmartCheckoutParams {
     itemRequirements: (NativeItemRequirement | ERC20ItemRequirement | ERC721ItemRequirement)[];
     transactionOrGasAmount: FulfillmentTransaction | GasAmount;
 }
+/**
+ * Represents a native item requirement for a transaction.
+ * @property {ItemType.NATIVE} type - The type to indicate this is a native item requirement.
+ * @property {string} amount - The amount of the item.
+ */
 type NativeItemRequirement = {
     type: ItemType.NATIVE;
     amount: string;
 };
+/**
+ * Represents an ERC20 item requirement for a transaction.
+ * @property {ItemType.ERC20} type - The type to indicate this is a ERC20 item requirement.
+ * @property {string} amount - The amount of the item.
+ * @property {string} contractAddress - The contract address of the ERC20.
+ * @property {string} spenderAddress - The contract address of the approver.
+ */
 type ERC20ItemRequirement = {
     type: ItemType.ERC20;
     contractAddress: string;
     amount: string;
     spenderAddress: string;
 };
+/**
+ * Represents an ERC721 item requirement for a transaction.
+ * @property {ItemType.ERC721} type - The type to indicate this is a ERC721 item requirement.
+ * @property {string} contractAddress - The contract address of the ERC721 collection.
+ * @property {string} id - The ID of this ERC721 in the collection.
+ * @property {string} spenderAddress - The contract address of the approver.
+ */
 type ERC721ItemRequirement = {
     type: ItemType.ERC721;
     contractAddress: string;
@@ -11085,7 +11264,7 @@ type ERC20Item = {
 /**
  * Represents an ERC721 item.
  * @property {ItemType} type - The type to indicate this is an ERC721 item.
- * @property {string} contractAddress - The contract address of the ERC721.
+ * @property {string} contractAddress - The contract address of the ERC721 collection.
  * @property {string} id - The ID of this ERC721 in the collection.
  * @property {string} spenderAddress - The contract address of the approver.
  */
@@ -11158,14 +11337,217 @@ type ERC20Gas = {
     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.
+ * The type representing the result of {@link Checkout.smartCheckout}.
  */
-interface SmartCheckoutResult {
-    sufficient: boolean;
+type SmartCheckoutResult = SmartCheckoutSufficient | SmartCheckoutInsufficient;
+/**
+ * Represents the result of {@link Checkout.smartCheckout} when smart checkout is sufficient.
+ * @property {boolean} sufficient - Indicates that smart checkout determined the user had sufficient funds.
+ * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements smart checkout
+ * determined were required for the transaction.
+ */
+type SmartCheckoutSufficient = {
+    sufficient: true;
     transactionRequirements: TransactionRequirement[];
+};
+/**
+ * Represents the result of {@link Checkout.smartCheckout} when smart checkout is insufficient.
+ * @property {boolean} sufficient - Indicates that smart checkout determined the user has insufficient funds
+ * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements smart checkout
+ * determined were required for the transaction.
+ * @property {SmartCheckoutRouter} router - The type containing the funding routes the user can take to fulfill the transaction requirements
+ */
+type SmartCheckoutInsufficient = {
+    sufficient: false;
+    transactionRequirements: TransactionRequirement[];
+    router: SmartCheckoutRouter;
+};
+/**
+ * Represents the routing outcome for a transaction.
+ * @property {boolean} isPassport - Indicates if the provider used was a passport provider.
+ * @property {AvailableRoutingOptions} availableRoutingOptions - The routing options available to the user
+ * @property {RoutingOutcome} routingOutcome - The routing outcome for the transaction which
+ * includes the funding routes if routes were found
+ */
+type SmartCheckoutRouter = {
+    isPassport: boolean;
+    availableRoutingOptions: AvailableRoutingOptions;
+    routingOutcome: RoutingOutcome;
+};
+/**
+ * An enum representing the routing outcome types
+ * @enum {string}
+ * @property {string} ROUTES_FOUND - If funding routes were found for the transaction.
+ * @property {string} NO_ROUTES_FOUND - If no funding routes were found for the transaction.
+ * @property {string} NO_ROUTE_OPTIONS - If no routing options were available for the transaction.
+ */
+declare enum RoutingOutcomeType {
+    ROUTES_FOUND = "ROUTES_FOUND",
+    NO_ROUTES_FOUND = "NO_ROUTES_FOUND",
+    NO_ROUTE_OPTIONS = "NO_ROUTE_OPTIONS"
+}
+type RoutingOutcome = RoutesFound | NoRoutesFound | NoRouteOptions;
+/**
+ * Represents a routing outcome where funding routes were found.
+ * @property {RoutingOutcomeType.ROUTES_FOUND} type - Indicates that funding routes were found for the transaction.
+ * @property {AvailableRoutingOptions} fundingRoutes - The funding routes found for the transaction.
+ */
+type RoutesFound = {
+    type: RoutingOutcomeType.ROUTES_FOUND;
+    fundingRoutes: FundingRoute[];
+};
+/**
+ * Represents a routing outcome where no funding routes were found.
+ * @property {RoutingOutcomeType.NO_ROUTES_FOUND} type - Indicates that no funding routes were found for the transaction.
+ * @property {string} message - The message indicating why no funding routes were found.
+ */
+type NoRoutesFound = {
+    type: RoutingOutcomeType.NO_ROUTES_FOUND;
+    message: string;
+};
+/**
+ * Represents a routing outcome where no routing options were available for the transaction.
+ * @property {RoutingOutcomeType.NO_ROUTE_OPTIONS} type - Indicates that no routing options were available for the transaction.
+ * @property {string} message - The message indicating why no routing options were available.
+ */
+type NoRouteOptions = {
+    type: RoutingOutcomeType.NO_ROUTE_OPTIONS;
+    message: string;
+};
+/**
+ * Represents a funding route
+ * @property {number} priority - The priority of the route
+ * @property {FundingStep[]} steps - The steps associated with this funding route
+ * @property {TotalFees | undefined} totalFees - The total fees for this route
+ */
+type FundingRoute = {
+    priority: number;
+    steps: FundingStep[];
+    totalFees?: TotalFees;
+};
+/**
+ * Represents the total fees for a route
+ * @property {Fee} gas - The total gas fees for this funding step
+ * @property {Fee} other - The total of all other fees associated with this funding step
+ * @property {Fee} total - The total combined gas and other fees for this funding step
+ */
+type TotalFees = {
+    gas: Fee;
+    other: Fee;
+    total: Fee;
+};
+/**
+ * Represents a fee
+ * @property {BigNumber} amount - The amount of the fee
+ * @property {string} formatted - The formatted amount of the fee
+ */
+type Fee = {
+    amount: BigNumber;
+    formattedAmount: string;
+};
+type FundingStep = BridgeFundingStep | SwapFundingStep | OnRampFundingStep;
+/**
+ * Represents a bridge funding route
+ * @property {FundingStepType.BRIDGE} type - Indicates that this is a bridge funding step
+ * @property {number} chainId - The chain id the bridge should be executed on
+ * @property {FundingItem} fundingItem - The funding item for the bridge
+ * @property {BridgeFees} fees - The fees for the bridge
+ */
+type BridgeFundingStep = {
+    type: FundingStepType.BRIDGE;
+    chainId: number;
+    fundingItem: FundingItem;
+    fees: BridgeFees;
+};
+/**
+ * Represents the fees for a bridge funding step
+ * @property {Fee} approvalGasFees - The approval gas fees for the bridge
+ * @property {Fee} bridgeGasFees - The bridge gas fees for the bridge
+ * @property {Fee[]} bridgeFees - Additional bridge fees for the bridge
+ */
+type BridgeFees = {
+    approvalGasFees: Fee;
+    bridgeGasFees: Fee;
+    bridgeFees: Fee[];
+};
+/**
+ * Represents a swap funding route
+ * @property {FundingStepType.SWAP} type - Indicates that this is a swap funding step
+ * @property {number} chainId - The chain id the swap should be executed on
+ * @property {FundingItem} fundingItem - The funding item for the swap
+ * @property {SwapFees} fees - The fees for the swap
+ */
+type SwapFundingStep = {
+    type: FundingStepType.SWAP;
+    chainId: number;
+    fundingItem: FundingItem;
+    fees: SwapFees;
+};
+/**
+ * Represents the fees for a swap funding step
+ * @property {Fee} approvalGasFees - The approval gas fees for the swap
+ * @property {Fee} swapGasFees - The swap gas fees for the swap
+ * @property {Fee[]} swapFees - Additional swap fees for the swap
+ */
+type SwapFees = {
+    approvalGasFees: Fee;
+    swapGasFees: Fee;
+    swapFees: Fee[];
+};
+/**
+ * Represents an onramp funding route
+ * @property {FundingStepType.ONRAMP} type - Indicates that this is an onramp funding step
+ * @property {number} chainId - The chain id the onramp should provide funds to
+ * @property {FundingItem} fundingItem - The item to be onramped
+ */
+type OnRampFundingStep = {
+    type: FundingStepType.ONRAMP;
+    chainId: number;
+    fundingItem: FundingItem;
+};
+/**
+ * An enum representing the funding step types
+ * @enum {string}
+ * @property {string} BRIDGE - If the funding step is a bridge.
+ * @property {string} SWAP - If the funding step is a swap.
+ * @property {string} ONRAMP - If the funding step is an onramp.
+ */
+declare enum FundingStepType {
+    BRIDGE = "BRIDGE",
+    SWAP = "SWAP",
+    ONRAMP = "ONRAMP"
 }
+/**
+ * Represents a funding item
+ * @property {ItemType.NATIVE | ItemType.ERC20} type - The type of the funding item
+ * @property {FundsRequired} fundsRequired - The amount of funds required of this funding item
+ * @property {UserBalance} userBalance - The current user balance of this funding item
+ * @property {TokenInfo} token - The token info for the funding item
+ */
+type FundingItem = {
+    type: ItemType.NATIVE | ItemType.ERC20;
+    fundsRequired: FundsRequired;
+    userBalance: UserBalance;
+    token: TokenInfo;
+};
+/**
+ * Represents the funds required of a funding item
+ * @property {BigNumber} amount - The amount of funds required
+ * @property {string} formattedAmount - The formatted amount of funds required
+ */
+type FundsRequired = {
+    amount: BigNumber;
+    formattedAmount: string;
+};
+/**
+ * Represents the user balance of a funding item
+ * @property {BigNumber} balance - The balance of the funding item
+ * @property {string} formattedBalance - The formatted balance of the funding item
+ */
+type UserBalance = {
+    balance: BigNumber;
+    formattedBalance: string;
+};
 /**
  * Represents the transaction requirement for a transaction.
  * @property {ItemType} type - The type of the transaction requirement.
@@ -11219,82 +11601,30 @@ type BalanceDelta = {
     balance: BigNumber;
     formattedBalance: string;
 };
-interface OrderFee {
-    amount: FeeToken | FeePercentage;
-    recipient: string;
-}
-interface FeeToken {
-    token: string;
-}
-interface FeePercentage {
-    percentageDecimal: number;
-}
+/**
+ * A type representing the Smart Checkout routing options available for a user
+ * if they are configured and enabled (not geo-blocked etc.)
+ */
+type AvailableRoutingOptions = {
+    onRamp?: boolean;
+    swap?: boolean;
+    bridge?: boolean;
+};
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
  * @property {Array<BuyOrder>} orders - The orders to buy
+ * Currently only processes the first order in the array until batch processing is supported.
  */
 interface BuyParams {
     provider: Web3Provider;
     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
- * @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[]} orderIds - The order IDs to cancel.
+ * Currently only processes the first order in the array until batch processing is supported.
  */
 interface CancelParams {
     provider: Web3Provider;
@@ -11591,104 +11921,12 @@ interface NetworkFilter {
  * Interface representing the parameters for {@link Checkout.sell}
  * @property {Web3Provider} provider - The provider to use for the sell.
  * @property {Array<SellOrder>} orders - An array of sell orders to execute.
- * Only currently actions the first order in the array until we support batch processing.
+ * Currently only processes the first order in the array until batch processing is supported.
  */
 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;
-}
-/**
- * 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 {string} amount - The amount of native token.
- */
-type NativeBuyToken = {
-    type: ItemType.NATIVE;
-    amount: string;
-};
-/**
- * Represents a ERC20 buy token
- * @property {ItemType} type - The type indicate this is a ERC20 token.
- * @property {string} amount - The amount of native token.
- * @property {string} contractAddress - The contract address of the ERC20.
- */
-type ERC20BuyToken = {
-    type: ItemType.ERC20;
-    amount: string;
-    contractAddress: string;
-};
 /**
  * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
  * @property {TokenFilterTypes} type - The type of token to retrieve.
@@ -12019,24 +12257,24 @@ declare class Checkout {
      * Determines the requirements for performing a buy.
      * @param {BuyParams} params - The parameters for the buy.
     */
-    buy(params: BuyParams): Promise<void>;
+    buy(params: BuyParams): Promise<BuyResult>;
     /**
      * Determines the requirements for performing a sell.
      * @param {SellParams} params - The parameters for the sell.
      * Only currently actions the first order in the array until we support batch processing.
      * Only currently actions the first fee in the fees array of each order until we support multiple fees.
     */
-    sell(params: SellParams): Promise<void>;
+    sell(params: SellParams): Promise<SellResult>;
     /**
      * Cancels a sell.
      * @param {CancelParams} params - The parameters for the cancel.
      */
-    cancel(params: CancelParams): Promise<void>;
+    cancel(params: CancelParams): Promise<CancelResult>;
     /**
      * Determines the transaction requirements to complete a purchase.
      * @params {SmartCheckoutParams} params - The parameters for smart checkout.
      */
-    smartCheckout(params: SmartCheckoutParams): Promise<void>;
+    smartCheckout(params: SmartCheckoutParams): Promise<SmartCheckoutResult>;
     /**
      * Checks if the given object is a Web3 provider.
      * @param {Web3Provider} web3Provider - The object to check.
@@ -12062,4 +12300,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, 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 };
+export { AllowedNetworkConfig, BuyOrder, BuyParams, BuyResult, BuyToken, CHECKOUT_API_BASE_URL, CancelParams, CancelResult, ChainId, ChainName, CheckConnectionParams, CheckConnectionResult, Checkout, CheckoutErrorType, CheckoutModuleConfiguration, CheckoutStatus, ConnectParams, ConnectResult, DexConfig, ERC20ItemRequirement, ERC721ItemRequirement, ErrorType, ExchangeType, FeePercentage, FeeToken, FiatRampParams, FulfillmentTransaction, GasAmount, GasEstimateBridgeToL2Result, GasEstimateParams, GasEstimateSwapResult, GasEstimateTokenConfig, GasEstimateType, GasToken, 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 };