Skip to content

Latest commit

 

History

History
93 lines (62 loc) · 6.53 KB

README.md

File metadata and controls

93 lines (62 loc) · 6.53 KB
Raw

Base

contract-deployments

This repo contains execution code and artifacts related to Base contract deployments, upgrades and calls. For actual contract implementations, see base-org/contracts.

This repo is structured with each network having a high level directory which contains sub directories of any "tasks" (contract deployments/calls) that have happened for that network.

GitHub contributors GitHub commit activity GitHub Stars GitHub repo size GitHub

Website base.org Blog Docs Discord Twitter BuildOnBase

GitHub pull requests by-label GitHub Issues

Setup

First install forge if you don't have it already:

  • Run make install-foundry to install Foundry.

To execute a new task run one of the following commands (depending on the type of change you're making):

  • For incident response commands: make setup-incident network=<network> incident=<incident-name>
  • For full new deployment (of L1 contracts related to Base): make setup-deploy network=<network>
  • For contract calls, upgrades, or one-off contract deployments: make setup-task network=<network> task=<task-name>

Next, cd into the directory that was created for you and follow the steps listed below for the relevant template.

Directory structure

Each task will have a directory structure similar to the following:

  • inputs/ any input json files
  • records/ foundry will autogenerate files here from running commands
  • script/ place to store any one-off foundry scripts
  • src/ place to store any one-off smart contracts (long lived contracts should go in base-org/contracts)
  • .env place to store env variables specific to this task

Using the incident response template

This template contains scripts that will help us respond to incidents efficiently.

To use template during an incident:

  1. Fill in the .env file with dependency commit numbers and any variables that need to be defined for the script you're running.
  2. Delete the other scripts that are not being used so that you don't run into build issues.
  3. Make sure the code compiles and check in the code.
  4. Have each signer pull the branch, and run relevant signing command from the Makefile.

To add new incident response scripts:

  1. Any incident response related scripts should be included in this template (should be generic, not specific to network), with specific TODOs wherever addresses or other details need to be filled in.
  2. Add the relevant make commands that would need to be run for the script to the template Makefile
  3. Add relevant mainnet addresses in comments to increase efficiency responding to an incident.

Using the deploy template

This template is used for deploying the L1 contracts in the OP stack to set up a new network.

  1. Ensure you have followed the instructions above in setup
  2. Rename the folder to something more descriptive
  3. Specify the commit of Optimism code and Base contracts code you intend to use in the .env file
  4. Run make deps
  5. Fill in the inputs/deploy-config.json and inputs/misc-config.json files with the input variables for the deployment.
  6. See the example make deploy command. Modifications may need to be made if you're using a key for deployment that you do not have the private key for (e.g. a hardware wallet)
  7. Run make deploy command
  8. Check in files to github. The files to ignore should already have been specified in the .gitignore, so you should be able to check in everything.

Using the generic template

This template can be used to do contract calls, upgrades or one-off deployments.

  1. Specify the commit of Optimism code and Base contracts code you intend to use in the .env file
  2. Run make deps
  3. Put scripts in the scripts directory (see examples that are part of the template, for example there is a file TransferOwner.s.sol, which can be used to setup the ownership transfer task). See note below if running a task that requires a multisig to sign.
  4. Call scripts from the Makefile (see examples in the template Makefile that's copied over).

Note: If using a multisig as a signer you can leverage the MultisigBuilder for standard multisigs or the NestedMultisigBuilder scripts in the base contracts repo for multisigs that contain other multisigs as signers. For these scripts, you need to implement the virtual functions that are provided, which will allow you to configure the task you'd like to run, the address of the multisig you're running it from and any post execution checks. See the files themselves for more details. It is recommended to add any configured addresses as constants at the top of the file and provide links to etherscan, etc as needed for reviewers to more accurately review the PR.