voltairelabs / plasma

Ethereum plasma implementation

Plasma MVP

Install dependencies with

$ npm install

Run test cases:

# start test rpc server (which starts server on localhost:8545)
$ npm run testrpc

# run test cases
$ npm run test

Development

# start test rpc server or you can start `geth`/`parity` node
$ npm run testrpc

# deploy contracts
$ npm run deploy

# start authority's server
$ npm run authorized-dev

# start dev server
$ npm run dev

Production

# build server
$ npm run build

# start server
$ npm start

CLI

$ npm run testrpc # or use actual ethereum node (check configurations)
$ npm run authorized-node # or simple dev node => npm run dev


# start cli (`-p` option provides a way to accept sender's private key)
$ ./src/cli/index.js -p '9b28f36fbd67381120752d6172ecdcf10e06ab2d9a1367aac00cdcd6ac7855d3'
plasma > .help

Configurations

You can override default configurations by creating config.env file in root directory and adding following variables:

Variable	Description	Default
APP_NAME	Name shown on UI	Plasma chain
APP_PORT	Server port	8080
CHAIN_DB	Level db location	./db
CHAIN_BLOCK_PERIOD	Plasma chain block period. After every block period, new plasma block will be created, if necessary.	6
CHAIN_WEB3_PROVIDER	Web3 http provider URL	http://localhost:8545
CHAIN_ROOT_CONTRACT	Contract address for root contract	0xb4ee...a6a
CHAIN_AUTHORITY_ADDRESS	Authority address for PoA	0x9fB2...791
CHAIN_AUTHORITY_PRIVATE_KEY	Authority's private key for PoA	0x9b28...5d3
NETWORK_EXTERNAL_HOST	Network's external host (for sync)	0.0.0.0
NETWORK_PORT	Network's port (for sync)	8081
NETWORK_PEERS	Pre-defined peers (for sync)

plasma's Issues

Add cli support

Investigate support for ERC20 tokens

Improve test coverage

TypeError: Cannot read property 'length' of undefined

Hi

While ruining the step npm run test I am getting this error.

` 1) Contract: Root chain - client Client transfer:
TypeError: Cannot read property 'length' of undefined
at Context._callee3$ (test/Client.js:115:38)
at tryCatch (node_modules/babel-polyfill/node_modules/regenerator-runtime/runtime.js:65:40)
at Generator.invoke [as _invoke] (node_modules/babel-polyfill/node_modules/regenerator-runtime/runtime.js:303:22)
at Generator.prototype.(anonymous function) [as next] (node_modules/babel-polyfill/node_modules/regenerator-runtime/runtime.js:117:21)
at step (test/Client.js:29:191)
at test/Client.js:29:361
at process._tickCallback (internal/process/next_tick.js:68:7)

2. Contract: Root chain - client Client withdraw:
   TypeError: Cannot read property 'length' of undefined
   at Context._callee5$ (test/Client.js:165:38)
   at tryCatch (node_modules/babel-polyfill/node_modules/regenerator-runtime/runtime.js:65:40)
   at Generator.invoke [as _invoke] (node_modules/babel-polyfill/node_modules/regenerator-runtime/runtime.js:303:22)
   at Generator.prototype.(anonymous function) [as next] (node_modules/babel-polyfill/node_modules/regenerator-runtime/runtime.js:117:21)
   at step (test/Client.js:29:191)
   at test/Client.js:29:361
   at process._tickCallback (internal/process/next_tick.js:68:7)`

Can you please check :)

Add test coverage instrumentation

Document RPC API and inter-node communication

Implement plasma node

Overview

Implement simple plasma node which receives transactions, validates them and creates a block.

The node must follow following rules to validate a transaction:

1. Should prevent double spends (spending already spent transaction output (TXO))
2. Shouldn't create unspent transaction output (UTXO) without creating individual deposit block or using other UTXOs as input
3. Should match the sum of the denominations of the inputs to the sum of the denominations of the outputs plus the fees
4. Should reject transaction from an address with exit state
5. Should reject transaction from an address which is already exited

The node must follow following rules to validate a block:

1. Should contain only validate transactions
2. Should include deposit transaction only once for deposit block
3. Should include valid transaction only once
4. Should submit the block to root chain

Specification

The specification will follow as we go ahead with the implementation.

API Interface

Implement an API interface (mostly with JSON RPC) to interact with the node. The interface must be open for all.

It must follow following features, APIs:

1. Should allow retrieving current state, data and transaction history for plasma chain
2. Should allow to submit transaction for validation

Add functional testing

First step: create a list with every scenario that a Plasma node should consider for testing.

Investigate support for NFTs / DARs

Add minimal wallet implementation for end users

Add contribution guidelines

Investigate testrpc crashes while running test suite

use of priority for exits mapping can create collisions

the priority variable in startExit function is prone to collisions. hence, its use in a mapping can lead to takeover of exit slots.

here a unit test that demos the problem:

https://github.com/johannbarbie/plasma/blob/test/weekOldBlockExit/test/RootChain2.js

Document attack scenarios

Make sure we have tests for each situation.

Add a way to collect fee

Considere removing need for separate Dagger process

Add plasma_ prefix to RPC methods

Investigate tree structure for chains