@idworks/jolocom-lib

jolocom-lib

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

Interested in our vision? Take a look at our whitepaper (it is currently outdated, and we are working on updating it).

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

• Library documentation
• Automatically generated api documentation
• Generic backend - exposes a set of HTTP endpoints for client applications to interact with.
• Demo service frontend - 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.
• Various Useful snippets: Here, and here

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

Requirements

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

Linting and Formatting

We use ESLint for static TypeScript code analysis.
We use Prettier 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.