re-deploy avalanche-fuji and deploy eth-sepolia (#1365)

* deploy script adaptations

* mumbai: same default gas settings as mainnet to prevent stuck or failing txs

* more readable verification output, add verification of SuperToken logic (new deploy method)

* remove CFA hook support from deployment script

* new fuji deployment

* updated metadata dependency

* undo mumbai gas changes

* add sepolia

* bump metadata version

* ops scripts bugfix & polish

* updated metadata

---------

Co-authored-by: 0xdavinchee <[email protected]>

Author: d10r

.github/workflows/handler.deploy-to-testnets.yml

@@ -34,7 +34,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-          network: [eth-goerli, polygon-mumbai, optimism-goerli, arbitrum-goerli, avalanche-fuji]
+          network: [eth-goerli, eth-sepolia, polygon-mumbai, optimism-goerli, arbitrum-goerli, avalanche-fuji]
 
     steps:
       - uses: actions/checkout@v3

.github/workflows/handler.verify-contracts.yml

@@ -24,7 +24,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-          network: [eth-goerli, polygon-mumbai, optimism-goerli, arbitrum-goerli, avalanche-fuji, polygon-mainnet, optimism-mainnet, arbitrum-one, avalanche-c, bsc-mainnet, celo-mainnet]
+          network: [eth-goerli, eth-sepolia, polygon-mumbai, optimism-goerli, arbitrum-goerli, avalanche-fuji, polygon-mainnet, optimism-mainnet, arbitrum-one, avalanche-c, bsc-mainnet, celo-mainnet]
 
     steps:
       - uses: actions/checkout@v3

packages/ethereum-contracts/hardhat.config.ts

@@ -31,6 +31,7 @@ subtask(TASK_COMPILE_SOLIDITY_GET_SOURCE_PATHS).setAction(
 const chainIds = {
     "eth-mainnet": 1,
     "eth-goerli": 5,
+    "eth-sepolia": 11155111,
 
     "xdai-mainnet": 100,
 
@@ -79,52 +80,56 @@ const config: HardhatUserConfig = {
     networks: {
         "bsc-mainnet": {
             ...createNetworkConfig("bsc-mainnet"),
-            url: process.env.BSC_PROVIDER_URL || "",
+            url: process.env.BSC_MAINNET_PROVIDER_URL || "",
         },
         "eth-goerli": {
             ...createNetworkConfig("eth-goerli"),
-            url: process.env.GOERLI_PROVIDER_URL || "",
+            url: process.env.ETH_GOERLI_PROVIDER_URL || "",
         },
         "xdai-mainnet": {
             ...createNetworkConfig("xdai-mainnet"),
             url: process.env.XDAI_MAINNET_PROVIDER_URL || "",
         },
         "optimism-mainnet": {
             ...createNetworkConfig("optimism-mainnet"),
-            url: process.env.OPMAINNET_PROVIDER_URL || "",
+            url: process.env.OPTIMISM_MAINNET_PROVIDER_URL || "",
         },
         "optimism-goerli": {
             ...createNetworkConfig("optimism-goerli"),
-            url: process.env.OPGOERLI_PROVIDER_URL || "",
+            url: process.env.OPTIMISM_GOERLI_PROVIDER_URL || "",
         },
         "arbitrum-one": {
             ...createNetworkConfig("arbitrum-one"),
-            url: process.env.ARBONE_PROVIDER_URL || "",
+            url: process.env.ARBITRUM_ONE_PROVIDER_URL || "",
         },
         "arbitrum-goerli": {
             ...createNetworkConfig("arbitrum-goerli"),
-            url: process.env.ARBGOERLI_PROVIDER_URL || "",
+            url: process.env.ARBITRUM_GOERLI_PROVIDER_URL || "",
         },
         "polygon-mainnet": {
             ...createNetworkConfig("polygon-mainnet"),
-            url: process.env.MATIC_PROVIDER_URL || "",
+            url: process.env.POLYGON_MAINNET_PROVIDER_URL || "",
         },
         "polygon-mumbai": {
             ...createNetworkConfig("polygon-mumbai"),
-            url: process.env.MUMBAI_PROVIDER_URL || "",
+            url: process.env.POLYGON_MUMBAI_PROVIDER_URL || "",
         },
         "avalanche-c": {
             ...createNetworkConfig("avalanche-c"),
-            url: process.env.AVALANCHE_PROVIDER_URL || "",
+            url: process.env.AVALANCHE_C_PROVIDER_URL || "",
         },
         "avalanche-fuji": {
             ...createNetworkConfig("avalanche-fuji"),
-            url: process.env.AVALANCHE_PROVIDER_URL || "",
+            url: process.env.AVALANCHE_FUJI_PROVIDER_URL || "",
         },
         "celo-mainnet": {
             ...createNetworkConfig("celo-mainnet"),
             url: process.env.CELO_MAINNET_PROVIDER_URL || "",
         },
+        "eth-sepolia": {
+            ...createNetworkConfig("eth-sepolia"),
+            url: process.env.ETH_SEPOLIA_PROVIDER_URL || "",
+        },
         coverage: {
             url: "http://127.0.0.1:8555",
         },

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

@@ -99,8 +99,6 @@ async function deployContractIfCodeChanged(
  *                  (overriding env: RELEASE_VERSION)
  * @param {string} options.outputFile Name of file where to log addresses of newly deployed contracts
  *                  (overriding env: OUTPUT_FILE)
- * @param {Address} options.cfaHookContract Address of the contract to be set up as CFA hooks receiver
- *                  (overriding env: CFA_HOOK_CONTRACT)
  *
  * Usage: npx truffle exec ops-scripts/deploy-framework.js
  */
@@ -117,7 +115,6 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
         appWhiteListing,
         protocolReleaseVersion,
         outputFile,
-        cfaHookContract,
     } = options;
     resetSuperfluidFramework = options.resetSuperfluidFramework;
 
@@ -126,10 +123,9 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
     console.log("reset superfluid framework: ", resetSuperfluidFramework);
 
     outputFile = outputFile || process.env.OUTPUT_FILE;
-    console.log("output file: ", outputFile);
-
-    cfaHookContract = cfaHookContract || process.env.CFA_HOOK_CONTRACT;
-    console.log("CFA hook contract", cfaHookContract);
+    if (outputFile !== undefined) {
+        console.log("output file: ", outputFile);
+    }
 
     // string to build a list of newly deployed contracts, written to a file if "outputFile" option set
     let output = "";
@@ -363,15 +359,10 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
 
     // list CFA v1
     const deployCFAv1 = async () => {
-        // @note Once we have the actual implementation for the hook contract,
-        // we will need to deploy it and put it here instead of ZERO_ADDRESS
-        const hookContractAddress = cfaHookContract || ZERO_ADDRESS;
-        console.log("CFA Hook Contract Address:", hookContractAddress);
-
         const agreement = await web3tx(
             ConstantFlowAgreementV1.new,
             "ConstantFlowAgreementV1.new"
-        )(superfluid.address, hookContractAddress);
+        )(superfluid.address, ZERO_ADDRESS);
 
         console.log("New ConstantFlowAgreementV1 address", agreement.address);
         output += `CFA_LOGIC=${agreement.address}\n`;
@@ -532,6 +523,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
             [
                 // See SuperToken constructor parameter
                 superfluid.address.toLowerCase().slice(2).padStart(64, "0"),
+                ZERO_ADDRESS.toLowerCase().slice(2).padStart(64, "0"),
             ]
         );
         if (cfaNewLogicAddress !== ZERO_ADDRESS)
@@ -691,27 +683,30 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                     UUPSProxy.new,
                     `Create ConstantOutflowNFT proxy`
                 )();
-                output += `CONSTANT_OUTFLOW_NFT_ADDRESS=${constantOutflowNFTProxy.address}\n`;
+                console.log("ConstantOutflowNFT Proxy address", constantOutflowNFTProxy.address);
+                output += `CONSTANT_OUTFLOW_NFT_PROXY=${constantOutflowNFTProxy.address}\n`;
+
                 const constantInflowNFTProxy = await web3tx(
                     UUPSProxy.new,
-                    `Create ConstantOutflowNFT proxy`
+                    `Create ConstantInflowNFT proxy`
                 )();
-                output += `CONSTANT_INFLOW_NFT_ADDRESS=${constantInflowNFTProxy.address}\n`;
+                console.log("ConstantInflowNFT Proxy address", constantInflowNFTProxy.address);
+                output += `CONSTANT_INFLOW_NFT_PROXY=${constantInflowNFTProxy.address}\n`;
 
                 const constantOutflowNFTLogic = await web3tx(
                     ConstantOutflowNFT.new,
                     `ConstantOutflowNFT.new`
                 )(superfluid.address, constantInflowNFTProxy.address);
-                output += `CONSTANT_OUTFLOW_NFT_LOGIC_ADDRESS=${constantOutflowNFTLogic.address}\n`;
-
+                console.log("ConstantOutflowNFT Logic address", constantOutflowNFTLogic.address);
+                output += `CONSTANT_OUTFLOW_NFT_LOGIC=${constantOutflowNFTLogic.address}\n`;
                 await constantOutflowNFTLogic.castrate();
 
                 const constantInflowNFTLogic = await web3tx(
-                    ConstantOutflowNFT.new,
-                    `ConstantOutflowNFT.new`
+                    ConstantInflowNFT.new,
+                    `ConstantInflowNFT.new`
                 )(superfluid.address, constantOutflowNFTProxy.address);
-                output += `CONSTANT_INFLOW_NFT_LOGIC_ADDRESS=${constantInflowNFTLogic.address}\n`;
-
+                console.log("ConstantInflowNFT Logic address", constantInflowNFTLogic.address);
+                output += `CONSTANT_INFLOW_NFT_LOGIC=${constantInflowNFTLogic.address}\n`;
                 await constantInflowNFTLogic.castrate();
 
                 // set the nft logic addresses (to be consumed by the super token factory logic constructor)
@@ -745,7 +740,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                 // set the nft proxy addresses (to be consumed by the super token logic constructor)
                 cofNFTProxyAddress = constantOutflowNFTProxy.address;
                 cifNFTProxyAddress = constantInflowNFTProxy.address;
-            } else {
+            } else { // nft proxies already exist
                 const newCOFNFTLogic = await deployContractIfCodeChanged(
                     web3,
                     ConstantOutflowNFT,
@@ -757,7 +752,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                             ConstantOutflowNFT.new,
                             "ConstantOutflowNFT.new"
                         )(superfluid.address, cifNFTProxyAddress);
-                        output += `CONSTANT_OUTFLOW_NFT_LOGIC_ADDRESS=${cofNFTLogic.address}\n`;
+                        output += `CONSTANT_OUTFLOW_NFT_LOGIC=${cofNFTLogic.address}\n`;
                         // castrate flow nft logic contract
                         await cofNFTLogic.castrate();
                         return cofNFTLogic;
@@ -779,7 +774,7 @@ module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
                             ConstantInflowNFT.new,
                             "ConstantInflowNFT.new"
                         )(superfluid.address, cofNFTProxyAddress);
-                        output += `CONSTANT_INFLOW_NFT_LOGIC_ADDRESS=${cifNFTLogic.address}\n`;
+                        output += `CONSTANT_INFLOW_NFT_LOGIC=${cifNFTLogic.address}\n`;
                         // castrate flow nft logic contract
                         await cifNFTLogic.castrate();
                         return cifNFTLogic;

packages/ethereum-contracts/ops-scripts/deploy-test-environment.js

@@ -31,6 +31,12 @@ async function takeEvmSnapshot() {
  * Usage: npx truffle exec ops-scripts/deploy-test-environment.js : {TOKENS_TO_DEPLOY}
  * where TOKENS_TO_DEPLOY is an optional list of token symbols, e.g. TEST1,TEST2.
  * For each such token, an underlying ERC20 and a wrapping Super Token will be deployed.
+ *
+ * WARNING:
+ * This script as is can easily overload the connected RPC.
+ * That is because every invocation of deploy-test-token or deploy-super-token
+ * creates an instance of SuperfluidSDK.Framework, where each instance seems to
+ * cause a lot of RPC polling. Those instances seem to not be release until the end of this script.
  */
 module.exports = eval(`(${S.toString()})()`)(async function (
     args,
@@ -62,7 +68,7 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     console.log("==== Superfluid framework deployed  ========");
 
     for (let i = 0; i < tokens.length; ++i) {
-        if (tokens[i] !== deploySuperToken) {
+        if (tokens[i] !== deploySuperToken) { // ???
             console.log(`======== Deploying test token ${tokens[i]} ========`);
             await deployTestToken(errorHandler, [":", tokens[i]], options);
             console.log(`======== Test token ${tokens[i]} deployed ========`);

packages/ethereum-contracts/ops-scripts/info-print-contract-addresses.js

@@ -14,6 +14,8 @@ const {
  * @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.skipTokens Don't iterate through tokens
+ *                  (overriding env: SKIP_TOKENS)
  *
  * Usage: npx truffle exec ops-scripts/info-print-contract-addresses : {OUTPUT_FILE}
  */
@@ -23,7 +25,11 @@ module.exports = eval(`(${S.toString()})()`)(async function (
 ) {
     let output = "";
 
-    let {protocolReleaseVersion} = options;
+    let {
+        protocolReleaseVersion,
+        skipTokens
+    } = options;
+    skipTokens = skipTokens || process.env.SKIP_TOKENS;
 
     if (args.length !== 1) {
         throw new Error("Wrong number of arguments");
@@ -41,8 +47,8 @@ module.exports = eval(`(${S.toString()})()`)(async function (
     const sf = new SuperfluidSDK.Framework({
         ...extractWeb3Options(options),
         version: protocolReleaseVersion,
-        tokens: config.tokenList,
-        loadSuperNativeToken: true,
+        tokens: skipTokens ? [] : config.tokenList,
+        loadSuperNativeToken: !skipTokens, // defaults to true
         additionalContracts: ["UUPSProxiable"],
     });
     await sf.initialize();
@@ -89,39 +95,41 @@ module.exports = eval(`(${S.toString()})()`)(async function (
 
     const constantOutflowNFTProxyAddress =
         await superTokenLogicContract.CONSTANT_OUTFLOW_NFT();
-    output += `CONSTANT_OUTFLOW_NFT_ADDRESS=${constantOutflowNFTProxyAddress}\n`;
+    output += `CONSTANT_OUTFLOW_NFT_PROXY=${constantOutflowNFTProxyAddress}\n`;
 
     const constantOutflowNFTLogicAddress = await (
         await UUPSProxiable.at(constantOutflowNFTProxyAddress)
     ).getCodeAddress();
-    output += `CONSTANT_OUTFLOW_NFT_LOGIC_ADDRESS=${constantOutflowNFTLogicAddress}\n`;
+    output += `CONSTANT_OUTFLOW_NFT_LOGIC=${constantOutflowNFTLogicAddress}\n`;
 
     const constantInflowNFTProxyAddress =
         await superTokenLogicContract.CONSTANT_INFLOW_NFT();
-    output += `CONSTANT_INFLOW_NFT_ADDRESS=${constantInflowNFTProxyAddress}\n`;
+    output += `CONSTANT_INFLOW_NFT_PROXY=${constantInflowNFTProxyAddress}\n`;
 
     const constantInflowNFTLogicAddress = await (
         await UUPSProxiable.at(constantInflowNFTProxyAddress)
     ).getCodeAddress();
-    output += `CONSTANT_INFLOW_NFT_LOGIC_ADDRESS=${constantInflowNFTLogicAddress}\n`;
+    output += `CONSTANT_INFLOW_NFT_LOGIC=${constantInflowNFTLogicAddress}\n`;
 
-    await Promise.all(
-        config.tokenList.map(async (tokenName) => {
-            output += `SUPER_TOKEN_${tokenName.toUpperCase()}=${
-                sf.tokens[tokenName].address
-            }\n`;
-            const underlyingTokenSymbol = await sf.tokens[
-                tokenName
-            ].underlyingToken.symbol.call();
-            output += `NON_SUPER_TOKEN_${underlyingTokenSymbol.toUpperCase()}=${
-                sf.tokens[tokenName].underlyingToken.address
+    if (! skipTokens) {
+        await Promise.all(
+            config.tokenList.map(async (tokenName) => {
+                output += `SUPER_TOKEN_${tokenName.toUpperCase()}=${
+                    sf.tokens[tokenName].address
+                }\n`;
+                const underlyingTokenSymbol = await sf.tokens[
+                    tokenName
+                ].underlyingToken.symbol.call();
+                output += `NON_SUPER_TOKEN_${underlyingTokenSymbol.toUpperCase()}=${
+                    sf.tokens[tokenName].underlyingToken.address
+                }\n`;
+            })
+        );
+        if (sf.config.nativeTokenSymbol) {
+            output += `SUPER_TOKEN_NATIVE_COIN=${
+                sf.tokens[sf.config.nativeTokenSymbol + "x"].address
             }\n`;
-        })
-    );
-    if (sf.config.nativeTokenSymbol) {
-        output += `SUPER_TOKEN_NATIVE_COIN=${
-            sf.tokens[sf.config.nativeTokenSymbol + "x"].address
-        }\n`;
+        }
     }
 
     await util.promisify(fs.writeFile)(outputFilename, output);

packages/ethereum-contracts/ops-scripts/libs/getConfig.js

@@ -49,6 +49,11 @@ module.exports = function getConfig(chainId) {
             patricianPeriod: 3600 * 0.2,
             biconomyForwarder: "0x3075b4dc7085C48A14A5A39BBa68F58B19545971",
         },
+        11155111: {
+            // sepolia
+            liquidationPeriod: 3600,
+            patricianPeriod: 3600 * 0.2,
+        },
         4: {
             // rinkeby
             liquidationPeriod: 3600,
@@ -221,7 +226,7 @@ module.exports = function getConfig(chainId) {
         43113: {
             // avalanche fuji testnet
             data: {
-                initialBlockNumber: 3220000,
+                initialBlockNumber: 21012000,
                 getLogsRange: 50000,
             },
         },