template for gas & elasticity increase

Makefile

@@ -2,6 +2,7 @@ FOUNDRY_COMMIT ?= 3b1129b5bc43ba22a9bcf4e4323c5a9df0023140
 
 PROJECT_DIR = $(network)/$(shell date +'%Y-%m-%d')-$(task)
 GAS_INCREASE_DIR = $(network)/$(shell date +'%Y-%m-%d')-increase-gas-limit
+GAS_AND_ELASTICITY_INCREASE_DIR = $(network)/$(shell date +'%Y-%m-%d')-increase-gas-and-elasticity-limit
 FAULT_PROOF_UPGRADE_DIR = $(network)/$(shell date +'%Y-%m-%d')-upgrade-fault-proofs
 SAFE_MANAGEMENT_DIR = $(network)/$(shell date +'%Y-%m-%d')-safe-swap-owner
 FUNDING_DIR = $(network)/$(shell date +'%Y-%m-%d')-funding
@@ -10,6 +11,7 @@ PAUSE_BRIDGE_BASE_DIR = $(network)/$(shell date +'%Y-%m-%d')-pause-bridge-base
 
 TEMPLATE_GENERIC = setup-templates/template-generic
 TEMPLATE_GAS_INCREASE = setup-templates/template-gas-increase
+TEMPLATE_GAS_AND_ELASTICITY_INCREASE = setup-templates/template-gas-and-elasticity-increase
 TEMPLATE_UPGRADE_FAULT_PROOFS = setup-templates/template-upgrade-fault-proofs
 TEMPLATE_SAFE_MANAGEMENT = setup-templates/template-safe-management
 TEMPLATE_FUNDING = setup-templates/template-funding
@@ -39,6 +41,11 @@ setup-gas-increase:
 	rm -rf $(TEMPLATE_GAS_INCREASE)/cache $(TEMPLATE_GAS_INCREASE)/lib $(TEMPLATE_GAS_INCREASE)/out
 	cp -r $(TEMPLATE_GAS_INCREASE) $(GAS_INCREASE_DIR)
 
+# Run `make setup-gas-increase network=<network>`
+setup-gas-and-elasticity-increase:
+	rm -rf $(TEMPLATE_GAS_AND_ELASTICITY_INCREASE)/cache $(TEMPLATE_GAS_AND_ELASTICITY_INCREASE)/lib $(TEMPLATE_GAS_AND_ELASTICITY_INCREASE)/out
+	cp -r $(TEMPLATE_GAS_AND_ELASTICITY_INCREASE) $(GAS_AND_ELASTICITY_INCREASE_DIR)
+
 # Run `make setup-upgrade-fault-proofs network=<network>`
 setup-upgrade-fault-proofs:
 	cp -r $(TEMPLATE_UPGRADE_FAULT_PROOFS) $(FAULT_PROOF_UPGRADE_DIR)
@@ -112,7 +119,7 @@ checkout-base-contracts-commit:
 ##
 # Task Signer Tool
 ##
-SIGNER_TOOL_COMMIT=92a4b600252cd7ffe255a876a880c2540802b99c
+SIGNER_TOOL_COMMIT=63df22556bb41f6a1fd14f90da2809a7c4e5fe8a
 SIGNER_TOOL_PATH=signer-tool
 
 .PHONY: checkout-signer-tool

README.md

@@ -37,18 +37,18 @@ To execute a new task, run one of the following commands (depending on the type
 
 - For a generic task: `make setup-task network=<network> task=<task-name>`
 - For gas increase tasks: `make setup-gas-increase network=<network>`
+- For combined gas and elasticity increase tasks: `make setup-gas-and-elasticity-increase network=<network>`
 - For funding: `make setup-funding network=<network>`
 - For fault proof upgrade: `make setup-upgrade-fault-proofs network=<network>`
 - For safe management tasks: `make setup-safe-management network=<network>`
-- For funding tasks: `make setup-funding network=<network>`
 - For updating the partner threshold in Base Bridge: `make setup-bridge-partner-threshold network=<network>`
 - For pausing / un-pausing Base Bridge: `make setup-bridge-pause network=<network>`
 
 Next, `cd` into the directory that was created for you and follow the steps listed below for the relevant template.
 
 > **👥 For Signers:** Please read the [Signer Guide](SIGNER.md) for step-by-step instructions on using the validation UI.
 
-Please note, you will need to manually create validation file(s) for your task as they are bespoke to each task and therefore not created automatically as a part of the templates. We use one validation Markdown file per multisig involved in the task, so if there's only one multisig involved in your task, then you can simply create a `VALIDATION.md` file at the root of your task containing the validation instructions, while if there are multiple multisigs involved in the task, then create a `validations/` sub-directory at the root of your task containing the corresponding validation Markdown files. If you need examples to work from, you can browse through similar past tasks in this repo and adapt them to your specific task. Also, please note that we have tooling to generate these files (like the `task-signer-tool`) which removes the manual aspect of creating these validation files, we will soon update these instructions to reflect how this process can be automated.
+Please note, for some older tasks (that have not yet been adapted to use the signer tool) you will need to manually create validation file(s) for your task as they are bespoke to each task and therefore not created automatically as a part of the templates. We use one validation Markdown file per multisig involved in the task, so if there's only one multisig involved in your task, then you can simply create a `VALIDATION.md` file at the root of your task containing the validation instructions, while if there are multiple multisigs involved in the task, then create a `validations/` sub-directory at the root of your task containing the corresponding validation Markdown files. If you need examples to work from, you can browse through similar past tasks in this repo and adapt them to your specific task. Also, please note that we have tooling to generate these files (like the `task-signer-tool`) which removes the manual aspect of creating these validation files, we will soon update these instructions to reflect how this process can be automated.
 
 ## Directory structure
 
@@ -96,6 +96,23 @@ This template is increasing the throughput on Base Chain.
 1. Check in the task when it's ready to sign and collect signatures from signers
 1. Once executed, check in the records files and mark the task `EXECUTED` in the README.
 
+## Using the combined gas limit and elasticity increase template
+
+This template is used to increase the gas limit and elasticity or roll back the upgrade (if needed).
+
+1. Ensure you have followed the instructions above in `setup`, including running `make setup-gas-and-elasticity-increase network=<network>` and then go to the folder that was created by this command.
+1. Specify the commit of [Optimism code](https://github.com/ethereum-optimism/optimism) and [Base contracts code](https://github.com/base/contracts), and the new / old gas limit and elasticity, as well the other env vars marked with a TODO, in the `.env` file.
+1. Run `make deps`.
+1. Ensure only the Sepolia or Mainnet variables are in the `.env` file depending on what network this task is for.
+1. Ensure the `SENDER` variable in the `.env` file is set to a signer of `OWNER_SAFE`.
+1. Build the contracts with `forge build`.
+1. Generate the validation file for signers with `make gen-validation`.
+1. Generate the rollback validation file for signers with `make gen-validation-rollback`.
+1. Double check the `cmd` field at the top of both of the generated validation files and ensure that the value passed to the `--sender` flag matches the `SENDER` env var already defined in the `.env` file.
+1. Ensure that all of the fields marked as `TODO` in the tasks's `README.md` have been properly filled out.
+1. Check in the task when it's ready to sign and request the facilitators to collect signatures from signers.
+1. Once executed, check in the records files and mark the task `EXECUTED` in the README.
+
 ## Using the fault proof upgrade template
 
 This template is used to upgrade the fault proof contracts. This is commonly done in conjunction with a hard fork.

setup-templates/template-gas-and-elasticity-increase/.env

@@ -0,0 +1,20 @@
+OP_COMMIT=TODO # Recommend using the version of https://github.com/ethereum-optimism/optimism that the current SystemConfig contract is on
+BASE_CONTRACTS_COMMIT=TODO # Recommend using the latest version of https://github.com/base-org/contracts
+
+# TODO: ensure `SYSTEM_CONFIG` is correct on the given network
+SYSTEM_CONFIG=0x73a79Fab69143498Ed3712e519A88a918e1f4072
+# TODO: ensure `OWNER_SAFE` is correct on the given network
+OWNER_SAFE=0x14536667Cd30e52C0b458BaACcB9faDA7046E056
+
+# TODO: ensure the current and future gas limits are set properly
+OLD_GAS_LIMIT=TODO
+NEW_GAS_LIMIT=TODO
+
+# TODO: ensure the current and future elasticities are set properly
+OLD_ELASTICITY=TODO
+NEW_ELASTICITY=TODO
+
+# TODO: ensure `SENDER` is a signer for `OWNER_SAFE` on the given network
+SENDER=0x1841CB3C2ce6870D0417844C817849da64E6e937
+
+RECORD_STATE_DIFF=true

setup-templates/template-gas-and-elasticity-increase/FACILITATOR.md

@@ -0,0 +1,26 @@
+# Facilitator Guide
+
+Guide for facilitators after collecting signatures from signers.
+
+### 1. Update repo:
+
+```bash
+cd contract-deployments
+git pull
+cd mainnet/TODO
+make deps
+```
+
+### 2. Execute upgrade
+
+```bash
+SIGNATURES=AAABBBCCC make execute
+```
+
+### 3. (**ONLY** if needed) Execute upgrade rollback
+
+> [!IMPORTANT] THIS SHOULD ONLY BE PERFORMED IN THE EVENT THAT WE NEED TO ROLLBACK
+
+```bash
+SIGNATURES=AAABBBCCC make execute-rollback
+```

setup-templates/template-gas-and-elasticity-increase/Makefile

@@ -0,0 +1,61 @@
+include ../../Makefile
+include ../../Multisig.mk
+include ../.env
+include .env
+
+ifndef LEDGER_ACCOUNT
+override LEDGER_ACCOUNT = 0
+endif
+
+ifndef ROLLBACK_NONCE_OFFSET
+override ROLLBACK_NONCE_OFFSET = 1
+endif
+
+RPC_URL = $(L1_RPC_URL)
+SCRIPT_NAME = IncreaseEip1559ElasticityAndIncreaseGasLimitScript
+
+.PHONY: gen-validation
+gen-validation: checkout-signer-tool run-script
+
+.PHONY: run-script
+run-script:
+	mkdir validations; \
+	cd $(SIGNER_TOOL_PATH); \
+	npm ci; \
+	bun run scripts/genValidationFile.ts --rpc-url $(L1_RPC_URL) \
+	--workdir .. --forge-cmd 'forge script --rpc-url $(L1_RPC_URL) \
+	$(SCRIPT_NAME) --sig "sign(address[])" [] --sender $(SENDER)' --out ../validations/base-signer-upgrade.json;
+
+.PHONY: execute
+execute:
+	FROM_GAS_LIMIT=$(FROM_GAS_LIMIT) \
+	TO_GAS_LIMIT=$(TO_GAS_LIMIT) \
+	FROM_ELASTICITY=$(FROM_ELASTICITY) \
+	TO_ELASTICITY=$(TO_ELASTICITY) \
+	$(call MULTISIG_EXECUTE,$(SIGNATURES))
+
+# Manually swap the old and new values for the gas limit and elasticity when passing them in for the rollback
+
+.PHONY: gen-validation-rollback
+gen-validation-rollback: checkout-signer-tool run-script-rollback
+
+.PHONY: run-script-rollback
+run-script-rollback:
+	cd $(SIGNER_TOOL_PATH); \
+	npm ci; \
+	bun run scripts/genValidationFile.ts --rpc-url $(RPC_URL) \
+	--workdir .. --forge-cmd 'FROM_GAS_LIMIT=$(TO_GAS_LIMIT) \
+	TO_GAS_LIMIT=$(FROM_GAS_LIMIT) FROM_ELASTICITY=$(TO_ELASTICITY) TO_ELASTICITY=$(FROM_ELASTICITY) \
+	SAFE_NONCE=$(shell expr $$(cast call $(OWNER_SAFE) "nonce()" --rpc-url $(RPC_URL) | cast to-dec) + $(ROLLBACK_NONCE_OFFSET)) \
+	forge script --rpc-url $(RPC_URL) \
+	$(SCRIPT_NAME) --sig "sign(address[])" [] --sender $(SENDER)' --out ../validations/base-signer-rollback.json;
+
+.PHONY: execute-rollback
+execute-rollback:
+	FROM_GAS_LIMIT=$(TO_GAS_LIMIT) \
+	TO_GAS_LIMIT=$(FROM_GAS_LIMIT) \
+	FROM_ELASTICITY=$(TO_ELASTICITY) \
+	TO_ELASTICITY=$(FROM_ELASTICITY) \
+	SAFE_NONCE=$(shell expr $$(cast call $(OWNER_SAFE) "nonce()" --rpc-url $(RPC_URL) | cast to-dec) + $(ROLLBACK_NONCE_OFFSET)) \
+	forge script --rpc-url $(RPC_URL) $(SCRIPT_NAME) \
+	--sig "run(bytes)" $(SIGNATURES) --ledger --hd-paths "m/44'/60'/$(LEDGER_ACCOUNT)'/0/0" --broadcast

setup-templates/template-gas-and-elasticity-increase/README.md

@@ -0,0 +1,88 @@
+# Update Gas Limit & Elasticity in L1 `SystemConfig`
+
+Status: TODO[READY TO SIGN|DONE]
+
+## Description
+
+We are updating the gas limit and elasticity to improve TPS and reduce gas fees.
+
+This runbook invokes the following script which allows our signers to sign the same call with two different sets of parameters for our Incident Multisig, defined in the [base-org/contracts](https://github.com/base/contracts) repository:
+
+`IncreaseEip1559ElasticityAndIncreaseGasLimitScript` -- This script will update the gas limit to our new limit of TODO gas and TODO elasticity if invoked as part of the "upgrade" process, or revert to the old limit of TODO gas and TODO elasticity if invoked as part of the "rollback" process.
+
+The values we are sending are statically defined in the `.env` file.
+
+> [!IMPORTANT] We have two transactions to sign. Please follow
+> the flow for both "Approving the Update transaction" and
+> "Approving the Rollback transaction". Hopefully we only need
+> the former, but will have the latter available if needed.
+
+## Install dependencies
+
+### 1. Update foundry
+
+```bash
+foundryup
+```
+
+### 2. Install Node.js if needed
+
+First, check if you have node installed
+
+```bash
+node --version
+```
+
+If you see a version output from the above command, you can move on. Otherwise, install node
+
+```bash
+brew install node
+```
+
+## Approving the Update transaction
+
+### 1. Update repo:
+
+```bash
+cd contract-deployments
+git pull
+```
+
+### 2. Run the signing tool (NOTE: do not enter the task directory. Run this command from the project's root).
+
+```bash
+make sign-task
+```
+
+### 3. Open the UI at [http://localhost:3000](http://localhost:3000)
+
+Be sure to select the correct task from the list of available tasks to sign (**not** the rollback task).
+
+### 4. Send signature to facilitator
+
+You may now kill the Signer Tool process in your terminal window by running `Ctrl + C`.
+
+## Approving the Rollback transaction
+
+Complete the above steps for `Approving the Update transaction` before continuing below.
+
+### 1. Update repo:
+
+```bash
+cd contract-deployments
+git pull
+```
+
+### 2. Run the signing tool (NOTE: do not enter the task directory. Run this command from the project's root).
+
+```bash
+make sign-task
+```
+
+### 3. Open the UI at [http://localhost:3000](http://localhost:3000)
+
+Be sure to select the correct task from the list of available tasks to sign (ensure it **is** the rollback task).
+
+### 4. Send signature to facilitator
+
+You may now kill the Signer Tool process in your terminal window by running `Ctrl + C`.

setup-templates/template-gas-and-elasticity-increase/foundry.toml

@@ -0,0 +1,20 @@
+[profile.default]
+src = 'src'
+out = 'out'
+libs = ['lib']
+broadcast = 'records'
+fs_permissions = [ {access = "read-write", path = "./"} ]
+optimizer = true
+optimizer_runs = 999999
+solc_version = "0.8.15"
+via-ir = false
+remappings = [
+    '@eth-optimism-bedrock/=lib/optimism/packages/contracts-bedrock/',
+    '@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts',
+    '@openzeppelin/contracts-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts',
+    '@rari-capital/solmate/=lib/solmate/',
+    '@base-contracts/=lib/base-contracts',
+    '@solady/=lib/solady/src/'
+]
+
+# See more config options https://github.com/foundry-rs/foundry/tree/master/config