Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(zoe): describe afterDeadline functionality in more detail #969

Merged
merged 1 commit into from
Feb 29, 2024

Conversation

0xpatrickdev
Copy link
Member

The exit behavior of an afterDeadline offer before the deadline occurs is not entirely clear in the documentation. The current behavior is that it is in the waived state until the deadline occurs, but one could mistakenly think it is in the onDemand state until the deadline occurs without explicit mention.

Copy link
Member

@dckc dckc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I expect the outcome of Agoric/agoric-sdk#4291 to be that these API reference docs are generated from JSDoc in agoric-sdk.

But meanwhile, I suppose this doesn't hurt much.

A contract can enforce a certain proposal shape using the
**[M](https://endojs.github.io/endo/interfaces/_endo_patterns.PatternMatchers.html)** (for '**M**atcher') object from `@endo/patterns`.

For example, a contract holding an auction might require that all offers include an `afterDeadline` exit rule with a timestamp in the future.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Show the example? In particular: show / explain that zcf.makeInvitation() is the way to actually do it.

Copy link

cloudflare-workers-and-pages bot commented Feb 29, 2024

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: ba795c6
Status: ✅  Deploy successful!
Preview URL: https://6c6c37b5.documentation-7tp.pages.dev
Branch Preview URL: https://pc-zoe-offers-after-deadline.documentation-7tp.pages.dev

View logs

@0xpatrickdev 0xpatrickdev merged commit 8e7f38d into main Feb 29, 2024
4 checks passed
@0xpatrickdev 0xpatrickdev deleted the pc/zoe-offers-after-deadline branch February 29, 2024 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants