Nahmii Contracts

This is the home of code for smart contracts for hubii's 2nd layer solution called nahmii.

White Paper

An elaborate outline of the nahmii protocol can be found in the nahmii white paper. We suggest you read this document before diving into the details of the supporting smart contracts in this repository.

Tests

In order to run the included tests there are a couple of alternatives readily available.

Truffle Develop may be spawned by truffle develop. Running command test in its REPL will initiate a run of all tests.

Alternatively the standard npm test may be run. This command spawns an instance of ganache-cli on which smart contracts are deployed and tests executed against.

Documentation

Directory ./docs contains a number of documentation files generated from Solidity contracts NatSpec comments using soldoc. Note that as soldoc has yet to support methods whose parameter or return value is a struct type the documentation is incomplete and defines parameter/return value as type tuple when a struct type instance is expected.

Bytecode Verification

Etherscan code verification is currently not possible as their code verification tool does not support ABI coder v2. In a support ticket correspondence we were told that support for ABI coder v2 is on their agenda.

Contributing

Bug Reports

Please open issues in the issue tracker and label them as bugs.

Development

All development is happening on the develop branch by using pull requests. Master branch is reserved for later usage.

Practices

Gitflow

Please obey by established Gitflow principles. Details can be obtained in post by Vincent Driessen or in Atlassian's Gitflow Workflow tutorial. Driessen's git-flow git extension is indispensable.