Merge pull request #114 from meTokens/chore/standard-descriptions

Standardise test description
meTokens · Feb 14, 2022 · 8cf98ee · 8cf98ee
2 parents aa59b85 + 4d98f49
commit 8cf98ee
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 54 deletions.
diff --git a/test/integration/Hub/UpdateCurveDetails.ts b/test/integration/Hub/UpdateCurveDetails.ts
@@ -25,10 +25,8 @@ import {
   passHours,
   passSeconds,
   setAutomine,
-  setNextBlockTimestamp,
 } from "../../utils/hardhatNode";
 import { ICurve } from "../../../artifacts/types/ICurve";
-import { start } from "repl";
 import { WeightedAverage } from "../../../artifacts/types/WeightedAverage";
 const setup = async () => {
   describe("Hub - update CurveDetails", () => {
@@ -117,7 +115,7 @@ const setup = async () => {
       const name = "Carl0 meToken";
       const symbol = "CARL";
 
-      const tx = await meTokenRegistry
+      await meTokenRegistry
         .connect(account0)
         .subscribe(name, symbol, firstHubId, 0);
       const meTokenAddr = await meTokenRegistry.getOwnerMeToken(
@@ -130,12 +128,10 @@ const setup = async () => {
       await token.connect(account1).approve(singleAssetVault.address, max);
       await token.connect(account2).approve(singleAssetVault.address, max);
 
-      const balBefore = await meToken.balanceOf(account2.address);
       const vaultBalBefore = await token.balanceOf(singleAssetVault.address);
       await foundry
         .connect(account2)
         .mint(meTokenAddr, tokenDeposited, account2.address);
-      const balAfter = await meToken.balanceOf(account2.address);
       const vaultBalAfter = await token.balanceOf(singleAssetVault.address);
       expect(vaultBalAfter.sub(vaultBalBefore)).to.equal(tokenDeposited);
       //setWarmup for 2 days
@@ -161,7 +157,7 @@ const setup = async () => {
     });
 
     describe("Warmup", () => {
-      it("should revert if targetCurve is the current curve", async () => {
+      it("should revert initUpdate() if targetCurve is the current curve", async () => {
         const updatedEncodedCurveDetails = ethers.utils.defaultAbiCoder.encode(
           ["uint256", "uint32"],
           [updatedBaseY, updatedReserveWeight]
@@ -175,7 +171,7 @@ const setup = async () => {
           )
         ).to.be.revertedWith("targetCurve==curve");
       });
-      it("Assets received based on initial curveDetails", async () => {
+      it("Assets received based on initial initialCurveDetails", async () => {
         const updatedEncodedCurveDetails = ethers.utils.defaultAbiCoder.encode(
           ["uint256", "uint32"],
           [updatedBaseY, updatedReserveWeight]
@@ -283,7 +279,7 @@ const setup = async () => {
       before(async () => {
         await passHours(1);
       });
-      it("Assets received for buyer based on weighted average burning full supply ", async () => {
+      it("Assets received for buyer based on weighted average  of curveDetails on burning full supply ", async () => {
         //move forward  3 Days
         await passDays(3);
         const tokenDepositedInETH = 100;
@@ -365,7 +361,7 @@ const setup = async () => {
           toETHNumber(balDaiAfterBurn.sub(balDaiAfterMint))
         ).to.be.approximately(assetsReturned, 0.000000000000001);
       });
-      it("Assets received for buyer based on weighted average not burning full supply ", async () => {
+      it("Assets received for buyer based on weighted average  of curveDetails on not burning full supply ", async () => {
         const tokenDepositedInETH = 100;
         const tokenDeposited = ethers.utils.parseEther(
           tokenDepositedInETH.toString()
@@ -447,7 +443,7 @@ const setup = async () => {
           toETHNumber(balDaiAfterBurn.sub(balDaiAfterMint))
         ).to.be.approximately(assetsReturned, 0.000000000000001);
       });
-      it("Assets received for owner based on weighted average not burning full supply ", async () => {
+      it("Assets received for owner based on weighted average  of curveDetails on not burning full supply ", async () => {
         // TODO: calculate weighted refundRatio based on current time relative to duration
         const tokenDepositedInETH = 100;
         const tokenDeposited = ethers.utils.parseEther(
@@ -537,7 +533,7 @@ const setup = async () => {
           toETHNumber(balDaiAfterBurn.sub(balDaiAfterMint))
         ).to.be.approximately(assetsReturned, 0.0000000000001);
       });
-      it("mint(): assets received based on weighted average", async () => {
+      it("mint(): assets received based on weighted average of curveDetails", async () => {
         const tokenDepositedInETH = 100;
         const tokenDeposited = ethers.utils.parseEther(
           tokenDepositedInETH.toString()
@@ -603,17 +599,10 @@ const setup = async () => {
     });
 
     describe("Cooldown", () => {
-      it("initUpdate() cannot be called", async () => {
-        const {
-          active,
-          refundRatio,
-          updating,
-          startTime,
-          endTime,
-          endCooldown,
-          reconfigure,
-          targetRefundRatio,
-        } = await hub.getDetails(1);
+      it("should revert initUpdate() if before cool down", async () => {
+        const { active, updating, endTime, reconfigure } = await hub.getDetails(
+          1
+        );
         expect(active).to.be.true;
         expect(updating).to.be.true;
         expect(reconfigure).to.be.false;
@@ -632,7 +621,7 @@ const setup = async () => {
         ).to.be.revertedWith("Still cooling down");
       });
 
-      it("burn() and mint() by owner should use the targetCurve", async () => {
+      it("burn() and mint() by owner should use the targetCurveDetails", async () => {
         // TODO: calculate weighted refundRatio based on current time relative to duration
         const tokenDepositedInETH = 100;
         const tokenDeposited = ethers.utils.parseEther(
@@ -733,7 +722,7 @@ const setup = async () => {
           toETHNumber(balDaiAfterBurn.sub(balDaiAfterMint))
         ).to.be.approximately(assetsReturned, 0.00000000001);
       });
-      it("burn() and mint() by buyer should use the targetCurve", async () => {
+      it("burn() and mint() by buyer should use the targetCurveDetails", async () => {
         // TODO: calculate weighted refundRatio based on current time relative to duration
         const tokenDepositedInETH = 100;
         const tokenDeposited = ethers.utils.parseEther(

diff --git a/test/integration/Hub/UpdateRefundRatio.ts b/test/integration/Hub/UpdateRefundRatio.ts
@@ -1,7 +1,6 @@
 import { ethers, getNamedAccounts } from "hardhat";
 import {
   calculateCollateralReturned,
-  calculateTokenReturned,
   deploy,
   getContractAt,
   toETHNumber,
@@ -50,8 +49,6 @@ const setup = async () => {
     const firstRefundRatio = 5000;
     const targetedRefundRatio = 500000; // 50%
     before(async () => {
-      // TODO: pre-load contracts
-      // NOTE: hub.register() should have already been called
       baseY = one.mul(1000);
       let DAI;
       ({ DAI } = await getNamedAccounts());
@@ -103,7 +100,7 @@ const setup = async () => {
       const name = "Carl0 meToken";
       const symbol = "CARL";
 
-      const tx = await meTokenRegistry
+      await meTokenRegistry
         .connect(account0)
         .subscribe(name, "CARL", firstHubId, 0);
       const meTokenAddr = await meTokenRegistry.getOwnerMeToken(
@@ -112,12 +109,10 @@ const setup = async () => {
       meToken = await getContractAt<MeToken>("MeToken", meTokenAddr);
 
       const tokenDeposited = ethers.utils.parseEther("100");
-      const balBefore = await meToken.balanceOf(account2.address);
       const vaultBalBefore = await token.balanceOf(singleAssetVault.address);
       await foundry
         .connect(account2)
         .mint(meTokenAddr, tokenDeposited, account2.address);
-      const balAfter = await meToken.balanceOf(account2.address);
       const vaultBalAfter = await token.balanceOf(singleAssetVault.address);
       expect(vaultBalAfter.sub(vaultBalBefore)).to.equal(tokenDeposited);
       //setWarmup for 2 days
@@ -142,7 +137,7 @@ const setup = async () => {
       expect(duration).to.equal(604800);
     });
 
-    describe("During warmup", () => {
+    describe("Warmup", () => {
       before(async () => {
         await hub.initUpdate(
           firstHubId,
@@ -151,12 +146,11 @@ const setup = async () => {
           ethers.utils.toUtf8Bytes("")
         );
       });
-      it("initUpdate() cannot be called", async () => {
-        // TODO: fast fwd a little bit
+      it("should revert initUpdate() if already updating", async () => {
+        // fast fwd a little bit
         let lastBlock = await ethers.provider.getBlock("latest");
         await passDays(1);
         lastBlock = await ethers.provider.getBlock("latest");
-        //await hub.setWarmup(172801);
         lastBlock = await ethers.provider.getBlock("latest");
         await expect(
           hub.initUpdate(1, bancorABDK.address, 1000, encodedCurveDetails)
@@ -243,14 +237,13 @@ const setup = async () => {
       before(async () => {
         await passHours(1);
       });
-      it("initUpdate() cannot be called", async () => {
-        // TODO: fast to active duration
+      it("should revert initUpdate() if already updating", async () => {
         await expect(
           hub.initUpdate(1, bancorABDK.address, 1000, encodedCurveDetails)
         ).to.be.revertedWith("already updating");
       });
 
-      it("Assets received for owner are not based on weighted average refund ratio only applies to buyer", async () => {
+      it("Assets received for owner should not apply refund ratio", async () => {
         //move forward  2 Days
         await passDays(2);
         const tokenDepositedInETH = 100;
@@ -306,7 +299,7 @@ const setup = async () => {
         );
       });
 
-      it("Assets received for buyer based on weighted average", async () => {
+      it("Assets received for buyer based on weighted average refundRatio", async () => {
         //move forward  3 Days
         await passDays(3);
         // TODO: calculate weighted refundRatio based on current time relative to duration
@@ -407,7 +400,7 @@ const setup = async () => {
         ).to.be.revertedWith("Still cooling down");
       });
 
-      it("Before refundRatio set, burn() for owner should not use the targetRefundRatio", async () => {
+      it("Before refundRatio set, burn() for owner should not apply refund ratio", async () => {
         const tokenDepositedInETH = 100;
         const tokenDeposited = ethers.utils.parseEther(
           tokenDepositedInETH.toString()

diff --git a/test/integration/MeTokenRegistry/ResubscribeCurve.ts b/test/integration/MeTokenRegistry/ResubscribeCurve.ts
@@ -214,13 +214,14 @@ const setup = async () => {
 
     describe("Warmup", () => {
       before(async () => {
+        // BlockTime < startTime
         const metokenDetails = await meTokenRegistry.getDetails(
           meToken.address
         );
         const block = await ethers.provider.getBlock("latest");
         expect(metokenDetails.startTime).to.be.gt(block.timestamp);
       });
-      it("mint(): meTokens received based on initial Curve", async () => {
+      it("mint() [buyer]: meTokens received based on initial Curve", async () => {
         const vaultDAIBefore = await dai.balanceOf(singleAssetVault.address);
         const meTokenTotalSupplyBefore = await meToken.totalSupply();
         expect(meTokenTotalSupplyBefore).to.be.equal(0);
@@ -351,6 +352,7 @@ const setup = async () => {
 
     describe("Duration", () => {
       before(async () => {
+        // IncreaseBlockTime > startTime
         const metokenDetails = await meTokenRegistry.getDetails(
           meToken.address
         );
@@ -359,7 +361,7 @@ const setup = async () => {
         const block = await ethers.provider.getBlock("latest");
         expect(metokenDetails.startTime).to.be.lt(block.timestamp);
       });
-      it("mint(): meTokens received based on weighted average of Curves", async () => {
+      it("mint() [buyer]: meTokens received based on weighted average of Curves", async () => {
         const vaultDAIBefore = await dai.balanceOf(singleAssetVault.address);
         const migrationWETHBefore = await weth.balanceOf(migration.address);
         const meTokenTotalSupplyBefore = await meToken.totalSupply();
@@ -560,6 +562,7 @@ const setup = async () => {
 
     describe("Cooldown", () => {
       before(async () => {
+        // IncreaseBlockTime > endTime
         const metokenDetails = await meTokenRegistry.getDetails(
           meToken.address
         );
@@ -568,7 +571,7 @@ const setup = async () => {
         const block = await ethers.provider.getBlock("latest");
         expect(metokenDetails.endTime).to.be.lt(block.timestamp);
       });
-      it("mint(): assets received based on target Curve", async () => {
+      it("mint() [buyer]: assets received based on target Curve", async () => {
         const vaultWETHBefore = await weth.balanceOf(singleAssetVault.address);
         const migrationWETHBefore = await weth.balanceOf(migration.address);
         const meTokenTotalSupplyBefore = await meToken.totalSupply();

diff --git a/test/integration/MeTokenRegistry/ResubscribeCurveDetails.ts b/test/integration/MeTokenRegistry/ResubscribeCurveDetails.ts
@@ -205,13 +205,14 @@ const setup = async () => {
 
     describe("Warmup", () => {
       before(async () => {
+        // BlockTime < startTime
         const metokenDetails = await meTokenRegistry.getDetails(
           meToken.address
         );
         const block = await ethers.provider.getBlock("latest");
         expect(metokenDetails.startTime).to.be.gt(block.timestamp);
       });
-      it("mint(): meTokens received based on initial Curve details", async () => {
+      it("mint() [buyer]: meTokens received based on initial Curve details", async () => {
         const vaultDAIBefore = await dai.balanceOf(singleAssetVault.address);
         const meTokenTotalSupplyBefore = await meToken.totalSupply();
         expect(meTokenTotalSupplyBefore).to.be.equal(0);
@@ -342,6 +343,7 @@ const setup = async () => {
 
     describe("Duration", () => {
       before(async () => {
+        // IncreaseBlockTime > startTime
         const metokenDetails = await meTokenRegistry.getDetails(
           meToken.address
         );
@@ -350,7 +352,7 @@ const setup = async () => {
         const block = await ethers.provider.getBlock("latest");
         expect(metokenDetails.startTime).to.be.lt(block.timestamp);
       });
-      it("mint(): meTokens received based on weighted average curve details", async () => {
+      it("mint() [buyer]: meTokens received based on weighted average curve details", async () => {
         const vaultDAIBefore = await dai.balanceOf(singleAssetVault.address);
         const migrationWETHBefore = await weth.balanceOf(migration.address);
         const meTokenTotalSupplyBefore = await meToken.totalSupply();
@@ -547,6 +549,7 @@ const setup = async () => {
 
     describe("Cooldown", () => {
       before(async () => {
+        // IncreaseBlockTime > endTime
         const metokenDetails = await meTokenRegistry.getDetails(
           meToken.address
         );
@@ -555,7 +558,7 @@ const setup = async () => {
         const block = await ethers.provider.getBlock("latest");
         expect(metokenDetails.endTime).to.be.lt(block.timestamp);
       });
-      it("burn(): finish migration must be called", async () => {
+      it("burn() [buyer]: finish migration must be called", async () => {
         const ownerMeToken = await meToken.balanceOf(account0.address);
         const migrationWETHBefore = await weth.balanceOf(migration.address);
         const meTokenTotalSupply = await meToken.totalSupply();