fix: add natspec

defi-wonderland · Aug 21, 2024 · ed705e8 · ed705e8
1 parent 6433041
commit ed705e8
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/solidity/contracts/DataReceiver.sol b/solidity/contracts/DataReceiver.sol
@@ -24,6 +24,7 @@ contract DataReceiver is IDataReceiver, Governable {
     oracleFactory = _oracleFactory;
   }
 
+  /// @inheritdoc IDataReceiver
   function addObservations(
     IOracleSidechain.ObservationData[] memory _observationsData,
     bytes32 _poolSalt,
@@ -84,6 +85,7 @@ contract DataReceiver is IDataReceiver, Governable {
     }
   }
 
+  /// @inheritdoc IDataReceiver
   function syncObservations(bytes32 _poolSalt, uint256 _maxObservations) external {
     IOracleSidechain _oracle = deployedOracles[_poolSalt];
     if (address(_oracle) == address(0)) revert ZeroAddress();
@@ -105,6 +107,7 @@ contract DataReceiver is IDataReceiver, Governable {
     if (_i == 0) revert ObservationsNotWritable();
   }
 
+  /// @inheritdoc IDataReceiver
   function whitelistAdapter(IBridgeReceiverAdapter _receiverAdapter, bool _isWhitelisted) external onlyGovernor {
     _whitelistAdapter(_receiverAdapter, _isWhitelisted);
   }

diff --git a/solidity/interfaces/IDataReceiver.sol b/solidity/interfaces/IDataReceiver.sol
@@ -61,6 +61,12 @@ interface IDataReceiver is IGovernable {
     uint24 _poolNonce
   ) external;
 
+  /// @notice Allows any address to attemt to insert cached observations
+  /// @param _poolSalt Identifier of the pool to fetch
+  /// @param _maxObservations Maximum number of observations to process
+  /// @dev Use _maxObservations = 0 to process all possible cached observations
+  function syncObservations(bytes32 _poolSalt, uint256 _maxObservations) external;
+
   /// @notice Allows governance to set an adapter whitelisted state
   /// @param _receiverAdapter Address of the adapter
   /// @param _isWhitelisted New whitelisting status