buidler-erasure

Buidler plugin for Erasure protocol

What

This plugin helps you deploy the erasure protocol contracts or connect to an arbitrary network and execute custom tasks

Tasks

This plugin adds the following tasks to Buidler:

• erasure:erasure-setup: Deploys all the erasure contracts

Environment extensions

This plugin add to maine extensions to the Buidler Runtime Environment:

• Erasure:

• getDeployedAddresses: retrieves the deployed addresses of a given contract name.
• getDeployedContracts: retrieves the deployed contract instances of a given contract name.
• saveDeployedContract: store a contract's address into the deployment state.
• deploy: deploys a contract

• Deployments:

• getErasureSetup: retrieves erasure deploy setup.
• deployContract: resolves what kind of contract it's being deployed and deploy it.
• getContractInstance: retrieves an instance of a contract attached to an address
• createInstance: creates a template instance from a factory

Configuration

You can configure how the erasure contracts are deployed.

There are some examples of different configurations here

By default, it uses the default setup which deploy the contracts as they are now.

Usage

You can use buidler-erasure along with erasure-protocol to deploy your contracts and run scripts, buidler-erasure tasks, or any custom tasks.

This plugin is still under development, so in order to use it you must build and link the dependencies onto your project.

Here is what you have to do to install it on the erasure-protocol project. This bash snippet installs my erasureprotocol/erasure-protocol fork, which includes a little script that simulates the packages/testenv

git clone git@github.com:itirabasso/buidler.git # clone my buidler's fork
git clone git@github.com:itirabasso/buidler-erasure.git # clone this plugin
git clone git@github.com:itirabasso/erasure-protocol.git # clone my erasure-protocol's fork

cd buidler
scripts/install.sh # install buidler (and all its dependencies)
npm run watch # build and watch for changes.

# new tab

cd packages/buidler-core
npm link # link buidler-core to introduce the changes in Buidler EVM

cd ../../../buidler-erasure
npm install
npm link @nomiclabs/buidler # link local buidler 
npm link 
npm run watch

# new tab

cd ../erasure-protocol
npm i
npm link @nomiclabs/buidler
npm link buidler-erasure
npx buidler # should display the avaiable commands
npx buidler run script.js # run the script.js which deploys the contracts con buidlerEVM and creates some instances

You can also use this same script to try it out on the rinkeby testnet, buidler-erasure will use the network's configured erasure setup and connect the contracts to the given addresses.

npx buidler run script.js --network rinkeby

Further development

I'm currently working on a FakeProvider to allow buidler-erasure to deploy on local networks (like ganache) with a fake tx (impersonating the NMR signer), for now it's only supporting buidlerEVM.

After that, and merging these features on buidler it'll be much easier to install the project.