PeerDIDMethod
@hyperledger/identus-sdk v8.0.0
@hyperledger/identus-sdk / overview / PeerDIDMethod
Class: PeerDIDMethod
Defined in: packages/lib/sdk/src/castor/methods/peer/index.ts:41
DID method implementation for did:peer (algorithm 2).
Creates peer DIDs from authentication and key-agreement keys and verifies signatures by resolving the DID Document locally.
Example
const peer = new PeerDIDMethod();
const did = await peer.create({
keys: {
AUTHENTICATION_KEY: [authSK],
KEY_AGREEMENT_KEY: [agreementSK],
},
services: [service],
});
Implements
DIDMethod<never,CreatePayload>
Constructors
Constructor
new PeerDIDMethod():
PeerDIDMethod
Returns
PeerDIDMethod
Properties
| Property | Type | Defined in |
|---|---|---|
method | "peer" | packages/lib/sdk/src/castor/methods/peer/index.ts:42 |
resolver | PeerDIDResolver | packages/lib/sdk/src/castor/methods/peer/index.ts:43 |
Methods
create()
create(
opts:CreatePayload):Promise<DID>
Defined in: packages/lib/sdk/src/castor/methods/peer/index.ts:52
Create a new did:peer:2 DID from the provided keys and services.
Parameters
| Parameter | Type | Description |
|---|---|---|
opts | CreatePayload | creation options containing keys and optional services |
Returns
Promise<DID>
the newly created peer DID
Throws
if required keys are missing
Implementation of
DIDMethod.create
verifySignature()
verifySignature(
did:DID,challenge:Uint8Array,signature:Uint8Array):Promise<boolean>
Defined in: packages/lib/sdk/src/castor/methods/peer/index.ts:71
Verify a signature against a Peer DID's Ed25519 verification methods.
Resolves the DID Document and tries each Ed25519 verification method
until one validates the signature, or returns false.
Parameters
| Parameter | Type |
|---|---|
did | DID |
challenge | Uint8Array |
signature | Uint8Array |
Returns
Promise<boolean>
Implementation of
DIDMethod.verifySignature