Merge pull request #51 from axieinfinity/release/v0.2.0

chore: merge all features from 'release/v0.2.0'

Author: TuDo1403

.broadcast.env.example

@@ -0,0 +1,12 @@
+# Fork block number to debug
+BLOCK=0x0
+# Caller
+FROM=0x0000000000000000000000000000000000000000
+# Callee
+TO=0x0000000000000000000000000000000000000000
+# Sent Value
+VALUE=0
+# Gas Amount
+GAS=0
+# Call Data
+CALLDATA=0x0

.debug.env.example

@@ -5,6 +5,8 @@ FROM=0x0000000000000000000000000000000000000000
 # Callee
 TO=0x0000000000000000000000000000000000000000
 # Sent Value
-VALUE=0x27cdb0997a65b2de99
+VALUE=0
+# Gas Amount
+GAS=0
 # Call Data
 CALLDATA=0x0

broadcast.sh

@@ -0,0 +1,31 @@
+# Source (or "dot") the .env file to load environment variables
+if [ -f .env ]; then
+    source .broadcast.env
+else
+    echo "Error: .broadcast.env file not found."
+fi
+
+verify_arg=""
+extra_argument=""
+
+for arg in "$@"; do
+    case $arg in
+    --trezor)
+        extra_argument+=trezor@
+        ;;
+    *) ;;
+    esac
+done
+
+# Remove the @ character from the end of extra_argument
+extra_argument="${extra_argument%%@}"
+
+echo Broadcast Tx...
+echo From: ${FROM}
+echo To: ${TO}
+echo Value: ${VALUE}
+echo GasAmount: ${GAS}
+echo Calldata:
+cast pretty-calldata ${CALLDATA}
+calldata=$(cast calldata 'broadcast(address,address,uint256,uint256,bytes)' ${FROM} ${TO} ${GAS} ${VALUE} ${CALLDATA})
+forge script ${verify_arg} ${@} -g 200 OnchainExecutor --sig 'run(bytes,string)' ${calldata} "${extra_argument}"

debug.sh

@@ -7,21 +7,12 @@ fi
 
 verify_arg=""
 extra_argument=""
-op_command="op run --env-file="./.env" --"
 
 for arg in "$@"; do
     case $arg in
     --trezor)
-        op_command=""
         extra_argument+=trezor@
         ;;
-    --broadcast)
-        op_command="op run --env-file="./.env" --"
-        ;;
-    --log)
-        set -- "${@/#--log/}"
-        extra_argument+=log@
-        ;;
     *) ;;
     esac
 done
@@ -33,7 +24,8 @@ echo Debug Tx...
 echo From: ${FROM}
 echo To: ${TO}
 echo Value: ${VALUE}
+echo GasAmount: ${GAS}
 echo Calldata:
 cast pretty-calldata ${CALLDATA}
-calldata=$(cast calldata 'trace(uint256,address,address,uint256,bytes)' ${BLOCK} ${FROM} ${TO} ${VALUE} ${CALLDATA})
-${op_command} forge script ${verify_arg} --legacy ${@} OnchainDebugger --sig 'run(bytes,string)' ${calldata} "${extra_argument}"
+calldata=$(cast calldata 'trace(uint256,address,address,uint256,uint256,bytes)' ${BLOCK} ${FROM} ${TO} ${GAS} ${VALUE} ${CALLDATA})
+forge script ${verify_arg} --legacy ${@} OnchainExecutor --sig 'run(bytes,string)' ${calldata} "${extra_argument}"

lib/forge-std

@@ -1,17 +1,11 @@
 verify_arg=""
 extra_argument=""
-op_command="op run --env-file="./.env" --"
 
 for arg in "$@"; do
     case $arg in
     --trezor)
-        op_command=""
         extra_argument+=trezor@
         ;;
-    --broadcast)
-        op_command="op run --env-file="./.env" --"
-        # verify_arg="--verify --verifier sourcify --verifier-url https://sourcify.roninchain.com/server/"
-        ;;
     --log)
         set -- "${@/#--log/}"
         extra_argument+=log@
@@ -24,4 +18,4 @@ done
 extra_argument="${extra_argument%%@}"
 
 calldata=$(cast calldata 'run()')
-${op_command} forge script ${verify_arg} --legacy ${@} --sig 'run(bytes,string)' ${calldata} "${extra_argument}"
+forge script ${verify_arg} ${@} -g 200 --sig 'run(bytes,string)' ${calldata} "${extra_argument}"

lib/solady

@@ -1,10 +1,9 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.19;
 
-import { Vm } from "../lib/forge-std/src/Vm.sol";
+import { Vm, VmSafe } from "../lib/forge-std/src/Vm.sol";
 import { StdStyle } from "../lib/forge-std/src/StdStyle.sol";
 import { console2 as console } from "../lib/forge-std/src/console2.sol";
-import { LibString } from "../lib/solady/src/utils/LibString.sol";
 import { WalletConfig } from "./configs/WalletConfig.sol";
 import { RuntimeConfig } from "./configs/RuntimeConfig.sol";
 import { MigrationConfig } from "./configs/MigrationConfig.sol";
@@ -17,11 +16,8 @@ import { LibSharedAddress } from "./libraries/LibSharedAddress.sol";
 
 contract BaseGeneralConfig is RuntimeConfig, WalletConfig, ContractConfig, NetworkConfig, MigrationConfig {
   using StdStyle for string;
-  using LibString for string;
   using EnumerableSet for EnumerableSet.AddressSet;
 
-  Vm internal constant vm = Vm(LibSharedAddress.VM);
-
   fallback() external {
     if (msg.sig == ISharedParameter.sharedArguments.selector) {
       bytes memory returnData = getRawSharedArguments();
@@ -91,19 +87,12 @@ contract BaseGeneralConfig is RuntimeConfig, WalletConfig, ContractConfig, Netwo
   }
 
   function _setUpDefaultSender() private {
-    // by default we will read private key from .env
-    _envPk = vm.envUint(getPrivateKeyEnvLabel(getCurrentNetwork()));
-    _envSender = vm.rememberKey(_envPk);
-
-    label(block.chainid, _envSender, "ENVSender");
-    console.log("GeneralConfig:", vm.getLabel(_envSender));
-
     _setUpSender();
   }
 
   function getSender() public view virtual override returns (address payable sender) {
     sender = _option.trezor ? payable(_trezorSender) : payable(_envSender);
-    require(sender != address(0), "GeneralConfig: Sender is address(0x0)");
+    require(sender != address(0x0), "GeneralConfig: Sender is address(0x0)");
   }
 
   function setAddress(TNetwork network, TContract contractType, address contractAddr) public virtual {
@@ -127,10 +116,14 @@ contract BaseGeneralConfig is RuntimeConfig, WalletConfig, ContractConfig, Netwo
 
   function _handleRuntimeConfig() internal virtual override {
     if (_option.trezor) {
-      string memory str = vm.envString(deployerEnvLabel());
-      _trezorSender = vm.parseAddress(str.replace(trezorPrefix(), ""));
+      _loadTrezorAccount();
       label(block.chainid, _trezorSender, "TrezorSender");
-      console.log("GeneralConfig:", vm.getLabel(_trezorSender));
+      console.log("GeneralConfig:", vm.getLabel(_trezorSender), "Enabled!");
+    } else {
+      string memory envLabel = getPrivateKeyEnvLabel(getCurrentNetwork());
+      _loadENVAccount(envLabel);
+      label(block.chainid, _envSender, "ENVSender");
+      console.log("GeneralConfig:", vm.getLabel(_envSender), "Enabled!");
     }
   }
 }

run.sh

@@ -9,14 +9,14 @@ import {
 import { LibString } from "../lib/solady/src/utils/LibString.sol";
 import { console, LibSharedAddress, StdStyle, IScriptExtended, ScriptExtended } from "./extensions/ScriptExtended.s.sol";
 import { IArtifactFactory, ArtifactFactory } from "./ArtifactFactory.sol";
-import { OnchainDebugger } from "./OnchainDebugger.s.sol"; // cheat to load artifact to parent `out` directory
+import { OnchainExecutor } from "./OnchainExecutor.s.sol"; // cheat to load artifact to parent `out` directory
 import { IMigrationScript } from "./interfaces/IMigrationScript.sol";
 import { LibProxy } from "./libraries/LibProxy.sol";
 import { DefaultContract } from "./utils/DefaultContract.sol";
 import { TContract } from "./types/Types.sol";
 
 abstract contract BaseMigration is ScriptExtended {
-  using StdStyle for string;
+  using StdStyle for *;
   using LibString for bytes32;
   using LibProxy for address payable;
 
@@ -232,6 +232,7 @@ abstract contract BaseMigration is ScriptExtended {
   function _upgradeRaw(address proxyAdmin, address payable proxy, address logic, bytes memory args) internal virtual {
     ITransparentUpgradeableProxy iProxy = ITransparentUpgradeableProxy(proxy);
     ProxyAdmin wProxyAdmin = ProxyAdmin(proxyAdmin);
+
     // if proxyAdmin is External Owned Wallet
     if (proxyAdmin.code.length == 0) {
       vm.broadcast(proxyAdmin);
@@ -240,31 +241,91 @@ abstract contract BaseMigration is ScriptExtended {
     } else {
       try wProxyAdmin.owner() returns (address owner) {
         if (args.length == 0) {
-          // try `upgrade` function
+          // try `upgrade(address,address)` function
           vm.prank(owner);
           (bool success,) = proxyAdmin.call(abi.encodeCall(ProxyAdmin.upgrade, (iProxy, logic)));
           if (success) {
-            vm.broadcast(owner);
-            wProxyAdmin.upgrade(iProxy, logic);
+            if (owner.code.length != 0) {
+              _cheatUpgrade(owner, wProxyAdmin, iProxy, logic);
+            } else {
+              vm.broadcast(owner);
+              wProxyAdmin.upgrade(iProxy, logic);
+            }
           } else {
             console.log(
-              StdStyle.yellow(
-                "`ProxyAdmin:upgrade` failed!. Retrying with `ProxyAdmin:upgradeAndCall` with emty args..."
-              )
+              "`ProxyAdmin:upgrade` failed!. Retrying with `ProxyAdmin:upgradeAndCall` with emty args...".yellow()
             );
+            if (owner.code.length != 0) {
+              _cheatUpgradeAndCall(owner, wProxyAdmin, iProxy, logic, args);
+            } else {
+              vm.broadcast(owner);
+              wProxyAdmin.upgradeAndCall(iProxy, logic, args);
+            }
+          }
+        } else {
+          if (owner.code.length != 0) {
+            _cheatUpgradeAndCall(owner, wProxyAdmin, iProxy, logic, args);
+          } else {
             vm.broadcast(owner);
             wProxyAdmin.upgradeAndCall(iProxy, logic, args);
           }
-        } else {
-          vm.broadcast(owner);
-          wProxyAdmin.upgradeAndCall(iProxy, logic, args);
         }
       } catch {
         revert("BaseMigration: Unknown ProxyAdmin contract!");
       }
     }
   }
 
+  function _cheatUpgrade(address owner, ProxyAdmin wProxyAdmin, ITransparentUpgradeableProxy iProxy, address logic)
+    internal
+    virtual
+  {
+    bytes memory callData = abi.encodeCall(ProxyAdmin.upgrade, (iProxy, logic));
+    console.log(
+      "------------------------------------------------------------------------------- Multi-Sig Proposal -------------------------------------------------------------------------------"
+    );
+    console.log("To:".cyan(), vm.getLabel(address(wProxyAdmin)));
+    console.log(
+      "Method:\n".cyan(),
+      string.concat(" - upgrade(address,address)\n  - ", vm.getLabel(address(iProxy)), "\n  - ", vm.getLabel(logic))
+    );
+    console.log("Raw Calldata Data:\n".cyan(), string.concat(" - ", vm.toString(callData)));
+    console.log(
+      "----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------"
+    );
+
+    // cheat prank to update `implementation slot` for next call
+    vm.prank(owner);
+    wProxyAdmin.upgrade(iProxy, logic);
+  }
+
+  function _cheatUpgradeAndCall(
+    address owner,
+    ProxyAdmin wProxyAdmin,
+    ITransparentUpgradeableProxy iProxy,
+    address logic,
+    bytes memory args
+  ) internal virtual {
+    bytes memory callData = abi.encodeCall(ProxyAdmin.upgradeAndCall, (iProxy, logic, args));
+    console.log(
+      "------------------------------------------------------------------------------- Multi-Sig Proposal -------------------------------------------------------------------------------"
+    );
+    console.log("To:".cyan(), vm.getLabel(address(wProxyAdmin)));
+    console.log(
+      "Method:\n".cyan(),
+      " - upgradeAndCall(address,address,bytes)\n",
+      string.concat(" - ", vm.getLabel(address(iProxy)), "\n  - ", vm.getLabel(logic), "\n  - ", vm.toString(args))
+    );
+    console.log("Raw Call Data:\n".cyan(), " - ", vm.toString(callData));
+    console.log(
+      "----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------"
+    );
+
+    // cheat prank to update `implementation slot` for next call
+    vm.prank(owner);
+    wProxyAdmin.upgradeAndCall(iProxy, logic, args);
+  }
+
   function _setDependencyDeployScript(TContract contractType, IScriptExtended deployScript) internal virtual {
     _deployScript[contractType] = IMigrationScript(address(deployScript));
   }