SmartRouter

SIP Protocol API Reference v0.7.4

---

SIP Protocol API Reference / SmartRouter

Class: SmartRouter

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7927

Smart Router for finding optimal settlement routes

Queries all compatible backends in parallel and ranks routes by:

• Total cost (network + protocol fees)
• Execution speed (estimated time)
• Privacy support (shielded vs transparent)

Features:

• Quote caching with configurable TTL (default: 30s)
• Per-backend timeouts (default: 5s)
• Circuit breaker for failing backends
• Error isolation with Promise.allSettled

Example

const registry = new SettlementRegistry()
registry.register(nearIntentsBackend)
registry.register(zcashBackend)

const router = new SmartRouter(registry, {
  cacheTtlMs: 30_000,
  backendTimeoutMs: 5_000,
})

const routes = await router.findBestRoute({
  from: { chain: 'ethereum', token: 'USDC' },
  to: { chain: 'solana', token: 'SOL' },
  amount: 100_000000n,
  privacyLevel: PrivacyLevel.SHIELDED,
  preferLowFees: true
})

// Get best route
const best = routes[0]
console.log(`Best backend: ${best.backend}`)
console.log(`Cost: ${best.quote.fees.totalFeeUSD} USD`)
console.log(`Time: ${best.quote.estimatedTime}s`)

Constructors

Constructor

new SmartRouter(registry, options?): SmartRouter$1

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7933

Parameters

registry

SettlementRegistry

options?

SmartRouterOptions

Returns

SmartRouter$1

Methods

clearCache()

clearCache(): void

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7937

Clear the quote cache

Returns

void

---

getCacheStats()

getCacheStats(): object

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7941

Get cache statistics

Returns

object

size

size: number

maxSize

maxSize: number

---

getBackendStatuses()

getBackendStatuses(): Map<string, CircuitBreakerStatus>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7948

Get backend health statuses

Returns

Map<string, CircuitBreakerStatus>

---

findBestRoute()

findBestRoute(params): Promise<RouteWithQuote[]>

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7959

Find best routes for a swap

Queries all compatible backends in parallel and returns sorted routes. Uses caching, per-backend timeouts, and circuit breaker for reliability.

Parameters

params

FindBestRouteParams

Route finding parameters

Returns

Promise<RouteWithQuote[]>

Sorted routes (best first)

Throws

If no backends support the route

---

compareQuotes()

compareQuotes(routes): QuoteComparison

Defined in: @sip-protocol/sdk/dist/index-DXh2IGkz.d.ts:7976

Compare quotes from multiple routes side-by-side

Parameters

routes

RouteWithQuote[]

Routes to compare (from findBestRoute)

Returns

QuoteComparison

Comparison with best routes by different criteria