Merge pull request #48 from NaturalSelectionLabs/fix/network-params-compress

fix: change setParams type to bytes

Author: iavl

deployments/abi/NetworkParams.abi

@@ -208,8 +208,8 @@
       },
       {
         "name": "params",
-        "type": "string",
-        "internalType": "string"
+        "type": "bytes",
+        "internalType": "bytes"
       }
     ],
     "outputs": [],
@@ -259,9 +259,9 @@
       },
       {
         "name": "params",
-        "type": "string",
+        "type": "bytes",
         "indexed": false,
-        "internalType": "string"
+        "internalType": "bytes"
       }
     ],
     "anonymous": false

script/CompressParams.s.sol

@@ -11,8 +11,9 @@ contract CompressParams is Script {
     // solhint-disable-next-line function-max-lines
     function run() public view {
         string memory params = _readInput("network_parameter");
-        bytes memory result = LibZip.flzCompress(bytes(params));
-        console.logBytes(result);
+        bytes memory compressed = LibZip.flzCompress(bytes(params));
+        console.log("Compressed:");
+        console.logBytes(compressed);
     }
 
     // read network config params from json file

src/NetworkParams.sol

@@ -12,10 +12,10 @@ contract NetworkParams is Initializable, AccessControlEnumerable {
     bytes32 public constant ADMIN_ROLE = keccak256("ADMIN_ROLE");
 
     // Mapping from epoch to configuration parameters
-    mapping(uint64 epoch => string params) private _params;
+    mapping(uint64 epoch => bytes params) private _params;
     uint64[] private _orderedEpochs;
 
-    event ParamsSet(uint64 indexed epoch, string params);
+    event ParamsSet(uint64 indexed epoch, bytes params);
 
     /**
      * @notice Initializes the NetworkParams contract.
@@ -30,10 +30,10 @@ contract NetworkParams is Initializable, AccessControlEnumerable {
      * @notice Sets configuration parameters for a specific epoch.
      * @dev Adds the epoch to the sorted list and maps it to the provided parameters.
      * @param epoch The epoch (as a uint64) to which the parameters should be associated.
-     * @param params The configuration parameters (as a string) to be set.
+     * @param params The configuration parameters (as bytes) to be set.
      */
-    function setParams(uint64 epoch, string calldata params) external onlyRole(ADMIN_ROLE) {
-        if (bytes(_params[epoch]).length == 0) {
+    function setParams(uint64 epoch, bytes calldata params) external onlyRole(ADMIN_ROLE) {
+        if (_params[epoch].length == 0) {
             _insertOrderedEpoch(epoch);
         }
 
@@ -54,13 +54,13 @@ contract NetworkParams is Initializable, AccessControlEnumerable {
         }
 
         uint64 nearestEpoch = _findNearestEpoch(epoch);
-        string memory compressedParams = _params[nearestEpoch];
+        bytes memory compressedParams = _params[nearestEpoch];
 
-        if (bytes(compressedParams).length == 0) {
+        if (compressedParams.length == 0) {
             return "";
         }
 
-        bytes memory decompressedParams = LibZip.flzDecompress(bytes(compressedParams));
+        bytes memory decompressedParams = LibZip.flzDecompress(compressedParams);
         return string(decompressedParams);
     }
 

test/NetworkParams.t.sol

@@ -11,7 +11,7 @@ contract NetworkParamsTest is CommonTest {
 
     NetworkParams internal _params;
 
-    event ParamsSet(uint64 indexed epoch, string params);
+    event ParamsSet(uint64 indexed epoch, bytes params);
 
     function setUp() public {
         _params = new NetworkParams();
@@ -26,9 +26,9 @@ contract NetworkParamsTest is CommonTest {
         bytes memory compressedParams = LibZip.flzCompress(bytes(paramsStr));
 
         expectEmit();
-        emit ParamsSet(100, string(compressedParams));
+        emit ParamsSet(100, compressedParams);
         vm.prank(bob);
-        _params.setParams(100, string(compressedParams));
+        _params.setParams(100, compressedParams);
 
         assertEq(_params.getParams(100), paramsStr);
     }
@@ -52,19 +52,19 @@ contract NetworkParamsTest is CommonTest {
         bytes memory compressedParams30 = LibZip.flzCompress(bytes(epoch30ParamsStr));
 
         expectEmit();
-        emit ParamsSet(100, string(compressedParams100));
+        emit ParamsSet(100, compressedParams100);
         vm.prank(bob);
-        _params.setParams(100, string(compressedParams100));
+        _params.setParams(100, compressedParams100);
 
         expectEmit();
-        emit ParamsSet(300, string(compressedParams300));
+        emit ParamsSet(300, compressedParams300);
         vm.prank(bob);
-        _params.setParams(300, string(compressedParams300));
+        _params.setParams(300, compressedParams300);
 
         expectEmit();
-        emit ParamsSet(200, string(compressedParams200));
+        emit ParamsSet(200, compressedParams200);
         vm.prank(bob);
-        _params.setParams(200, string(compressedParams200));
+        _params.setParams(200, compressedParams200);
 
         // Below 100
         assertEq(_params.getParams(50), epoch100ParamsStr);
@@ -85,18 +85,18 @@ contract NetworkParamsTest is CommonTest {
 
         // Update existing epoch 200
         expectEmit();
-        emit ParamsSet(200, string(compressedParams200Modified));
+        emit ParamsSet(200, compressedParams200Modified);
         vm.prank(bob);
-        _params.setParams(200, string(compressedParams200Modified));
+        _params.setParams(200, compressedParams200Modified);
 
         // Equal to 200
         assertEq(_params.getParams(200), epoch200ParamsStrModified);
 
         // Update earlier epoch
         expectEmit();
-        emit ParamsSet(30, string(compressedParams30));
+        emit ParamsSet(30, compressedParams30);
         vm.prank(bob);
-        _params.setParams(30, string(compressedParams30));
+        _params.setParams(30, compressedParams30);
 
         // Pass epoch 30
         assertEq(_params.getParams(0), epoch30ParamsStr);