PrivacySmartRouterConfig

SIP Protocol API Reference v0.15.1

SIP Protocol API Reference / PrivacySmartRouterConfig

Interface: PrivacySmartRouterConfig

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19855

Configuration for SmartRouter backend selection

Properties

prioritize

prioritize: RouterPriority

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19857

What to prioritize when selecting backend

minAnonymitySet?

optional minAnonymitySet?: number

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19859

Minimum anonymity set size (for pool mixers)

requireViewingKeys?

optional requireViewingKeys?: boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19861

Require viewing key support

allowComputePrivacy?

optional allowComputePrivacy?: boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19863

Allow compute privacy backends

preferredBackend?

optional preferredBackend?: string

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19865

Preferred backend name (hint, not requirement)

excludeBackends?

optional excludeBackends?: string[]

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19867

Excluded backend names

maxCost?

optional maxCost?: bigint

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19869

Maximum acceptable cost

maxLatency?

optional maxLatency?: number

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19871

Maximum acceptable latency in ms

enableFallback?

optional enableFallback?: boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19876

Enable automatic fallback to alternative backends on failure

Default

true

includeUnhealthy?

optional includeUnhealthy?: boolean

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19881

Include unhealthy backends (circuit open) in selection

Default

false

maxFallbackAttempts?

optional maxFallbackAttempts?: number

Defined in: @sip-protocol/sdk/dist/index-GLbkPPho.d.ts:19886

Maximum number of fallback attempts