Merge pull request #48 from semiotic-ai/45-n-06-incorrect-documentation

docs: update docs to match code updates
semiotic-ai · Aug 17, 2023 · 9c145b4 · 9c145b4
2 parents 4d6884d + e567b02
commit 9c145b4
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 4 deletions.
diff --git a/src/AllocationIDTracker.sol b/src/AllocationIDTracker.sol
@@ -47,7 +47,7 @@ contract AllocationIDTracker {
      * @dev Marks an allocation ID as used.
      * @param sender The sender of the token to receiver.
      * @param allocationID The allocation ID to mark as used.
-     * @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, collateral contract address).
+     * @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, escrow contract address).
      * @notice REVERT with error:
      *               - AllocationIDPreviouslyClaimed: If the (sender, allocationID) pair was previously claimed
      *               - InvalidProof: If the proof is not valid
@@ -68,7 +68,7 @@ contract AllocationIDTracker {
 
     /**
      * @dev Verifies a proof.
-     * @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, collateral contract address).
+     * @param proof ECDSA Proof signed by the receiver's allocationID consisting of packed (sender address, allocationID, escrow contract address).
      * @param sender The sender of the token to receiver.
      * @param allocationID The allocation ID to verify.
      * @notice REVERT with error:

diff --git a/src/Escrow.sol b/src/Escrow.sol
@@ -26,12 +26,12 @@ contract Escrow {
     struct EscrowAccount {
         uint256 balance; // Total escrow balance for a sender-receiver pair
         uint256 amountThawing; // Amount of escrow currently being thawed
-        uint256 thawEndTimestamp; // Block number at which thawing period ends (zero if not thawing)
+        uint256 thawEndTimestamp; // Timestamp at which thawing period ends (zero if not thawing)
     }
 
     struct SenderAuthorization {
         address sender; // Sender the signer is authorized to sign for
-        uint256 thawEndTimestamp; // Block number at which thawing period ends (zero if not thawing)
+        uint256 thawEndTimestamp; // Timestamp at which thawing period ends (zero if not thawing)
     }
 
     // Stores how much escrow each sender has deposited for each receiver, as well as thawing information