fix: contract comments

defi-wonderland · Jul 16, 2024 · 3bd1871 · 3bd1871
1 parent 6f23b2f
commit 3bd1871
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 4 deletions.
diff --git a/script/Deploy.s.sol b/script/Deploy.s.sol
@@ -8,6 +8,7 @@ import {IBFactory} from 'interfaces/IBFactory.sol';
 import {Script} from 'forge-std/Script.sol';
 import {Params} from 'script/Params.s.sol';
 
+/// @notice This base script is shared across `yarn script:{b|bcow}factory:{mainnet|testnet}`
 abstract contract DeployBaseFactory is Script, Params {
   constructor() Params(block.chainid) {}
 
@@ -21,12 +22,14 @@ abstract contract DeployBaseFactory is Script, Params {
   function _deployFactory() internal virtual returns (IBFactory);
 }
 
+/// @notice This script will be executed by `yarn script:bfactory:{mainnet|testnet}`
 contract DeployBFactory is DeployBaseFactory {
   function _deployFactory() internal override returns (IBFactory bFactory) {
     bFactory = new BFactory();
   }
 }
 
+/// @notice This script will be executed by `yarn script:bcowfactory:{mainnet|testnet}`
 contract DeployBCoWFactory is DeployBaseFactory {
   function _deployFactory() internal override returns (IBFactory bFactory) {
     bFactory = new BCoWFactory({

diff --git a/script/Params.s.sol b/script/Params.s.sol
@@ -1,7 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.25;
 
-contract Params {
+/// @notice Deployment parameters
+abstract contract Params {
   struct BFactoryDeploymentParams {
     address bDao;
   }

diff --git a/script/Registry.s.sol b/script/Registry.s.sol
@@ -6,8 +6,11 @@ import {BFactory} from 'contracts/BFactory.sol';
 
 import {Params} from 'script/Params.s.sol';
 
-contract Registry is Params {
+/// @notice Registry of deployed contracts
+abstract contract Registry is Params {
+  /// @notice Balancer Pool Factory
   BFactory public bFactory;
+  /// @notice Balancer CoW Pool Factory
   BCoWFactory public bCoWFactory;
 
   constructor(uint256 chainId) Params(chainId) {

diff --git a/script/Script.s.sol b/script/Script.s.sol
@@ -8,12 +8,13 @@ import {IFaucet} from 'interfaces/IFaucet.sol';
 import {Script} from 'forge-std/Script.sol';
 import {Registry} from 'script/Registry.s.sol';
 
+/// @notice This base script is shared across `yarn script:{mainnet|testnet}`
 abstract contract BaseScript is Registry, Script {
   constructor() Registry(block.chainid) {}
 }
 
+/// @notice This script will be executed by `yarn script:mainnet`
 contract MainnetScript is BaseScript {
-  /// @notice This script will be executed by `yarn script:mainnet`
   function run() public {
     assert(block.chainid == 1);
     vm.startBroadcast();
@@ -24,14 +25,14 @@ contract MainnetScript is BaseScript {
   }
 }
 
+/// @notice This script will be executed by `yarn script:testnet`
 contract TestnetScript is BaseScript {
   /// @notice ERC20 and Faucet addresses
   address internal constant _SEPOLIA_FAUCET = 0x26bfAecAe4D5fa93eE1737ce1Ce7D53F2a0E9b2d;
   address internal constant _SEPOLIA_BAL_TOKEN = 0xb19382073c7A0aDdbb56Ac6AF1808Fa49e377B75;
   address internal constant _SEPOLIA_DAI_TOKEN = 0xB77EB1A70A96fDAAeB31DB1b42F2b8b5846b2613;
   address internal constant _SEPOLIA_USDC_TOKEN = 0x80D6d3946ed8A1Da4E226aa21CCdDc32bd127d1A;
 
-  /// @notice This script will be executed by `yarn script:testnet`
   /// @dev The following is an example of a script that deploys a Balancer CoW pool
   function run() public {
     assert(block.chainid == 11_155_111);