CrossChainProvider

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

Pluggable cross-chain provider. Adding a provider is “add a module”; the rest of the app references only this interface (never a specific provider).

Properties

depositAddressRoutes?

readonly optional depositAddressRoutes?: boolean

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

Set by remoteProvider when the app opted in (depositAddressRoutes): this stub may send the input to an address its backend names. Without it the engine refuses a remote stub’s deposit-address and plain-value builds.

---

name

readonly name: string

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

Provider name, unique in a router.

---

remote?

readonly optional remote?: boolean

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

Set by remoteProvider: the quotes and builds come from a backend, not from code the app ships. The engine then takes the addresses an EVM transaction may call or approve only from callTargets / spenders — the app’s pins — and refuses a calldata route or an approval it has no pin for (scan 2026-10-27 modules, F8/F9/F16).

---

supportsSameChain?

optional supportsSameChain?: boolean

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

Explicit opt-in: provider can execute a same-chain swap.

---

verifiesBuilds?

readonly optional verifiesBuilds?: boolean

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

Set by remoteProvider when the app gave it verifyBuild: its builds are checked on the client.

---

verifiesQuotes?

readonly optional verifiesQuotes?: boolean

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

Set by remoteProvider when the app gave it verifyQuote: its quotes’ transactions are checked on the client. A remote stub’s EVM calldata route needs this or verifiesBuilds (scan 2026-10-30, F3).

Methods

buildClaim()?

optional buildClaim(ref): Promise<UnsignedTx | null>

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

Two-phase routes: the destination-chain transaction that completes the delivery (CCTP receiveMessage(message, attestation)), or null while the attestation is not available yet. The engine executes it through a destination-chain account (claimSwap2); tx.chain names that chain.

Parameters

ref

IntentRef

Returns

Promise<UnsignedTx | null>

---

buildDeposit()

buildDeposit(quote): Promise<UnsignedTx>

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

The source-leg transaction for a quote.

Parameters

quote

Quote

Returns

Promise<UnsignedTx>

---

callTargets()?

optional callTargets(chain): readonly string[]

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

Remote stubs: the contracts this provider’s EVM swaps may call on chain (the app’s list, e.g. lifiPins).

Parameters

chain

string

Returns

readonly string[]

---

claimTargets()?

optional claimTargets(chain): readonly string[]

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

The contracts a claim from buildClaim may call on chain (CAIP-2) — CCTP’s MessageTransmitter. claimSwap2 refuses a claim to anything else, and a provider with a claim step must declare them (round 3, M24). Kept on the client: for a remote provider this is the app’s list, never the server’s.

Parameters

chain

string

Returns

readonly string[]

---

close()?

optional close(): void

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

Returns

void

---

describeActivity()?

optional describeActivity(tx, ctx): ActivityItem | null

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

Recognize one of this provider’s own transactions in an address’s history (contract + selector on EVM, settlement counterparty elsewhere) and describe it for the activity feed; null when it is not this provider’s. Pure and synchronous. The single-provider protocol classes and the router delegate describeActivity here.

Parameters

tx

ChainTx

ctx

DescribeActivityContext

Returns

ActivityItem | null

---

enabled()

enabled(): boolean

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

Master flag — providers ship “dark” (off) until validated with real funds.

Returns

boolean

---

getQuote()

getQuote(params, signal?): Promise<Quote | null>

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

A quote, or null with the reason passed to params.onRefusal.

Parameters

params

QuoteParams

signal?

AbortSignal

Returns

Promise<Quote | null>

---

notifyDeposit()?

optional notifyDeposit(intentId, txHash): Promise<void>

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

Tell the provider the source funds were sent (tx hash / BoC). Required for NEAR Intents TON deposits — the HOT-bridge oracle can’t observe SIMPLE-mode deposits on uninitialized addresses without it. Best-effort elsewhere.

Parameters

intentId

string

txHash

string

Returns

Promise<void>

---

preflightDeposit()?

optional preflightDeposit(quote, tx): Promise<void>

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

Last fail-closed check after any approval and immediately before the wallet signs/broadcasts the source leg. Providers whose execution target can rotate or halt (THORChain vaults/routers) must revalidate it here.

Parameters

quote

Quote

tx

UnsignedTx

Returns

Promise<void>

---

registerSignedOrder()?

optional registerSignedOrder(intentId, signature): Promise<void>

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

Gasless typed-order providers: register the wallet’s EIP-712 signature.

Parameters

intentId

string

signature

string

Returns

Promise<void>

---

spenders()?

optional spenders(chain): readonly string[]

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

Remote stubs: the spenders this provider’s EVM swaps may be approved for on chain (the app’s list).

Parameters

chain

string

Returns

readonly string[]

---

supportsChain()?

optional supportsChain(caip2): boolean

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

Optional discovery hook for custom providers.

Parameters

caip2

string

Returns

boolean

---

supportsChainPair()?

optional supportsChainPair(fromChain, toChain): boolean

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

Optional pair-level discovery for aggregators.

Parameters

fromChain

string

toChain

string

Returns

boolean

---

supportsRoute()

supportsRoute(from, to): boolean

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

Cheap synchronous check: can this provider route from to to? No I/O.

Parameters

from

Asset

to

Asset

Returns

boolean

---

trackIntent()

trackIntent(ref): Promise<IntentStatus>

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

Current status of a swap.

Parameters

ref

IntentRef

Returns

Promise<IntentStatus>