Contract upgrade tooling: makefile + documentation (#293)

Signed-off-by: Alfonso de la Rocha <[email protected]> Co-authored-by: snissn <[email protected]> Co-authored-by: auto-commit <[email protected]> Co-authored-by: Alfonso de la Rocha <[email protected]> Co-authored-by: adlrocha <[email protected]> Co-authored-by: raulk <[email protected]> Co-authored-by: raulk <[email protected]>
consensus-shipyard · Dec 21, 2023 · 97fb4ea · 97fb4ea
1 parent bf36dba
commit 97fb4ea
Show file tree

Hide file tree

Showing 9 changed files with 96 additions and 93 deletions.
diff --git a/Makefile b/Makefile
@@ -10,6 +10,12 @@ OUTPUT ?= .out
 deploy-ipc:
 	./ops/deploy.sh $(NETWORK)
 
+deploy-subnet-registry:
+	./ops/deploy-subnet-registry.sh $(NETWORK)
+
+deploy-subnet:
+	./ops/deploy-subnet.sh $(NETWORK)
+
 upgrade-gw-diamond:
 	./ops/upgrade-gw-diamond.sh $(NETWORK)
 

diff --git a/README.md b/README.md
@@ -49,6 +49,48 @@ To deploy the contracts in some other network configured in the Hardhat config y
 make deploy-ipc NETWORK=<network-name>
 ```
 
+# Upgrading IPC Solidity Contracts
+
+This repository's contracts use the Diamond pattern for upgradability, allowing new features to be added or issues to be corrected without a full redeployment. The upgrade process is automated and includes bytecode verification to ensure the integrity of the changes.
+
+## Automated Upgrade and Bytecode Verification
+
+When you run an upgrade command, the repository's scripts handle several tasks:
+
+1. **Bytecode Verification**: The scripts fetch the bytecode of the currently deployed contracts on an FEVM-powered IPC network using the details stored in local JSON files in the root directory of the git repository. They compare this with the bytecode generated after applying the intended changes on a temporary Ganache network.
+
+2. **Conditional Upgrades**: If the bytecode verification process detects changes that align with the intended upgrades, the `make` command conditionally triggers other scripts to perform the actual upgrade on the network.
+
+## Upgrade Commands
+
+To upgrade a contract, you may use the following commands. The NETWORK parameter is optional; if not specified, the scripts will default to "auto":
+
+-   **Gateway Diamond Upgrade**:
+
+    ```bash
+    make upgrade-gw-diamond [NETWORK=<network-name>]
+    ```
+
+-   **Subnet Actor Diamond Upgrade**:
+
+    ```bash
+    make upgrade-sa-diamond [NETWORK=<network-name>]
+    ```
+
+-   **Subnet Registry Diamond Upgrade**:
+    ```bash
+    make upgrade-sr-diamond [NETWORK=<network-name>]
+    ```
+
+After running any of these commands, the scripts will provide transaction details for verification. Check the transaction on the appropriate block explorer to confirm the upgrade's success.
+
+## Important Notes
+
+-   The upgrade commands are intended for use by authorized personnel with a deep understanding of the contracts' functionality.
+-   Ensure that your local repository is up to date with the latest contract code and JSON files before initiating an upgrade.
+-   Backup all contract data and thoroughly test any new code in a controlled environment prior to an upgrade.
+-   Monitor the output of the upgrade process carefully for transaction details and to verify its successful completion.
+
 ## Branching Strategy
 
 ### Production branch

diff --git a/hardhat.config.ts b/hardhat.config.ts
@@ -1,14 +1,12 @@
-import { HardhatUserConfig, task } from 'hardhat/config'
-import '@typechain/hardhat'
-import 'hardhat-storage-layout-changes'
-
 import '@nomicfoundation/hardhat-foundry'
 import '@nomiclabs/hardhat-ethers'
-import 'hardhat-deploy'
-import 'hardhat-contract-sizer'
-
+import '@typechain/hardhat'
 import dotenv from 'dotenv'
 import fs from 'fs'
+import 'hardhat-contract-sizer'
+import 'hardhat-deploy'
+import 'hardhat-storage-layout-changes'
+import { HardhatUserConfig, task } from 'hardhat/config'
 import { HardhatRuntimeEnvironment } from 'hardhat/types'
 
 dotenv.config()
@@ -193,27 +191,6 @@ task(
     },
 )
 
-task(
-    'deploy-subnet',
-    'Builds and deploys the SubnetActor contract on the selected network',
-    async (args, hre: HardhatRuntimeEnvironment) => {
-        const network = hre.network.name
-
-        const deployments = await getDeployments(network)
-        const { deploy } = await lazyImport('./scripts/deploy-subnet')
-
-        // remove unused lib
-        delete deployments.libs['StorableMsgHelper']
-
-        const subnetDeployment = await deploy(
-            deployments.Gateway,
-            deployments.libs,
-        )
-
-        await saveDeployments(network, subnetDeployment)
-    },
-)
-
 task(
     'deploy-gw-diamond-and-facets',
     'Builds and deploys Gateway Actor diamond and its facets',

diff --git a/ops/deploy-subnet-registry.sh b/ops/deploy-subnet-registry.sh
@@ -0,0 +1,19 @@
+#!/bin/bash
+# Upgrades IPC Gateway Diamond Facets on an EVM-compatible subnet using hardhat
+set -e
+
+if [ $# -ne 1 ]
+then
+    echo "Expected a single argument with the name of the network to deploy (localnet, calibrationnet, mainnet)"
+    exit 1
+fi
+
+NETWORK=$1
+
+if [ "$NETWORK" = "auto" ]; then
+  echo "[*] Automatically getting chainID for network"
+  source ops/chain-id.sh
+fi
+
+
+npx hardhat deploy-subnet-registry --network ${NETWORK}
diff --git a/ops/deploy-subnet.sh b/ops/deploy-subnet.sh
@@ -0,0 +1,20 @@
+#!/bin/bash
+# Upgrades IPC Gateway Diamond Facets on an EVM-compatible subnet using hardhat
+set -e
+
+if [ $# -ne 1 ]
+then
+    echo "Expected a single argument with the name of the network to deploy (localnet, calibrationnet, mainnet)"
+    exit 1
+fi
+
+NETWORK=$1
+
+if [ "$NETWORK" = "auto" ]; then
+  echo "[*] Automatically getting chainID for network"
+  source ops/chain-id.sh
+fi
+
+
+npx hardhat deploy-sa-diamond-and-facets --network ${NETWORK}
+
diff --git a/scripts/deploy-registry.template.ts b/scripts/deploy-registry.template.ts
@@ -1,5 +1,5 @@
-import { ethers } from 'hardhat'
 import { deployContractWithDeployer, getTransactionFees } from './util'
+import { ethers } from 'hardhat'
 
 const { getSelectors, FacetCutAction } = require('./js/diamond.js')
 

diff --git a/scripts/deploy-sa-diamond.ts b/scripts/deploy-sa-diamond.ts
@@ -1,5 +1,5 @@
-import hre, { ethers } from 'hardhat'
 import { deployContractWithDeployer, getTransactionFees } from './util'
+import hre, { ethers } from 'hardhat'
 
 const { getSelectors, FacetCutAction } = require('./js/diamond.js')
 

diff --git a/scripts/deploy-subnet.ts b/scripts/deploy-subnet.ts
diff --git a/scripts/util.ts b/scripts/util.ts
@@ -1,8 +1,9 @@
 import { SignerWithAddress } from '@nomiclabs/hardhat-ethers/signers'
 import { providers, Wallet, ContractFactory, Contract } from 'ethers'
-import { Contract, ethers } from 'hardhat'
 import ganache from 'ganache'
+import { ethers } from 'hardhat'
 import * as linker from 'solc/linker'
+
 const { getSelectors, FacetCutAction } = require('./js/diamond.js')
 const fs = require('fs')