SettlementBackend

SIP Protocol API Reference / SettlementBackend

Interface: SettlementBackend

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

Settlement Backend Interface

All settlement backends must implement this interface. This allows SIP to support multiple settlement layers (NEAR Intents, Zcash, THORChain, etc.)

Example

class MySettlementBackend implements SettlementBackend {
  name = 'my-backend'
  supportedChains = ['ethereum', 'solana']

  async getQuote(params: QuoteParams): Promise<Quote> {
    // Implementation
  }

  async executeSwap(params: SwapParams): Promise<SwapResult> {
    // Implementation
  }

  async getStatus(swapId: string): Promise<SwapStatusResponse> {
    // Implementation
  }
}

Properties

name

readonly name: string

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

Backend name (e.g., ‘near-intents’, ‘zcash’, ‘thorchain’)

capabilities

readonly capabilities: BackendCapabilities

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

Backend capabilities

Methods

getQuote()

getQuote(params): Promise<SettlementQuote>

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

Get a quote for a cross-chain swap

Parameters

params

SettlementQuoteParams

Quote parameters

Returns

Promise<SettlementQuote>

Quote with pricing, fees, and deposit address

Throws

If parameters are invalid

Throws

If backend API is unavailable

executeSwap()

executeSwap(params): Promise<SettlementSwapResult>

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

Execute a swap using a quote

For most backends, this returns a deposit address and waits for user deposit. Some backends may require additional signing or approval.

Parameters

params

SettlementSwapParams

Swap execution parameters

Returns

Promise<SettlementSwapResult>

Swap result with status and transaction details

Throws

If quote is invalid or expired

Throws

If backend API is unavailable

getStatus()

getStatus(swapId): Promise<SwapStatusResponse>

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

Get current swap status

Parameters

swapId

string

Swap identifier (typically the deposit address)

Returns

Promise<SwapStatusResponse>

Current swap status

Throws

If swap ID is invalid

Throws

If backend API is unavailable

cancel()?

optional cancel(swapId): Promise<void>

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

Cancel a pending swap (optional)

Only supported by backends with cancellation capabilities. Check capabilities.supportsCancellation before calling.

Parameters

swapId

string

Swap identifier to cancel

Returns

Promise<void>

Throws

If swap cannot be cancelled (already executed, etc.)

Throws

If backend API is unavailable

Throws

If cancellation is not supported

waitForCompletion()?

optional waitForCompletion(swapId, options?): Promise<SwapStatusResponse>

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

Wait for swap completion (optional)

Polls swap status until completion or timeout. Backends may provide more efficient implementations (webhooks, subscriptions).

Parameters

swapId

string

Swap identifier to monitor

options?

Polling options

interval?

number

Polling interval in milliseconds (default: 5000)

timeout?

number

Maximum wait time in milliseconds (default: 600000 = 10 minutes)

onStatusChange?

(status) => void

Status change callback

Returns

Promise<SwapStatusResponse>

Final swap status

Throws

If swap ID is invalid

Throws

If backend API is unavailable

getDryQuote()?

optional getDryQuote(params): Promise<SettlementQuote>

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

Get a dry quote (preview without creating deposit address)

Useful for showing estimates without committing to a swap. Not all backends support this (return same as getQuote if not).

Parameters

params

SettlementQuoteParams

Quote parameters

Returns

Promise<SettlementQuote>

Quote preview

notifyDeposit()?

optional notifyDeposit(swapId, txHash, metadata?): Promise<void>

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

Notify backend of deposit transaction (optional)

Some backends require explicit notification after user deposits. Check backend documentation for requirements.

Parameters

swapId

string

Swap identifier (typically deposit address)

txHash

string

Deposit transaction hash

metadata?

Record<string, unknown>

Additional backend-specific data

Returns

Promise<void>