# jolocom-lib

> Unified library for interacting with the Jolocom identity solution

Latest version **5.5.3** (published 2022-12-05) · MIT license · 0 weekly downloads

## Install

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

## Health

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

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.5.3 |
| Published | 2022-12-05 |
| First published | 2018-02-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 21 |
| Unpacked size | 227.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 24 |
| Author | Eugeniu Rusu |
| Maintainers | thomas_jolocom, clungu, exulansis, jolocom-dev, mnzaki |
| Keywords | Jolocom, Self-Sovereign Identity |

## Links

- npm: https://www.npmjs.com/package/jolocom-lib
- Repository: https://github.com/jolocom/jolocom-lib
- Homepage: https://github.com/jolocom/jolocom-lib#readme
- Issues: https://github.com/jolocom/jolocom-lib/issues
- npm.io page: https://npm.io/package/jolocom-lib

## Dependencies (21)

- [bip39](https://npm.io/package/bip39.md) ^3.0.2
- [hdkey](https://npm.io/package/hdkey.md) ^2.0.1
- [jsonld](https://npm.io/package/jsonld.md) ^1.6.1
- [rfc4648](https://npm.io/package/rfc4648.md) ^1.4.0
- [jsontokens](https://npm.io/package/jsontokens.md) ^1.0.0
- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1
- [create-hash](https://npm.io/package/create-hash.md) 1.2.0
- [@types/sinon](https://npm.io/package/@types/sinon.md) ^9.0.5
- [did-resolver](https://npm.io/package/did-resolver.md) 2.0.0
- [json-logic-js](https://npm.io/package/json-logic-js.md) ^2.0.0
- [ethereumjs-util](https://npm.io/package/ethereumjs-util.md) ^6.1.0
- [reflect-metadata](https://npm.io/package/reflect-metadata.md) ^0.1.13
- [class-transformer](https://npm.io/package/class-transformer.md) 0.3.1
- [secrets.js-grempe](https://npm.io/package/secrets.js-grempe.md) ^1.1.0
- [@jolocom/native-core](https://npm.io/package/@jolocom/native-core.md) ^1.0.0
- [@jolocom/protocol-ts](https://npm.io/package/@jolocom/protocol-ts.md) ^0.6.1
- [@jolocom/jolo-did-resolver](https://npm.io/package/@jolocom/jolo-did-resolver.md) ^1.0.0
- [@jolocom/jolo-did-registrar](https://npm.io/package/@jolocom/jolo-did-registrar.md) 1.0.2
- [@jolocom/vaulted-key-provider](https://npm.io/package/@jolocom/vaulted-key-provider.md) ^0.7.4
- [@hawkingnetwork/ed25519-hd-key-rn](https://npm.io/package/@hawkingnetwork/ed25519-hd-key-rn.md) ^1.0.1
- [@jolocom/local-resolver-registrar](https://npm.io/package/@jolocom/local-resolver-registrar.md) ^1.0.1

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 5.5.3 (latest) — 2022-12-05
- 5.3.0 (proof_chains) — 2022-02-09
- 5.2.0-rc0 (next) — 2021-01-27
- 5.0.28 (experimental) — 2020-08-25
- 5.5.1 — 2022-05-10
- 5.5.0 — 2022-05-10
- 5.4.0 — 2022-04-29
- 5.3.2 — 2022-03-09
- 5.3.1 — 2022-03-02
- 5.2.1 — 2021-06-30
- 5.2.0 — 2021-03-10
- 5.1.1 — 2021-01-15
- 5.1.0 — 2020-11-16
- 5.1.0-rc12 — 2020-11-07
- 5.1.0-rc11 — 2020-11-06
- … 168 more at https://npm.io/package/jolocom-lib/versions

## README

# jolocom-lib

Library for interacting with the self-sovereign identity solution provided by Jolocom.

Interested in our vision? Take a look at our [whitepaper](http://jolocom.io/wp-content/uploads/2018/07/Jolocom-Technical-WP-_-Self-Sovereign-and-Decentralised-Identity-By-Design-2018-03-09.pdf) (it is currently outdated, and we are working on updating it).

Want to use our library? Please refer to the following resources:

- [Library documentation](https://jolocom-lib.readthedocs.io/en/latest/gettingStarted.html)
- [Automatically generated api documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/jolocom/jolocom-lib/master/api_docs/documentation/globals.html)
- [Generic backend](https://github.com/jolocom/generic-backend) - exposes a set of HTTP endpoints for client applications to interact with.
- [Demo service frontend](https://gitlab.com/jolocom/municipal-service) - to interact with the generic backend.
  - Instructions can be found in the repository README, more about the project as a whole can be found [here](https://stories.jolocom.com/demo-services-using-ssi-building-blocks-now-available-607e2ccd506d).
- Various Useful snippets: [Here](https://github.com/Exulansis/web3_snippets), and [here](https://github.com/Exulansis/Validation-Examples)

Integration and unit tests located in the ``./tests`` folder are a good place to start too.

[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/jolocom/SmartWallet)
[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

## Requirements

Starting with version `2.3.0`, the Jolocom Library requires `Node.js v10` or `Node.js v11` to run. Versions prior to `2.3.0` require `Node.js v8`.

## Linting and Formatting

We use [ESLint](https://eslint.org/) for static TypeScript code analysis.  
We use [Prettier](https://prettier.io/) for auto formatting of our code, but this is configured to run as part of ESLint.  
To display real-time linting errors, an ESLint plugin must be installed in your IDE or text editor.  
On VSCode, it is possible to allow ESLint to format upon saving of files, which will run Prettier under the options within this project.  

Additionally, we have included a script in package.json to allow use of ESlint/Prettier from the CLI:

- `yarn format` will auto-fix as many problems as it can in the project in files with the extension `.ts`, and log unfixed errors to the console.

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