Skip to content
docs

RankedQuote

Defined in: protocol-swap2-router/src/router.ts:41

A validated quote with its place in the auction.

depositAddress: string

Defined in: protocol-swap2-core/dist/types.d.ts:77

Quote.depositAddress


depositMemo: string | null

Defined in: protocol-swap2-core/dist/types.d.ts:78

Quote.depositMemo


destAmount: string

Defined in: protocol-swap2-core/dist/types.d.ts:82

Quote.destAmount


etaSeconds: number

Defined in: protocol-swap2-core/dist/types.d.ts:94

Estimated time to delivery.

Quote.etaSeconds


optional fees?: object[]

Defined in: protocol-swap2-core/dist/types.d.ts:86

Honest itemized fees when the provider exposes base-unit amounts.

amount: string

optional description?: string

included: boolean

token: string

type: "protocol" | "network" | "affiliate" | "other"

Quote.fees


feeUsd: number

Defined in: protocol-swap2-core/dist/types.d.ts:84

Quote.feeUsd


intentId: string

Defined in: protocol-swap2-core/dist/types.d.ts:76

Provider’s id for this swap; tracked with trackIntent.

Quote.intentId


minDestAmount: string

Defined in: protocol-swap2-core/dist/types.d.ts:83

Quote.minDestAmount


netValueUsd: number | null

Defined in: protocol-swap2-router/src/router.ts:43

Net USD value (valueUsd), or null when the auction compared raw outputs.


provider: string

Defined in: protocol-swap2-core/dist/types.d.ts:74

Provider name.

Quote.provider


optional providerData?: Record<string, string>

Defined in: protocol-swap2-core/dist/types.d.ts:100

Provider-owned, JSON-safe facts required to revalidate execution.

Quote.providerData


relativeValue: number

Defined in: protocol-swap2-router/src/router.ts:45

This quote’s value against the best one, 0..1 (1 = the best price).


reliability: number

Defined in: protocol-swap2-core/dist/types.d.ts:96

Provider’s reliability hint, 0 to 1.

Quote.reliability


sourceAmount: string

Defined in: protocol-swap2-core/dist/types.d.ts:81

Quote.sourceAmount


tags: ("best" | "fastest")[]

Defined in: protocol-swap2-router/src/router.ts:47

“best”: the pick (best price; faster/more reliable among equal prices). “fastest”: the lowest ETA.


optional txRequest?: TxRequest

Defined in: protocol-swap2-core/dist/types.d.ts:80

Present instead of a usable depositAddress for calldata providers.

Quote.txRequest


validUntilMs: number

Defined in: protocol-swap2-core/dist/types.d.ts:98

Quote expiry, unix milliseconds.

Quote.validUntilMs