Skip to content

Commit

Permalink
chore: Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Mark S. Miller <[email protected]>
  • Loading branch information
gibson042 and erights authored Dec 1, 2023
1 parent 5544782 commit e0e0fd8
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions main/guides/zoe/proposal.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ To make an offer, you use [`E(zoe).offer(...)`](/reference/zoe-api/zoe.md#e-zoe-
## Invitations

An [Invitation](/reference/zoe-api/zoe-data-types.md#invitation) is a special case of ERTP [Payment](/reference/ertp-api/payment.md). Each is linked to a specific contract [Instance](/reference/zoe-api/zoe-data-types.md#instance), and
having one gives you the right to participate in that contract instance by making offers in it.
having one gives you the right to participate in that contract instance by making offers with it.

There are two main ways for contract users to get an invitation:
- If you create the contract instance, the contract might supply a special creator invitation.
Expand Down Expand Up @@ -52,7 +52,7 @@ In contrast, [Payments](/reference/ertp-api/payment.md) hold actual digital asse

**exit** specifies how the offer can be cancelled. It must conform to one of three shapes:
- `{ onDemand: null }`: (Default) The offering party can cancel on demand.
- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to promptly finish their offer.
- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to complete (finish or fail) their offer.
- `{ afterDeadline: deadlineDetails }`: The offer is automatically cancelled after a deadline,
as determined by its `timer` and `deadline` properties.

Expand Down
2 changes: 1 addition & 1 deletion main/reference/zoe-api/zcfmint.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Mint the *gains* **Amount** of assets and add them to
that **seat**'s **[Allocation](./zoe-data-types.md#allocation)**. If a **seat** is provided,
it is returned. Otherwise a new **seat** is returned.

## aZCFMint.burnLosses(losses, zcfSeat?)
## aZCFMint.burnLosses(losses, zcfSeat)
- **losses**: **[AmountKeywordRecord](./zoe-data-types.md#keywordrecord)**
- **zcfSeat**: **[ZCFSeat](./zcfseat.md)**
- Returns: None
Expand Down
4 changes: 2 additions & 2 deletions main/reference/zoe-api/zoe.md
Original file line number Diff line number Diff line change
Expand Up @@ -320,7 +320,7 @@ the Keywords might be "Asset" and "Bid".

**exit** specifies how the offer can be cancelled. It must conform to one of three shapes:
- `{ onDemand: null }`: (Default) The offering party can cancel on demand.
- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to promptly finish their offer.
- `{ waived: null }`: The offering party can't cancel and relies entirely on the smart contract to complete (finish or fail) their offer.
- `{ afterDeadline: deadlineDetails }`: The offer is automatically cancelled after a deadline,
as determined by its **timer** and **deadline** properties.
**timer** must be a timer, and **deadline** must be timestamp understood by it.
Expand All @@ -343,7 +343,7 @@ const paymentKeywordRecord = harden({
<a href="offerargs"></a>
### Offer Arguments

**offerArgs** is an object that can be used to pass additional arguments to the
**offerArgs** is an optional CopyRecord that can be used to pass additional arguments to the
**offerHandler** contract code associated with the invitation by
[`zcf.makeInvitation(...)`](./zoe-contract-facet.md#zcf-makeinvitation-offerhandler-description-customproperties-proposalshape).
Each contract can define the properties it supports and which are required.
Expand Down

0 comments on commit e0e0fd8

Please sign in to comment.