Class ThresholdBbsPlusSigner

Common functionality of the BBS+ and BBS threshold signer

Hierarchy (view full)

ThresholdSigner
- ThresholdBbsPlusSigner

Constructors

constructor

new ThresholdBbsPlusSigner(id, others, threshold, sigBatchSize, protocolId): ThresholdBbsPlusSigner
Parameters
- id: number
  id of this participant
- others: Set<number>
  ids of all other participant
- threshold: number
  the threshold for this signature
- sigBatchSize: number
  the number of signatures that will be produced with on the completion of this protocol.
- protocolId: Uint8Array
  unique id
Returns ThresholdBbsPlusSigner
Inherited from ThresholdSigner.constructor
- Defined in threshold-sigs/common.ts:80

Properties

`Optional`comms

comms?: Commitments

`Optional`commsForZero

commsForZero?: Map<number, CommitmentsForZeroSharing>

`Readonly`id

id: number

`Optional`msg1s

msg1s?: Map<number, Message1>

`Optional`msg2s

msg2s?: Map<number, Message2>

`Readonly`others

others: Set<number>

`Readonly`protocolId

protocolId: Uint8Array

`Optional`recvCommFrom

recvCommFrom?: Set<number>

`Optional`recvSharesFrom

recvSharesFrom?: Set<number>

`Protected` `Optional`round1Output

round1Output?: Uint8Array

`Protected` `Optional`round2Output

round2Output?: Uint8Array

`Readonly`sigBatchSize

sigBatchSize: number

`Readonly`threshold

threshold: number

Methods

createSigShare

createSigShare(messages, indexInBatch, params, encodeMessages): ThresholdBbsPlusSignatureShare
Create a share of the BBS+ signature to be given to the user
Parameters
- messages: Uint8Array[]
  the messages to be signed for this signature
- indexInBatch: number
  the index (0-based) of this signature in the batch
- params: BBSPlusSignatureParamsG1
- encodeMessages: boolean
Returns ThresholdBbsPlusSignatureShare
- Defined in threshold-sigs/bbs-plus.ts:30

ensureRound1Finished

ensureRound1Finished(): void
Returns void
Inherited from ThresholdSigner.ensureRound1Finished
- Defined in threshold-sigs/common.ts:215

ensureRound1Started

ensureRound1Started(): void
Returns void
Inherited from ThresholdSigner.ensureRound1Started
- Defined in threshold-sigs/common.ts:209

ensureRound2Finished

ensureRound2Finished(): void
Returns void
Inherited from ThresholdSigner.ensureRound2Finished
- Defined in threshold-sigs/common.ts:227

ensureRound2Started

ensureRound2Started(): void
Returns void
Inherited from ThresholdSigner.ensureRound2Started
- Defined in threshold-sigs/common.ts:221

`Protected`finishR1

finishR1(secretKey): void
Parameters
- secretKey: Uint8Array
Returns void
Inherited from ThresholdSigner.finishR1
- Defined in threshold-sigs/common.ts:188

finishRound1

finishRound1(secretKey): void
Parameters
- secretKey: BBSPlusSecretKey
Returns void
- Defined in threshold-sigs/bbs-plus.ts:19

`Protected`finishRound1Func

finishRound1Func(): ((phase1: Uint8Array, secretKey: Uint8Array) => Uint8Array)
Returns ((phase1: Uint8Array, secretKey: Uint8Array) => Uint8Array)
- - (phase1, secretKey): Uint8Array
  - Parameters
    - phase1: Uint8Array
    - secretKey: Uint8Array
    Returns Uint8Array
Overrides ThresholdSigner.finishRound1Func
- Defined in threshold-sigs/bbs-plus.ts:91

finishRound2

finishRound2(): void
Returns void
Inherited from ThresholdSigner.finishRound2
- Defined in threshold-sigs/common.ts:183

`Protected`finishRound2Func

finishRound2Func(): ((phase2: Uint8Array) => Uint8Array)
Returns ((phase2: Uint8Array) => Uint8Array)
- - (phase2): Uint8Array
  - Parameters
    - phase2: Uint8Array
    Returns Uint8Array
Overrides ThresholdSigner.finishRound2Func
- Defined in threshold-sigs/bbs-plus.ts:123

`Protected`getSharesForOtherFunc

getSharesForOtherFunc(): ((phase1: Uint8Array, otherId: number) => [Uint8Array, Uint8Array])
Returns ((phase1: Uint8Array, otherId: number) => [Uint8Array, Uint8Array])
- - (phase1, otherId): [Uint8Array, Uint8Array]
  - Parameters
    - phase1: Uint8Array
    - otherId: number
    Returns [Uint8Array, Uint8Array]
Overrides ThresholdSigner.getSharesForOtherFunc
- Defined in threshold-sigs/bbs-plus.ts:74

`Protected`getSharesForOthersFunc

getSharesForOthersFunc(): ((phase1: Uint8Array, otherIds: number[]) => [Uint8Array, Uint8Array][])
Returns ((phase1: Uint8Array, otherIds: number[]) => [Uint8Array, Uint8Array][])
- - (phase1, otherIds): [Uint8Array, Uint8Array][]
  - Parameters
    - phase1: Uint8Array
    - otherIds: number[]
    Returns [Uint8Array, Uint8Array][]
Overrides ThresholdSigner.getSharesForOthersFunc
- Defined in threshold-sigs/bbs-plus.ts:78

getSharesForOtherSigner

getSharesForOtherSigner(signerId): [Shares, ZeroShares]
Returns shares to be sent to the signer with id signerId
Parameters
- signerId: number
Returns [Shares, ZeroShares]
Inherited from ThresholdSigner.getSharesForOtherSigner
- Defined in threshold-sigs/common.ts:122

getSharesForOtherSigners

getSharesForOtherSigners(signerIds): [Shares, ZeroShares][]
Returns an array of shares, 1 to be sent to each of the signer in signerIds
Parameters
- signerIds: number[]
Returns [Shares, ZeroShares][]
Inherited from ThresholdSigner.getSharesForOtherSigners
- Defined in threshold-sigs/common.ts:132

hasFinishedRound1

hasFinishedRound1(): boolean
Returns boolean
Inherited from ThresholdSigner.hasFinishedRound1
- Defined in threshold-sigs/common.ts:197

hasFinishedRound2

hasFinishedRound2(): boolean
Returns boolean
Inherited from ThresholdSigner.hasFinishedRound2
- Defined in threshold-sigs/common.ts:205

hasReceivedCommitmentsFromAll

hasReceivedCommitmentsFromAll(): boolean
Returns boolean
Inherited from ThresholdSigner.hasReceivedCommitmentsFromAll
- Defined in threshold-sigs/common.ts:233

hasReceivedSharesFromAll

hasReceivedSharesFromAll(): boolean
Returns boolean
Inherited from ThresholdSigner.hasReceivedSharesFromAll
- Defined in threshold-sigs/common.ts:237

hasStarted

hasStarted(): boolean
Returns boolean
Inherited from ThresholdSigner.hasStarted
- Defined in threshold-sigs/common.ts:193

hasStartedRound2

hasStartedRound2(): boolean
Returns boolean
Inherited from ThresholdSigner.hasStartedRound2
- Defined in threshold-sigs/common.ts:201

`Protected`processCommFunc

processCommFunc(): ((phase1: Uint8Array, senderId: number, commitments: Uint8Array, commitmentsZeroShare: Uint8Array) => Uint8Array)
Returns ((phase1: Uint8Array, senderId: number, commitments: Uint8Array, commitmentsZeroShare: Uint8Array) => Uint8Array)
- - (phase1, senderId, commitments, commitmentsZeroShare): Uint8Array
  - Parameters
    - phase1: Uint8Array
    - senderId: number
    - commitments: Uint8Array
    - commitmentsZeroShare: Uint8Array
    Returns Uint8Array
Overrides ThresholdSigner.processCommFunc
- Defined in threshold-sigs/bbs-plus.ts:65

processReceivedCommitments

processReceivedCommitments(senderId, comms, commsZeroShare): void
Parameters
- senderId: number
- comms: Commitments
- commsZeroShare: CommitmentsForZeroSharing
Returns void
Inherited from ThresholdSigner.processReceivedCommitments
- Defined in threshold-sigs/common.ts:107

processReceivedMsg1

processReceivedMsg1(senderId, msg, gadgetVector): Message2
Parameters
- senderId: number
- msg: Message1
- gadgetVector: GadgetVector
Returns Message2
Inherited from ThresholdSigner.processReceivedMsg1
- Defined in threshold-sigs/common.ts:166

processReceivedMsg2

processReceivedMsg2(senderId, msg, gadgetVector): void
Parameters
- senderId: number
- msg: Message2
- gadgetVector: GadgetVector
Returns void
Inherited from ThresholdSigner.processReceivedMsg2
- Defined in threshold-sigs/common.ts:178

processReceivedShares

processReceivedShares(senderId, shares, zeroShares): void
Parameters
- senderId: number
- shares: Shares
- zeroShares: ZeroShares
Returns void
Inherited from ThresholdSigner.processReceivedShares
- Defined in threshold-sigs/common.ts:138

`Protected`processSharesFunc

processSharesFunc(): ((phase1: Uint8Array, senderId: number, shares: Uint8Array, zeroShares: Uint8Array) => Uint8Array)
Returns ((phase1: Uint8Array, senderId: number, shares: Uint8Array, zeroShares: Uint8Array) => Uint8Array)
- - (phase1, senderId, shares, zeroShares): Uint8Array
  - Parameters
    - phase1: Uint8Array
    - senderId: number
    - shares: Uint8Array
    - zeroShares: Uint8Array
    Returns Uint8Array
Overrides ThresholdSigner.processSharesFunc
- Defined in threshold-sigs/bbs-plus.ts:82

`Protected`recvMsg1Func

recvMsg1Func(): ((phase2: Uint8Array, senderId: number, message: Uint8Array, gadgetVector: Uint8Array) => [Uint8Array, Uint8Array])
Returns ((phase2: Uint8Array, senderId: number, message: Uint8Array, gadgetVector: Uint8Array) => [Uint8Array, Uint8Array])
- - (phase2, senderId, message, gadgetVector): [Uint8Array, Uint8Array]
  - Parameters
    - phase2: Uint8Array
    - senderId: number
    - message: Uint8Array
    - gadgetVector: Uint8Array
    Returns [Uint8Array, Uint8Array]
Overrides ThresholdSigner.recvMsg1Func
- Defined in threshold-sigs/bbs-plus.ts:105

`Protected`recvMsg2Func

recvMsg2Func(): ((phase2: Uint8Array, senderId: number, message: Uint8Array, gadgetVector: Uint8Array) => Uint8Array)
Returns ((phase2: Uint8Array, senderId: number, message: Uint8Array, gadgetVector: Uint8Array) => Uint8Array)
- - (phase2, senderId, message, gadgetVector): Uint8Array
  - Parameters
    - phase2: Uint8Array
    - senderId: number
    - message: Uint8Array
    - gadgetVector: Uint8Array
    Returns Uint8Array
Overrides ThresholdSigner.recvMsg2Func
- Defined in threshold-sigs/bbs-plus.ts:114

startRound1

startRound1(): [Commitments, Map<number, CommitmentsForZeroSharing>]
Returns the commitments to be sent to other signers

Returns [Commitments, Map<number, CommitmentsForZeroSharing>]
Inherited from ThresholdSigner.startRound1
- Defined in threshold-sigs/common.ts:94

`Protected`startRound1Func

startRound1Func(): ((sigBatchSize: number, participantId: number, others: Set<number>, protocolId: Uint8Array) => [Uint8Array, Uint8Array, Map<number, Uint8Array>])
Returns ((sigBatchSize: number, participantId: number, others: Set<number>, protocolId: Uint8Array) => [Uint8Array, Uint8Array, Map<number, Uint8Array>])
- - (sigBatchSize, participantId, others, protocolId): [Uint8Array, Uint8Array, Map<number, Uint8Array>]
  - Parameters
    - sigBatchSize: number
    - participantId: number
    - others: Set<number>
    - protocolId: Uint8Array
    Returns [Uint8Array, Uint8Array, Map<number, Uint8Array>]
Overrides ThresholdSigner.startRound1Func
- Defined in threshold-sigs/bbs-plus.ts:56

startRound2

startRound2(baseOTOut, gadgetVector): Map<number, Message1>
Parameters
- baseOTOut: BaseOTOutput
- gadgetVector: GadgetVector
Returns Map<number, Message1>
Inherited from ThresholdSigner.startRound2
- Defined in threshold-sigs/common.ts:149

`Protected`startRound2Func

startRound2Func(): ((participantId: number, others: Set<number>, phase1Output: Uint8Array, baseOTOutput: Uint8Array, gadgetVector: Uint8Array) => [Uint8Array, Map<number, Uint8Array>])
Returns ((participantId: number, others: Set<number>, phase1Output: Uint8Array, baseOTOutput: Uint8Array, gadgetVector: Uint8Array) => [Uint8Array, Map<number, Uint8Array>])
- - (participantId, others, phase1Output, baseOTOutput, gadgetVector): [Uint8Array, Map<number, Uint8Array>]
  - Parameters
    - participantId: number
    - others: Set<number>
    - phase1Output: Uint8Array
    - baseOTOutput: Uint8Array
    - gadgetVector: Uint8Array
    Returns [Uint8Array, Map<number, Uint8Array>]
Overrides ThresholdSigner.startRound2Func
- Defined in threshold-sigs/bbs-plus.ts:95

`Static`aggregateShares

aggregateShares(shares): BBSPlusSignatureG1
Aggregate many signature shares to form a BBS+ signature
Parameters
- shares: ThresholdBbsPlusSignatureShare[]
Returns BBSPlusSignatureG1
- Defined in threshold-sigs/bbs-plus.ts:52

Class ThresholdBbsPlusSigner

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ThresholdBbsPlusSigner

Properties

Optionalcomms

OptionalcommsForZero

Readonlyid

Optionalmsg1s

Optionalmsg2s

Readonlyothers

ReadonlyprotocolId

OptionalrecvCommFrom

OptionalrecvSharesFrom

Protected Optionalround1Output

Protected Optionalround2Output

ReadonlysigBatchSize

Readonlythreshold

Methods

createSigShare

Parameters

Returns ThresholdBbsPlusSignatureShare

ensureRound1Finished

Returns void

ensureRound1Started

Returns void

ensureRound2Finished

Returns void

ensureRound2Started

Returns void

ProtectedfinishR1

Parameters

Returns void

finishRound1

Parameters

Returns void

ProtectedfinishRound1Func

Returns ((phase1: Uint8Array, secretKey: Uint8Array) => Uint8Array)

Parameters

Returns Uint8Array

finishRound2

Returns void

ProtectedfinishRound2Func

Returns ((phase2: Uint8Array) => Uint8Array)

Parameters

Returns Uint8Array

ProtectedgetSharesForOtherFunc

Returns ((phase1: Uint8Array, otherId: number) => [Uint8Array, Uint8Array])

Parameters

Returns [Uint8Array, Uint8Array]

ProtectedgetSharesForOthersFunc

Returns ((phase1: Uint8Array, otherIds: number[]) => [Uint8Array, Uint8Array][])

Parameters

Returns [Uint8Array, Uint8Array][]

getSharesForOtherSigner

Parameters

Returns [Shares, ZeroShares]

getSharesForOtherSigners

Parameters

Returns [Shares, ZeroShares][]

hasFinishedRound1

Returns boolean

hasFinishedRound2

Returns boolean

hasReceivedCommitmentsFromAll

Returns boolean

hasReceivedSharesFromAll

Returns boolean

hasStarted

Returns boolean

hasStartedRound2

Returns boolean

ProtectedprocessCommFunc

Returns ((phase1: Uint8Array, senderId: number, commitments: Uint8Array, commitmentsZeroShare: Uint8Array) => Uint8Array)

`Optional`comms

`Optional`commsForZero

`Readonly`id

`Optional`msg1s

`Optional`msg2s

`Readonly`others

`Readonly`protocolId

`Optional`recvCommFrom

`Optional`recvSharesFrom

`Protected` `Optional`round1Output

`Protected` `Optional`round2Output

`Readonly`sigBatchSize

`Readonly`threshold

`Protected`finishR1

`Protected`finishRound1Func

`Protected`finishRound2Func

`Protected`getSharesForOtherFunc

`Protected`getSharesForOthersFunc

`Protected`processCommFunc

`Protected`processSharesFunc

`Protected`recvMsg1Func

`Protected`recvMsg2Func

`Protected`startRound1Func

`Protected`startRound2Func

`Static`aggregateShares