ArgosId

v1.3.2

The argosid is a library of Ethereum smart contracts which allow anyone to create decentralized identities. It is an open source project created by Argos Protocol.

Documentation

argos-id documentation

Using argosid in your project

As a node package

npm install argos-id --save

or

yarn add argos-id

npm build will generate this file and save it to dist/argos.js.

Local development

1. Clone this repo.

git clone https://github.com/argosid/argos-id.git && cd argos-id

If you would like to submit pull requests, you should instead fork this repo and then clone your fork. Note pull requests should always be made to the develop branch, which always has the latest commits.

2. Install dependencies and link

npm run install:dev

install:dev is shortcut for npm install && npm link. Linking means that changes to argosid code are immediately available to local DApps without an npm install.

3. Start the local blockchain and build argosid

npm start

Code changes will trigger a live rebuild.

Tests

Command Line (All Tests)

Our full test suite can be run with:

npm run test

Note: you should not have the server running at this time, as these tests start their own local blockchain instance.

Command Line (Only Solidity Tests)

Our Solidity tests (which use Truffle) are located at contracts/test.

npm run test:contracts

Note: you should not have the server running at this time, as these tests start their own local blockchain instance.

Browser Tests

A subset of our tests can be run from the browser. These tests are automatically served at http://localhost:8081 when you run npm start. These tests are automatically rerun when source or test code is changed.

Run a subset of these tests using the grep query string parameter, for example: http://localhost:8081/?grep=IpfsService

Using the Ganache GUI

By default, starting argosid locally starts ganache-cli automatically. However, for development you might want to connect to the GUI version of Ganache. This provides a nice interface for browsing your local blockchain activity and can be useful for debugging.

To use the Ganache GUI:

1. Install Ganache
2. Start Ganache
3. Navigate to the settings in Ganache (click on the gear in the upper right-hand corner)
4. Set Port Number to 8545
5. Set Network ID to 999
6. Under the Accounts & Keys tab, set the mnemonic to candy maple cake sugar pudding cream honey rich smooth crumble sweet treat
7. When starting argosid locally, run npm run start:local (instead of npm run start)

Initialize a genesis node

geth --datadir . init ./genesis.json

geth --datadir . --networkid 9090 console

geth --datadir . import pk

Start a genesis node

geth --datadir . --networkid 999 --mine --minerthreads=4 --rpc --rpcapi "db,eth,net,web3,personal,admin" --rpccorsdomain "*" --rpcaddr "0.0.0.0"