Skip to content

Latest commit

 

History

History
109 lines (69 loc) · 2.79 KB

README.md

File metadata and controls

109 lines (69 loc) · 2.79 KB
Raw

Tenderizer

Coverage Status

Install

Make sure Node.js (>=v12.0) is installed.

git clone https://github.com/Tenderize/tender-core.git
cd tender-core
yarn

Build

Compile the contracts and build artifacts used for testing and deployment.

yarn compile

Clean

Remove existing build artifacts.

yarn clean

Lint

The project uses ESLint for Typescript/Javascript linting and Solhint and Prettier for Solidity linting.

yarn lint

Run Tests

All tests will be executed via hardhat.

Make sure to add relevant API keys inside .env file.

To run all tests:

yarn test

To run unit tests only:

yarn test:unit

To run integration tests only:

yarn test:integration

To run gas reporting tests (via hardhat-gas-reporter) only:

yarn test:gas

To run tests with coverage (via solidity-coverage) reporting:

yarn test:coverage

Deployment

Make sure that an ETH node is accessible and that the network being deployed to is supported by the hardhat.config.ts configuration. By default an in-memory Hardhat VM will be used, to specify another network use the --network flag.

Environment Variables

  • Make sure that you enter a PRIVATE_KEY and JSON_RPC in the project root .env file when using a live network.
  • Adjust the necessary environment variables in deploy/.env

Deploying dependencies

To be able to deploy Tenderizers, first the dependencies need to be deployed.

yarn deploy:libraries
yarn deploy:registry

These commands will export the contract artifacts to deployments/{networkName}/{ContractName}.json

Deploying tenderizers

A Tenderizer is a combination of contracts, some general dependencies will be re-used. After deployment the new tenderizer will be registered with the Registry.

To deploy a Tenderizer provide the required environment variables in deploy/.env, e.g. NAME=Livepeer will ensure that the Livepeer Tenderizer is deployed and saved to deployments/{networkName}/Livepeer.json with all its dependencies and contracts in a single file.

Also make sure to set the the name of the Tenderizer you want to deploy from the console. This needs to be done separately because at the time the command is executed the deploy/.env has not yet been parsed.

export NAME=<Name e.g. "Livepeer">
yarn deploy:tenderizer --network <networkName>