Skip to content
Solidity contracts that run Provident One insurance fund
JavaScript Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
contracts
migrations
test
.gitignore
.travis.yml
AUTHORS
Dockerfile
LICENSE.md
README.md
logo.png
test.sh
testchain.sh
truffle.js

README.md

Provident One contracts Build Status Slack badge

Provident One is a decentralized vehicle that runs on top of the Ethereum blockchain. It features insurance plans entities can subscribe to, a way for subscribers to claim to the insurance and a investment fund with a token that gives liquidity to the fund.

It uses Truffle as a contract development framework.

Right now we a are participating in the hack.ether.camp hackathon, so if you like the project we would appreciate your support voting the project. See Provident One on hack.ether.camp.

Architecture

If you glance over the contracts/ directory, you will find a not very well known way of architecting Ethereum contracts. This architecture has been chosen to allow for code modularity and allowing good upgradability of certain parts of the system.

It is explained in more detail in the whitepaper section 3, Implementation.

Development

The recommended workflow for developing and contributing to the contracts is using the truffle console for compiling, deploying and playing with contracts. In order to do that, just:

$ npm install -g truffle ethereumjs-testrpc

$ testrpc // leave process running
$ truffle console
> compile
Compiling InsuranceFund.sol
...
> migrate --reset
...
> InsuranceFund.deployed()
Insurance Fund deployed eth-pudding object

You need to be running a Ethereum node with RPC enabled for Truffle to connect. In this example, we are just running it with testrpc, which is a in-memory RPC enabled node written in JS, that is very fast for development and testing. This can be run also on a private blockchain running with geth, the Ethereum testnet or the mainnet. See Truffle network configuration for more info.

Testing

We have been finding TDD to be a very good way to develop Solidity contracts, as it gives the peace of mind that you are not creating bugs as you continue developing.

For running in the CI, a Docker image has been created for the sake of simplicity. It starts a testrpc node and runs the tests against it.

Right now, there are lots of tests missing to cover the entire functionallity of the system. Help with tests is needed and apprecited.

No Pull Requests will be merged unless there is a test case for that functionallity and all tests are passing in the CI.

Community Slack badge

We truly believe Provident One to be a community effort. If you are interested in its development, don't hesitate to join the community on Slack

License

Provident One is licensed under the GNU AGPLv3 license

You can’t perform that action at this time.