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

package/scripts/deploy-framework.js

@@ -1,3 +1,5 @@
+const fs = require("fs");
+const util = require("util");
 const getConfig = require("./libs/getConfig");
 const SuperfluidSDK = require("@superfluid-finance/js-sdk");
 const {web3tx} = require("@decentral.ee/web3-helpers");
@@ -17,6 +19,8 @@ const {
 let resetSuperfluidFramework;
 let resolver;
 
+/// @param deployFunc must return a contract object
+/// @returns the newly deployed or existing loaded contract
 async function deployAndRegisterContractIf(
     Contract,
     resolverKey,
@@ -42,6 +46,8 @@ async function deployAndRegisterContractIf(
     return contractDeployed;
 }
 
+/// @param deployFunc must return a contract address
+/// @returns the address of the newly deployed contract or ZERO_ADDRESS if not deployed
 async function deployContractIf(web3, Contract, cond, deployFunc) {
     let newCodeAddress = ZERO_ADDRESS;
     const contractName = Contract.contractName;
@@ -57,6 +63,8 @@ async function deployContractIf(web3, Contract, cond, deployFunc) {
     return newCodeAddress;
 }
 
+/// @param deployFunc must return a contract address
+/// @returns the address of the newly deployed contract or ZERO_ADDRESS if not deployed
 async function deployContractIfCodeChanged(
     web3,
     Contract,
@@ -88,6 +96,8 @@ async function deployContractIfCodeChanged(
  *                  (overriding env: RESET_SUPERFLUID_FRAMEWORK)
  * @param {boolean} options.protocolReleaseVersion Specify the protocol release version to be used
  *                  (overriding env: RELEASE_VERSION)
+ * @param {boolean} options.outputFile Name of file where to log addresses of newly deployed contracts
+ *                  (overriding env: OUTPUT_FILE)
  *
  * Usage: npx truffle exec scripts/deploy-framework.js
  */
@@ -103,6 +113,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
         nonUpgradable,
         appWhiteListing,
         protocolReleaseVersion,
+        outputFile,
     } = options;
     resetSuperfluidFramework = options.resetSuperfluidFramework;
 
@@ -110,6 +121,12 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
         resetSuperfluidFramework || !!process.env.RESET_SUPERFLUID_FRAMEWORK;
     console.log("reset superfluid framework: ", resetSuperfluidFramework);
 
+    outputFile = outputFile || process.env.OUTPUT_FILE;
+    console.log("output file: ", outputFile);
+
+    // string to build a list of newly deployed contracts, written to a file if "outputFile" option set
+    let output = "";
+
     const networkType = await web3.eth.net.getNetworkType();
     const networkId = await web3.eth.net.getId();
     const chainId = await web3.eth.getChainId();
@@ -117,6 +134,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
     console.log("network ID: ", networkId);
     console.log("chain ID: ", chainId);
     const config = getConfig(chainId);
+    output += `NETWORK_ID=${networkId}\n`;
 
     const CFAv1_TYPE = web3.utils.sha3(
         "org.superfluid-finance.agreements.ConstantFlowAgreement.v1"
@@ -221,7 +239,12 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                 await codeChanged(web3, TestGovernance, contractAddress),
             async () => {
                 governanceInitializationRequired = true;
-                return await web3tx(TestGovernance.new, "TestGovernance.new")();
+                const c = await web3tx(
+                    TestGovernance.new,
+                    "TestGovernance.new"
+                )();
+                output += `SUPERFLUID_GOVERNANCE=${c.address}\n`;
+                return c;
             }
         );
     }
@@ -232,10 +255,12 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
         "SuperfluidLoader-v1",
         async (contractAddress) => contractAddress === ZERO_ADDRESS,
         async () => {
-            return await web3tx(
+            const c = await web3tx(
                 SuperfluidLoader.new,
                 "SuperfluidLoader.new"
             )(resolver.address);
+            output += `SUPERFLUID_LOADER=${c.address}\n`;
+            return c;
         }
     );
 
@@ -255,11 +280,13 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
             console.log(
                 `Superfluid new code address ${superfluidLogic.address}`
             );
+            output += `SUPERFLUID_HOST_LOGIC=${superfluidLogic.address}\n`;
             if (!nonUpgradable) {
                 const proxy = await web3tx(
                     UUPSProxy.new,
                     "Create Superfluid proxy"
                 )();
+                output += `SUPERFLUID_HOST_PROXY=${proxy.address}\n`;
                 await web3tx(
                     proxy.initializeProxy,
                     "proxy.initializeProxy"
@@ -332,8 +359,10 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
             "ConstantFlowAgreementV1.new"
         )(superfluid.address);
         console.log("New ConstantFlowAgreementV1 address", agreement.address);
+        output += `CFA_LOGIC=${agreement.address}\n`;
         return agreement;
     };
+
     if (!(await superfluid.isAgreementTypeListed.call(CFAv1_TYPE))) {
         const cfa = await deployCFAv1();
         await web3tx(
@@ -341,32 +370,26 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
             "Governance registers CFA"
         )(superfluid.address, cfa.address);
     }
-    let linked = false;
-    let lib;
+
     // list IDA v1
-    const deploySlotsBitmapLibrary = async () => {
-        // we have to change this slightly when using hardhat vs. truffle
-        if (process.env.IS_HARDHAT) {
-            if (linked || lib != null) return;
-            lib = await web3tx(
-                SlotsBitmapLibrary.new,
-                "SlotsBitmapLibrary.new"
-            )();
-            InstantDistributionAgreementV1.link(lib);
-            linked = true;
-            return lib.address;
-        } else {
-            const lib = await web3tx(
+    const deployIDAv1 = async () => {
+        const deploySlotsBitmapLibrary = async () => {
+            const slotsBmpLib = await web3tx(
                 SlotsBitmapLibrary.new,
                 "SlotsBitmapLibrary.new"
             )();
-            InstantDistributionAgreementV1.link(
-                "SlotsBitmapLibrary",
-                lib.address
-            );
-        }
-    };
-    const deployIDAv1 = async () => {
+            output += `SLOTS_BITMAP_LIBRARY_ADDRESS=${slotsBmpLib.address}\n`;
+            if (process.env.IS_HARDHAT) {
+                InstantDistributionAgreementV1.link(slotsBmpLib);
+            } else {
+                InstantDistributionAgreementV1.link(
+                    "SlotsBitmapLibrary",
+                    slotsBmpLib.address
+                );
+            }
+            return slotsBmpLib;
+        };
+        // small inefficiency: this may be re-deployed even if not changed
         await deploySlotsBitmapLibrary();
         const agreement = await web3tx(
             InstantDistributionAgreementV1.new,
@@ -376,16 +399,18 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
             "New InstantDistributionAgreementV1 address",
             agreement.address
         );
+        output += `IDA_LOGIC=${agreement.address}\n`;
         return agreement;
     };
+
     if (!(await superfluid.isAgreementTypeListed.call(IDAv1_TYPE))) {
-        await deploySlotsBitmapLibrary();
         const ida = await deployIDAv1();
         await web3tx(
             governance.registerAgreementClass,
             "Governance registers IDA"
         )(superfluid.address, ida.address);
     } else {
+        // link library in order to avoid spurious code change detections
         let slotsBitmapLibraryAddress = ZERO_ADDRESS;
         try {
             slotsBitmapLibraryAddress = await (
@@ -393,20 +418,11 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                     await superfluid.getAgreementClass.call(IDAv1_TYPE)
                 )
             ).SLOTS_BITMAP_LIBRARY_ADDRESS.call();
-        } catch (e) {
-            console.warn("Cannot get slotsBitmapLibrary address", e.toString());
-        }
-        if (
-            (await deployContractIfCodeChanged(
-                web3,
-                SlotsBitmapLibrary,
-                slotsBitmapLibraryAddress,
-                deploySlotsBitmapLibrary
-            )) == ZERO_ADDRESS
-        ) {
-            // code not changed, link with existing library
             if (process.env.IS_HARDHAT) {
-                if (lib) {
+                if (slotsBitmapLibraryAddress !== ZERO_ADDRESS) {
+                    const lib = await SlotsBitmapLibrary.at(
+                        slotsBitmapLibraryAddress
+                    );
                     InstantDistributionAgreementV1.link(lib);
                 }
             } else {
@@ -415,6 +431,8 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                     slotsBitmapLibraryAddress
                 );
             }
+        } catch (e) {
+            console.warn("Cannot get slotsBitmapLibrary address", e.toString());
         }
     }
 
@@ -438,6 +456,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                     SuperfluidLogic.new,
                     "SuperfluidLogic.new"
                 )(nonUpgradable, appWhiteListing);
+                output += `SUPERFLUID_HOST_LOGIC=${superfluidLogic.address}\n`;
                 return superfluidLogic.address;
             }
         );
@@ -533,6 +552,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                 SuperTokenFactoryLogic.new,
                 "SuperTokenFactoryLogic.new"
             )(superfluid.address, helper.address);
+            output += `SUPERFLUID_SUPER_TOKEN_FACTORY_LOGIC=${superTokenFactoryLogic.address}\n`;
             return superTokenFactoryLogic.address;
         }
     );
@@ -569,4 +589,11 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
         );
         console.log(`export RESOLVER_ADDRESS=${process.env.RESOLVER_ADDRESS}`);
     }
+
+    if (outputFile !== undefined) {
+        await util.promisify(fs.writeFile)(outputFile, output);
+        console.log(
+            `List of newly deployed contracts written to ${outputFile}`
+        );
+    }
 });

package/scripts/gov-upgrade-governance.js

@@ -0,0 +1,87 @@
+const SuperfluidSDK = require("@superfluid-finance/js-sdk");
+
+const {
+    getScriptRunnerFactory: S,
+    extractWeb3Options,
+    builtTruffleContractLoader,
+} = require("./libs/common");
+
+/**
+ * @dev Deploy the latest governance logic and initiate an upgrade to it.
+ * Needs the deployed governance contract to implement UUPSProxiable
+ * and owned by a Gnosis Multisig Wallet.
+ * @param {Array} argv Overriding command line arguments
+ * @param {boolean} options.isTruffle Whether the script is used within native truffle framework
+ * @param {Web3} options.web3  Injected web3 instance
+ * @param {Address} options.from Address to deploy contracts from
+ * @param {boolean} options.protocolReleaseVersion Specify the protocol release version to be used
+ *
+ * Usage: npx truffle exec scripts/gov-upgrade-governance.js
+ */
+module.exports = eval(`(${S.toString()})()`)(async function (
+    args,
+    options = {}
+) {
+    console.log("======== Upgrade governance ========");
+    let {protocolReleaseVersion} = options;
+
+    console.log("protocol release version:", protocolReleaseVersion);
+
+    const sf = new SuperfluidSDK.Framework({
+        ...extractWeb3Options(options),
+        version: protocolReleaseVersion,
+        additionalContracts: [
+            "Ownable",
+            "IMultiSigWallet",
+            "SuperfluidGovernanceBase",
+            "SuperfluidGovernanceII",
+        ],
+        contractLoader: builtTruffleContractLoader,
+    });
+    await sf.initialize();
+
+    const gov = await sf.contracts.UUPSProxiable.at(
+        await sf.host.getGovernance.call()
+    );
+    console.log("Governance address:", gov.address);
+
+    // sanity check - do we have an upgradable proxy contract and the right one?
+    try {
+        const uuidIs = await gov.proxiableUUID();
+        const uuidWant = web3.utils.keccak256(
+            "org.superfluid-finance.contracts.SuperfluidGovernanceII.implementation"
+        );
+        if (uuidIs !== uuidWant) {
+            console.error("ERR: governance contract: proxiableUUID mismatch");
+            process.exit(1);
+        }
+    } catch (e) {
+        console.error(
+            "ERR: governance seems not to be an instance of UUPSProxiable"
+        );
+        process.exit(1);
+    }
+
+    // we have the right contract, proceeding with new contract deployment
+    console.log(
+        "Deploying new instance of SuperfluidGovernanceII (gov logic)..."
+    );
+    const govLogic = await sf.contracts.SuperfluidGovernanceII.new();
+    console.log("Deployed to", govLogic.address);
+    await govLogic.castrate();
+    console.log("Marked gov logic as initialized (castrate)");
+
+    // prepare multisig transaction for executing the upgrade
+    const multis = await sf.contracts.IMultiSigWallet.at(
+        await (await sf.contracts.Ownable.at(gov.address)).owner()
+    );
+    console.log("MultiSig address:", multis.address);
+
+    const data = gov.contract.methods.updateCode(govLogic.address).encodeABI();
+    console.log("MultiSig data", data);
+    console.log("Sending governance action to multisig...");
+    await multis.submitTransaction(gov.address, 0, data);
+    console.log(
+        "Governance action sent, but it may still need confirmation(s)."
+    );
+});

package/scripts/info-print-contract-addresses.js

@@ -15,7 +15,7 @@ const {
  * @param {Web3} options.web3  Injected web3 instance
  * @param {Address} options.from Address to deploy contracts from
  *
- * Usage: npx truffle exec scripts/info-print-contract-addresses : output_file
+ * Usage: npx truffle exec scripts/info-print-contract-addresses : {OUTPUT_FILE}
  */
 module.exports = eval(`(${S.toString()})()`)(async function (
     args,

package/scripts/libs/common.js

@@ -193,13 +193,14 @@ async function sendGovernanceAction(sf, actionFn) {
     const gov = await sf.contracts.SuperfluidGovernanceBase.at(
         await sf.host.getGovernance.call()
     );
+    console.log("Governance address:", gov.address);
     switch (process.env.GOVERNANCE_ADMIN_TYPE) {
         case "MULTISIG": {
             console.log("Governance Admin Type: MultiSig");
             const multis = await sf.contracts.IMultiSigWallet.at(
                 await (await sf.contracts.Ownable.at(gov.address)).owner()
             );
-            console.log("MultiSig address: ", multis.address);
+            console.log("MultiSig address:", multis.address);
             const data = actionFn(gov.contract.methods).encodeABI();
             console.log("MultiSig data", data);
             console.log("Sending governance action to multisig...");

package/scripts/libs/getConfig.js

@@ -198,7 +198,7 @@ module.exports = function getConfig(chainId) {
             // governance default configs
             gov_enableAppWhiteListing: true,
             // misc
-            // disableTestGovernance: true,
+            disableTestGovernance: true,
             data: {
                 initialBlockNumber: 14700000,
                 getLogsRange: 50000,