FindBestRouteParams

SIP Protocol API Reference v0.9.0

---

SIP Protocol API Reference / FindBestRouteParams

Interface: FindBestRouteParams

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7843

Route finding parameters

Properties

from

from: object

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7845

Source chain and token

chain

chain: ChainId

token

token: string

---

to

to: object

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7850

Destination chain and token

chain

chain: ChainId

token

token: string

---

amount

amount: bigint

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7855

Amount to swap (in smallest units)

---

privacyLevel

privacyLevel: PrivacyLevel

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7857

Privacy level

---

preferSpeed?

optional preferSpeed?: boolean

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7859

Prefer speed over cost (default: false)

---

preferLowFees?

optional preferLowFees?: boolean

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7861

Prefer low fees over speed (default: true)

---

recipientMetaAddress?

optional recipientMetaAddress?: string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7863

Additional quote parameters

---

senderAddress?

optional senderAddress?: string

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7864

---

slippageTolerance?

optional slippageTolerance?: number

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7865

---

deadline?

optional deadline?: number

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7866

---

skipCache?

optional skipCache?: boolean

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7868

Skip cache and fetch fresh quotes (default: false)