​
Parameters

ParameterDescriptionRequired
defaultFromTokenAn object representing a token that will be used as the default to swap from.✅
supportedWalletVMsA required array of VMs that the swap widget should support, if a VM is selected that’s not listed it will fall back to the (deposit address)[https://support.relay.link/en/articles/10269920-how-do-deposit-addresses-work] ux. When setting this array make sure that the VMs are connectible by your wallet connection provider (dynamic, rainbow, privy, etc).✅
defaultToTokenAn object representing a token that will be used as the default to swap to.❌
lockFromTokenDisables selecting a from token in the ui. A defaultFromToken is required in order for this setting to be applied.❌
lockToTokenDisables selecting a to token in the ui. A defaultToToken is required in order for this setting to be applied.❌
onFromTokenChangeA callback triggered when the user changes the from token❌
onToTokenChangeA callback triggered when the user changes the to token❌
lockChainIdIf set, locks the chain selection to the specified chain ID. Requires default tokens to be configured for this to work properly.❌
tokensAn array of Token objects to restrict the available tokens for selection.❌
walletAn AdaptedWallet object representing the user’s wallet.❌
multiWalletSupportEnabledA boolean indicating whether multi-wallet (evm/svm) support is enabled.❌
linkedWalletsAn array of LinkedWallet objects when multi-wallet support is enabled.❌ (✅ if multiWalletSupportEnabled is true)
onSetPrimaryWalletA callback function to set the primary wallet when multi-wallet support is enabled.❌ (✅ if multiWalletSupportEnabled is true)
onLinkNewWalletA callback function to link a new wallet when multi-wallet support is enabled.❌ (✅ if multiWalletSupportEnabled is true)
defaultToAddressA wallet address to send the proceeds to.❌
defaultAmountThe default amount to swap, the amount is in the from token currency.❌
defaultTradeTypeThis can either be EXACT_INPUT or EXACT_OUTPUT, each of these refers to prefilling the output amount or the input amount and having the quote return the other side.❌
onConnectWalletA callback to connect the user’s wallet. The widget can be used to fetch quotes for unauthenticated sessions but executing the quote requires an authenticated session.✅
onAnalyticEventA callback which sends useful events to pipe into your existing analytics integration.❌
onSwapValidatingA callback that returns the quote object along with executable steps while validating the swap❌
onSwapSuccessA callback that returns the quote object along with executable steps when the swap is complete❌

​
Usage

import { SwapWidget } from '@reservoir0x/relay-kit-ui'
import { useConnectModal } from '@rainbow-me/rainbowkit'

export default function MyComponent() {
  const { openConnectModal } = useConnectModal()

  return (
    <SwapWidget
      defaultToToken={{
        chainId: 10,
        address: '0x7f5c764cbc14f9669b88837ca1490cca17c31607',
        decimals: 6,
        name: 'USDC',
        symbol: 'USDC',
        logoURI: 'https://ethereum-optimism.github.io/data/USDC/logo.png'
      }}
      defaultFromToken={{
        chainId: 8453,
        address: '0x833589fcd6edb6e08f4c7c32d4f71b54bda02913',
        decimals: 6,
        name: 'USDC',
        symbol: 'USDC',
        logoURI: 'https://ethereum-optimism.github.io/data/USDC/logo.png'
      }}
      defaultAmount={'5'}
      supportedWalletVMs={['evm']}
      onConnectWallet={openConnectModal}
      onAnalyticEvent={(eventName, data) => {
        console.log('Analytic Event', eventName, data)
      }}
    />
  )
}
RelayKitProviderTheming