# jolocom-sdk

> Jolocom Software Development Kit - Facilitating applications to manage and interact with digital identities.

Latest version **0.6.0** (published 2020-05-06) · 0 weekly downloads

## Install

```sh
npm install jolocom-sdk
pnpm add jolocom-sdk
yarn add jolocom-sdk
bun add jolocom-sdk
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2020-05-06 |
| First published | 2017-11-15 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 256.7 KB |
| Known vulnerabilities | 0 (+5 in 2 direct dependencies) |
| Install scripts | no |
| Maintainers | jolocom |

## Links

- npm: https://www.npmjs.com/package/jolocom-sdk
- npm.io page: https://npm.io/package/jolocom-sdk

## Dependencies (21)

- [wif](https://npm.io/package/wif.md) ^2.0.6
- [sjcl](https://npm.io/package/sjcl.md) ^1.0.7
- [bip39](https://npm.io/package/bip39.md) ^3.0.2
- [ramda](https://npm.io/package/ramda.md) ^0.26.1
- [redux](https://npm.io/package/redux.md) ^3.7.2
- [squel](https://npm.io/package/squel.md) ^5.12.1
- [unorm](https://npm.io/package/unorm.md) ^1.6.0
- [assert](https://npm.io/package/assert.md) ^2.0.0
- [events](https://npm.io/package/events.md) ^3.0.0
- [i18n-js](https://npm.io/package/i18n-js.md) ^3.1.0
- [sqlite3](https://npm.io/package/sqlite3.md) ^4.0.0
- [typeorm](https://npm.io/package/typeorm.md) ^0.2.5
- [form-data](https://npm.io/package/form-data.md) ^3.0.0
- [jolocom-lib](https://npm.io/package/jolocom-lib.md) ^4.1.0
- [redux-thunk](https://npm.io/package/redux-thunk.md) ^2.3.0
- [browser-ipfs](https://npm.io/package/browser-ipfs.md) ^0.0.6
- [vm-browserify](https://npm.io/package/vm-browserify.md) ^1.1.0
- [crypto-browserify](https://npm.io/package/crypto-browserify.md) ^3.12.0
- [ethereumjs-wallet](https://npm.io/package/ethereumjs-wallet.md) ^0.6.0
- [stream-browserify](https://npm.io/package/stream-browserify.md) ^2.0.2
- [cred-types-jolocom-core](https://npm.io/package/cred-types-jolocom-core.md) ^0.0.11

## Recent versions

- 0.6.0 (latest) — 2020-05-06
- 0.5.2 — 2020-04-27
- 0.5.1 — 2020-04-27
- 0.4.1 — 2020-04-21
- 0.4.0 — 2020-04-17
- 0.3.5 — 2020-04-15
- 0.3.4 — 2020-04-09
- 0.3.3 — 2020-04-02
- 0.3.2 — 2020-04-02
- 0.3.1 — 2020-04-02
- 0.3.0 — 2020-04-01
- 0.2.0 — 2020-04-01
- 0.1.0 — 2020-04-01
- 0.0.4 — 2017-11-16
- 0.0.3 — 2017-11-15
- … 2 more at https://npm.io/package/jolocom-sdk/versions

## README

Jolocom Software Development Kit - Facilitating applications to manage and
interact with digital identities.

Interested in our vision? Take a look at our [whitepaper](https://jolocom.io/wp-content/uploads/2018/07/Jolocom-Technical-WP-_-Self-Sovereign-and-Decentralised-Identity-By-Design-2018-03-09.pdf)

## Prerequisites

- Set-up requires [Node.js](https://nodejs.org/en/download/) to be installed on your computer.
  - `Node.js v10` is required to build the project.
- We use [Yarn](https://yarnpkg.com) as our package manager.

## Installation

### In another project

1. use `npm i jolocom-sdk` or `yarn add jolocom-sdk`
2. `import { JolocomSDK } from 'jolocom-sdk'`

An instance of an agent can be instantiated with crypto material in a variety of
ways:

- `JolocomSDK.fromMnemonic` BIP39 12 word seed phrase
- `JolocomSDK.fromStore` Connection to a database with seed material
- `JolocomSDK.newDIDFromSeed`Buffer of arbitrary seed entropy

NOTE: using the arbitrary input buffer registers a new identity on the Jolocom
DID Method

### Running a debug version for development

1. Clone the sdk repository to your computer.
2. `cd` into the directory and run `yarn` or `yarn install` from your terminal to install the required packages.

To run a repl, use `yarn repl`.

## Testing

We use Jest for unit tests, and [detox](https://github.com/wix/Detox) + Jest for end-to-end tests.

To run unit tests, with watch and testing coverage display enabled:

```bash
yarn test --watch --coverage
```

## Code Style and Formatting

- We use [ESLint](https://eslint.org/) and [Prettier](https://prettier.io/) to keep a consistent style across the codebase.
  - There are plugins available for a range of IDEs and text editors; automatic formatting on save is also supported in some editors.
- `yarn format` will format files automatically as much as possible.

Copyright (C) 2014-2020 JOLOCOM GmbH

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