@latticexyz/world-modules 2.0.0-main-e20633d4 → 2.0.0-main-071aadb9

package/src/modules/keyswithvalue/tables/KeysWithValue.sol

@@ -25,12 +25,18 @@ FieldLayout constant _fieldLayout = FieldLayout.wrap(
 );
 
 library KeysWithValue {
-  /** Get the table values' field layout */
+  /**
+   * @notice Get the table values' field layout.
+   * @return _fieldLayout The field layout for the table.
+   */
   function getFieldLayout() internal pure returns (FieldLayout) {
     return _fieldLayout;
   }
 
-  /** Get the table's key schema */
+  /**
+   * @notice Get the table's key schema.
+   * @return _keySchema The key schema for the table.
+   */
   function getKeySchema() internal pure returns (Schema) {
     SchemaType[] memory _keySchema = new SchemaType[](1);
     _keySchema[0] = SchemaType.BYTES32;
@@ -38,7 +44,10 @@ library KeysWithValue {
     return SchemaLib.encode(_keySchema);
   }
 
-  /** Get the table's value schema */
+  /**
+   * @notice Get the table's value schema.
+   * @return _valueSchema The value schema for the table.
+   */
   function getValueSchema() internal pure returns (Schema) {
     SchemaType[] memory _valueSchema = new SchemaType[](1);
     _valueSchema[0] = SchemaType.BYTES32_ARRAY;
@@ -46,34 +55,48 @@ library KeysWithValue {
     return SchemaLib.encode(_valueSchema);
   }
 
-  /** Get the table's key names */
+  /**
+   * @notice Get the table's key field names.
+   * @return keyNames An array of strings with the names of key fields.
+   */
   function getKeyNames() internal pure returns (string[] memory keyNames) {
     keyNames = new string[](1);
     keyNames[0] = "valueHash";
   }
 
-  /** Get the table's field names */
+  /**
+   * @notice Get the table's value field names.
+   * @return fieldNames An array of strings with the names of value fields.
+   */
   function getFieldNames() internal pure returns (string[] memory fieldNames) {
     fieldNames = new string[](1);
     fieldNames[0] = "keysWithValue";
   }
 
-  /** Register the table with its config */
+  /**
+   * @notice Register the table with its config.
+   */
   function register(ResourceId _tableId) internal {
     StoreSwitch.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Register the table with its config */
+  /**
+   * @notice Register the table with its config.
+   */
   function _register(ResourceId _tableId) internal {
     StoreCore.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Register the table with its config (using the specified store) */
+  /**
+   * @notice Register the table with its config (using the specified store).
+   */
   function register(IStore _store, ResourceId _tableId) internal {
     _store.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Get keysWithValue */
+  /**
+   * @notice Get keysWithValue.
+   */
   function getKeysWithValue(
     ResourceId _tableId,
     bytes32 valueHash
@@ -85,7 +108,9 @@ library KeysWithValue {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keysWithValue */
+  /**
+   * @notice Get keysWithValue.
+   */
   function _getKeysWithValue(
     ResourceId _tableId,
     bytes32 valueHash
@@ -97,7 +122,9 @@ library KeysWithValue {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keysWithValue (using the specified store) */
+  /**
+   * @notice Get keysWithValue (using the specified store).
+   */
   function getKeysWithValue(
     IStore _store,
     ResourceId _tableId,
@@ -110,7 +137,9 @@ library KeysWithValue {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keysWithValue */
+  /**
+   * @notice Get keysWithValue.
+   */
   function get(ResourceId _tableId, bytes32 valueHash) internal view returns (bytes32[] memory keysWithValue) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -119,7 +148,9 @@ library KeysWithValue {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keysWithValue */
+  /**
+   * @notice Get keysWithValue.
+   */
   function _get(ResourceId _tableId, bytes32 valueHash) internal view returns (bytes32[] memory keysWithValue) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -128,7 +159,9 @@ library KeysWithValue {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keysWithValue (using the specified store) */
+  /**
+   * @notice Get keysWithValue (using the specified store).
+   */
   function get(
     IStore _store,
     ResourceId _tableId,
@@ -141,7 +174,9 @@ library KeysWithValue {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Set keysWithValue */
+  /**
+   * @notice Set keysWithValue.
+   */
   function setKeysWithValue(ResourceId _tableId, bytes32 valueHash, bytes32[] memory keysWithValue) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -149,7 +184,9 @@ library KeysWithValue {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keysWithValue)));
   }
 
-  /** Set keysWithValue */
+  /**
+   * @notice Set keysWithValue.
+   */
   function _setKeysWithValue(ResourceId _tableId, bytes32 valueHash, bytes32[] memory keysWithValue) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -157,7 +194,9 @@ library KeysWithValue {
     StoreCore.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keysWithValue)));
   }
 
-  /** Set keysWithValue (using the specified store) */
+  /**
+   * @notice Set keysWithValue (using the specified store).
+   */
   function setKeysWithValue(
     IStore _store,
     ResourceId _tableId,
@@ -170,7 +209,9 @@ library KeysWithValue {
     _store.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keysWithValue)));
   }
 
-  /** Set keysWithValue */
+  /**
+   * @notice Set keysWithValue.
+   */
   function set(ResourceId _tableId, bytes32 valueHash, bytes32[] memory keysWithValue) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -178,7 +219,9 @@ library KeysWithValue {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keysWithValue)));
   }
 
-  /** Set keysWithValue */
+  /**
+   * @notice Set keysWithValue.
+   */
   function _set(ResourceId _tableId, bytes32 valueHash, bytes32[] memory keysWithValue) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -186,7 +229,9 @@ library KeysWithValue {
     StoreCore.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keysWithValue)));
   }
 
-  /** Set keysWithValue (using the specified store) */
+  /**
+   * @notice Set keysWithValue (using the specified store).
+   */
   function set(IStore _store, ResourceId _tableId, bytes32 valueHash, bytes32[] memory keysWithValue) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -194,7 +239,9 @@ library KeysWithValue {
     _store.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keysWithValue)));
   }
 
-  /** Get the length of keysWithValue */
+  /**
+   * @notice Get the length of keysWithValue.
+   */
   function lengthKeysWithValue(ResourceId _tableId, bytes32 valueHash) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -205,7 +252,9 @@ library KeysWithValue {
     }
   }
 
-  /** Get the length of keysWithValue */
+  /**
+   * @notice Get the length of keysWithValue.
+   */
   function _lengthKeysWithValue(ResourceId _tableId, bytes32 valueHash) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -216,7 +265,9 @@ library KeysWithValue {
     }
   }
 
-  /** Get the length of keysWithValue (using the specified store) */
+  /**
+   * @notice Get the length of keysWithValue (using the specified store).
+   */
   function lengthKeysWithValue(IStore _store, ResourceId _tableId, bytes32 valueHash) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -227,7 +278,9 @@ library KeysWithValue {
     }
   }
 
-  /** Get the length of keysWithValue */
+  /**
+   * @notice Get the length of keysWithValue.
+   */
   function length(ResourceId _tableId, bytes32 valueHash) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -238,7 +291,9 @@ library KeysWithValue {
     }
   }
 
-  /** Get the length of keysWithValue */
+  /**
+   * @notice Get the length of keysWithValue.
+   */
   function _length(ResourceId _tableId, bytes32 valueHash) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -249,7 +304,9 @@ library KeysWithValue {
     }
   }
 
-  /** Get the length of keysWithValue (using the specified store) */
+  /**
+   * @notice Get the length of keysWithValue (using the specified store).
+   */
   function length(IStore _store, ResourceId _tableId, bytes32 valueHash) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -261,8 +318,8 @@ library KeysWithValue {
   }
 
   /**
-   * Get an item of keysWithValue
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keysWithValue.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeysWithValue(
     ResourceId _tableId,
@@ -279,8 +336,8 @@ library KeysWithValue {
   }
 
   /**
-   * Get an item of keysWithValue
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keysWithValue.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItemKeysWithValue(
     ResourceId _tableId,
@@ -297,8 +354,8 @@ library KeysWithValue {
   }
 
   /**
-   * Get an item of keysWithValue (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keysWithValue (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeysWithValue(
     IStore _store,
@@ -316,8 +373,8 @@ library KeysWithValue {
   }
 
   /**
-   * Get an item of keysWithValue
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keysWithValue.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItem(ResourceId _tableId, bytes32 valueHash, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -330,8 +387,8 @@ library KeysWithValue {
   }
 
   /**
-   * Get an item of keysWithValue
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keysWithValue.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItem(ResourceId _tableId, bytes32 valueHash, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -344,8 +401,8 @@ library KeysWithValue {
   }
 
   /**
-   * Get an item of keysWithValue (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keysWithValue (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItem(
     IStore _store,
@@ -362,7 +419,9 @@ library KeysWithValue {
     }
   }
 
-  /** Push an element to keysWithValue */
+  /**
+   * @notice Push an element to keysWithValue.
+   */
   function pushKeysWithValue(ResourceId _tableId, bytes32 valueHash, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -370,7 +429,9 @@ library KeysWithValue {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keysWithValue */
+  /**
+   * @notice Push an element to keysWithValue.
+   */
   function _pushKeysWithValue(ResourceId _tableId, bytes32 valueHash, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -378,7 +439,9 @@ library KeysWithValue {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keysWithValue (using the specified store) */
+  /**
+   * @notice Push an element to keysWithValue (using the specified store).
+   */
   function pushKeysWithValue(IStore _store, ResourceId _tableId, bytes32 valueHash, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -386,7 +449,9 @@ library KeysWithValue {
     _store.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keysWithValue */
+  /**
+   * @notice Push an element to keysWithValue.
+   */
   function push(ResourceId _tableId, bytes32 valueHash, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -394,7 +459,9 @@ library KeysWithValue {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keysWithValue */
+  /**
+   * @notice Push an element to keysWithValue.
+   */
   function _push(ResourceId _tableId, bytes32 valueHash, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -402,7 +469,9 @@ library KeysWithValue {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keysWithValue (using the specified store) */
+  /**
+   * @notice Push an element to keysWithValue (using the specified store).
+   */
   function push(IStore _store, ResourceId _tableId, bytes32 valueHash, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -410,7 +479,9 @@ library KeysWithValue {
     _store.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Pop an element from keysWithValue */
+  /**
+   * @notice Pop an element from keysWithValue.
+   */
   function popKeysWithValue(ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -418,7 +489,9 @@ library KeysWithValue {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keysWithValue */
+  /**
+   * @notice Pop an element from keysWithValue.
+   */
   function _popKeysWithValue(ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -426,7 +499,9 @@ library KeysWithValue {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keysWithValue (using the specified store) */
+  /**
+   * @notice Pop an element from keysWithValue (using the specified store).
+   */
   function popKeysWithValue(IStore _store, ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -434,7 +509,9 @@ library KeysWithValue {
     _store.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keysWithValue */
+  /**
+   * @notice Pop an element from keysWithValue.
+   */
   function pop(ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -442,7 +519,9 @@ library KeysWithValue {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keysWithValue */
+  /**
+   * @notice Pop an element from keysWithValue.
+   */
   function _pop(ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -450,7 +529,9 @@ library KeysWithValue {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keysWithValue (using the specified store) */
+  /**
+   * @notice Pop an element from keysWithValue (using the specified store).
+   */
   function pop(IStore _store, ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -459,8 +540,7 @@ library KeysWithValue {
   }
 
   /**
-   * Update an element of keysWithValue at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keysWithValue at `_index`.
    */
   function updateKeysWithValue(ResourceId _tableId, bytes32 valueHash, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -473,8 +553,7 @@ library KeysWithValue {
   }
 
   /**
-   * Update an element of keysWithValue at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keysWithValue at `_index`.
    */
   function _updateKeysWithValue(ResourceId _tableId, bytes32 valueHash, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -487,8 +566,7 @@ library KeysWithValue {
   }
 
   /**
-   * Update an element of keysWithValue (using the specified store) at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keysWithValue (using the specified store) at `_index`.
    */
   function updateKeysWithValue(
     IStore _store,
@@ -507,8 +585,7 @@ library KeysWithValue {
   }
 
   /**
-   * Update an element of keysWithValue at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keysWithValue at `_index`.
    */
   function update(ResourceId _tableId, bytes32 valueHash, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -521,8 +598,7 @@ library KeysWithValue {
   }
 
   /**
-   * Update an element of keysWithValue at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keysWithValue at `_index`.
    */
   function _update(ResourceId _tableId, bytes32 valueHash, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -535,8 +611,7 @@ library KeysWithValue {
   }
 
   /**
-   * Update an element of keysWithValue (using the specified store) at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keysWithValue (using the specified store) at `_index`.
    */
   function update(IStore _store, ResourceId _tableId, bytes32 valueHash, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -548,7 +623,9 @@ library KeysWithValue {
     }
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function deleteRecord(ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -556,7 +633,9 @@ library KeysWithValue {
     StoreSwitch.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function _deleteRecord(ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -564,7 +643,9 @@ library KeysWithValue {
     StoreCore.deleteRecord(_tableId, _keyTuple, _fieldLayout);
   }
 
-  /** Delete all data for given keys (using the specified store) */
+  /**
+   * @notice Delete all data for given keys (using the specified store).
+   */
   function deleteRecord(IStore _store, ResourceId _tableId, bytes32 valueHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;
@@ -572,7 +653,10 @@ library KeysWithValue {
     _store.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Tightly pack dynamic data using this table's schema */
+  /**
+   * @notice Tightly pack dynamic data lengths using this table's schema.
+   * @return _encodedLengths The lengths of the dynamic fields (packed into a single bytes32 value).
+   */
   function encodeLengths(bytes32[] memory keysWithValue) internal pure returns (PackedCounter _encodedLengths) {
     // Lengths are effectively checked during copy by 2**40 bytes exceeding gas limits
     unchecked {
@@ -580,12 +664,20 @@ library KeysWithValue {
     }
   }
 
-  /** Tightly pack dynamic data using this table's schema */
+  /**
+   * @notice Tightly pack dynamic (variable length) data using this table's schema.
+   * @return The dynamic data, encoded into a sequence of bytes.
+   */
   function encodeDynamic(bytes32[] memory keysWithValue) internal pure returns (bytes memory) {
     return abi.encodePacked(EncodeArray.encode((keysWithValue)));
   }
 
-  /** Tightly pack full data using this table's field layout */
+  /**
+   * @notice Encode all of a record's fields.
+   * @return The static (fixed length) data, encoded into a sequence of bytes.
+   * @return The lengths of the dynamic fields (packed into a single bytes32 value).
+   * @return The dyanmic (variable length) data, encoded into a sequence of bytes.
+   */
   function encode(bytes32[] memory keysWithValue) internal pure returns (bytes memory, PackedCounter, bytes memory) {
     bytes memory _staticData;
     PackedCounter _encodedLengths = encodeLengths(keysWithValue);
@@ -594,7 +686,9 @@ library KeysWithValue {
     return (_staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Encode keys as a bytes32 array using this table's field layout */
+  /**
+   * @notice Encode keys as a bytes32 array using this table's field layout.
+   */
   function encodeKeyTuple(bytes32 valueHash) internal pure returns (bytes32[] memory) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = valueHash;