Class Checkout

constructor

• new Checkout(config?): Checkout

• Constructs a new instance of the CheckoutModule class.

  Parameters

  • Optionalconfig: CheckoutModuleConfiguration

    The configuration object for the CheckoutModule.

  Returns Checkout

Readonlyconfig

ReadonlyfiatRampService

Readonlyavailability

Optional Readonlypassport

StaticisWrappedBrowserProvider

• isWrappedBrowserProvider(browserProvider): boolean

• Checks if the given object is a WrappedBrowserProvider.

  Parameters

  • browserProvider: WrappedBrowserProvider

    The object to check.

  Returns boolean

  • True if the object is a WrappedBrowserProvider, false otherwise.

widgets

• widgets(init): Promise<WidgetsFactory>

• Loads the widgets bundle and initiates the widgets factory.

  Parameters

  • init: WidgetsInit

    The initialisation parameters for loading the widgets bundle and applying configuration

  Returns Promise<WidgetsFactory>

  A promise that resolves to the widgets factory instance that can be used to create and manage widgets

  Throws

  When the widgets script fails to load

createProvider

• createProvider(params): Promise<CreateProviderResult>

• Creates a provider using the given parameters.

  Parameters

  • params: CreateProviderParams

    The parameters for creating the provider.

  Returns Promise<CreateProviderResult>

  A promise that resolves to the created provider.

getInjectedProviders

• getInjectedProviders(): readonly EIP6963ProviderDetail[]

• Returns a list of EIP-6963 injected providers and their metadata.

  Returns readonly EIP6963ProviderDetail[]

  A readonly array of injected providers and their metadata.

findInjectedProvider

• findInjectedProvider(args): undefined | EIP6963ProviderDetail

• Finds an injected provider by its RDNS.

  Parameters

  • args: {
        rdns: string;
    }

    The parameters for finding the injected provider.

    • rdns: string

  Returns undefined | EIP6963ProviderDetail

  • The found provider and metadata or undefined.

onInjectedProvidersChange

• onInjectedProvidersChange(listener): (() => void)

• Subscribes to changes in the injected providers.

  Parameters

  • listener: ((providers: EIP6963ProviderDetail[]) => void)

    The listener to be called when the injected providers change.

    • • (providers): void

      • Parameters

        • providers: EIP6963ProviderDetail[]

        Returns void

  Returns (() => void)

  • A function to unsubscribe the listener.
  • • (): void

    • Returns void

clearInjectedProviders

• clearInjectedProviders(): void

• Clears all registered injected providers and their subscriptions.

  Returns void

  This method doesn't return a value

checkIsWalletConnected

• checkIsWalletConnected(params): Promise<CheckConnectionResult>

• Checks if a wallet is connected to the specified provider.

  Parameters

  • params: CheckConnectionParams

    The parameters for checking the wallet connection.

  Returns Promise<CheckConnectionResult>

  • A promise that resolves to the result of the check.

getRiskAssessment

• getRiskAssessment(addresses): Promise<AssessmentResult>

• Fetches the risk assessment for the given addresses.

  Parameters

  • addresses: string[]

    The addresses to assess.

  Returns Promise<AssessmentResult>

  • A promise that resolves to the risk assessment result.

checkIsAddressSanctioned

• checkIsAddressSanctioned(assessment, address?): boolean

• Helper method that checks if given risk assessment results contain sanctioned addresses.

  Parameters

  • assessment: AssessmentResult

    Risk assessment to analyse.
  • Optionaladdress: string

    If defined, only sanctions for the given address will be checked.

  Returns boolean

  • Result of the check.

connect

• connect(params): Promise<ConnectResult>

• Connects to a blockchain network using the specified provider.

  Parameters

  • params: ConnectParams

    The parameters for connecting to the network.

  Returns Promise<ConnectResult>

  A promise that resolves to an object containing the provider and network information.

  Throws

  If the provider is not valid or if there is an error connecting to the network.

addNetwork

• addNetwork(params): Promise<any>

• Adds the network for the current wallet provider.

  Parameters

  • params: AddNetworkParams

    The parameters for adding the network.

  Returns Promise<any>

  • A promise that resolves to the result of adding the network.

  Throws

  When the network cannot be added to the wallet

switchNetwork

• switchNetwork(params): Promise<SwitchNetworkResult>

• Switches the network for the current wallet provider.

  Parameters

  • params: SwitchNetworkParams

    The parameters for switching the network.

  Returns Promise<SwitchNetworkResult>

  • A promise that resolves to the result of switching the network.

getTokenInfo

• getTokenInfo(params): Promise<TokenInfo>

• Retrieves the token information given the token address. This function makes RPC calls to ERC20 contracts to fetch the main contract information (e.g. symbol).

  Parameters

  • params: GetTokenInfoParams

    The parameters for retrieving the token information.

  Returns Promise<TokenInfo>

  • A promise that resolves to the token info request.

getBalance

• getBalance(params): Promise<GetBalanceResult>

• Retrieves the balance of a wallet address.

  Parameters

  • params: GetBalanceParams

    The parameters for retrieving the balance.

  Returns Promise<GetBalanceResult>

  • A promise that resolves to the balance result.

getAllBalances

• getAllBalances(params): Promise<GetAllBalancesResult>

• Retrieves the balances of all tokens for a given wallet address on a specific chain.

  Parameters

  • params: GetAllBalancesParams

    The parameters for retrieving the balances.

  Returns Promise<GetAllBalancesResult>

  • A promise that resolves to the result of retrieving the balances.

getNetworkAllowList

• getNetworkAllowList(params): Promise<GetNetworkAllowListResult>

• Retrieves the supported networks based on the provided parameters.

  Parameters

  • params: GetNetworkAllowListParams

    The parameters for retrieving the network allow list.

  Returns Promise<GetNetworkAllowListResult>

  • A promise that resolves to the network allow list result.

getTokenAllowList

• getTokenAllowList(params): Promise<GetTokenAllowListResult>

• Retrieves the supported tokens based on the provided parameters.

  Parameters

  • params: GetTokenAllowListParams

    The parameters for retrieving the token allow list.

  Returns Promise<GetTokenAllowListResult>

  • A promise that resolves to the token allow list result.

getWalletAllowList

• getWalletAllowList(params): Promise<GetWalletAllowListResult>

• Retrieves the default supported wallets based on the provided parameters.

  Parameters

  • params: GetWalletAllowListParams

    The parameters for retrieving the wallet allow list.

  Returns Promise<GetWalletAllowListResult>

  • A promise that resolves to the wallet allow list result.

sendTransaction

• sendTransaction(params): Promise<SendTransactionResult>

• Sends a transaction using the specified provider and transaction parameters.

  Parameters

  • params: SendTransactionParams

    The parameters for sending the transaction.

  Returns Promise<SendTransactionResult>

  A promise that resolves to the result of the transaction.

providerCall

• providerCall<T>(browserProvider, block): Promise<T>

• Wraps a WrappedBrowserProvider call to validate the provider and handle errors.

  Type Parameters

  • T

  Parameters

  • browserProvider: WrappedBrowserProvider | Eip1193Provider

    The provider to connect to the network.
  • block: ((browserProvider: WrappedBrowserProvider) => Promise<T>)

    The block executing the provider call.

    • • (browserProvider): Promise<T>

      • Parameters

        • browserProvider: WrappedBrowserProvider

        Returns Promise<T>

  Returns Promise<T>

  Returns the result of the provided block param.

getNetworkInfo

• getNetworkInfo(params): Promise<NetworkInfo>

• Retrieves network information using the specified provider.

  Parameters

  • params: GetNetworkParams

    The parameters for retrieving network information.

  Returns Promise<NetworkInfo>

  A promise that resolves to the network information.

buy

• buy(params): Promise<BuyResult>

• Determines the requirements for performing a buy.

  Parameters

  • params: BuyParams

    The parameters for the buy.

  Returns Promise<BuyResult>

  A promise that resolves to the buy transaction requirements

  Deprecated

  Please use orderbook.fulfillOrder or orderbook.fulfillBulkOrders instead. The smartCheckout method can still be used to ensure the transaction requirements are met before preparing the order fulfillment

sell

• sell(params): Promise<SellResult>

• Determines the requirements for performing a sell.

  Parameters

  • params: SellParams

    The parameters for the sell.

  Returns Promise<SellResult>

  A promise that resolves to the sell transaction requirements 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.

  Deprecated

  Please use orderbook.prepareListing or orderbook.prepareBulkListing instead. The smartCheckout method can still be used to ensure the transaction requirements are met before preparing the listing

cancel

• cancel(params): Promise<CancelResult>

• Cancels a sell.

  Parameters

  • params: CancelParams

    The parameters for the cancel.

  Returns Promise<CancelResult>

  A promise that resolves to the cancel transaction result

  Deprecated

  Please use orderbook.prepareOrderCancellations instead.

smartCheckout

• smartCheckout(params): Promise<SmartCheckoutResult>

• Determines the transaction requirements to complete a purchase. This includes checking token approvals, native currency balance, and calculating the optimal route for completing the transaction.

  Parameters

  • params: SmartCheckoutParams

    The parameters for smart checkout.

  Returns Promise<SmartCheckoutResult>

  A promise that resolves to the transaction requirements including:

  • Required token approvals
  • Required native currency balance
  • Suggested transaction route
  • Estimated gas costs

  Throws

  When item requirements cannot be mapped or checkout validation fails

gasEstimate

• gasEstimate(params): Promise<GasEstimateSwapResult | GasEstimateBridgeToL2Result>

• Estimates the gas required for a swap or bridge transaction.

  Parameters

  • params: GasEstimateParams

    The parameters for the gas estimation.

  Returns Promise<GasEstimateSwapResult | GasEstimateBridgeToL2Result>

  • A promise that resolves to the gas estimation result.

createFiatRampUrl

• createFiatRampUrl(params): Promise<string>

• Creates and returns a URL for the fiat ramp widget.

  Parameters

  • params: FiatRampParams

    The parameters for creating the url.

  Returns Promise<string>

  • A promise that resolves to a string url.

getExchangeFeeEstimate

• getExchangeFeeEstimate(): Promise<OnRampProviderFees>

• Fetches fiat ramp fee estimations.

  Returns Promise<OnRampProviderFees>

  • A promise that resolves to OnRampProviderFees.

isSwapAvailable

• isSwapAvailable(): Promise<boolean>

• Fetches Swap widget availability.

  Returns Promise<boolean>

  • A promise that resolves to a boolean.

swap

• swap(params): Promise<SwapResult>

• Fetches a quote and then performs the approval and swap transaction.

  Parameters

  • params: SwapParams

    The parameters for the swap.

  Returns Promise<SwapResult>

  • A promise that resolves to the swap result (swap tx, swap tx receipt, quote used in the swap).

swapQuote

• swapQuote(params): Promise<SwapQuoteResult>

• Fetches a quote for the swap.

  Parameters

  • params: SwapParams

    The parameters for the swap.

  Returns Promise<SwapQuoteResult>

  • A promise that resolves to the swap quote result.