Project 8 Framework

A toolkit for developing Token Incentivized Sidechains on top of Ethereum.

Overview

This repo provides a set of on-chain and off-chain tools to build generalized Proof-of-Stake sidechains with non-custodial payments.

Prerequisites

1. brew

ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

1. HubFlow

brew install hubflow

If you are on Linux

git clone https://github.com/datasift/gitflow
cd gitflow
sudo ./install.sh

---

Setup

1. npm install -g truffle solhint

• IDE Integrations for solhint

1. git clone [email protected]:luciditytech/token-incentivized-sidechains.git
2. npm install
3. git hf init

---

Compiling and migrating smart contracts

1. truffle compile
2. truffle migrate

---

Testing smart contracts

Be sure compiled contracts are latest before testing

1. truffle test
2. With code coverage: npm test

---

Linting smart contracts

1. solhint "contracts/**/*.sol"

---

Licensed under MIT.

This code is licensed under MIT.

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Notice

Except as contained in this notice, the name of the ZeroX Affiliate, LLC DBA Kr8os shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from ZeroX Affiliate, LLC DBA Kr8os.