RouterSwap2Protocol

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

A swap2 protocol that asks every installed provider in parallel, checks each quote the same way, and executes the chosen route. Pass exactly one of providers or router.

const swap2 = new RouterSwap2Protocol(account, {
  fromChain: 'eip155:1',
  providers: [lifiProvider(), nearIntentsProvider(), cctpProvider()],
})
const quote = await swap2.quoteSwap2({ fromToken: 'USDC', toToken: 'USDC', toChain: 'eip155:8453', fromTokenAmount: 100_000_000n })

Extends

BaseSwap2Protocol

Constructors

Constructor

new RouterSwap2Protocol(account, config): RouterSwap2Protocol

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

Parameters

account

unknown

config

RouterSwap2Config

Returns

RouterSwap2Protocol

Overrides

BaseSwap2Protocol.constructor

Properties

_account

protected readonly _account: IWalletAccountReadOnly | IWalletAccount

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

Inherited from

BaseSwap2Protocol._account

_config

protected readonly _config: Swap2ProtocolConfig

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

Inherited from

BaseSwap2Protocol._config

fromChain

protected readonly fromChain: string

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

Inherited from

BaseSwap2Protocol.fromChain

Methods

assertFeeCaps()

protected assertFeeCaps(fees, sourceAmount, sourceToken, config?): void

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

Parameters

fees

readonly Swap2Fee[] | undefined

sourceAmount

bigint

sourceToken

string

config?

Swap2ProtocolConfig

Returns

void

Inherited from

BaseSwap2Protocol.assertFeeCaps

assertFeeConfig()

protected assertFeeConfig(config?): void

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

Parameters

config?

Swap2ProtocolConfig

Returns

void

Inherited from

BaseSwap2Protocol.assertFeeConfig

assertQuoteFeeCaps()

protected assertQuoteFeeCaps(q, options, config?): void

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

Parameters

q

Quote

options

Swap2Options

config?

Swap2ProtocolConfig

Returns

void

Inherited from

BaseSwap2Protocol.assertQuoteFeeCaps

bridge()

bridge(options): Promise<BridgeResult>

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

The inherited bridge() has no floor field: quote first, then bind execution to that quote’s minimum so the inherited convenience API stays safe.

Parameters

options

BridgeOptions

Returns

Promise<BridgeResult>

Inherited from

BaseSwap2Protocol.bridge

chainSupported()

protected chainSupported(caip2): boolean

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

Whether this protocol can route a chain at all (for support discovery).

Parameters

caip2

string

Returns

boolean

Overrides

BaseSwap2Protocol.chainSupported

claimSwap2()

claimSwap2(id, account): Promise<{ chain: string; hash: string; id: string; }>

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

Two-phase routes (CCTP-style burn-and-mint): once getSwap2Status reports “action-required”, the delivery needs a second transaction on the DESTINATION chain, signed there and paid in that chain’s gas. account is the destination-chain account (the bound source account is not reused: the chains differ). The provider builds the claim from the attestation; it is refused when not ready, when it names another chain than the account, or when it is anything but plain EVM calldata. Returns the claim hash and the status id to keep polling with.

Parameters

id

string

account

unknown

Returns

Promise<{ chain: string; hash: string; id: string; }>

Inherited from

BaseSwap2Protocol.claimSwap2

close()

close(): void

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

Release the providers’ resources (timers, sockets).

Returns

void

describeActivity()

describeActivity(tx, ctx): ActivityItem | null

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

Delegates to every provider the router holds (first match wins); null with no providers.

Parameters

tx

ChainTx

ctx

DescribeActivityContext

Returns

ActivityItem | null

Overrides

BaseSwap2Protocol.describeActivity

emitPhase()

protected emitPhase(phase, detail?): void

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

Report an execution phase; an observer that throws is ignored.

Parameters

phase

Swap2ExecutionPhase

detail?

Swap2ExecutionPhaseDetail

Returns

void

Inherited from

BaseSwap2Protocol.emitPhase

getSupportedChains()

getSupportedChains(): Promise<Swap2SupportedChain[]>

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

Source chains this protocol can swap from.

Returns

Promise<Swap2SupportedChain[]>

Inherited from

BaseSwap2Protocol.getSupportedChains

getSupportedTokens()

getSupportedTokens(options?): Promise<Swap2SupportedToken[]>

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

Tokens of the asset catalog on the supported chains, optionally narrowed.

Parameters

options?

Swap2SupportedTokensOptions

Returns

Promise<Swap2SupportedToken[]>

Inherited from

BaseSwap2Protocol.getSupportedTokens

getSwap2Status()

getSwap2Status(id, _options?): Promise<Swap2StatusResult>

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

Status of a swap by the id swap2() returned, asked from the provider that executed it.

Parameters

id

string

_options?

Swap2StatusOptions

Returns

Promise<Swap2StatusResult>

Inherited from

BaseSwap2Protocol.getSwap2Status

noRouteDetail()

protected noRouteDetail(): string

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

Why the last resolveQuote came back empty (venue names + reasons), or “”. Rides inside the no-route error so execution failures are diagnosable from the surface that shows them.

Returns

string

Overrides

BaseSwap2Protocol.noRouteDetail

pairSupported()

protected pairSupported(fromChain, toChain): boolean

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

Pair-level capability used when discovery specifies both endpoints.

Parameters

fromChain

string

toChain

string

Returns

boolean

Overrides

BaseSwap2Protocol.pairSupported

prepareOptions()

protected prepareOptions(options): Promise<Swap2Options>

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

Options ready to quote: with allowUnlistedTokens, an unlisted source token gets its decimals, read from the chain through the account (cached per token) — a caller’s fromTokenDecimals that disagrees is refused. Listed tokens and every option otherwise pass through unchanged.

Parameters

options

Swap2Options

Returns

Promise<Swap2Options>

Inherited from

BaseSwap2Protocol.prepareOptions

protocolEnabled()

protected protocolEnabled(): boolean

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

Runtime availability used by the public discovery methods.

Returns

boolean

Inherited from

BaseSwap2Protocol.protocolEnabled

providerFor()

protected providerFor(name): CrossChainProvider | undefined

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

Look up a provider by name to resume/track an in-flight swap2.

Parameters

name

string

Returns

CrossChainProvider | undefined

Overrides

BaseSwap2Protocol.providerFor

quoteBridge()

quoteBridge(options): Promise<BridgeQuote>

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

The older quoteBridge, run through quoteSwap2.

Parameters

options

BridgeOptions

Returns

Promise<BridgeQuote>

Inherited from

BaseSwap2Protocol.quoteBridge

quoteSwap()

quoteSwap(options): Promise<SwapQuote>

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

The older quoteSwap, run through quoteSwap2.

Parameters

options

SwapOptions

Returns

Promise<SwapQuote>

Inherited from

BaseSwap2Protocol.quoteSwap

quoteSwap2()

quoteSwap2(options): Promise<Swap2Quote>

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

Ask for a quote and check it against the request (amounts, slippage floor, fee ceilings in the protocol config). Works on a read-only account.

Parameters

options

Swap2Options

Returns

Promise<Swap2Quote>

Throws

Swap2QuoteError when no route answers, with the provider’s own reason when it gave one.

Inherited from

BaseSwap2Protocol.quoteSwap2

quoteSwap2Routes()

quoteSwap2Routes(options, opts?): Promise<Swap2Route[]>

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

Every route for a picker, ranked, with the best and the fastest tagged. onUpdate gets the ranked list each time another provider answers, so a UI shows the first price as soon as the fastest venue replies. Routes the caller’s floor or fee caps refuse are left out. Execute the one the user picks with using(route.provider).swap2(...).

Parameters

options

Swap2Options

opts?

onUpdate?

(routes, pending) => void

Returns

Promise<Swap2Route[]>

requireSigningAccount()

protected requireSigningAccount(methodName): IWalletAccount

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

The account, narrowed to a signing one, or a ReadOnlyAccountError naming the caller.

Parameters

methodName

string

Returns

IWalletAccount

Inherited from

BaseSwap2Protocol.requireSigningAccount

resolveQuote()

protected resolveQuote(params): Promise<Quote | null>

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

Quote the route (single provider, or best across the router).

Parameters

params

QuoteParams

Returns

Promise<Quote | null>

Overrides

BaseSwap2Protocol.resolveQuote

routeQuote()

protected routeQuote(q, options): Swap2Quote | null

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

A dry route the auction already validated → the public quote, or null when the caller’s floor / fee caps refuse it.

Parameters

q

Quote

options

Swap2Options

Returns

Swap2Quote | null

Inherited from

BaseSwap2Protocol.routeQuote

snapshotOf()

protected snapshotOf(options): Swap2Options

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

A frozen, validated copy of caller options (what every engine path works from).

Parameters

options

Swap2Options

Returns

Swap2Options

Inherited from

BaseSwap2Protocol.snapshotOf

sourceAsset()

protected sourceAsset(options): CcAsset | undefined

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

The source asset the options name: the catalog’s, or (allowUnlistedTokens) an unlisted one with its decimals.

Parameters

options

Swap2Options

Returns

CcAsset | undefined

Inherited from

BaseSwap2Protocol.sourceAsset

swap()

swap(options): Promise<SwapResult>

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

Same protection for legacy exact-in swap() calls whose min is optional.

Parameters

options

SwapOptions

Returns

Promise<SwapResult>

Inherited from

BaseSwap2Protocol.swap

swap2()

swap2(options, config?): Promise<Swap2Result>

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

Re-quote, check the quote, show it to reviewExecution when configured, send any approvals, then sign and broadcast the source leg. An identical call already in flight on the same account is refused.

Parameters

options

Swap2Options

config?

Swap2ProtocolConfig

Returns

Promise<Swap2Result>

Throws

Swap2ExecutionError for a read-only account, Swap2InFlightError for a double tap, Swap2MaybeSentError when the broadcast outcome is unknown (do not retry; track hash).

Inherited from

BaseSwap2Protocol.swap2

toParams()

protected toParams(given, dry): QuoteParams

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

Swap2Options → the engine’s QuoteParams (exact-in only).

Parameters

given

Swap2Options

dry

boolean

Returns

QuoteParams

Inherited from

BaseSwap2Protocol.toParams

toQuote()

protected toQuote(q, options): Swap2Quote

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

Parameters

q

Quote

options

Swap2Options

Returns

Swap2Quote

Inherited from

BaseSwap2Protocol.toQuote

using()

using(provider): RouterSwap2Protocol

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

This protocol pinned to one provider — the route a user picked from quoteSwap2Routes.

Parameters

provider

string

Returns

RouterSwap2Protocol