SettlementRegistry

SIP Protocol API Reference v0.7.0

---

SIP Protocol API Reference / SettlementRegistry

Class: SettlementRegistry

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4521

Settlement Backend Registry

Manages multiple settlement backends and provides route-based selection.

Example

const registry = new SettlementRegistry()

// Register backends
registry.register(nearIntentsBackend)
registry.register(zcashBackend)

// Get backend by name
const backend = registry.get('near-intents')

// Find best backend for a route
const bestBackend = registry.getBestForRoute('ethereum', 'solana')

// List all supported routes
const routes = registry.getSupportedRoutes()

Constructors

Constructor

new SettlementRegistry(): SettlementRegistry

Returns

SettlementRegistry

Methods

register()

register(backend): void

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4534

Register a settlement backend

Parameters

backend

SettlementBackend

Settlement backend to register

Returns

void

Throws

If backend with same name already exists

Example

registry.register(nearIntentsBackend)

---

get()

get(name): SettlementBackend

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4547

Get a settlement backend by name

Parameters

name

string

Backend name

Returns

SettlementBackend

Settlement backend

Throws

If backend is not found

Example

const backend = registry.get('near-intents')

---

list()

list(): string[]

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4559

List all registered backend names

Returns

string[]

Array of backend names

Example

const names = registry.list()
// ['near-intents', 'zcash', 'thorchain']

---

getBestForRoute()

getBestForRoute(fromChain, toChain): SettlementBackend

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4579

Get the best backend for a specific route

Selection criteria (in order of priority):

1. Backends that support both source and destination chains
2. Backends with faster average execution time
3. First registered backend (if no execution time info)

Parameters

fromChain

ChainId

Source chain

toChain

ChainId

Destination chain

Returns

SettlementBackend

Best settlement backend for the route

Throws

If no backend supports the route

Example

const backend = registry.getBestForRoute('ethereum', 'solana')
const quote = await backend.getQuote({ ... })

---

getSupportedRoutes()

getSupportedRoutes(): Route[]

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4596

Get all supported routes across all registered backends

Returns

Route[]

Array of supported routes

Example

const routes = registry.getSupportedRoutes()
// [
//   { fromChain: 'ethereum', toChain: 'solana', backend: 'near-intents' },
//   { fromChain: 'solana', toChain: 'ethereum', backend: 'near-intents' },
//   { fromChain: 'ethereum', toChain: 'zcash', backend: 'zcash' },
//   ...
// ]

---

has()

has(name): boolean

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4610

Check if a backend is registered

Parameters

name

string

Backend name

Returns

boolean

True if backend is registered

Example

if (registry.has('near-intents')) {
  const backend = registry.get('near-intents')
}

---

unregister()

unregister(name): boolean

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4622

Unregister a settlement backend

Parameters

name

string

Backend name to unregister

Returns

boolean

True if backend was unregistered, false if not found

Example

registry.unregister('near-intents')

---

clear()

clear(): void

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4631

Clear all registered backends

Returns

void

Example

registry.clear()

---

size()

size(): number

Defined in: @sip-protocol/sdk/dist/index-BYZbDjal.d.ts:4642

Get number of registered backends

Returns

number

Number of registered backends

Example

const count = registry.size()