CoW AMM Router: CoW Sender transfers to Vault upfront (No approval)

pkg/interfaces/contracts/pool-cow/ICowRouter.sol

@@ -0,0 +1,195 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+pragma solidity ^0.8.24;
+
+import { IERC20 } from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
+
+import { SwapKind } from "../vault/VaultTypes.sol";
+
+interface ICowRouter {
+    /**
+     * @notice Data for the swap and donate hook.
+     * @dev The swap and donate hook is used to swap on CoW AMM pools and donate surplus or fees to the same pool.
+     * @param pool Address of the CoW AMM Pool
+     * @param sender Account originating the swap and donate operation
+     * @param swapKind Type of swap (exact in or exact out)
+     * @param swapTokenIn The token entering the Vault (balance increases)
+     * @param swapTokenOut The token leaving the Vault (balance decreases)
+     * @param swapMaxAmountIn Exact amount in, when swap is EXACT_IN, or max amount in if swap is EXACT OUT
+     * @param swapMinAmountOut Max amount out, when swap is EXACT_IN, or exact amount out if swap is EXACT OUT
+     * @param swapDeadline Deadline for the swap, after which it will revert
+     * @param donationAmounts Amount of tokens to donate + protocol fees, sorted in token registration order
+     * @param transferHint Amount of tokens transferred upfront, sorted in token registration order
+     * @param userData Additional (optional) data sent with the swap request and emitted with donation and swap events
+     */
+    struct SwapAndDonateHookParams {
+        address pool;
+        address sender;
+        SwapKind swapKind;
+        IERC20 swapTokenIn;
+        IERC20 swapTokenOut;
+        uint256 swapMaxAmountIn;
+        uint256 swapMinAmountOut;
+        uint256 swapDeadline;
+        uint256[] donationAmounts;
+        uint256[] transferHint;
+        bytes userData;
+    }
+
+    /**
+     * @notice Data for the donate hook.
+     * @dev The donate hook is used to donate surplus or fees to a CoW AMM pool.
+     * @param pool Address of the CoW AMM Pool
+     * @param sender Account originating the donate operation
+     * @param donationAmounts Amount of tokens to donate + protocol fees, sorted in token registration order
+     * @param userData Additional (optional) data sent with the swap request and emitted with the donation event
+     */
+    struct DonateHookParams {
+        address pool;
+        address sender;
+        uint256[] donationAmounts;
+        bytes userData;
+    }
+
+    /// @notice The swap transaction was not validated before the specified deadline timestamp.
+    error SwapDeadline();
+
+    /**
+     * @notice The `newProtocolFeePercentage` is above the maximum limit.
+     * @param newProtocolFeePercentage New value of the protocol fee percentage
+     * @param maxProtocolFeePercentage The maximum protocol fee percentage
+     */
+    error ProtocolFeePercentageAboveLimit(uint256 newProtocolFeePercentage, uint256 maxProtocolFeePercentage);
+
+    /**
+     * @notice A swap and a donation have occurred.
+     * @param pool The pool with the tokens being swapped
+     * @param swapTokenIn The token entering the Vault (balance increases)
+     * @param swapTokenOut The token leaving the Vault (balance decreases)
+     * @param swapAmountIn Number of tokenIn tokens
+     * @param swapAmountOut Number of tokenOut tokens
+     * @param donationAfterFees Amounts donated to the pool after protocol fees, sorted in token registration order
+     * @param protocolFeeAmounts Fees collected by the protocol, sorted in token registration order
+     * @param userData Additional (optional) data sent with the swap and donate request
+     */
+    event CoWSwapAndDonation(
+        address pool,
+        IERC20 swapTokenIn,
+        IERC20 swapTokenOut,
+        uint256 swapAmountIn,
+        uint256 swapAmountOut,
+        uint256[] donationAfterFees,
+        uint256[] protocolFeeAmounts,
+        bytes userData
+    );
+
+    /**
+     * @notice A donation has occurred.
+     * @param pool The pool that receives the donation
+     * @param donationAfterFees Amounts donated to the pool after protocol fees, sorted in token registration order
+     * @param protocolFeeAmounts Fees collected by the protocol, sorted in token registration order
+     * @param userData Additional (optional) data sent with the donate request
+     */
+    event CoWDonation(address pool, uint256[] donationAfterFees, uint256[] protocolFeeAmounts, bytes userData);
+
+    /**
+     * @notice The protocol fee percentage charged on donations was changed.
+     * @param newProtocolFeePercentage The new protocol fee percentage
+     */
+    event ProtocolFeePercentageChanged(uint256 newProtocolFeePercentage);
+
+    /**
+     * @notice Executes an ExactIn swap and donates a specified amount to the same CoW AMM Pool.
+     * @dev This is a permissioned function, intended to be called only by a `CoW Settlement` contract. CoW AMM matches
+     * transaction tokens outside of the pool, and donates fees (surplus) back to the pool. Therefore, the swap has no
+     * fees, but protocol fees are charged on the donation amount. On success, it emits a CoWSwapAndDonation event.
+     *
+     * @param pool The pool with the tokens being swapped
+     * @param swapTokenIn The token entering the Vault (balance increases)
+     * @param swapTokenOut The token leaving the Vault (balance decreases)
+     * @param swapExactAmountIn Number of tokenIn tokens
+     * @param swapMinAmountOut Minimum number of tokenOut tokens
+     * @param swapDeadline Deadline for the swap, after which it will revert
+     * @param donationAmounts Amount of tokens to donate + protocol fees, sorted in token registration order
+     * @param transferHint Amount of tokens transferred upfront, sorted in token registration order
+     * @param userData Additional (optional) data sent with the swap and donate request
+     * @return exactAmountOut Number of tokenOut tokens returned from the swap
+     */
+    function swapExactInAndDonateSurplus(
+        address pool,
+        IERC20 swapTokenIn,
+        IERC20 swapTokenOut,
+        uint256 swapExactAmountIn,
+        uint256 swapMinAmountOut,
+        uint256 swapDeadline,
+        uint256[] memory donationAmounts,
+        uint256[] memory transferHint,
+        bytes memory userData
+    ) external returns (uint256 exactAmountOut);
+
+    /**
+     * @notice Executes an ExactOut swap and donates a specified amount to the same CoW AMM Pool.
+     * @dev This is a permissioned function, intended to be called only by a `CoW Settlement` contract. CoW AMM matches
+     * transaction tokens outside of the pool, and donates fees (surplus) back to the pool. Therefore, the swap has no
+     * fees, but protocol fees are charged on the donation amount. On success, it emits a CoWSwapAndDonation event.
+     *
+     * @param pool The pool with the tokens being swapped
+     * @param swapTokenIn The token entering the Vault (balance increases)
+     * @param swapTokenOut The token leaving the Vault (balance decreases)
+     * @param swapMaxAmountIn Maximum number of tokenIn tokens
+     * @param swapExactAmountOut Number of tokenOut tokens
+     * @param swapDeadline Deadline for the swap, after which it will revert
+     * @param donationAmounts Amount of tokens to donate + protocol fees, sorted in token registration order
+     * @param transferHint Amount of tokens transferred upfront, sorted in token registration order
+     * @param userData Additional (optional) data sent with the swap and donate request
+     * @return exactAmountIn Number of tokenIn tokens charged in the swap
+     */
+    function swapExactOutAndDonateSurplus(
+        address pool,
+        IERC20 swapTokenIn,
+        IERC20 swapTokenOut,
+        uint256 swapMaxAmountIn,
+        uint256 swapExactAmountOut,
+        uint256 swapDeadline,
+        uint256[] memory donationAmounts,
+        uint256[] memory transferHint,
+        bytes memory userData
+    ) external returns (uint256 exactAmountIn);
+
+    /**
+     * @notice Executes a donation of a specified amount to a CoW AMM Pool.
+     * @dev This is a permissioned function, intended to be used to donate amounts to CoW AMM pools. On success, emits
+     * a CoWDonation event. userData may be used to explain the reason of the CoWDonation.
+     *
+     * @param pool The pool that receives the donation
+     * @param donationAmounts Amount of tokens to donate + protocol fees, sorted in token registration order
+     * @param userData Additional (optional) data sent with the donate request
+     */
+    function donate(address pool, uint256[] memory donationAmounts, bytes memory userData) external;
+
+    /**
+     * @notice Returns the protocol fee percentage, registered in the CoW Router.
+     * @dev The protocol fee percentage is used to calculate the amount of protocol fees to charge on a donation.
+     * The fees stay in the router.
+     *
+     * @return protocolFeePercentage The current protocol fee percentage
+     */
+    function getProtocolFeePercentage() external view returns (uint256 protocolFeePercentage);
+
+    /**
+     * @notice Returns the protocol fees collected by the CoW Router for a specific token.
+     * @dev The protocol fees collected by the CoW Router stay in the CoW router contract.
+     * @param token Token with collected protocol fees
+     * @return fees Protocol fees collected for the specific token
+     */
+    function getCollectedProtocolFees(IERC20 token) external view returns (uint256 fees);
+
+    /**
+     * @notice Sets the protocol fee percentage.
+     * @dev This is a permissioned function. The protocol fee percentage is capped at a maximum value, registered as a
+     * constant in the CoW AMM Router.
+     *
+     * @param newProtocolFeePercentage New value of the protocol fee percentage
+     */
+    function setProtocolFeePercentage(uint256 newProtocolFeePercentage) external;
+}

pkg/pool-cow/.solcover.js

@@ -0,0 +1,3 @@
+module.exports = {
+  skipFiles: ['test'],
+};

pkg/pool-cow/.solhintignore

@@ -0,0 +1 @@
+contracts/test/

pkg/pool-cow/README.md

@@ -0,0 +1,7 @@
+# <img src="../../logo.svg" alt="Balancer" height="128px">
+
+# CoW AMM in Balancer V3
+
+## Licensing
+
+[GNU General Public License Version 3 (GPL v3)](../../LICENSE).