From 6179c246a2bba1fa9a20c34a86b5f63c2a7b0b12 Mon Sep 17 00:00:00 2001
From: itofarina <farinalvaro@gmail.com>
Date: Mon, 9 Oct 2023 17:46:45 -0300
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20escrow:=20add=20missing=20natspe?=
 =?UTF-8?q?c?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .changeset/chilled-insects-sneeze.md | 5 +++++
 contracts/periphery/EscrowedEXA.sol  | 9 ++++++---
 2 files changed, 11 insertions(+), 3 deletions(-)
 create mode 100644 .changeset/chilled-insects-sneeze.md

diff --git a/.changeset/chilled-insects-sneeze.md b/.changeset/chilled-insects-sneeze.md
new file mode 100644
index 000000000..3274253e9
--- /dev/null
+++ b/.changeset/chilled-insects-sneeze.md
@@ -0,0 +1,5 @@
+---
+"@exactly/protocol": patch
+---
+
+📝 escrow: add missing natspec
diff --git a/contracts/periphery/EscrowedEXA.sol b/contracts/periphery/EscrowedEXA.sol
index 8decd0a68..90dee6d13 100644
--- a/contracts/periphery/EscrowedEXA.sol
+++ b/contracts/periphery/EscrowedEXA.sol
@@ -62,7 +62,7 @@ contract EscrowedEXA is ERC20VotesUpgradeable, AccessControlUpgradeable {
   }
 
   /// @notice Mints esEXA for EXA.
-  /// @param amount Amount of EXA to mint.
+  /// @param amount Amount of esEXA to mint.
   /// @param to Address to send esEXA to.
   function mint(uint256 amount, address to) external {
     assert(amount != 0);
@@ -70,8 +70,8 @@ contract EscrowedEXA is ERC20VotesUpgradeable, AccessControlUpgradeable {
     _mint(to, amount);
   }
 
-  /// @notice Redeems esEXA for EXA.
-  /// @param amount Amount of esEXA to redeem.
+  /// @notice Redeems EXA for esEXA.
+  /// @param amount Amount of EXA to redeem.
   /// @param to Address to send EXA to.
   /// @dev Caller must have REDEEMER_ROLE.
   function redeem(uint256 amount, address to) external onlyRole(REDEEMER_ROLE) {
@@ -208,10 +208,12 @@ contract EscrowedEXA is ERC20VotesUpgradeable, AccessControlUpgradeable {
     emit ReserveRatioSet(reserveRatio_);
   }
 
+  /// @notice Returns the current timepoint of EXA, as per ERC-6372.
   function clock() public view override returns (uint48) {
     return exa.clock();
   }
 
+  /// @notice Returns the current clock mode of EXA, as per ERC-6372.
   // solhint-disable-next-line func-name-mixedcase
   function CLOCK_MODE() public view override returns (string memory) {
     return exa.CLOCK_MODE();
@@ -231,6 +233,7 @@ error Untransferable();
 error InvalidStream();
 error Disagreement();
 
+/// @dev https://github.com/sablier-labs/v2-core/blob/v1.0.0/src/interfaces/ISablierV2LockupLinear.sol
 interface ISablierV2LockupLinear {
   function cancel(uint256 streamId) external;