Merge pull request #138 from CirclesUBI/20240412-operate-flow-reentre…

…ncy-guard 20240412 operate flow reentrency guard
CirclesUBI · May 3, 2024 · f17bb8f · f17bb8f
2 parents 9461fb2 + 9467030
commit f17bb8f
Show file tree

Hide file tree

Showing 28 changed files with 65 additions and 29 deletions.
diff --git a/src/circles/Circles.sol b/src/circles/Circles.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "../lib/Math64x64.sol";
 import "./ERC1155.sol";

diff --git a/src/circles/Demurrage.sol b/src/circles/Demurrage.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "../errors/Errors.sol";
 import "../lib/Math64x64.sol";

diff --git a/src/circles/DiscountedBalances.sol b/src/circles/DiscountedBalances.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "../lib/Math64x64.sol";
 import "./Demurrage.sol";

diff --git a/src/circles/ICircles.sol b/src/circles/ICircles.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "./IDemurrage.sol";
 

diff --git a/src/circles/IDemurrage.sol b/src/circles/IDemurrage.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 interface IDemurrage {
     function inflationDayZero() external view returns (uint256);

diff --git a/src/errors/Errors.sol b/src/errors/Errors.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 interface IHubErrors {
     error CirclesHubOnlyDuringBootstrap(uint8 code);
@@ -69,6 +69,8 @@ interface ICirclesErrors {
     error CirclesLogicAssertion(uint8 code);
 
     error CirclesIdMustBeDerivedFromAddress(uint256 providedId, uint8 code);
+
+    error CirclesReentrancyGuard(uint8 code);
 }
 
 interface IStandardTreasuryErrors {

diff --git a/src/groups/BaseMintPolicy.sol b/src/groups/BaseMintPolicy.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "./IMintPolicy.sol";
 import "./Definitions.sol";

diff --git a/src/groups/Definitions.sol b/src/groups/Definitions.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 contract BaseMintPolicyDefinitions {
     // Type declarations

diff --git a/src/groups/IMintPolicy.sol b/src/groups/IMintPolicy.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 interface IMintPolicy {
     function beforeMintPolicy(

diff --git a/src/hub/Hub.sol b/src/hub/Hub.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "../circles/Circles.sol";
 import "../errors/Errors.sol";
@@ -131,6 +131,14 @@ contract Hub is Circles, MetadataDefinitions, IHubErrors, ICirclesErrors {
      */
     mapping(address => mapping(address => TrustMarker)) public trustMarkers;
 
+    /**
+     * @dev Normal storage slot for the reentrancy guard.
+     * todo: the original task was to use a transient storage slot,
+     * but solc v0.8.24 still didn't recognize the tload/tstore assembly.
+     * see
+     */
+    bool private _reentrancyGuard;
+
     // Events
 
     event RegisterHuman(address indexed avatar);
@@ -166,6 +174,32 @@ contract Hub is Circles, MetadataDefinitions, IHubErrors, ICirclesErrors {
         _;
     }
 
+    /**
+     * @dev Reentrancy guard for nonReentrant functions.
+     * see https://soliditylang.org/blog/2024/01/26/transient-storage/
+     */
+    modifier nonReentrant(uint8 _code) {
+        // todo: this should use transient storage slot
+        // but didn't compile; investigate
+        // assembly {
+        //     if tload(0) { revert(0, 0) }
+        //     tstore(0, 1)
+        // }
+        // _;
+        // assembly {
+        //     tstore(0, 0)
+        // }
+
+        // for now, default to normal storage slot
+        // replace this later with transient storage slot
+        if (_reentrancyGuard) {
+            revert CirclesReentrancyGuard(_code);
+        }
+        _reentrancyGuard = true;
+        _;
+        _reentrancyGuard = false;
+    }
+
     // Constructor
 
     /**
@@ -527,7 +561,7 @@ contract Hub is Circles, MetadataDefinitions, IHubErrors, ICirclesErrors {
         FlowEdge[] calldata _flow,
         Stream[] calldata _streams,
         bytes calldata _packedCoordinates
-    ) external {
+    ) external nonReentrant(0) {
         // first unpack the coordinates to array of uint16
         uint16[] memory coordinates = _unpackCoordinates(_packedCoordinates, _flow.length);
 

diff --git a/src/hub/IHub.sol b/src/hub/IHub.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC1155/IERC1155.sol";
 import "../circles/ICircles.sol";

diff --git a/src/hub/MetadataDefinitions.sol b/src/hub/MetadataDefinitions.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 contract MetadataDefinitions {
     // Type declarations

diff --git a/src/lift/DemurrageCircles.sol b/src/lift/DemurrageCircles.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

diff --git a/src/lift/ERC20DiscountedBalances.sol b/src/lift/ERC20DiscountedBalances.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "../circles/Demurrage.sol";

diff --git a/src/lift/ERC20InflationaryBalances.sol b/src/lift/ERC20InflationaryBalances.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 import "../circles/Demurrage.sol";

diff --git a/src/lift/ERC20Lift.sol b/src/lift/ERC20Lift.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/utils/Create2.sol";
 import "../errors/Errors.sol";

diff --git a/src/lift/ERC20Permit.sol b/src/lift/ERC20Permit.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

diff --git a/src/lift/IERC20Lift.sol b/src/lift/IERC20Lift.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 enum CirclesType {
     Demurrage,

diff --git a/src/lift/InflationaryCircles.sol b/src/lift/InflationaryCircles.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";

diff --git a/src/migration/IHub.sol b/src/migration/IHub.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 /**
  * @title IHub v1

diff --git a/src/migration/IToken.sol b/src/migration/IToken.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC20/IERC20.sol";
 

diff --git a/src/migration/Migration.sol b/src/migration/Migration.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "../errors/Errors.sol";
 import "../hub/IHub.sol";

diff --git a/src/names/Base58Converter.sol b/src/names/Base58Converter.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 contract Base58Converter {
     string internal constant ALPHABET = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";

diff --git a/src/names/INameRegistry.sol b/src/names/INameRegistry.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 interface INameRegistry {
     function updateCidV0Digest(address avatar, bytes32 cidVoDigest) external;

diff --git a/src/names/NameRegistry.sol b/src/names/NameRegistry.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "../errors/Errors.sol";
 import "../hub/IHub.sol";

diff --git a/src/treasury/IStandardVault.sol b/src/treasury/IStandardVault.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 interface IStandardVault {
     function returnCollateral(address receiver, uint256[] calldata ids, uint256[] calldata values, bytes calldata data)

diff --git a/src/treasury/StandardTreasury.sol b/src/treasury/StandardTreasury.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
 import "@openzeppelin/contracts/utils/introspection/ERC165.sol";

diff --git a/src/treasury/StandardVault.sol b/src/treasury/StandardVault.sol
@@ -1,5 +1,5 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity >=0.8.13;
+pragma solidity >=0.8.24;
 
 import "@openzeppelin/contracts/token/ERC1155/utils/ERC1155Holder.sol";
 import "../errors/Errors.sol";