[ETHEREUM-CONTRACTS] payable macro forwarder (#2025)

Author: d10r

packages/automation-contracts/autowrap/package.json

@@ -4,8 +4,8 @@
     "version": "0.3.0",
     "devDependencies": {
         "@openzeppelin/contracts": "^4.9.6",
-        "@superfluid-finance/ethereum-contracts": "^1.11.0",
-        "@superfluid-finance/metadata": "^1.5.1"
+        "@superfluid-finance/ethereum-contracts": "^1.11.1",
+        "@superfluid-finance/metadata": "^1.5.2"
     },
     "license": "MIT",
     "scripts": {

packages/automation-contracts/scheduler/package.json

@@ -4,8 +4,8 @@
     "version": "1.2.0",
     "devDependencies": {
         "@openzeppelin/contracts": "^4.9.6",
-        "@superfluid-finance/ethereum-contracts": "^1.11.0",
-        "@superfluid-finance/metadata": "^1.5.1"
+        "@superfluid-finance/ethereum-contracts": "^1.11.1",
+        "@superfluid-finance/metadata": "^1.5.2"
     },
     "license": "MIT",
     "scripts": {

packages/ethereum-contracts/CHANGELOG.md

@@ -3,10 +3,11 @@ All notable changes to the ethereum-contracts will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [v1.11.1]
 
 ### Changed
 
+* `MacroForwarder` made payable.
 * `IUserDefinedMacro`: added a method `postCheck()` which allows to verify state changes after running the macro.
 * `SuperfluidFrameworkDeployer` now also deploys and `MacroForwarder` and enables it as trusted forwarder.
 * `deploy-test-environment.js` now deploys fUSDC (the underlying) with 6 decimals (instead of 18) to better resemble the actual USDC.

packages/ethereum-contracts/contracts/interfaces/utils/IUserDefinedMacro.sol

@@ -31,23 +31,16 @@ interface IUserDefinedMacro {
     function postCheck(ISuperfluid host, bytes memory params, address msgSender) external view;
 
     /*
-     * Additional to the required interface, we recommend to implement the following function:
-     * `function getParams(...) external view returns (bytes memory);`
+     * Additional to the required interface, we recommend to implement one or multiple view functions
+     * which take operation specific typed arguments and return the abi encoded bytes.
+     * As a convention, the name of those functions shall start with `params`.
      *
-     * It shall return abi encoded params as required as second argument of `MacroForwarder.runMacro()`.
-     *
-     * The function name shall be `getParams` and the return type shall be `bytes memory`.
-     * The number, type and name of arguments are free to choose such that they best fit the macro use case.
-     *
-     * In conjunction with the name of the Macro contract, the signature should be as self-explanatory as possible.
-     *
-     * Example for a contract `MultiFlowDeleteMacro` which lets a user delete multiple flows in one transaction:
-     * `function getParams(ISuperToken superToken, address[] memory receivers) external view returns (bytes memory)`
-     *
-     *
-     * Implementing this view function has several advantages:
+     * Implementing this view function(s) has several advantages:
+     * - Allows to build more complex macros with internally encapsulated dispatching logic
      * - Allows to use generic tooling like Explorers to interact with the macro
      * - Allows to build auto-generated UIs based on the contract ABI
      * - Makes it easier to interface with the macro from Dapps
+     *
+     * You can consult the related test code in `MacroForwarderTest.t.sol` for examples.
      */
 }

packages/ethereum-contracts/contracts/utils/ForwarderBase.sol

@@ -25,12 +25,20 @@ abstract contract ForwarderBase {
     }
 
     function _forwardBatchCall(ISuperfluid.Operation[] memory ops) internal returns (bool) {
+        return _forwardBatchCallWithValue(ops, 0);
+    }
+
+    function _forwardBatchCallWithValue(ISuperfluid.Operation[] memory ops, uint256 valueToForward)
+        internal
+        returns (bool)
+    {
         bytes memory fwBatchCallData = abi.encodeCall(_host.forwardBatchCall, (ops));
 
         // https://eips.ethereum.org/EIPS/eip-2771
         // we encode the msg.sender as the last 20 bytes per EIP-2771 to extract the original txn signer later on
         // solhint-disable-next-line avoid-low-level-calls
-        (bool success, bytes memory returnedData) = address(_host).call(abi.encodePacked(fwBatchCallData, msg.sender));
+        (bool success, bytes memory returnedData) = address(_host)
+            .call{value: valueToForward}(abi.encodePacked(fwBatchCallData, msg.sender));
 
         if (!success) {
             CallUtils.revertFromReturnedData(returnedData);

packages/ethereum-contracts/contracts/utils/MacroForwarder.sol

@@ -7,8 +7,8 @@ import { ForwarderBase } from "../utils/ForwarderBase.sol";
 
 
 /**
- * @dev This is a trusted forwarder with high degree of extensibility through permission-less and user-defined "macro
- * contracts". This is a vanilla version without EIP-712 support.
+ * @dev This is a minimal version of a trusted forwarder with high degree of extensibility
+ * through permissionless and user-defined "macro contracts".
  */
 contract MacroForwarder is ForwarderBase {
     constructor(ISuperfluid host) ForwarderBase(host) {}
@@ -29,11 +29,12 @@ contract MacroForwarder is ForwarderBase {
      * @dev Run the macro defined by the provided macro contract and params.
      * @param  m      Target macro.
      * @param  params Parameters to run the macro.
+     * If value (native coins) is provided, it is forwarded.
      */
-    function runMacro(IUserDefinedMacro m, bytes calldata params) external returns (bool)
+    function runMacro(IUserDefinedMacro m, bytes calldata params) external payable returns (bool)
     {
         ISuperfluid.Operation[] memory operations = buildBatchOperations(m, params);
-        bool retVal = _forwardBatchCall(operations);
+        bool retVal = _forwardBatchCallWithValue(operations, msg.value);
         m.postCheck(_host, params, msg.sender);
         return retVal;
     }

packages/ethereum-contracts/ops-scripts/deploy-deterministically.js

@@ -21,7 +21,7 @@ const MacroForwarder = artifacts.require("MacroForwarder");
  * @param web3 The web3 instance to be used
  * @param from address to use for funding the deployer account
  *
- * Usage: npx truffle exec ops-scripts/deploy-deterministically.js : {CONTRACT NAME} [{NONCE}]
+ * Usage: npx truffle exec ops-scripts/deploy-deterministically.js : {CONTRACT NAME}
  *        CONTRACT NAME must be one of SuperfluidLoader, AgreementForwarder
  *        If NONCE is not defined, 0 is assumed (-> first tx done from the deployer account)
  *
@@ -32,6 +32,7 @@ const MacroForwarder = artifacts.require("MacroForwarder");
  *        GAS_PRICE: override the estimated gas price
  *        EST_TX_COST: override the estimated tx cost (amount to be sent to deployer)
  *                   for networks with different cost derivation structure (Optimism)
+ *        NONCE: if NONCE is not defined, 0 is assumed (-> first tx done from the deployer account)
  */
 module.exports = eval(`(${S.toString()})()`)(async function (
     args,
@@ -41,18 +42,12 @@ module.exports = eval(`(${S.toString()})()`)(async function (
 
     console.log("======== Deploying deterministically ========");
 
-    let nonce = 0;
-    if (args.length === 2) {
-        nonce = parseInt(args.pop());
-        if (nonce < 0) {
-            console.error("nonce must be >= 0");
-            process.exit(1);
-        }
-    } else if (args.length !== 1) {
+    if (args.length !== 1) {
         throw new Error("Wrong number of arguments");
     }
     const contractName = args.pop();
 
+    const nonce = parseInt(process.env.NONCE) || 0;
     const privKey = process.env.DETERMINISTIC_DEPLOYER_PK;
     const deployer = web3.eth.accounts.privateKeyToAccount(privKey);
     console.log("deployer:", deployer.address);
@@ -100,10 +95,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
 
     const deployerTxCnt = await web3.eth.getTransactionCount(deployer.address);
     if (nonce !== deployerTxCnt) {
-        console.error(
-            `### ERR: requested nonce is ${nonce}, but next usable nonce is ${deployerTxCnt}`
-        );
-        process.exit(1);
+        throw new Error(`### ERR: requested nonce is ${nonce}, but next usable nonce is ${deployerTxCnt}`);
     }
 
     const deployerBalance = await web3.eth.getBalance(deployer.address);

packages/ethereum-contracts/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
-    "version": "1.11.0",
+    "version": "1.11.1",
     "dependencies": {
         "@decentral.ee/web3-helpers": "0.5.3",
         "@nomiclabs/hardhat-ethers": "2.2.3",
@@ -18,7 +18,7 @@
         "@safe-global/safe-service-client": "^2.0.3",
         "@safe-global/safe-web3-lib": "^1.9.4",
         "@superfluid-finance/js-sdk": "^0.6.3",
-        "@superfluid-finance/metadata": "^1.5.1",
+        "@superfluid-finance/metadata": "^1.5.2",
         "async": "^3.2.6",
         "csv-writer": "^1.6.0",
         "ethers": "^5.7.2",

packages/ethereum-contracts/tasks/deploy-macro-forwarder.sh

@@ -1,5 +1,6 @@
 #!/usr/bin/env bash
 set -eu
+set -o pipefail
 
 # Usage:
 # tasks/deploy-macro-forwarder.sh <network>
@@ -23,7 +24,7 @@ source .env
 set -x
 
 network=$1
-expectedContractAddr="0xfD01285b9435bc45C243E5e7F978E288B2912de6"
+expectedContractAddr="0xFD0268E33111565dE546af2675351A4b1587F89F"
 deployerPk=$MACROFWD_DEPLOYER_PK
 
 tmpfile="/tmp/$(basename "$0").addr"
@@ -35,13 +36,18 @@ rm "$tmpfile"
 
 echo "deployed to $contractAddr"
 if [[ $contractAddr != "$expectedContractAddr" ]]; then
-    echo "oh no!"
-    exit
+    echo "contract address not as expected!"
+    if [ -z "$SKIP_ADDRESS_CHECK" ]; then
+        exit
+    fi
 fi
 
 # verify (give it a few seconds to pick up the code)
 sleep 5
+# allow to fail
+set +e
 npx truffle run --network "$network" verify MacroForwarder@"$contractAddr"
+set -e
 
 # set resolver
 ALLOW_UPDATE=1 npx truffle exec --network "$network" ops-scripts/resolver-set-key-value.js : MacroForwarder "$contractAddr"