PrivacySmartRouterConfig

SIP Protocol API Reference v0.7.4

SIP Protocol API Reference / PrivacySmartRouterConfig

Interface: PrivacySmartRouterConfig

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

Configuration for SmartRouter backend selection

Properties

prioritize

prioritize: RouterPriority

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

What to prioritize when selecting backend

minAnonymitySet?

optional minAnonymitySet: number

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

Minimum anonymity set size (for pool mixers)

requireViewingKeys?

optional requireViewingKeys: boolean

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

Require viewing key support

allowComputePrivacy?

optional allowComputePrivacy: boolean

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

Allow compute privacy backends

preferredBackend?

optional preferredBackend: string

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

Preferred backend name (hint, not requirement)

excludeBackends?

optional excludeBackends: string[]

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

Excluded backend names

maxCost?

optional maxCost: bigint

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

Maximum acceptable cost

maxLatency?

optional maxLatency: number

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

Maximum acceptable latency in ms

enableFallback?

optional enableFallback: boolean

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

Enable automatic fallback to alternative backends on failure

Default

true

includeUnhealthy?

optional includeUnhealthy: boolean

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

Include unhealthy backends (circuit open) in selection

Default

false

maxFallbackAttempts?

optional maxFallbackAttempts: number

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

Maximum number of fallback attempts