@latticexyz/world-modules 2.0.0-main-cf2104eb → 2.0.0-main-fe005ee0

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

@@ -87,7 +87,9 @@ library CallboundDelegations {
     _store.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls
+   */
   function getAvailableCalls(
     address delegator,
     address delegatee,
@@ -104,7 +106,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls
+   */
   function _getAvailableCalls(
     address delegator,
     address delegatee,
@@ -121,7 +125,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 +145,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls
+   */
   function get(
     address delegator,
     address delegatee,
@@ -156,7 +164,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get availableCalls */
+  /**
+   * @notice Get availableCalls
+   */
   function _get(
     address delegator,
     address delegatee,
@@ -173,7 +183,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 +203,9 @@ library CallboundDelegations {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Set availableCalls */
+  /**
+   * @notice Set availableCalls
+   */
   function setAvailableCalls(
     address delegator,
     address delegatee,
@@ -208,7 +222,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 +241,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 +261,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 +280,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 +299,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,

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

@@ -80,7 +80,9 @@ library TimeboundDelegations {
     _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 +92,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 +104,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 +120,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 +132,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 +144,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 +156,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 +167,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 +178,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 +189,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 +200,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 +211,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)));

package/src/modules/uniqueentity/tables/UniqueEntity.sol

@@ -71,7 +71,9 @@ library UniqueEntity {
     _store.registerTable(_tableId, _fieldLayout, getKeySchema(), getValueSchema(), getKeyNames(), getFieldNames());
   }
 
-  /** Get value */
+  /**
+   * @notice Get value
+   */
   function getValue(ResourceId _tableId) internal view returns (uint256 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
@@ -79,7 +81,9 @@ library UniqueEntity {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get value */
+  /**
+   * @notice Get value
+   */
   function _getValue(ResourceId _tableId) internal view returns (uint256 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
@@ -87,7 +91,9 @@ library UniqueEntity {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get value (using the specified store) */
+  /**
+   * @notice Get value (using the specified store)
+   */
   function getValue(IStore _store, ResourceId _tableId) internal view returns (uint256 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
@@ -95,7 +101,9 @@ library UniqueEntity {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get value */
+  /**
+   * @notice Get value
+   */
   function get(ResourceId _tableId) internal view returns (uint256 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
@@ -103,7 +111,9 @@ library UniqueEntity {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get value */
+  /**
+   * @notice Get value
+   */
   function _get(ResourceId _tableId) internal view returns (uint256 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
@@ -111,7 +121,9 @@ library UniqueEntity {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Get value (using the specified store) */
+  /**
+   * @notice Get value (using the specified store)
+   */
   function get(IStore _store, ResourceId _tableId) internal view returns (uint256 value) {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
@@ -119,42 +131,54 @@ library UniqueEntity {
     return (uint256(bytes32(_blob)));
   }
 
-  /** Set value */
+  /**
+   * @notice Set value
+   */
   function setValue(ResourceId _tableId, uint256 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
-  /** Set value */
+  /**
+   * @notice Set value
+   */
   function _setValue(ResourceId _tableId, uint256 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
-  /** Set value (using the specified store) */
+  /**
+   * @notice Set value (using the specified store)
+   */
   function setValue(IStore _store, ResourceId _tableId, uint256 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     _store.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
-  /** Set value */
+  /**
+   * @notice Set value
+   */
   function set(ResourceId _tableId, uint256 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     StoreSwitch.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
-  /** Set value */
+  /**
+   * @notice Set value
+   */
   function _set(ResourceId _tableId, uint256 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);
 
     StoreCore.setStaticField(_tableId, _keyTuple, 0, abi.encodePacked((value)), _fieldLayout);
   }
 
-  /** Set value (using the specified store) */
+  /**
+   * @notice Set value (using the specified store)
+   */
   function set(IStore _store, ResourceId _tableId, uint256 value) internal {
     bytes32[] memory _keyTuple = new bytes32[](0);