contracts

@joincivil/contracts

Smart-contracts that build the kernel of the protocol and ecosystem of Civil in general. To be deployed on Ethereum's network.

Note

To support our code coverage and documentation generation tools (solcover and doxity respectively), which cannot correctly instrument and parse contracts that import files added to this repo via EPM, we have brought several contracts in via EPM and then moved them into the /contracts/installed_contracts folder. We have also modified the import paths of those files appropriately but otherwise there are no changes. The contracts originally brought in via EPM are:

AttributeStore.sol (package: attrstore @ v1.0.0) DLL.sol (package: dll @ v1.0.3) ERC20Interface.sol (package: tokens @ v1.0.0) ERC20.sol (package: tokens @ v1.0.0) PLCRVoting.sol (package: plcr-revival @ v1.3.0) Parameterizer.sol (package: tcr @ v1.1.0)

For the same reason, we have brought several files from OpenZeppelin originally added via NPM into the contracts/zeppelin-solidity folder. Those contracts are:

ECRecovery.sol Ownable.sol SafeMath.sol

Usage

Start up Ganache in the root directory of the monorepo:

yarn ganache

Build and strip the artifacts:

yarn build

Run tests:

yarn test

And check out migrations:

yarn truffle migrate

Artifacts

Truffle generates a lot of additional data inside the .json artifacts that are needed to interface with the artifacts from outside the Ethereum's network.

During the build process artifacts are striped out of additional, debugging information and placed in the build/artifacts folder.

Migrations

This package supports easy Infura migrations and automatic token allocation to teammates. Adding enviromental variables to your .profile will allow you to use it during migrations:

export MNEMONIC="" # Your mnemonic for HD Wallet provider
export INFURA_KEY="" # Your infura api key
export TEAMMATES="" # Comma seperated list of addresses

Contributing

Civil's ecosystem is free and open-source, we're all part of it and you're encouraged to be a part of it with us. Best place to start hacking would be to use the @joincivil/core and build some application on top of the protocol.

If you're itching to dwelve deeper inside, help wanted and good first issue labels are good places to get started and learn the architecture.

Licenses

Inside this package there are multiple smart-contracts from multiple open-sources with somewhat different licensing terms. While we're working to get everything under LGPLv2.1 this is not currently possible. contracts and test folders are split into subfolders with specific names, code under those subfolders is licensed under licenses as follow:

Subfolder	License	Original source
tcr/		skmgoldin/tcr
multisig/		gnosis/MultiSigWallet
anything else		civil/Civil