@superfluid-finance/ethereum-contracts 1.4.1-dev.e675dbc.0 → 1.4.2-dev.e06ddfc.0

package/build/contracts/UUPSUtils.json

@@ -15,15 +15,15 @@
     "absolutePath": "project:/contracts/upgradability/UUPSUtils.sol",
     "exportedSymbols": {
       "UUPSUtils": [
-        37588
+        37600
       ]
     },
-    "id": 37589,
+    "id": 37601,
     "license": "AGPLv3",
     "nodeType": "SourceUnit",
     "nodes": [
       {
-        "id": 37566,
+        "id": 37578,
         "literals": [
           "solidity",
           "0.8",
@@ -39,15 +39,15 @@
         "contractDependencies": [],
         "contractKind": "library",
         "documentation": {
-          "id": 37567,
+          "id": 37579,
           "nodeType": "StructuredDocumentation",
           "src": "60:76:95",
           "text": " @title UUPS (Universal Upgradeable Proxy Standard) Shared Library"
         },
         "fullyImplemented": true,
-        "id": 37588,
+        "id": 37600,
         "linearizedBaseContracts": [
-          37588
+          37600
         ],
         "name": "UUPSUtils",
         "nameLocation": "145:9:95",
@@ -56,17 +56,17 @@
           {
             "constant": true,
             "documentation": {
-              "id": 37568,
+              "id": 37580,
               "nodeType": "StructuredDocumentation",
               "src": "162:288:95",
               "text": " @dev Implementation slot constant.\n Using https://eips.ethereum.org/EIPS/eip-1967 standard\n Storage slot 0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc\n (obtained as bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1))."
             },
-            "id": 37571,
+            "id": 37583,
             "mutability": "constant",
             "name": "_IMPLEMENTATION_SLOT",
             "nameLocation": "481:20:95",
             "nodeType": "VariableDeclaration",
-            "scope": 37588,
+            "scope": 37600,
             "src": "455:115:95",
             "stateVariable": true,
             "storageLocation": "default",
@@ -75,7 +75,7 @@
               "typeString": "bytes32"
             },
             "typeName": {
-              "id": 37569,
+              "id": 37581,
               "name": "bytes32",
               "nodeType": "ElementaryTypeName",
               "src": "455:7:95",
@@ -86,7 +86,7 @@
             },
             "value": {
               "hexValue": "307833363038393461313362613161333231303636376338323834393264623938646361336532303736636333373335613932306133636135303564333832626263",
-              "id": 37570,
+              "id": 37582,
               "isConstant": false,
               "isLValue": false,
               "isPure": true,
@@ -104,7 +104,7 @@
           },
           {
             "body": {
-              "id": 37578,
+              "id": 37590,
               "nodeType": "Block",
               "src": "681:107:95",
               "statements": [
@@ -145,33 +145,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 37571,
+                      "declaration": 37583,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "751:20:95",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 37575,
+                      "declaration": 37587,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "737:4:95",
                       "valueSize": 1
                     }
                   ],
-                  "id": 37577,
+                  "id": 37589,
                   "nodeType": "InlineAssembly",
                   "src": "691:91:95"
                 }
               ]
             },
             "documentation": {
-              "id": 37572,
+              "id": 37584,
               "nodeType": "StructuredDocumentation",
               "src": "577:36:95",
               "text": "@dev Get implementation address."
             },
-            "id": 37579,
+            "id": 37591,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -179,23 +179,23 @@
             "nameLocation": "627:14:95",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 37573,
+              "id": 37585,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "641:2:95"
             },
             "returnParameters": {
-              "id": 37576,
+              "id": 37588,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 37575,
+                  "id": 37587,
                   "mutability": "mutable",
                   "name": "impl",
                   "nameLocation": "675:4:95",
                   "nodeType": "VariableDeclaration",
-                  "scope": 37579,
+                  "scope": 37591,
                   "src": "667:12:95",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -204,7 +204,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 37574,
+                    "id": 37586,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "667:7:95",
@@ -219,7 +219,7 @@
               ],
               "src": "666:14:95"
             },
-            "scope": 37588,
+            "scope": 37600,
             "src": "618:170:95",
             "stateMutability": "view",
             "virtual": false,
@@ -227,7 +227,7 @@
           },
           {
             "body": {
-              "id": 37586,
+              "id": 37598,
               "nodeType": "Block",
               "src": "896:171:95",
               "statements": [
@@ -266,33 +266,33 @@
                   "evmVersion": "london",
                   "externalReferences": [
                     {
-                      "declaration": 37571,
+                      "declaration": 37583,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "988:20:95",
                       "valueSize": 1
                     },
                     {
-                      "declaration": 37582,
+                      "declaration": 37594,
                       "isOffset": false,
                       "isSlot": false,
                       "src": "1026:11:95",
                       "valueSize": 1
                     }
                   ],
-                  "id": 37585,
+                  "id": 37597,
                   "nodeType": "InlineAssembly",
                   "src": "906:155:95"
                 }
               ]
             },
             "documentation": {
-              "id": 37580,
+              "id": 37592,
               "nodeType": "StructuredDocumentation",
               "src": "794:40:95",
               "text": "@dev Set new implementation address."
             },
-            "id": 37587,
+            "id": 37599,
             "implemented": true,
             "kind": "function",
             "modifiers": [],
@@ -300,17 +300,17 @@
             "nameLocation": "848:17:95",
             "nodeType": "FunctionDefinition",
             "parameters": {
-              "id": 37583,
+              "id": 37595,
               "nodeType": "ParameterList",
               "parameters": [
                 {
                   "constant": false,
-                  "id": 37582,
+                  "id": 37594,
                   "mutability": "mutable",
                   "name": "codeAddress",
                   "nameLocation": "874:11:95",
                   "nodeType": "VariableDeclaration",
-                  "scope": 37587,
+                  "scope": 37599,
                   "src": "866:19:95",
                   "stateVariable": false,
                   "storageLocation": "default",
@@ -319,7 +319,7 @@
                     "typeString": "address"
                   },
                   "typeName": {
-                    "id": 37581,
+                    "id": 37593,
                     "name": "address",
                     "nodeType": "ElementaryTypeName",
                     "src": "866:7:95",
@@ -335,19 +335,19 @@
               "src": "865:21:95"
             },
             "returnParameters": {
-              "id": 37584,
+              "id": 37596,
               "nodeType": "ParameterList",
               "parameters": [],
               "src": "896:0:95"
             },
-            "scope": 37588,
+            "scope": 37600,
             "src": "839:228:95",
             "stateMutability": "nonpayable",
             "virtual": false,
             "visibility": "internal"
           }
         ],
-        "scope": 37589,
+        "scope": 37601,
         "src": "137:933:95",
         "usedErrors": []
       }
@@ -360,7 +360,7 @@
   },
   "networks": {},
   "schemaVersion": "3.4.9",
-  "updatedAt": "2022-09-05T13:33:19.193Z",
+  "updatedAt": "2022-09-21T11:06:18.589Z",
   "devdoc": {
     "kind": "dev",
     "methods": {},

package/build/contracts-sizes.txt

@@ -5,7 +5,7 @@ SuperToken.sol : 18114 (6462)
 SuperfluidToken.sol : 2 (24574)
 InstantDistributionAgreementV1.sol : 21380 (3196)
 AgreementLibrary.sol : 143 (24433)
-ConstantFlowAgreementV1.sol : 20582 (3994)
+ConstantFlowAgreementV1.sol : 20609 (3967)
 AgreementBase.sol : 2 (24574)
 SuperfluidGovernanceII.sol : 8155 (16421)
 SuperfluidGovernanceBase.sol : 2 (24574)

package/contracts/agreements/ConstantFlowAgreementV1.sol

@@ -446,7 +446,7 @@ contract ConstantFlowAgreementV1 is
                 ctx, currentContext);
         }
 
-        _requireAvailableBalance(flowVars.token, currentContext);
+        _requireAvailableBalance(flowVars.token, flowVars.sender, currentContext);
     }
 
     function _updateFlow(
@@ -474,7 +474,7 @@ contract ConstantFlowAgreementV1 is
                 ctx, currentContext);
         }
 
-        _requireAvailableBalance(flowVars.token, currentContext);
+        _requireAvailableBalance(flowVars.token, flowVars.sender, currentContext);
     }
 
     function _deleteFlow(
@@ -1221,6 +1221,7 @@ contract ConstantFlowAgreementV1 is
     }
     function _requireAvailableBalance(
         ISuperfluidToken token,
+        address flowSender,
         ISuperfluid.Context memory currentContext
     )
         private view
@@ -1228,7 +1229,7 @@ contract ConstantFlowAgreementV1 is
         // do not enforce balance checks during callbacks for the appCreditToken
         if (currentContext.callType != ContextDefinitions.CALL_INFO_CALL_TYPE_APP_CALLBACK ||
             currentContext.appCreditToken != token) {
-            (int256 availableBalance,,) = token.realtimeBalanceOf(currentContext.msgSender, currentContext.timestamp);
+            (int256 availableBalance,,) = token.realtimeBalanceOf(flowSender, currentContext.timestamp);
             if (availableBalance < 0) {
                 revert SuperfluidErrors.INSUFFICIENT_BALANCE(SuperfluidErrors.CFA_INSUFFICIENT_BALANCE);
             }
@@ -1432,6 +1433,10 @@ contract ConstantFlowAgreementV1 is
         internal pure
         returns (bool)
     {
+        if (signedTotalCFADeposit == 0) {
+            return false;
+        }
+
         int256 totalRewardLeft = availableBalance + signedTotalCFADeposit;
         int256 totalCFAOutFlowrate = signedTotalCFADeposit / int256(liquidationPeriod);
         // divisor cannot be zero with existing outflow

package/contracts/utils/CFAv1Forwarder.sol

@@ -15,6 +15,7 @@ import {
 import { CallUtils } from "../libs/CallUtils.sol";
 
 /**
+ * Contract address: 0xCfA1E187C9141B8bA90a436CB789017FA573d051
  * The CFAv1Forwarder contract provides an easy to use interface to
  * ConstantFlowAgreementV1 specific functionality of Super Tokens.
  * Instances of this contract can operate on the protocol only if configured as "trusted forwarder"
@@ -376,7 +377,7 @@ contract CFAv1Forwarder {
                 )
             );
 
-        _forwardBatchCall(address(_cfa), cfaCallData);
+        _forwardBatchCall(address(_cfa), cfaCallData, new bytes(0));
     }
 
     // compiles the calldata of a single operation for the host invocation and executes it
@@ -405,9 +406,4 @@ contract CFAv1Forwarder {
             CallUtils.revertFromReturnedData(returnedData);
         }
     }
-
-    // invokes_forwardBatchCall with empty userData
-    function _forwardBatchCall(address target, bytes memory callData) internal {
-        _forwardBatchCall(target, callData, new bytes(0));
-    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@superfluid-finance/ethereum-contracts",
-    "version": "1.4.1-dev.e675dbc.0",
+    "version": "1.4.2-dev.e06ddfc.0",
     "description": " Ethereum contracts implementation for the Superfluid Protocol",
     "homepage": "https://github.com/superfluid-finance/protocol-monorepo/tree/dev/packages/ethereum-contracts#readme",
     "repository": {
@@ -27,7 +27,7 @@
         "run-hardhat": "IS_HARDHAT=true hardhat",
         "run-truffle": "IS_TRUFFLE=true truffle",
         "run-forge": "IS_FOUNDRY=true forge",
-        "run-nodemon": "nodemon -e sol,js,ts -i build -x",
+        "run-nodemon": "nodemon -e sol,js,ts -x",
         "build": "run-s build:*",
         "build:contracts": "rm -f build/contracts/*;yarn run-truffle compile",
         "build:hardhat": "yarn run-hardhat compile",
@@ -37,7 +37,7 @@
         "testenv:deploy": "yarn run-truffle exec scripts/deploy-test-environment.js : TEST",
         "pretest": "{ yarn testenv:start > /dev/null& } && sleep 5",
         "test": "run-s test:*:*",
-        "test:contracts:hardhat": "yarn run-hardhat test testsuites/all-contracts.js",
+        "test:contracts:hardhat": "yarn run-hardhat test testsuites/all-contracts.ts",
         "test:contracts:foundry": "yarn run-forge test --hardhat",
         "test:contracts:solc-compatibility": "test/test-solc-compatibility.sh",
         "test:deployment:scripts-js-hardhat": "yarn run-hardhat test test/scripts/deployment.test.js",
@@ -48,6 +48,10 @@
         "lint": "run-s lint:*",
         "lint:sol": "solhint -w 0 contracts/*.sol contracts/*/*.sol && echo '✔  Your .sol files look good.'",
         "lint:js-eslint": "eslint . --max-warnings=0 --report-unused-disable-directives && echo '✔  Your .js files look good.'",
+        "lint-ts": "eslint test -c .eslintrc.ts.json --ext .ts",
+        "lint:ts-eslint": "yarn lint-ts --max-warnings=0 --report-unused-disable-directives && echo '✔  Your .ts files look good.'",
+        "fix": "run-s fix:*",
+        "fix:eslint": "yarn lint-ts --fix",
         "lint:check-no-focused-tests": "grep -FR .only test || { echo 'No test is focused.';exit 0; } && { echo '✘ You have focused tests.'; exit 1; }",
         "pre-commit": "if [ ! -z \"$(git status -s .)\" ];then run-s pre-commit:*;else true;fi",
         "pre-commit:lint": "yarn lint",
@@ -58,21 +62,21 @@
     "dependencies": {
         "@decentral.ee/web3-helpers": "0.5.3",
         "@openzeppelin/contracts": "4.7.3",
-        "@superfluid-finance/js-sdk": "^0.6.4-dev.e675dbc.0",
+        "@superfluid-finance/js-sdk": "0.6.3",
         "@truffle/contract": "4.5.23",
         "ethereumjs-tx": "2.1.2",
         "ethereumjs-util": "7.1.5",
         "stack-trace": "0.0.10"
     },
     "devDependencies": {
-        "@nomiclabs/hardhat-truffle5": "^2.0.6",
+        "@nomiclabs/hardhat-truffle5": "^2.0.7",
         "async": "^3.2.4",
         "csv-writer": "^1.6.0",
         "ganache-time-traveler": "1.0.16",
         "mochawesome": "^7.1.3",
         "readline": "1.3.0",
         "solhint": "3.3.7",
-        "solidity-coverage": "0.7.21",
+        "solidity-coverage": "0.8.0",
         "solidity-docgen": "^0.6.0-beta.25",
         "truffle-flattener": "^1.6.0",
         "truffle-plugin-verify": "0.5.28"

package/scripts/deploy-deterministically.js

@@ -4,7 +4,7 @@ const SuperfluidSDK = require("@superfluid-finance/js-sdk");
 const Resolver = artifacts.require("Resolver");
 
 const SuperfluidLoader = artifacts.require("SuperfluidLoader");
-const AgreementForwarder = artifacts.require("AgreementForwarder");
+const CFAv1Forwarder = artifacts.require("CFAv1Forwarder");
 
 /**
  * @dev Deploy specified contract at a deterministic address (defined by sender, nonce)
@@ -12,16 +12,23 @@ const AgreementForwarder = artifacts.require("AgreementForwarder");
  * In order to make this easy, the script takes a private key of the deployer account and funds it.
  * Recommendation: create a new account (guaranteed to be at nonce 1 everywhere) for the deployer.
  *
+ * Note: fee estimation does currently not work on optimism (mainnet and testnets).
+ * It's unknown how to do an estimation of the overall cost (L1 and L2).
+ * Solution: manually pre-fund the deployer account.
+ *
  * @param web3 The web3 instance to be used
  * @param from address to use for funding the deployer account
  *
- * Usage: npx truffle exec scripts/deploy-deterministically.js : {PRIVATE KEY} {CONTRACT NAME} [{NONCE}]
+ * Usage: npx truffle exec scripts/deploy-deterministically.js : {CONTRACT NAME} [{NONCE}]
  *        CONTRACT NAME must be one of SuperfluidLoader, AgreementForwarder
- *        If NONCE is not defined, 1 is assumed (-> first tx done from the deployer account)
+ *        If NONCE is not defined, 0 is assumed (-> first tx done from the deployer account)
+ *
+ * Required ENV var: DETERMINISTIC_DEPLOYER_PK
  *
  * (optional) ENV vars:
- *        GASLIMIT: override the gas limit for networks with misbehaving estimation (Arbitrum)
- *        ESTTXCOST: override the estimated tx cost (amount to be sent to deployer)
+ *        GAS_LIMIT: override the gas limit for networks with misbehaving estimation
+ *        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)
  */
 module.exports = eval(`(${S.toString()})()`)(async function (
@@ -32,19 +39,19 @@ module.exports = eval(`(${S.toString()})()`)(async function (
 
     console.log("======== Deploying deterministically ========");
 
-    let nonce = 1;
-    if (args.length === 3) {
+    let nonce = 0;
+    if (args.length === 2) {
         nonce = parseInt(args.pop());
-        if (nonce <= 0) {
-            console.error("nonce must be > 0");
+        if (nonce < 0) {
+            console.error("nonce must be >= 0");
             process.exit(1);
         }
-    } else if (args.length !== 2) {
+    } else if (args.length !== 1) {
         throw new Error("Wrong number of arguments");
     }
     const contractName = args.pop();
-    const privKey = args.pop();
 
+    const privKey = process.env.DETERMINISTIC_DEPLOYER_PK;
     const deployer = web3.eth.accounts.privateKeyToAccount(privKey);
     console.log("deployer:", deployer.address);
     console.log("nonce:", nonce);
@@ -67,22 +74,20 @@ module.exports = eval(`(${S.toString()})()`)(async function (
         console.log(
             `setting up SuperfluidLoader for chainId ${chainId}, resolver ${resolverAddr}`
         );
-    } else if (contractName === "AgreementForwarder") {
-        ContractArtifact = AgreementForwarder;
+    } else if (contractName === "CFAv1Forwarder") {
+        ContractArtifact = CFAv1Forwarder;
         deployArgs = [hostAddr];
         console.log(
-            `setting up AgreementForwarder for chainId ${chainId}, host ${hostAddr}`
+            `setting up CFAv1Forwarder for chainId ${chainId}, host ${hostAddr}`
         );
     } else {
         throw new Error("Contract unknown / not supported");
     }
 
     const deployerTxCnt = await web3.eth.getTransactionCount(deployer.address);
-    if (nonce !== deployerTxCnt + 1) {
+    if (nonce !== deployerTxCnt) {
         console.error(
-            `### ERR: requested nonce is ${nonce}, but next usable nonce is ${
-                deployerTxCnt + 1
-            }`
+            `### ERR: requested nonce is ${nonce}, but next usable nonce is ${deployerTxCnt}`
         );
         process.exit(1);
     }
@@ -90,7 +95,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     const deployerBalance = await web3.eth.getBalance(deployer.address);
     console.log("deployer balance:", web3.utils.fromWei(deployerBalance));
 
-    const gasPrice = await web3.eth.getGasPrice();
+    const gasPrice = process.env.GAS_PRICE || (await web3.eth.getGasPrice());
     console.log("gas price:", gasPrice);
 
     const Contract = new web3.eth.Contract(ContractArtifact.abi);
@@ -99,7 +104,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
         arguments: deployArgs,
     });
 
-    const gasLimit = process.env.GASLIMIT || (await deployTx.estimateGas());
+    const gasLimit = process.env.GAS_LIMIT || (await deployTx.estimateGas());
     console.log("gas limit:", gasLimit);
 
     const deployCode = deployTx.encodeABI();
@@ -107,19 +112,24 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     const BN = web3.utils.BN;
     // calc delta between deployer balance and estimated deployment cost
     // On Optimism, this won't reflect the actual cost bcs of missing L1 component, see https://community.optimism.io/docs/developers/build/transaction-fees/#estimating-the-total-fee
-    const estTxCost = process.env.ESTTXCOST
-        ? new BN(process.env.ESTTXCOST)
+    const estTxCost = process.env.EST_TX_COST
+        ? new BN(process.env.EST_TX_COST)
         : new BN(gasLimit).mul(new BN(gasPrice));
     console.log("estimated tx cost:", estTxCost.toString());
     const missingBalance = estTxCost.sub(new BN(deployerBalance));
     if (missingBalance.gt(new BN(0))) {
         console.log("deployer missing balance", missingBalance.toString());
         console.log("sending funding tx...");
-        const fundingTx = await web3.eth.sendTransaction({
+        const fundingTxObj = {
             from: options.from || (await web3.eth.getAccounts())[0],
             to: deployer.address,
             value: missingBalance,
-        });
+        };
+        if (process.env.GAS_PRICE !== undefined) {
+            fundingTxObj.gasPrice = gasPrice;
+        }
+        const fundingTx = await web3.eth.sendTransaction(fundingTxObj);
+
         console.log(
             `funded deployer account in tx ${fundingTx.transactionHash}`
         );
@@ -134,6 +144,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     const unsignedTx = {
         data: deployCode,
         gas: gasLimit,
+        nonce,
     };
     if (hasEip1559) {
         console.log("creating EIP-1559 tx");