Add rocketMegapool convenience ABI to upgrade

Author: kanewallmann

contracts/contract/upgrade/RocketUpgradeOneDotFour.sol

@@ -24,7 +24,7 @@ contract RocketUpgradeOneDotFour is RocketBase {
 
     bool public lockedB = false;
     address[18] public addressesB;
-    string[18] public abisB;
+    string[19] public abisB;
 
     // Construct
     constructor(
@@ -50,7 +50,7 @@ contract RocketUpgradeOneDotFour is RocketBase {
     // @notice Sets the B addresses and ABIs of the upgrade
     function setB(
         address[18] memory _addressesB,
-        string[18] memory _abisB
+        string[19] memory _abisB
     ) external {
         require(msg.sender == deployer, "Only deployer can set");
         require(!lockedB, "Already set");
@@ -83,6 +83,9 @@ contract RocketUpgradeOneDotFour is RocketBase {
         _addContract("rocketMegapoolPenalties",               addressesB[15], abisB[15]);
         _addContract("rocketNetworkSnapshotsTime",            addressesB[16], abisB[16]);
 
+        // Add rocketMegapool convenience ABI
+        _addABI("rocketMegapool", abisB[18]);
+
         // Upgrade existing contracts
         _upgradeContract("rocketNodeManager",                 addressesA[4],  abisA[4]);
         _upgradeContract("rocketNodeDeposit",                 addressesA[5],  abisA[5]);
@@ -232,4 +235,20 @@ contract RocketUpgradeOneDotFour is RocketBase {
         setAddress(keccak256(abi.encodePacked("contract.address", _name)), _contractAddress);
         setString(keccak256(abi.encodePacked("contract.abi", _name)), _contractAbi);
     }
+
+    /// @dev Adds a new ABI to the protocol
+    function _addABI(string memory _name, string memory _contractAbi) internal {
+        // Check ABI name
+        bytes32 nameHash = keccak256(abi.encodePacked(_name));
+        require(bytes(_name).length > 0, "Invalid ABI name");
+        // Sanity check
+        require(bytes(_contractAbi).length > 0, "Empty ABI is invalid");
+        // Cannot add ABI if name is already used for an existing network contract
+        require(getAddress(keccak256(abi.encodePacked("contract.address", _name))) == address(0x0), "ABI name is already in use");
+        // Cannot add ABI if ABI already exists for this name (use upgradeABI instead)
+        string memory existingAbi = getString(keccak256(abi.encodePacked("contract.abi", _name)));
+        require(bytes(existingAbi).length == 0, "ABI name is already in use");
+        // Set ABI
+        setString(keccak256(abi.encodePacked("contract.abi", _name)), _contractAbi);
+    }
 }

test-upgrade/_helpers/upgrade.js

@@ -69,6 +69,16 @@ export async function deployUpgrade(rocketStorageAddress) {
         364032n * 32n,  // Electra
     ]
 
+    // Construct ABI for rocketMegapool
+    const rocketMegapoolAbi = []
+        .concat(artifacts.require('RocketMegapoolDelegate').abi)
+        .concat(artifacts.require('RocketMegapoolDelegateBase').abi)
+        .concat(artifacts.require('RocketMegapoolProxy').abi)
+        .filter(i => i.type !== 'fallback' && i.type !== 'receive');
+
+    rocketMegapoolAbi.push({ stateMutability: 'payable', type: 'fallback'});
+    rocketMegapoolAbi.push({ stateMutability: 'payable', type: 'receive'});
+
     // Deploy other contracts
     for (let contract in networkContracts) {
         // Only deploy if it hasn't been deployed already like a precompiled
@@ -179,6 +189,7 @@ export async function deployUpgrade(rocketStorageAddress) {
                         compressABI(networkContracts.rocketMegapoolPenalties.abi),
                         compressABI(networkContracts.rocketNetworkSnapshotsTime.abi),
                         compressABI(networkContracts.rocketDAOProtocolSettingsProposals.abi),
+                        compressABI(rocketMegapoolAbi)
                     ],
                 ];
                 instance = await networkContracts[contract].new(rocketStorageAddress);

test-upgrade/tests/misc-tests.js

@@ -18,6 +18,7 @@ import assert from 'assert';
 import { registerNode } from '../../test/_helpers/node';
 import { userDeposit } from '../../test/_helpers/deposit';
 import { deployMegapool, getMegapoolForNode, getValidatorInfo, nodeDeposit } from '../../test/_helpers/megapool';
+import { decompressABI } from '../../test/_utils/contract';
 
 const helpers = require('@nomicfoundation/hardhat-network-helpers');
 const hre = require('hardhat');
@@ -125,6 +126,10 @@ export default function() {
             assertBN.equal(split[1], '0.09'.ether); // Voter share
             assertBN.equal(split[2], '0'.ether);    // Protocol share
             assertBN.equal(split[3], '0.86'.ether); // User share
+
+            // Check rocketMegapool ABI exists
+            const rocketMegapoolAbi = await rocketStorage.getString(ethers.solidityPackedKeccak256(['string', 'string'], ['contract.abi', 'rocketMegapool']));
+            assert.notEqual(rocketMegapoolAbi.length, 0);
         });
 
         it(printTitle('node', 'can create megapool and deposit from a node registered before upgrade'), async () => {