Baseline V2 DTL Callback

script/salts/salts.json

@@ -19,10 +19,16 @@
     "0xeea914831cafc1587d76be464f11002411abf2a8819b9fdb690b0861a50b7013": "0xfc5a3e878c2ebbe399fd000b0874c27ddc00fccafbebc26a47062384fb792271"
   },
   "Test_BaselineAllocatedAllowlist": {
-    "0xdf4e330322b2cf16b983e30be68fdcc9f28aa9ca3ea5668db2da4680e00f7656": "0x90d7692e46b872b1176d8f108f9ffa9f37afd52ab59b2411c01b53d585a47df2"
+    "0x1faee5b1c5e1f51d292824d16ac337ab5e751d0d34ab975d497c7f0522abe4a5": "0x3c6ed49222aa4c2e296d1e5558263c7c4a68c820a5be7b9843c78c138fc51d4b"
+  },
+  "Test_BaselineAllowlist": {
+    "0xb6bc84a7c4b2e2bf8df9fb376187d15179701fd8bbb0f81e1ebf327967057c0f": "0x09c688d1cf01d00646fc1935f46c73aa9a9e122f53709c1c87659becb5b65eed"
   },
   "Test_BaselineAxisLaunch": {
-    "0x93fb862631c4414f2d4108397ca06e077a3caf62374b7a6c8fb38d35c275f02a": "0xd116feb11c4c04385a9476d1f1a1da81cfedca07a1b3638abd751622fbeffb8a"
+    "0x5554c48c8c661389476240aa7a1f3ec5cc9eee83e418504c25ee333d29d9bf87": "0x5ed9eb6bba3f801a5c7155da7e61545c108a342439c577724bf5514a06dd54a2"
+  },
+  "Test_BaselineCappedAllowlist": {
+    "0x4b6236fa5b749b4fa015814d771f50572468614e1f520a158aa7993702e66d42": "0x3602acfb2aae132c7c329d60ecff55a5a8eb29040ad118a66ed218c1640cd7d0"
   },
   "Test_CappedMerkleAllowlist": {
     "0xd46fcdc05daffec5dc7bd7b165f3ffef024c5074d5f5d8f096ad176a348b93e9": "0x9a505eb6b9322904cad8128403089877c62cbbfad4b91ab17f83e0e51bc519e2",

script/salts/test/TestSalts.s.sol

@@ -18,6 +18,8 @@ import {UniswapV3DirectToLiquidity} from "src/callbacks/liquidity/UniswapV3DTL.s
 import {BaselineAxisLaunch} from "src/callbacks/liquidity/BaselineV2/BaselineAxisLaunch.sol";
 import {BALwithAllocatedAllowlist} from
     "src/callbacks/liquidity/BaselineV2/BALwithAllocatedAllowlist.sol";
+import {BALwithAllowlist} from "src/callbacks/liquidity/BaselineV2/BALwithAllowlist.sol";
+import {BALwithCappedAllowlist} from "src/callbacks/liquidity/BaselineV2/BALwithCappedAllowlist.sol";
 import {UniswapV3Factory} from "test/lib/uniswap-v3/UniswapV3Factory.sol";
 import {GUniFactory} from "lib/g-uni-v1-core/contracts/GUniFactory.sol";
 import {UniswapV2Router02} from "uniswap-v2-periphery/UniswapV2Router02.sol";
@@ -563,4 +565,23 @@ contract TestSalts is Script, WithEnvironment, Permit2User, WithSalts, TestConst
         );
         _setTestSalt(callbackBytecodePath, "EF", "BaselineAllocatedAllowlist", callbackBytecodeHash);
     }
+
+    function generateBaselineAllowlist() public {
+        // Get the salt
+        bytes memory callbackArgs =
+            abi.encode(_AUCTION_HOUSE, _BASELINE_KERNEL, _BASELINE_QUOTE_TOKEN, _OWNER);
+        (string memory callbackBytecodePath, bytes32 callbackBytecodeHash) =
+            _writeBytecode("BaselineAllowlist", type(BALwithAllowlist).creationCode, callbackArgs);
+        _setTestSalt(callbackBytecodePath, "EF", "BaselineAllowlist", callbackBytecodeHash);
+    }
+
+    function generateBaselineCappedAllowlist() public {
+        // Get the salt
+        bytes memory callbackArgs =
+            abi.encode(_AUCTION_HOUSE, _BASELINE_KERNEL, _BASELINE_QUOTE_TOKEN, _OWNER);
+        (string memory callbackBytecodePath, bytes32 callbackBytecodeHash) = _writeBytecode(
+            "BaselineCappedAllowlist", type(BALwithCappedAllowlist).creationCode, callbackArgs
+        );
+        _setTestSalt(callbackBytecodePath, "EF", "BaselineCappedAllowlist", callbackBytecodeHash);
+    }
 }

src/callbacks/liquidity/BaselineV2/BALwithAllocatedAllowlist.sol

@@ -78,6 +78,7 @@ contract BALwithAllocatedAllowlist is BaselineAxisLaunch {
 
         // Set the merkle root and buyer limit
         merkleRoot = merkleRootParams;
+        emit MerkleRootSet(merkleRoot);
     }
 
     /// @inheritdoc BaselineAxisLaunch
@@ -100,7 +101,13 @@ contract BALwithAllocatedAllowlist is BaselineAxisLaunch {
         __onBid(lotId_, bidId_, buyer_, amount_, callbackData_);
     }
 
-    /// @notice Override this function to implement additional functionality
+    /// @notice Override this function to implement additional functionality for the `onBid` callback
+    ///
+    /// @param  lotId_          The ID of the lot
+    /// @param  bidId_          The ID of the bid
+    /// @param  buyer_          The address of the buyer
+    /// @param  amount_         The amount of quote tokens
+    /// @param  callbackData_   The callback data
     function __onBid(
         uint96 lotId_,
         uint64 bidId_,

src/callbacks/liquidity/BaselineV2/BALwithAllowlist.sol

@@ -1,15 +1,28 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.19;
 
-import {MerkleProofLib} from "lib/solady/src/utils/MerkleProofLib.sol";
+import {MerkleProof} from "lib/openzeppelin-contracts/contracts/utils/cryptography/MerkleProof.sol";
 
 import {BaselineAxisLaunch} from "src/callbacks/liquidity/BaselineV2/BaselineAxisLaunch.sol";
 
 /// @notice Allowlist version of the Baseline Axis Launch callback.
-/// @notice This version allows for a merkle tree to be used to determine which addresses are allowed to participate.
+/// @notice This version allows for a merkle tree to be used to determine which addresses are allowed to participate. However, the amount of quote tokens they can spend is not limited.
 contract BALwithAllowlist is BaselineAxisLaunch {
+    // ========== ERRORS ========== //
+
+    /// @notice Error message when the callback state does not support the action
+    error Callback_InvalidState();
+
+    // ========== EVENTS ========== //
+
+    /// @notice Emitted when the merkle root is set
+    event MerkleRootSet(bytes32 merkleRoot);
+
     // ========== STATE VARIABLES ========== //
 
+    /// @notice The root of the merkle tree that represents the allowlist
+    /// @dev    The merkle tree should adhere to the format specified in the OpenZeppelin MerkleProof library at https://github.com/OpenZeppelin/merkle-tree
+    ///         In particular, leaf values (such as `(address)` or `(address,uint256)`) should be double-hashed.
     bytes32 public merkleRoot;
 
     // ========== CONSTRUCTOR ========== //
@@ -34,6 +47,11 @@ contract BALwithAllowlist is BaselineAxisLaunch {
 
     // ========== CALLBACK FUNCTIONS ========== //
 
+    /// @inheritdoc BaselineAxisLaunch
+    /// @dev        This function reverts if:
+    ///             - `allowlistData_` is not of the correct length
+    ///
+    /// @param      allowlistData_  abi-encoded data: (bytes32) representing the merkle root
     function __onCreate(
         uint96,
         address,
@@ -43,13 +61,22 @@ contract BALwithAllowlist is BaselineAxisLaunch {
         bool,
         bytes memory allowlistData_
     ) internal virtual override {
+        // Check that the parameters are of the correct length
+        if (allowlistData_.length != 32) {
+            revert Callback_InvalidParams();
+        }
+
         // Decode the merkle root from the callback data
-        (bytes32 merkleRoot_) = abi.decode(allowlistData_, (bytes32));
+        bytes32 merkleRootParams = abi.decode(allowlistData_, (bytes32));
 
-        // Set the merkle root and buyer limit
-        merkleRoot = merkleRoot_;
+        // Set the merkle root
+        merkleRoot = merkleRootParams;
+        emit MerkleRootSet(merkleRoot);
     }
 
+    /// @inheritdoc BaselineAxisLaunch
+    ///
+    /// @param      callbackData_   abi-encoded data: (bytes32[]) representing the merkle proof
     function _onBid(
         uint96 lotId_,
         uint64 bidId_,
@@ -64,6 +91,13 @@ contract BALwithAllowlist is BaselineAxisLaunch {
         __onBid(lotId_, bidId_, buyer_, amount_, callbackData_);
     }
 
+    /// @notice Override this function to implement additional functionality for the `onBid` callback
+    ///
+    /// @param  lotId_          The ID of the lot
+    /// @param  bidId_          The ID of the bid
+    /// @param  buyer_          The address of the buyer
+    /// @param  amount_         The amount of quote tokens
+    /// @param  callbackData_   The callback data
     function __onBid(
         uint96 lotId_,
         uint64 bidId_,
@@ -79,11 +113,42 @@ contract BALwithAllowlist is BaselineAxisLaunch {
         bytes32[] memory proof = abi.decode(callbackData_, (bytes32[]));
 
         // Get the leaf for the buyer
-        bytes32 leaf = keccak256(abi.encodePacked(buyer_));
+        bytes32 leaf = keccak256(bytes.concat(keccak256(abi.encode(buyer_))));
 
         // Validate the merkle proof
-        if (!MerkleProofLib.verify(proof, merkleRoot, leaf)) {
+        if (!MerkleProof.verify(proof, merkleRoot, leaf)) {
             revert Callback_NotAuthorized();
         }
     }
+
+    // ========== ADMIN FUNCTIONS ========== //
+
+    /// @notice Sets the merkle root for the allowlist
+    ///         This function can be called by the owner to update the merkle root after `onCreate()`.
+    /// @dev    This function performs the following:
+    ///         - Performs validation
+    ///         - Sets the merkle root
+    ///         - Emits a MerkleRootSet event
+    ///
+    ///         This function reverts if:
+    ///         - The caller is not the owner
+    ///         - The auction has not been registered
+    ///         - The auction has been completed
+    ///
+    /// @param  merkleRoot_ The new merkle root
+    function setMerkleRoot(bytes32 merkleRoot_) external onlyOwner {
+        // Revert if onCreate has not been called
+        if (lotId == type(uint96).max) {
+            revert Callback_InvalidState();
+        }
+
+        // Revert if the auction has been completed already
+        if (auctionComplete) {
+            revert Callback_InvalidState();
+        }
+
+        merkleRoot = merkleRoot_;
+
+        emit MerkleRootSet(merkleRoot_);
+    }
 }

src/callbacks/liquidity/BaselineV2/BALwithCappedAllowlist.sol

@@ -1,17 +1,23 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.19;
 
+import {BaselineAxisLaunch} from "src/callbacks/liquidity/BaselineV2/BaselineAxisLaunch.sol";
 import {BALwithAllowlist} from "src/callbacks/liquidity/BaselineV2/BALwithAllowlist.sol";
 
 /// @notice Capped allowlist version of the Baseline Axis Launch callback.
 /// @notice This version allows for each address in the Merkle tree to have a standard amount of quote tokens they can spend.
 contract BALwithCappedAllowlist is BALwithAllowlist {
     // ========== ERRORS ========== //
+
+    /// @notice Error message when the bid amount exceeds the limit assigned to a buyer
     error Callback_ExceedsLimit();
 
     // ========== STATE VARIABLES ========== //
 
+    /// @notice The maximum amount a buyer can spend
     uint256 public buyerLimit;
+
+    /// @notice Tracks the cumulative amount spent by a buyer
     mapping(address => uint256) public buyerSpent;
 
     // ========== CONSTRUCTOR ========== //
@@ -36,6 +42,11 @@ contract BALwithCappedAllowlist is BALwithAllowlist {
 
     // ========== CALLBACK FUNCTIONS ========== //
 
+    /// @inheritdoc BaselineAxisLaunch
+    /// @dev        This function reverts if:
+    ///             - `allowlistData_` is not of the correct length
+    ///
+    /// @param      allowlistData_ abi-encoded data: (bytes32) representing the merkle root
     function __onCreate(
         uint96,
         address,
@@ -45,6 +56,11 @@ contract BALwithCappedAllowlist is BALwithAllowlist {
         bool,
         bytes memory allowlistData_
     ) internal override {
+        // Check that the parameters are of the correct length
+        if (allowlistData_.length != 64) {
+            revert Callback_InvalidParams();
+        }
+
         // Decode the merkle root from the callback data
         (bytes32 merkleRoot_, uint256 buyerLimit_) = abi.decode(allowlistData_, (bytes32, uint256));
 
@@ -54,8 +70,12 @@ contract BALwithCappedAllowlist is BALwithAllowlist {
         // Set the merkle root and buyer limit
         merkleRoot = merkleRoot_;
         buyerLimit = buyerLimit_;
+        emit MerkleRootSet(merkleRoot);
     }
 
+    /// @inheritdoc BALwithAllowlist
+    /// @dev        This function reverts if:
+    ///             - The buyer has already spent their limit
     function __onBid(
         uint96,
         uint64,
@@ -68,6 +88,7 @@ contract BALwithCappedAllowlist is BALwithAllowlist {
     }
 
     // ========== INTERNAL FUNCTIONS ========== //
+
     function _canBuy(address buyer_, uint256 amount_) internal {
         // Check if the buyer has already spent their limit
         if (buyerSpent[buyer_] + amount_ > buyerLimit) {