Skip to main content

Class: DidMethod

Hierarchy

  • BaseMethod

    DidMethod

Implements

  • DidMethod

Constructors

constructor

new DidMethod(stores, events)

Parameters

NameType
storesNamedRegistry
eventsNamedRegistry

Inherited from

BaseMethod.constructor

Defined in

node_modules/klayr-framework/dist-node/modules/base_method.d.ts:5

Properties

config

config: DidModuleConfig

Defined in

packages/klayr-did-module/src/method.ts:33


events

Protected events: NamedRegistry

Inherited from

BaseMethod.events

Defined in

node_modules/klayr-framework/dist-node/modules/base_method.d.ts:4


stores

Protected stores: NamedRegistry

Inherited from

BaseMethod.stores

Defined in

node_modules/klayr-framework/dist-node/modules/base_method.d.ts:3

Methods

addControllers

addControllers(methodContext, senderPublicKey, target, controllers, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
controllersstring[]
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.addControllers

Defined in

packages/klayr-did-module/src/method.ts:153


addKeys

addKeys(methodContext, senderPublicKey, target, keys, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
keysKeysCommand[]
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.addKeys

Defined in

packages/klayr-did-module/src/method.ts:87


addServiceEndpoint

addServiceEndpoint(methodContext, senderPublicKey, target, endpoint, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
endpointObject
endpoint.idstring
endpoint.serviceEndpointstring
endpoint.typestring
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.addServiceEndpoint

Defined in

packages/klayr-did-module/src/method.ts:219


authorize

authorize(methodContext, did, factors): Promise<AuthorizationResult[]>

Parameters

NameType
methodContextMethodContext
didstring
factorsAuthorizationFactors

Returns

Promise<AuthorizationResult[]>

Implementation of

DidMethodInterface.authorize

Defined in

packages/klayr-did-module/src/method.ts:62


create

create(methodContext, senderPublicKey, did, controllers, keys): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
didstring
controllersstring[]
keysKeysCommand[]

Returns

Promise<void>

Implementation of

DidMethodInterface.create

Defined in

packages/klayr-did-module/src/method.ts:71


deactivate

deactivate(methodContext, senderPublicKey, target, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.deactivate

Defined in

packages/klayr-did-module/src/method.ts:285


getConfig

getConfig(): DidModuleConfig

Returns

DidModuleConfig

Implementation of

DidMethodInterface.getConfig

Defined in

packages/klayr-did-module/src/method.ts:40


getNonce

getNonce(methodContext, did): Promise<{ nonce: string }>

Parameters

NameType
methodContextMethodContext
didstring

Returns

Promise<{ nonce: string }>

Implementation of

DidMethodInterface.getNonce

Defined in

packages/klayr-did-module/src/method.ts:49


incrementNonce

incrementNonce(methodContext, did): Promise<void>

Parameters

NameType
methodContextMethodContext
didstring

Returns

Promise<void>

Implementation of

DidMethodInterface.incrementNonce

Defined in

packages/klayr-did-module/src/method.ts:55


init

init(config): void

Parameters

NameType
configDidModuleConfig

Returns

void

Implementation of

DidMethodInterface.init

Defined in

packages/klayr-did-module/src/method.ts:35


read

read(methodContext, did): Promise<DidDocument>

Parameters

NameType
methodContextMethodContext
didstring

Returns

Promise<DidDocument>

Implementation of

DidMethodInterface.read

Defined in

packages/klayr-did-module/src/method.ts:44


removeControllers

removeControllers(methodContext, senderPublicKey, target, controllers, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
controllersstring[]
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.removeControllers

Defined in

packages/klayr-did-module/src/method.ts:186


removeKeys

removeKeys(methodContext, senderPublicKey, target, publicKeys, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
publicKeysBuffer[]
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.removeKeys

Defined in

packages/klayr-did-module/src/method.ts:120


removeServiceEndpoint

removeServiceEndpoint(methodContext, senderPublicKey, target, endpointId, signer, signature?): Promise<void>

Parameters

NameType
methodContextMethodContext
senderPublicKeyBuffer
targetstring
endpointIdstring
signerstring
signature?Buffer

Returns

Promise<void>

Implementation of

DidMethodInterface.removeServiceEndpoint

Defined in

packages/klayr-did-module/src/method.ts:252