Skip to content

Commit

Permalink
fixup! docs: revise partially from docs site
Browse files Browse the repository at this point in the history
  • Loading branch information
turadg committed Apr 2, 2024
1 parent 9708f2d commit cf3a82d
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions packages/zoe/src/zoeService/types.js
Original file line number Diff line number Diff line change
Expand Up @@ -220,15 +220,22 @@
* @property {(keyword: Keyword) => Promise<Payment<any>>} getPayout returns a
* promise for the Payment corresponding to the indicated keyword. The promise
* will resolve after the seat has exited.
* @property {() => Promise<OR>} getOfferResult
* @property {() => void} [tryExit] Note: Only works if the seat's `proposal`
* @property {() => Promise<OR>} getOfferResult Returns a Promise for an
* OfferResult. The OfferResult can be any Passable. For example, in the
* Automatic Refund example, it's the string "The offer was accepted". In the
* Covered Call example, it's a call option, which is an assayable Invitation to
* buy the underlying asset. Strings and invitations are the most common things
* returned. The value is the result returned by the offerHandler function
* passed in the first argument to zcf.makeInvitation(...).
* Since the contract can return whatever it wants as an offer result, there is no guarantee that the promise will resolve promptly.
* @property {() => void} tryExit Note: Only works if the seat's `proposal`
* has an `OnDemand` `exit` clause. Zoe's offer-safety guarantee applies no
* matter how a seat's interaction with a contract ends. Under normal
* circumstances, the participant might be able to call `tryExit()`, or the
* contract might do something explicitly. On exiting, the seat holder gets its
* current `allocation` and the `seat` can no longer interact with the contract.
* @property {() => Promise<boolean>} hasExited Returns true if the seat has
* exited, false if it is still active.
* exited, false if it is still active. Returns promptly.
* @property {() => Promise<0|1>} numWantsSatisfied Returns a Promise for a
* number which indicates the result of the exited Proposal, as described below:
*
Expand All @@ -240,7 +247,7 @@
* This is numeric to support a planned enhancement called "multiples" which
* will allow the return value to be any non-negative number.
* @property {() => Promise<Allocation>} getFinalAllocation return a promise for
* the final allocation. The promise will resolve after the seat has exited.
* the final allocation. The promise will be resolved promptly once the seat exits.
* @property {() => Subscriber<Completion>} getExitSubscriber returns a
* subscriber that will be notified when the seat has exited or failed.
*/
Expand Down

0 comments on commit cf3a82d

Please sign in to comment.