DID BTCR2 JS

Appearance

Class: BeaconCohortSigningSession ​

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:52

Implements ​

Constructors ​

Constructor ​

new BeaconCohortSigningSession(params): BeaconCohortSigningSession

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:128

Creates a new instance of BeaconCohortSigningSession.

Parameters ​

params ​

SigningSession

Parameters to initialize the signing session.

Returns ​

BeaconCohortSigningSession

Properties ​

aggregatedNonce? ​

optional aggregatedNonce: Uint8Array<ArrayBufferLike>

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:81

Aggregated nonce from all participants.

Implementation of ​

SigningSession.aggregatedNonce

cohort ​

cohort: AggregateBeaconCohort

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:63

DID of the coordinator.

Implementation of ​

SigningSession.cohort

id ​

id: string

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:57

Unique identifier for the signing session.

Implementation of ​

SigningSession.id

musig2Session? ​

optional musig2Session: Session

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:117

Musig2 session for signing operations.

nonceContributions ​

nonceContributions: Map<string, Nonce>

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:75

Map of nonce contributions from participants.

Implementation of ​

SigningSession.nonceContributions

nonceSecrets? ​

optional nonceSecrets: bigint

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:111

Secrets for nonces contributed by participants.

Implementation of ​

SigningSession.nonceSecrets

partialSignatures ​

partialSignatures: Map<string, Uint8Array<ArrayBufferLike>>

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:87

Map of partial signatures from participants.

Implementation of ​

SigningSession.partialSignatures

pendingTx ​

pendingTx: Transaction

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:69

Pending transaction to be signed.

Implementation of ​

SigningSession.pendingTx

processedRequests ​

processedRequests: Record<string, string>

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:105

Map of processed requests from participants.

Implementation of ​

SigningSession.processedRequests

signature? ​

optional signature: Uint8Array<ArrayBufferLike>

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:93

Final signature for the transaction.

Implementation of ​

SigningSession.signature

status ​

status: SIGNING_SESSION_STATUS_TYPE

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:99

Current status of the signing session.

Implementation of ​

SigningSession.status

Methods ​

addNonceContribution() ​

addNonceContribution(from, nonceContribution): void

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:159

Adds a nonce contribution from a participant to the session.

Parameters ​

from ​

string

The public key of the participant contributing the nonce.

nonceContribution ​

Uint8Array

The nonce contribution from the participant.

Returns ​

void

Throws ​

If the session is not awaiting nonce contributions or if the contribution is invalid.

addPartialSignature() ​

addPartialSignature(from, partialSignature): void

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:207

Adds a partial signature from a participant to the session.

Parameters ​

from ​

string

The public key of the participant contributing the partial signature.

partialSignature ​

Uint8Array

The partial signature from the participant.

Returns ​

void

generateAggregatedNonce() ​

generateAggregatedNonce(): Uint8Array

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:184

Generates the aggregated nonce from all nonce contributions for the session.

Returns ​

Uint8Array

The aggregated nonce.

Throws ​

If not all nonce contributions have been received.

generateFinalSignature() ​

generateFinalSignature(): Promise<Uint8Array<ArrayBufferLike>>

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:223

Generates the final signature from all partial signatures.

Returns ​

Promise<Uint8Array<ArrayBufferLike>>

The final aggregated signature.

generatePartialSignature() ​

generatePartialSignature(participantSk): Uint8Array

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:254

Generates a partial signature for the session using the participant's secret key.

Parameters ​

participantSk ​

Uint8Array

The secret key of the participant.

Returns ​

Uint8Array

The partial signature generated by the participant.

getAuthorizationRequest() ​

getAuthorizationRequest(to, from): BeaconCohortAuthorizationRequestMessage

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:142

Gets the authorization request message for a participant.

Parameters ​

to ​

string

The public key of the participant to whom the request is sent.

from ​

string

The public key of the participant sending the request.

Returns ​

BeaconCohortAuthorizationRequestMessage

The authorization request message.

isComplete() ​

isComplete(): boolean

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:278

Checks if the signing session is a completed state.

Returns ​

boolean

True if the session is complete, false otherwise.

isFailed() ​

isFailed(): boolean

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:286

Checks if the signing session is in a failed state.

Returns ​

boolean

True if the session has failed, false otherwise.

json() ​

json(): BeaconCohortSigningSession

Defined in: packages/method/src/core/beacon/aggregation/session/index.ts:270

Converts the signing session instance to a JSON object representation.

Returns ​

BeaconCohortSigningSession

The JSON object representation of the signing session.