Skip to content

Commit

Permalink
chore: Apply suggestions from code review
Browse files Browse the repository at this point in the history
  • Loading branch information
gibson042 committed Dec 1, 2023
1 parent 95f4e80 commit 2b28ec8
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 13 deletions.
4 changes: 2 additions & 2 deletions main/glossary/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,8 +350,8 @@ Keys can be used as elements of CopySets and CopyBags and as keys of CopyMaps (s

## Keyword

A *Keyword* is a string that is an ASCII-only [identifier](https://developer.mozilla.org/en-US/docs/Glossary/Identifier)
and starts with an upper case letter.
A *Keyword* is a string that is an ASCII-only [identifier](https://developer.mozilla.org/en-US/docs/Glossary/Identifier),
starts with an upper case letter, and is not equal to "NaN" or "Infinity".
See **[Zoe Data Types](/reference/zoe-api/zoe-data-types.md#keyword)**.

## Mint
Expand Down
6 changes: 4 additions & 2 deletions main/guides/js-programming/far.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,8 +104,10 @@ this prevents malicious clients from playing tricks with cyclic data etc.
The `farName` parameter gives the `Remotable` an _interface name_ for debugging purposes, which only shows
up when logged through the `console`, for example with `console.log`.

The `objectWithMethods` parameter should be an object whose properties are the functions serving
as the object's methods.
The optional `objectWithMethods` parameter should be an object
whose properties are the functions serving as the object's methods.
It MUST NOT already be hardened or even frozen (though `Far()` will harden it before returning successfully).
If not provided, a new empty object will be used.

Before succeeding, the `Far()` function:

Expand Down
17 changes: 8 additions & 9 deletions main/reference/zoe-api/zcfmint.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,21 +17,20 @@ Returns an **IssuerRecord** containing the **[Issuer](/reference/ertp-api/issuer
- **zcfSeat**: **[ZCFSeat](./zcfseat.md)** - Optional.
- Returns: **ZCFSeat**

All **amounts** in *gains* must be of this **ZCFMint**'s **[Brand](/reference/ertp-api/brand.md)**.
The *gains*' **[Keywords](./zoe-data-types.md#keyword)** are in that **seat**'s namespace.
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.
All **amounts** in *gains* must be of this **ZCFMint**'s **[Brand](/reference/ertp-api/brand.md)**
and the *gains*' **[Keywords](./zoe-data-types.md#keyword)** should be defined by the contract instance in which *zcfSeat* is participating.
If *zcfSeat* is not provided, a new **seat** is used.
Mints the *gains* **Amount** of assets and adds them to *zcfSeat*'s **[Allocation](./zoe-data-types.md#allocation)**, then returns *zcfSeat*.

## aZCFMint.burnLosses(losses, zcfSeat)
- **losses**: **[AmountKeywordRecord](./zoe-data-types.md#keywordrecord)**
- **zcfSeat**: **[ZCFSeat](./zcfseat.md)**
- Returns: None

All **amounts** in *losses* must be of this **ZCFMint**'s **[Brand](/reference/ertp-api/brand.md)**.
The *losses*' **[Keywords](./zoe-data-types.md#keyword)** are in that **seat**'s namespace.
Subtract *losses* from that **seat**'s **[Allocation](./zoe-data-types.md#allocation)**, then
burn that **amount** of assets from the pooled **[Purse](/reference/ertp-api/purse.md)**.
All **amounts** in *losses* must be of this **ZCFMint**'s **[Brand](/reference/ertp-api/brand.md)**
and the *losses*' **[Keywords](./zoe-data-types.md#keyword)** must be defined by the contract instance in which *zcfSeat* is participating.
Subtracts *losses* from *zcfSeat*'s **[Allocation](./zoe-data-types.md#allocation)**, then
burns that **amount** of assets from the pooled **[Purse](/reference/ertp-api/purse.md)**.



0 comments on commit 2b28ec8

Please sign in to comment.