kustomzone / monorepo

Development monorepo for the State Channels project.

Simple off-chain applications framework for Ethereum.

statechannels 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 one or other of the whitepapers underpinning the project, or a less technical written description.

• Packages
• Contributing
  • Installing dependencies
  • Building packages
  • Clean
  • Lint
  • Tests
• Community

Packages

This repository is a monorepo, and contains the following packages maintained with lerna and yarn workspaces:

• client-api-docs : API docs for the interface betwen a state channel Dapp and the wallet
• channel-client : A JavaScript object interface for the state channels client API
• channel-provider : Thin wrapper around PostMessage communication between an App and a Wallet
• client-api-schema : JSON-RPC based schema definitions for the Client API with TypeScript typings
• e2e-tests : End-to-end browser tests of all packages with puppeteer
• devtools : Developer tooling
• jest-gas-reporter : Reports the gas used by various calls to ethereum contracts
• nitro-protocol : Smart contracts and documentation website
• rps : Rock paper scissors DApp
• simple-hub : Simple server wallet for mediating virtual channels
• tic-tac-toe : Tic-tac-toe DApp
• web3torrent : DApp extension of webtorrent including micropayments
• wire-format : Format of messages that are sent over the wire between wallets
• xstate-wallet : A browser wallet implementation

Contributing

• Create a new issue to report bugs
• Fix an issue. statechannels is an Open Source Project!

Installing dependencies

Make sure you have Yarn v1.17.3 installed. For easy management of specific Yarn versions, we recommend using Yarn Version Manager (YVM).

To install the dependencies:

yarn

from the monorepo root.

Building packages

To build all packages:

yarn build

Clean

To clean all packages:

yarn clean

Lint

To lint all packages:

yarn lint:check

To also apply automatic fixes:

yarn lint:write

Tests

To run all tests:

yarn test

Development Flow

The rps, nitro-protocol, wallet, and hub packages will need to interact with a local blockchain when running and testing locally.

Running locally

Run

SC_ENV=virtual-funding yarn start-servers $APP

where APP is either web3torrent or rps. This will start a ganache instance on port 8545, and subsequently start servers for

• the wallet
• the app
• the simple-hub (used for virtual-funding)

These servers use a common set of contracts deployed against the shared ganache instance.

Community

State Channels Forums: https://research.statechannels.org/