SignHash Ethereum Smart Contracts

The repository contains Ethereum Smart Contracts implementing core SignHash functionality, identity management and donations. You can read more about SignHash project in the whitepaper.

Getting started

The project uses NPM and Truffle Framework.

Contracts are written in Solidity. Everything else (migrations, tests, scripts) is written in TypeScript.

Contracts code resides in contracts directory.

You can find compiled ABI and network addresses in build directory.

Developing

Clone repository and install dependencies

git clone https://github.com/SignHash/signhash-contracts.git
cd signhash-contracts
npm install

Building

Compile contracts

npm run compile

Run tests

npm test

Run linters

npm run lint

Deploying / Publishing

Run migrations on testrpc

npm run migrate

Setup testrpc with deployed contracts

npm run seed

Configuration

Configuration is documented in Truffle docs.

Contributing

Significant changes to SignHash smart contracts, architecture or functionality should be proposed in the proposals repository.

Please follow tslint and solhint configurations. TypeScript code is auto-formatted in git pre-commit hook and follow prettier configuration.

Licensing

The code in this project is licensed under the MIT license.