refactor(store): clean up Memory, make mcopy pure (#1153)

* refactor(store): clean up Memory, make mcopy pure * update comments * Create nice-pandas-knock.md
latticexyz · Jul 13, 2023 · 8d51a03 · 8d51a03
1 parent 0d43481
commit 8d51a03
Show file tree

Hide file tree

Showing 45 changed files with 114 additions and 123 deletions.
diff --git a/.changeset/nice-pandas-knock.md b/.changeset/nice-pandas-knock.md
@@ -0,0 +1,8 @@
+---
+"@latticexyz/cli": patch
+"@latticexyz/common": patch
+"@latticexyz/store": patch
+"@latticexyz/world": patch
+---
+
+Clean up Memory.sol, make mcopy pure
diff --git a/e2e/packages/contracts/src/codegen/tables/Multi.sol b/e2e/packages/contracts/src/codegen/tables/Multi.sol
@@ -235,7 +235,7 @@ library Multi {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(int256 num, bool value) internal view returns (bytes memory) {
+  function encode(int256 num, bool value) internal pure returns (bytes memory) {
     return abi.encodePacked(num, value);
   }
 

diff --git a/e2e/packages/contracts/src/codegen/tables/Number.sol b/e2e/packages/contracts/src/codegen/tables/Number.sol
@@ -100,7 +100,7 @@ library Number {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(uint32 value) internal view returns (bytes memory) {
+  function encode(uint32 value) internal pure returns (bytes memory) {
     return abi.encodePacked(value);
   }
 

diff --git a/e2e/packages/contracts/src/codegen/tables/NumberList.sol b/e2e/packages/contracts/src/codegen/tables/NumberList.sol
@@ -169,7 +169,7 @@ library NumberList {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(uint32[] memory value) internal view returns (bytes memory) {
+  function encode(uint32[] memory value) internal pure returns (bytes memory) {
     uint40[] memory _counters = new uint40[](1);
     _counters[0] = uint40(value.length * 4);
     PackedCounter _encodedLengths = PackedCounterLib.pack(_counters);

diff --git a/e2e/packages/contracts/src/codegen/tables/Vector.sol b/e2e/packages/contracts/src/codegen/tables/Vector.sol
@@ -196,7 +196,7 @@ library Vector {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(int32 x, int32 y) internal view returns (bytes memory) {
+  function encode(int32 x, int32 y) internal pure returns (bytes memory) {
     return abi.encodePacked(x, y);
   }
 

diff --git a/examples/minimal/packages/contracts/src/codegen/tables/CounterTable.sol b/examples/minimal/packages/contracts/src/codegen/tables/CounterTable.sol
@@ -100,7 +100,7 @@ library CounterTable {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(uint32 value) internal view returns (bytes memory) {
+  function encode(uint32 value) internal pure returns (bytes memory) {
     return abi.encodePacked(value);
   }
 

diff --git a/examples/minimal/packages/contracts/src/codegen/tables/Inventory.sol b/examples/minimal/packages/contracts/src/codegen/tables/Inventory.sol
@@ -110,7 +110,7 @@ library Inventory {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(uint32 amount) internal view returns (bytes memory) {
+  function encode(uint32 amount) internal pure returns (bytes memory) {
     return abi.encodePacked(amount);
   }
 

diff --git a/examples/minimal/packages/contracts/src/codegen/tables/MessageTable.sol b/examples/minimal/packages/contracts/src/codegen/tables/MessageTable.sol
@@ -83,7 +83,7 @@ library MessageTable {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(string memory value) internal view returns (bytes memory) {
+  function encode(string memory value) internal pure returns (bytes memory) {
     uint40[] memory _counters = new uint40[](1);
     _counters[0] = uint40(bytes(value).length);
     PackedCounter _encodedLengths = PackedCounterLib.pack(_counters);

diff --git a/packages/cli/contracts/src/codegen/tables/Dynamics1.sol b/packages/cli/contracts/src/codegen/tables/Dynamics1.sol
@@ -735,7 +735,7 @@ library Dynamics1 {
   }
 
   /** Decode the tightly packed blob using this table's schema */
-  function decode(bytes memory _blob) internal view returns (Dynamics1Data memory _table) {
+  function decode(bytes memory _blob) internal pure returns (Dynamics1Data memory _table) {
     // 0 is the total byte length of static data
     PackedCounter _encodedLengths = PackedCounter.wrap(Bytes.slice32(_blob, 0));
 
@@ -774,7 +774,7 @@ library Dynamics1 {
     uint128[3] memory staticU128,
     address[4] memory staticAddrs,
     bool[5] memory staticBools
-  ) internal view returns (bytes memory) {
+  ) internal pure returns (bytes memory) {
     uint40[] memory _counters = new uint40[](5);
     _counters[0] = uint40(staticB32.length * 32);
     _counters[1] = uint40(staticI32.length * 4);
@@ -852,7 +852,7 @@ function toStaticArray_bool_5(bool[] memory _value) pure returns (bool[5] memory
   }
 }
 
-function fromStaticArray_bytes32_1(bytes32[1] memory _value) view returns (bytes32[] memory _result) {
+function fromStaticArray_bytes32_1(bytes32[1] memory _value) pure returns (bytes32[] memory _result) {
   _result = new bytes32[](1);
   uint256 fromPointer;
   uint256 toPointer;
@@ -863,7 +863,7 @@ function fromStaticArray_bytes32_1(bytes32[1] memory _value) view returns (bytes
   Memory.copy(fromPointer, toPointer, 32);
 }
 
-function fromStaticArray_int32_2(int32[2] memory _value) view returns (int32[] memory _result) {
+function fromStaticArray_int32_2(int32[2] memory _value) pure returns (int32[] memory _result) {
   _result = new int32[](2);
   uint256 fromPointer;
   uint256 toPointer;
@@ -874,7 +874,7 @@ function fromStaticArray_int32_2(int32[2] memory _value) view returns (int32[] m
   Memory.copy(fromPointer, toPointer, 64);
 }
 
-function fromStaticArray_uint128_3(uint128[3] memory _value) view returns (uint128[] memory _result) {
+function fromStaticArray_uint128_3(uint128[3] memory _value) pure returns (uint128[] memory _result) {
   _result = new uint128[](3);
   uint256 fromPointer;
   uint256 toPointer;
@@ -885,7 +885,7 @@ function fromStaticArray_uint128_3(uint128[3] memory _value) view returns (uint1
   Memory.copy(fromPointer, toPointer, 96);
 }
 
-function fromStaticArray_address_4(address[4] memory _value) view returns (address[] memory _result) {
+function fromStaticArray_address_4(address[4] memory _value) pure returns (address[] memory _result) {
   _result = new address[](4);
   uint256 fromPointer;
   uint256 toPointer;
@@ -896,7 +896,7 @@ function fromStaticArray_address_4(address[4] memory _value) view returns (addre
   Memory.copy(fromPointer, toPointer, 128);
 }
 
-function fromStaticArray_bool_5(bool[5] memory _value) view returns (bool[] memory _result) {
+function fromStaticArray_bool_5(bool[5] memory _value) pure returns (bool[] memory _result) {
   _result = new bool[](5);
   uint256 fromPointer;
   uint256 toPointer;

diff --git a/packages/cli/contracts/src/codegen/tables/Dynamics2.sol b/packages/cli/contracts/src/codegen/tables/Dynamics2.sol
@@ -478,7 +478,7 @@ library Dynamics2 {
   }
 
   /** Decode the tightly packed blob using this table's schema */
-  function decode(bytes memory _blob) internal view returns (Dynamics2Data memory _table) {
+  function decode(bytes memory _blob) internal pure returns (Dynamics2Data memory _table) {
     // 0 is the total byte length of static data
     PackedCounter _encodedLengths = PackedCounter.wrap(Bytes.slice32(_blob, 0));
 
@@ -503,7 +503,7 @@ library Dynamics2 {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(uint64[] memory u64, string memory str, bytes memory b) internal view returns (bytes memory) {
+  function encode(uint64[] memory u64, string memory str, bytes memory b) internal pure returns (bytes memory) {
     uint40[] memory _counters = new uint40[](3);
     _counters[0] = uint40(u64.length * 8);
     _counters[1] = uint40(bytes(str).length);

diff --git a/packages/cli/contracts/src/codegen/tables/Ephemeral.sol b/packages/cli/contracts/src/codegen/tables/Ephemeral.sol
@@ -86,7 +86,7 @@ library Ephemeral {
   }
 
   /** Tightly pack full data using this table's schema */
-  function encode(uint256 value) internal view returns (bytes memory) {
+  function encode(uint256 value) internal pure returns (bytes memory) {
     return abi.encodePacked(value);
   }
 

diff --git a/packages/cli/contracts/src/codegen/tables/Singleton.sol b/packages/cli/contracts/src/codegen/tables/Singleton.sol
@@ -451,7 +451,7 @@ library Singleton {
   /** Decode the tightly packed blob using this table's schema */
   function decode(
     bytes memory _blob
-  ) internal view returns (int256 v1, uint32[2] memory v2, uint32[2] memory v3, uint32[1] memory v4) {
+  ) internal pure returns (int256 v1, uint32[2] memory v2, uint32[2] memory v3, uint32[1] memory v4) {
     // 32 is the total byte length of static data
     PackedCounter _encodedLengths = PackedCounter.wrap(Bytes.slice32(_blob, 32));
 
@@ -483,7 +483,7 @@ library Singleton {
     uint32[2] memory v2,
     uint32[2] memory v3,
     uint32[1] memory v4
-  ) internal view returns (bytes memory) {
+  ) internal pure returns (bytes memory) {
     uint40[] memory _counters = new uint40[](3);
     _counters[0] = uint40(v2.length * 4);
     _counters[1] = uint40(v3.length * 4);
@@ -534,7 +534,7 @@ function toStaticArray_uint32_1(uint32[] memory _value) pure returns (uint32[1]
   }
 }
 
-function fromStaticArray_uint32_2(uint32[2] memory _value) view returns (uint32[] memory _result) {
+function fromStaticArray_uint32_2(uint32[2] memory _value) pure returns (uint32[] memory _result) {
   _result = new uint32[](2);
   uint256 fromPointer;
   uint256 toPointer;
@@ -545,7 +545,7 @@ function fromStaticArray_uint32_2(uint32[2] memory _value) view returns (uint32[
   Memory.copy(fromPointer, toPointer, 64);
 }
 
-function fromStaticArray_uint32_1(uint32[1] memory _value) view returns (uint32[] memory _result) {
+function fromStaticArray_uint32_1(uint32[1] memory _value) pure returns (uint32[] memory _result) {
   _result = new uint32[](1);
   uint256 fromPointer;
   uint256 toPointer;

diff --git a/packages/cli/contracts/src/codegen/tables/Statics.sol b/packages/cli/contracts/src/codegen/tables/Statics.sol
@@ -872,7 +872,7 @@ library Statics {
     bool v5,
     Enum1 v6,
     Enum2 v7
-  ) internal view returns (bytes memory) {
+  ) internal pure returns (bytes memory) {
     return abi.encodePacked(v1, v2, v3, v4, v5, v6, v7);
   }
 

diff --git a/packages/common/src/codegen/render-solidity/renderTypeHelpers.ts b/packages/common/src/codegen/render-solidity/renderTypeHelpers.ts
@@ -83,7 +83,7 @@ function renderUnwrapperStaticArray(
   return `
     function ${functionName}(
       ${elementType}[${staticLength}] memory _value
-    ) view returns (
+    ) pure returns (
       ${internalTypeId} memory _result
     ) {
       _result = new ${internalTypeId}(${staticLength});

diff --git a/packages/store/gas-report.json b/packages/store/gas-report.json
@@ -81,7 +81,7 @@
     "file": "test/Gas.t.sol",
     "test": "testCompareAbiEncodeVsCustom",
     "name": "custom decode",
-    "gasUsed": 2124
+    "gasUsed": 2127
   },
   {
     "file": "test/Gas.t.sol",
@@ -123,7 +123,7 @@
     "file": "test/Mixed.t.sol",
     "test": "testSetAndGet",
     "name": "get record from Mixed",
-    "gasUsed": 13455
+    "gasUsed": 13458
   },
   {
     "file": "test/PackedCounter.t.sol",
@@ -231,37 +231,37 @@
     "file": "test/Slice.t.sol",
     "test": "testToBytes",
     "name": "Slice (0 bytes) to bytes memory",
-    "gasUsed": 473
+    "gasUsed": 476
   },
   {
     "file": "test/Slice.t.sol",
     "test": "testToBytes",
     "name": "Slice (2 bytes) to bytes memory",
-    "gasUsed": 508
+    "gasUsed": 511
   },
   {
     "file": "test/Slice.t.sol",
     "test": "testToBytes",
     "name": "Slice (32 bytes) to bytes memory",
-    "gasUsed": 507
+    "gasUsed": 724
   },
   {
     "file": "test/Slice.t.sol",
     "test": "testToBytes",
     "name": "Slice (34 bytes) to bytes memory",
-    "gasUsed": 585
+    "gasUsed": 727
   },
   {
     "file": "test/Slice.t.sol",
     "test": "testToBytes",
     "name": "Slice (1024 bytes) to bytes memory",
-    "gasUsed": 4849
+    "gasUsed": 7443
   },
   {
     "file": "test/Slice.t.sol",
     "test": "testToBytes",
     "name": "Slice (1024x1024 bytes) to bytes memory",
-    "gasUsed": 6616506
+    "gasUsed": 9205372
   },
   {
     "file": "test/Slice.t.sol",
@@ -339,25 +339,25 @@
     "file": "test/StoreCoreDynamic.t.sol",
     "test": "testPopFromSecondField",
     "name": "pop from field (cold, 1 slot, 1 uint32 item)",
-    "gasUsed": 29291
+    "gasUsed": 29294
   },
   {
     "file": "test/StoreCoreDynamic.t.sol",
     "test": "testPopFromSecondField",
     "name": "pop from field (warm, 1 slot, 1 uint32 item)",
-    "gasUsed": 19346
+    "gasUsed": 19349
   },
   {
     "file": "test/StoreCoreDynamic.t.sol",
     "test": "testPopFromThirdField",
     "name": "pop from field (cold, 2 slots, 10 uint32 items)",
-    "gasUsed": 31174
+    "gasUsed": 31177
   },
   {
     "file": "test/StoreCoreDynamic.t.sol",
     "test": "testPopFromThirdField",
     "name": "pop from field (warm, 2 slots, 10 uint32 items)",
-    "gasUsed": 19229
+    "gasUsed": 19232
   },
   {
     "file": "test/StoreCoreGas.t.sol",
@@ -609,13 +609,13 @@
     "file": "test/StoreCoreGas.t.sol",
     "test": "testUpdateInField",
     "name": "update in field (1 slot, 1 uint32 item)",
-    "gasUsed": 16605
+    "gasUsed": 16611
   },
   {
     "file": "test/StoreCoreGas.t.sol",
     "test": "testUpdateInField",
     "name": "push to field (2 slots, 6 uint64 items)",
-    "gasUsed": 17696
+    "gasUsed": 17702
   },
   {
     "file": "test/StoreMetadata.t.sol",
@@ -627,7 +627,7 @@
     "file": "test/StoreMetadata.t.sol",
     "test": "testSetAndGet",
     "name": "get record from StoreMetadataTable",
-    "gasUsed": 12116
+    "gasUsed": 12689
   },
   {
     "file": "test/StoreSwitch.t.sol",