@superfluid-finance/ethereum-contracts 1.7.2-dev.09f3be3.0 → 1.7.2-dev.2cebc84.0

package/ops-scripts/libs/getConfig.js

@@ -1,289 +0,0 @@
-const SuperfluidSDK = require("@superfluid-finance/js-sdk");
-
-/*
- * REFERENCES:
- * - https://docs.biconomy.io/misc/contract-addresses
- */
-
-module.exports = function getConfig(chainId) {
-    const DEFAULT_CONFIGS = {
-        //
-        // Local Testing
-        //
-        4447: {
-            // for local testing (truffle internal ganache and TestEnvironment)
-            // this is a fake forwarder address, it is to test the deployment script
-            biconomyForwarder: "0x3075b4dc7085C48A14A5A39BBa68F58B19545971",
-        },
-        5777: {
-            // for local testing (external ganache)
-            // this is a fake forwarder address, it is to test the deployment script
-            biconomyForwarder: "0x3075b4dc7085C48A14A5A39BBa68F58B19545971",
-        },
-        6777: {
-            // for coverage testing
-            // this is a fake forwarder address, it is to test the deployment script
-            biconomyForwarder: "0x3075b4dc7085C48A14A5A39BBa68F58B19545971",
-        },
-
-        //
-        // ETHEREUM
-        //
-        1: {
-            // mainnet
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: [],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 15870000,
-                getLogsRange: 10000,
-            },
-        },
-        5: {
-            // goerli
-            liquidationPeriod: 3600,
-            patricianPeriod: 3600 * 0.2,
-            biconomyForwarder: "0x3075b4dc7085C48A14A5A39BBa68F58B19545971",
-        },
-        11155111: {
-            // sepolia
-            liquidationPeriod: 3600,
-            patricianPeriod: 3600 * 0.2,
-        },
-        4: {
-            // rinkeby
-            liquidationPeriod: 3600,
-            patricianPeriod: 3600 * 0.2,
-            biconomyForwarder: "0x1730cAe53340aB01228019618C2b544642f3650A",
-        },
-
-        3: {
-            // ropsten
-            liquidationPeriod: 3600,
-            patricianPeriod: 3600 * 0.2,
-            biconomyForwarder: "0x1De6349B96774ed5E3569e47D609C19A8dE15C89",
-        },
-        42: {
-            // kovan
-            liquidationPeriod: 3600,
-            patricianPeriod: 3600 * 0.2,
-            biconomyForwarder: "0xE8Df44bcaedD41586cE73eB85e409bcaa834497B",
-        },
-
-        //
-        // MATIC: https://docs.matic.network/docs/develop/network-details/network/
-        //
-        80001: {
-            // (matic) mumbai testnet
-            liquidationPeriod: 3600,
-            patricianPeriod: 3600 * 0.2,
-            biconomyForwarder: "0x2B99251eC9650e507936fa9530D11dE4d6C9C05c",
-        },
-        137: {
-            // (matic) mainnet
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: ["DAIx", "USDCx", "ETHx"],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 10000000,
-                getLogsRange: 10000,
-            },
-        },
-
-        //
-        // xDAI: https://www.xdaichain.com/for-users/wallets/metamask/metamask-setup
-        //
-        100: {
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: ["ETHx"],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-        },
-
-        //
-        // BSC: https://docs.binance.org/smart-chain/developer/rpc.html
-        //
-        56: {
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: [],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 18800000,
-                getLogsRange: 5000,
-            },
-        },
-        97: {
-            // BSC chapel testnet
-            data: {
-                initialBlockNumber: 19437500,
-                getLogsRange: 10000,
-            },
-        },
-
-        //
-        // Optimistic Ethereum: https://community.optimism.io/docs/
-        //
-        10: {
-            // optimism mainnet
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: ["DAIx", "USDCx"],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 4300000,
-                getLogsRange: 50000,
-            },
-        },
-        69: {
-            // optimism testnet (kovan)
-            data: {
-                initialBlockNumber: 300000,
-                getLogsRange: 50000,
-            },
-        },
-        420: {
-            // optimism testnet (goerli)
-            data: {
-                initialBlockNumber: 340000,
-                getLogsRange: 50000,
-            },
-        },
-
-        //
-        // Arbitrum: https://developer.offchainlabs.com
-        //
-        42161: {
-            // arbitrum one mainnet
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: ["DAIx", "USDCx"],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 7600000,
-                getLogsRange: 50000,
-            },
-        },
-        421611: {
-            // arbitrum testnet (rinkeby)
-            data: {
-                initialBlockNumber: 7300000,
-                getLogsRange: 50000,
-            },
-        },
-        421613: {
-            // arbitrum testnet (goerli)
-            data: {
-                initialBlockNumber: 93000,
-                getLogsRange: 50000,
-            },
-        },
-
-        //
-        // ARTIS
-        //
-        0x03c401: {
-            // (artis) tau1 testnet
-        },
-
-        //
-        // Avalanche C-Chain: https://docs.avax.network/learn/platform-overview#contract-chain-c-chain
-        //
-        43114: {
-            // avalanche mainnet
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: [],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 14700000,
-                getLogsRange: 50000,
-            },
-        },
-        43113: {
-            // avalanche fuji testnet
-            data: {
-                initialBlockNumber: 21012000,
-                getLogsRange: 50000,
-            },
-            cfaFwd: "0x2CDd45c5182602a36d391F7F16DD9f8386C3bD8D",
-        },
-
-        //
-        // Celo: https://github.com/celo-org/celo-monorepo#docs
-        //
-        42220: {
-            // celo mainnet
-            liquidationPeriod: 3600 * 4,
-            patricianPeriod: 3600 * 4 * 0.2,
-            tokenList: [],
-            // governance default configs
-            gov_enableAppWhiteListing: true,
-            // misc
-            disableTestGovernance: true,
-            data: {
-                initialBlockNumber: 16393000,
-                getLogsRange: 20000,
-            },
-        },
-        44787: {
-            // Celo alfajores testnet
-            data: {
-                initialBlockNumber: 11519000,
-                getLogsRange: 50000,
-            },
-        },
-
-        //
-        // Base: https://base.org/
-        //
-        84531: {
-            // base testnet (goerli)
-            data: {
-                initialBlockNumber: 5249500,
-                getLogsRange: 50000,
-            },
-        },
-    };
-
-    return {
-        // global default configs
-        ...{
-            // default liquidation period for the test deployments
-            liquidationPeriod: 3600,
-            // default patrician period for test deployments
-            patricianPeriod: 3600 * 0.2,
-            // default token list for the test deployments
-            tokenList: ["fDAIx", "fUSDCx", "fTUSDx"],
-            data: {},
-            cfaFwd: "0xcfA132E353cB4E398080B9700609bb008eceB125",
-        },
-        // network specific configs
-        ...DEFAULT_CONFIGS[chainId],
-        // SDK provided configs
-        ...SuperfluidSDK.getConfig(chainId),
-    };
-};

package/ops-scripts/libs/truffleScriptRunnerFactory.js

@@ -1,97 +0,0 @@
-/**
- * @dev Parse colon marked arguments
- *
- * NOTE:
- * Provide arguments to the script through ":" separator
- */
-function parseColonArgs(argv) {
-    const argIndex = argv.indexOf(":");
-    if (argIndex < 0) {
-        console.log("No colon arguments");
-        return [];
-    } else {
-        const args = argv.slice(argIndex + 1);
-        return args;
-    }
-}
-
-/**
- * @dev Script runner for logic function
- *
- * This is development framework dependent, and it's currently for Truffle.
- *
- * runnerOpts.skipArgv:
- *   - most scripts supports argv followed by an options, but for compatibility issue
- *     some script wants to skip the argv. This option enables the hack.
- */
-module.exports = function (ctxFn, logicFn, runnerOpts) {
-    return async function (cb, argv, options = {}) {
-        try {
-            const {artifacts, web3, truffleDetected} = ctxFn();
-
-            let args;
-            if (runnerOpts.skipArgv) {
-                // skip argv arguments
-                options = argv || {};
-            } else {
-                // Parse colon indicated arguments
-                args = parseColonArgs(argv || process.argv);
-                runnerOpts.doNotPrintColonArgs ||
-                    console.log("Colon arguments", args);
-            }
-
-            // if isTruffle is not set explicitly
-            if (!("isTruffle" in options)) {
-                if ("DISABLE_NATIVE_TRUFFLE" in process.env) {
-                    options.isTruffle = !process.env.DISABLE_NATIVE_TRUFFLE;
-                } else {
-                    options.isTruffle = truffleDetected;
-                }
-            }
-
-            // normalize web3 environment
-            console.log(
-                "use truffle native environment (isTruffle)",
-                options.isTruffle
-            );
-            if (options.isTruffle) {
-                if (options.web3) {
-                    throw Error(
-                        "Flag 'isTruffle' cannot be 'true' when using a web3 instance."
-                    );
-                }
-                // set these globally so that it's available throughout the executions
-                global.web3 = web3;
-                global.artifacts = artifacts;
-            } else {
-                if (!truffleDetected) {
-                    if (!options.web3) {
-                        throw Error(
-                            "A web3 instance is not provided when not using truffle."
-                        );
-                    }
-                    global.web3 = options.web3;
-                } else {
-                    // use web3 of truffle
-                    options.web3 = global.web3 = web3;
-                }
-            }
-
-            // Use common environment variables
-            options.protocolReleaseVersion =
-                options.protocolReleaseVersion ||
-                process.env.RELEASE_VERSION ||
-                "test";
-            console.log(
-                "protocol release version:",
-                options.protocolReleaseVersion
-            );
-
-            const retVal = await logicFn(args, options);
-            cb();
-            return retVal;
-        } catch (err) {
-            cb(err);
-        }
-    };
-};

package/ops-scripts/resolver-list-super-token.js

@@ -1,73 +0,0 @@
-const SuperfluidSDK = require("@superfluid-finance/js-sdk");
-const {
-    getScriptRunnerFactory: S,
-    ZERO_ADDRESS,
-    extractWeb3Options,
-    builtTruffleContractLoader,
-    setResolver,
-} = require("./libs/common");
-
-/**
- * @dev List a super token in resolver.
- * @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 {string} options.protocolReleaseVersion Specify the protocol release version to be used
- *
- * Usage: npx truffle exec ops-scripts/resolver-list-super-token.js : {SUPER_TOKEN_ADDRESS}
- */
-module.exports = eval(`(${S.toString()})()`)(async function (
-    args,
-    options = {}
-) {
-    console.log("======== List new super token ========");
-    let {resetToken, protocolReleaseVersion} = options;
-
-    if (args.length !== 1) {
-        throw new Error("Wrong number of arguments");
-    }
-    const superTokenAddress = args.pop();
-    console.log("Super Token Address", superTokenAddress);
-
-    resetToken = resetToken || !!process.env.RESET_TOKEN;
-    console.log("protocol release version:", protocolReleaseVersion);
-
-    const sf = new SuperfluidSDK.Framework({
-        ...extractWeb3Options(options),
-        version: protocolReleaseVersion,
-        additionalContracts: [
-            "Ownable",
-            "IMultiSigWallet",
-            "SuperfluidGovernanceBase",
-            "SuperToken",
-            "Resolver",
-            "IAccessControlEnumerable",
-        ],
-        contractLoader: builtTruffleContractLoader,
-    });
-    await sf.initialize();
-
-    const superToken = await sf.contracts.SuperToken.at(superTokenAddress);
-    if (
-        (await superToken.proxiableUUID.call()) !==
-        web3.utils.sha3(
-            "org.superfluid-finance.contracts.SuperToken.implementation"
-        )
-    ) {
-        throw new Error("Not a super token");
-    }
-    const tokenSymbol = await superToken.symbol.call();
-    const superTokenKey = `supertokens.${protocolReleaseVersion}.${tokenSymbol}`;
-    console.log("Super token key", superTokenKey);
-
-    const resolver = await sf.contracts.Resolver.at(sf.resolver.address);
-    if (
-        (await resolver.get.call(superTokenKey)) !== ZERO_ADDRESS &&
-        !resetToken
-    ) {
-        console.error("Super token already listed!");
-        console.error("A Transfer event may be needed for indexers to notice.");
-    }
-    await setResolver(sf, superTokenKey, superTokenAddress);
-});

package/ops-scripts/resolver-register-token.js

@@ -1,72 +0,0 @@
-const {web3tx} = require("@decentral.ee/web3-helpers");
-const SuperfluidSDK = require("@superfluid-finance/js-sdk");
-
-const getConfig = require("./libs/getConfig");
-
-const {
-    getScriptRunnerFactory: S,
-    extractWeb3Options,
-    builtTruffleContractLoader,
-} = require("./libs/common");
-
-/**
- * @dev Deploy test token (Mintable ERC20) to the network.
- * @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.resetToken Reset the token deployment
- *
- * Usage: npx truffle exec ops-scripts/resolver-register-token.js : {TOKEN_NAME} {TOKEN_ADDRESS}
- */
-module.exports = eval(`(${S.toString()})()`)(async function (
-    args,
-    options = {}
-) {
-    console.log("======== Register test token ========");
-    let {resetToken} = options;
-
-    if (args.length !== 2) {
-        throw new Error("Wrong number of arguments");
-    }
-    const tokenAddress = args.pop();
-    const tokenName = args.pop();
-    console.log("Token name", tokenName);
-    console.log("Token address", tokenAddress);
-
-    const networkType = await web3.eth.net.getNetworkType();
-    const networkId = await web3.eth.net.getId();
-    const chainId = await web3.eth.getChainId();
-    console.log("network Type: ", networkType);
-    console.log("network ID: ", networkId);
-    console.log("chain ID: ", chainId);
-    const config = getConfig(chainId);
-
-    resetToken = resetToken || !!process.env.RESET_TOKEN;
-    console.log("reset token: ", resetToken);
-    console.log("chain ID: ", chainId);
-
-    const {Resolver} = await SuperfluidSDK.loadContracts({
-        ...extractWeb3Options(options),
-        additionalContracts: ["Resolver"],
-        contractLoader: builtTruffleContractLoader,
-        networkId,
-    });
-
-    const resolver = await Resolver.at(config.resolverAddress);
-    console.log("Resolver address", resolver.address);
-
-    const name = `tokens.${tokenName}`;
-    let testTokenAddress = await resolver.get(name);
-
-    if (
-        resetToken ||
-        testTokenAddress === "0x0000000000000000000000000000000000000000"
-    ) {
-        await web3tx(resolver.set, `Resolver set ${name}`)(name, tokenAddress);
-    } else {
-        console.log("Token already set");
-    }
-
-    console.log("======== Test token registered ======");
-});

package/ops-scripts/resolver-reset-deployment.js

@@ -1,54 +0,0 @@
-const {web3tx} = require("@decentral.ee/web3-helpers");
-const {setWeb3Provider} = require("@decentral.ee/web3-helpers/src/config");
-const Resolver = artifacts.require("Resolver");
-const getConfig = require("./libs/getConfig");
-
-const {getScriptRunnerFactory: S, rl} = require("./libs/common");
-
-/**
- * @dev Reset the superfluid framework deployment.
- * @param {Array} args Overriding command line arguments
- *
- * Usage: npx truffle exec ops-scripts/resolver-reset-deployment.js : {VERSION}
- */
-module.exports = eval(`(${S.toString()})()`)(async function (args) {
-    if (args.length !== 1) {
-        throw new Error("Wrong number of arguments");
-    }
-    const version = args.pop();
-
-    if (version != (await rl("Please confirm the version: "))) {
-        console.error("Mismatched versions");
-        return;
-    }
-
-    const networkType = await web3.eth.net.getNetworkType();
-    const networkId = await web3.eth.net.getId();
-    const chainId = await web3.eth.getChainId();
-    console.log("network Type: ", networkType);
-    console.log("network ID: ", networkId);
-    console.log("chain ID: ", chainId);
-    const config = getConfig(chainId);
-
-    // make sure that we are using the same web3 provider in the helpers
-    setWeb3Provider(web3.currentProvider);
-
-    let resolver;
-    if (config.resolverAddress) {
-        resolver = await Resolver.at(config.resolverAddress);
-    } else {
-        resolver = await web3tx(Resolver.new, "Resolver.new")();
-        // make it available for the sdk for testing purpose
-        process.env.RESOLVER_ADDRESS = resolver.address;
-    }
-    console.log("Resolver address", resolver.address);
-
-    await web3tx(resolver.set, "Clear Superfluid deployment")(
-        `Superfluid.${version}`,
-        "0x" + "0".repeat(40)
-    );
-    await web3tx(resolver.set, "Clear TestGovernance deployment")(
-        `TestGovernance.${version}`,
-        "0x" + "0".repeat(40)
-    );
-});

package/ops-scripts/resolver-set-key-value.js

@@ -1,69 +0,0 @@
-const SuperfluidSDK = require("@superfluid-finance/js-sdk");
-const {
-    getScriptRunnerFactory: S,
-    ZERO_ADDRESS,
-    extractWeb3Options,
-    builtTruffleContractLoader,
-    setResolver,
-} = require("./libs/common");
-
-/**
- * @dev Set a given value for a given key in resolver
- * @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 {string} options.protocolReleaseVersion Specify the protocol release version to be used
- *
- * Usage: npx truffle exec ops-scripts/resolver-set-key-value.js : {KEY} {VALUE}
- *
- * ENV vars:
- *    ALLOW_UPDATE: only if set will existing values be overwritten
- *    RESOLVER_ADMIN_TYPE: needs to be set to MULTISIG for networks with multisig owner
- */
-module.exports = eval(`(${S.toString()})()`)(async function (
-    args,
-    options = {}
-) {
-    console.log("======== Set key with value ========");
-    let {protocolReleaseVersion} = options;
-
-    if (args.length !== 2) {
-        throw new Error("Wrong number of arguments");
-    }
-    const value = args.pop();
-    const key = args.pop();
-
-    console.log("Key", key);
-    console.log("Value", value);
-
-    console.log("protocol release version:", protocolReleaseVersion);
-
-    const sf = new SuperfluidSDK.Framework({
-        ...extractWeb3Options(options),
-        version: protocolReleaseVersion,
-        additionalContracts: [
-            "Ownable",
-            "IMultiSigWallet",
-            "SuperfluidGovernanceBase",
-            "Resolver",
-            "IAccessControlEnumerable",
-        ],
-        contractLoader: builtTruffleContractLoader,
-    });
-    await sf.initialize();
-
-    const resolver = await sf.contracts.Resolver.at(sf.resolver.address);
-
-    const prevVal = await resolver.get.call(key);
-    if (prevVal !== ZERO_ADDRESS) {
-        console.log("Key already has a value", prevVal);
-        if (!process.env.ALLOW_UPDATE) {
-            throw new Error(
-                "ALLOW_UPDATE not set, can't override existing value"
-            );
-        }
-    }
-
-    await setResolver(sf, key, value);
-});