@superfluid-finance/ethereum-contracts 1.7.2-dev.09f3be3.0 → 1.7.2-dev.36bfd5f.0

package/ops-scripts/deploy-deterministically.js

@@ -1,169 +0,0 @@
-const {getScriptRunnerFactory: S} = require("./libs/common");
-
-const SuperfluidSDK = require("@superfluid-finance/js-sdk");
-const Resolver = artifacts.require("Resolver");
-
-const SuperfluidLoader = artifacts.require("SuperfluidLoader");
-const CFAv1Forwarder = artifacts.require("CFAv1Forwarder");
-
-/**
- * @dev Deploy specified contract at a deterministic address (defined by sender, nonce)
- * This facilitates deployment of the contract at the same address across networks.
- * 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 ops-scripts/deploy-deterministically.js : {CONTRACT NAME} [{NONCE}]
- *        CONTRACT NAME must be one of SuperfluidLoader, AgreementForwarder
- *        If NONCE is not defined, 0 is assumed (-> first tx done from the deployer account)
- *
- * Required ENV var: DETERMINISTIC_DEPLOYER_PK
- *
- * (optional) ENV vars:
- *        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 (
-    args,
-    options = {}
-) {
-    let {protocolReleaseVersion} = options;
-
-    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) {
-        throw new Error("Wrong number of arguments");
-    }
-    const contractName = 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);
-
-    const chainId = await web3.eth.getChainId();
-    const resolverAddr = SuperfluidSDK.getConfig(
-        chainId,
-        protocolReleaseVersion
-    ).resolverAddress;
-    console.log("resolver addr:", resolverAddr);
-    const resolver = await Resolver.at(resolverAddr);
-    const hostAddr = await resolver.get(`Superfluid.${protocolReleaseVersion}`);
-    console.log("host addr:", hostAddr);
-
-    let ContractArtifact;
-    let deployArgs;
-    if (contractName === "SuperfluidLoader") {
-        ContractArtifact = SuperfluidLoader;
-        deployArgs = [resolverAddr];
-        console.log(
-            `setting up SuperfluidLoader for chainId ${chainId}, resolver ${resolverAddr}`
-        );
-    } else if (contractName === "CFAv1Forwarder") {
-        ContractArtifact = CFAv1Forwarder;
-        deployArgs = [hostAddr];
-        console.log(
-            `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) {
-        console.error(
-            `### ERR: requested nonce is ${nonce}, but next usable nonce is ${deployerTxCnt}`
-        );
-        process.exit(1);
-    }
-
-    const deployerBalance = await web3.eth.getBalance(deployer.address);
-    console.log("deployer balance:", web3.utils.fromWei(deployerBalance));
-
-    const gasPrice = process.env.GAS_PRICE || (await web3.eth.getGasPrice());
-    console.log("gas price:", gasPrice);
-
-    const Contract = new web3.eth.Contract(ContractArtifact.abi);
-    const deployTx = Contract.deploy({
-        data: ContractArtifact.bytecode,
-        arguments: deployArgs,
-    });
-
-    const gasLimit = process.env.GAS_LIMIT || (await deployTx.estimateGas());
-    console.log("gas limit:", gasLimit);
-
-    const deployCode = deployTx.encodeABI();
-
-    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.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 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}`
-        );
-    } else {
-        console.log("deployer account is already sufficiently funded");
-    }
-
-    // check if EIP-1559 enabled
-    const lastBlock = await web3.eth.getBlock(await web3.eth.getBlockNumber());
-    const hasEip1559 = lastBlock.baseFeePerGas !== undefined;
-
-    const unsignedTx = {
-        data: deployCode,
-        gas: gasLimit,
-        nonce,
-    };
-    if (hasEip1559) {
-        console.log("creating EIP-1559 tx");
-        unsignedTx.maxFeePerGas = gasPrice;
-        unsignedTx.maxPriorityFeePerGas = gasPrice; // may cause overpaying, but not a big deal here
-    } else {
-        console.log("creating non-EIP-1559 tx");
-        unsignedTx.gasPrice = gasPrice;
-    }
-
-    const signedTx = await web3.eth.accounts.signTransaction(
-        unsignedTx,
-        privKey
-    );
-    console.log("signed tx with tx hash:", signedTx.transactionHash);
-
-    console.log("sending deploy tx...");
-    const deployTxReceipt = await web3.eth.sendSignedTransaction(
-        signedTx.rawTransaction
-    );
-    console.log("contract deployed at:", deployTxReceipt.contractAddress);
-});

package/ops-scripts/deploy-erc1820.js

@@ -1,83 +0,0 @@
-// Adapted from https://github.com/0xjac/ERC1820/blob/master/js/deployment.js
-const assert = require("assert").strict;
-
-const Transaction = require("ethereumjs-tx").Transaction;
-const ethUtils = require("ethereumjs-util");
-// TODO: this is a weird dependency, should probably get this from elsewhere
-const ERC1820Registry = require("./artifacts/ERC1820Registry.json");
-const {getScriptRunnerFactory: S, hasCode} = require("./libs/common");
-
-/**
- * @dev Deploy ERC1820 to the network.
- * @param web3 The web3 to be used
- * @param from address to deploy contracts from
- *
- * Usage: npx truffle exec ops-scripts/deploy-erc1820.js
- */
-module.exports = eval(`(${S.toString()})({skipArgv: true})`)(async function (
-    args,
-    options = {}
-) {
-    web3 = web3 || options.web3;
-
-    const rawTransaction = {
-        nonce: 0,
-        gasPrice: 100000000000,
-        value: 0,
-        data: "0x" + ERC1820Registry.bin,
-        gasLimit: 800000,
-        v: 27,
-        r: "0x1820182018201820182018201820182018201820182018201820182018201820",
-        s: "0x1820182018201820182018201820182018201820182018201820182018201820",
-    };
-    const tx = new Transaction(rawTransaction);
-    const res = {
-        sender: ethUtils.toChecksumAddress(
-            "0x" + tx.getSenderAddress().toString("hex")
-        ),
-        rawTx: "0x" + tx.serialize().toString("hex"),
-        contractAddr: ethUtils.toChecksumAddress(
-            "0x" +
-                ethUtils
-                    .generateAddress(
-                        tx.getSenderAddress(),
-                        ethUtils.toBuffer(0)
-                    )
-                    .toString("hex")
-        ),
-    };
-    assert.equal("0xa990077c3205cbDf861e17Fa532eeB069cE9fF96", res.sender);
-    assert.equal(
-        "0x1820a4B7618BdE71Dce8cdc73aAB6C95905faD24",
-        res.contractAddr
-    );
-
-    console.log("Checking ERC1820 deployment at", res.contractAddr);
-    if (!(await hasCode(web3, res.contractAddr))) {
-        console.log("Deploying...");
-        const account = options.from || (await web3.eth.getAccounts())[0];
-        console.log("Step 1: send ETH");
-        // NOTE: we estimate gas when running test coverage w/ hardhat
-        // otherwise there is a weird bug which requires the user to have
-        // over 2k ETH to send the transaction
-        const estimatedGasObject = {
-            from: account,
-            to: res.sender,
-            value: "100000000000000000", //web3.utils.toWei(0.1)
-        };
-        if (process.env.IS_HARDHAT) {
-            const estimatedGas = await web3.eth.estimateGas(estimatedGasObject);
-            await web3.eth.sendTransaction({
-                ...estimatedGasObject,
-                gas: estimatedGas,
-            });
-        } else {
-            await web3.eth.sendTransaction(estimatedGasObject);
-        }
-        console.log("Step 2: send signed transaction");
-        await web3.eth.sendSignedTransaction(res.rawTx);
-        console.log("Deployment done.");
-    } else {
-        console.log("ERC1820 is already deployed.");
-    }
-});