Class SSKRShareCbor

SSKRShareCbor - CBOR/UR wrapper for an SSKR share.

An SSKR share is a binary encoding of:

Identifier (2 bytes)
Group metadata (1 byte): group_threshold-1 (4 bits) + group_count-1 (4 bits)
Member metadata (1 byte): group_index (4 bits) + member_threshold-1 (4 bits)
Member index (1 byte): reserved (4 bits, must be 0) + member_index (4 bits)
Share value (variable length)

Implements

CborTaggedEncodable
CborTaggedDecodable<SSKRShareCbor>

Methods

`Static`fromData

fromData(data: Uint8Array): SSKRShareCbor
Create an SSKRShareCbor from raw share bytes.
Parameters
- data: Uint8Array
  The share bytes (5+ bytes)
Returns SSKRShareCbor
- Defined in components/src/sskr.ts:83

`Static`fromHex

fromHex(hex: string): SSKRShareCbor
Create an SSKRShareCbor from a hex string.
Parameters
- hex: string
  The share as a hex string
Returns SSKRShareCbor
- Defined in components/src/sskr.ts:92

asBytes

asBytes(): Uint8Array
Returns the raw share bytes.

Returns Uint8Array
- Defined in components/src/sskr.ts:103

data

data(): Uint8Array
Returns a copy of the raw share bytes.

Returns Uint8Array
- Defined in components/src/sskr.ts:110

hex

hex(): string
Returns the share as a hex string.

Returns string
- Defined in components/src/sskr.ts:117

identifier

identifier(): number
Returns the identifier (2 bytes) as a number.

Returns number
- Defined in components/src/sskr.ts:128

identifierHex

identifierHex(): string
Returns the identifier as a hex string.

Returns string
- Defined in components/src/sskr.ts:135

groupThreshold

groupThreshold(): number
Returns the group threshold (minimum number of groups needed).

Returns number
- Defined in components/src/sskr.ts:142

groupCount

groupCount(): number
Returns the total number of groups.

Returns number
- Defined in components/src/sskr.ts:149

groupIndex

groupIndex(): number
Returns this share's group index (0-based).

Returns number
- Defined in components/src/sskr.ts:156

memberThreshold

memberThreshold(): number
Returns the member threshold for this share's group.

Returns number
- Defined in components/src/sskr.ts:163

memberIndex

memberIndex(): number
Returns this share's member index within its group (0-based).

Returns number
- Defined in components/src/sskr.ts:170

shareValue

shareValue(): Uint8Array
Returns the share value (the actual secret share data).

Returns Uint8Array
- Defined in components/src/sskr.ts:177

equals

equals(other: SSKRShareCbor): boolean
Compare with another SSKRShareCbor.
Parameters
- other: SSKRShareCbor
Returns boolean
- Defined in components/src/sskr.ts:188

toString

toString(): string
Get string representation.

Returns string
- Defined in components/src/sskr.ts:199

cborTags

cborTags(): Tag[]
Returns the CBOR tags associated with SSKRShare. Includes both current tag (40309) and legacy tag (309) for compatibility.

Returns Tag[]
Implementation of CborTaggedEncodable.cborTags
- Defined in components/src/sskr.ts:211

untaggedCbor

untaggedCbor(): Cbor
Returns the untagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.untaggedCbor
- Defined in components/src/sskr.ts:218

taggedCbor

taggedCbor(): Cbor
Returns the tagged CBOR encoding.

Returns Cbor
Implementation of CborTaggedEncodable.taggedCbor
- Defined in components/src/sskr.ts:225

taggedCborData

taggedCborData(): Uint8Array
Returns the tagged value in CBOR binary representation.

Returns Uint8Array
Implementation of CborTaggedEncodable.taggedCborData
- Defined in components/src/sskr.ts:232

fromUntaggedCbor

fromUntaggedCbor(cborValue: Cbor): SSKRShareCbor
Creates an SSKRShareCbor by decoding it from untagged CBOR.
Parameters
- cborValue: Cbor
Returns SSKRShareCbor
Implementation of CborTaggedDecodable.fromUntaggedCbor
- Defined in components/src/sskr.ts:243

fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): SSKRShareCbor
Creates an SSKRShareCbor by decoding it from tagged CBOR. Accepts both tag 40309 and legacy tag 309.
Parameters
- cborValue: Cbor
Returns SSKRShareCbor
Implementation of CborTaggedDecodable.fromTaggedCbor
- Defined in components/src/sskr.ts:252

`Static`fromTaggedCbor

fromTaggedCbor(cborValue: Cbor): SSKRShareCbor
Static method to decode from tagged CBOR.
Parameters
- cborValue: Cbor
Returns SSKRShareCbor
- Defined in components/src/sskr.ts:269

`Static`fromTaggedCborData

fromTaggedCborData(data: Uint8Array): SSKRShareCbor
Static method to decode from tagged CBOR binary data.
Parameters
- data: Uint8Array
Returns SSKRShareCbor
- Defined in components/src/sskr.ts:277

`Static`fromUntaggedCborData

fromUntaggedCborData(data: Uint8Array): SSKRShareCbor
Static method to decode from untagged CBOR binary data.
Parameters
- data: Uint8Array
Returns SSKRShareCbor
- Defined in components/src/sskr.ts:285