Skip to main content

Interface: SwapOptions

gSwap SDK 2.0.0-rc.4

gSwap SDK 2.0.0-rc.4 / SwapOptions

Interface: SwapOptions

Defined in: packages/gswap-sdk/dist/index.d.ts:3185

Options of a swap.

Properties​

pool?​

optional pool?: SwapPool

Defined in: packages/gswap-sdk/dist/index.d.ts:3197

Pin the pool: take token0 / token1 verbatim from the quote the user saw, instead of ordering tokenIn / tokenOut by string comparison. tokenIn and tokenOut must be exactly these two symbols, and token0 must sort before token1. See swapRouteFromQuote.

uniqueKey?​

optional uniqueKey?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:3191

The attempt's uniqueKey (1-128 characters of A-Za-z0-9._:-). Default: a fresh <uniqueKeyPrefix><uuid>. Supply one to know the key before signing (to remember it, to show it), or to retry the SAME attempt after a lost response; never reuse it for another trade.