Interface Multikey

Readonlycontroller

Readonlyid

Readonlykeys

ReadonlypublicKey

Optional ReadonlysecretKey

Readonlysigner

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: Bytes, opts: { scheme: "ecdsa" | "schnorr" }): Bytes

  Produce signed data with a secret key.

  Parameters

  • data: Bytes

    Data to be signed.
  • opts: { scheme: "ecdsa" | "schnorr" }

  Returns Bytes

  Signature byte array.

  Throws

  if no secret key is provided.

toVerificationMethod

• toVerificationMethod(): DidVerificationMethod

  Convert the multikey to a verification method.

  Returns DidVerificationMethod

  The verification method.

verify

• verify(
      signature: Bytes,
      message: string,
      opts: { scheme: "ecdsa" | "schnorr" },
  ): boolean

  Verify a schnorr signature.

  Parameters

  • signature: Bytes

    Signature for verification.
  • message: string

    Data for verification.
  • opts: { scheme: "ecdsa" | "schnorr" }

  Returns boolean

  If the signature is valid against the public key.