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

package/src/modules/std-delegations/tables/CallboundDelegations.sol

@@ -33,12 +33,18 @@ FieldLayout constant _fieldLayout = FieldLayout.wrap(
 );
 
 library CallboundDelegations {
-  /** 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[](4);
     _keySchema[0] = SchemaType.ADDRESS;
@@ -49,7 +55,10 @@ library CallboundDelegations {
     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.UINT256;
@@ -57,7 +66,10 @@ library CallboundDelegations {
     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[](4);
     keyNames[0] = "delegator";
@@ -66,28 +78,39 @@ library CallboundDelegations {
     keyNames[3] = "callDataHash";
   }
 
-  /** 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] = "availableCalls";
   }
 
-  /** 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 availableCalls */
+  /**
+   * @notice Get availableCalls.
+   */
   function getAvailableCalls(
     address delegator,
     address delegatee,
@@ -104,7 +127,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls.
+   */
   function _getAvailableCalls(
     address delegator,
     address delegatee,
@@ -121,7 +146,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls (using the specified store) */
+  /**
+   * @notice Get availableCalls (using the specified store).
+   */
   function getAvailableCalls(
     IStore _store,
     address delegator,
@@ -139,7 +166,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls.
+   */
   function get(
     address delegator,
     address delegatee,
@@ -156,7 +185,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls.
+   */
   function _get(
     address delegator,
     address delegatee,
@@ -173,7 +204,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls (using the specified store) */
+  /**
+   * @notice Get availableCalls (using the specified store).
+   */
   function get(
     IStore _store,
     address delegator,
@@ -191,7 +224,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Set availableCalls */
+  /**
+   * @notice Set availableCalls.
+   */
   function setAvailableCalls(
     address delegator,
     address delegatee,
@@ -208,7 +243,9 @@ library CallboundDelegations {
     StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((availableCalls)), _fieldLayout);
   }
 
-  /** Set availableCalls */
+  /**
+   * @notice Set availableCalls.
+   */
   function _setAvailableCalls(
     address delegator,
     address delegatee,
@@ -225,7 +262,9 @@ library CallboundDelegations {
     StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((availableCalls)), _fieldLayout);
   }
 
-  /** Set availableCalls (using the specified store) */
+  /**
+   * @notice Set availableCalls (using the specified store).
+   */
   function setAvailableCalls(
     IStore _store,
     address delegator,
@@ -243,7 +282,9 @@ library CallboundDelegations {
     _store.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((availableCalls)), _fieldLayout);
   }
 
-  /** Set availableCalls */
+  /**
+   * @notice Set availableCalls.
+   */
   function set(
     address delegator,
     address delegatee,
@@ -260,7 +301,9 @@ library CallboundDelegations {
     StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((availableCalls)), _fieldLayout);
   }
 
-  /** Set availableCalls */
+  /**
+   * @notice Set availableCalls.
+   */
   function _set(
     address delegator,
     address delegatee,
@@ -277,7 +320,9 @@ library CallboundDelegations {
     StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((availableCalls)), _fieldLayout);
   }
 
-  /** Set availableCalls (using the specified store) */
+  /**
+   * @notice Set availableCalls (using the specified store).
+   */
   function set(
     IStore _store,
     address delegator,
@@ -295,7 +340,9 @@ library CallboundDelegations {
     _store.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((availableCalls)), _fieldLayout);
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function deleteRecord(address delegator, address delegatee, ResourceId systemId, bytes32 callDataHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](4);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -306,7 +353,9 @@ library CallboundDelegations {
     StoreSwitch.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function _deleteRecord(address delegator, address delegatee, ResourceId systemId, bytes32 callDataHash) internal {
     bytes32[] memory _keyTuple = new bytes32[](4);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -317,7 +366,9 @@ library CallboundDelegations {
     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,
     address delegator,
@@ -334,12 +385,20 @@ library CallboundDelegations {
     _store.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Tightly pack static data using this table's schema */
+  /**
+   * @notice Tightly pack static (fixed length) data using this table's schema.
+   * @return The static data, encoded into a sequence of bytes.
+   */
   function encodeStatic(uint256 availableCalls) internal pure returns (bytes memory) {
     return abi.encodePacked(availableCalls);
   }
 
-  /** 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(uint256 availableCalls) internal pure returns (bytes memory, PackedCounter, bytes memory) {
     bytes memory _staticData = encodeStatic(availableCalls);
 
@@ -349,7 +408,9 @@ library CallboundDelegations {
     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(
     address delegator,
     address delegatee,

package/src/modules/std-delegations/tables/TimeboundDelegations.sol

@@ -30,12 +30,18 @@ FieldLayout constant _fieldLayout = FieldLayout.wrap(
 );
 
 library TimeboundDelegations {
-  /** 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[](2);
     _keySchema[0] = SchemaType.ADDRESS;
@@ -44,7 +50,10 @@ library TimeboundDelegations {
     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.UINT256;
@@ -52,35 +61,49 @@ library TimeboundDelegations {
     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[](2);
     keyNames[0] = "delegator";
     keyNames[1] = "delegatee";
   }
 
-  /** 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] = "maxTimestamp";
   }
 
-  /** 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 maxTimestamp */
+  /**
+   * @notice Get maxTimestamp.
+   */
   function getMaxTimestamp(address delegator, address delegatee) internal view returns (uint256 maxTimestamp) {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -90,7 +113,9 @@ library TimeboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get maxTimestamp */
+  /**
+   * @notice Get maxTimestamp.
+   */
   function _getMaxTimestamp(address delegator, address delegatee) internal view returns (uint256 maxTimestamp) {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -100,7 +125,9 @@ library TimeboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get maxTimestamp (using the specified store) */
+  /**
+   * @notice Get maxTimestamp (using the specified store).
+   */
   function getMaxTimestamp(
     IStore _store,
     address delegator,
@@ -114,7 +141,9 @@ library TimeboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get maxTimestamp */
+  /**
+   * @notice Get maxTimestamp.
+   */
   function get(address delegator, address delegatee) internal view returns (uint256 maxTimestamp) {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -124,7 +153,9 @@ library TimeboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get maxTimestamp */
+  /**
+   * @notice Get maxTimestamp.
+   */
   function _get(address delegator, address delegatee) internal view returns (uint256 maxTimestamp) {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -134,7 +165,9 @@ library TimeboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get maxTimestamp (using the specified store) */
+  /**
+   * @notice Get maxTimestamp (using the specified store).
+   */
   function get(IStore _store, address delegator, address delegatee) internal view returns (uint256 maxTimestamp) {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -144,7 +177,9 @@ library TimeboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Set maxTimestamp */
+  /**
+   * @notice Set maxTimestamp.
+   */
   function setMaxTimestamp(address delegator, address delegatee, uint256 maxTimestamp) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -153,7 +188,9 @@ library TimeboundDelegations {
     StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((maxTimestamp)), _fieldLayout);
   }
 
-  /** Set maxTimestamp */
+  /**
+   * @notice Set maxTimestamp.
+   */
   function _setMaxTimestamp(address delegator, address delegatee, uint256 maxTimestamp) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -162,7 +199,9 @@ library TimeboundDelegations {
     StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((maxTimestamp)), _fieldLayout);
   }
 
-  /** Set maxTimestamp (using the specified store) */
+  /**
+   * @notice Set maxTimestamp (using the specified store).
+   */
   function setMaxTimestamp(IStore _store, address delegator, address delegatee, uint256 maxTimestamp) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -171,7 +210,9 @@ library TimeboundDelegations {
     _store.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((maxTimestamp)), _fieldLayout);
   }
 
-  /** Set maxTimestamp */
+  /**
+   * @notice Set maxTimestamp.
+   */
   function set(address delegator, address delegatee, uint256 maxTimestamp) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -180,7 +221,9 @@ library TimeboundDelegations {
     StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((maxTimestamp)), _fieldLayout);
   }
 
-  /** Set maxTimestamp */
+  /**
+   * @notice Set maxTimestamp.
+   */
   function _set(address delegator, address delegatee, uint256 maxTimestamp) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -189,7 +232,9 @@ library TimeboundDelegations {
     StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((maxTimestamp)), _fieldLayout);
   }
 
-  /** Set maxTimestamp (using the specified store) */
+  /**
+   * @notice Set maxTimestamp (using the specified store).
+   */
   function set(IStore _store, address delegator, address delegatee, uint256 maxTimestamp) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -198,7 +243,9 @@ library TimeboundDelegations {
     _store.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((maxTimestamp)), _fieldLayout);
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function deleteRecord(address delegator, address delegatee) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -207,7 +254,9 @@ library TimeboundDelegations {
     StoreSwitch.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Delete all data for given keys */
+  /**
+   * @notice Delete all data for given keys.
+   */
   function _deleteRecord(address delegator, address delegatee) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -216,7 +265,9 @@ library TimeboundDelegations {
     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, address delegator, address delegatee) internal {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));
@@ -225,12 +276,20 @@ library TimeboundDelegations {
     _store.deleteRecord(_tableId, _keyTuple);
   }
 
-  /** Tightly pack static data using this table's schema */
+  /**
+   * @notice Tightly pack static (fixed length) data using this table's schema.
+   * @return The static data, encoded into a sequence of bytes.
+   */
   function encodeStatic(uint256 maxTimestamp) internal pure returns (bytes memory) {
     return abi.encodePacked(maxTimestamp);
   }
 
-  /** 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(uint256 maxTimestamp) internal pure returns (bytes memory, PackedCounter, bytes memory) {
     bytes memory _staticData = encodeStatic(maxTimestamp);
 
@@ -240,7 +299,9 @@ library TimeboundDelegations {
     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(address delegator, address delegatee) internal pure returns (bytes32[] memory) {
     bytes32[] memory _keyTuple = new bytes32[](2);
     _keyTuple[0] = bytes32(uint256(uint160(delegator)));