Class SchnorrMultikey

constructor

• new SchnorrMultikey(params: MultikeyParams): SchnorrMultikey

  Creates an instance of SchnorrMultikey.

  Parameters

  • params: MultikeyParams

    The parameters to create the multikey

    • controller: string

    • id: string

    • Optionalkeys?: SchnorrKeyPair

  Returns SchnorrMultikey

  Throws

  if neither a publicKey nor a privateKey is provided

Readonlycontroller

Readonlyid

Static Readonlytype

keys

• get keys(): SchnorrKeyPair

  Returns SchnorrKeyPair

publicKey

• get publicKey(): PublicKey

  Returns PublicKey

secretKey

• get secretKey(): SecretKey

  Returns SecretKey

signer

• get signer(): boolean

  Returns boolean

fromVerificationMethod

• fromVerificationMethod(verificationMethod: DidVerificationMethod): Multikey

  Convert a verification method to a multikey.

  Parameters

  • verificationMethod: DidVerificationMethod

    The verification method to convert.

  Returns Multikey

  Multikey instance.

  Throws

  if the verification method is missing required fields. if the verification method has an invalid type. if the publicKeyMultibase has an invalid prefix.

fullId

• fullId(): string

  Get the full id of the multikey

  Returns string

  The full id of the multikey

json

• json(): MultikeyObject

  Convert the multikey to a JSON object.

  Returns MultikeyObject

  The multikey as a JSON object.

sign

• sign(data: Hex, opts?: CryptoOptions): Bytes

  Produce a schnorr signature over arbitrary data.

  Parameters

  • data: Hex

    Data to be signed.
  • Optionalopts: CryptoOptions

  Returns Bytes

  Signature byte array.

  Throws

  if no private key is provided.

toCryptosuite

• toCryptosuite(cryptosuite?: "bip340-jcs-2025" | "bip340-rdfc-2025"): Cryptosuite

  Constructs an instance of Cryptosuite from the current Multikey instance.

  Parameters

  • Optionalcryptosuite: "bip340-jcs-2025" | "bip340-rdfc-2025" = 'bip340-jcs-2025'

  Returns Cryptosuite

toVerificationMethod

• toVerificationMethod(): DidVerificationMethod

  Convert the multikey to a verification method.

  Returns DidVerificationMethod

  The verification method.

verify

• verify(signature: Bytes, data: Hex, opts?: CryptoOptions): boolean

  Verify a schnorr signature.

  Parameters

  • signature: Bytes

    Signature for verification.
  • data: Hex

    Data for verification.
  • Optionalopts: CryptoOptions

  Returns boolean

  If the signature is valid against the public key.

verifyEcdsa

• verifyEcdsa(signature: Bytes, data: Hex): boolean

  Verify an ecdsa signature.

  Parameters

  • signature: Bytes

    Signature for verification.
  • data: Hex

    Data for verification.

  Returns boolean

  If the signature is valid against the public key.

StaticfromPrivateKey

• fromPrivateKey(params: FromSecretKey): SchnorrMultikey

  Creates a Multikey instance from a private key

  Parameters

  • params: FromSecretKey

    The parameters to create the multikey

    • controller: string

    • entropy: Bytes

    • id: string

  Returns SchnorrMultikey

  The new multikey instance

StaticfromPublicKey

• fromPublicKey(params: FromPublicKey): Multikey

  Creates a Multikey instance from a public key

  Parameters

  • params: FromPublicKey

    The parameters to create the multikey

    • controller: string

    • id: string

    • publicKeyBytes: Bytes

  Returns Multikey

  The new multikey instance

StaticfromPublicKeyMultibase

• fromPublicKeyMultibase(params: FromPublicKeyMultibaseParams): SchnorrMultikey

  Creates a Multikey instance from a public key multibase.

  Parameters

  • params: FromPublicKeyMultibaseParams

    See FromPublicKeyMultibaseParams for details.

    • controller: string

    • id: string

    • publicKeyMultibase: string

  Returns SchnorrMultikey

  The new multikey instance.

Staticinitialize

• initialize(params: MultikeyParams): SchnorrMultikey

  Static convenience method to create a new Multikey instance.

  Parameters

  • params: MultikeyParams

    The parameters to create the multikey

    • controller: string

    • id: string

    • Optionalkeys?: SchnorrKeyPair

  Returns SchnorrMultikey

  A new Multikey instance

  Throws

  if neither a publicKey nor a privateKey is provided