feat: update initialize version for settlement

Author: iavl

lib/surl

@@ -0,0 +1 @@
+Subproject commit 034c912ae9b5e707a5afd21f145b452ad8e800df

script/Deploy.s.sol

@@ -8,8 +8,9 @@ import {Settlement} from "../src/Settlement.sol";
 import {Staking} from "../src/Staking.sol";
 import {DeployConfig} from "./DeployConfig.s.sol";
 import {Deployer} from "./Deployer.sol";
-import {TransparentUpgradeableProxy} from
-    "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
+import {
+    TransparentUpgradeableProxy
+} from "@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol";
 import {console2 as console} from "forge-std/console2.sol";
 
 contract Deploy is Deployer {
@@ -86,9 +87,7 @@ contract Deploy is Deployer {
     function deployProxy(string memory _name) public broadcast returns (address addr_) {
         address logic = mustGetAddress(_stripSemver(_name));
         TransparentUpgradeableProxy proxy = new TransparentUpgradeableProxy({
-            _logic: logic,
-            initialOwner: cfg.proxyAdminOwner(),
-            _data: ""
+            _logic: logic, initialOwner: cfg.proxyAdminOwner(), _data: ""
         });
 
         // check states

script/Deployer.sol

@@ -499,11 +499,7 @@ abstract contract Deployer is Script {
     /// @notice Reads the artifact from the filesystem by name and returns the Deployment.
     /// @param _name The name of the artifact to read.
     /// @return The deployment corresponding to the name.
-    function _getExistingDeployment(string memory _name)
-        internal
-        view
-        returns (Deployment memory)
-    {
+    function _getExistingDeployment(string memory _name) internal view returns (Deployment memory) {
         string memory path = string.concat(deploymentsDir, "/", _name, ".json");
         try vm.readFile(path) returns (string memory json) {
             bytes memory addr = stdJson.parseRaw(json, "$.address");

src/Chips.sol

@@ -120,9 +120,10 @@ contract Chips is IChips, Initializable, ERC721 {
             "]}"
         );
 
-        return string.concat(
-            "data:application/json;base64,", Base64.encode(bytes(string.concat(json)))
-        );
+        return
+            string.concat(
+                "data:application/json;base64,", Base64.encode(bytes(string.concat(json)))
+            );
     }
 
     function tokenURI(uint256 id) public view override returns (string memory) {
@@ -151,9 +152,10 @@ contract Chips is IChips, Initializable, ERC721 {
             "]}"
         );
 
-        return string.concat(
-            "data:application/json;base64,", Base64.encode(bytes(string.concat(json)))
-        );
+        return
+            string.concat(
+                "data:application/json;base64,", Base64.encode(bytes(string.concat(json)))
+            );
     }
 
     function _generateChipImage(uint256 tokenId)
@@ -191,13 +193,14 @@ contract Chips is IChips, Initializable, ERC721 {
     {
         Node memory node = IStaking(_staking).getNode(nodeAddr);
 
-        (uint8 colorCount, uint8 frameCount, uint8 chipCornerCount, uint8 chipDetailCount) =
-        chipVersion == ChipVersion.V1
+        (uint8 colorCount, uint8 frameCount, uint8 chipCornerCount, uint8 chipDetailCount) = chipVersion
+                == ChipVersion.V1
             ? SVGGenerator.getNodeTraitsCount()
             : SVGGeneratorV2.getNodeTraitsCount();
 
-        uint256 nodeTraitCount = uint256(frameCount) * uint256(colorCount)
-            * uint256(chipDetailCount) * uint256(colorCount) * uint256(chipCornerCount);
+        uint256 nodeTraitCount =
+            uint256(frameCount) * uint256(colorCount) * uint256(chipDetailCount)
+            * uint256(colorCount) * uint256(chipCornerCount);
 
         // Chips from the same node will have the same traits
         uint256 nodeTraitId = uint256(keccak256(abi.encodePacked(nodeAddr))) % nodeTraitCount;
@@ -263,8 +266,9 @@ contract Chips is IChips, Initializable, ERC721 {
             (colorCount,,,) = SVGGeneratorV2.getNodeTraitsCount();
         }
 
-        uint256 chipTraitCount = uint256(eyeCount) * (mouthCount) * (headShapeCount) * (colorCount)
-            * (headDetailCount) * (colorCount) * (nftCardCount);
+        uint256 chipTraitCount =
+            uint256(eyeCount) * (mouthCount) * (headShapeCount) * (colorCount) * (headDetailCount)
+            * (colorCount) * (nftCardCount);
 
         uint256 chipTraitId = seed % chipTraitCount;
 
@@ -291,11 +295,11 @@ contract Chips is IChips, Initializable, ERC721 {
         uint8 colorCount,
         uint8 nftCardCount
     ) internal pure returns (ChipTraits memory) {
-        uint256 factor = uint256(mouthCount) * uint256(headShapeCount) * uint256(colorCount)
+        uint256 factor =
+            uint256(mouthCount) * uint256(headShapeCount) * uint256(colorCount)
             * uint256(headDetailCount) * uint256(colorCount) * uint256(nftCardCount);
 
-        return (
-            ChipTraits({
+        return (ChipTraits({
                 eyesId: _calTraitId(chipTraitId, eyeCount, factor),
                 mouthId: _calTraitId(chipTraitId, mouthCount, factor / uint256(mouthCount)),
                 headShapeId: _calTraitId(
@@ -320,8 +324,7 @@ contract Chips is IChips, Initializable, ERC721 {
                     (factor / uint256(mouthCount)) / uint256(headShapeCount) / uint256(colorCount)
                         / uint256(headDetailCount) / uint256(colorCount)
                 )
-            })
-        );
+            }));
     }
 
     function _calTraitId(uint256 traitId, uint8 traitCount, uint256 divisionFactor)

src/NetworkParams.sol

@@ -2,8 +2,9 @@
 // solhint-disable comprehensive-interface
 pragma solidity 0.8.24;
 
-import {AccessControlEnumerable} from
-    "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
+import {
+    AccessControlEnumerable
+} from "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
 import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import {Math} from "@openzeppelin/contracts/utils/math/Math.sol";
 import {LibZip} from "@solady/utils/LibZip.sol";

src/Settlement.sol

@@ -13,13 +13,14 @@ import {
     RewardsAlreadyDistributed,
     SubmissionIntervalNotElapsed
 } from "./libraries/Errors.sol";
-import {AccessControlEnumerable} from
-    "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
+import {
+    AccessControlEnumerable
+} from "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
 import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import {Multicall} from "@openzeppelin/contracts/utils/Multicall.sol";
 
 contract Settlement is ISettlement, Multicall, Initializable, AccessControlEnumerable {
-    string public constant version = "2.1.0";
+    string public constant version = "2.2.0";
 
     /// @dev Duration of an epoch.
     uint256 public constant EPOCH_DURATION = 18 hours;
@@ -49,7 +50,8 @@ contract Settlement is ISettlement, Multicall, Initializable, AccessControlEnume
     // distributed operation rewards for each epoch
     mapping(uint256 epoch => uint256 operationRewards) internal _distributedOperationRewards;
     // rewarded node addresses
-    mapping(uint256 epoch => mapping(address nodeAddr => bool rewarded)) internal _rewardedAddresses;
+    mapping(uint256 epoch => mapping(address nodeAddr => bool rewarded)) internal
+        _rewardedAddresses;
 
     modifier validEpoch(uint256 epoch) {
         if (epoch < _currentEpoch || epoch > _currentEpoch + 1) {
@@ -75,7 +77,7 @@ contract Settlement is ISettlement, Multicall, Initializable, AccessControlEnume
         address oracleAccount,
         uint256 startTime,
         uint256 operationRewardsPercent
-    ) external override reinitializer(4) {
+    ) external override reinitializer(5) {
         if (staking != address(0)) {
             _staking = staking;
         }
@@ -89,7 +91,9 @@ contract Settlement is ISettlement, Multicall, Initializable, AccessControlEnume
             _startTimestamp = startTime;
         }
 
-        _updateRewardsRatio(operationRewardsPercent);
+        if (operationRewardsPercent > 0) {
+            _updateRewardsRatio(operationRewardsPercent);
+        }
     }
 
     /// @inheritdoc ISettlement
@@ -112,7 +116,10 @@ contract Settlement is ISettlement, Multicall, Initializable, AccessControlEnume
         IStaking(_staking).setSettlementPhase(!isFinal);
 
         // distribute rewards
-        IStaking(_staking).distributeRewards{value: data.rewardsToSend}(
+        IStaking(_staking)
+        .distributeRewards{
+            value: data.rewardsToSend
+        }(
             data.epochInfo,
             nodeAddrs,
             operationRewards,
@@ -195,9 +202,8 @@ contract Settlement is ISettlement, Multicall, Initializable, AccessControlEnume
     function _updateRewardsRatio(uint256 operationRewardsPercent) internal {
         _totalOperationRewardsPerEpoch =
             (TOTAL_REWARDS_PER_YEAR * EPOCH_DURATION * operationRewardsPercent) / (100 * 365 days);
-        _totalStakingRewardsPerEpoch = (
-            (TOTAL_REWARDS_PER_YEAR * EPOCH_DURATION) * (100 - operationRewardsPercent)
-        ) / (100 * 365 days);
+        _totalStakingRewardsPerEpoch = ((TOTAL_REWARDS_PER_YEAR * EPOCH_DURATION)
+                * (100 - operationRewardsPercent)) / (100 * 365 days);
     }
 
     /// @dev check distributed operationRewards not exceeds the max rewards per

src/Staking.sol

@@ -18,8 +18,9 @@ import {NodeSettingsLib} from "./libraries/NodeSettingsLib.sol";
 import {RewardsAndSlashingLib} from "./libraries/RewardsAndSlashingLib.sol";
 import {StakingLib} from "./libraries/StakingLib.sol";
 import {StorageLib} from "./libraries/StorageLib.sol";
-import {AccessControlEnumerable} from
-    "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
+import {
+    AccessControlEnumerable
+} from "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";
 import {Initializable} from "@openzeppelin/contracts/proxy/utils/Initializable.sol";
 import {Multicall} from "@openzeppelin/contracts/utils/Multicall.sol";
 import {Pausable} from "@openzeppelin/contracts/utils/Pausable.sol";
@@ -85,7 +86,7 @@ contract Staking is
 
     /// @dev total operation pool tokens
     uint256 internal _totalOperationPoolTokens; // deprecated in next version
-    /// @dev total staking pool tokens
+        // / @dev total staking pool tokens
     uint256 internal _totalStakingPoolTokens; // deprecated in next version
 
     /// @dev the issuers of chips
@@ -281,11 +282,7 @@ contract Staking is
     }
 
     /// @inheritdoc IStaking
-    function setTaxRateBasisPoints4Node(uint64 taxRateBasisPoints)
-        external
-        override
-        whenNotPaused
-    {
+    function setTaxRateBasisPoints4Node(uint64 taxRateBasisPoints) external override whenNotPaused {
         NodeSettingsLib.setTaxRateBasisPoints4Node(taxRateBasisPoints, msg.sender);
     }
 
@@ -313,11 +310,7 @@ contract Staking is
     }
 
     /// @inheritdoc IStaking
-    function mergeChips(uint256[] calldata chipIds)
-        external
-        override
-        returns (uint256 newTokenId)
-    {
+    function mergeChips(uint256[] calldata chipIds) external override returns (uint256 newTokenId) {
         return StakingLib.mergeChips(chipIds);
     }
 
@@ -455,9 +448,12 @@ contract Staking is
         )
     {
         PoolStatData storage pool = StorageLib.poolStatStorage();
-        return (
-            pool.totalOperationPoolTokens, pool.totalStakingPoolTokens, pool.totalSlashingPoolTokens
-        );
+        return
+            (
+                pool.totalOperationPoolTokens,
+                pool.totalStakingPoolTokens,
+                pool.totalSlashingPoolTokens
+            );
     }
 
     /// @inheritdoc IStaking

src/base/ERC721.sol

@@ -55,7 +55,8 @@ abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Er
         returns (bool)
     {
         return interfaceId == type(IERC721).interfaceId
-            || interfaceId == type(IERC721Metadata).interfaceId || super.supportsInterface(interfaceId);
+            || interfaceId == type(IERC721Metadata).interfaceId
+            || super.supportsInterface(interfaceId);
     }
 
     /**
@@ -195,9 +196,9 @@ abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Er
         returns (bool)
     {
         return spender != address(0)
-            && (
-                owner == spender || isApprovedForAll(owner, spender) || _getApproved(tokenId) == spender
-            );
+            && (owner == spender
+                || isApprovedForAll(owner, spender)
+                || _getApproved(tokenId) == spender);
     }
 
     /**
@@ -238,11 +239,7 @@ abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Er
      *
      * NOTE: If overriding this function in a way that tracks balances, see also {_increaseBalance}.
      */
-    function _update(address to, uint256 tokenId, address auth)
-        internal
-        virtual
-        returns (address)
-    {
+    function _update(address to, uint256 tokenId, address auth) internal virtual returns (address) {
         address from = _ownerOf(tokenId);
 
         // Perform (optional) operator check
@@ -415,9 +412,8 @@ abstract contract ERC721 is Context, ERC165, IERC721, IERC721Metadata, IERC721Er
         private
     {
         if (to.code.length > 0) {
-            try IERC721Receiver(to).onERC721Received(_msgSender(), from, tokenId, data) returns (
-                bytes4 retval
-            ) {
+            try IERC721Receiver(to)
+                .onERC721Received(_msgSender(), from, tokenId, data) returns (bytes4 retval) {
                 if (retval != IERC721Receiver.onERC721Received.selector) {
                     revert ERC721InvalidReceiver(to);
                 }

src/interfaces/IChips.sol

@@ -41,7 +41,7 @@ interface IChips {
     function totalSupply() external view returns (uint256);
 
     /**
-     * @notice  Returns the address of the Staking contract.
+     * @notice Returns the address of the Staking contract.
      * @return Address of the Staking contract.
      */
     function stakingContract() external view returns (address);

src/interfaces/ISettlement.sol

@@ -93,7 +93,7 @@ interface ISettlement {
     function setNodeStatus(address[] calldata nodeAddrs, NodeStatus[] calldata status) external;
 
     /**
-     * @notice  Returns the address of the Staking contract.
+     * @notice Returns the address of the Staking contract.
      * @return Address of the Staking contract.
      */
     function stakingContract() external view returns (address);
@@ -105,7 +105,7 @@ interface ISettlement {
     function currentEpoch() external view returns (uint256);
 
     /**
-     * @notice  Returns the bonus info.
+     * @notice Returns the bonus info.
      * @return (operationRewardsPerEpoch, stakingRewardsPerEpoch) The amount of request bonus per
      * epoch.
      */