# @transmute/transmute-did

> 🚧 Under Construction. Not for production use! 🚧

Latest version **1.1.8** (published 2019-02-03) · MIT license · 0 weekly downloads

## Install

```sh
npm install @transmute/transmute-did
pnpm add @transmute/transmute-did
yarn add @transmute/transmute-did
bun add @transmute/transmute-did
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.8 |
| Published | 2019-02-03 |
| First published | 2018-11-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 60.3 KB |
| Known vulnerabilities | 0 (+3 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 58 |
| Maintainers | gjgd, or13 |

## Links

- npm: https://www.npmjs.com/package/@transmute/transmute-did
- Repository: https://github.com/transmute-industries/transmute
- Homepage: https://github.com/transmute-industries/transmute#readme
- Issues: https://github.com/transmute-industries/transmute/issues
- npm.io page: https://npm.io/package/@transmute/transmute-did

## Dependencies (21)

- [tmp](https://npm.io/package/tmp.md) 0.0.33
- [bs58](https://npm.io/package/bs58.md) ^4.0.1
- [bip39](https://npm.io/package/bip39.md) ^2.5.0
- [hdkey](https://npm.io/package/hdkey.md) ^1.1.0
- [merge](https://npm.io/package/merge.md) >=1.2.1
- [jsonld](https://npm.io/package/jsonld.md) ^1.2.1
- [lodash](https://npm.io/package/lodash.md) ^4.17.11
- [moment](https://npm.io/package/moment.md) ^2.22.2
- [js-sha3](https://npm.io/package/js-sha3.md) ^0.8.0
- [openpgp](https://npm.io/package/openpgp.md) ^4.0.1
- [elliptic](https://npm.io/package/elliptic.md) ^6.4.1
- [fs-extra](https://npm.io/package/fs-extra.md) ^7.0.1
- [base64url](https://npm.io/package/base64url.md) ^3.0.0
- [jsonschema](https://npm.io/package/jsonschema.md) ^1.2.4
- [did-resolver](https://npm.io/package/did-resolver.md) 0.0.4
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) ^5.2.0
- [secrets.js-grempe](https://npm.io/package/secrets.js-grempe.md) ^1.1.0
- [libsodium-wrappers](https://npm.io/package/libsodium-wrappers.md) ^0.7.3
- [generate-rsa-keypair](https://npm.io/package/generate-rsa-keypair.md) ^0.1.2
- [json-stringify-deterministic](https://npm.io/package/json-stringify-deterministic.md) ^1.0.1
- [@transmute/transmute-adapter-memory](https://npm.io/package/@transmute/transmute-adapter-memory.md) ^1.0.0-alpha.2

## Recent versions

- 1.1.8 (latest) — 2019-02-03
- 1.1.7 — 2019-01-31
- 1.1.6 — 2019-01-31
- 1.1.5 — 2019-01-31
- 1.1.4 — 2019-01-28
- 1.1.3 — 2019-01-26
- 1.1.2 — 2019-01-26
- 1.1.1 — 2019-01-23
- 1.1.0 — 2019-01-23
- 1.0.2-0 — 2019-01-12
- 1.0.1-alpha.2 — 2018-12-11
- 1.0.1-alpha.1 — 2018-12-10
- 1.0.1-0 — 2018-11-26
- 1.0.0-alpha.3 — 2018-11-15
- 1.0.0-alpha.2 — 2018-11-15
- … 2 more at https://npm.io/package/@transmute/transmute-did/versions

## README

# Transmute DID

🚧 Under Construction. Not for production use! 🚧

<p align="center">
  <img src="../../transmute-banner.png"/>
</p>

> Decentralized Identifiers (DIDs) are a new type of identifier for verifiable, "self-sovereign" digital identity. DIDs are fully under the control of the DID subject, independent from any centralized registry, identity provider, or certificate authority. DIDs are URLs that relate a DID subject to means for trustable interactions with that subject. DIDs resolve to DID Documents — simple documents that describe how to use that specific DID. Each DID Document contains at least three things: cryptographic material, authentication suites, and service endpoints. Cryptographic material combined with authentication suites provide a set of mechanisms to authenticate as the DID subject (e.g., public keys, pseudonymous biometric protocols, etc.). Service endpoints enable trusted interactions with the DID subject.

#### [W3C DID Spec](https://w3c-ccg.github.io/did-spec/)
#### [W3C VC Data Model](https://www.w3.org/TR/verifiable-claims-data-model/)

### Getting Started

```
npm i
npm run test
```

### Documentation

This library uses self describing json-ld.

#### [Nested DID Spec](./docs/nested-did-spec.md)

## What it does

The `transmute-did` package contains several libraries for basic cryptographic operations

## `src/lib/ethereumExtensions/`: Ethereum

Creating an Ethereum identity

- Generate a BIP-39 Mnemonic
- Get a keypair from a mnemonic and a derivation path
- Get an Ethereum address from a public key

## `src/lib/openpgpExtensions/`: PGP

PGP uses RSA by default but also supports the following Elliptic Curves: `curve25519, p256, p384, p521, secp256k1, brainpoolP256r1, brainpoolP384r1, brainpoolP512r1`.

This library provides:

- generation of PGP keypairs from a name and a passphrase
- Signing a message with the sender's private key
- Verifying a message with the sender's public key
- Encrypting a message with the recipient's public key and signing it with the sender's private key
- Decrypting a message with the recipient's private key and verifying it with the sender's public key

## `src/lib/sodiumExtensions/`: Libsodium

LibSodium uses `ED25519` by default.

This library provides:

- a Signature scheme using libsodium's [crypto_sign](https://nacl.cr.yp.to/sign.html)
- a Public-key authenticated encryption scheme using libsodium's [crypto_box](https://nacl.cr.yp.to/box.html)

## `src/lib/shamirExtensions/`: Secret Sharing

This library provides

- Shamir secret sharing methods

## `src/lib/misc/`: Miscellaneous tools

This library provides

- Transmute DID document generation
- converting keypairs to a ciphertext wallet

---
_Source: https://npm.io/package/@transmute/transmute-did · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
