Class PublicKeyPackage<C>

constructor

• new PublicKeyPackage<C extends Ciphersuite>(
      ciphersuite: C,
      verifyingShares: Map<string, VerifyingShare<C>>,
      verifyingKey: C["Element"],
      minSigners?: number,
  ): PublicKeyPackage<C>

  Create a new PublicKeyPackage instance.

  Type Parameters

  • C extends Ciphersuite

  Parameters

  • ciphersuite: C

    The ciphersuite to use

  • verifyingShares: Map<string, VerifyingShare<C>>

    Map of identifier string to verifying share

  • verifyingKey: C["Element"]

    The group verifying key element

  • OptionalminSigners: number

    Minimum number of signers (threshold)

  Returns PublicKeyPackage<C>

ReadonlyverifyingShares

ReadonlyverifyingKey

ReadonlyminSigners

StaticfromCommitment

• fromCommitment<C extends Ciphersuite>(
      ciphersuite: C,
      identifiers: Set<string>,
      commitment: VerifiableSecretSharingCommitment<C>,
  ): Promise<PublicKeyPackage<C>>

  Computes the public key package given a list of participant identifiers and a VerifiableSecretSharingCommitment. This is useful in scenarios where the commitments are published somewhere and it's desirable to recreate the public key package from them.

  Type Parameters

  • C extends Ciphersuite

  Parameters

  • ciphersuite: C

    The ciphersuite to use

  • identifiers: Set<string>

    Set of participant identifier strings

  • commitment: VerifiableSecretSharingCommitment<C>

    The VSS commitment

  Returns Promise<PublicKeyPackage<C>>

  The computed PublicKeyPackage

  Throws

  If computation fails

StaticfromDkgCommitments

• fromDkgCommitments<C extends Ciphersuite>(
      ciphersuite: C,
      commitments: Map<string, VerifiableSecretSharingCommitment<C>>,
  ): Promise<PublicKeyPackage<C>>

  Computes the public key package given a map of participant identifiers and their VerifiableSecretSharingCommitment from a distributed key generation process.

  Type Parameters

  • C extends Ciphersuite

  Parameters

  • ciphersuite: C

    The ciphersuite to use

  • commitments: Map<string, VerifiableSecretSharingCommitment<C>>

    Map of identifier string to VSS commitment

  Returns Promise<PublicKeyPackage<C>>

  The computed PublicKeyPackage

  Throws

  If computation fails

maxSigners

• maxSigners(): number

  Return the maximum number of signers.

  Returns number

  The maximum number of signers

equals

• equals(other: PublicKeyPackage<C>): boolean

  Check equality with another PublicKeyPackage.

  Parameters

  • other: PublicKeyPackage<C>

    The other PublicKeyPackage

  Returns boolean

  True if equal

clone

• clone(): PublicKeyPackage<C>

  Clone this PublicKeyPackage.

  Returns PublicKeyPackage<C>

  A new PublicKeyPackage with the same values

toString

• toString(): string

  Convert to string representation.

  Returns string

  Debug string