Class Multikey

constructor

• new Multikey(params: MultikeyParams): Multikey

  Creates an instance of Multikey.

  Parameters

  • params: MultikeyParams

    The parameters to create the multikey

    • controller: string

    • id: string

    • OptionalkeyPair?: KeyPair

  Returns Multikey

  Throws

  if neither a publicKey nor a privateKey is provided

Readonlycontroller

Readonlyid

Static Readonlytype

isSigner

• get isSigner(): boolean

  Returns boolean

  See

  IMultikey.isSigner

keyPair

• get keyPair(): KeyPair

  Returns KeyPair

  See

  IMultikey.keyPair

privateKey

• get privateKey(): PrivateKey

  Returns PrivateKey

  See

  IMultikey.privateKey

publicKey

• get publicKey(): PublicKey

  Returns PublicKey

  See

  IMultikey.publicKey

fromVerificationMethod

• fromVerificationMethod(vm: DidVerificationMethod): Multikey

  Parameters

  • vm: DidVerificationMethod

  Returns Multikey

  See

  IMultikey.fromVerificationMethod

fullId

• fullId(): string

  Returns string

  See

  IMultikey.fullId

json

• json(): MultikeyJSON

  Returns MultikeyJSON

  See

  IMultikey.json

sign

• sign(data: Hex): Bytes

  Parameters

  • data: Hex

  Returns Bytes

  See

  IMultikey.sign

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

  Returns DidVerificationMethod

  See

  IMultikey.toVerificationMethod

verify

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

  Parameters

  • signature: Bytes
  • data: Hex

  Returns boolean

  See

  IMultikey.verify

Staticinitialize

• initialize(params: MultikeyParams): Multikey

  Static convenience method to create a new Multikey instance.

  Parameters

  • params: MultikeyParams

    The parameters to create the multikey

    • controller: string

    • id: string

    • OptionalkeyPair?: KeyPair

  Returns Multikey

  A new Multikey instance

  Throws

  if neither a publicKey nor a privateKey is provided