JupiterSwap2Config

Defined in: protocol-swap2-jupiter/src/protocol.ts:6

Extends

Swap2EngineConfig.JupiterProviderConfig

Properties

accountChain?

optional accountChain?: string

Defined in: protocol-swap2-core/dist/swap2/base.d.ts:66

Optional account chain identity when the account does not expose a provider.

Inherited from

Swap2EngineConfig.accountChain

allowUnlistedTokens?

optional allowUnlistedTokens?: boolean

Defined in: protocol-swap2-core/dist/swap2/base.d.ts:107

Accept tokens the swap catalog does not list, named by their contract (EVM) or mint (Solana): tokens the user added at their own risk. Off by default. The source token’s decimals are read with the account’s getTokenInfo (a fromTokenDecimals that disagrees is refused); an account without it must be given fromTokenDecimals. Only providers that trade any token (LI.FI, Uniswap, Balancer, Fynd, Jupiter) quote them, and they have no USD value: the router cannot judge their price, so show the user the amounts.

Inherited from

Swap2EngineConfig.allowUnlistedTokens

apiKey?

optional apiKey?: string

Defined in: protocol-swap2-jupiter/src/provider.ts:41

Jupiter Developer Platform key, sent as x-api-key. Keyless works at 0.5 RPS.

Inherited from

JupiterProviderConfig.apiKey

apiUrl?

optional apiUrl?: string

Defined in: protocol-swap2-jupiter/src/provider.ts:39

Swap API base (default https://api.jup.ag/swap/v2).

Inherited from

JupiterProviderConfig.apiUrl

computeUnitPricePercentile?

optional computeUnitPricePercentile?: string

Defined in: protocol-swap2-jupiter/src/provider.ts:47

Passed to /build: “medium” | “high” | “veryHigh” or a percentile in bps (default: Jupiter’s 50th percentile).

Inherited from

JupiterProviderConfig.computeUnitPricePercentile

decodeTonBody?

optional decodeTonBody?: (bocBase64) => unknown

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

Decodes a base64 BoC into a TON Cell for deposits that carry a cell body (e.g. Omniston escrow payloads). The package deliberately does not depend on @ton/core; the caller supplies e.g. (b) => Cell.fromBase64(b). Without it, cell-body deposits fail closed — a TON account treats a string body as a TEXT COMMENT, which would strand the swap.

Parameters

bocBase64

string

Returns

unknown

Inherited from

Swap2EngineConfig.decodeTonBody

defaultSlippageBps?

optional defaultSlippageBps?: number

Defined in: protocol-swap2-jupiter/src/provider.ts:49

Slippage when the caller names none, bps (default 50).

Inherited from

JupiterProviderConfig.defaultSlippageBps

enabled?

optional enabled?: boolean

Defined in: protocol-swap2-jupiter/src/provider.ts:37

Inherited from

JupiterProviderConfig.enabled

fromChain

fromChain: string

Defined in: protocol-swap2-core/dist/swap2/base.d.ts:60

CAIP-2 of the chain the bound account lives on (the swap2 source).

Inherited from

Swap2EngineConfig.fromChain

maxComputeUnitPrice?

optional maxComputeUnitPrice?: bigint

Defined in: protocol-swap2-jupiter/src/provider.ts:45

Ceiling on the compute-unit price Jupiter suggests, micro-lamports (default 2 000 000).

Inherited from

JupiterProviderConfig.maxComputeUnitPrice

maxNetworkFeeBps?

optional maxNetworkFeeBps?: number | bigint

Defined in: core/dist/index-QWdcwE6y.d.ts:429

Maximum acceptable network fee, basis points of the input amount.

Inherited from

Swap2EngineConfig.maxNetworkFeeBps

maxProtocolFeeBps?

optional maxProtocolFeeBps?: number | bigint

Defined in: core/dist/index-QWdcwE6y.d.ts:431

Maximum acceptable protocol fee, basis points of the input amount.

Inherited from

Swap2EngineConfig.maxProtocolFeeBps

onExecutionPhase?

optional onExecutionPhase?: (phase, detail?) => void

Defined in: protocol-swap2-core/dist/swap2/base.d.ts:62

Progress observer, see Swap2ExecutionPhase.

Parameters

phase

Swap2ExecutionPhase

detail?

Swap2ExecutionPhaseDetail

Returns

void

Inherited from

Swap2EngineConfig.onExecutionPhase

reviewExecution?

optional reviewExecution?: (plan) => void | Promise<void>

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

Review gate: called once the live quote is built and every payload/value check has passed, BEFORE any approval or signature. It receives a copy of exactly what will be signed; throwing (the user cancelled) aborts with nothing sent. A quote that expires while the gate is open is refused before the first approval. When the quote expires while the engine’s own approval is being mined, the engine re-quotes once; if the fresh quote differs from the reviewed one (payload, gas, a worse output) the gate is called again with requoted: true, and throwing then revokes the allowance.

Parameters

plan

Swap2ExecutionPlan

Returns

void | Promise<void>

Inherited from

Swap2EngineConfig.reviewExecution

rpcUrls?

optional rpcUrls?: readonly string[]

Defined in: protocol-swap2-jupiter/src/provider.ts:43

Solana JSON-RPC endpoints: compute-unit simulation and status. Without them the limit is 1.4 M CU and status stays pending.

Inherited from

JupiterProviderConfig.rpcUrls

serializedNativeAllowance?

optional serializedNativeAllowance?: string | number | bigint

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

Provider-SERIALIZED legs (a swap aggregator’s fully built Solana transaction): how much native coin, in base units, the account may lose on top of the swap input — rent for a destination token account, wrapped SOL juggling, priority fees. Default 20 000 000 lamports (0.02 SOL).

Inherited from

Swap2EngineConfig.serializedNativeAllowance

skipAccountChainCheck?

optional skipAccountChainCheck?: boolean

Defined in: protocol-swap2-core/dist/swap2/base.d.ts:64

Explicit escape hatch for adapters that can prove chain binding elsewhere.

Inherited from

Swap2EngineConfig.skipAccountChainCheck

tonGasCeiling?

optional tonGasCeiling?: string | number | bigint

Defined in: protocol-swap2-core/dist/swap2/base.d.ts:87

The most nanoTON a TON cell-body deposit may attach as gas: on top of the input for a native source, the whole attached value for a jetton source (default 1 TON; live Omniston swaps attach 0.1–0.4). A build attaching more is refused (scan 2026-10-27 modules, F7).

Inherited from

Swap2EngineConfig.tonGasCeiling