Skip to content

Commit 0a6aedc

Browse files
committed
fix: correct docs for proofValidPeriod
1 parent 4d5c6ca commit 0a6aedc

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/IncentivizedMessageEscrow.sol

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,9 @@ abstract contract IncentivizedMessageEscrow is IIncentivizedMessageEscrow, Bytes
9191
/**
9292
* @notice Returns the duration for which a proof is valid for.
9393
* It may vary by destination.
94-
* @dev Remember to add block.timestamp to the duration where proofs remain vaild for.
95-
* The setting needs to be sane: Do not set the proofValidPeriod to more than ~1 years.
94+
* @dev On checks, block.timestamp is added to the return of this function such that
95+
* block.timestamp + _proofValidPeriod > deadline.
96+
* Can be set to 0 which implies any is valid.
9697
* @return timestamp The timestamp of when the application's message won't get delivered but rather acked back.
9798
*/
9899
function _proofValidPeriod(bytes32 destinationIdentifier) virtual internal view returns(uint64 timestamp);

0 commit comments

Comments
 (0)