feat(afterDeadline): ensure it's clear the seat is not exitable by a user before the deadline #821
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…user before the deadline
There was a problem hiding this comment.
Should more detail about the afterDeadline offer be included? Example:
"The exit behavior of an afterDeadline offer before the deadline occurs is that it is in the waived state until the deadline occurs; note that it is not in the onDemand state until the deadline occurs."
0xpatrickdev
commented
Jan 8, 2024
| @@ -314,6 +314,7 @@ key:value pairs: | |||
| by its **timer** and **deadline** properties. | |||
| **timer** must be a timer, and **deadline** must be a [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) value interpreted with respect to the timer. | |||
| Some example timers use Unix epoch time, while others count block height. | |||
| The proposer cannot exit the seat before the deadline, but the contract can exit the seat early on their behalf. | |||
There was a problem hiding this comment.
Suggested change
| The proposer cannot exit the seat before the deadline, but the contract can exit the seat early on their behalf. | |
| The proposer cannot exit the seat before the deadline - the seat is in the `waived` state until the deadline occurs, but the contract can exit the seat early on the proposer's behalf. |
How is this @kbennett2000 ?
There was a problem hiding this comment.
Realizing the section this is proposing to edit is no longer there. Will update this to target the https://docs.agoric.com/reference/zoe-api/zoe.html#proposals section.
|
Closing in favor of #969 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The exit behavior of an
afterDeadlineoffer before the deadline occurs is not entirely clear in the documentation. The current behavior is that it is in thewaivedstate until the deadline occurs, but one could mistakenly think it is in theonDemandstate until the deadline occurs without explicit mention.This PR adds a sentence describing the full behavior to the Proposals and payments section. The second half is maybe not necessary, but this comment inspired me to include it.
It may also make sense to add this language or similar language to the other two places
afterDeadlineappears - Exit Rule in the glossary and the Zoe Guide.