@digitalcredentials/did-context

DID Context (did-context)

A DID (Decentralized Identifier) context library for JavaScript

This project packages the DID Context from the DID specification for use with Node.js and web apps.

Table of Contents

• Security
• Background
• Install
• Usage
• Contribute
• Commercial Support
• License

Security

TBD

Background

See also (related specs):

• Decentralized Identifiers (DIDs) - Data Model and Syntaxes
• Decentralized Identifier Resolution

Install

Requires Node.js 8.3+

To install via NPM:

npm install did-context

Usage

const didContext = require('did-context');

// use URL in a JSON-LD context
const obj = {
  "@context": [
    didContext.constants.DID_CONTEXT_URL,
    // ...
  ],
  // ...
};

// get context data for a specific context
const data = didContext.contexts.get('https://www.w3.org/ns/did/v1');
// ...

This package can be used with bundlers, such as webpack, in browser applications.

API

The library exports two properties:

• constants: A Object that maps constants to well-known context URLs. The main constant DID_CONTEXT_URL may be updated from time to time to the latest context location.
• contexts: A Map that maps URLs to full context data.

Contribute

Code and packaging development is at the did-context project. The contexts themselves are developed in the did-spec project.

Contexts in this package are updated manually from the did-spec contexts. Please file an issue if this package is not synced with did-spec changes in a timely manner.

Small note: If editing the Readme, please conform to the standard-readme specification.

Commercial Support

Commercial support for this library is available upon request from Digital Bazaar: [e-mail]

License

• Code: BSD 3-Clause © Digital Bazaar
• Contexts: W3C Software and Document License
• See the LICENSE file for details.