@somnia-chain/markets-sdk / chains / CreateBridgeTransferParams
Interface: CreateBridgeTransferParams
Defined in: packages/sdk/src/chains/bridge/transfer.ts:25
Parameters for createBridgeTransfer.
Properties
token
token:
BridgeToken
Defined in: packages/sdk/src/chains/bridge/transfer.ts:27
Token to bridge.
from
from:
number
Defined in: packages/sdk/src/chains/bridge/transfer.ts:29
Chain id to send FROM.
to
to:
number
Defined in: packages/sdk/src/chains/bridge/transfer.ts:31
Chain id to send TO.
amount
amount:
bigint
Defined in: packages/sdk/src/chains/bridge/transfer.ts:36
Amount in base units of the origin side's decimals — read them off BridgeTokenDetails.decimals rather than assuming 18 (WBTC is 8).
recipient
recipient:
`0x${string}`
Defined in: packages/sdk/src/chains/bridge/transfer.ts:38
Who receives the tokens on the destination chain.
gasPayment?
optionalgasPayment?:bigint
Defined in: packages/sdk/src/chains/bridge/transfer.ts:45
Interchain gas payment to attach, added to the transfer's value. Defaults to
0n, which is correct for this bridge — it has no InterchainGasPaymaster and
every router quotes 0. Pass the result of quoteGasPayment(destinationDomain)
if that ever changes.
approveAmount?
optionalapproveAmount?:bigint
Defined in: packages/sdk/src/chains/bridge/transfer.ts:51
Amount to approve on a collateral route. Defaults to amount (exact
approval). Pass a larger value to approve once for several transfers, or 0n
to skip the approval step entirely when an allowance is already in place.