Skip to content
DID Method implementation using the Sidetree protocol on top of Ethereum and IPFS
JavaScript TypeScript HTML Other
Branch: development
Clone or download
Latest commit 2e516ea Aug 15, 2019

README.md

element

Build Status codecov

🔥 Experimental Sidetree Protocol based DID Method elem with Ethereum and IPFS

See our blog post

Click below image for demo video.

Element Testnet Demo

This is a lerna mono repo, see packages for all modules.

See also ion, sidetree, sidetree-ethereum.

Getting Started

If you're using EC2

We recommend using

  • Ubuntu Server 18.04 LTS
  • a t2.small instance or equivalent (1 vCPU, 2GB of RAM and 8 GB of Disk)

To setup, run the following commands:

# Update packaging tool
sudo apt update
# Install nvm
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash
. ~/.nvm/nvm.sh
# Install node
nvm install v10.16.0
# Install other required dependencies
sudo apt install python build-essential jq

Clone the repo:

git clone git@github.com:decentralized-identity/element.git
cd element

Install:

npm i

Run smart contract tests:

npm run test:contracts

Run lib, api and app tests:

npm run test

Lint

npm run lint

Coverage

npm run coverage

Publishing

If you have 2fa enabled for npm (and you should!).

NPM_CONFIG_OTP=123456 lerna publish

Testing Documentation

npm i -g http-server
serve ./docs

See .travis.yml for setup and test commands for linux.

You can’t perform that action at this time.