@pigi/contracts

contracts

contracts is the set of smart contracts written in Solidity for the Plasma Group series of projects.

Requirements and Setup

Clone the parent repo pigi and follow its instructions.

Node.js

contracts is tested with Node.js and has been tested on the following versions of Node:

• 11.6.0

If you're having trouble getting contracts tests running, please make sure you have one of the above Node.js versions installed.

Running Tests

contracts makes use of a combination of Mocha (a testing framework) and Chai (an assertion library) for testing.

Run all tests with:

yarn test

So that Python and Vyper aren't requirements for our other components, we do include a compiled-contracts folder which contains JS exports of the bytecode and ABI. Compilation is done automatically before testing.

Deploying

You can deploy by running:

yarn run deploy:<contract-specific-task-here> <environment>

The environment parameter tells the deployment script which config file to use (expected filename .<environment>.env).

For instance, to deploy the RollupChain contract using .local.env as the config file, you would run:

yarn run deploy:rollup-chain local

See .env.example for more information.