buidler.config.js

// ES6 module imports via require
require("@babel/register");

// Libraries
const assert = require("assert");
const { constants, errors, utils } = require("ethers");

// Disable ethers v4 warnings e.g. for solidity overloaded fns
errors.setLogLevel("error");

// Classes
const Action = require("./src/classes/gelato/Action").default;
const Condition = require("./src/classes/gelato/Condition").default;
const GelatoProvider = require("./src/classes/gelato/GelatoProvider").default;
const Task = require("./src/classes/gelato/Task").default;
const TaskSpec = require("./src/classes/gelato/TaskSpec").default;
const TaskReceipt = require("./src/classes/gelato/TaskReceipt").default;
// Objects
const gelatoSysAdminInitialState = require("./test/gelato_core/base/gelato_sys_admin/GelatoSysAdmin.initialState")
  .default;
// Objects/Enums
const Operation = require("./src/enums/gelato/Operation").default;
const DataFlow = require("./src/enums/gelato/DataFlow").default;

// Helpers
// Async
const sleep = require("./src/helpers/async/sleep").default;
// Gelato
const convertTaskReceiptArrayToObj = require("./src/helpers/gelato/convertTaskReceiptArrayToObj")
  .default;
const convertTaskReceiptObjToArray = require("./src/helpers/gelato/convertTaskReceiptObjToArray")
  .default;
// Nested Arrays
const nestedArraysAreEqual = require("./src/helpers/nestedArrays/nestedArraysAreEqual")
  .default;
// Nested Objects
const checkNestedObj = require("./src/helpers/nestedObjects/checkNestedObj")
  .default;
const getNestedObj = require("./src/helpers/nestedObjects/getNestedObj")
  .default;

// ================================= BRE extension ==================================
extendEnvironment((bre) => {
  // Classes
  bre.Action = Action;
  bre.Condition = Condition;
  bre.GelatoProvider = GelatoProvider;
  bre.Task = Task;
  bre.TaskSpec = TaskSpec;
  bre.TaskReceipt = TaskReceipt;
  // Objects
  bre.gelatoSysAdminInitialState = gelatoSysAdminInitialState;
  // Objects/Enums
  bre.Operation = Operation;
  bre.DataFlow = DataFlow;
  // Functions
  // Async
  bre.sleep = sleep;
  // Gelato
  bre.convertTaskReceiptArrayToObj = convertTaskReceiptArrayToObj;
  bre.convertTaskReceiptObjToArray = convertTaskReceiptObjToArray;
  // Nested Arrays
  bre.nestedArraysAreEqual = nestedArraysAreEqual;
  // Nested Objects
  bre.checkNestedObj = checkNestedObj;
  bre.getNestedObj = getNestedObj;
  // Libraries
  bre.constants = constants;
  bre.utils = utils;
  bre.getUser = () => new ethers.Wallet(USER_PK, ethers.provider);
  bre.getProvider = () => new ethers.Wallet(PROVIDER_PK, ethers.provider);
  bre.getSysAdmin = () => new ethers.Wallet(SYS_ADMIN_PK, ethers.provider);
  bre.getExecutor = () => new ethers.Wallet(EXECUTOR_PK, ethers.provider);
});

// ================================= CONFIG =========================================
// Process Env Variables
require("dotenv").config();
const DEV_MNEMONIC = process.env.DEV_MNEMONIC;
const MAINNET_MNEMONIC = process.env.MAINNET_MNEMONIC;
const INFURA_ID = process.env.INFURA_ID;
const DEFAULT_NETWORK = process.env.DEFAULT_NETWORK;
const USER_PK = process.env.USER_PK;
const PROVIDER_PK = process.env.PROVIDER_PK;
const SYS_ADMIN_PK = process.env.SYS_ADMIN_PK;
const EXECUTOR_PK = process.env.EXECUTOR_PK;
const ALCHEMY_ID = process.env.ALCHEMY_ID;

assert.ok(DEV_MNEMONIC, "no DEV_MNEMONIC in process.env");
assert.ok(MAINNET_MNEMONIC, "no MAINNET_MNEMONIC in process.env");
assert.ok(INFURA_ID, "no Infura ID in process.env");
assert.ok(USER_PK, "no user private key (USER_PK) found in .env");
assert.ok(PROVIDER_PK, "no provider private key (USER_PK) found in .env");
// assert.ok(ALCHEMY_ID, "no Alchemy ID in process.env");

// Config Files
const buidlerevmConfig = require("./buidler/config/networks/buidlerevmConfig");
const rinkebyConfig = require("./buidler/config/networks/rinkebyConfig");
const mainnetConfig = require("./buidler/config/networks/mainnetConfig");

module.exports = {
  defaultNetwork: DEFAULT_NETWORK ? DEFAULT_NETWORK : "buidlerevm",
  etherscan: {
    // The url for the Etherscan API you want to use.
    // For example, here we're using the one for the Rinkeby test network
    url: "https://api.etherscan.io/api",
    // Your API key for Etherscan (Obtain one at https://etherscan.io/)
    apiKey: process.env.ETHERSCAN_KEY,
  },
  gasReporter: {
    enabled: process.env.REPORT_GAS ? true : false,
  },
  networks: {
    buidlerevm: {
      hardfork: "istanbul",
      contracts: buidlerevmConfig.contracts,
      allowUnlimitedContractSize: process.env.BUIDLER_DEBUG ? true : false,
      // Custom
      filters: { defaultFromBlock: 1, defaultToBlock: "latest" },
    },
    coverage: {
      url: "http://127.0.0.1:8555",
      // Custom
      filters: { defaultFromBlock: 1, defaultToBlock: "latest" },
    },
    localhost: {
      allowUnlimitedContractSize: process.env.BUIDLER_DEBUG ? true : false,
      filters: { defaultFromBlock: 1, defaultToBlock: "latest" },
    },
    mainnet: {
      // Standard
      accounts: { mnemonic: MAINNET_MNEMONIC },
      chainId: 1,
      gas: "auto",
      gasPrice: parseInt(utils.parseUnits("80", "gwei")),
      gasMultiplier: 1.5,
      url: `https://mainnet.infura.io/v3/${INFURA_ID}`,
      // url: `https://eth-mainnet.alchemyapi.io/v2/${ALCHEMY_ID}`,
      // Custom
      addressBook: mainnetConfig.addressBook,
      contracts: mainnetConfig.contracts,
      deployments: mainnetConfig.deployments,
      filters: mainnetConfig.filters,
    },
    rinkeby: {
      // Standard
      accounts: { mnemonic: DEV_MNEMONIC },
      chainId: 4,
      gasPrice: parseInt(utils.parseUnits("8", "gwei")),
      url: `https://rinkeby.infura.io/v3/${INFURA_ID}`,
      // Custom
      addressBook: rinkebyConfig.addressBook,
      contracts: rinkebyConfig.contracts,
      deployments: rinkebyConfig.deployments,
      filters: rinkebyConfig.filters,
    },
  },
  solc: {
    version: "0.6.10",
    optimizer: { enabled: true },
  },
};

// ================================= PLUGINS =========================================
usePlugin("@nomiclabs/buidler-ethers");
usePlugin("@nomiclabs/buidler-etherscan");
usePlugin("@nomiclabs/buidler-waffle");
usePlugin("buidler-gas-reporter");
usePlugin("solidity-coverage");

// ================================= TASKS =========================================
// task action function receives the Buidler Runtime Environment as second argument

// ============== ABI
require("./buidler/tasks/abi/collection.tasks.abi");

// ============== BLOCK
require("./buidler/tasks/block/collection.tasks.block");

// ============== BRE
// BRE, BRE-CONFIG(:networks), BRE-NETWORK
require("./buidler/tasks/bre/collection.tasks.bre");

// ============== DAPPS
require("./buidler/tasks/dapps/collection.tasks.dapps");

// ============== DEBUGGING
require("./buidler/tasks/debugging/collection.tasks.debugging");

// ============== DEPLOY
require("./buidler/tasks/deploy/collection.tasks.deploy");

// ============== ERC20
require("./buidler/tasks/erc20/collection.tasks.erc20");

// ============== ETH
require("./buidler/tasks/eth/collection.tasks.eth");

// ============== ETHERS
require("./buidler/tasks/ethers/collection.tasks.ethers");

// ============== EVENTS
require("./buidler/tasks/events/collection.tasks.events");

// ============= GELATO
// _____ ACTIONS
require("./buidler/tasks/gelato/actions/collection.tasks.actions");
// _____ CORE
// GasAdmin, Executors, Providers, submitTask, ...
require("./buidler/tasks/gelato/core/collection.tasks.gelato-core");
// _____ CONDITIONS
require("./buidler/tasks/gelato/conditions/collection.tasks.conditions");
// _____ HELPERS
require("./buidler/tasks/gelato/helpers/collection.tasks.gelato-helpers.js");

// ============= USER PROXIES (GelatoUserProxy, GnosisSafeProxy,...)
require("./buidler/tasks/user_proxies/collection.tasks.gelato-user-proxies");

// ======================== INTERNAL HELPER TASKS ======================================
// encoding, naming ....
require("./buidler/tasks/internal/collection.internalTasks");

// ======================== VIEW FUNCS ======================================
require("./buidler/tasks/view/collection.viewTasks");

// ======================== DEMO ======================================
require("./src/demo/collection.tasks.demo");