2.0.0 • Published 2 years ago

@verixyz/did-manager v2.0.0

Weekly downloads
-
License
Apache-2.0
Repository
github
Last release
2 years ago

verixyz DID Manager

The DID controller abstraction plugin for verixyz.

This plugin combines multiple DID method controllers and provides the abstracted functionality to other plugins.

Classes

AbstractDIDStore

An abstract class for the DIDManager identifier store

Methods

  • delete(args)
  • get(args)
  • import(args)
  • list(args)

AbstractIdentifierProvider

An abstract class for the DIDManager identifier providers

Methods

  • addKey(args, context)
  • addService(args, context)
  • createIdentifier(args, context)
  • deleteIdentifier(args, context)
  • removeKey(args, context)
  • removeService(args, context)

AliasDiscoveryProvider

Properties

  • name:(not declared)

Methods

  • discoverDid(args, context)

DIDManager

Agent plugin that implements IDIDManager interface

Constructors

  • (constructor)(options) Constructs a new instance of the DIDManager class

Properties

  • methods: IDIDManager Plugin methods
  • schema: any

Methods

  • didManagerAddKey({ did, key, options }, context) Adds a key to a DID Document
  • didManagerAddService({ did, service, options }, context) Adds a service to a DID Document
  • didManagerCreate(args, context) Creates and returns a new identifier
  • didManagerDelete({ did }, context) Deletes identifier
  • didManagerFind(args) Returns a list of managed identifiers
  • didManagerGet({ did }) Returns a specific identifier
  • didManagerGetByAlias({ alias, provider }) Returns a specific identifier by alias
  • didManagerGetOrCreate({ provider, alias, kms, options }, context) Returns an existing identifier or creates a new one for a specific alias
  • didManagerGetProviders() Returns a list of available identifier providers
  • didManagerImport(identifier, context) Imports identifier
  • didManagerRemoveKey({ did, kid, options }, context) Removes a key from a DID Document
  • didManagerRemoveService({ did, id, options }, context) Removes a service from a DID Document
  • didManagerSetAlias({ did, alias }, context) Sets identifier alias

MemoryDIDStore

Methods

  • delete({ did })
  • get({ did, alias, provider, })
  • import(args)
  • list(args)