Skip to content
develop
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

TangleID Core

TangleID JavaScript monorepo

Build Status GitHub license lerna

This is the TangleID JavaScript library, which allows you to do the following:

For more use cases, please visit the TangleID website.

Installing the library

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

Getting started

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.

Developing

Bootstrap your environments

  1. Clone this repository.
$ git clone https://github.com/TangleID/TangleID
  1. Install the dependency packages.
$ yarn run init

Running tests

$ yarn run test

Build the packages

$ yarn run build

Updating documentation

The documentation is generated from the JSDoc annotations. To update the documentation running yarn run docs from the root directory.

Licensing

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.