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

package/src/modules/keysintable/tables/KeysInTable.sol

@@ -41,12 +41,18 @@ struct KeysInTableData {
 }
 
 library KeysInTable {
-  /** 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;
@@ -54,7 +60,10 @@ library KeysInTable {
     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[](5);
     _valueSchema[0] = SchemaType.BYTES32_ARRAY;
@@ -66,13 +75,19 @@ library KeysInTable {
     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] = "sourceTableId";
   }
 
-  /** 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[](5);
     fieldNames[0] = "keys0";
@@ -82,22 +97,30 @@ library KeysInTable {
     fieldNames[4] = "keys4";
   }
 
-  /** Register the table with its config */
+  /**
+   * @notice Register the table with its config.
+   */
   function register() internal {
     StoreSwitch.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Register the table with its config */
+  /**
+   * @notice Register the table with its config.
+   */
   function _register() 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) internal {
     _store.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Get keys0 */
+  /**
+   * @notice Get keys0.
+   */
   function getKeys0(ResourceId sourceTableId) internal view returns (bytes32[] memory keys0) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -106,7 +129,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys0 */
+  /**
+   * @notice Get keys0.
+   */
   function _getKeys0(ResourceId sourceTableId) internal view returns (bytes32[] memory keys0) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -115,7 +140,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys0 (using the specified store) */
+  /**
+   * @notice Get keys0 (using the specified store).
+   */
   function getKeys0(IStore _store, ResourceId sourceTableId) internal view returns (bytes32[] memory keys0) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -124,7 +151,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Set keys0 */
+  /**
+   * @notice Set keys0.
+   */
   function setKeys0(ResourceId sourceTableId, bytes32[] memory keys0) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -132,7 +161,9 @@ library KeysInTable {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keys0)));
   }
 
-  /** Set keys0 */
+  /**
+   * @notice Set keys0.
+   */
   function _setKeys0(ResourceId sourceTableId, bytes32[] memory keys0) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -140,7 +171,9 @@ library KeysInTable {
     StoreCore.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keys0)));
   }
 
-  /** Set keys0 (using the specified store) */
+  /**
+   * @notice Set keys0 (using the specified store).
+   */
   function setKeys0(IStore _store, ResourceId sourceTableId, bytes32[] memory keys0) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -148,7 +181,9 @@ library KeysInTable {
     _store.setDynamicField(_tableId, _keyTuple, 0, EncodeArray.encode((keys0)));
   }
 
-  /** Get the length of keys0 */
+  /**
+   * @notice Get the length of keys0.
+   */
   function lengthKeys0(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -159,7 +194,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys0 */
+  /**
+   * @notice Get the length of keys0.
+   */
   function _lengthKeys0(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -170,7 +207,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys0 (using the specified store) */
+  /**
+   * @notice Get the length of keys0 (using the specified store).
+   */
   function lengthKeys0(IStore _store, ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -182,8 +221,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys0
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys0.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys0(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -196,8 +235,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys0
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys0.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItemKeys0(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -210,8 +249,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys0 (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys0 (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys0(IStore _store, ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -223,7 +262,9 @@ library KeysInTable {
     }
   }
 
-  /** Push an element to keys0 */
+  /**
+   * @notice Push an element to keys0.
+   */
   function pushKeys0(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -231,7 +272,9 @@ library KeysInTable {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys0 */
+  /**
+   * @notice Push an element to keys0.
+   */
   function _pushKeys0(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -239,7 +282,9 @@ library KeysInTable {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys0 (using the specified store) */
+  /**
+   * @notice Push an element to keys0 (using the specified store).
+   */
   function pushKeys0(IStore _store, ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -247,7 +292,9 @@ library KeysInTable {
     _store.pushToDynamicField(_tableId, _keyTuple, 0, abi.encodePacked((_element)));
   }
 
-  /** Pop an element from keys0 */
+  /**
+   * @notice Pop an element from keys0.
+   */
   function popKeys0(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -255,7 +302,9 @@ library KeysInTable {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keys0 */
+  /**
+   * @notice Pop an element from keys0.
+   */
   function _popKeys0(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -263,7 +312,9 @@ library KeysInTable {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 0, 32);
   }
 
-  /** Pop an element from keys0 (using the specified store) */
+  /**
+   * @notice Pop an element from keys0 (using the specified store).
+   */
   function popKeys0(IStore _store, ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -272,8 +323,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys0 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys0 at `_index`.
    */
   function updateKeys0(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -286,8 +336,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys0 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys0 at `_index`.
    */
   function _updateKeys0(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -300,8 +349,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys0 (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 keys0 (using the specified store) at `_index`.
    */
   function updateKeys0(IStore _store, ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -313,7 +361,9 @@ library KeysInTable {
     }
   }
 
-  /** Get keys1 */
+  /**
+   * @notice Get keys1.
+   */
   function getKeys1(ResourceId sourceTableId) internal view returns (bytes32[] memory keys1) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -322,7 +372,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys1 */
+  /**
+   * @notice Get keys1.
+   */
   function _getKeys1(ResourceId sourceTableId) internal view returns (bytes32[] memory keys1) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -331,7 +383,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys1 (using the specified store) */
+  /**
+   * @notice Get keys1 (using the specified store).
+   */
   function getKeys1(IStore _store, ResourceId sourceTableId) internal view returns (bytes32[] memory keys1) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -340,7 +394,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Set keys1 */
+  /**
+   * @notice Set keys1.
+   */
   function setKeys1(ResourceId sourceTableId, bytes32[] memory keys1) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -348,7 +404,9 @@ library KeysInTable {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 1, EncodeArray.encode((keys1)));
   }
 
-  /** Set keys1 */
+  /**
+   * @notice Set keys1.
+   */
   function _setKeys1(ResourceId sourceTableId, bytes32[] memory keys1) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -356,7 +414,9 @@ library KeysInTable {
     StoreCore.setDynamicField(_tableId, _keyTuple, 1, EncodeArray.encode((keys1)));
   }
 
-  /** Set keys1 (using the specified store) */
+  /**
+   * @notice Set keys1 (using the specified store).
+   */
   function setKeys1(IStore _store, ResourceId sourceTableId, bytes32[] memory keys1) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -364,7 +424,9 @@ library KeysInTable {
     _store.setDynamicField(_tableId, _keyTuple, 1, EncodeArray.encode((keys1)));
   }
 
-  /** Get the length of keys1 */
+  /**
+   * @notice Get the length of keys1.
+   */
   function lengthKeys1(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -375,7 +437,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys1 */
+  /**
+   * @notice Get the length of keys1.
+   */
   function _lengthKeys1(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -386,7 +450,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys1 (using the specified store) */
+  /**
+   * @notice Get the length of keys1 (using the specified store).
+   */
   function lengthKeys1(IStore _store, ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -398,8 +464,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys1
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys1.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys1(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -412,8 +478,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys1
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys1.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItemKeys1(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -426,8 +492,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys1 (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys1 (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys1(IStore _store, ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -439,7 +505,9 @@ library KeysInTable {
     }
   }
 
-  /** Push an element to keys1 */
+  /**
+   * @notice Push an element to keys1.
+   */
   function pushKeys1(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -447,7 +515,9 @@ library KeysInTable {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 1, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys1 */
+  /**
+   * @notice Push an element to keys1.
+   */
   function _pushKeys1(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -455,7 +525,9 @@ library KeysInTable {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 1, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys1 (using the specified store) */
+  /**
+   * @notice Push an element to keys1 (using the specified store).
+   */
   function pushKeys1(IStore _store, ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -463,7 +535,9 @@ library KeysInTable {
     _store.pushToDynamicField(_tableId, _keyTuple, 1, abi.encodePacked((_element)));
   }
 
-  /** Pop an element from keys1 */
+  /**
+   * @notice Pop an element from keys1.
+   */
   function popKeys1(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -471,7 +545,9 @@ library KeysInTable {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 1, 32);
   }
 
-  /** Pop an element from keys1 */
+  /**
+   * @notice Pop an element from keys1.
+   */
   function _popKeys1(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -479,7 +555,9 @@ library KeysInTable {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 1, 32);
   }
 
-  /** Pop an element from keys1 (using the specified store) */
+  /**
+   * @notice Pop an element from keys1 (using the specified store).
+   */
   function popKeys1(IStore _store, ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -488,8 +566,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys1 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys1 at `_index`.
    */
   function updateKeys1(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -502,8 +579,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys1 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys1 at `_index`.
    */
   function _updateKeys1(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -516,8 +592,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys1 (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 keys1 (using the specified store) at `_index`.
    */
   function updateKeys1(IStore _store, ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -529,7 +604,9 @@ library KeysInTable {
     }
   }
 
-  /** Get keys2 */
+  /**
+   * @notice Get keys2.
+   */
   function getKeys2(ResourceId sourceTableId) internal view returns (bytes32[] memory keys2) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -538,7 +615,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys2 */
+  /**
+   * @notice Get keys2.
+   */
   function _getKeys2(ResourceId sourceTableId) internal view returns (bytes32[] memory keys2) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -547,7 +626,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys2 (using the specified store) */
+  /**
+   * @notice Get keys2 (using the specified store).
+   */
   function getKeys2(IStore _store, ResourceId sourceTableId) internal view returns (bytes32[] memory keys2) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -556,7 +637,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Set keys2 */
+  /**
+   * @notice Set keys2.
+   */
   function setKeys2(ResourceId sourceTableId, bytes32[] memory keys2) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -564,7 +647,9 @@ library KeysInTable {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 2, EncodeArray.encode((keys2)));
   }
 
-  /** Set keys2 */
+  /**
+   * @notice Set keys2.
+   */
   function _setKeys2(ResourceId sourceTableId, bytes32[] memory keys2) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -572,7 +657,9 @@ library KeysInTable {
     StoreCore.setDynamicField(_tableId, _keyTuple, 2, EncodeArray.encode((keys2)));
   }
 
-  /** Set keys2 (using the specified store) */
+  /**
+   * @notice Set keys2 (using the specified store).
+   */
   function setKeys2(IStore _store, ResourceId sourceTableId, bytes32[] memory keys2) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -580,7 +667,9 @@ library KeysInTable {
     _store.setDynamicField(_tableId, _keyTuple, 2, EncodeArray.encode((keys2)));
   }
 
-  /** Get the length of keys2 */
+  /**
+   * @notice Get the length of keys2.
+   */
   function lengthKeys2(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -591,7 +680,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys2 */
+  /**
+   * @notice Get the length of keys2.
+   */
   function _lengthKeys2(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -602,7 +693,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys2 (using the specified store) */
+  /**
+   * @notice Get the length of keys2 (using the specified store).
+   */
   function lengthKeys2(IStore _store, ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -614,8 +707,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys2
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys2.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys2(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -628,8 +721,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys2
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys2.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItemKeys2(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -642,8 +735,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys2 (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys2 (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys2(IStore _store, ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -655,7 +748,9 @@ library KeysInTable {
     }
   }
 
-  /** Push an element to keys2 */
+  /**
+   * @notice Push an element to keys2.
+   */
   function pushKeys2(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -663,7 +758,9 @@ library KeysInTable {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 2, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys2 */
+  /**
+   * @notice Push an element to keys2.
+   */
   function _pushKeys2(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -671,7 +768,9 @@ library KeysInTable {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 2, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys2 (using the specified store) */
+  /**
+   * @notice Push an element to keys2 (using the specified store).
+   */
   function pushKeys2(IStore _store, ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -679,7 +778,9 @@ library KeysInTable {
     _store.pushToDynamicField(_tableId, _keyTuple, 2, abi.encodePacked((_element)));
   }
 
-  /** Pop an element from keys2 */
+  /**
+   * @notice Pop an element from keys2.
+   */
   function popKeys2(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -687,7 +788,9 @@ library KeysInTable {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 2, 32);
   }
 
-  /** Pop an element from keys2 */
+  /**
+   * @notice Pop an element from keys2.
+   */
   function _popKeys2(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -695,7 +798,9 @@ library KeysInTable {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 2, 32);
   }
 
-  /** Pop an element from keys2 (using the specified store) */
+  /**
+   * @notice Pop an element from keys2 (using the specified store).
+   */
   function popKeys2(IStore _store, ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -704,8 +809,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys2 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys2 at `_index`.
    */
   function updateKeys2(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -718,8 +822,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys2 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys2 at `_index`.
    */
   function _updateKeys2(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -732,8 +835,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys2 (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 keys2 (using the specified store) at `_index`.
    */
   function updateKeys2(IStore _store, ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -745,7 +847,9 @@ library KeysInTable {
     }
   }
 
-  /** Get keys3 */
+  /**
+   * @notice Get keys3.
+   */
   function getKeys3(ResourceId sourceTableId) internal view returns (bytes32[] memory keys3) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -754,7 +858,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys3 */
+  /**
+   * @notice Get keys3.
+   */
   function _getKeys3(ResourceId sourceTableId) internal view returns (bytes32[] memory keys3) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -763,7 +869,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys3 (using the specified store) */
+  /**
+   * @notice Get keys3 (using the specified store).
+   */
   function getKeys3(IStore _store, ResourceId sourceTableId) internal view returns (bytes32[] memory keys3) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -772,7 +880,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Set keys3 */
+  /**
+   * @notice Set keys3.
+   */
   function setKeys3(ResourceId sourceTableId, bytes32[] memory keys3) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -780,7 +890,9 @@ library KeysInTable {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 3, EncodeArray.encode((keys3)));
   }
 
-  /** Set keys3 */
+  /**
+   * @notice Set keys3.
+   */
   function _setKeys3(ResourceId sourceTableId, bytes32[] memory keys3) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -788,7 +900,9 @@ library KeysInTable {
     StoreCore.setDynamicField(_tableId, _keyTuple, 3, EncodeArray.encode((keys3)));
   }
 
-  /** Set keys3 (using the specified store) */
+  /**
+   * @notice Set keys3 (using the specified store).
+   */
   function setKeys3(IStore _store, ResourceId sourceTableId, bytes32[] memory keys3) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -796,7 +910,9 @@ library KeysInTable {
     _store.setDynamicField(_tableId, _keyTuple, 3, EncodeArray.encode((keys3)));
   }
 
-  /** Get the length of keys3 */
+  /**
+   * @notice Get the length of keys3.
+   */
   function lengthKeys3(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -807,7 +923,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys3 */
+  /**
+   * @notice Get the length of keys3.
+   */
   function _lengthKeys3(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -818,7 +936,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys3 (using the specified store) */
+  /**
+   * @notice Get the length of keys3 (using the specified store).
+   */
   function lengthKeys3(IStore _store, ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -830,8 +950,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys3
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys3.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys3(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -844,8 +964,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys3
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys3.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItemKeys3(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -858,8 +978,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys3 (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys3 (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys3(IStore _store, ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -871,7 +991,9 @@ library KeysInTable {
     }
   }
 
-  /** Push an element to keys3 */
+  /**
+   * @notice Push an element to keys3.
+   */
   function pushKeys3(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -879,7 +1001,9 @@ library KeysInTable {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 3, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys3 */
+  /**
+   * @notice Push an element to keys3.
+   */
   function _pushKeys3(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -887,7 +1011,9 @@ library KeysInTable {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 3, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys3 (using the specified store) */
+  /**
+   * @notice Push an element to keys3 (using the specified store).
+   */
   function pushKeys3(IStore _store, ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -895,7 +1021,9 @@ library KeysInTable {
     _store.pushToDynamicField(_tableId, _keyTuple, 3, abi.encodePacked((_element)));
   }
 
-  /** Pop an element from keys3 */
+  /**
+   * @notice Pop an element from keys3.
+   */
   function popKeys3(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -903,7 +1031,9 @@ library KeysInTable {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 3, 32);
   }
 
-  /** Pop an element from keys3 */
+  /**
+   * @notice Pop an element from keys3.
+   */
   function _popKeys3(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -911,7 +1041,9 @@ library KeysInTable {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 3, 32);
   }
 
-  /** Pop an element from keys3 (using the specified store) */
+  /**
+   * @notice Pop an element from keys3 (using the specified store).
+   */
   function popKeys3(IStore _store, ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -920,8 +1052,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys3 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys3 at `_index`.
    */
   function updateKeys3(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -934,8 +1065,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys3 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys3 at `_index`.
    */
   function _updateKeys3(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -948,8 +1078,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys3 (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 keys3 (using the specified store) at `_index`.
    */
   function updateKeys3(IStore _store, ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -961,7 +1090,9 @@ library KeysInTable {
     }
   }
 
-  /** Get keys4 */
+  /**
+   * @notice Get keys4.
+   */
   function getKeys4(ResourceId sourceTableId) internal view returns (bytes32[] memory keys4) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -970,7 +1101,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys4 */
+  /**
+   * @notice Get keys4.
+   */
   function _getKeys4(ResourceId sourceTableId) internal view returns (bytes32[] memory keys4) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -979,7 +1112,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Get keys4 (using the specified store) */
+  /**
+   * @notice Get keys4 (using the specified store).
+   */
   function getKeys4(IStore _store, ResourceId sourceTableId) internal view returns (bytes32[] memory keys4) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -988,7 +1123,9 @@ library KeysInTable {
     return (SliceLib.getSubslice(_blob, 0, _blob.length).decodeArray_bytes32());
   }
 
-  /** Set keys4 */
+  /**
+   * @notice Set keys4.
+   */
   function setKeys4(ResourceId sourceTableId, bytes32[] memory keys4) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -996,7 +1133,9 @@ library KeysInTable {
     StoreSwitch.setDynamicField(_tableId, _keyTuple, 4, EncodeArray.encode((keys4)));
   }
 
-  /** Set keys4 */
+  /**
+   * @notice Set keys4.
+   */
   function _setKeys4(ResourceId sourceTableId, bytes32[] memory keys4) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1004,7 +1143,9 @@ library KeysInTable {
     StoreCore.setDynamicField(_tableId, _keyTuple, 4, EncodeArray.encode((keys4)));
   }
 
-  /** Set keys4 (using the specified store) */
+  /**
+   * @notice Set keys4 (using the specified store).
+   */
   function setKeys4(IStore _store, ResourceId sourceTableId, bytes32[] memory keys4) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1012,7 +1153,9 @@ library KeysInTable {
     _store.setDynamicField(_tableId, _keyTuple, 4, EncodeArray.encode((keys4)));
   }
 
-  /** Get the length of keys4 */
+  /**
+   * @notice Get the length of keys4.
+   */
   function lengthKeys4(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1023,7 +1166,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys4 */
+  /**
+   * @notice Get the length of keys4.
+   */
   function _lengthKeys4(ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1034,7 +1179,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the length of keys4 (using the specified store) */
+  /**
+   * @notice Get the length of keys4 (using the specified store).
+   */
   function lengthKeys4(IStore _store, ResourceId sourceTableId) internal view returns (uint256) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1046,8 +1193,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys4
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys4.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys4(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -1060,8 +1207,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys4
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys4.
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function _getItemKeys4(ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -1074,8 +1221,8 @@ library KeysInTable {
   }
 
   /**
-   * Get an item of keys4 (using the specified store)
-   * (unchecked, returns invalid data if index overflows)
+   * @notice Get an item of keys4 (using the specified store).
+   * @dev Reverts with Store_IndexOutOfBounds if `_index` is out of bounds for the array.
    */
   function getItemKeys4(IStore _store, ResourceId sourceTableId, uint256 _index) internal view returns (bytes32) {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -1087,7 +1234,9 @@ library KeysInTable {
     }
   }
 
-  /** Push an element to keys4 */
+  /**
+   * @notice Push an element to keys4.
+   */
   function pushKeys4(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1095,7 +1244,9 @@ library KeysInTable {
     StoreSwitch.pushToDynamicField(_tableId, _keyTuple, 4, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys4 */
+  /**
+   * @notice Push an element to keys4.
+   */
   function _pushKeys4(ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1103,7 +1254,9 @@ library KeysInTable {
     StoreCore.pushToDynamicField(_tableId, _keyTuple, 4, abi.encodePacked((_element)));
   }
 
-  /** Push an element to keys4 (using the specified store) */
+  /**
+   * @notice Push an element to keys4 (using the specified store).
+   */
   function pushKeys4(IStore _store, ResourceId sourceTableId, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1111,7 +1264,9 @@ library KeysInTable {
     _store.pushToDynamicField(_tableId, _keyTuple, 4, abi.encodePacked((_element)));
   }
 
-  /** Pop an element from keys4 */
+  /**
+   * @notice Pop an element from keys4.
+   */
   function popKeys4(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1119,7 +1274,9 @@ library KeysInTable {
     StoreSwitch.popFromDynamicField(_tableId, _keyTuple, 4, 32);
   }
 
-  /** Pop an element from keys4 */
+  /**
+   * @notice Pop an element from keys4.
+   */
   function _popKeys4(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1127,7 +1284,9 @@ library KeysInTable {
     StoreCore.popFromDynamicField(_tableId, _keyTuple, 4, 32);
   }
 
-  /** Pop an element from keys4 (using the specified store) */
+  /**
+   * @notice Pop an element from keys4 (using the specified store).
+   */
   function popKeys4(IStore _store, ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1136,8 +1295,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys4 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys4 at `_index`.
    */
   function updateKeys4(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -1150,8 +1308,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys4 at `_index`
-   * (checked only to prevent modifying other tables; can corrupt own data if index overflows)
+   * @notice Update an element of keys4 at `_index`.
    */
   function _updateKeys4(ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -1164,8 +1321,7 @@ library KeysInTable {
   }
 
   /**
-   * Update an element of keys4 (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 keys4 (using the specified store) at `_index`.
    */
   function updateKeys4(IStore _store, ResourceId sourceTableId, uint256 _index, bytes32 _element) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
@@ -1177,7 +1333,9 @@ library KeysInTable {
     }
   }
 
-  /** Get the full data */
+  /**
+   * @notice Get the full data.
+   */
   function get(ResourceId sourceTableId) internal view returns (KeysInTableData memory _table) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1190,7 +1348,9 @@ library KeysInTable {
     return decode(_staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Get the full data */
+  /**
+   * @notice Get the full data.
+   */
   function _get(ResourceId sourceTableId) internal view returns (KeysInTableData memory _table) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1203,7 +1363,9 @@ library KeysInTable {
     return decode(_staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Get the full data (using the specified store) */
+  /**
+   * @notice Get the full data (using the specified store).
+   */
   function get(IStore _store, ResourceId sourceTableId) internal view returns (KeysInTableData memory _table) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1216,7 +1378,9 @@ library KeysInTable {
     return decode(_staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Set the full data using individual values */
+  /**
+   * @notice Set the full data using individual values.
+   */
   function set(
     ResourceId sourceTableId,
     bytes32[] memory keys0,
@@ -1235,7 +1399,9 @@ library KeysInTable {
     StoreSwitch.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Set the full data using individual values */
+  /**
+   * @notice Set the full data using individual values.
+   */
   function _set(
     ResourceId sourceTableId,
     bytes32[] memory keys0,
@@ -1254,7 +1420,9 @@ library KeysInTable {
     StoreCore.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData, _fieldLayout);
   }
 
-  /** Set the full data using individual values (using the specified store) */
+  /**
+   * @notice Set the full data using individual values (using the specified store).
+   */
   function set(
     IStore _store,
     ResourceId sourceTableId,
@@ -1274,7 +1442,9 @@ library KeysInTable {
     _store.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Set the full data using the data struct */
+  /**
+   * @notice Set the full data using the data struct.
+   */
   function set(ResourceId sourceTableId, KeysInTableData memory _table) internal {
     bytes memory _staticData;
     PackedCounter _encodedLengths = encodeLengths(_table.keys0, _table.keys1, _table.keys2, _table.keys3, _table.keys4);
@@ -1286,7 +1456,9 @@ library KeysInTable {
     StoreSwitch.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData);
   }
 
-  /** Set the full data using the data struct */
+  /**
+   * @notice Set the full data using the data struct.
+   */
   function _set(ResourceId sourceTableId, KeysInTableData memory _table) internal {
     bytes memory _staticData;
     PackedCounter _encodedLengths = encodeLengths(_table.keys0, _table.keys1, _table.keys2, _table.keys3, _table.keys4);
@@ -1298,7 +1470,9 @@ library KeysInTable {
     StoreCore.setRecord(_tableId, _keyTuple, _staticData, _encodedLengths, _dynamicData, _fieldLayout);
   }
 
-  /** Set the full data using the data struct (using the specified store) */
+  /**
+   * @notice Set the full data using the data struct (using the specified store).
+   */
   function set(IStore _store, ResourceId sourceTableId, KeysInTableData memory _table) internal {
     bytes memory _staticData;
     PackedCounter _encodedLengths = encodeLengths(_table.keys0, _table.keys1, _table.keys2, _table.keys3, _table.keys4);
@@ -1311,8 +1485,7 @@ library KeysInTable {
   }
 
   /**
-   * Decode the tightly packed blob of static data using this table's field layout
-   * Undefined behaviour for invalid blobs
+   * @notice Decode the tightly packed blob of dynamic data using the encoded lengths.
    */
   function decodeDynamic(
     PackedCounter _encodedLengths,
@@ -1361,8 +1534,10 @@ library KeysInTable {
   }
 
   /**
-   * Decode the tightly packed blob using this table's field layout.
-   * Undefined behaviour for invalid blobs.
+   * @notice Decode the tightly packed blobs using this table's field layout.
+   *
+   * @param _encodedLengths Encoded lengths of dynamic fields.
+   * @param _dynamicData Tightly packed dynamic fields.
    */
   function decode(
     bytes memory,
@@ -1375,7 +1550,9 @@ library KeysInTable {
     );
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function deleteRecord(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1383,7 +1560,9 @@ library KeysInTable {
     StoreSwitch.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function _deleteRecord(ResourceId sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1391,7 +1570,9 @@ library KeysInTable {
     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 sourceTableId) internal {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);
@@ -1399,7 +1580,10 @@ library KeysInTable {
     _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 keys0,
     bytes32[] memory keys1,
@@ -1419,7 +1603,10 @@ library KeysInTable {
     }
   }
 
-  /** 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 keys0,
     bytes32[] memory keys1,
@@ -1437,7 +1624,12 @@ library KeysInTable {
       );
   }
 
-  /** 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 keys0,
     bytes32[] memory keys1,
@@ -1452,7 +1644,9 @@ library KeysInTable {
     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(ResourceId sourceTableId) internal pure returns (bytes32[] memory) {
     bytes32[] memory _keyTuple = new bytes32[](1);
     _keyTuple[0] = ResourceId.unwrap(sourceTableId);