feat(ct): overhaul deployment process

ops/docker-compose.yml

@@ -36,30 +36,7 @@ services:
       # Env vars for the deployment script.
       CONTRACTS_RPC_URL: http://l1_chain:8545
       CONTRACTS_DEPLOYER_KEY: 'ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80'
-      CONTRACTS_TARGET_NETWORK: 'custom'
-      OVM_ADDRESS_MANAGER_OWNER: '0xf39fd6e51aad88f6f4ce6ab8827279cfffb92266'
-      OVM_PROPOSER_ADDRESS: '0x3c44cdddb6a900fa2b585dd299e03d12fa4293bc'
-      OVM_SEQUENCER_ADDRESS: '0x70997970c51812dc3a010c7d01b50e0d17dc79c8'
-      SCC_FRAUD_PROOF_WINDOW: 0
-      NUM_DEPLOY_CONFIRMATIONS: 0
-      # skip compilation when run in docker-compose, since the contracts
-      # were already compiled in the builder step
-      NO_COMPILE: 1
-
-      # Env vars for the dump script.
-      # Default hardhat account 5
-      GAS_PRICE_ORACLE_OWNER: '0x9965507d1a55bcc2695c58ba16fb37d819b0a4dc'
-      # setting the whitelist owner to address(0) disables the whitelist
-      WHITELIST_OWNER: '0x0000000000000000000000000000000000000000'
-      L1_FEE_WALLET_ADDRESS: '0x391716d440c151c42cdf1c95c1d83a5427bca52c'
-      L2_CHAIN_ID: 987
-      L2_BLOCK_GAS_LIMIT: 15000000
-      BLOCK_SIGNER_ADDRESS: '0x00000398232E2064F896018496b4b44b3D62751F'
-      GAS_PRICE_ORACLE_OVERHEAD: 2750
-      GAS_PRICE_ORACLE_SCALAR: 1500000
-      GAS_PRICE_ORACLE_L1_BASE_FEE: 1
-      GAS_PRICE_ORACLE_GAS_PRICE: 1
-      GAS_PRICE_ORACLE_DECIMALS: 6
+      CONTRACTS_TARGET_NETWORK: 'local'
     ports:
       # expose the service to the host for getting the contract addrs
       - ${DEPLOYER_PORT:-8080}:8081

ops/scripts/deployer.sh

@@ -24,39 +24,7 @@ curl \
 echo "Connected to L1."
 echo "Building deployment command."
 
-DEPLOY_CMD="npx hardhat deploy"
-
-# Helper method to concatenate things onto $DEPLOY_CMD.
-# Usage: concat_cmd "str-to-concat"
-function concat_cmd() {
-    DEPLOY_CMD="$DEPLOY_CMD $1"
-}
-
-# Helper method to conditionally concatenate CLI arguments
-# when a given env var is defined.
-# Usage: concat_arg "--arg-name" "env-var-name"
-function concat_arg() {
-    ARG=$1
-    ENV_VAR=$2
-    if [ -n "${!ENV_VAR+x}" ]; then
-        echo "$ENV_VAR set to ${!ENV_VAR}, applying $ARG argument."
-        concat_cmd "$ARG \"${!ENV_VAR}\""
-    else
-        echo "$ENV_VAR is not not set, skipping $ARG argument."
-    fi
-}
-
-concat_arg "--network" "CONTRACTS_TARGET_NETWORK"
-concat_arg "--ovm-address-manager-owner" "OVM_ADDRESS_MANAGER_OWNER"
-concat_arg "--ovm-proposer-address" "OVM_PROPOSER_ADDRESS"
-concat_arg "--ovm-sequencer-address" "OVM_SEQUENCER_ADDRESS"
-concat_arg "--l1-block-time-seconds" "L1_BLOCK_TIME_SECONDS"
-concat_arg "--ctc-max-transaction-gas-limit" "CTC_MAX_TRANSACTION_GAS_LIMIT"
-concat_arg "--ctc-l2-gas-discount-divisor" "CTC_L2_GAS_DISCOUNT_DIVISOR"
-concat_arg "--ctc-enqueue-gas-cost" "CTC_ENQUEUE_GAS_COST"
-concat_arg "--scc-fraud-proof-window" "SCC_FRAUD_PROOF_WINDOW"
-concat_arg "--num-deploy-confirmations" "NUM_DEPLOY_CONFIRMATIONS"
-concat_arg "--forked" "FORKED"
+DEPLOY_CMD="npx hardhat deploy --network $CONTRACTS_TARGET_NETWORK"
 
 echo "Deploying contracts. Deployment command:"
 echo "$DEPLOY_CMD"
@@ -81,20 +49,13 @@ echo "}" >> addresses.json
 echo "Built addresses.json. Content:"
 jq . addresses.json
 
-echo "Env vars for the dump script:"
-export L1_STANDARD_BRIDGE_ADDRESS=$(cat "./addresses.json" | jq -r .Proxy__OVM_L1StandardBridge)
-export L1_CROSS_DOMAIN_MESSENGER_ADDRESS=$(cat "./addresses.json" | jq -r .Proxy__OVM_L1CrossDomainMessenger)
-echo "ADDRESS_MANAGER_ADDRESS=$ADDRESS_MANAGER_ADDRESS"
-echo "L1_STANDARD_BRIDGE_ADDRESS=$L1_STANDARD_BRIDGE_ADDRESS"
-echo "L1_CROSS_DOMAIN_MESSENGER_ADDRESS=$L1_CROSS_DOMAIN_MESSENGER_ADDRESS"
-
-
 echo "Building dump file."
-yarn run build:dump
-mv addresses.json ./dist/dumps
+npx hardhat take-dump --network $CONTRACTS_TARGET_NETWORK
+mv addresses.json ./genesis
+cp ./genesis/$CONTRACTS_TARGET_NETWORK.json ./genesis/state-dump.latest.json
 
 # service the addresses and dumps
 echo "Starting server."
 python3 -m http.server \
     --bind "0.0.0.0" 8081 \
-    --directory ./dist/dumps
+    --directory ./genesis

packages/contracts/.env.example

@@ -0,0 +1,11 @@
+# Name for the network to deploy to ("mainnet", "kovan", etc.)
+CONTRACTS_TARGET_NETWORK=
+
+# Private key that will send deployment transactions
+CONTRACTS_DEPLOYER_KEY=
+
+# RPC URL connected to the L1 chain we're deploying to
+CONTRACTS_RPC_URL=
+
+# Your Etherscan API key for the L1 network
+ETHERSCAN_API_KEY=

packages/contracts/README.md

@@ -32,7 +32,9 @@ import { L1CrossDomainMessenger } from "@eth-optimism/contracts/L1/messaging/L1C
 ```
 
 ## Guide for Developers
+
 ### Setup
+
 Install the following:
 - [`Node.js` (14+)](https://nodejs.org/en/)
 - [`npm`](https://www.npmjs.com/get-npm)
@@ -46,107 +48,105 @@ cd contracts
 ```
 
 Install `npm` packages:
+
 ```shell
 yarn install
 ```
 
 ### Running Tests
+
 Tests are executed via `yarn`:
+
 ```shell
 yarn test
 ```
 
 Run specific tests by giving a path to the file you want to run:
+
 ```shell
 yarn test ./test/path/to/my/test.spec.ts
 ```
 
 ### Measuring test coverage:
+
 ```shell
 yarn test:coverage
 ```
 
 The output is most easily viewable by opening the html file in your browser:
+
 ```shell
 open ./coverage/index.html
 ```
 
 ### Compiling and Building
-Easiest way is to run the primary build script:
-```shell
-yarn build
-```
 
-Running the full build command will perform the following actions:
-1. `build:contracts` - Compile all Solidity contracts with both the EVM and OVM compilers.
-2. `build:typescript` - Builds the typescript files that are used to export utilities into js.
-3. `build:copy` - Copies various other files into the dist folder.
-4. `build:dump` - Generates a genesis state from the contracts that L2 geth will use.
-5. `build:typechain` - Generates [TypeChain](https://github.com/ethereum-ts/TypeChain) artifacts.
+Compile and build the various required with the `build` command:
 
-You can also build specific components as follows:
 ```shell
-yarn build:contracts
+yarn build
 ```
 
 ### Deploying the Contracts
 
 #### Required environment variables
 
-You must set the following environment variables to execute a deployment:
-
-```bash
-# Name for the network to deploy to ("mainnet", "kovan", etc.)
-export CONTRACTS_TARGET_NETWORK=...
-
-# Private key that will send deployment transactions
-export CONTRACTS_DEPLOYER_KEY=...
+You must set several required environment variables before you can execute a deployment.
+Duplicate the file [`.env.example`](./.env.example) and rename your duplicate to `.env`.
+Fill out each of the environment variables before continuing.
 
-# RPC URL connected to the L1 chain we're deploying to
-export CONTRACTS_RPC_URL=...
+#### Creating a deployment configuration
 
-# Your Etherscan API key for the L1 network
-export ETHERSCAN_API_KEY=...
-```
-
-#### Creating a deployment script
+Before you can carry out a deployment, you must create a deployment configuration file inside of the [deploy-config](./deploy-config/) folder.
+Deployment configuration files are TypeScript files that export an object that conforms to the `DeployConfig` type.
+See [mainnet.ts](./deploy-config/mainnet.ts) for an example deployment configuration.
+We recommend duplicating an existing deployment config and modifying it to satisfy your requirements.
 
-Before you can carry out a deployment, you must create a deployment script.
-See [mainnet.sh](./scripts/deploy-scripts/mainnet.sh) for an example deployment script.
-We recommend duplicating an existing deployment script and modifying it to satisfy your requirements.
+#### Executing a deployment
 
-Most variables within the deploy script are relatively self-explanatory.
-If you intend to upgrade an existing system you **MUST** [include the following argument](https://github.com/ethereum-optimism/optimism/blob/6f633f915b34a46ac14430724bed9722af8bd05e/packages/contracts/scripts/deploy-scripts/mainnet.sh#L33) in the deploy script:
+Once you've created your deploy config, you can execute a deployment with the following command:
 
 ```
---tags upgrade
+npx hardhat deploy --network <my network name>
 ```
 
-If you are deploying a system from scratch, you should **NOT** include `--tags upgrade` or you will fail to deploy several contracts.
+Note that this only applies to fresh deployments.
+If you want to upgrade an existing system (instead of deploying a new system from scratch), you must use the following command instead:
 
-#### Executing a deployment
+```
+npx hardhat deploy --network <my network name> --tags upgrade
+```
 
-Once you've created your deploy script, simply run the script to trigger a deployment.
 During the deployment process, you will be asked to transfer ownership of several contracts to a special contract address.
 You will also be asked to verify various configuration values.
 This is a safety mechanism to make sure that actions within an upgrade are performed atomically.
 Ownership of these addresses will be automatically returned to the original owner address once the upgrade is complete.
 The original owner can always recover ownership from the upgrade contract in an emergency.
 Please read these instructions carefully, verify each of the presented configuration values, and carefully confirm that the contract you are giving ownership to has not been compromised (e.g., check the code on Etherscan).
 
-After your deployment is complete, your new contracts will be written to an artifacts directory in `./deployments/<name>`.
-Your contracts will also be automatically verified as part of the deployment script.
+After your deployment is complete, your new contracts will be written to an artifacts directory in `./deployments/<my network name>`.
+
+#### Verifying contract source code
+
+Contracts will be automatically verified via both [Etherscan](https://etherscan.io) and [Sourcify](https://sourcify.dev/) during the deployment process.
+If there was an issue with verification during the deployment, you can manually verify your contracts with the command:
+
+```
+npx hardhat etherscan-verify --network <my network name>
+```
 
 #### Creating a genesis file
 
 Optimism expects that certain contracts (called "predeploys") be deployed to the L2 network at pre-determined addresses.
-Doing this requires that you generate a special genesis file to be used by your corresponding L2Geth nodes.
-You must first create a genesis generation script.
-Like in the deploy script, we recommend starting from an [existing script](./scripts/deploy-scripts/mainnet-genesis.sh).
-Modify each of the values within this script to match the values of your own deployment, taking any L1 contract addresses from the `./deployments/<name>` folder that was just generated or modified.
+We guarantee this by creating a genesis file in which certain contracts are already within the L2 state at the genesis block.
+To create the genesis file for your network, you must first deploy the L1 contracts using the appropriate commands from above.
+Once you've deployed your contracts, run the following command:
+
+```
+npx hardhat take-dump --network <my network name>
+```
 
-Execute this script to generate the genesis file.
-You will find this genesis file at `./dist/dumps/state-dump.latest.json`.
+A genesis file will be created for you at `/genesis/<my network name>.json`.
 You can then ingest this file via `geth init`.
 
 ### Hardhat tasks

packages/contracts/deploy-config/goerli.ts

@@ -0,0 +1,20 @@
+import { DeployConfig } from '../src/deploy-config'
+
+const config: DeployConfig = {
+  network: 'goerli',
+  l1BlockTimeSeconds: 15,
+  l2BlockGasLimit: 15_000_000,
+  l2ChainId: 420,
+  ctcL2GasDiscountDivisor: 32,
+  ctcEnqueueGasCost: 60_000,
+  sccFaultProofWindowSeconds: 604800,
+  sccSequencerPublishWindowSeconds: 12592000,
+  ovmSequencerAddress: '0xB79f76EF2c5F0286176833E7B2eEe103b1CC3244',
+  ovmProposerAddress: '0x9A2F243c605e6908D96b18e21Fb82Bf288B19EF3',
+  ovmBlockSignerAddress: '0x27770a9694e4B4b1E130Ab91Bc327C36855f612E',
+  ovmFeeWalletAddress: '0xB79f76EF2c5F0286176833E7B2eEe103b1CC3244',
+  ovmAddressManagerOwner: '0x32b70c156302d28A9119445d2bbb9ab1cBD01671',
+  ovmGasPriceOracleOwner: '0x84f70449f90300997840eCb0918873745Ede7aE6',
+}
+
+export default config