https://github.com/TangleID/TangleID

Secure self-sovereign identity built on IOTA/Tangle
https://github.com/TangleID/TangleID

biilabs decentralized-identifiers digital-assets identity iota tangle tangleid

Last synced: 2 months ago
JSON representation

Secure self-sovereign identity built on IOTA/Tangle

• Host: GitHub
• URL: https://github.com/TangleID/TangleID
• Owner: TangleID
• License: mit
• Created: 2017-11-22T15:52:42.000Z (about 7 years ago)
• Default Branch: develop
• Last Pushed: 2024-02-21T00:55:21.000Z (11 months ago)
• Last Synced: 2024-03-30T16:35:29.408Z (10 months ago)
• Topics: biilabs, decentralized-identifiers, digital-assets, identity, iota, tangle, tangleid
• Language: TypeScript
• Homepage: https://tangleid.github.io
• Size: 3.35 MB
• Stars: 143
• Watchers: 20
• Forks: 34
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-iota - TangleID - sovereign identity built on IOTA/Tangle (Developers / Non Official)

README

        
# TangleID Core

> TangleID JavaScript monorepo

[![Build Status](https://travis-ci.org/TangleID/TangleID.svg?branch=develop)](https://travis-ci.org/TangleID/TangleID)

![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg) [![lerna](https://img.shields.io/badge/maintained%20with-lerna-cc00ff.svg)](https://lernajs.io/)

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

- Registering and resolving [identifier](https://w3c-ccg.github.io/did-spec/)

- Signing JSON-LD document, e.g. [Verifiable Credentials](https://w3c.github.io/vc-data-model/)

- Verifying JSON-LD document signature

For more use cases, please visit the [TangleID website](https://tangleid.github.io/).

## Installing the library

To install the TangleID library and its dependencies, you can use one of the following options:

Install using [npm](https://www.npmjs.org/):

```shell

npm install @tangleid/core

```

or using [yarn](https://yarnpkg.com/):

```shell

yarn add @tangleid/core

```

## Getting started

To register/resolve the identifier, do the following:

```javascript

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](packages/core#api-reference).

## Developing

### Bootstrap your environments

1. Clone this repository.

```shell

$ git clone https://github.com/TangleID/TangleID

```

2. Install the dependency packages.

```shell

$ yarn run init

```

### Running tests

 ```shell

 $ yarn run test

 ```

### Build the packages

 ```shell

 $ yarn run build

 ```

### Updating documentation

 The documentation is generated from the [`JSDoc`](http://usejsdoc.org) 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.