This is an SDK for creating scalable and resilient client side peer-to-peer (p2p) state channels for arbitrary state machines with shared security inherited from a distributed ledger (blockchain).
The repository currently holds a Minimal Feature Set (MFS) as part of our grant agreement with the Web3 Foundation.
We recommend waiting for the Full Feature Set before using it in production.
- Demo - https://www.youtube.com/watch?v=W_CWPOezjU8
- Tech Explanation - https://www.youtube.com/watch?v=RtjiyDDhvWA
- Peer3 Intro - https://www.youtube.com/watch?v=GnRPe6ziKpI
yarn add @peer3/state-channels-plusThe SDK currently supports running EVM smart contracts (state machines). We recommend watching our tech explanation video to have a rough estimate how things work.
While you can do general (arbitrary) execution, the SDK requires the state machines to implement a base contract AStateMachine. The implemented contract executes p2p with shared security enforced by a blockchain, concretely by a StateChannelManager contract that extends AStateChannelManager.
The TypeScript part of the SDK currently builds on top of ethers.
The SDK abstracts away most of the complexities of the system and is designed to have the same development experience as if the contracts were executing on-chain. It takes an ethers contract instance and enshrines it during setup. The enshrined contract has the same type and functionality as the original contract, but it executes p2p. The setup also wraps the ethers signer by giving it more functionality that's used within the system.
Tic-Tac-Toe - the code used in the demo video
Install local dependencies
yarnCompile the contracts and run tests
yarn testcMIT