Uniswap v4 Integration

.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
       contents: read
       security-events: write
     env:
-      SOLC_VERSION: 0.8.20
+      SOLC_VERSION: 0.8.24
       ETH_MAINNET_RPC_URL: ${{ secrets.ETH_MAINNET_RPC_URL }}
       ETH_SEPOLIA_RPC_URL: ${{ secrets.ETH_SEPOLIA_RPC_URL }}
       BASE_MAINNET_RPC_URL: ${{ secrets.BASE_MAINNET_RPC_URL }}

.gitmodules

@@ -23,6 +23,12 @@
 [submodule "lib/solady"]
 	path = lib/solady
 	url = https://github.com/Vectorized/solady
+[submodule "lib/v4-periphery"]
+	path = lib/v4-periphery
+	url = https://github.com/Uniswap/v4-periphery
+[submodule "lib/v4-core"]
+	path = lib/v4-core
+	url = https://github.com/Uniswap/v4-core
 [submodule "lib/diamond-2-hardhat"]
 	path = lib/diamond-2-hardhat
 	url = https://github.com/nayms/diamond-2-hardhat

foundry.toml

@@ -7,7 +7,7 @@ remappings = ["forge-std/=lib/forge-std/src/"]
 libraries = []
 cache = true
 force = false
-evm_version = 'paris'
+evm_version = 'cancun'
 auto_detect_solc = true
 offline = true
 optimizer = true

gemforge.config.cjs

@@ -15,7 +15,7 @@ module.exports = {
     // SPDX License - to be inserted in all generated .sol files
     license: "MIT",
     // Solidity compiler version - to be inserted in all generated .sol files
-    version: "0.8.20",
+    version: "0.8.24",
   },
   // commands to execute
   commands: {
@@ -58,7 +58,7 @@ module.exports = {
     // proxy interface options
     proxyInterface: {
       // imports to include in the generated IDiamondProxy interface
-      imports: ["src/shared/FreeStructs.sol"],
+      imports: ["src/shared/FreeStructs.sol", "lib/v4-core/src/types/BalanceDelta.sol"],
     },
   },
   // diamond configuration

remappings.txt

@@ -8,3 +8,5 @@ solady/=lib/solady/src/
 solidity-lib/=lib/solidity-lib/contracts/
 solidity-stringutils/=lib/solidity-stringutils/
 solmate/=lib/solmate/src/
+@v4-core/=lib/v4-core
+@v4-periphery/=lib/v4-periphery

script/AddSupportedExternalToken.s.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import "forge-std/Script.sol";
 import { DiamondProxy } from "src/generated/DiamondProxy.sol";

script/CreateEntity.s.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import "forge-std/Script.sol";
 

script/deployment/DeployERC20.s.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 /// @notice Quickly deploy a mock ERC20 token, for testing only!
 

src/facets/ACLFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { LibAdmin } from "../libs/LibAdmin.sol";
 import { LibACL, LibHelpers } from "../libs/LibACL.sol";
@@ -24,7 +24,7 @@
      */
     function assignRole(bytes32 _objectId, bytes32 _contextId, string memory _role) external {
         bytes32 assignerId = LibHelpers._getSenderId();
         require(LibACL._canAssign(assignerId, _objectId, _contextId, LibHelpers._stringToBytes32(_role)), "not in assigners group");
 
         /// @dev First, assigner attempts to unassign the role.
         bytes32 roleId = LibACL._getRoleInContext(_objectId, _contextId);
@@ -45,7 +45,7 @@
     function unassignRole(bytes32 _objectId, bytes32 _contextId) external {
         bytes32 roleId = LibACL._getRoleInContext(_objectId, _contextId);
         bytes32 assignerId = LibHelpers._getSenderId();
         require(LibACL._canAssign(assignerId, _objectId, _contextId, roleId), "not in assigners group");
         LibACL._unassignRole(_objectId, _contextId);
     }
 
@@ -146,7 +146,7 @@
      * @param _roleInGroup is member of
      */
     function updateRoleGroup(string memory _role, string memory _group, bool _roleInGroup) external assertPrivilege(LibAdmin._getSystemId(), LC.GROUP_SYSTEM_ADMINS) {
         require(_group._stringToBytes32() != LC.GROUP_SYSTEM_ADMINS._stringToBytes32(), "system admins group is not modifiable");
         LibACL._updateRoleGroup(_role, _group, _roleInGroup);
     }
 }

src/facets/AdminFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { AppStorage, LibAppStorage } from "../shared/AppStorage.sol";
 import { Modifiers } from "../shared/Modifiers.sol";

src/facets/EntityFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { Entity, FeeSchedule } from "../shared/AppStorage.sol";
 import { Modifiers } from "../shared/Modifiers.sol";

src/facets/GovernanceFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { IDiamondCut } from "lib/diamond-2-hardhat/contracts/interfaces/IDiamondCut.sol";
 import { Modifiers } from "../shared/Modifiers.sol";
@@ -43,7 +43,7 @@
         AppStorage storage s = LibAppStorage.diamondStorage();
 
         if (s.upgradeScheduled[id] > block.timestamp) {
             revert("Upgrade has already been scheduled");
         }
         // 0 == upgrade is not scheduled / has been cancelled
         // block.timestamp + upgradeExpiration == upgrade is scheduled and expires at this time
@@ -61,7 +61,7 @@
     function updateUpgradeExpiration(uint256 duration) external assertPrivilege(LibAdmin._getSystemId(), LC.GROUP_SYSTEM_ADMINS) {
         AppStorage storage s = LibAppStorage.diamondStorage();
 
         require(1 minutes < duration && duration < 1 weeks, "invalid upgrade expiration period");
 
         s.upgradeExpiration = duration;
         emit UpdateUpgradeExpiration(duration);
@@ -75,7 +75,7 @@
     function cancelUpgrade(bytes32 id) external assertPrivilege(LibAdmin._getSystemId(), LC.GROUP_SYSTEM_ADMINS) {
         AppStorage storage s = LibAppStorage.diamondStorage();
 
         require(s.upgradeScheduled[id] > 0, "invalid upgrade ID");
 
         s.upgradeScheduled[id] = 0;
 

src/facets/MarketFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { Modifiers } from "../shared/Modifiers.sol";
 import { MarketInfo } from "../shared/AppStorage.sol";
@@ -33,9 +33,9 @@
      * @param _offerId offer ID
      */
     function cancelOffer(uint256 _offerId) external notLocked nonReentrant assertPrivilege(LibObject._getParentFromAddress(msg.sender), LC.GROUP_CANCEL_OFFER) {
         require(LibMarket._getOffer(_offerId).state == LC.OFFER_STATE_ACTIVE, "offer not active");
         bytes32 creator = LibMarket._getOffer(_offerId).creator;
         require(LibObject._getParent(LibHelpers._getSenderId()) == creator, "only member of entity can cancel");
         LibMarket._cancelOffer(_offerId);
     }
 

src/facets/NaymsOwnershipFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { LibDiamond } from "lib/diamond-2-hardhat/contracts/libraries/LibDiamond.sol";
 import { IERC173 } from "lib/diamond-2-hardhat/contracts/interfaces/IERC173.sol";
@@ -14,8 +14,8 @@
         bytes32 systemID = LibHelpers._stringToBytes32(LC.SYSTEM_IDENTIFIER);
         bytes32 newAcc1Id = LibHelpers._getIdForAddress(_newOwner);
 
         require(!LibACL._isInGroup(newAcc1Id, systemID, LibHelpers._stringToBytes32(LC.GROUP_SYSTEM_ADMINS)), "NEW owner MUST NOT be sys admin");
         require(!LibACL._isInGroup(newAcc1Id, systemID, LibHelpers._stringToBytes32(LC.GROUP_SYSTEM_MANAGERS)), "NEW owner MUST NOT be sys manager");
 
         LibDiamond.setContractOwner(_newOwner);
     }

src/facets/PhasedDiamondCutFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { DiamondCutFacet } from "lib/diamond-2-hardhat/contracts/facets/DiamondCutFacet.sol";
 import { LibDiamond } from "lib/diamond-2-hardhat/contracts/libraries/LibDiamond.sol";

src/facets/SimplePolicyFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { Modifiers } from "../shared/Modifiers.sol";
 import { SimplePolicyInfo, SimplePolicy, CalculatedFees, Stakeholders } from "../shared/AppStorage.sol";

src/facets/StakingFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { LibTokenizedVaultStaking, StakingConfig } from "../libs/LibTokenizedVaultStaking.sol";
 import { LibHelpers } from "../libs/LibHelpers.sol";

src/facets/SwapFacet.sol

@@ -0,0 +1,119 @@
+// SPDX-License-Identifier: MIT
+pragma solidity 0.8.24;
+
+import { LibAdmin } from "src/libs/LibAdmin.sol";
+import { LibObject } from "src/libs/LibObject.sol";
+import { LibConstants as LC } from "src/libs/LibConstants.sol";
+import { LibTokenizedVault } from "src/libs/LibTokenizedVault.sol";
+import { Modifiers } from "src/shared/Modifiers.sol";
+import { IPoolManager } from "v4-core/interfaces/IPoolManager.sol";
+import { BalanceDelta } from "v4-core/types/BalanceDelta.sol";
+import { Currency } from "v4-core/types/Currency.sol";
+import { CurrencySettler } from "lib/v4-core/test/utils/CurrencySettler.sol";
+import { SwapParams, CallbackData } from "../shared/FreeStructs.sol";
+import { StateLibrary } from "v4-core/libraries/StateLibrary.sol";
+import { TransientStateLibrary } from "v4-core/libraries/TransientStateLibrary.sol";
+
+/**
+ * @title Swap
+ * @notice Facet for working with Swaps
+ * @dev Swap facet
+ */
+contract SwapFacet is Modifiers {
+    using LibObject for address;
+    using CurrencySettler for Currency;
+    using TransientStateLibrary for IPoolManager;
+
+    function swap(
+        IPoolManager _manager,
+        SwapParams memory swapParams,
+        bytes32 _fromTokenId,
+        bytes32 _toTokenId,
+        bytes32 _toEntityId
+    ) external assertPrivilege(LibAdmin._getSystemId(), LC.GROUP_SYSTEM_ADMINS) returns (BalanceDelta delta) {
+        LibTokenizedVault._internalBurn(msg.sender._getParentFromAddress(), _fromTokenId, uint256(swapParams.params.amountSpecified));
+
+        // Swap tokens
+        delta = abi.decode(
+            _manager.unlock(abi.encode(CallbackData(msg.sender, swapParams.key, swapParams.params, swapParams.takeClaims, swapParams.settleUsingBurn, swapParams.hookData))),
+            (BalanceDelta)
+        );
+
+        LibTokenizedVault._internalMint(_toEntityId, _toTokenId, uint256(uint128(delta.amount0())));
+    }
+
+    function unlockCallback(bytes calldata rawData) external returns (bytes memory) {
+        IPoolManager _manager = IPoolManager(msg.sender);
+
+        // Decode the callback data
+        CallbackData memory data = abi.decode(rawData, (CallbackData));
+
+        // Initial balance checks (optional, but recommended for debugging and validation)
+        (, , int256 deltaBefore0) = _fetchBalances(_manager, data.key.currency0, data.sender, address(this));
+        (, , int256 deltaBefore1) = _fetchBalances(_manager, data.key.currency1, data.sender, address(this));
+
+        require(deltaBefore0 == 0, "deltaBefore0 is not equal to 0");
+        require(deltaBefore1 == 0, "deltaBefore1 is not equal to 0");
+
+        // Execute the swap on Uniswap V4 pool
+        BalanceDelta delta = _manager.swap(data.key, data.params, data.hookData);
+
+        // Post-swap balance checks
+        (, , int256 deltaAfter0) = _fetchBalances(_manager, data.key.currency0, data.sender, address(this));
+        (, , int256 deltaAfter1) = _fetchBalances(_manager, data.key.currency1, data.sender, address(this));
+
+        if (data.params.zeroForOne) {
+            if (data.params.amountSpecified < 0) {
+                // exact input, 0 for 1
+                require(deltaAfter0 >= data.params.amountSpecified, "deltaAfter0 is not greater than or equal to data.params.amountSpecified");
+                require(delta.amount0() == deltaAfter0, "delta.amount0() is not equal to deltaAfter0");
+                require(deltaAfter1 >= 0, "deltaAfter1 is not greater than or equal to 0");
+            } else {
+                // exact output, 0 for 1
+                require(deltaAfter0 <= 0, "deltaAfter0 is not less than or equal to zero");
+                require(delta.amount1() == deltaAfter1, "delta.amount1() is not equal to deltaAfter1");
+                require(deltaAfter1 <= data.params.amountSpecified, "deltaAfter1 is not less than or equal to data.params.amountSpecified");
+            }
+        } else {
+            if (data.params.amountSpecified < 0) {
+                // exact input, 1 for 0
+                require(deltaAfter1 >= data.params.amountSpecified, "deltaAfter1 is not greater than or equal to data.params.amountSpecified");
+                require(delta.amount1() == deltaAfter1, "delta.amount1() is not equal to deltaAfter1");
+                require(deltaAfter0 >= 0, "deltaAfter0 is not greater than or equal to 0");
+            } else {
+                // exact output, 1 for 0
+                require(deltaAfter1 <= 0, "deltaAfter1 is not less than or equal to 0");
+                require(delta.amount0() == deltaAfter0, "delta.amount0() is not equal to deltaAfter0");
+                require(deltaAfter0 <= data.params.amountSpecified, "deltaAfter0 is not less than or equal to data.params.amountSpecified");
+            }
+        }
+
+        // Post-swap balance handling
+        if (deltaAfter0 < 0) {
+            data.key.currency0.settle(_manager, data.sender, uint256(-deltaAfter0), data.settleUsingBurn);
+        }
+        if (deltaAfter1 < 0) {
+            data.key.currency1.settle(_manager, data.sender, uint256(-deltaAfter1), data.settleUsingBurn);
+        }
+        if (deltaAfter0 > 0) {
+            data.key.currency0.take(_manager, data.sender, uint256(deltaAfter0), data.takeClaims);
+        }
+        if (deltaAfter1 > 0) {
+            data.key.currency1.take(_manager, data.sender, uint256(deltaAfter1), data.takeClaims);
+        }
+
+        // Return the encoded delta
+        return abi.encode(delta);
+    }
+
+    function _fetchBalances(
+        IPoolManager _manager,
+        Currency currency,
+        address user,
+        address deltaHolder
+    ) internal view returns (uint256 userBalance, uint256 poolBalance, int256 delta) {
+        userBalance = currency.balanceOf(user);
+        poolBalance = currency.balanceOf(address(_manager));
+        delta = _manager.currencyDelta(deltaHolder, currency);
+    }
+}

src/facets/SystemFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { LibConstants as LC } from "../libs/LibConstants.sol";
 import { Modifiers } from "../shared/Modifiers.sol";

src/facets/TokenizedVaultFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { Modifiers } from "../shared/Modifiers.sol";
 import { LibConstants as LC } from "../libs/LibConstants.sol";

src/facets/TokenizedVaultIOFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { Modifiers } from "../shared/Modifiers.sol";
 import { LibTokenizedVaultIO } from "../libs/LibTokenizedVaultIO.sol";

src/facets/UserFacet.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { Modifiers } from "../shared/Modifiers.sol";
 import { LibConstants as LC } from "../libs/LibConstants.sol";

src/init/InitDiamond.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { IDiamondCut } from "lib/diamond-2-hardhat/contracts/interfaces/IDiamondCut.sol";
 import { IDiamondLoupe } from "lib/diamond-2-hardhat/contracts/interfaces/IDiamondLoupe.sol";

src/interfaces/IERC1271.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 // OpenZeppelin Contracts (last updated v5.0.0) (interfaces/IERC1271.sol)
 
-pragma solidity ^0.8.20;
+pragma solidity 0.8.24;
 
 /**
  * @dev Interface of the ERC1271 standard signature validation method for

src/interfaces/IERC165.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 interface IERC165 {
     /// @notice Query if a contract implements an interface

src/interfaces/IERC173.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 /// @title ERC-173 Contract Ownership Standard
 ///  Note: the ERC-165 identifier for this interface is 0x7f5828d0 is ERC165

src/interfaces/IERC20.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 /**
  * See https://github.com/OpenZeppelin/openzeppelin-contracts/tree/master/contracts/token/ERC20

src/libs/LibACL.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { AppStorage, LibAppStorage } from "../shared/AppStorage.sol";
 import { LibDiamond } from "lib/diamond-2-hardhat/contracts/libraries/LibDiamond.sol";

src/libs/LibAdmin.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { AppStorage, FunctionLockedStorage, LibAppStorage } from "../shared/AppStorage.sol";
 import { Entity, EntityApproval } from "../shared/FreeStructs.sol";

src/libs/LibConstants.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 /**
  * @dev Settings keys.

src/libs/LibEIP712.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { AppStorage, LibAppStorage } from "../shared/AppStorage.sol";
 

src/libs/LibERC20.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 /******************************************************************************\
 * Author: Nick Mudge

src/libs/LibEntity.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { LibAppStorage, AppStorage } from "../shared/AppStorage.sol";
 import { Entity } from "../shared/AppStorage.sol";

src/libs/LibFeeRouter.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { AppStorage, LibAppStorage, CalculatedFees, FeeAllocation, FeeSchedule } from "../shared/AppStorage.sol";
 import { LibObject } from "./LibObject.sol";

src/libs/LibGovernance.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { IDiamondCut } from "lib/diamond-2-hardhat/contracts/interfaces/IDiamondCut.sol";
 

src/libs/LibHelpers.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { LibConstants as LC } from "./LibConstants.sol";
 

src/libs/LibInitDiamond.sol

@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: MIT
-pragma solidity 0.8.20;
+pragma solidity 0.8.24;
 
 import { AppStorage, FunctionLockedStorage, LibAppStorage } from "../shared/AppStorage.sol";
 import { LibConstants as LC } from "./LibConstants.sol";