TangleID JavaScript monorepo
This is the TangleID JavaScript library, which allows you to do the following:
- Registering and resolving identifier
- Signing JSON-LD document, e.g. Verifiable Credentials
- Verifying JSON-LD document signature
For more use cases, please visit the TangleID website.
To install the TangleID library and its dependencies, you can use one of the following options:
Install using npm:
npm install @tangleid/core
or using yarn:
yarn add @tangleid/core
To register/resolve the identifier, do the following:
import { composeAPI } from '@tangleid/core';
const tid = composeAPI({
provider: 'https://tangle.puyuma.org',
});
const { seed, did, document } = await tid.registerIdentifier({
publicKey,
});
const resolved = await tid.resolveIdentifier(did);
The API Reference can be found in here.
- Clone this repository.
$ git clone https://github.com/TangleID/TangleID
- Install the dependency packages.
$ yarn run init
$ yarn run test
$ yarn run build
The documentation is generated from the JSDoc
annotations. To update the documentation running yarn run docs
from the root directory.
TangleID is freely redistributable under the MIT License. Use of this source
code is governed by a MIT-style license that can be found in the LICENSE
file.