From 2b28ec84c40de2dd1ab7cf26adf43cce0306fb70 Mon Sep 17 00:00:00 2001 From: Richard Gibson Date: Thu, 30 Nov 2023 21:54:18 -0500 Subject: [PATCH] chore: Apply suggestions from code review --- main/glossary/README.md | 4 ++-- main/guides/js-programming/far.md | 6 ++++-- main/reference/zoe-api/zcfmint.md | 17 ++++++++--------- 3 files changed, 14 insertions(+), 13 deletions(-) diff --git a/main/glossary/README.md b/main/glossary/README.md index 7712dc76c..573873f87 100644 --- a/main/glossary/README.md +++ b/main/glossary/README.md @@ -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 diff --git a/main/guides/js-programming/far.md b/main/guides/js-programming/far.md index b20157434..688cd8c7b 100644 --- a/main/guides/js-programming/far.md +++ b/main/guides/js-programming/far.md @@ -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: diff --git a/main/reference/zoe-api/zcfmint.md b/main/reference/zoe-api/zcfmint.md index 133bec9e8..9d0e73e61 100644 --- a/main/reference/zoe-api/zcfmint.md +++ b/main/reference/zoe-api/zcfmint.md @@ -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)**.