Skip to content

Latest commit

 

History

History
105 lines (77 loc) · 5.31 KB

local-dev.md

File metadata and controls

105 lines (77 loc) · 5.31 KB
Raw

Development Install

This guide will describe how to install and run Element locally on a Linux machine running Ubuntu 20.04.3 on either an x86_64 machine, or Raspberry Pi 4. This guide will use the example name of ubuntu (with lower-case u) to describe the user and default home directory of /home/ubuntu with sudo privileges.

Table of Contents

  • Install Dependencies
  • Clone and Build the Repository
  • Start Required Services
  • Run Create / Resolve Operation

Install Dependencies

Install IPFS

$ sudo snap install ipfs
$ ipfs init

Install MongoDB

$ wget -qO - https://www.mongodb.org/static/pgp/server-4.4.asc | sudo apt-key add -
$ echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu focal/mongodb-org/4.4 multiverse" | sudo tee /etc/apt/sources.list.d/mongodb-org-4.4.list
$ sudo apt-get update
$ sudo apt-get install -y mongodb-org
$ sudo systemctl daemon-reload
$ sudo systemctl enable mongod.service
$ sudo systemctl start mongod.service

Install Nodejs (v14)

$ sudo apt install -y python-is-python3 make gcc g++
$ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.0/install.sh | bash
$ source ~/.bashrc
$ nvm install 14
$ nvm use 14

Install Ganache Cli

$ npm install ganache-cli -g

Start Required Services

MongoDB should be running in the background as a daemon service. In order to run the element dashboard, we will need ipfs and ganache-cli running in the background.

We can do this by running ipfs and galache-cli in the background using a detached screen, executing the following commands.

$ screen -dm bash -c "ganache-cli"
$ screen -dm bash -c "ipfs daemon"

Clone and Build Repository

$ git clone https://github.com/transmute-industries/sidetree.js.git
$ cd sidetree.js/packages/dashboard
$ npm i
$ cp .env.ganache.example .env.ganache
$ npm run dev:ganache

Run Example API

Once Element is running you can access the UI via http://localhost:3000. You can create a wallet, create a did, and resolve a did from the dashboard.

To test your installation with example did, we can run the following curl commands.

Create Request

curl --header "Content-Type: application/json" --request POST --data '{"type":"create","suffixData":{"deltaHash":"EiCP8MJ9oX2jmTxVi6xa1WoGmzkg8HaxmWWiR6R34cUmvw","recoveryCommitment":"EiCFei9R_74JeKbxGIZPI4XXwbb0eDpBeweA9IpymBEOFA"},"delta":{"updateCommitment":"EiDDJ-s9CPjkh6yaH5apLIKZ1G87K0phukB3Fofy2ujeAg","patches":[{"action":"replace","document":{"publicKeys":[{"id":"signingKey","type":"EcdsaSecp256k1VerificationKey2019","publicKeyJwk":{"kty":"EC","crv":"secp256k1","x":"8a7JVJUDcR_mS6gyTAgdvGFZkhO8plwWfId3xqHa7xA","y":"xIxXstl9XR-hXXBkrhzxrFhJRvab2MLhQDus92S8G2o"},"purposes":["authentication","assertionMethod","capabilityInvocation","capabilityDelegation","keyAgreement"]}],"services":[{"id":"serviceId123","type":"someType","serviceEndpoint":"https://www.url.com"}]}}]}}' http://localhost:3000/api/1.0/operations

Create Response

{"@context":"https://w3id.org/did-resolution/v1","didDocument":{"@context":["https://www.w3.org/ns/did/v1","https://w3id.org/security/suites/jws-2020/v1",{"@vocab":"https://www.w3.org/ns/did#"}],"id":"did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg","verificationMethod":[{"id":"#signingKey","controller":"did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg","type":"EcdsaSecp256k1VerificationKey2019","publicKeyJwk":{"kty":"EC","crv":"secp256k1","x":"8a7JVJUDcR_mS6gyTAgdvGFZkhO8plwWfId3xqHa7xA","y":"xIxXstl9XR-hXXBkrhzxrFhJRvab2MLhQDus92S8G2o"}}],"authentication":["#signingKey"],"assertionMethod":["#signingKey"],"capabilityInvocation":["#signingKey"],"capabilityDelegation":["#signingKey"],"keyAgreement":["#signingKey"],"service":[{"id":"#serviceId123","type":"someType","serviceEndpoint":"https://www.url.com"}]},"didDocumentMetadata":{"method":{"published":false,"recoveryCommitment":"EiCFei9R_74JeKbxGIZPI4XXwbb0eDpBeweA9IpymBEOFA","updateCommitment":"EiDDJ-s9CPjkh6yaH5apLIKZ1G87K0phukB3Fofy2ujeAg"},"canonicalId":"did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg"}}

Resolve Request

$ curl http://localhost:3000/api/1.0/identifiers/did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg

Resolve Response

{"@context":"https://w3id.org/did-resolution/v1","didDocument":{"@context":["https://www.w3.org/ns/did/v1","https://w3id.org/security/suites/jws-2020/v1",{"@vocab":"https://www.w3.org/ns/did#"}],"id":"did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg","verificationMethod":[{"id":"#signingKey","controller":"did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg","type":"EcdsaSecp256k1VerificationKey2019","publicKeyJwk":{"kty":"EC","crv":"secp256k1","x":"8a7JVJUDcR_mS6gyTAgdvGFZkhO8plwWfId3xqHa7xA","y":"xIxXstl9XR-hXXBkrhzxrFhJRvab2MLhQDus92S8G2o"}}],"authentication":["#signingKey"],"assertionMethod":["#signingKey"],"capabilityInvocation":["#signingKey"],"capabilityDelegation":["#signingKey"],"keyAgreement":["#signingKey"],"service":[{"id":"#serviceId123","type":"someType","serviceEndpoint":"https://www.url.com"}]},"didDocumentMetadata":{"method":{"published":true,"recoveryCommitment":"EiCFei9R_74JeKbxGIZPI4XXwbb0eDpBeweA9IpymBEOFA","updateCommitment":"EiDDJ-s9CPjkh6yaH5apLIKZ1G87K0phukB3Fofy2ujeAg"},"canonicalId":"did:elem:ganache:EiB_4F3m_qz5tBdRmC7tcMOQJxvKSyICzQ4Uxt8cGTN5Vg"}}