This repository contains a small state channel framework capable of running 3rd-party 'applications' that conform to a simple state-machine interface. It also contains the logic for a few example applications (a payment channel and the game of rock-paper-scissors) to demonstrate how to build on top of the framework.
The framework takes a pragmatic approach, sacrificing generality of the supported applications, for simplicity in the on-chain and off-chain logic. In particular, the framework can't (yet) support any applications that have state transitions whose validity depends on time, or other properties that are external to the channel's state. For example, as it currently stands, you couldn't build a state channel sports betting game, where bets have to be made by a deadline and the winner is determined through an oracle feed.
A full description of the framework and it's capabilities can be found in our whitepaper.
The framework in this respository is currently limited to 2-player games, but that's mostly due to solidity challenges and time constraints - the framework itself extends naturally to n-player games.
The framework separates the core behaviour of the protocol from the implementation. We currently provide one implementation (the simple adjudicator). You can find more about working with the framework using the simple adjudicator in the readme.
This repository is split into packages, the first two of which are published as independent node modules.
||Contracts and js libraries for the protocol rules and states|
||Implementation of on-chain adjudicator capable of supporting the protocol|
||Example: 2-player game built on the framework|
||Example: payment channel built on the framework|
This project is still a work in progress! Still to do in the short term:
- Publish packages to npm
- Release whitepaper
- Build out a full example application (including UI)
- Optimize contracts for gas consumption
- More tests to demonstrate the simple adjudicator
- Audit contracts
In the medium term:
- Add support for ERC20 tokens
- Extend the code to n-party games
- Create an adjudicator capable of supporting ledger channels and virtual channels
We welcome contributions and feedback from the community! We'll be putting together some more-comprehensive contributing guidelines shortly. In the meantime, issues and PRs welcome!
To get started:
- Download the repo.
- Install lerna:
npm install -g lerna.
- Install truffle:
npm install -g truffle.
- Install ganache.
lerna bootstrapanywhere in the project.
- Within a package, run
npm testfor that package's tests. Or, run it from the project root to test both
NOTE: while the above instructions use globally installed
truffle node modules, the tests running on circleci use dev dependencies, and may therefore produce different results.
This project is licensed under the terms of the MIT license.