simplyify mock token contract comments

balancer · Jul 23, 2024 · d1db3c5 · d1db3c5
1 parent 0d6a157
commit d1db3c5
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 34 deletions.
diff --git a/packages/foundry/contracts/hooks/VeBALFeeDiscountHook.sol b/packages/foundry/contracts/hooks/VeBALFeeDiscountHook.sol
@@ -15,7 +15,8 @@ import { IRouterCommon } from "@balancer-labs/v3-interfaces/contracts/vault/IRou
 import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 
 /**
- * @title VeBAL Fee Discount Hook Example
+ * @title VeBAL Fee Discount Hook
+ * @notice Applies a 50% discount to the swap fee for users holding veBAL tokens
  */
 contract VeBALFeeDiscountHook is BaseHooks {
     // only pools from the allowedFactory are able to register and use this hook

diff --git a/packages/foundry/contracts/mocks/MockToken1.sol b/packages/foundry/contracts/mocks/MockToken1.sol
@@ -3,20 +3,13 @@ pragma solidity ^0.8.24;
 
 import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
-/**
- * @title Mock Token 1
- * @notice Entire initial supply is minted to the deployer
- * @dev Default decimals is 18, but you can override the decimals function from ERC20
- */
 contract MockToken1 is ERC20 {
+    // Mint the initial supply to the deployer
     constructor(string memory name, string memory symbol, uint256 initialSupply) ERC20(name, symbol) {
         _mint(msg.sender, initialSupply);
     }
 
-    /**
-     * Allow any user to mint any amount of tokens to their wallet
-     * This function is accessible on the frontend's "Debug" page
-     */
+    // Allow any user to mint any amount of tokens to their wallet
     function mint(uint256 amount) external {
         _mint(msg.sender, amount);
     }

diff --git a/packages/foundry/contracts/mocks/MockToken2.sol b/packages/foundry/contracts/mocks/MockToken2.sol
@@ -3,20 +3,13 @@ pragma solidity ^0.8.24;
 
 import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
-/**
- * @title Mock Token 2
- * @notice Entire initial supply is minted to the deployer
- * @dev Default decimals is 18, but you can override the decimals function from ERC20
- */
 contract MockToken2 is ERC20 {
+    // Mint the initial supply to the deployer
     constructor(string memory name, string memory symbol, uint256 initialSupply) ERC20(name, symbol) {
         _mint(msg.sender, initialSupply);
     }
 
-    /**
-     * Allow any user to mint any amount of tokens to their wallet
-     * This function is accessible on the frontend's "Debug" page
-     */
+    // Allow any user to mint any amount of tokens to their wallet
     function mint(uint256 amount) external {
         _mint(msg.sender, amount);
     }

diff --git a/packages/foundry/contracts/mocks/MockVeBAL.sol b/packages/foundry/contracts/mocks/MockVeBAL.sol
@@ -3,20 +3,13 @@ pragma solidity ^0.8.24;
 
 import { ERC20 } from "@openzeppelin/contracts/token/ERC20/ERC20.sol";
 
-/**
- * @title Mock VeBAL
- * @notice Entire initial supply is minted to the deployer
- * @dev Default decimals is 18, but you can override the decimals function from ERC20
- */
 contract MockVeBAL is ERC20 {
+    // Mint the initial supply to the deployer
     constructor(string memory name, string memory symbol, uint256 initialSupply) ERC20(name, symbol) {
         _mint(msg.sender, initialSupply);
     }
 
-    /**
-     * Allow any user to mint any amount of tokens to their wallet
-     * This function is accessible on the frontend's "Debug" page
-     */
+    // Allow any user to mint any amount of tokens to their wallet
     function mint(uint256 amount) external {
         _mint(msg.sender, amount);
     }

diff --git a/packages/nextjs/contracts/deployedContracts.ts b/packages/nextjs/contracts/deployedContracts.ts
@@ -7,7 +7,7 @@ import { GenericContractsDeclaration } from "~~/utils/scaffold-eth/contract";
 const deployedContracts = {
   31337: {
     MockToken1: {
-      address: "0x539383fDc37eE70495088826ec32F6B28153245C",
+      address: "0x8e8cB505973E04200554Bd98741086C7Eca9f42a",
       abi: [
         {
           type: "constructor",
@@ -365,7 +365,7 @@ const deployedContracts = {
       },
     },
     MockToken2: {
-      address: "0x69d2485148F2F6e408db39C2516D948Ac1CD69Ab",
+      address: "0xC2D1A7c03C0459a8d0Ee885283CE828DE5fFf617",
       abi: [
         {
           type: "constructor",
@@ -723,7 +723,7 @@ const deployedContracts = {
       },
     },
     MockVeBAL: {
-      address: "0xE5A9Ef3838184697602d9c95782304E9b86E230D",
+      address: "0x906e3a6d1baf80e3e3fa3D57A5DA73099Da86C4c",
       abi: [
         {
           type: "constructor",
@@ -1081,7 +1081,7 @@ const deployedContracts = {
       },
     },
     ConstantSumFactory: {
-      address: "0x0EAa0A56CF3260e1999067c174E1f044389C9f5b",
+      address: "0x68c87F9fB214Bb4856a13c9123f9b0624944D1A6",
       abi: [
         {
           type: "constructor",
@@ -1465,7 +1465,7 @@ const deployedContracts = {
       },
     },
     ConstantProductFactory: {
-      address: "0xD15Fcc7b91470BDd22a5756B5Add434E9421cea4",
+      address: "0x2a374E85Ca5F1af906De5CdDa3658219e8759097",
       abi: [
         {
           type: "constructor",
@@ -1849,7 +1849,7 @@ const deployedContracts = {
       },
     },
     VeBALFeeDiscountHook: {
-      address: "0xd3d3399b02b8Bde3b4A77295393679d95C380f10",
+      address: "0xb33ca895101aB93835fd846d8C23FBdBC29d5843",
       abi: [
         {
           type: "constructor",