ThresholdViewingKey

SIP Protocol API Reference / ThresholdViewingKey

Class: ThresholdViewingKey

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

Threshold Viewing Key implementation using Shamir’s Secret Sharing

Allows splitting a viewing key into N-of-M shares where any N shares can reconstruct the original key, but fewer than N shares reveal nothing.

Constructors

Constructor

new ThresholdViewingKey(): ThresholdViewingKey

Returns

ThresholdViewingKey

Methods

create()

static create(params): ThresholdShares

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

Create threshold shares from a viewing key

Parameters

params

Configuration parameters

threshold

number

totalShares

number

viewingKey

`0x${string}`

Returns

ThresholdShares

Threshold shares with commitment

Throws

ValidationError if parameters are invalid

Example

const threshold = ThresholdViewingKey.create({
  threshold: 3,
  totalShares: 5,
  viewingKey: '0xabc123...',
})

reconstruct()

static reconstruct(shares): `0x${string}`

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

Reconstruct viewing key from threshold shares

Parameters

string[]

Array of encoded shares (must be >= threshold)

Returns

`0x${string}`

Reconstructed viewing key

Throws

ValidationError if insufficient or invalid shares

Example

const viewingKey = ThresholdViewingKey.reconstruct([
  'share1',
  'share2',
  'share3',
])

verifyShare()

static verifyShare(share, expectedCommitment): boolean

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

Verify a share without revealing the viewing key

Parameters

string

Encoded share to verify

expectedCommitment

string

Expected commitment hash

Returns

boolean

True if share is valid

Example

const isValid = ThresholdViewingKey.verifyShare(
  'share1',
  'commitment_hash'
)