diff --git a/main/reference/zoe-api/price-authority.md b/main/reference/zoe-api/price-authority.md index 082eff604f..39cbc80389 100644 --- a/main/reference/zoe-api/price-authority.md +++ b/main/reference/zoe-api/price-authority.md @@ -218,3 +218,38 @@ const quote = E(PriceAuthority).mutableQuoteWhenLTE( AmountMath.make(brands.Out, 974n), ); ``` + +## MutableQuote + +A **MutableQuote** represents a statement from a **[PriceAuthority](./price-authority)** as to the +current price level at a particular time. The significant content (prices +and time) is packaged in the **[Amount](/reference/ertp-api/ertp-data-types#amount)**, and repeated +in the **[Payment](/reference/ertp-api/payment)** for veracity. + +**MutableQuotes** should be used when you expect to make multiple calls, replacing the trigger +value. If you just need a single quote, and won't change the trigger level, you should use +**PriceQuotes**. + +A **MutableQuote** is an **Amount**-**Payment** pair, where the **Amount** is also the current +balance of the **Payment**. + +## PriceQuote + +A **PriceQuote** represents a statement from a **[PriceAuthority](./price-authority)** as to the +current price level at a particular time. The significant content (prices +and time) is packaged in the **[Amount](/reference/ertp-api/ertp-data-types#amount)** and repeated +in the **[Payment](/reference/ertp-api/payment)** for veracity. +A **PriceQuote** is an **Amount**-**Payment** pair, where the **Amount** is also the current +balance of the **Payment**. + +```js +const { quoteAmount, quotePayment } = priceQuote; +``` + +**PriceQuotes** are returned in two forms: + +- **PriceDescription** + - Always includes **amountIn**, **amountOut**, the quote's **Timestamp**, + and the **TimerService** the **Timestamp** is relative to. +- **PriceDescription** wrapped as a **QuoteAuthority** issued payment. + - This lets quotes be shared in a format letting others verify the time and values. diff --git a/main/reference/zoe-api/zoe-data-types.md b/main/reference/zoe-api/zoe-data-types.md index f63526720d..d1ffba631e 100644 --- a/main/reference/zoe-api/zoe-data-types.md +++ b/main/reference/zoe-api/zoe-data-types.md @@ -87,45 +87,10 @@ const paymentKeywordRecord = { }; ``` -## MutableQuote - -A **MutableQuote** represents a statement from a **[PriceAuthority](./price-authority)** as to the -current price level at a particular time. The significant content (prices -and time) is packaged in the **[Amount](/reference/ertp-api/ertp-data-types#amount)**, and repeated -in the **[Payment](/reference/ertp-api/payment)** for veracity. - -**MutableQuotes** should be used when you expect to make multiple calls, replacing the trigger -value. If you just need a single quote, and won't change the trigger level, you should use -**PriceQuotes**. - -A **MutableQuote** is an **Amount**-**Payment** pair, where the **Amount** is also the current -balance of the **Payment**. - ## ParsableNumber A **ParsableNumber** is defined as a **bigint**, **number**, or **string**. -## PriceQuote - -A **PriceQuote** represents a statement from a **[PriceAuthority](./price-authority)** as to the -current price level at a particular time. The significant content (prices -and time) is packaged in the **[Amount](/reference/ertp-api/ertp-data-types#amount)** and repeated -in the **[Payment](/reference/ertp-api/payment)** for veracity. -A **PriceQuote** is an **Amount**-**Payment** pair, where the **Amount** is also the current -balance of the **Payment**. - -```js -const { quoteAmount, quotePayment } = priceQuote; -``` - -**PriceQuotes** are returned in two forms: - -- **PriceDescription** - - Always includes **amountIn**, **amountOut**, the quote's **Timestamp**, - and the **TimerService** the **Timestamp** is relative to. -- **PriceDescription** wrapped as a **QuoteAuthority** issued payment. - - This lets quotes be shared in a format letting others verify the time and values. - ## Ratio **Ratios** are pass-by-value records that consist of a