ipfs-did-document v1.2.3

js-ipfs-did-document

This is a module for creating ipfs based DID Documents. The CID of the first document created will become the identifier of the DID. Any subsequent updates to a DID document will link back to the previous document CID. In order to create a complete DID Method this module needs to be paired with a revocation module that handles revocation and rotation of keys.

Install

Using npm:

$ npm install ipfs-did-document

API

DidDocument

A class for creating ipfs based DID Documents. Based on the DID spec: https://w3c-ccg.github.io/did-spec/

Kind: global class

• DidDocument
  • new DidDocument(ipfs, method)
  • instance
    • .addPublicKey(id, type, encoding, key, owner)
    • .removePublicKey(id)
    • .addAuthentication(type, id)
    • .removeAuthentication(id)
    • .addService(id, type, serviceEndpoint, additionalFields)
    • .removeService(id)
    • .setRevocationMethod(methodDescriptor)
    • .addCustomProperty(propName, propValue)
    • .removeCustomProperty(propName)
    • .commit() ⇒ Promise.<CID>
  • static
    • .load(ipfs, documentCid) ⇒ Promise.<DidDocument>
    • .cidToDocument(ipfs, documentCid) ⇒ Promise.<Object>

new DidDocument(ipfs, method)

Create a new DID Document.

didDocument.addPublicKey(id, type, encoding, key, owner)

Add a new public key

Kind: instance method of DidDocument

didDocument.removePublicKey(id)

Remove a public key

Kind: instance method of DidDocument

didDocument.addAuthentication(type, id)

Add a new authentication

Kind: instance method of DidDocument

didDocument.removeAuthentication(id)

Remove an authentication

Kind: instance method of DidDocument

didDocument.addService(id, type, serviceEndpoint, additionalFields)

Add a new service

Kind: instance method of DidDocument

didDocument.removeService(id)

Remove a service

Kind: instance method of DidDocument

didDocument.setRevocationMethod(methodDescriptor)

Set the revocationMethod. This can be of any js object and is determined by the implementer of a revocation module.

Kind: instance method of DidDocument

didDocument.addCustomProperty(propName, propValue)

Add a new property

Kind: instance method of DidDocument

didDocument.removeCustomProperty(propName)

Remove a property

Kind: instance method of DidDocument

didDocument.commit() ⇒ Promise.<CID>

Commit all changes and create a new ipfs dag object.

Kind: instance method of DidDocument
Returns: Promise.<CID> - The CID of the object

DidDocument.load(ipfs, documentCid) ⇒ Promise.<DidDocument>

Load an already existing DID Document.

Kind: static method of DidDocument
Returns: Promise.<DidDocument> - self

DidDocument.cidToDocument(ipfs, documentCid) ⇒ Promise.<Object>

Returns the DID document of a document CID

Kind: static method of DidDocument
Returns: Promise.<Object> - The DID document as a js object