Castor
@hyperledger/identus-sdk v8.1.3
@hyperledger/identus-sdk / overview / Domain / Castor
Interface: Castor
Defined in: packages/shared/domain/build/index.d.ts:2404
Building block for creating, resolving, and managing Decentralized Identifiers across multiple DID methods.
The concrete SDK implementation (@hyperledger/identus-sdk!Castor)
narrows these signatures by inferring the payload and metadata types
directly from the DID method instances registered on that Castor, so
createDID, publishDID, etc. are fully typed per method.
Methods
createDID()
createDID(
method:string,opts:unknown):Promise<DID>
Defined in: packages/shared/domain/build/index.d.ts:2405
Parameters
| Parameter | Type |
|---|---|
method | string |
opts | unknown |
Returns
Promise<DID>
deactivateDID()
deactivateDID(
method:string,opts:unknown):Promise<unknown>
Defined in: packages/shared/domain/build/index.d.ts:2408
Parameters
| Parameter | Type |
|---|---|
method | string |
opts | unknown |
Returns
Promise<unknown>
publishDID()
publishDID(
method:string,opts:unknown):Promise<unknown>
Defined in: packages/shared/domain/build/index.d.ts:2406
Parameters
| Parameter | Type |
|---|---|
method | string |
opts | unknown |
Returns
Promise<unknown>
resolveDID()
resolveDID(
did:string|DID):Promise<DIDDocument>
Defined in: packages/shared/domain/build/index.d.ts:2415
Resolve a DID to its DID Document.
Parameters
| Parameter | Type | Description |
|---|---|---|
did | string | DID | a DID instance or DID string |
Returns
Promise<DIDDocument>
the resolved DIDDocument
updateDID()
updateDID(
method:string,opts:unknown):Promise<unknown>
Defined in: packages/shared/domain/build/index.d.ts:2407
Parameters
| Parameter | Type |
|---|---|
method | string |
opts | unknown |
Returns
Promise<unknown>
verifySignature()
verifySignature(
did:DID,challenge:Uint8Array,signature:Uint8Array):Promise<boolean>
Defined in: packages/shared/domain/build/index.d.ts:2424
Verify a cryptographic signature against a DID's verification methods.
Parameters
| Parameter | Type | Description |
|---|---|---|
did | DID | the signer's DID |
challenge | Uint8Array | the original data that was signed |
signature | Uint8Array | the signature bytes to verify |
Returns
Promise<boolean>
true if any verification method on the DID validates the signature