Merge pull request #1 from NFTX-project/tests

Add more tests

Author: apoorvlathey

.gitmodules

@@ -1,7 +1,6 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
-	branch = v1.3.0
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts

README.md

@@ -2,7 +2,7 @@
   "mainnet": {
     "CreateVaultZap": "0x56dab32697B4A313f353DA0CE42B5113eD8E6f74",
     "DefaultProxyAdmin": "0xf8Cab5e4912e08c475033776d9472b81c1325e58",
-    "FailSafe": "0x8665664CD32B6263A9b716371814Dc8CecFb8F2B",
+    "FailSafe": "0x6bB724F11a8D7254800Cf34922E0D54407B0e698",
     "MarketplaceUniversalRouterZap": "0x293A0c49c85F1D8851C665Ac3cE1f1DC2a79bE3d",
     "MigratorZap": "0x089610Fb04c34C014B4B391f4eCEFAef94E98CEc",
     "NFTXEligibilityManager": "0x4086e98Cce041d286112d021612fD894cFed94D5",
@@ -14,11 +14,34 @@
     "NonfungiblePositionManager": "0x26387fcA3692FCac1C1e8E4E2B22A6CF0d4b71bF",
     "permit2": "0x000000000022d473030f116ddee9f6b43ac78ba3",
     "QuoterV2": "0x5493dF723c17B6A768aA61F79405bA56ffC5294a",
+    "ShutdownRedeemerUpgradeable": "0x96cf14C2A61b7142421397735e702e25f1aa7F30",
     "SwapRouter": "0x1703f8111B0E7A10e1d14f9073F53680d64277A3",
     "TickLens": "0x1650115DDD287bE6F4972180d290D0FF89a42c40",
     "UniswapV3FactoryUpgradeable": "0xa70e10beB02fF9a44007D9D3695d4b96003db101",
     "WETH": "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2"
   },
+  "arbitrum": {
+    "CreateVaultZap": "0xF9E891AB1ECa89B7A4B3cBD45aEBFDF3Ec38946F",
+    "DefaultProxyAdmin": "0xdA7C2F023Dd30329d41483B95AFd24962f468A54",
+    "FailSafe": "0xBDA73b600435BF4309270438842dcE06f9a06fb7",
+    "MarketplaceUniversalRouterZap": "0xf56296B3010a59Ef7F0915569DD44E1302b9Ca40",
+    "MigratorZap": "0x6E1537eD56f52414f0182FaebF79A5fB2Ad2CABd",
+    "NFTXEligibilityManager": "0x6DCdfD7e94957cBAE9023c232dE18c0F72c2aD16",
+    "NFTXFeeDistributorV3": "0x0d50970C7848ebbE52661e70057D7D063B7de886",
+    "NFTXInventoryStakingV3Upgradeable": "0xe39a7E67d3E3b6eAF58BC02C4E80C3688847d155",
+    "NFTXRouter": "0x52731751Dede22827ad47109f5e9697d75a3ef4d",
+    "nftxUniversalRouter": "0x0DA69287B4C1B28181E5d155dDDda7Fa5C32E5Ad",
+    "NFTXVaultFactoryUpgradeableV3": "0x4dEeb9D2Bff2e9C35ce1f013DcC4582F891cb711",
+    "NonfungiblePositionManager": "0x8AD238377531547838370B9C4aC346b9Ed5466Ea",
+    "permit2": "0x000000000022d473030f116ddee9f6b43ac78ba3",
+    "QuoterV2": "0xff3957CB28aB34186543281e0bbe0De05C9e7D6D",
+    "ShutdownRedeemerUpgradeable": "",
+    "SwapRouter": "0xeA60242d7183E3d13Dc17fb2A4D0230d34eef502",
+    "TickLens": "0x3f2797b0E19CBf2377B8DE2d1CEC2698AcA7b081",
+    "UniswapV3FactoryUpgradeable": "0xF4D0512FB47319B0CE9144EF582862e2921CaBF8",
+    "UniswapV3Staker": "0xd4E155135b7dFf66c9C3B34EcA4aE7d9555FE31F",
+    "WETH": "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1"
+  },
   "sepolia": {
     "CreateVaultZap": "0xD80b916470F8e79FD8d09874cb159CbB8D13d8da",
     "DefaultProxyAdmin": "0x36cBBb16F2FA71d4B773E9F4A11cF7FC53B13EfD",
@@ -34,6 +57,7 @@
     "NonfungiblePositionManager": "0xA9bCC1e29d3460177875f68fDCC0264D22c40BF0",
     "permit2": "0x000000000022d473030f116ddee9f6b43ac78ba3",
     "QuoterV2": "0xb8EB27ca4715f7A04228c6F83935379D1f5AbABd",
+    "ShutdownRedeemerUpgradeable": "0x4b25288f40C7e00F93f0DA261C314d67b640c9dF",
     "SwapRouter": "0xa7069da6a7e600e0348620484fD2B1f24E075d5f",
     "TickLens": "0xA13E04fAEe08E784A44C27e9E77Ca7a02D45BFd7",
     "UniswapV3FactoryUpgradeable": "0xDD2dce9C403f93c10af1846543870D065419E70b",
@@ -54,6 +78,7 @@
     "NonfungiblePositionManager": "0xDa9411C5455a1bfDb527d0988c0A2764E2a104be",
     "permit2": "0x000000000022d473030f116ddee9f6b43ac78ba3",
     "QuoterV2": "0xBb473dbEF3363b5d7CDD5f12429Fd1C5F0c10499",
+    "ShutdownRedeemerUpgradeable": "",
     "SwapRouter": "0x2E77A788fc66c5312354aaE0df1dC1895ce556f8",
     "TickLens": "0x32A7703773cBc265cf79D49340F656837169FEcD",
     "UniswapV3FactoryUpgradeable": "0xf25081B098c5929A26F562aa2502795fE89BC73f",

addresses.json

@@ -0,0 +1,12 @@
+import { HardhatRuntimeEnvironment, Network } from "hardhat/types";
+import { DeployFunction } from "hardhat-deploy/types";
+import { deployShutdownRedeemer } from "./modules/ShutdownRedeemer";
+
+const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
+  const { shutdownRedeemer } = await deployShutdownRedeemer({
+    hre,
+  });
+};
+export default func;
+func.tags = ["ShutdownRedeemer"];
+func.dependencies = [];

deploy/ShutdownRedeemer.ts

@@ -45,6 +45,7 @@ const config: {
     lpEarlyWithdrawPenaltyInWei: BigNumber;
     nftxRouterVTokenDustThreshold: BigNumber;
     multisig?: string;
+    UniswapV3Staker?: string;
   };
 } = {
   goerli: {
@@ -81,7 +82,7 @@ const config: {
     ...commonConfig,
     treasury: "0x40D73Df4F99bae688CE3C23a01022224FE16C7b2",
     WETH: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
-    REWARD_TIER_CARDINALITY: "102",
+    REWARD_TIER_CARDINALITY: "102", // average block time = 12 seconds (https://etherscan.io/chart/blocktime). Cardinality = (20mins * 60) / 12 = 100. then adding 2 extra blocks for good measures.
     permit2: "0x000000000022d473030f116ddee9f6b43ac78ba3",
     nftxUniversalRouter: "0x250d62a67254A46c0De472d2c9215E1d890cC90f", // NOTE: update this if new UniswapV3Factory deployed.
     v2VaultFactory: "0xBE86f647b167567525cCAAfcd6f881F1Ee558216",
@@ -91,14 +92,16 @@ const config: {
   },
   arbitrum: {
     ...commonConfig,
-    treasury: "0x000000000000000000000000000000000000dEaD", // FIXME: set valid address
+    treasury: "0x3863A65CE278a240f9Aa2A4b4A48493bE59E6139",
     WETH: "0x82aF49447D8a07e3bd95BD0d56f35241523fBab1",
-    REWARD_TIER_CARDINALITY: "75",
+    REWARD_TIER_CARDINALITY: "4617", // average block time = 0.26 seconds (https://arbiscan.io/chart/blocktime). Cardinality = (20mins * 60) / 0.26 = 4615. then adding 2 extra blocks for good measures.
     permit2: "0x000000000022d473030f116ddee9f6b43ac78ba3",
-    nftxUniversalRouter: "0x000000000000000000000000000000000000dEaD", // FIXME: set valid address
+    nftxUniversalRouter: "0x0DA69287B4C1B28181E5d155dDDda7Fa5C32E5Ad", // NOTE: update this if new UniswapV3Factory deployed.
     v2VaultFactory: "0xE77b89FEc41A7b7dC74eb33602e82F0672FbB33C",
     v2Inventory: "0x1A2C03ABD4Af7C87d8b4d5aD39b56fa98E8C4Cc6",
     sushiRouter: "0x1b02dA8Cb0d097eB8D57A175b88c7D8b47997506",
+    multisig: "0x3863A65CE278a240f9Aa2A4b4A48493bE59E6139",
+    UniswapV3Staker: "0xd4E155135b7dFf66c9C3B34EcA4aE7d9555FE31F",
   },
 };
 

deploy/deployConfig.ts

@@ -0,0 +1,33 @@
+import { HardhatRuntimeEnvironment } from "hardhat/types";
+import { getConfig, handleUpgradeDeploy } from "../utils";
+
+export const deployShutdownRedeemer = async ({
+  hre,
+}: {
+  hre: HardhatRuntimeEnvironment;
+}) => {
+  const { deployer, config } = await getConfig(hre);
+
+  const shutdownRedeemer = await handleUpgradeDeploy({
+    hre,
+    contractName: "ShutdownRedeemerUpgradeable",
+    deployOptions: {
+      from: deployer,
+      args: [config.v2VaultFactory],
+      proxy: {
+        proxyContract: "OpenZeppelinTransparentProxy",
+        execute: {
+          init: {
+            methodName: "__ShutdownRedeemer_init",
+            args: [],
+          },
+        },
+      },
+      log: true,
+    },
+  });
+
+  return {
+    shutdownRedeemer: shutdownRedeemer.address,
+  };
+};

deploy/modules/ShutdownRedeemer.ts

@@ -15,7 +15,6 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) {
     "DefaultProxyAdmin",
     "MarketplaceUniversalRouterZap",
     "MigratorZap",
-    "FailSafe",
     "NFTXFeeDistributorV3",
     "NFTXInventoryStakingV3Upgradeable",
     "NFTXRouter",

deploy/scripts/TransferOwnership.ts

@@ -5,6 +5,7 @@ import path from "path";
 import { format } from "prettier";
 import { keccak256, toUtf8Bytes, defaultAbiCoder } from "ethers/lib/utils";
 import deployConfig from "../deployConfig";
+import { Contract } from "ethers";
 
 export const getConfig = async (hre: HardhatRuntimeEnvironment) => {
   const { deployments, getNamedAccounts, network } = hre;
@@ -118,13 +119,16 @@ export const handleUpgradeDeploy = async ({
 }): Promise<Deployment> => {
   const { deploy, network, deployments } = await getConfig(hre);
 
-  const defaultProxyAdminContract = await getContract(hre, "DefaultProxyAdmin");
-
-  // set the current owner of the proxy, in the deployOptions
-  deployOptions.proxy = {
-    ...(typeof deployOptions.proxy === "object" ? deployOptions.proxy : {}),
-    owner: await defaultProxyAdminContract.owner(),
-  };
+  let defaultProxyAdminContract: Contract | undefined;
+  try {
+    // if the DefaultProxyAdmin is already deployed
+    defaultProxyAdminContract = await getContract(hre, "DefaultProxyAdmin");
+    // set the current owner of the proxy, in the deployOptions
+    deployOptions.proxy = {
+      ...(typeof deployOptions.proxy === "object" ? deployOptions.proxy : {}),
+      owner: await defaultProxyAdminContract.owner(),
+    };
+  } catch {}
 
   let deployment: Deployment | undefined = undefined;
   try {

deploy/utils/index.ts

@@ -0,0 +1 @@
+42161