Interface: Multikey

Defined in: multikey/interface.ts:32

Interface for a 2.1.1 Multikey. Multikey

Properties

controller

readonly controller: string

Defined in: multikey/interface.ts:37

---

id

readonly id: string

Defined in: multikey/interface.ts:34

---

keys

readonly keys: SchnorrKeyPair

Defined in: multikey/interface.ts:40

---

publicKey

readonly publicKey: CompressedSecp256k1PublicKey

Defined in: multikey/interface.ts:43

---

secretKey?

readonly optional secretKey: Secp256k1SecretKey

Defined in: multikey/interface.ts:46

---

signer

readonly signer: boolean

Defined in: multikey/interface.ts:49

Methods

fromVerificationMethod()

fromVerificationMethod(verificationMethod): Multikey

Defined in: multikey/interface.ts:88

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

Defined in: multikey/interface.ts:71

Get the full id of the multikey

Returns

string

The full id of the multikey

---

json()

json(): MultikeyObject

Defined in: multikey/interface.ts:94

Convert the multikey to a JSON object.

Returns

MultikeyObject

The multikey as a JSON object.

---

sign()

sign(data, opts): Bytes

Defined in: multikey/interface.ts:57

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

Defined in: multikey/interface.ts:77

Convert the multikey to a verification method.

Returns

DidVerificationMethod

The verification method.

---

verify()

verify(signature, message, opts): boolean

Defined in: multikey/interface.ts:65

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.