@imtbl/checkout-sdk 2.0.0-alpha.0

package/dist/types/smartCheckout/allowance/types.d.ts

@@ -0,0 +1,30 @@
+import { TransactionRequest } from 'ethers';
+import { ERC20Item, ERC721Item, ERC1155Item, ItemRequirement, ItemType } from '../../types';
+export type ItemAllowance = {
+    sufficient: boolean;
+    allowances: Allowance[];
+};
+export type Allowance = SufficientAllowance | InsufficientERC20 | InsufficientERC721 | InsufficientERC1155;
+export type SufficientAllowance = {
+    sufficient: true;
+    itemRequirement: ItemRequirement;
+};
+export type InsufficientERC20 = {
+    type: ItemType.ERC20;
+    sufficient: false;
+    delta: bigint;
+    itemRequirement: ERC20Item;
+    approvalTransaction: TransactionRequest | undefined;
+};
+export type InsufficientERC721 = {
+    type: ItemType.ERC721;
+    sufficient: false;
+    itemRequirement: ERC721Item;
+    approvalTransaction: TransactionRequest | undefined;
+};
+export type InsufficientERC1155 = {
+    type: ItemType.ERC1155;
+    sufficient: false;
+    itemRequirement: ERC1155Item;
+    approvalTransaction: TransactionRequest | undefined;
+};

package/dist/types/smartCheckout/balanceCheck/balanceCheck.d.ts

@@ -0,0 +1,7 @@
+import { ItemRequirement, WrappedBrowserProvider } from '../../types';
+import { CheckoutConfiguration } from '../../config';
+import { BalanceCheckResult } from './types';
+/**
+ * Checks the item requirements against the owner balances.
+ */
+export declare const balanceCheck: (config: CheckoutConfiguration, provider: WrappedBrowserProvider, ownerAddress: string, itemRequirements: ItemRequirement[], forceFetch?: boolean) => Promise<BalanceCheckResult>;

package/dist/types/smartCheckout/balanceCheck/balanceCheck.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/balanceCheck/balanceRequirement.d.ts

@@ -0,0 +1,17 @@
+import { ERC20Item, ERC721Item, ItemBalance, ItemRequirement, WrappedBrowserProvider, NativeItem, TokenBalance, TokenInfo } from '../../types';
+import { BalanceERC20Requirement, BalanceERC721Requirement, BalanceNativeRequirement } from './types';
+export declare const getTokensFromRequirements: (itemRequirements: ItemRequirement[]) => TokenInfo[];
+/**
+ * Gets the balance requirement with delta for an ERC721 requirement.
+ */
+export declare const getERC721BalanceRequirement: (itemRequirement: ERC721Item, balances: ItemBalance[]) => BalanceERC721Requirement;
+export declare const getTokenFromBalances: (itemRequirement: ERC20Item | NativeItem, balances: ItemBalance[]) => TokenBalance | undefined;
+type TokensInfoMap = {
+    [key: string]: TokenInfo;
+};
+export declare const getTokensInfo: (itemRequirements: Array<ERC20Item | NativeItem>, balances: ItemBalance[], provider: WrappedBrowserProvider) => Promise<TokensInfoMap>;
+/**
+ * Gets the balance requirement for a NATIVE or ERC20 requirement.
+ */
+export declare const getTokenBalanceRequirement: (itemRequirement: ERC20Item | NativeItem, balances: ItemBalance[], token: TokenInfo) => BalanceNativeRequirement | BalanceERC20Requirement;
+export {};

package/dist/types/smartCheckout/balanceCheck/balanceRequirement.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/balanceCheck/index.d.ts

@@ -0,0 +1 @@
+export * from './balanceCheck';

package/dist/types/smartCheckout/balanceCheck/types.d.ts

@@ -0,0 +1,30 @@
+import { BalanceDelta, ERC721Balance, ItemType, TokenBalance } from '../../types';
+export type BalanceNativeRequirement = {
+    type: ItemType.NATIVE;
+    sufficient: boolean;
+    delta: BalanceDelta;
+    current: TokenBalance;
+    required: TokenBalance;
+    isFee: boolean;
+};
+export type BalanceERC20Requirement = {
+    type: ItemType.ERC20;
+    sufficient: boolean;
+    delta: BalanceDelta;
+    current: TokenBalance;
+    required: TokenBalance;
+    isFee: boolean;
+};
+export type BalanceERC721Requirement = {
+    type: ItemType.ERC721;
+    sufficient: boolean;
+    delta: BalanceDelta;
+    current: ERC721Balance;
+    required: ERC721Balance;
+    isFee: boolean;
+};
+export type BalanceRequirement = BalanceNativeRequirement | BalanceERC721Requirement | BalanceERC20Requirement;
+export type BalanceCheckResult = {
+    sufficient: boolean;
+    balanceRequirements: BalanceRequirement[];
+};

package/dist/types/smartCheckout/buy/buy.d.ts

@@ -0,0 +1,7 @@
+import { TransactionRequest } from 'ethers';
+import { CheckoutConfiguration } from '../../config';
+import { ItemType, ItemRequirement, GasAmount, FulfillmentTransaction, BuyResult, BuyOrder, BuyOverrides } from '../../types/smartCheckout';
+import { WrappedBrowserProvider } from '../../types';
+export declare const getItemRequirement: (type: ItemType, tokenAddress: string, amount: bigint, spenderAddress: string, isFee?: boolean) => ItemRequirement;
+export declare const getTransactionOrGas: (gasLimit: number, fulfillmentTransactions: TransactionRequest[]) => FulfillmentTransaction | GasAmount;
+export declare const buy: (config: CheckoutConfiguration, provider: WrappedBrowserProvider, orders: Array<BuyOrder>, overrides?: BuyOverrides) => Promise<BuyResult>;

package/dist/types/smartCheckout/buy/buy.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/buy/index.d.ts

@@ -0,0 +1 @@
+export * from './buy';

package/dist/types/smartCheckout/cancel/cancel.d.ts

@@ -0,0 +1,3 @@
+import { CheckoutConfiguration } from '../../config';
+import { CancelOverrides, CancelResult, WrappedBrowserProvider } from '../../types';
+export declare const cancel: (config: CheckoutConfiguration, provider: WrappedBrowserProvider, orderIds: string[], overrides?: CancelOverrides) => Promise<CancelResult>;

package/dist/types/smartCheckout/cancel/cancel.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/cancel/index.d.ts

@@ -0,0 +1 @@
+export * from './cancel';

package/dist/types/smartCheckout/fees/fees.d.ts

@@ -0,0 +1,5 @@
+import { FeeValue } from '@imtbl/orderbook';
+import { OrderFee } from '../../types/fees';
+export declare const MAX_FEE_PERCENTAGE_DECIMAL = 1;
+export declare const MAX_FEE_DECIMAL_PLACES = 6;
+export declare const calculateFees: (orderFees: Array<OrderFee>, weiAmount: string, decimals?: number, tokenQuantity?: bigint) => Array<FeeValue>;

package/dist/types/smartCheckout/fees/fees.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/gas/gasCalculator.d.ts

@@ -0,0 +1,6 @@
+import { TransactionRequest } from 'ethers';
+import { FulfillmentTransaction, GasAmount, ItemRequirement, WrappedBrowserProvider } from '../../types';
+import { InsufficientERC1155, InsufficientERC20, InsufficientERC721 } from '../allowance/types';
+export declare const estimateGas: (provider: WrappedBrowserProvider, transaction: TransactionRequest) => Promise<bigint>;
+export declare const getGasItemRequirement: (gas: bigint, transactionOrGas: FulfillmentTransaction | GasAmount) => ItemRequirement;
+export declare const gasCalculator: (provider: WrappedBrowserProvider, insufficientItems: (InsufficientERC20 | InsufficientERC721 | InsufficientERC1155)[], transactionOrGas: FulfillmentTransaction | GasAmount) => Promise<ItemRequirement | null>;

package/dist/types/smartCheckout/gas/gasCalculator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/gas/index.d.ts

@@ -0,0 +1 @@
+export * from './gasCalculator';

package/dist/types/smartCheckout/index.d.ts

@@ -0,0 +1 @@
+export * from './smartCheckout';

package/dist/types/smartCheckout/itemRequirements/index.d.ts

@@ -0,0 +1 @@
+export * from './itemRequirements';

package/dist/types/smartCheckout/itemRequirements/itemRequirements.d.ts

@@ -0,0 +1,2 @@
+import { ERC1155ItemRequirement, ERC20ItemRequirement, ERC721ItemRequirement, ItemRequirement, WrappedBrowserProvider, NativeItemRequirement } from '../../types';
+export declare function getItemRequirementsFromRequirements(provider: WrappedBrowserProvider, requirements: (NativeItemRequirement | ERC20ItemRequirement | ERC721ItemRequirement | ERC1155ItemRequirement)[]): Promise<ItemRequirement[]>;

package/dist/types/smartCheckout/itemRequirements/itemRequirements.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridge/bridgeRoute.d.ts

@@ -0,0 +1,11 @@
+import { JsonRpcProvider } from 'ethers';
+import { BridgeFundingStep, ChainId, AvailableRoutingOptions } from '../../../types';
+import { CheckoutConfiguration } from '../../../config';
+import { TokenBalanceResult } from '../types';
+export declare const hasSufficientL1Eth: (tokenBalanceResult: TokenBalanceResult, totalFees: bigint) => boolean;
+export type BridgeRequirement = {
+    amount: bigint;
+    formattedAmount: string;
+    l2address: string;
+};
+export declare const bridgeRoute: (config: CheckoutConfiguration, readOnlyProviders: Map<ChainId, JsonRpcProvider>, availableRoutingOptions: AvailableRoutingOptions, bridgeRequirement: BridgeRequirement, tokenBalanceResults: Map<ChainId, TokenBalanceResult>) => Promise<BridgeFundingStep | undefined>;

package/dist/types/smartCheckout/routing/bridge/bridgeRoute.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridge/getBridgeFeeEstimate.d.ts

@@ -0,0 +1,7 @@
+import { BridgeFeeResponse } from '@imtbl/bridge-sdk';
+import { JsonRpcProvider } from 'ethers';
+import { ChainId } from '../../../types';
+import { CheckoutConfiguration } from '../../../config';
+export declare const getBridgeFeeEstimate: (config: CheckoutConfiguration, readOnlyProviders: Map<ChainId, JsonRpcProvider>, fromChainId: ChainId, toChainId: ChainId) => Promise<BridgeFeeResponse & {
+    approvalGas: bigint;
+}>;

package/dist/types/smartCheckout/routing/bridge/getBridgeFeeEstimate.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridge/getEthBalance.d.ts

@@ -0,0 +1,2 @@
+import { TokenBalanceResult } from '../types';
+export declare const getEthBalance: (balances: TokenBalanceResult) => bigint;

package/dist/types/smartCheckout/routing/bridge/getEthBalance.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridgeAndSwap/bridgeAndSwapRoute.d.ts

@@ -0,0 +1,15 @@
+import { JsonRpcProvider } from 'ethers';
+import { CheckoutConfiguration } from '../../../config';
+import { AvailableRoutingOptions, BridgeFundingStep, ChainId, GetBalanceResult, SwapFundingStep, TokenInfo } from '../../../types';
+import { BalanceCheckResult, BalanceERC20Requirement, BalanceNativeRequirement } from '../../balanceCheck/types';
+import { TokenBalanceResult } from '../types';
+import { L1ToL2TokenAddressMapping } from '../indexer/fetchL1Representation';
+export declare const abortBridgeAndSwap: (bridgeableTokens: string[], swappableTokens: TokenInfo[], l1balances: GetBalanceResult[], l2balances: GetBalanceResult[], availableRoutingOptions: AvailableRoutingOptions, requiredTokenAddress: string | undefined) => boolean;
+export declare const filterSwappableTokensByBridgeableAddresses: (requiredTokenAddress: string, bridgeableTokens: string[], swappableTokens: TokenInfo[], l1tol2Addresses: L1ToL2TokenAddressMapping[]) => TokenInfo[];
+export declare const reapplyOriginalSwapBalances: (tokenBalances: Map<ChainId, TokenBalanceResult>, swapRoutes: SwapFundingStep[]) => SwapFundingStep[];
+export declare const constructBridgeAndSwapRoutes: (bridgeFundingSteps: (BridgeFundingStep | undefined)[], swapFundingSteps: SwapFundingStep[], l1tol2Addresses: L1ToL2TokenAddressMapping[]) => BridgeAndSwapRoute[];
+export type BridgeAndSwapRoute = {
+    bridgeFundingStep: BridgeFundingStep;
+    swapFundingStep: SwapFundingStep;
+};
+export declare const bridgeAndSwapRoute: (config: CheckoutConfiguration, readOnlyProviders: Map<ChainId, JsonRpcProvider>, availableRoutingOptions: AvailableRoutingOptions, insufficientRequirement: BalanceNativeRequirement | BalanceERC20Requirement, ownerAddress: string, tokenBalances: Map<ChainId, TokenBalanceResult>, bridgeableTokens: string[], swappableTokens: TokenInfo[], balanceRequirements: BalanceCheckResult) => Promise<BridgeAndSwapRoute[]>;

package/dist/types/smartCheckout/routing/bridgeAndSwap/bridgeAndSwapRoute.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridgeAndSwap/constructBridgeRequirements.d.ts

@@ -0,0 +1,9 @@
+import { GetBalanceResult } from '../../../types';
+import { BridgeRequirement } from '../bridge/bridgeRoute';
+import { DexQuote, DexQuotes } from '../types';
+import { L1ToL2TokenAddressMapping } from '../indexer/fetchL1Representation';
+import { BalanceCheckResult } from '../../balanceCheck/types';
+export declare const getFeesForTokenAddress: (dexQuote: DexQuote, tokenAddress: string) => bigint;
+export declare const getAmountFromBalanceRequirement: (balanceRequirements: BalanceCheckResult, quotedTokenAddress: string) => bigint;
+export declare const getAmountToBridge: (quotedAmountWithFees: bigint, amountFromBalanceRequirement: bigint, l2balance: GetBalanceResult | undefined) => bigint;
+export declare const constructBridgeRequirements: (dexQuotes: DexQuotes, l1balances: GetBalanceResult[], l2balances: GetBalanceResult[], l1tol2addresses: L1ToL2TokenAddressMapping[], balanceRequirements: BalanceCheckResult) => BridgeRequirement[];

package/dist/types/smartCheckout/routing/bridgeAndSwap/constructBridgeRequirements.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridgeAndSwap/fetchL1ToL2Mapping.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridgeAndSwap/fetchL1ToL2Mappings.d.ts

@@ -0,0 +1,4 @@
+import { CheckoutConfiguration } from '../../../config';
+import { TokenInfo } from '../../../types';
+import { L1ToL2TokenAddressMapping } from '../indexer/fetchL1Representation';
+export declare const fetchL1ToL2Mappings: (config: CheckoutConfiguration, swappableTokens: TokenInfo[]) => Promise<L1ToL2TokenAddressMapping[]>;

package/dist/types/smartCheckout/routing/bridgeAndSwap/getBalancesByChain.d.ts

@@ -0,0 +1,7 @@
+import { CheckoutConfiguration } from '../../../config';
+import { ChainId, GetBalanceResult } from '../../../types';
+import { TokenBalanceResult } from '../types';
+export declare const getBalancesByChain: (config: CheckoutConfiguration, tokenBalances: Map<ChainId, TokenBalanceResult>) => {
+    l1balances: GetBalanceResult[];
+    l2balances: GetBalanceResult[];
+};

package/dist/types/smartCheckout/routing/bridgeAndSwap/getBalancesByChain.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/bridgeAndSwap/getDexQuotes.d.ts

@@ -0,0 +1,5 @@
+import { CheckoutConfiguration } from '../../../config';
+import { DexQuotes } from '../types';
+import { BalanceNativeRequirement, BalanceERC20Requirement } from '../../balanceCheck/types';
+import { TokenInfo } from '../../../types';
+export declare const getDexQuotes: (config: CheckoutConfiguration, ownerAddress: string, requiredTokenAddress: string, insufficientRequirement: BalanceNativeRequirement | BalanceERC20Requirement, filteredSwappableTokens: TokenInfo[]) => Promise<DexQuotes>;

package/dist/types/smartCheckout/routing/bridgeAndSwap/getDexQuotes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/geoBlocking.d.ts

@@ -0,0 +1,3 @@
+import { CheckoutConfiguration } from '../../config';
+export declare const isOnRampAvailable: () => Promise<boolean>;
+export declare const isSwapAvailable: (config: CheckoutConfiguration) => Promise<boolean>;

package/dist/types/smartCheckout/routing/geoBlocking.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/index.d.ts

@@ -0,0 +1 @@
+export * from './routingOptions';

package/dist/types/smartCheckout/routing/indexer/fetchL1Representation.d.ts

@@ -0,0 +1,9 @@
+import { CheckoutConfiguration } from '../../../config';
+import { ChainId } from '../../../types';
+export declare const INDEXER_ETH_ROOT_CONTRACT_ADDRESS = "0x0000000000000000000000000000000000000eee";
+export declare const getImxL1Representation: (chainId: ChainId, config: CheckoutConfiguration) => Promise<string>;
+export type L1ToL2TokenAddressMapping = {
+    l1address: string;
+    l2address: string;
+};
+export declare const fetchL1Representation: (config: CheckoutConfiguration, l2address: string) => Promise<L1ToL2TokenAddressMapping | undefined>;

package/dist/types/smartCheckout/routing/indexer/fetchL1Representation.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/onRamp/index.d.ts

@@ -0,0 +1 @@
+export * from './onRampRoute';

package/dist/types/smartCheckout/routing/onRamp/onRampRoute.d.ts

@@ -0,0 +1,4 @@
+import { CheckoutConfiguration } from '../../../config';
+import { AvailableRoutingOptions, OnRampFundingStep } from '../../../types';
+import { BalanceRequirement } from '../../balanceCheck/types';
+export declare const onRampRoute: (config: CheckoutConfiguration, availableRoutingOptions: AvailableRoutingOptions, balanceRequirement: BalanceRequirement) => Promise<OnRampFundingStep | undefined>;

package/dist/types/smartCheckout/routing/onRamp/onRampRoute.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/routingCalculator.d.ts

@@ -0,0 +1,13 @@
+import { JsonRpcProvider } from 'ethers';
+import { BalanceCheckResult, BalanceRequirement } from '../balanceCheck/types';
+import { AvailableRoutingOptions, BridgeFundingStep, ChainId, FundingRoute, OnRampFundingStep, RoutingOutcome, SwapFundingStep, TokenInfo } from '../../types';
+import { TokenBalanceResult } from './types';
+import { CheckoutConfiguration } from '../../config';
+import { RoutingTokensAllowList } from '../allowList/types';
+import { BridgeAndSwapRoute } from './bridgeAndSwap/bridgeAndSwapRoute';
+export declare const getInsufficientRequirement: (balanceRequirements: BalanceCheckResult) => BalanceRequirement | undefined;
+export declare const getBridgeFundingStep: (config: CheckoutConfiguration, readOnlyProviders: Map<ChainId, JsonRpcProvider>, availableRoutingOptions: AvailableRoutingOptions, insufficientRequirement: BalanceRequirement | undefined, tokenBalances: Map<ChainId, TokenBalanceResult>) => Promise<BridgeFundingStep | undefined>;
+export declare const getSwapFundingSteps: (config: CheckoutConfiguration, availableRoutingOptions: AvailableRoutingOptions, insufficientRequirement: BalanceRequirement | undefined, ownerAddress: string, tokenBalances: Map<ChainId, TokenBalanceResult>, swapTokenAllowList: TokenInfo[] | undefined, balanceRequirements: BalanceCheckResult) => Promise<SwapFundingStep[]>;
+export declare const getBridgeAndSwapFundingSteps: (config: CheckoutConfiguration, readOnlyProviders: Map<ChainId, JsonRpcProvider>, availableRoutingOptions: AvailableRoutingOptions, insufficientRequirement: BalanceRequirement | undefined, ownerAddress: string, tokenBalances: Map<ChainId, TokenBalanceResult>, tokenAllowList: RoutingTokensAllowList | undefined, balanceRequirements: BalanceCheckResult) => Promise<BridgeAndSwapRoute[]>;
+export declare const getOnRampFundingStep: (config: CheckoutConfiguration, availableRoutingOptions: AvailableRoutingOptions, insufficientRequirement: BalanceRequirement | undefined) => Promise<OnRampFundingStep | undefined>;
+export declare const routingCalculator: (config: CheckoutConfiguration, ownerAddress: string, balanceRequirements: BalanceCheckResult, availableRoutingOptions: AvailableRoutingOptions, onFundingRoute?: (fundingRoute: FundingRoute) => void) => Promise<RoutingOutcome>;

package/dist/types/smartCheckout/routing/routingCalculator.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/routingOptions.d.ts

@@ -0,0 +1,7 @@
+import { CheckoutConfiguration } from '../../config';
+import { AvailableRoutingOptions, WrappedBrowserProvider } from '../../types';
+export declare function isPassportProvider(provider?: WrappedBrowserProvider | null): boolean;
+/**
+ * Determines which routing options are available.
+ */
+export declare const getAvailableRoutingOptions: (config: CheckoutConfiguration, provider: WrappedBrowserProvider) => Promise<AvailableRoutingOptions>;

package/dist/types/smartCheckout/routing/routingOptions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/swap/quoteFetcher.d.ts

@@ -0,0 +1,7 @@
+import { CheckoutConfiguration } from '../../../config';
+import { ChainId } from '../../../types';
+import { DexQuotes } from '../types';
+export declare const quoteFetcher: (config: CheckoutConfiguration, chainId: ChainId, walletAddress: string, requiredToken: {
+    address: string;
+    amount: bigint;
+}, swappableTokens: string[]) => Promise<DexQuotes>;

package/dist/types/smartCheckout/routing/swap/quoteFetcher.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/swap/swapRoute.d.ts

@@ -0,0 +1,24 @@
+import { Amount, Fee } from '@imtbl/dex-sdk';
+import { CheckoutConfiguration } from '../../../config';
+import { AvailableRoutingOptions, ChainId, GetBalanceResult, SwapFees, SwapFundingStep } from '../../../types';
+import { BalanceCheckResult, BalanceRequirement } from '../../balanceCheck/types';
+import { TokenBalanceResult } from '../types';
+export declare const constructSwapRoute: (chainId: ChainId, fundsRequired: bigint, userBalance: GetBalanceResult, fees: SwapFees) => SwapFundingStep;
+export declare const isBalanceRequirementTokenValid: (balanceRequirement: BalanceRequirement) => boolean;
+export declare const getRequiredToken: (balanceRequirement: BalanceRequirement) => {
+    address: string;
+    amount: bigint;
+};
+type SufficientApprovalFees = {
+    sufficient: boolean;
+    approvalGasFee: bigint;
+    approvalGasTokenAddress: string;
+};
+export declare const checkUserCanCoverApprovalFees: (l2Balances: GetBalanceResult[], approval: Amount | null) => SufficientApprovalFees;
+export declare const checkUserCanCoverSwapFees: (l2Balances: GetBalanceResult[], approvalFees: SufficientApprovalFees, swapGasFee: Amount | null, swapFees: Fee[], tokenBeingSwapped: {
+    amount: bigint;
+    address: string;
+}) => boolean;
+export declare const checkIfUserCanCoverRequirement: (l2balance: bigint, balanceRequirements: BalanceCheckResult, quoteTokenAddress: string, amountBeingSwapped: bigint, approvalFees: SufficientApprovalFees, swapFees: Fee[]) => boolean;
+export declare const swapRoute: (config: CheckoutConfiguration, availableRoutingOptions: AvailableRoutingOptions, walletAddress: string, balanceRequirement: BalanceRequirement, tokenBalanceResults: Map<ChainId, TokenBalanceResult>, swappableTokens: string[], balanceRequirements: BalanceCheckResult) => Promise<SwapFundingStep[]>;
+export {};

package/dist/types/smartCheckout/routing/swap/swapRoute.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/tokenBalances.d.ts

@@ -0,0 +1,5 @@
+import { JsonRpcProvider } from 'ethers';
+import { CheckoutConfiguration } from '../../config';
+import { ChainId, AvailableRoutingOptions } from '../../types';
+import { TokenBalanceResult } from './types';
+export declare const getAllTokenBalances: (config: CheckoutConfiguration, readOnlyProviders: Map<ChainId, JsonRpcProvider>, ownerAddress: string, availableRoutingOptions: AvailableRoutingOptions) => Promise<Map<ChainId, TokenBalanceResult>>;

package/dist/types/smartCheckout/routing/tokenBalances.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/routing/types.d.ts

@@ -0,0 +1,15 @@
+import { Amount, Quote } from '@imtbl/dex-sdk';
+import { ChainId, GetBalanceResult } from '../../types';
+import { CheckoutError } from '../../errors';
+export type TokenBalanceResult = {
+    success: boolean;
+    balances: GetBalanceResult[];
+    error?: CheckoutError;
+};
+export type TokenBalances = Map<ChainId, TokenBalanceResult>;
+export type DexQuotes = Map<string, DexQuote>;
+export type DexQuote = {
+    quote: Quote;
+    approval: Amount | null;
+    swap: Amount | null;
+};

package/dist/types/smartCheckout/sell/index.d.ts

@@ -0,0 +1 @@
+export * from './sell';

package/dist/types/smartCheckout/sell/sell.d.ts

@@ -0,0 +1,7 @@
+import { ERC20Item, NativeItem } from '@imtbl/orderbook';
+import { ERC721Item, ERC1155Item, SellOrder, BuyToken, SellResult, WrappedBrowserProvider } from '../../types';
+import { CheckoutConfiguration } from '../../config';
+export declare const getERC721Requirement: (id: string, contractAddress: string, spenderAddress: string) => ERC721Item;
+export declare const getERC1155Requirement: (id: string, contractAddress: string, spenderAddress: string, amount: string) => ERC1155Item;
+export declare const getBuyToken: (buyToken: BuyToken, decimals?: number) => ERC20Item | NativeItem;
+export declare const sell: (config: CheckoutConfiguration, provider: WrappedBrowserProvider, orders: Array<SellOrder>) => Promise<SellResult>;

package/dist/types/smartCheckout/sell/sell.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/smartCheckout/smartCheckout.d.ts

@@ -0,0 +1,6 @@
+import { AvailableRoutingOptions, FulfillmentTransaction, FundingRoute, GasAmount, ItemRequirement, SmartCheckoutResult } from '../types/smartCheckout';
+import { CheckoutConfiguration } from '../config';
+import { BalanceCheckResult } from './balanceCheck/types';
+import { WrappedBrowserProvider } from '../types';
+export declare const overrideBalanceCheckResult: (balanceCheckResult: BalanceCheckResult) => BalanceCheckResult;
+export declare const smartCheckout: (config: CheckoutConfiguration, provider: WrappedBrowserProvider, itemRequirements: ItemRequirement[], transactionOrGasAmount?: FulfillmentTransaction | GasAmount, routingOptions?: AvailableRoutingOptions, onComplete?: (result: SmartCheckoutResult) => void, onFundingRoute?: (fundingRoute: FundingRoute) => void, fundingRouteFullAmount?: boolean) => Promise<SmartCheckoutResult>;

package/dist/types/smartCheckout/smartCheckout.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/swap/index.d.ts

@@ -0,0 +1 @@
+export * from './swap';

package/dist/types/swap/swap.d.ts

@@ -0,0 +1,7 @@
+import { BrowserProvider } from 'ethers';
+import { WrappedBrowserProvider, TokenInfo } from '../types';
+import { CheckoutConfiguration } from '../config';
+import { SwapQuoteResult, SwapResult } from '../types/swap';
+declare const swapQuote: (config: CheckoutConfiguration, provider: BrowserProvider, fromToken: TokenInfo, toToken: TokenInfo, fromAmount?: string, toAmount?: string, slippagePercent?: number, maxHops?: number, deadline?: number) => Promise<SwapQuoteResult>;
+declare const swap: (config: CheckoutConfiguration, provider: WrappedBrowserProvider, fromToken: TokenInfo, toToken: TokenInfo, fromAmount?: string, toAmount?: string, slippagePercent?: number, maxHops?: number, deadline?: number) => Promise<SwapResult>;
+export { swapQuote, swap };

package/dist/types/swap/swap.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/tokens/index.d.ts

@@ -0,0 +1 @@
+export * from './tokens';

package/dist/types/tokens/tokens.d.ts

@@ -0,0 +1,12 @@
+import { JsonRpcProvider, BrowserProvider } from 'ethers';
+import { ChainId, GetTokenAllowListResult, TokenFilter, TokenFilterTypes, TokenInfo } from '../types';
+import { CheckoutConfiguration } from '../config';
+type TokenAllowListParams = {
+    type: TokenFilterTypes;
+    chainId?: ChainId;
+    exclude?: TokenFilter[];
+};
+export declare const getTokenAllowList: (config: CheckoutConfiguration, { type, chainId, exclude, }: TokenAllowListParams) => Promise<GetTokenAllowListResult>;
+export declare const isNativeToken: (address: string | undefined) => boolean;
+export declare function getERC20TokenInfo(browserProvider: BrowserProvider | JsonRpcProvider, tokenAddress: string): Promise<TokenInfo>;
+export {};

package/dist/types/tokens/tokens.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/transaction/index.d.ts

@@ -0,0 +1 @@
+export * from './transaction';

package/dist/types/transaction/transaction.d.ts

@@ -0,0 +1,21 @@
+import { TransactionRequest } from 'ethers';
+import { CheckoutError, CheckoutErrorType } from '../errors';
+import { WrappedBrowserProvider, SendTransactionResult } from '../types';
+export declare function isPassportProvider(provider?: WrappedBrowserProvider | null): boolean;
+/**
+ * Checks conditions to operate a gas-free flow.
+ *
+ * TODO:
+ * - Phase 1 (2024): Allow all passport wallets to be gas-free.
+ * - Phase 2 & 3 (2025): Not all passport wallets will be gas-free.
+ *   Therefore, the gas-free condition must be checked against the relayer's
+ *   `im_getFeeOptions` endpoint, which should return zero for
+ *   passport accounts with gas sponsorship enabled.
+ *
+ * Refer to the docs for more details:
+ * https://docs.immutable.com/docs/zkevm/architecture/gas-sponsorship-for-gamers/
+ */
+export declare function isGasFree(provider?: WrappedBrowserProvider | null): boolean;
+export declare const setTransactionGasLimits: (browserProvider: WrappedBrowserProvider, transaction: TransactionRequest) => Promise<TransactionRequest>;
+export declare const handleProviderError: (err: any) => CheckoutError<CheckoutErrorType>;
+export declare const sendTransaction: (browserProvider: WrappedBrowserProvider, transaction: TransactionRequest) => Promise<SendTransactionResult>;

package/dist/types/transaction/transaction.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/types/balances.d.ts

@@ -0,0 +1,52 @@
+import { Eip1193Provider } from 'ethers';
+import { ChainId } from './chains';
+import { TokenInfo } from './tokenInfo';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Interface representing the parameters for {@link Checkout.getBalance}.
+ * @property {WrappedBrowserProvider} provider - The provider used to get the balance.
+ * @property {string} walletAddress - The wallet address.
+ * @property {string | undefined} tokenAddress - The contract address of the token.
+ */
+export interface GetBalanceParams {
+    provider: WrappedBrowserProvider;
+    walletAddress: string;
+    tokenAddress?: string;
+}
+/**
+ * Interface representing the result of {@link Checkout.getBalance}.
+ * @property {bigint} balance - The balance of the wallet for the token.
+ * @property {string} formattedBalance - The formatted balance of the wallet for the token.
+ * @property {TokenInfo} token - The token information.
+ */
+export interface GetBalanceResult {
+    balance: bigint;
+    formattedBalance: string;
+    token: TokenInfo;
+}
+/**
+ * Interface representing the parameters for {@link Checkout.getAllBalances}.
+ * @property {WrappedBrowserProvider} provider - The provider used to get the balances, it is a required parameter
+ * if no walletAddress is provided.
+ * @property {string} walletAddress - The wallet address, it is a required parameter if no provider is provided.
+ * @property {ChainId} chainId - The ID of the network.
+ */
+export interface GetAllBalancesParams {
+    provider?: WrappedBrowserProvider | Eip1193Provider;
+    walletAddress?: string;
+    chainId: ChainId;
+}
+/**
+ * Interface representing the result of {@link Checkout.getAllBalances}.
+ * @property {GetBalanceResult[]} balances - The array of balances of the wallet for every token.
+ */
+export interface GetAllBalancesResult {
+    balances: GetBalanceResult[];
+}
+/**
+ * Interface representing the result of {@link Checkout.getBalances}.
+ * @property {GetBalanceResult[]} balances - The array of balances of the wallet specific tokens.
+ */
+export interface GetBalancesResult {
+    balances: GetBalanceResult[];
+}

package/dist/types/types/buy.d.ts

@@ -0,0 +1,15 @@
+import { Eip1193Provider } from 'ethers';
+import { WrappedBrowserProvider } from './provider';
+import { BuyOrder, BuyOverrides } from './smartCheckout';
+/**
+ * Interface representing the parameters for {@link Checkout.buy}
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider to use for the buy.
+ * @property {Array<BuyOrder>} orders - The orders to buy
+ * @property {BuyOverrides} overrides - The overrides to use for the buy.
+ * Currently only processes the first order in the array until batch processing is supported.
+ */
+export interface BuyParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    orders: Array<BuyOrder>;
+    overrides?: BuyOverrides;
+}

package/dist/types/types/cancel.d.ts

@@ -0,0 +1,15 @@
+import { Eip1193Provider } from 'ethers';
+import { CancelOverrides } from './smartCheckout';
+import { WrappedBrowserProvider } from './provider';
+/**
+ * Interface representing the parameters for {@link Checkout.cancel}
+ * @property {WrappedBrowserProvider | Eip1193Provider} provider - The provider to use for the cancel.
+ * @property {string[]} orderIds - The order IDs to cancel.
+ * @property {CancelOverrides} overrides - The overrides to use for the cancel.
+ * Currently only processes the first order in the array until batch processing is supported.
+ */
+export interface CancelParams {
+    provider: WrappedBrowserProvider | Eip1193Provider;
+    orderIds: string[];
+    overrides?: CancelOverrides;
+}