Class FrostDkgParticipantG2

Participant when the public key is in group G2

Hierarchy (view full)

FrostDkgParticipant
- FrostDkgParticipantG2

Constructors

constructor

new FrostDkgParticipantG2(id, threshold, total, protocolId): FrostDkgParticipantG2
Parameters
- id: number
- threshold: number
- total: number
- protocolId: Uint8Array
Returns FrostDkgParticipantG2
Inherited from FrostDkgParticipant.constructor
- Defined in frost-dkg.ts:65

Properties

`Readonly`id

id: number

Id of this participant

`Readonly`protocolId

protocolId: Uint8Array

Id of this execution of the DKG. Use different ids in different protocol executions.

`Optional`publicKey

publicKey?: Uint8Array

The public key of the participant

`Optional`receivedFromInRound1Count

receivedFromInRound1Count?: number

Count of messages received from others in round 1

`Optional`receivedFromInRound2

receivedFromInRound2?: Set<number>

Sender ids who sent message in round 2

`Optional`round1Msg

round1Msg?: Round1Msg

Message to be sent in round 1

`Optional`secretKey

secretKey?: Uint8Array

The secret key of the participant

`Optional`shares

shares?: Share[]

Shares to be sent in round 2

`Readonly`threshold

threshold: number

`Optional`thresholdPublicKey

thresholdPublicKey?: Uint8Array

The threshold public key and all participants will have the same public key

`Readonly`total

total: number

Methods

finishRound1

finishRound1(unchecked?): Share[]
Parameters
- unchecked: boolean = true
Returns Share[]
Inherited from FrostDkgParticipant.finishRound1
- Defined in frost-dkg.ts:94

`Protected`finishRound1Func

finishRound1Func(): ((roundState: Uint8Array) => [Uint8Array, Uint8Array[]])
Returns ((roundState: Uint8Array) => [Uint8Array, Uint8Array[]])
- - (roundState): [Uint8Array, Uint8Array[]]
  - Parameters
    - roundState: Uint8Array
    Returns [Uint8Array, Uint8Array[]]
Overrides FrostDkgParticipant.finishRound1Func
- Defined in frost-dkg.ts:282

finishRound2

finishRound2(pkBase, unchecked?): [Uint8Array, Uint8Array, Uint8Array]
Returns the secret key, public key and the threshold key
Parameters
- pkBase: PublicKeyBase
- unchecked: boolean = true
Returns [Uint8Array, Uint8Array, Uint8Array]
Inherited from FrostDkgParticipant.finishRound2
- Defined in frost-dkg.ts:120

`Protected`finishRound2Func

finishRound2Func(): ((roundState: Uint8Array, pkBase: Uint8Array) => [Uint8Array, Uint8Array, Uint8Array])
Returns ((roundState: Uint8Array, pkBase: Uint8Array) => [Uint8Array, Uint8Array, Uint8Array])
- - (roundState, pkBase): [Uint8Array, Uint8Array, Uint8Array]
  - Parameters
    - roundState: Uint8Array
    - pkBase: Uint8Array
    Returns [Uint8Array, Uint8Array, Uint8Array]
Overrides FrostDkgParticipant.finishRound2Func
- Defined in frost-dkg.ts:295

generateThresholdPublicKeyFromPublicKeys

generateThresholdPublicKeyFromPublicKeys(pubkeys): ThresholdPublicKey
Parameters
- pubkeys: [number, Uint8Array][]
Returns ThresholdPublicKey
Inherited from FrostDkgParticipant.generateThresholdPublicKeyFromPublicKeys
- Defined in frost-dkg.ts:135

hasFinishedRound1

hasFinishedRound1(): boolean
Returns boolean
Inherited from FrostDkgParticipant.hasFinishedRound1
- Defined in frost-dkg.ts:143

hasFinishedRound2

hasFinishedRound2(): boolean
Returns boolean
Inherited from FrostDkgParticipant.hasFinishedRound2
- Defined in frost-dkg.ts:147

hasStarted

hasStarted(): boolean
Returns boolean
Inherited from FrostDkgParticipant.hasStarted
- Defined in frost-dkg.ts:139

hasThresholdParticipatedInRound1

hasThresholdParticipatedInRound1(): boolean
Returns boolean
Inherited from FrostDkgParticipant.hasThresholdParticipatedInRound1
- Defined in frost-dkg.ts:151

hasThresholdParticipatedInRound2

hasThresholdParticipatedInRound2(): boolean
Returns boolean
Inherited from FrostDkgParticipant.hasThresholdParticipatedInRound2
- Defined in frost-dkg.ts:165

haveAllParticipatedInRound1

haveAllParticipatedInRound1(): boolean
Returns boolean
Inherited from FrostDkgParticipant.haveAllParticipatedInRound1
- Defined in frost-dkg.ts:158

haveAllParticipatedInRound2

haveAllParticipatedInRound2(): boolean
Returns boolean
Inherited from FrostDkgParticipant.haveAllParticipatedInRound2
- Defined in frost-dkg.ts:172

processReceivedMessageInRound1

processReceivedMessageInRound1(msg, pkBase): void
Parameters
- msg: Round1Msg
- pkBase: PublicKeyBase
Returns void
Inherited from FrostDkgParticipant.processReceivedMessageInRound1
- Defined in frost-dkg.ts:84

processReceivedSharesInRound2

processReceivedSharesInRound2(senderId, share, pkBase): void
Parameters
- senderId: number
- share: Share
- pkBase: PublicKeyBase
Returns void
Inherited from FrostDkgParticipant.processReceivedSharesInRound2
- Defined in frost-dkg.ts:107

`Protected`processRound1MsgFunc

processRound1MsgFunc(): ((roundState: Uint8Array, msg: Uint8Array, protocolId: Uint8Array, pkBase: Uint8Array) => Uint8Array)
Returns ((roundState: Uint8Array, msg: Uint8Array, protocolId: Uint8Array, pkBase: Uint8Array) => Uint8Array)
- - (roundState, msg, protocolId, pkBase): Uint8Array
  - Parameters
    - roundState: Uint8Array
    - msg: Uint8Array
    - protocolId: Uint8Array
    - pkBase: Uint8Array
    Returns Uint8Array
Overrides FrostDkgParticipant.processRound1MsgFunc
- Defined in frost-dkg.ts:273

`Protected`processRound2MsgFunc

processRound2MsgFunc(): ((roundState: Uint8Array, senderId: number, share: Uint8Array, pkBase: Uint8Array) => Uint8Array)
Returns ((roundState: Uint8Array, senderId: number, share: Uint8Array, pkBase: Uint8Array) => Uint8Array)
- - (roundState, senderId, share, pkBase): Uint8Array
  - Parameters
    - roundState: Uint8Array
    - senderId: number
    - share: Uint8Array
    - pkBase: Uint8Array
    Returns Uint8Array
Overrides FrostDkgParticipant.processRound2MsgFunc
- Defined in frost-dkg.ts:286

startRound1

startRound1(pkBase): Round1Msg
Returns the message to be broadcast to all others
Parameters
- pkBase: PublicKeyBase
Returns Round1Msg
Inherited from FrostDkgParticipant.startRound1
- Defined in frost-dkg.ts:76

`Protected`startRound1Func

startRound1Func(): ((participantId: number, threshold: number, total: number, protocolId: Uint8Array, pkBase: Uint8Array) => [Uint8Array, Uint8Array])
Returns ((participantId: number, threshold: number, total: number, protocolId: Uint8Array, pkBase: Uint8Array) => [Uint8Array, Uint8Array])
- - (participantId, threshold, total, protocolId, pkBase): [Uint8Array, Uint8Array]
  - Parameters
    - participantId: number
    - threshold: number
    - total: number
    - protocolId: Uint8Array
    - pkBase: Uint8Array
    Returns [Uint8Array, Uint8Array]
Overrides FrostDkgParticipant.startRound1Func
- Defined in frost-dkg.ts:263

`Protected`thresholdPublicKeyFromPublicKeysFunc

thresholdPublicKeyFromPublicKeysFunc(): ((pubkeys: [number, Uint8Array][], threshold: number) => Uint8Array)
Returns ((pubkeys: [number, Uint8Array][], threshold: number) => Uint8Array)
- - (pubkeys, threshold): Uint8Array
  - Parameters
    - pubkeys: [number, Uint8Array][]
    - threshold: number
    Returns Uint8Array
Overrides FrostDkgParticipant.thresholdPublicKeyFromPublicKeysFunc
- Defined in frost-dkg.ts:299

`Static`generatePublicKeyBaseFromBbsParams

generatePublicKeyBaseFromBbsParams(params): PublicKeyBase
The public key in BBS uses the elliptic curve point from the signature params so returns that
Parameters
- params: BBSSignatureParams
Returns PublicKeyBase
- Defined in frost-dkg.ts:315

`Static`generatePublicKeyBaseFromBbsPlusParams

generatePublicKeyBaseFromBbsPlusParams(params): PublicKeyBase
The public key in BBS+ uses the elliptic curve point from the signature params so returns that
Parameters
- params: BBSPlusSignatureParamsG1
Returns PublicKeyBase
- Defined in frost-dkg.ts:307

Class FrostDkgParticipantG2

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FrostDkgParticipantG2

Properties

Readonlyid

ReadonlyprotocolId

OptionalpublicKey

OptionalreceivedFromInRound1Count

OptionalreceivedFromInRound2

Optionalround1Msg

OptionalsecretKey

Optionalshares

Readonlythreshold

OptionalthresholdPublicKey

Readonlytotal

Methods

finishRound1

Parameters

Returns Share[]

ProtectedfinishRound1Func

Returns ((roundState: Uint8Array) => [Uint8Array, Uint8Array[]])

Parameters

Returns [Uint8Array, Uint8Array[]]

finishRound2

Parameters

Returns [Uint8Array, Uint8Array, Uint8Array]

ProtectedfinishRound2Func

Returns ((roundState: Uint8Array, pkBase: Uint8Array) => [Uint8Array, Uint8Array, Uint8Array])

Parameters

Returns [Uint8Array, Uint8Array, Uint8Array]

generateThresholdPublicKeyFromPublicKeys

Parameters

Returns ThresholdPublicKey

hasFinishedRound1

Returns boolean

hasFinishedRound2

Returns boolean

hasStarted

Returns boolean

hasThresholdParticipatedInRound1

Returns boolean

hasThresholdParticipatedInRound2

Returns boolean

haveAllParticipatedInRound1

Returns boolean

haveAllParticipatedInRound2

Returns boolean

processReceivedMessageInRound1

Parameters

Returns void

processReceivedSharesInRound2

Parameters

Returns void

ProtectedprocessRound1MsgFunc

Returns ((roundState: Uint8Array, msg: Uint8Array, protocolId: Uint8Array, pkBase: Uint8Array) => Uint8Array)

Parameters

Returns Uint8Array

ProtectedprocessRound2MsgFunc

Returns ((roundState: Uint8Array, senderId: number, share: Uint8Array, pkBase: Uint8Array) => Uint8Array)

Parameters

Returns Uint8Array

startRound1

Parameters

Returns Round1Msg

ProtectedstartRound1Func

Returns ((participantId: number, threshold: number, total: number, protocolId: Uint8Array, pkBase: Uint8Array) => [Uint8Array, Uint8Array])

Parameters

Returns [Uint8Array, Uint8Array]

ProtectedthresholdPublicKeyFromPublicKeysFunc

Returns ((pubkeys: [number, Uint8Array][], threshold: number) => Uint8Array)

Parameters

Returns Uint8Array

StaticgeneratePublicKeyBaseFromBbsParams

`Readonly`id

`Readonly`protocolId

`Optional`publicKey

`Optional`receivedFromInRound1Count

`Optional`receivedFromInRound2

`Optional`round1Msg

`Optional`secretKey

`Optional`shares

`Readonly`threshold

`Optional`thresholdPublicKey

`Readonly`total

`Protected`finishRound1Func

`Protected`finishRound2Func

`Protected`processRound1MsgFunc

`Protected`processRound2MsgFunc

`Protected`startRound1Func

`Protected`thresholdPublicKeyFromPublicKeysFunc

`Static`generatePublicKeyBaseFromBbsParams

`Static`generatePublicKeyBaseFromBbsPlusParams