Simple off-chain applications framework for Ethereum.
Counterfactual is a simple off-chain framework for building state channel applications on top of the Ethereum blockchain. It aims to make it simpler to build permissionless applications that have instant finality with zero-fee transactions.
You can learn more about what state channels are by reading our whitepaper or a less technical written description. Further, if you want to dive into the specifications of the Counterfactual protocol you can read them here.
||Core implementation of on-chain state resolution mechanisms|
||The core state channels client that a user runs|
||A JS API for interacting with off-chain apps|
||Wrapper around API calls to a Node|
||Extendible middleware-based executor of Counterfactual protocols|
||Shared type declarations|
||Shims for external library typings|
- Join us in Discord to help with development or to hang out with some ethereum hackers :)
- Create a new issue to report bugs
- Fix an issue. Counterfactual is an Open Source Project!
The Playground currently only supports the Kovan network.
Make sure you have Yarn v1.10.1 installed or higher. Refer to Yarn's installation guide for setup instructions for your operating system.
To install the dependencies:
To build all packages:
To clean all packages:
To lint all packages:
To also apply automatic fixes:
To run all tests: