Skip to content

Commit

Permalink
fix: correct docs for proofValidPeriod
Browse files Browse the repository at this point in the history
  • Loading branch information
reednaa committed Mar 14, 2024
1 parent 4d5c6ca commit 0a6aedc
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/IncentivizedMessageEscrow.sol
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,9 @@ abstract contract IncentivizedMessageEscrow is IIncentivizedMessageEscrow, Bytes
/**
* @notice Returns the duration for which a proof is valid for.
* It may vary by destination.
* @dev Remember to add block.timestamp to the duration where proofs remain vaild for.
* The setting needs to be sane: Do not set the proofValidPeriod to more than ~1 years.
* @dev On checks, block.timestamp is added to the return of this function such that
* block.timestamp + _proofValidPeriod > deadline.
* Can be set to 0 which implies any is valid.
* @return timestamp The timestamp of when the application's message won't get delivered but rather acked back.
*/
function _proofValidPeriod(bytes32 destinationIdentifier) virtual internal view returns(uint64 timestamp);
Expand Down

0 comments on commit 0a6aedc

Please sign in to comment.