FindBestRouteParams
SIP Protocol API Reference v0.7.4
SIP Protocol API Reference / FindBestRouteParams
Interface: FindBestRouteParams
Section titled “Interface: FindBestRouteParams”Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7843
Route finding parameters
Properties
Section titled “Properties”from:
object
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7845
Source chain and token
chain:
ChainId
token:
string
to:
object
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7850
Destination chain and token
chain:
ChainId
token:
string
amount
Section titled “amount”amount:
bigint
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7855
Amount to swap (in smallest units)
privacyLevel
Section titled “privacyLevel”privacyLevel:
PrivacyLevel
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7857
Privacy level
preferSpeed?
Section titled “preferSpeed?”
optionalpreferSpeed:boolean
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7859
Prefer speed over cost (default: false)
preferLowFees?
Section titled “preferLowFees?”
optionalpreferLowFees:boolean
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7861
Prefer low fees over speed (default: true)
recipientMetaAddress?
Section titled “recipientMetaAddress?”
optionalrecipientMetaAddress:string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7863
Additional quote parameters
senderAddress?
Section titled “senderAddress?”
optionalsenderAddress:string
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7864
slippageTolerance?
Section titled “slippageTolerance?”
optionalslippageTolerance:number
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7865
deadline?
Section titled “deadline?”
optionaldeadline:number
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7866
skipCache?
Section titled “skipCache?”
optionalskipCache:boolean
Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7868
Skip cache and fetch fresh quotes (default: false)