Smart contracts for Revo, a DeFi platform that makes yield farming easy and profitable for everyone.
First install dependencies with yarn (just type yarn in the CLI from the project root and hit enter).
Next compile contracts, which also populates the typechain types (which are needed elsewhere).
For first-time setup, follow the instructions in deploy/index.ts to prevent compilation errors
due to missing generated types.
Then run this from the CLI: yarn compile-contracts . This will generate the typescript types for our contracts;
they will be saved to the typechain directory.
After initial setup, you should be able to use the "normal" deploy script without issues.
Note that after making changes to contracts, you will need to compile the contracts to update the typechain types,
then possibly update the deploy script before deploying (in particular, this will be necessary if you updated arguments
for the constructor for some contract in the deploy script).
There are some helper scripts for interacting with the Farm Bot contract in the scripts directory.
- deposit: deposit LP into a farm bot
- grant-compounder: grant the compounder role (assuming you are the farm bot admin)
- withdraw: withdraw LP from a farm bot
The docstring in each script file should help you prepare to run each one. Here's an example of running the deposit
script from the CLI:
PRIVATE_KEY=<fill this in> LP_AMOUNT=<fill this in> node --require ts-node/register <fill in path to project>/scripts/deposit.ts
or with regular node by first building with yarn build and then running the compiled JS file.
- Compile contracts with
yarn compile-contracts - Deploy with
yarn deploy-contracts-alfajores --step {your_step_here}
- Compile contracts with
yarn compile-contracts - Deploy with
yarn deploy-contracts-mainnet --step {your_step_here}