Code Monkey home page Code Monkey logo

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.

TangleID's Projects

tangleid icon tangleid

Secure self-sovereign identity built on IOTA/Tangle

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.