IBC Transfer
Understand how to use the IBC Transfer components
Common customisations via props
Props
className
(optional)
className
(optional)Add classes to customise the styling
title
(optional)
title
(optional)Use to set the title of tab.
Default Value - "IBC Swaps"
sourceHeader
(optional)
sourceHeader
(optional)Use to set custom text for source section header
Default Value - "You're sending"
destinationHeader
(optional)
destinationHeader
(optional)Use to set custom text for destination section header
Default Value - "To"
showPoweredByBanner
(optional)
showPoweredByBanner
(optional)This is a boolean which toggles the visibility for the powered by text for the tab - Powered by Leap and Skip
Default Value - false
defaultValues
(optional)
defaultValues
(optional)This is an object that contains the default values for the tab
sourceChainId
: chainId of the source chainsourceAsset
: denom of source assetinputAmount
: input amount of swap in string
allowedSourceChains
(optional)
allowedSourceChains
(optional)Pass in an array of objects with a chainId
property set to the chains you want to display on the source side.
txnLifecycleHooks
(optional)
txnLifecycleHooks
(optional)This is an object that contains the callbacks for transaction lifecycle
onTxnSignInit
- callback fired when a transaction signing request is initiatedonTxnSignApproved
- callback fired when a transaction signing request is approved and the transaction has been accepted on chainonTxnSignFailed
- callback fired when a transaction signing request is rejected from walletonTxnComplete
- callback fired when a swap completesonTxnInProgress
- callback fired when a transaction is initiated, you can return a cleanup callback that fires when the transaction has been accepted on chain
onValuesChange
(optional)
onValuesChange
(optional)This a callback which is fired when following values are changed for a swap
sourceChainId
: chainId of the source chainsourceAsset
: denomination of source assetdestinationChainId
: chainId of the destination chaininputAmount
: input amount of swap in string
Last updated