Merge pull request #185 from defi-wonderland/chore/merge-dev-into-fuzz

chore: merge dev into fuzz

.env.example

@@ -1,6 +1,9 @@
 MAINNET_RPC=
 MAINNET_DEPLOYER_PK=
 
+GNOSIS_RPC=
+GNOSIS_DEPLOYER_PK=
+
 SEPOLIA_RPC=
 SEPOLIA_DEPLOYER_PK=
 

.forge-snapshots/exitPool.snap

@@ -1 +1 @@
-174743
+174820

.forge-snapshots/joinPool.snap

@@ -1 +1 @@
-138985
+138974

.forge-snapshots/newBCoWFactory.snap

@@ -0,0 +1 @@
+4200675

.forge-snapshots/newBCoWPool.snap

@@ -0,0 +1 @@
+3397437

.forge-snapshots/newBFactory.snap

@@ -1 +1 @@
-4130621
+3442127

.forge-snapshots/newBPool.snap

@@ -1 +1 @@
-3477592
+2841995

.forge-snapshots/settlementCoWSwap.snap

@@ -1 +1 @@
-215793
+215771

.forge-snapshots/settlementCoWSwapInverse.snap

@@ -1 +1 @@
-225641
+225619

.forge-snapshots/swapExactAmountIn.snap

@@ -1 +1 @@
-104914
+104964

.forge-snapshots/swapExactAmountInInverse.snap

@@ -1 +1 @@
-114583
+114787

.github/workflows/ci.yml

@@ -18,20 +18,20 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
+        uses: foundry-rs/foundry-toolchain@v1.2.0
         with:
           version: nightly
 
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version: 20.x
           cache: 'yarn'
 
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
 
-      - name: Precompile using 0.8.14 and via-ir=false
+      - name: Precompile contracts
         run: yarn build
 
       - name: Run tests
@@ -45,20 +45,20 @@ jobs:
       - uses: actions/checkout@v3
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
+        uses: foundry-rs/foundry-toolchain@v1.2.0
         with:
           version: nightly
 
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version: 20.x
           cache: 'yarn'
 
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
 
-      - name: Precompile using 0.8.14 and via-ir=false
+      - name: Precompile contracts
         run: yarn build
 
       - name: Run tests
@@ -77,14 +77,14 @@ jobs:
       - uses: wagoid/commitlint-github-action@v5
 
       - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
+        uses: foundry-rs/foundry-toolchain@v1.2.0
         with:
           version: nightly
 
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 18.x
+          node-version: 20.x
           cache: 'yarn'
 
       - name: Install bulloak 

README.md

@@ -32,6 +32,7 @@ yarn test    # run the tests
 - Deprecated `Migrations` contract (not needed)
 - Added an `_afterFinalize` hook (to be called at the end of the finalize routine)
 - Implemented reentrancy locks using transient storage.
+- Deprecated `joinswap` and `exitswap` methods (avoid single-token math precision issues)
 
 ## Features on BCoWPool (added via inheritance to BPool)
 - Immutably stores CoW Protocol's `SolutionSettler` and `VaultRelayer` addresses at deployment
@@ -57,3 +58,17 @@ yarn test    # run the tests
   - The weight represents the intended distribution of value between the tokens in the pool
 - Modify the pool's swap fee by calling `IBPool.setSwapFee(fee)`
 - Finalize the pool by calling `IBPool.finalize()`
+
+# Deployments
+Ethereum Mainnet:
+  - BCoWFactory: [0x23fcC2166F991B8946D195de53745E1b804C91B7](https://etherscan.io/address/0x23fcC2166F991B8946D195de53745E1b804C91B7)
+  - BCoWHelper: [0x5F6e7D3ef6e9aedD21C107BF8faA610f1215C730 ](https://etherscan.io/address/0x5F6e7D3ef6e9aedD21C107BF8faA610f1215C730 )
+
+Ethereum Sepolia:
+  - BCoWFactory: [0xF3F089AF5FaAF8784B445593B3bd8A514EaA3433 ](https://sepolia.etherscan.io/address/0xF3F089AF5FaAF8784B445593B3bd8A514EaA3433 )
+  - BCoWHelper: [0x07E7E9e3f4E715Ef1434b7f865fedBCE82Dd41Ba](https://sepolia.etherscan.io/address/0x07E7E9e3f4E715Ef1434b7f865fedBCE82Dd41Ba)
+  - BCoWPool: [0x4Cc911897fFCC5553627d454533D944F1D78CBdE](https://sepolia.etherscan.io/address/0x4Cc911897fFCC5553627d454533D944F1D78CBdE)
+
+  Gnosis Mainnet:
+  - BCoWFactory: [0x7573B99BC09c11Dc0427fb9c6662bc603E008304](https://gnosisscan.io/address/0x7573B99BC09c11Dc0427fb9c6662bc603E008304)
+  - BCoWHelper: [0x85315994492E88D6faCd3B0E3585c68A4720627e](https://gnosisscan.io/address/0x85315994492E88D6faCd3B0E3585c68A4720627e)

foundry.toml

@@ -38,8 +38,10 @@ max_test_rejects = 2_500_000
 
 [rpc_endpoints]
 mainnet = "${MAINNET_RPC}"
+gnosis = "${GNOSIS_RPC}"
 sepolia = "${SEPOLIA_RPC}"
 
 [etherscan]
 mainnet = { key = "${ETHERSCAN_API_KEY}", chain = "mainnet" }
+gnosis = { key = "${ETHERSCAN_API_KEY}", chain = "gnosis" }
 sepolia = { key = "${ETHERSCAN_API_KEY}", chain = "sepolia" }

package.json

@@ -1,30 +1,32 @@
 {
-  "name": "balancer-core",
-  "version": "0.0.7",
+  "name": "balancer-cow-amm",
+  "version": "1.4.0",
   "private": true,
-  "description": "Balancer Core Contracts and ABI",
-  "homepage": "https://github.com/balancer-labs/balancer-core#readme",
+  "description": "Balancer CoW AMM",
+  "homepage": "https://github.com/balancer/cow-amm#readme",
   "bugs": {
-    "url": "https://github.com/balancer-labs/balancer-core/issues"
+    "url": "https://github.com/balancer/cow-amm/issues"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/balancer-labs/balancer-core.git"
+    "url": "git+https://github.com/balancer/cow-amm.git"
   },
-  "license": "GPL-3.0-only",
+  "license": "GPL-3.0-or-later",
   "scripts": {
     "build": "forge build",
     "build:optimized": "FOUNDRY_PROFILE=optimized forge build",
-    "coverage": "forge coverage --match-contract Unit",
-    "deploy:bcowfactory:mainnet": "bash -c 'source .env && forge script DeployBCoWFactory -vvvvv --rpc-url $MAINNET_RPC --broadcast --chain mainnet --private-key $MAINNET_DEPLOYER_PK --verify --etherscan-api-key $ETHERSCAN_API_KEY'",
-    "deploy:bcowfactory:testnet": "bash -c 'source .env && forge script DeployBCoWFactory -vvvvv --rpc-url $SEPOLIA_RPC --broadcast --chain sepolia --private-key $SEPOLIA_DEPLOYER_PK --verify --etherscan-api-key $ETHERSCAN_API_KEY'",
-    "deploy:bfactory:mainnet": "bash -c 'source .env && forge script DeployBFactory -vvvvv --rpc-url $MAINNET_RPC --broadcast --chain mainnet --private-key $MAINNET_DEPLOYER_PK --verify --etherscan-api-key $ETHERSCAN_API_KEY'",
-    "deploy:bfactory:testnet": "bash -c 'source .env && forge script DeployBFactory -vvvvv --rpc-url $SEPOLIA_RPC --broadcast --chain sepolia --private-key $SEPOLIA_DEPLOYER_PK --verify --etherscan-api-key $ETHERSCAN_API_KEY'",
+    "coverage": "forge coverage --match-path 'test/unit/**'",
+    "deploy:gnosis": "forge script DeployBCoWFactory -vvvvv --rpc-url $GNOSIS_RPC --broadcast --chain gnosis --private-key $GNOSIS_DEPLOYER_PK --verify",
+    "deploy:mainnet": "forge script DeployBCoWFactory -vvvvv --rpc-url $MAINNET_RPC --broadcast --chain mainnet --private-key $MAINNET_DEPLOYER_PK --verify",
+    "deploy:testnet": "forge script DeployBCoWFactory -vvvvv --rpc-url $SEPOLIA_RPC --broadcast --chain sepolia --private-key $SEPOLIA_DEPLOYER_PK --verify",
     "lint:bulloak": "find test/unit -name '*.tree' | xargs bulloak check",
     "lint:check": "solhint 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol' && forge fmt --check",
     "lint:fix": "solhint --fix 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol' && sort-package-json && forge fmt",
     "lint:natspec": "npx @defi-wonderland/natspec-smells --config natspec-smells.config.js",
     "prepare": "husky install",
+    "script:gnosis": "forge script MainnetScript -vvvvv --rpc-url $GNOSIS_RPC --broadcast --chain gnosis --private-key $GNOSIS_DEPLOYER_PK --verify",
+    "script:mainnet": "forge script MainnetScript -vvvvv --rpc-url $MAINNET_RPC --broadcast --chain mainnet --private-key $MAINNET_DEPLOYER_PK --verify",
+    "script:testnet": "forge script TestnetScript -vvvvv --rpc-url $SEPOLIA_RPC --broadcast --chain sepolia --private-key $SEPOLIA_DEPLOYER_PK --verify",
     "smock": "smock-foundry --contracts src/contracts",
     "test": "yarn test:integration && yarn test:unit",
     "test:echidna": "find test/invariants/fuzz -regex '.*\\.t\\.sol$' |cut -d '/' -f 4 | cut -d . -f 1 |xargs -I{} echidna test/invariants/fuzz/{}.t.sol --contract Fuzz{} --config test/invariants/fuzz/{}.yaml",
@@ -44,6 +46,7 @@
     "@crytic/properties": "https://github.com/crytic/properties.git",
     "@openzeppelin/contracts": "5.0.2",
     "composable-cow": "github:cowprotocol/composable-cow.git#24d556b",
+    "cow-amm": "github:cowprotocol/cow-amm.git#6566128",
     "solmate": "github:transmissions11/solmate#c892309"
   },
   "devDependencies": {

remappings.txt

@@ -5,8 +5,11 @@ solmate/=node_modules/solmate/src
 @cowprotocol/=node_modules/@cowprotocol/contracts/src/contracts
 cowprotocol/=node_modules/@cowprotocol/contracts/src/
 @composable-cow/=node_modules/composable-cow/
+@cow-amm/=node_modules/cow-amm/src
+lib/openzeppelin/=node_modules/@openzeppelin
 halmos-cheatcodes=node_modules/halmos-cheatcodes
 @crytic/=node_modules/@crytic/
 
 contracts/=src/contracts
 interfaces/=src/interfaces
+libraries/=src/libraries

script/.solhint.json

@@ -0,0 +1,6 @@
+{
+  "rules": {
+    "one-contract-per-file": "off",
+    "custom-errors": "off"
+  }
+}

script/Deploy.s.sol

@@ -0,0 +1,43 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.25;
+
+import {BCoWFactory} from 'contracts/BCoWFactory.sol';
+import {BCoWHelper} from 'contracts/BCoWHelper.sol';
+import {BFactory} from 'contracts/BFactory.sol';
+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) {}
+
+  function run() public {
+    vm.startBroadcast();
+    IBFactory bFactory = _deployFactory();
+    bFactory.setBDao(_bFactoryDeploymentParams.bDao);
+    vm.stopBroadcast();
+  }
+
+  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({
+      solutionSettler: _bCoWFactoryDeploymentParams.settlement,
+      appData: _bCoWFactoryDeploymentParams.appData
+    });
+
+    new BCoWHelper(address(bFactory));
+  }
+}

script/Params.s.sol

@@ -1,36 +1,44 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.25;
 
-contract Params {
+/// @notice Deployment parameters
+abstract contract Params {
   struct BFactoryDeploymentParams {
-    address bLabs;
+    address bDao;
   }
 
   struct BCoWFactoryDeploymentParams {
-    address bLabs;
     address settlement;
     bytes32 appData;
   }
 
   /// @notice Settlement address
   address internal constant _GPV2_SETTLEMENT = 0x9008D19f58AAbD9eD0D60971565AA8510560ab41;
-
-  /// @notice AppData identifier
-  bytes32 internal constant _APP_DATA = bytes32('appData');
-
-  /// @notice BFactory deployment parameters for each chain
-  mapping(uint256 _chainId => BFactoryDeploymentParams _params) internal _bFactoryDeploymentParams;
-
-  /// @notice BCoWFactory deployment parameters for each chain
-  mapping(uint256 _chainId => BCoWFactoryDeploymentParams _params) internal _bCoWFactoryDeploymentParams;
-
-  constructor() {
-    // Mainnet
-    _bFactoryDeploymentParams[1] = BFactoryDeploymentParams(address(this));
-    _bCoWFactoryDeploymentParams[1] = BCoWFactoryDeploymentParams(address(this), _GPV2_SETTLEMENT, _APP_DATA);
-
-    // Sepolia
-    _bFactoryDeploymentParams[11_155_111] = BFactoryDeploymentParams(address(this));
-    _bCoWFactoryDeploymentParams[11_155_111] = BCoWFactoryDeploymentParams(address(this), _GPV2_SETTLEMENT, _APP_DATA);
+  /// @notice Balancer DAO address (has controller permission to collect fees from BFactory pools)
+  address internal constant _B_DAO = 0xce88686553686DA562CE7Cea497CE749DA109f9F;
+
+  /**
+   * @notice AppData identifier
+   * @dev Value obtained from https://explorer.cow.fi/appdata?tab=encode
+   *      - appCode: "CoW AMM Balancer"
+   *      - metadata:hooks:version: 0.1.0
+   *      - version: 1.1.0
+   */
+  bytes32 internal constant _APP_DATA = 0x362e5182440b52aa8fffe70a251550fbbcbca424740fe5a14f59bf0c1b06fe1d;
+
+  /// @notice BFactory deployment parameters
+  BFactoryDeploymentParams internal _bFactoryDeploymentParams;
+
+  /// @notice BCoWFactory deployment parameters
+  BCoWFactoryDeploymentParams internal _bCoWFactoryDeploymentParams;
+
+  constructor(uint256 chainId) {
+    if (chainId == 1 || chainId == 100 || chainId == 11_155_111) {
+      // Ethereum Mainnet & Ethereum Sepolia [Testnet]
+      _bFactoryDeploymentParams = BFactoryDeploymentParams({bDao: _B_DAO});
+      _bCoWFactoryDeploymentParams = BCoWFactoryDeploymentParams({settlement: _GPV2_SETTLEMENT, appData: _APP_DATA});
+    } else {
+      revert('Params: unknown chain ID');
+    }
   }
 }