Skip to content

Latest commit

 

History

History
78 lines (56 loc) · 4.8 KB

README.md

File metadata and controls

78 lines (56 loc) · 4.8 KB

Deploy Smart Contracts

To deploy the smart contracts and set things up, the best thing to do is to use the deploy-by-config.ts script.

In order to use the script, you will need to create a YAML file to describe the complete setup. An example configuration is available. You should copy it and make changes as required. At the moment, that example file uses address/tokens from the mainnet, so you should deploy the contracts on a fork of the mainnet.

In one terminal window, run:

npm run start-fork

and wait for the fork to start.

Then in another terminal window, run:

# Set the default AWS region in order to sign using KMS.
# You should also make sure you have AWS setup and your IAM role have the permission to use the key to sign
export AWS_REGION=eu-west-1
# Compile the contracts
npx hardhat compile
# print out the contracts that will be deployed
HARDHAT_NETWORK=localhost ./node_modules/.bin/ts-node --files ./scripts/deploy-by-config.ts --config ./deployment-config/config-example.yaml --deploy true --update false --dryrun true  --env dev
# deploy the contracts
HARDHAT_NETWORK=localhost ./node_modules/.bin/ts-node --files ./scripts/deploy-by-config.ts --config ./deployment-config/config-example.yaml --deploy true --update false --dryrun false  --env dev

# print out the contract calls that going to be made
HARDHAT_NETWORK=localhost ./node_modules/.bin/ts-node --files ./scripts/deploy-by-config.ts --config ./deployment-config/config-example.yaml --deploy true --update true --dryrun true  --env dev
# configure the contracts
HARDHAT_NETWORK=localhost ./node_modules/.bin/ts-node --files ./scripts/deploy-by-config.ts --config ./deployment-config/config-example.yaml --deploy true --update true --dryrun false  --env dev

For the arguments:

  • config: The path to the configuration file
  • deploy: Set this to true to deploy new smart contracts. The results of the deployments will be stored in a configuration file that is named with the value of the env argument, and if a contract is already deployed the script will skip the already deployed contracts. Default value is true.
  • update: Set this to true if you want to configure the deployed contracts to match the state described in the YAML file. Should only run this after all contracts are deployed. If there are contracts not deployed there could be errors. Default value is true.
  • dryrun: If set to true, the script will only print out information, like the contracts that will be deployed, or the smart contract calls that will be made, with estimated gas if available (they are not available for proxy contracts or multisig transactions). If this set to false the script will actually execute the transactions.
  • env: The name of the environment. A deployment records file will be created using this value.

Verify the Contracts on Etherscan

Use the verify.ts script to verify the deployed contracts:

HARDHAT_NETWORK=rinkeby ./node_modules/.bin/ts-node --files ./scripts/verify.ts --env test-rinkeby

The script will go through all the contracts in the deployment records and upload the source code for them to be verified.

Upgrade Smart Contracts

Some smart contracts are upgradeable, and only governance should have permission to upgrade a contract.

To upgrade a upgradeable smart contract, use the propose-upgrade.ts script. The script will deploy the new contract, and automatically propose a multisig transaction to upgrade the proxy contract to the new contract.

NOTE: if there are any other additional steps required after the new contract is deployed, you will need to do them in some other way, either manually or via other scripts.

Example:

# Set the default AWS region in order to sign using KMS.
# You should also make sure you have AWS setup and your IAM role have the permission to use the key to sign
export AWS_REGION=eu-west-1
# Compile the contracts
npx hardhat compile
# Invoke the upgrade
HARDHAT_NETWORK=rinkeby ./node_modules/.bin/ts-node --files ./scripts/propose-upgrade.ts --current-contract Staking --new-contract StakingV1Mock --abi-path ../abi/contracts/staking/Staking.sol/Staking.json --governance 0x02319D11BAe6b7027efbfED51163a8c51ec3d6FA --env test-rinkeby

For the arguments:

  • env: The name of the environment. There should be a deployment record file already exists for this environment for upgrades.
  • current-contract: The name of the current deployed contract. Note it is the contract name (e.g. the name of the contract in the .sol file).
  • new-contract: The name of the new contract to upgrade to.
  • abi-path: The path to the ABI file of the current contract. All abi files for the contracts can be found in the abi directory once they are compiled.
  • governance: The multisig wallet address of the governance.