- Zoe {{$themeConfig.zoeVersion}}. Last updated
- {{$themeConfig.zoeDocsUpdated}}.
-
-
diff --git a/main/.vuepress/config.js b/main/.vuepress/config.js
deleted file mode 100644
index 01c9a094d..000000000
--- a/main/.vuepress/config.js
+++ /dev/null
@@ -1,378 +0,0 @@
-const nav = require('./themeConfig/nav');
-
-module.exports = {
- /* --- FOR DEPLOYMENT TO GITHUB PAGES--- */
- base: '/', // The base URL the site will be deployed at.
- /* --- HOME PAGE --- */
- title: 'Documentation', // title for the site. prefix for all page titles and displayed in the navbar
- description: 'Build, deploy and operate dApps and DeFi markets.', // desc for the site; rendered as a tag in the page HTML
- // Extra tags to inject into the page HTML . You can specify each tag in the form of [tagName, { attrName: attrValue }, innerHTML?].
- head: [
- [
- 'meta',
- { name: 'viewport', content: 'width=device-width, initial-scale=1' },
- ],
- ['link', { rel: 'icon', href: '/favicon-full.ico' }],
- [
- 'style',
- { type: 'text/css' },
- `
- .two-col-table td {
- width: 50%;
- }
- .two-col-table table {
- table-layout: fixed;
- }
- a[href^='#'] {
- font-style: italic;
- }`,
- ],
- [
- 'script',
- {
- src: 'https://www.googletagmanager.com/gtag/js?id=UA-118217811-1',
- async: '',
- },
- ],
- [
- 'script',
- {},
- "window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-118217811-1'); ",
- ],
- [
- 'script',
- {},
- `
- /** @type {Map<[...anySelectors: string[]], (elems: (Element | null)[]) => unknown>} */
- const fixups = new Map();
-
- // Update the "home" link to target agoric.com while intercepting clicks
- // such that those outside of its image continue routing to the root of
- // the documentation site.
- fixups.set(['.home-link', '.logo'], ([homeEl, logoEl]) => {
- if (homeEl) {
- homeEl.setAttribute('href', 'https://agoric.com');
- homeEl.setAttribute('onclick', 'return false;');
- }
- if (logoEl) {
- logoEl.setAttribute('onclick', "document.location='https://agoric.com';return false;");
- }
- });
-
- if (location.hash && location.hash !== '#') {
- // Once content has loaded, re-navigate to the page target
- // without triggering interfering router/history/scroll logic.
- const hash = location.hash;
- fixups.set(['main'], _elems => {
- const stopPropagation = evt => {
- evt.stopImmediatePropagation();
-
- const props = {};
- const proto = Object.getPrototypeOf(evt);
- const propSource = proto === Event.prototype ? {} : proto;
- for (const name of Object.getOwnPropertyNames(propSource)) {
- if (name !== 'constructor') props[name] = evt[name];
- }
- console.log('suppress', evt.type, { __proto__: evt, ...props });
- };
- const stopEvents = types => {
- const restorers = types.map(type => {
- window.addEventListener(type, stopPropagation, true);
- return () => window.removeEventListener(type, stopPropagation, true);
- });
- const passEvents = () => {
- // Run and drop references to all restore functions.
- while (restorers.length > 0) restorers.pop()();
- };
- return passEvents;
- };
-
- // Navigate to the page itself as a blank slate.
- const passStateEvents = stopEvents(['hashchange', 'popstate']);
- const passScrollEvents = stopEvents(['scroll']);
- location.replace('#');
-
- // Restore state-change events, then navigate back to the target.
- passStateEvents();
- try {
- const target = document.getElementById(decodeURIComponent(hash.slice(1)));
- if (target && target.innerHTML.trim() === '') {
- document.documentElement.classList.add('scrollingToTarget');
- target.scrollIntoView({ behavior: 'instant' });
- document.documentElement.classList.remove('scrollingToTarget');
- }
- } catch (err) {
- console.warn(err);
- }
- location.replace(hash);
-
- // Restore scroll events and create a new history entry to be overridden
- // if the initial target lacks a TOC entry to highlight.
- passScrollEvents();
- history.pushState(null, '', hash);
- });
- }
-
- // Poll until all fixups trigger by matching at least one element.
- const fixupInterval = setInterval(function() {
- for (const [selectors, fixup] of fixups) {
- const elems = selectors.map(sel => document.querySelector(sel));
- if (elems.some(el => el)) {
- // console.log('fixup', selectors);
- fixups.delete(selectors);
- Promise.resolve(elems).then(fixup);
- }
- }
- if (!fixups.size) {
- clearInterval(fixupInterval);
- // console.log('fixups are done');
- }
- }, 500);
- `,
- ],
- ],
-
- plugins: [
- 'check-md',
- [
- '@vuepress/last-updated',
- {
- dateOptions: {
- dateStyle: 'medium',
- timeStyle: 'long',
- timeZone: 'Etc/UTC',
- },
- },
- ],
- ],
-
- /* --- DEFAULT THEME CONFIG --- */
- themeConfig: {
- sidebarDepth: 1,
- lastUpdated: 'Last Updated',
- logo: '/logo.svg',
- /* --- NAVBAR (top) --- */
- nav,
- /* --- SIDEBAR --- */
- // This configuration displays different sidebars for different sections of
- // content. Pages must be organized into directories for each desired
- // section
-
- // NOTES:
- // Internal links: Must have a corresponding folder with a README.md file
- // Links must be absolute with trailing slash '/guide/'
- // Trailing slash implies it is looking for a .md file
- sidebar: {
- '/guides/': [
- {
- title: 'Getting Started',
- path: '/guides/getting-started/',
- collapsible: false,
- children: [
- '/guides/getting-started/',
- '/guides/getting-started/contract-rpc.html',
- '/guides/getting-started/deploying.html',
- ],
- },
- {
- title: 'Zoe',
- path: '/guides/zoe/',
- collapsible: false,
- children: [
- '/guides/zoe/contract-basics.html',
- '/guides/zoe/',
- '/guides/zoe/contract-upgrade.html',
- ],
- },
- {
- title: 'Agoric CLI',
- path: '/guides/agoric-cli/',
- collapsible: false,
- children: [
- '/guides/agoric-cli/',
- '/guides/agoric-cli/agd-query-tx.html',
- ],
- },
- {
- title: 'JavaScript Framework',
- path: '/guides/js-programming/',
- collapsible: false,
- children: [
- '/guides/js-programming/',
- '/guides/js-programming/hardened-js.html',
- '/guides/js-programming/eventual-send.html',
- '/guides/js-programming/far.html',
- '/guides/js-programming/notifiers.html',
- ],
- },
- {
- title: 'Wallet',
- path: '/guides/wallet/',
- collapsible: false,
- children: ['/guides/wallet/', '/guides/wallet/ui'],
- },
- {
- title: 'ERTP',
- path: '/guides/ertp/',
- collapsible: false,
- children: [
- '/guides/ertp/',
- '/guides/ertp/amounts.html',
- '/guides/ertp/amount-math.html',
- '/guides/ertp/issuers-and-mints.html',
- '/guides/ertp/purses-and-payments.html',
- ],
- },
- {
- title: 'Permissioned Contract Deployment',
- path: '/guides/coreeval/',
- collapsible: false,
- children: [
- '/guides/coreeval/',
- '/guides/coreeval/permissions.html',
- '/guides/coreeval/proposal.html',
- '/guides/coreeval/local-testnet.html',
- ],
- },
- {
- title: 'Example Zoe Contracts',
- path: '/guides/zoe/contracts/',
- collapsible: false,
- children: [
- '/guides/zoe/contracts/',
- '/guides/zoe/contracts/oracle.html',
- '/guides/zoe/contracts/vault.html',
- '/guides/zoe/contracts/loan.html',
- '/guides/zoe/contracts/fundedCallSpread.html',
- '/guides/zoe/contracts/pricedCallSpread.html',
- '/guides/zoe/contracts/covered-call.html',
- '/guides/zoe/contracts/otc-desk.html',
- '/guides/zoe/contracts/constantProductAMM.html',
- '/guides/zoe/contracts/sell-items.html',
- '/guides/zoe/contracts/atomic-swap.html',
- '/guides/zoe/contracts/barter-exchange.html',
- '/guides/zoe/contracts/second-price-auction.html',
- '/guides/zoe/contracts/simple-exchange.html',
- '/guides/zoe/contracts/escrow-to-vote.html',
- '/guides/zoe/contracts/mint-payments.html',
- '/guides/zoe/contracts/mint-and-sell-nfts.html',
- '/guides/zoe/contracts/use-obj-example.html',
- '/guides/zoe/contracts/automatic-refund.html',
- ],
- },
- {
- title: 'Deployed Zoe Contracts',
- path: '/guides/zoe/actual-contracts/',
- collapsible: false,
- children: [
- '/guides/zoe/actual-contracts/',
- '/guides/zoe/actual-contracts/PSM.html',
- ],
- },
- {
- title: 'Agoric Dapps',
- path: '/guides/dapps/',
- collapsible: false,
- children: [
- '/guides/dapps/',
- '/guides/dapps/dapp-templates.html',
- '/guides/dapps/starting-multiuser-dapps.html',
- '/guides/getting-started/deploying.html',
- '/guides/getting-started/contract-rpc.html',
- ],
- },
- {
- title: 'Agoric Platform',
- path: '/guides/platform/',
- collapsible: false,
- children: [],
- },
- {
- title: 'Chainlink Integration',
- path: '/guides/chainlink-integration.html',
- collapsible: false,
- children: [],
- },
- {
- title: 'SubQuery Indexing',
- path: '/guides/subquery-indexing.html',
- collapsible: false,
- children: [],
- },
- ],
- '/reference/': [
- {
- title: 'Wallet API',
- path: '/reference/wallet-api.html',
- collapsible: false,
- children: [],
- },
- {
- title: 'ERTP API',
- path: '/reference/ertp-api/',
- collapsible: false,
- children: [
- '/reference/ertp-api/',
- '/reference/ertp-api/issuer.html',
- '/reference/ertp-api/mint.html',
- '/reference/ertp-api/brand.html',
- '/reference/ertp-api/purse.html',
- '/reference/ertp-api/payment.html',
- '/reference/ertp-api/amount-math.html',
- '/reference/ertp-api/ertp-data-types.html',
- ],
- },
- {
- title: 'REPL API',
- path: '/reference/repl/',
- collapsible: false,
- children: [
- '/reference/repl/',
- '/reference/repl/timerServices.html',
- '/reference/repl/board.html',
- '/reference/repl/networking.html',
- '/reference/repl/priceAuthority.html',
- '/reference/repl/scratch.html',
- ],
- },
- {
- title: 'Zoe API',
- path: '/reference/zoe-api/',
- collapsible: false,
- children: [
- '/reference/zoe-api/',
- '/reference/zoe-api/zoe.html',
- '/reference/zoe-api/user-seat.html',
- '/reference/zoe-api/zoe-contract-facet.html',
- '/reference/zoe-api/zcfseat.html',
- '/reference/zoe-api/zcfmint.html',
- '/reference/zoe-api/price-authority.html',
- '/reference/zoe-api/zoe-helpers.html',
- '/reference/zoe-api/ratio-math.html',
- '/reference/zoe-api/zoe-data-types.html',
- ],
- },
- ],
- },
- docsRepo: 'Agoric/documentation',
- // if your docs are not at the root of the repo:
- docsDir: 'main',
- // if your docs are in a specific branch (defaults to 'master'):
- docsBranch: 'main',
- // defaults to false, set to true to enable
- editLinks: true,
- // custom text for edit link. Defaults to "Edit this page"
- editLinkText: 'Help us improve this page!',
-
- zoeVersion: 'v0.24.0',
- zoeDocsUpdated: 'August 25, 2022',
-
- /* --- SEARCH --- */
- // Comes with built-in search functionality which builds its index from the
- // h1, h2, and h3 headers
- // Disable search by uncommenting the following line:
- // search: false
- // Customize how many suggestions will be shown with:
- // searchMaxSuggestions:
-
-
-
-
-
-
-
-
-- Learn the basics of HardenedJS -
- It's JavaScript with the safety you expect - see why MetaMask uses it to safely run their Snaps technology for 30M+ customers. -- See the safety properties of our Zoe Framework -
- From Offer Safety to the POLA, the Zoe Framework protects devs (and users) while writing your smart contract logic. -
-
-
-
-
-
-
-
diff --git a/main/glossary/README.md b/main/glossary/index.md
similarity index 91%
rename from main/glossary/README.md
rename to main/glossary/index.md
index 34ed95bee..713c5f077 100644
--- a/main/glossary/README.md
+++ b/main/glossary/index.md
@@ -50,8 +50,8 @@ sword. They don't send you the actual 5 Quatloos; that only happens when there i
trade terms and they send you a payment, not an amount, of 5 Quatloos, the actual asset. Creating
a new `amount` does **not** create new assets.
-For more information, see the [ERTP documentation's Amounts section](/guides/ertp/amounts.md)
-and the [ERTP API's AmountMath section](/reference/ertp-api/amount-math.md).
+For more information, see the [ERTP documentation's Amounts section](/guides/ertp/amounts)
+and the [ERTP API's AmountMath section](/reference/ertp-api/amount-math).
## AmountMath
@@ -78,8 +78,8 @@ five tickets is performed by set union rather than by arithmetic.
of [Key](#key) values subject to the same constraints as
those of `AssetKind.COPY_SET` but allowed to be present more than once.
-For more information, see the [ERTP documentation's AmountMath section](/guides/ertp/amount-math.md)
-and the [ERTP API's AmountMath section](/reference/ertp-api/amount-math.md).
+For more information, see the [ERTP documentation's AmountMath section](/guides/ertp/amount-math)
+and the [ERTP API's AmountMath section](/reference/ertp-api/amount-math).
## AmountValue
@@ -88,9 +88,9 @@ An AmountValue is the part of an [Amount](#amount) that describes the value of s
that can be owned or shared: how much, how many, or a description of a unique asset, such as
$3, Pixel(3,2), or “Seat J12 for the show September 27th at 9:00pm”.
For a [fungible](#fungible) Amount, the AmountValue is usually a non-negative **BigInt** such as `10n` or `137n`.
-For a [non-fungible](#non-fungible) Amount, the AmountValue might be a [CopySet](/guides/js-programming/far.md#pass-styles-and-harden) containing strings naming particular rights or objects representing the rights directly.
+For a [non-fungible](#non-fungible) Amount, the AmountValue might be a [CopySet](/guides/js-programming/far#pass-styles-and-harden) containing strings naming particular rights or objects representing the rights directly.
-For more information, see the [ERTP documentation's AmountValue section](/guides/ertp/amounts.md#amountvalues).
+For more information, see the [ERTP documentation's AmountValue section](/guides/ertp/amounts#amountvalues).
## AssetHolder
@@ -99,9 +99,9 @@ digital assets in the quantity specified by an [amount](#amount).
## BigInt
-In [ERTP AmountMath](/guides/ertp/amount-math.md), we use the JavaScript [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) type for the `value` of fungible amounts in order to avoid overflow risks from using the usual JavaScript `Number` type.
+In [ERTP AmountMath](/guides/ertp/amount-math), we use the JavaScript [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) type for the `value` of fungible amounts in order to avoid overflow risks from using the usual JavaScript `Number` type.
-[Timer Services](/reference/repl/timerServices.md) also use `BigInt` for absolute and relative times.
+[Timer Services](/reference/repl/timerServices) also use `BigInt` for absolute and relative times.
`BigInt`s are written with an `n` suffix: `0n`, `1n`, `2n`, ... or created with `BigInt("123")`
or `BigInt(123)`.
@@ -122,8 +122,8 @@ appropriate for an object, do not use the board to communicate access to it.
Identifies the type of [issuer](#issuer), such as "[Quatloos](#quatloos)",
"[Moola](#moola)", etc. Brands are one of the two elements that
make up an [amount](#amount).
-For more information, see the [ERTP documentation's Brand section](/guides/ertp/amounts.md#brands)
-and the [ERTP API's Brand section](/reference/ertp-api/brand.md).
+For more information, see the [ERTP documentation's Brand section](/guides/ertp/amounts#brands)
+and the [ERTP API's Brand section](/reference/ertp-api/brand).
## Bundle
@@ -150,7 +150,7 @@ unzip bundle.zip
Destroy digital assets. Burning a [payment](#payment) additionally makes it
unavailable for later use. See
-[anIssuer.burn()](/reference/ertp-api/issuer.md#anissuer-burn-payment-optamount).
+[anIssuer.burn()](/reference/ertp-api/issuer#anissuer-burn-payment-optamount).
## Comparable
@@ -173,7 +173,7 @@ If they have ten houses for sale, they have ten different contract instances.
A [hardened](#harden) acyclic array in which each element is [passable](#passable), such as
`harden(['foo', 'bar'])`.
For more information, see the
-[Marshaling section in the JavaScript Distributed Programming Guide](/guides/js-programming/far.md#marshaling-by-copy-or-by-presence).
+[Marshaling section in the JavaScript Distributed Programming Guide](/guides/js-programming/far#marshaling-by-copy-or-by-presence).
## CopyRecord
@@ -181,11 +181,11 @@ A [hardened](#harden) acyclic plain object [dictionary](https://en.wikipedia.org
in which each key is a string and each value is [passable](#passable), such as
`harden({ keys: [0, 1], values: ['foo', 'bar'] })`.
For more information, see the
-[Marshaling section in the JavaScript Distributed Programming Guide](/guides/js-programming/far.md#marshaling-by-copy-or-by-presence).
+[Marshaling section in the JavaScript Distributed Programming Guide](/guides/js-programming/far#marshaling-by-copy-or-by-presence).
## Creator Invitation
-An [invitation](#invitation) optionally returned by [`E(zoe).startInstance(...)`](/reference/zoe-api/zoe.md#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs) that the contract instance
+An [invitation](#invitation) optionally returned by [`E(zoe).startInstance(...)`](/reference/zoe-api/zoe#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs) that the contract instance
creator can use. It is usually used in contracts where the creator immediately
sells something (auctions, swaps, etc.).
@@ -207,7 +207,7 @@ in another vat, machine, or blockchain. It takes as its argument either a local
or a [presence](#presence) for a remote object or a promise for a local or remote object, and
sends messages to the object using normal message-sending syntax. The local proxy forwards all messages to the remote object to deal with.
All `E()` calls return a promise for the eventual result. For more detail, see
-the [`E()` section in the Distributed JavaScript page](/guides/js-programming/eventual-send.md).
+the [`E()` section in the Distributed JavaScript page](/guides/js-programming/eventual-send).
## Endo
@@ -257,7 +257,7 @@ See [`E()`](#e) above.
## Exit Rule
An object specifying how an [offer](#offer) can be cancelled, such as on demand or by a deadline.
-For details, see [`E(zoe).offer(...)`](/reference/zoe-api/zoe.md#proposals).
+For details, see [`E(zoe).offer(...)`](/reference/zoe-api/zoe#proposals).
## Facet
@@ -312,7 +312,7 @@ For more details, see [What developers need to know about inter-blockchain commu
A [payment](#payment) whose amount represents (and is required for) participation in a contract instance.
Contracts often return a creator invitation on their instantiation, in case the contract instantiator wants
to immediately participate. Otherwise, the contract instance must create any additional invitations.
-Every [offer](#offer) to participate in a contract instance must include an invitation to that instance in the first argument to [`E(zoe).offer(...)`](/reference/zoe-api/zoe.md#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs), and any wallet receiving one will validate it via the [InvitationIssuer](#invitationissuer).
+Every [offer](#offer) to participate in a contract instance must include an invitation to that instance in the first argument to [`E(zoe).offer(...)`](/reference/zoe-api/zoe#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs), and any wallet receiving one will validate it via the [InvitationIssuer](#invitationissuer).
An invitation's [amount](#amount) includes the following properties:
- The contract's installation in Zoe, including access to its source code.
@@ -346,8 +346,8 @@ payments of their asset type (splitting, combining, burning, and exclusively cla
payments). An issuer from a trusted source can determine if an untrusted payment of
its asset type is valid.
-For more information, see the [ERTP documentation's Issuer section](/guides/ertp/issuers-and-mints.md)
-and the [ERTP API's Issuer section](/reference/ertp-api/issuer.md).
+For more information, see the [ERTP documentation's Issuer section](/guides/ertp/issuers-and-mints)
+and the [ERTP API's Issuer section](/reference/ertp-api/issuer).
## Key
@@ -363,7 +363,7 @@ Keys can be used as elements of CopySets and CopyBags and as keys of CopyMaps (s
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)**.
+See **[Zoe Data Types](/reference/zoe-api/zoe-data-types#keyword)**.
## Mint
@@ -386,9 +386,9 @@ They interact with Purses, Payments, Brands, and Issuers in the same ways.
ZCFMints and ERTP mints do **not** have the same methods. Do not try to use ERTP methods on a ZCFMint or vice versa.
However, issuers and brands associated with either an ERTP mint or a ZCFMint are the same concepts and have the same methods.
-For more information on ERTP mints, see the [ERTP documentation's Mint section](/guides/ertp/issuers-and-mints.md)
-and the [ERTP API's Mint section](/reference/ertp-api/mint.md). For more information about ZCFMints,
-see the [ZCF API `zcf.makeZCFMint()`](/reference/zoe-api/zoe-contract-facet.md#zcf-makezcfmint-keyword-assetkind-displayinfo).
+For more information on ERTP mints, see the [ERTP documentation's Mint section](/guides/ertp/issuers-and-mints)
+and the [ERTP API's Mint section](/reference/ertp-api/mint). For more information about ZCFMints,
+see the [ZCF API `zcf.makeZCFMint()`](/reference/zoe-api/zoe-contract-facet#zcf-makezcfmint-keyword-assetkind-displayinfo).
## Moola
@@ -405,7 +405,7 @@ as they are not interchangeable (and may have different prices). See also [fungi
## Notifier
A notifier provides a stream of updates describing changes to the state of an [offer](#offer) or other object.
-For more information, see [Notifiers and Subscriptions](/guides/js-programming/notifiers.md).
+For more information, see [Notifiers and Subscriptions](/guides/js-programming/notifiers).
## Object Capabilities
@@ -436,7 +436,7 @@ to the amount in the proposal they're willing to give. The payments are automati
according to the contract code. An offer gets a [payout](#payout) of some combination of what the party originally contributed
and what others have contributed. The specific payout is determined by the contract code.
-See [Offers](/guides/zoe/proposal.md).
+See [Offers](/guides/zoe/proposal).
## Offer Safety
@@ -455,15 +455,15 @@ Passables also include [CopyArrays](#copyarray) and [CopyRecords](#copyrecord),
recursively terminate in non-container passables.
For more information, see the
-[Marshaling section in the JavaScript Distributed Programming Guide](/guides/js-programming/far.md#marshaling-by-copy-or-by-presence).
+[Marshaling section in the JavaScript Distributed Programming Guide](/guides/js-programming/far#marshaling-by-copy-or-by-presence).
## Payment
Payments hold assets created by [mints](#mint), specifically assets intended for transfer
from one party to another. All assets of a payment are of the same [brand](#brand).
-For more information, see the [ERTP documentation's Payments section](/guides/ertp/purses-and-payments.md#payments)
-and the [ERTP API's Payments section](/reference/ertp-api/payment.md).
+For more information, see the [ERTP documentation's Payments section](/guides/ertp/purses-and-payments#payments)
+and the [ERTP API's Payments section](/reference/ertp-api/payment).
## Payout
@@ -503,15 +503,15 @@ const myProposal = harden({
```
`give` and `want` each associate [Keywords](#keyword) defined by the contract with corresponding [Amounts](#amount) describing respectively what will be given and what is being requested in exchange.
-See [Offers](/guides/zoe/proposal.md).
+See [Offers](/guides/zoe/proposal).
## Purse
A purse holds [amounts](#amount) of assets issued by a particular [mint](#mint) that are all of the same [brand](#brand), often for arbitrarily long periods of time.
When transfer is desired, a purse can move part of its held balance to a [payment](#payment).
-For more information, see the [ERTP documentation's Purses section](/guides/ertp/purses-and-payments.md#purses-and-payments) and the
-[ERTP API's Purses section](/reference/ertp-api/purse.md).
+For more information, see the [ERTP documentation's Purses section](/guides/ertp/purses-and-payments#purses-and-payments) and the
+[ERTP API's Purses section](/reference/ertp-api/purse).
## Quatloos
@@ -528,13 +528,13 @@ current allocation as a [payout](#payout).
Zoe uses a seat to represent an [offer](#offer) in progress, and has two seat [facets](#facet) representing
two views of the same seat; a `ZCFSeat` and a `UserSeat`. The `UserSeat` is returned to the user who made an
offer, and can check [payout](#payout) status or retrieve their results. The `ZCFSeat` is the argument passed to
-the `offerHandler` in the contract code. It is used within contracts and with [`zcf` methods](/reference/zoe-api/zoe-contract-facet.md).
+the `offerHandler` in the contract code. It is used within contracts and with [`zcf` methods](/reference/zoe-api/zoe-contract-facet).
The two seat facets have slightly different methods but represent the same seat and offer in progress.
The term comes from the expression "having a seat at the table" with regards to participating in a negotiation.
-For more details, see the [ZCFSeat documentation](/reference/zoe-api/zcfseat.md) and
-the [UserSeat documentation](/reference/zoe-api/user-seat.md).
+For more details, see the [ZCFSeat documentation](/reference/zoe-api/zcfseat) and
+the [UserSeat documentation](/reference/zoe-api/user-seat).
## Semi-fungible
@@ -556,7 +556,7 @@ An imaginary currency Agoric documentation uses in examples.
## Terms
-Contract instances have associated terms, gotten via [`E(zoe).getTerms(instance)`](/reference/zoe-api/zoe.md#e-zoe-getterms-instance),
+Contract instances have associated terms, gotten via [`E(zoe).getTerms(instance)`](/reference/zoe-api/zoe#e-zoe-getterms-instance),
which include the instance's associated [issuers](#issuer), [brands](#brand), and any custom terms. For
example, you might have a general auction contract. When someone instantiates it,
they provide terms applicable only to that instance. For some instances of
@@ -584,7 +584,7 @@ See the [Wallet Guide and API](/guides/wallet/).
*ZCF (Zoe Contract Facet)* is the [facet](#facet) of Zoe exposed to contract code. The Zoe
Contract Facet methods can be called synchronously by contract code.
-See the [ZCF API](/reference/zoe-api/zoe-contract-facet.md).
+See the [ZCF API](/reference/zoe-api/zoe-contract-facet).
## ZCFMint
@@ -593,8 +593,8 @@ See [Mint](#mint).
## Zoe Helpers
A set of API helper methods for writing contracts. These methods extract common contract code and
-patterns into reusable helpers. See the [Zoe Helpers API](/reference/zoe-api/zoe-helpers.md).
+patterns into reusable helpers. See the [Zoe Helpers API](/reference/zoe-api/zoe-helpers).
## Zoe Service
-A set of API methods for deploying and working with smart contracts. See [Zoe Service API](/reference/zoe-api/zoe.md).
+A set of API methods for deploying and working with smart contracts. See [Zoe Service API](/reference/zoe-api/zoe).
diff --git a/main/guides/agoric-cli/README.md b/main/guides/agoric-cli/index.md
similarity index 100%
rename from main/guides/agoric-cli/README.md
rename to main/guides/agoric-cli/index.md
diff --git a/main/guides/assets/README.md b/main/guides/assets/index.md
similarity index 100%
rename from main/guides/assets/README.md
rename to main/guides/assets/index.md
diff --git a/main/guides/chainlink-integration.md b/main/guides/chainlink-integration.md
index 1123bacc9..17ec863c0 100644
--- a/main/guides/chainlink-integration.md
+++ b/main/guides/chainlink-integration.md
@@ -8,7 +8,7 @@ actually on-chain.
Using Chainlink on Agoric provides two main features:
- Price feeds are exposed on Agoric via the on-chain `home.priceAuthority`. This is an
- officially-sponsored [price authority](/guides/zoe/price-authority.md) built
+ officially-sponsored [price authority](/guides/zoe/price-authority) built
from aggregating several Chainlink nodes.
- [Chainlink's Any API](https://docs.chain.link/docs/request-and-receive-data)
can initiate a job on a single oracle and return its results
@@ -21,7 +21,7 @@ software](https://github.com/Agoric/dapp-oracle/blob/HEAD/chainlink-agoric/READM
## Price Authority
To test your contract against a locally-simulated price authority, just follow
-the instructions in [the Price Authority API](/reference/zoe-api/price-authority.md).
+the instructions in [the Price Authority API](/reference/zoe-api/price-authority).
To use the curated on-chain price authority, see `home.priceAuthority`. For
example, to get a quote for selling `30 Testnet.$LINK` in `Testnet.$USD`:
@@ -40,7 +40,7 @@ const { quoteAmount: { value: [{ amountOut: usdAmount, timestamp }] } } = await
## Any API
To use Chainlink's Any API, you need to get an instance of the
-[Low-level Oracle Query Contract](/guides/zoe/contracts/oracle.md) and submit a
+[Low-level Oracle Query Contract](/guides/zoe/contracts/oracle) and submit a
query of the form:
```js
diff --git a/main/guides/coreeval/README.md b/main/guides/coreeval/index.md
similarity index 88%
rename from main/guides/coreeval/README.md
rename to main/guides/coreeval/index.md
index eaaf13a05..a39c64caf 100644
--- a/main/guides/coreeval/README.md
+++ b/main/guides/coreeval/index.md
@@ -9,6 +9,6 @@ if such a proposal passes, its JavaScript code is run with ocaps extracted using
To do try it out in a local testnet chain:
-1. [Declare the capabilities that the proposal will require](./permissions.md).
-2. [Code the proposal itself](./proposal.md).
-3. [Deploy the proposal to a local testnet](./local-testnet.md).
+1. [Declare the capabilities that the proposal will require](./permissions).
+2. [Code the proposal itself](./proposal).
+3. [Deploy the proposal to a local testnet](./local-testnet).
diff --git a/main/guides/coreeval/permissions.md b/main/guides/coreeval/permissions.md
index bc80e4593..55d41d75b 100644
--- a/main/guides/coreeval/permissions.md
+++ b/main/guides/coreeval/permissions.md
@@ -66,10 +66,10 @@ general interest to most contracts, while others are more specific to the PSM co
* **agoricNamesAdmin**: Grants write access to the Agoric name service. This permission is somewhat specific to the PSM contract.
* **bankManager**: Grants access to bank-related functionality within ERTP, allowing the contract to manipulate nearly all Cosmos assets in the chain. Because this capability is very powerful, this permission should only be granted to contracts that absolutely need it.
-* **board**: Grants write access to the [board name service](/guides/wallet/README.md#the-agoric-board).
+* **board**: Grants write access to the [board name service](/guides/wallet/index#the-agoric-board).
* **chainStorage**: Grants write access to the chain storage node, which is required when running `agd query` commands. Thus, most contracts will need access to this.
* **zoe**: When this permission is set, it grants access to the Zoe framework. All contracts will need access to this.
-* **feeMintAccess**: When this permission is set, the contract will be able to create digital assets. Only contracts that mint privileged Agoric digital assets (i.e., not the unprivileged **[zcf.makeZCFMint()](/reference/zoe-api/zoe-contract-facet.md#zcf-makezcfmint-keyword-assetkind-displayinfo)**) will need access to this.
+* **feeMintAccess**: When this permission is set, the contract will be able to create digital assets. Only contracts that mint privileged Agoric digital assets (i.e., not the unprivileged **[zcf.makeZCFMint()](/reference/zoe-api/zoe-contract-facet#zcf-makezcfmint-keyword-assetkind-displayinfo)**) will need access to this.
* **economicCommitteeCreatorFacet**, **econCharterKit**, **provisionPoolStartResult**: These 3 permissions are required by governed contracts.
* **chainTimerService**: When this permission is set, it grants access to the *chainTimerService*. All governed contracts need access to this so they know when a vote is complete.
@@ -89,8 +89,8 @@ Specifies what instances, if any, the contract produces or consumes.
## Issuer Section
-Specifies what **[Issuers](/reference/ertp-api/issuer.md)**, if any, the contract produces or consumes.
+Specifies what **[Issuers](/reference/ertp-api/issuer)**, if any, the contract produces or consumes.
## Brand Section
-Specifies what **[Brands](/reference/ertp-api/brand.md)**, if any, the contract produces or consumes.
\ No newline at end of file
+Specifies what **[Brands](/reference/ertp-api/brand)**, if any, the contract produces or consumes.
diff --git a/main/guides/coreeval/proposal.md b/main/guides/coreeval/proposal.md
index 059363b30..eaf59b2e0 100644
--- a/main/guides/coreeval/proposal.md
+++ b/main/guides/coreeval/proposal.md
@@ -4,7 +4,7 @@ You will need to write a proposal script that runs the contract, and possibly do
depending on your needs. (Usually these additional things will be dependent on a governance vote.) For
example, [gov-add-psm.js](https://github.com/Agoric/agoric-sdk/blob/master/packages/inter-protocol/test/psm/gov-add-psm.js)
is a proposal Agoric created for the PSM contract. It executes in an environment with globals such as
-**[E](../js-programming/eventual-send.md)** and **[Far](../js-programming/far.md#far-api)** provided.
+**[E](../js-programming/eventual-send)** and **[Far](../js-programming/far#far-api)** provided.
::: details Show example proposal
```jsx
diff --git a/main/guides/dapps/README.md b/main/guides/dapps/index.md
similarity index 100%
rename from main/guides/dapps/README.md
rename to main/guides/dapps/index.md
diff --git a/main/guides/ertp/amount-math.md b/main/guides/ertp/amount-math.md
index b0ef3fa0f..1d8514ab4 100644
--- a/main/guides/ertp/amount-math.md
+++ b/main/guides/ertp/amount-math.md
@@ -12,7 +12,7 @@ There are two `AssetKinds`, each of which implements the same methods. Which kin
for a particular `brand` depends on what was specified when the `brand` and
its `issuer` were created. They are:
- `AssetKind.NAT` ("nat"): Used with fungible assets. Values are natural numbers using the JavaScript [BigInt](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/BigInt) type to avoid overflow risks from using the usual JavaScript `Number` type.
-- `AssetKind.SET` ("set"): Used with non-fungible assets. Values are [copyArray](../js-programming/far.md#passstyleof-api)s such as hardened arrays of strings.
+- `AssetKind.SET` ("set"): Used with non-fungible assets. Values are [copyArray](../js-programming/far#passstyleof-api)s such as hardened arrays of strings.
## AmountMath Methods
The following is a brief description and example of each `AmountMath` method. For
@@ -24,66 +24,66 @@ optional. Where optional, use the `brand` you got from an issuer (or from Zoe)
to add verification that the `brand` of "amount" argument(s) corresponds with that `brand`.
- **Information Getting Methods**
- - [AmountMath.getValue(brand, amount)](/reference/ertp-api/amount-math.md#amountmath-getvalue-brand-amount)
+ - [AmountMath.getValue(brand, amount)](/reference/ertp-api/amount-math#amountmath-getvalue-brand-amount)
- Returns the `value` of the `amount` argument. For fungible assets, this will be a `BigInt`.
- - <<< @/snippets/ertp/guide/test-amount-math.js#getValue
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#getValue
- **Comparison Methods**
- - [AmountMath.isEmpty(amount, brand?)](/reference/ertp-api/amount-math.md#amountmath-isempty-amount-brand)
+ - [AmountMath.isEmpty(amount, brand?)](/reference/ertp-api/amount-math#amountmath-isempty-amount-brand)
- Returns `true` if its `amount` argument is empty, otherwise `false`.
Throws an error if the optional `brand` argument isn't the same as the `amount` argument brand.
- - <<< @/snippets/ertp/guide/test-amount-math.js#isEmpty
- - [AmountMath.isGTE(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math.md#amountmath-isgte-leftamount-rightamount-brand)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#isEmpty
+ - [AmountMath.isGTE(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math#amountmath-isgte-leftamount-rightamount-brand)
- Returns `true` if the `leftAmount` argument is greater than or equal
to the `rightAmount` argument, otherwise `false`.
Throws an error if the optional `brand` argument isn't the same as the `amount` arguments brands.
- - <<< @/snippets/ertp/guide/test-amount-math.js#isGTE
- - [AmountMath.isEqual(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math.md#amountmath-isequal-leftamount-rightamount-brand)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#isGTE
+ - [AmountMath.isEqual(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math#amountmath-isequal-leftamount-rightamount-brand)
- Returns `true` if the `leftAmount` argument equals the
`rightAmount` argument. Throws an error if the optional `brand` argument isn't the same as the `amount` arguments brands.
- - <<< @/snippets/ertp/guide/test-amount-math.js#isEqual
- - [AmountMath.coerce(brand, allegedAmount)](/reference/ertp-api/amount-math.md#amountmath-coerce-brand-allegedamount)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#isEqual
+ - [AmountMath.coerce(brand, allegedAmount)](/reference/ertp-api/amount-math#amountmath-coerce-brand-allegedamount)
- Takes an `amount` and returns it if it's a valid `amount`.
If invalid, it throws an error.
- - <<< @/snippets/ertp/guide/test-amount-math.js#coerce
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#coerce
- **Manipulator Methods**
- - [AmountMath.add(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math.md#amountmath-add-leftamount-rightamount-brand)
+ - [AmountMath.add(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math#amountmath-add-leftamount-rightamount-brand)
- Returns an `amount` that is the union of the `leftAmount` and `rightAmount`
`amount` arguments. For a fungible `amount`, this means add their
values. For a non-fungible `amount`, it usually means
including all elements from both `leftAmount` and `rightAmount`.
Throws an error if the optional `brand` argument isn't the same as the `amount` arguments brands.
- - <<< @/snippets/ertp/guide/test-amount-math.js#add
- - [AmountMath.subtract(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math.md#amountmath-subtract-leftamount-rightamount-brand)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#add
+ - [AmountMath.subtract(leftAmount, rightAmount, brand?)](/reference/ertp-api/amount-math#amountmath-subtract-leftamount-rightamount-brand)
- Returns a new `amount` that is the `leftAmount` argument minus
the `rightAmount` argument (i.e., for strings or objects
everything in `leftAmount` not in `rightAmount`). If `leftAmount`
doesn't include the contents of `rightAmount`, it throws an error.
It also throws an error if the optional `brand` argument isn't the
same as the `amount` arguments brands.
- - <<< @/snippets/ertp/guide/test-amount-math.js#subtract
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#subtract
- **Amount Creation Methods**
- - [AmountMath.make(brand, allegedValue)](/reference/ertp-api/amount-math.md#amountmath-make-brand-allegedvalue)
+ - [AmountMath.make(brand, allegedValue)](/reference/ertp-api/amount-math#amountmath-make-brand-allegedvalue)
- Takes a `value` argument and returns an `amount` by making a record
with the `value` and the `brand` associated with the `AmountMath`. The `value`
argument should be represented as a `BigInt` e.g. `10n` rather than `10`.
- - <<< @/snippets/ertp/guide/test-amount-math.js#make
- - [AmountMath.makeEmpty(brand, assetKind)](/reference/ertp-api/amount-math.md#amountmath-makeempty-brand-assetkind)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#make
+ - [AmountMath.makeEmpty(brand, assetKind)](/reference/ertp-api/amount-math#amountmath-makeempty-brand-assetkind)
- Returns an `amount` representing an empty `amount`, which is the identity
element for the `AmountMath` `add()` and `subtract()`
operations. Note that this value varies depending on the
`brand` and whether it is of kind `AssetKind.NAT` or `AssetKind.SET`.
- - <<< @/snippets/ertp/guide/test-amount-math.js#makeEmpty
- - [AmountMath.makeEmptyFromAmount(amount)](/reference/ertp-api/amount-math.md#amountmath-makeemptyfromamount-amount)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#makeEmpty
+ - [AmountMath.makeEmptyFromAmount(amount)](/reference/ertp-api/amount-math#amountmath-makeemptyfromamount-amount)
- Returns an `amount` representing an empty `amount`, using another `amount`
as the template for the new empty amount's `brand` and `assetKind`.
- - <<< @/snippets/ertp/guide/test-amount-math.js#makeEmptyFromAmount
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#makeEmptyFromAmount
## Methods On Other Objects
-These methods return an **[AssetKind](/reference/ertp-api/ertp-data-types.md#assetkind)**:
-- [anIssuer.getAssetKind()](/reference/ertp-api/issuer.md#anissuer-getassetkind)
+These methods return an **[AssetKind](/reference/ertp-api/ertp-data-types#assetkind)**:
+- [anIssuer.getAssetKind()](/reference/ertp-api/issuer#anissuer-getassetkind)
- Returns the `AssetKind` of the `issuer`'s `brand`. (`AssetKind.NAT` or `AssetKind.SET`).
- - <<< @/snippets/ertp/guide/test-amount-math.js#getAssetKind2
-- [zcf.getAssetKind(brand)](/reference/zoe-api/zoe-contract-facet.md#zcf-getassetkind-brand)
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#getAssetKind2
+- [zcf.getAssetKind(brand)](/reference/zoe-api/zoe-contract-facet#zcf-getassetkind-brand)
- Returns the `AssetKind` of the `brand` argument.
- - <<< @/snippets/ertp/guide/test-amount-math.js#zcfGetAssetKind
+ - <<< @/../snippets/ertp/guide/test-amount-math.js#zcfGetAssetKind
diff --git a/main/guides/ertp/amounts.md b/main/guides/ertp/amounts.md
index 07e9fd2eb..58b09c19d 100644
--- a/main/guides/ertp/amounts.md
+++ b/main/guides/ertp/amounts.md
@@ -5,7 +5,7 @@
An `amount` describes digital assets. There are no `amount` API methods,
-but [AmountMath](/reference/ertp-api/amount-math.md) methods take `amounts` as arguments
+but [AmountMath](/reference/ertp-api/amount-math) methods take `amounts` as arguments
to get information about and manipulate them.
`AmountMath.make()` is generally how you make new `amounts`.
@@ -13,7 +13,7 @@ However, you can also make an `amount` as an object literal by making a record o
a `brand` and a `value`. While `AmountMath.make()` is recommended for proper
object-oriented programming, this produces the same result:
-<<< @/snippets/ertp/guide/test-amounts.js#manualMake
+<<< @/../snippets/ertp/guide/test-amounts.js#manualMake
Each `amount` has two properties:
- **brand**: The type of digital asset, such as our imaginary `Quatloos` currency or,
in a game, a powerful magic sword with a brand of `Plus3Sword-ABCGames` or similar.
@@ -53,36 +53,36 @@ and example of each `brand` method. For more detail, click the method's name
to go to its entry in the [ERTP
API Reference](/reference/ertp-api/).
-- [aBrand.isMyIssuer()](/reference/ertp-api/brand.md#abrand-ismyissuer-allegedissuer)
+- [aBrand.isMyIssuer()](/reference/ertp-api/brand#abrand-ismyissuer-allegedissuer)
- Returns `true` if the `issuer` argument matches the `issuer` associated with the `brand`.
We have this method because the `issuer` is authoritative and the `brand` is not. You can
create a `payment`, `purse`, or `amount` with a `brand` that claims a particular `issuer`,
without that `issuer` having been involved. But if you use that `payment` or `purse`, it won't be
accepted by genuine ones. So to know, you have to verify with the `issuer` to see if it agrees.
- - <<< @/snippets/ertp/guide/test-amounts.js#isMyIssuer
-- [aBrand.getAllegedName()](/reference/ertp-api/brand.md#abrand-getallegedname)
+ - <<< @/../snippets/ertp/guide/test-amounts.js#isMyIssuer
+- [aBrand.getAllegedName()](/reference/ertp-api/brand#abrand-getallegedname)
- Returns the `brand`'s alleged name, but should not be trusted as accurate.
- - <<< @/snippets/ertp/guide/test-amounts.js#getAllegedName
-- [aBrand.getDisplayInfo()](/reference/ertp-api/brand.md#abrand-getdisplayinfo)
+ - <<< @/../snippets/ertp/guide/test-amounts.js#getAllegedName
+- [aBrand.getDisplayInfo()](/reference/ertp-api/brand#abrand-getdisplayinfo)
- Returns the `DisplayInfo` associated with the `brand`. The `DisplayInfo`
tells the UI how to correctly display `values` associated with the `brand`.
- - <<< @/snippets/ertp/guide/test-amounts.js#getDisplayInfo
+ - <<< @/../snippets/ertp/guide/test-amounts.js#getDisplayInfo
The following methods on other ERTP components also either operate on or
return a `brand`.
-- [anIssuer.getBrand()](/reference/ertp-api/issuer.md#anissuer-getbrand)
+- [anIssuer.getBrand()](/reference/ertp-api/issuer#anissuer-getbrand)
- Returns the `brand` for the `issuer`. The `brand` is not closely
held, so this should not be trusted to identify an `issuer`
alone. Fake digital assets and `amount`s can use the `brand` of another `issuer`.
- - <<< @/snippets/ertp/guide/test-amounts.js#getBrand
-- [aPayment.getAllegedBrand()](/reference/ertp-api/payment.md#apayment-getallegedbrand)
+ - <<< @/../snippets/ertp/guide/test-amounts.js#getBrand
+- [aPayment.getAllegedBrand()](/reference/ertp-api/payment#apayment-getallegedbrand)
- Return the `payment`'s alleged `brand`. Because a `payment`
is not trusted, this should be treated with suspicion and verified
elsewhere. This example code determines if a `payment` we got from untrusted sources
is valid. It uses the `brand` to find a `purse` we want to deposit it in, then verifies
that it's genuine.
- - <<< @/snippets/ertp/guide/test-amounts.js#depositSomewhere
+ - <<< @/../snippets/ertp/guide/test-amounts.js#depositSomewhere
## AmountValues
@@ -96,10 +96,10 @@ not `Number`s. Write `10n` rather than `10`.
There are no `value`
methods, but two `AmountMath` methods use or return them.
-- [AmountMath.getValue(brand, amount)](/reference/ertp-api/amount-math.md#amountmath-getvalue-brand-amount)
+- [AmountMath.getValue(brand, amount)](/reference/ertp-api/amount-math#amountmath-getvalue-brand-amount)
- Return the `amount` argument's `value`
- - <<< @/snippets/ertp/guide/test-amounts.js#getValue
-- [AmountMath.make(brand, allegedValue)](/reference/ertp-api/amount-math.md#amountmath-make-brand-allegedvalue)
+ - <<< @/../snippets/ertp/guide/test-amounts.js#getValue
+- [AmountMath.make(brand, allegedValue)](/reference/ertp-api/amount-math#amountmath-make-brand-allegedvalue)
- Make an `amount`from a `brand` and a `value`.
- - <<< @/snippets/ertp/guide/test-amounts.js#make
+ - <<< @/../snippets/ertp/guide/test-amounts.js#make
diff --git a/main/guides/ertp/README.md b/main/guides/ertp/index.md
similarity index 92%
rename from main/guides/ertp/README.md
rename to main/guides/ertp/index.md
index ec28bf280..4caa95472 100644
--- a/main/guides/ertp/README.md
+++ b/main/guides/ertp/index.md
@@ -38,10 +38,10 @@ and Balcony sections, where a holder may sit in any seat of the respective secti
### Amount
-Assets are described by **[Amount](./amounts.md)** records consisting of a `brand` and a `value`.
-- **[Brand](./amounts.md#brands)**: An asset's type.
+Assets are described by **[Amount](./amounts)** records consisting of a `brand` and a `value`.
+- **[Brand](./amounts#brands)**: An asset's type.
You can think of this as the answer to the question "What is it?" about an asset.
-- **[AmountValue](./amounts.md#amountvalues)**: An asset's size.
+- **[AmountValue](./amounts#amountvalues)**: An asset's size.
You can think of this as the answer to the questions "how many?" or "how much?" about an asset.
**Important**: Amounts are *descriptions* of digital assets, not the actual assets. They have no
@@ -53,19 +53,19 @@ whose values have to be non-negative integers represented as BigInts (thus the a
### AmountMath
-ERTP uses the **[AmountMath](./amount-math.md)** library for operations such as adding, subtracting,
+ERTP uses the **[AmountMath](./amount-math)** library for operations such as adding, subtracting,
and comparing amount values (such as when depositing to or withdrawing assets from a purse).
### Brand
Most ERTP objects have a permanent constraint to working with or on one specific
-**[Brand](./amounts.md#brands)** established at their creation. If one is
+**[Brand](./amounts#brands)** established at their creation. If one is
initially associated with Quatloos, it always associated with Quatloos and Quatloos only.
In particular, a `brand` and its `mint` and its `issuer` are all in unchangeable respective
one-to-one relationships with each other.
-- **[Mint](./issuers-and-mints.md#mints)**:
+- **[Mint](./issuers-and-mints#mints)**:
The unique creator of digital assets of a particular `brand`.
-- **[Issuer](./issuers-and-mints.md#issuers)**:
+- **[Issuer](./issuers-and-mints#issuers)**:
The source of truth of how many digital assets each `purse` and `payment` holds. An `issuer`
is used to validate `payments` received from untrusted parties for the `brand` with which
it is associated.
@@ -82,9 +82,9 @@ Let's look at an example. Suppose there is the "Quatloos" `brand`. That means th
### Purses and Payments
We've already mentioned our final two concepts:
-- **[Purse](./purses-and-payments.md#purses)**: An
+- **[Purse](./purses-and-payments#purses)**: An
object for holding digital assets of a specific `brand`.
-- **[Payment](./purses-and-payments.md#payments)**:
+- **[Payment](./purses-and-payments#payments)**:
An object for transferring digital assets of a specific `brand` to another party.
Similar to other component instances, a `purse` and a `payment` only work with one
@@ -119,7 +119,7 @@ are covered on the component-specific pages.
-<<< @/snippets/ertp/guide/test-readme.js#makeIssuerKit
+<<< @/../snippets/ertp/guide/test-readme.js#makeIssuerKit
First, you pass a string naming a new `brand` to
`makeIssuerKit()`. As noted above, a `make
-<<< @/snippets/ertp/guide/test-readme.js#depositFacet
+<<< @/../snippets/ertp/guide/test-readme.js#depositFacet
@@ -189,7 +189,7 @@ of your friend's accounts or find out how much is in them.
-<<< @/snippets/ertp/guide/test-readme.js#getId
+<<< @/../snippets/ertp/guide/test-readme.js#getId
@@ -201,7 +201,7 @@ others can get the value just by knowing the Id. Alice can make her Id(s) known
communication method she likes; private email, an email blast to a mailing list or many individuals,
buying an ad on a website, tv program, or newspaper, listing it on her website, etc.
-<<< @/snippets/ertp/guide/test-readme.js#getValue
+<<< @/../snippets/ertp/guide/test-readme.js#getValue
Remember, ERTP's use of OCaps requires that you have access to an object in order
to run methods on it. So someone who wants to use Alice's deposit facet
@@ -217,7 +217,7 @@ in it, and the 5 Quatloos `payment` consumed when the transfer happened.
The `E()` notation is a local "bridge" that lets you invoke methods on remote objects.
It takes a local representative (a [presence](../../glossary/#presence)) for a remote object
as an argument and sends messages to the remote object. This is explained in more detail at the
-[`E()` section in the Distributed JavaScript page](../js-programming/eventual-send.md).
+[`E()` section in the Distributed JavaScript page](../js-programming/eventual-send).
## Creating and Using Non-Fungible Assets
@@ -231,14 +231,14 @@ An object representing a valid ticket has the properties:
- `show`: A string describing the show.
- `start`: A string representing a [time/date in ISO format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString).
-<<< @/snippets/ertp/guide/test-readme.js#ticketValues
+<<< @/../snippets/ertp/guide/test-readme.js#ticketValues
To create tickets, you first create JavaScript objects that each represent a ticket.
Then, because you need to specify the amount of digital assets to be minted,
you can use `AmountMath` to make an amount. In this case, you're making tickets
for one performance of *Hamilton*.
-<<< @/snippets/ertp/guide/test-readme.js#makeTicketIssuer
+<<< @/../snippets/ertp/guide/test-readme.js#makeTicketIssuer
As before, you use `makeIssuerKit()` to create a `mint` that can create Agoric Theatre ticket assets.
The difference from when you created a fungible asset is that you have to use a second argument,
@@ -248,7 +248,7 @@ There are two `AssetKinds`. Each one polymorphically implements the same set of
- `AssetKind.NAT`: Works with natural number `values` and fungible assets. Default value for `makeIssuerKit()`.
- `AssetKind.SET`: Used with non-fungible assets, operates on an array of records (objects) with keys and values.
-<<< @/snippets/ertp/guide/test-readme.js#ticketPayments
+<<< @/../snippets/ertp/guide/test-readme.js#ticketPayments
First you define an `amount` description for each ticket you want to issue.
diff --git a/main/guides/ertp/issuers-and-mints.md b/main/guides/ertp/issuers-and-mints.md
index a68b543f8..13e28d6f6 100644
--- a/main/guides/ertp/issuers-and-mints.md
+++ b/main/guides/ertp/issuers-and-mints.md
@@ -37,46 +37,46 @@ more detail, click the method's name to go to its entry in the [ERTP
API Reference](/reference/ertp-api/).
- **Create issuer operation**
- - [makeIssuerKit()](/reference/ertp-api/issuer.md#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)
+ - [makeIssuerKit()](/reference/ertp-api/issuer#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)
- Create and return a new `issuer` and its associated `mint` and `brand`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#import
- <<< @/snippets/ertp/guide/test-issuers-and-mints.js#makeIssuerKit
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#import
+ <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#makeIssuerKit
- **Get information about the issuer operations**
- - [anIssuer.getAllegedName()](/reference/ertp-api/issuer.md#anissuer-getallegedname)
+ - [anIssuer.getAllegedName()](/reference/ertp-api/issuer#anissuer-getallegedname)
- Return the `allegedName` for the `issuer` (the non-trusted human-readable name of its associated `brand`).
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#getAllegedName
- - [anIssuer.getAssetKind()](/reference/ertp-api/issuer.md#anissuer-getassetkind)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#getAllegedName
+ - [anIssuer.getAssetKind()](/reference/ertp-api/issuer#anissuer-getassetkind)
- Return the kind of the `issuer`'s asset; either `AssetKind.NAT` ("nat") or `AssetKind.SET` ("set").
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#getAssetKind
- - [anIssuer.getBrand()](/reference/ertp-api/issuer.md#anissuer-getbrand)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#getAssetKind
+ - [anIssuer.getBrand()](/reference/ertp-api/issuer#anissuer-getbrand)
- Return the `brand` for the `issuer`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#getBrand
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#getBrand
- **Purse operation**
- - [anIssuer.makeEmptyPurse()](/reference/ertp-api/issuer.md#anissuer-makeemptypurse)
+ - [anIssuer.makeEmptyPurse()](/reference/ertp-api/issuer#anissuer-makeemptypurse)
- Make and return an empty `purse` for holding assets of the `brand` associated with the `issuer`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#makeEmptyPurse
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#makeEmptyPurse
- **Payment operations**
- - [anIssuer.burn(payment, optAmount)](/reference/ertp-api/issuer.md#anissuer-burn-payment-optamount)
+ - [anIssuer.burn(payment, optAmount)](/reference/ertp-api/issuer#anissuer-burn-payment-optamount)
- Destroy all of the digital assets in the `payment`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#burn
- - [anIssuer.claim(payment, optAmount)](/reference/ertp-api/issuer.md#anissuer-claim-payment-optamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#burn
+ - [anIssuer.claim(payment, optAmount)](/reference/ertp-api/issuer#anissuer-claim-payment-optamount)
- Transfer all digital assets from `payment` to a new Payment.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#claim
- - [anIssuer.combine(paymentsArray)](/reference/ertp-api/issuer.md#anissuer-combine-paymentsarray-opttotalamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#claim
+ - [anIssuer.combine(paymentsArray)](/reference/ertp-api/issuer#anissuer-combine-paymentsarray-opttotalamount)
- Combine multiple Payments into one new Payment.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#combine
- - [anIssuer.getAmountOf(payment)](/reference/ertp-api/issuer.md#anissuer-getamountof-payment)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#combine
+ - [anIssuer.getAmountOf(payment)](/reference/ertp-api/issuer#anissuer-getamountof-payment)
- Describe the `payment`'s balance as an Amount.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#getAmountOf
- - [anIssuer.isLive(payment)](/reference/ertp-api/issuer.md#anissuer-islive-payment)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#getAmountOf
+ - [anIssuer.isLive(payment)](/reference/ertp-api/issuer#anissuer-islive-payment)
- Return `true` if the `payment` was created by the issuer and is available for use (has not been consumed or burned).
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#isLive
- - [anIssuer.split(payment, paymentAmountA)](/reference/ertp-api/issuer.md#anissuer-split-payment-paymentamounta)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#isLive
+ - [anIssuer.split(payment, paymentAmountA)](/reference/ertp-api/issuer#anissuer-split-payment-paymentamounta)
- Split a single `payment` into two new Payments.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#split
- - [anIssuer.splitMany(payment, paymentAmountArray)](/reference/ertp-api/issuer.md#anissuer-splitmany-payment-amountarray)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#split
+ - [anIssuer.splitMany(payment, paymentAmountArray)](/reference/ertp-api/issuer#anissuer-splitmany-payment-amountarray)
- Split a single `payment` into multiple Payments.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#splitMany
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#splitMany
**Related Methods:**
@@ -85,12 +85,12 @@ API Reference](/reference/ertp-api/).
A `mint`, `brand`, or `purse` is actually associated with an `issuer` only if
the `issuer` itself acknowledges the association.
-- [aMint.getIssuer()](/reference/ertp-api/mint.md#amint-getissuer)
+- [aMint.getIssuer()](/reference/ertp-api/mint#amint-getissuer)
- Return the `issuer` uniquely associated with the `mint`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#mintGetIssuer
-- [aBrand.isMyIssuer(issuer)](/reference/ertp-api/brand.md#abrand-ismyissuer-allegedissuer)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#mintGetIssuer
+- [aBrand.isMyIssuer(issuer)](/reference/ertp-api/brand#abrand-ismyissuer-allegedissuer)
- Return `true` if `issuer` is the brand's `issuer`, `false` if not.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#isMyIssuer
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#isMyIssuer
## Mints
@@ -114,14 +114,14 @@ the one Quatloos `mint` can create new Quatloos.
So a Quatloos `mint` can never become a Moola `mint`, or any other non-Quatloos asset.
There are two `mint` methods, and the method that creates new mints. Click the method's name to go to its entry in the [ERTP
-API Reference](/ertp/api/).
-- [aMint.getIssuer()](/reference/ertp-api/mint.md#amint-getissuer)
+API Reference](/reference/ertp-api/index).
+- [aMint.getIssuer()](/reference/ertp-api/mint#amint-getissuer)
- Return the `issuer` uniquely associated with the `mint`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#mintGetIssuer
-- [aMint.mintPayment()](/reference/ertp-api/mint.md#amint-mintpayment-newamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#mintGetIssuer
+- [aMint.mintPayment()](/reference/ertp-api/mint#amint-mintpayment-newamount)
- Create new digital assets of the `mint`'s associated `brand`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#mintMintPayment
-- [makeIssuerKit()](/reference/ertp-api/issuer.md#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#mintMintPayment
+- [makeIssuerKit()](/reference/ertp-api/issuer#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)
- Create and return a new `issuer` and its associated `mint` and `brand`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#makeIssuerKitMint
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#makeIssuerKitMint
diff --git a/main/guides/ertp/purses-and-payments.md b/main/guides/ertp/purses-and-payments.md
index ed5499e3e..c44f1bde0 100644
--- a/main/guides/ertp/purses-and-payments.md
+++ b/main/guides/ertp/purses-and-payments.md
@@ -21,7 +21,7 @@ of any particular `brand`. Neither a `purse` nor a `payment` can ever change the
associated `brand`.
Each `purse` and `payment` object contains a specific amount of digital assets,
-which may be none at all ("empty" in [AmountMath](./amount-math.md) terms). In the same way
+which may be none at all ("empty" in [AmountMath](./amount-math) terms). In the same way
you might have separate bank accounts for different purposes,
you can have separate purses for the same `brand` of digital asset.
One of your purses might hold 2 Quatloos while another holds 9000 Quatloos.
@@ -31,8 +31,8 @@ whatever assets already exist there. So a 3 Quatloos deposit
into a `purse` with 8 Quatloos results in a `purse` with 11 Quatloos.
When adding a `payment` to a `purse`, you must add the entire `payment`. To
-only add part of a `payment`, you must first call [anIssuer.split()](/reference/ertp-api/issuer.md#anissuer-split-payment-paymentamounta)
-or [anIssuer.splitMany()](/reference/ertp-api/issuer.md#anissuer-splitmany-payment-amountarray)
+only add part of a `payment`, you must first call [anIssuer.split()](/reference/ertp-api/issuer#anissuer-split-payment-paymentamounta)
+or [anIssuer.splitMany()](/reference/ertp-api/issuer#anissuer-splitmany-payment-amountarray)
to split it into two or more new `payments`.
`mints` create entirely new digital assets and put them in a new `payment`.
@@ -43,7 +43,7 @@ the `brand` of the new `payment` is the same as the associated `brand` of its or
In ERTP, assets are not transferred directly from one `purse` to another.
Instead, the transfer must be mediated by a `payment` as demonstrated below.
In the Agoric stack, the actual send and receive operations are provided by
-[`E()`](../js-programming/eventual-send.md).
+[`E()`](../js-programming/eventual-send).
- Sender:
1. Withdraw assets described by an `amount` from a `purse`, creating a `payment`.
2. Send this `payment` to a recipient.
@@ -82,25 +82,25 @@ to a party, you should tell them what `brand` it accepts.
The following is a brief description and example of each `purse` method. For
more detail, click the method's name to go to its entry in the [ERTP
API Reference](/reference/ertp-api/).
-- [aPurse.getCurrentAmount()](/reference/ertp-api/purse.md#apurse-getcurrentamount)
+- [aPurse.getCurrentAmount()](/reference/ertp-api/purse#apurse-getcurrentamount)
- Describe the `purse`'s current balance as an Amount. Note that a `purse` can be empty.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#getCurrentAmount
-- [aPurse.withdraw(amount)](/reference/ertp-api/purse.md#apurse-withdraw-amount)
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#getCurrentAmount
+- [aPurse.withdraw(amount)](/reference/ertp-api/purse#apurse-withdraw-amount)
- Withdraw the `amount` of specified digital assets from this `purse` into a new `payment`.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#withdraw
-- [aPurse.deposit(payment, optAmount)](/reference/ertp-api/purse.md#apurse-deposit-payment-optamount)
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#withdraw
+- [aPurse.deposit(payment, optAmount)](/reference/ertp-api/purse#apurse-deposit-payment-optamount)
- Deposit all the contents of `payment` into this `purse`, returning an `amount` describing the
`payment`.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#deposit
-- [aPurse.getDepositFacet()](/reference/ertp-api/purse.md#apurse-getdepositfacet)
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#deposit
+- [aPurse.getDepositFacet()](/reference/ertp-api/purse#apurse-getdepositfacet)
- Return a deposit-only facet on the `purse`. Note that the command to add a `payment`'s
assets via a `DepositFacet` is not `deposit()` but `receive()` as shown here.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#getDepositFacet
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#getDepositFacet
In addition, the method to create a new, empty, `purse` is called on an `issuer`:
-- [anIssuer.makeEmptyPurse()](/reference/ertp-api/issuer.md#anissuer-makeemptypurse)
+- [anIssuer.makeEmptyPurse()](/reference/ertp-api/issuer#anissuer-makeemptypurse)
- Make and return an empty `purse` that holds assets of the `brand` associated with the `issuer`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#makeEmptyPurse
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#makeEmptyPurse
## Payments
@@ -141,8 +141,8 @@ To consume a `payment` into a new `purse`:
have `payments` as arguments and effectively operate on a `payment`. The following is a
brief description and example of each `payment`-related method. For
more detail, click the method's name to go to its entry in the [ERTP
-API Reference](/ertp/api/).
-- [aPayment.getAllegedBrand()](/reference/ertp-api/payment.md#apayment-getallegedbrand)
+API Reference](/reference/ertp-api/index).
+- [aPayment.getAllegedBrand()](/reference/ertp-api/payment#apayment-getallegedbrand)
- Return the `brand` indicating the kind of digital asset this `payment` purports to be
and which `issuer` to use with it.
Because `payments` are not trusted, any method calls on them should be treated
@@ -150,38 +150,38 @@ API Reference](/ertp/api/).
### Other Objects' Payment-Related Methods
-- [anIssuer.burn(payment, optAmount)](/reference/ertp-api/issuer.md#anissuer-burn-payment-optamount)
+- [anIssuer.burn(payment, optAmount)](/reference/ertp-api/issuer#anissuer-burn-payment-optamount)
- Destroy all of the digital assets in the `payment`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#burn
-- [anIissuer.claim(payment, optAmount)](/reference/ertp-api/issuer.md#anissuer-claim-payment-optamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#burn
+- [anIissuer.claim(payment, optAmount)](/reference/ertp-api/issuer#anissuer-claim-payment-optamount)
- Transfer all digital assets from `payment` to a new Payment.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#claim
-- [anIssuer.combine(paymentsArray)](/reference/ertp-api/issuer.md#anissuer-combine-paymentsarray-opttotalamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#claim
+- [anIssuer.combine(paymentsArray)](/reference/ertp-api/issuer#anissuer-combine-paymentsarray-opttotalamount)
- Combine multiple Payments into one new Payment.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#combine
-- [anIssuer.getAmountOf(payment)](/reference/ertp-api/issuer.md#anissuer-getamountof-payment)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#combine
+- [anIssuer.getAmountOf(payment)](/reference/ertp-api/issuer#anissuer-getamountof-payment)
- Describe the `payment`'s balance as an Amount.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#getAmountOf
-- [anIssuer.isLive(payment)](/reference/ertp-api/issuer.md#anissuer-islive-payment)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#getAmountOf
+- [anIssuer.isLive(payment)](/reference/ertp-api/issuer#anissuer-islive-payment)
- Return `true` if the `payment` was created by the issuer and is available for use (has not been consumed or burned).
-- [anIssuer.split(payment, paymentAmountA)](/reference/ertp-api/issuer.md#anissuer-split-payment-paymentamounta)
+- [anIssuer.split(payment, paymentAmountA)](/reference/ertp-api/issuer#anissuer-split-payment-paymentamounta)
- Split a single `payment` into two new Payments.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#split
-- [anIssuer.splitMany(payment, amountArray)](/reference/ertp-api/issuer.md#anissuer-splitmany-payment-amountarray)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#split
+- [anIssuer.splitMany(payment, amountArray)](/reference/ertp-api/issuer#anissuer-splitmany-payment-amountarray)
- Split a single `payment` into multiple Payments.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#splitManyConcise
-- [aMint.mintPayment(newAmount)](/reference/ertp-api/mint.md#amint-mintpayment-newamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#splitManyConcise
+- [aMint.mintPayment(newAmount)](/reference/ertp-api/mint#amint-mintpayment-newamount)
- Create new digital assets of the `mint`'s associated `brand`.
- - <<< @/snippets/ertp/guide/test-issuers-and-mints.js#mintMintPayment
-- [aPurse.deposit(payment, optAmount)](/reference/ertp-api/purse.md#apurse-deposit-payment-optamount)
+ - <<< @/../snippets/ertp/guide/test-issuers-and-mints.js#mintMintPayment
+- [aPurse.deposit(payment, optAmount)](/reference/ertp-api/purse#apurse-deposit-payment-optamount)
- Deposit all the contents of `payment` into `purse`.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#deposit
-- [aPurse.getDepositFacet()](/reference/ertp-api/purse.md#apurse-getdepositfacet)
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#deposit
+- [aPurse.getDepositFacet()](/reference/ertp-api/purse#apurse-getdepositfacet)
- Create and return a new deposit-only facet of the `purse` that allows arbitrary other parties to deposit Payments into `purse`.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#getDepositFacet
-- [aPurse.withdraw(amount)](/reference/ertp-api/purse.md#apurse-withdraw-amount)
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#getDepositFacet
+- [aPurse.withdraw(amount)](/reference/ertp-api/purse#apurse-withdraw-amount)
- Withdraw the `amount` of specified digital assets from `purse` into a new `payment`.
- - <<< @/snippets/ertp/guide/test-purses-and-payments.js#withdraw
+ - <<< @/../snippets/ertp/guide/test-purses-and-payments.js#withdraw
## Purse and Payment Example
@@ -189,4 +189,4 @@ The following code creates a new `purse` for the `quatloos` brand, deposits
10 Quatloos into the `purse`, withdraws 3 Quatloos from the `purse` into a
`payment`, and finally returns an `amount` describing what's currently in the `purse`, 7 Quatloos.
-<<< @/snippets/ertp/guide/test-purses-and-payments.js#example
+<<< @/../snippets/ertp/guide/test-purses-and-payments.js#example
diff --git a/main/guides/getting-started/contract-rpc.md b/main/guides/getting-started/contract-rpc.md
index c8123cb32..c70018e08 100644
--- a/main/guides/getting-started/contract-rpc.md
+++ b/main/guides/getting-started/contract-rpc.md
@@ -1,7 +1,7 @@
# Smart Wallet Dapp Architecture
The [Agoric Platform](../platform/) consists of smart contracts
-and services such as [Zoe](../zoe/) running in a [Hardened JavaScript](../js-programming/hardened-js.md) VM running on top of a Cosmos SDK consensus layer. Clients interact with the consensus layer by making
+and services such as [Zoe](../zoe/) running in a [Hardened JavaScript](../js-programming/hardened-js) VM running on top of a Cosmos SDK consensus layer. Clients interact with the consensus layer by making
queries and submitting messages in signed transactions. In the Smart
Wallet Architecture, dapps consist of
@@ -112,7 +112,7 @@ The [vstorage-viewer](https://github.com/p2p-org/p2p-agoric-vstorage-viewer) con
## Specifying Offers
Recall that for an agent within the JavaScript VM,
-[`E(zoe).offer(...)`](../../reference/zoe-api/zoe.md#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs) takes an `Invitation` and optionally a `Proposal` with `{ give, want, exit }`, a `PaymentPKeywordRecord`, and `offerArgs`; it returns a `UserSeat` from which we can [getPayouts()](../../reference/zoe-api/user-seat.md#e-userseat-getpayouts).
+[`E(zoe).offer(...)`](../../reference/zoe-api/zoe#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs) takes an `Invitation` and optionally a `Proposal` with `{ give, want, exit }`, a `PaymentPKeywordRecord`, and `offerArgs`; it returns a `UserSeat` from which we can [getPayouts()](../../reference/zoe-api/user-seat#e-userseat-getpayouts).
@@ -120,7 +120,7 @@ In the Smart Wallet architecture, a client uses an `OfferSpec` to
tell its `SmartWallet` how to conduct an offer.
It includes an `invitationSpec` to say what invitation to pass to Zoe. For example:
-<<< @/snippets/test-marshal.js#exInvitationSpec
+<<< @/../snippets/test-marshal.js#exInvitationSpec
Here the `SmartWallet` calls `E(zoe).getPublicFacet(instance)` and then
uses the `publicInvitationMaker` and `invitationArgs` to call the contract's
@@ -137,12 +137,12 @@ For more `InvitationSpec` examples, see [How to make an offer from a dapp via th
The client fills in the proposal, which instructs the `SmartWallet`
to withdraw corresponding payments to send to Zoe.
-<<< @/snippets/test-marshal.js#exBridgeAction
+<<< @/../snippets/test-marshal.js#exBridgeAction
But recall the `spend_action` field in `MsgWalletSpendAction` is a string.
In fact, the expected string in this case is of the form:
-<<< @/snippets/test-marshal.js#exSpendActionCk
+<<< @/../snippets/test-marshal.js#exSpendActionCk
We recognize `"method":"executeOffer"` and such, but
`body:`, `slots:`, and `$1.Alleged: Gold Brand` need further explanation.
@@ -157,40 +157,40 @@ We recognize `"method":"executeOffer"` and such, but
To start with, amounts include `bigint`s. The `@endo/marshal` API handles those:
-<<< @/snippets/test-marshal.js#marshal-json-steroids
+<<< @/../snippets/test-marshal.js#marshal-json-steroids
-To marshal brands and instances, recall from the discussion of [marshal in eventual send](../js-programming/eventual-send.md#e-and-marshal-a-closer-look)
+To marshal brands and instances, recall from the discussion of [marshal in eventual send](../js-programming/eventual-send#e-and-marshal-a-closer-look)
how remotables are marshalled with a translation table.
-The [Agoric Board](../../reference/repl/board.md) is a well-known name service that issues
+The [Agoric Board](../../reference/repl/board) is a well-known name service that issues
plain string identifiers for object identities and other passable _keys_ (that is: passable values excluding promises and errors).
Contracts and other services can use its table of identifiers as a marshal
translation table:
-<<< @/snippets/test-marshal.js#boardMarshal
+<<< @/../snippets/test-marshal.js#boardMarshal
To reverse the process, clients can mirror the on-chain board translation
table by synthesizing a remotable for each reference marker received:
-<<< @/snippets/test-marshal.js#makeBoardContext
+<<< @/../snippets/test-marshal.js#makeBoardContext
Now we can take results of vstorage queries for `Data('published.agoricNames.brand')` and `Data('published.agoricNames.instance')` unmarshal ("ingest") them:
-<<< @/snippets/test-marshal.js#useBoardContext
+<<< @/../snippets/test-marshal.js#useBoardContext
And now we have all the pieces of the `BridgeAction` above.
The marshalled form is:
-<<< @/snippets/test-marshal.js#exBridgeActionEq
+<<< @/../snippets/test-marshal.js#exBridgeActionEq
We still don't quite have a single string for the `spend_action` field.
We need to `stringify` the `CapData`:
-<<< @/snippets/test-marshal.js#exSpendAction
+<<< @/../snippets/test-marshal.js#exSpendAction
And now we have the `spend_action` in the expected form:
-<<< @/snippets/test-marshal.js#exSpendActionCk
+<<< @/../snippets/test-marshal.js#exSpendActionCk
The wallet factory can now `JSON.parse` this string
into `CapData` and unmarshal it using a board marshaller
diff --git a/main/guides/getting-started/deploying.md b/main/guides/getting-started/deploying.md
index ad69d6fd6..36bc2649f 100644
--- a/main/guides/getting-started/deploying.md
+++ b/main/guides/getting-started/deploying.md
@@ -1,6 +1,6 @@
# Deploying Smart Contracts
-The `agoric deploy` command in the [Agoric command line tool](/guides/agoric-cli/README.md#agoric-deploy) supports deploying contracts and off-chain web applications that talk to those contracts. The command has two primary uses:
+The `agoric deploy` command in the [Agoric command line tool](/guides/agoric-cli/index#agoric-deploy) supports deploying contracts and off-chain web applications that talk to those contracts. The command has two primary uses:
* Deploy smart contract source code onto the blockchain.
* Deploy and set up an application program on a local server running an Agoric process.
@@ -38,7 +38,7 @@ First, let's look at *contract deployment*. `contract/deploy.js` bundles up a co
it on the blockchain as source code, using `Zoe`.
This does _not_ execute contract code; it just makes the code available on-chain.
-The contract deployment process uses [`zoe.install()`](/reference/zoe-api/zoe.md#e-zoe-install-bundle)
+The contract deployment process uses [`zoe.install()`](/reference/zoe-api/zoe#e-zoe-install-bundle)
to install the contract source code on-chain. This returns an *installation* associated with the
source code. In a typical contract deployment, the deploy script adds the installation
to the default shared board so it is broadly accessible on the chain. The script then writes
diff --git a/main/guides/getting-started/README.md b/main/guides/getting-started/index.md
similarity index 99%
rename from main/guides/getting-started/README.md
rename to main/guides/getting-started/index.md
index d83f55132..273677440 100644
--- a/main/guides/getting-started/README.md
+++ b/main/guides/getting-started/index.md
@@ -234,7 +234,7 @@ Use control-C to exit the logs, then start the smart contract. Starting the cont
yarn start:contract
```
-This `start:contract` script will do a number of things that we will cover in more detail later (_[transaction commands](../agoric-cli/agd-query-tx.md#transaction-commands), [permissioned deployment](../coreeval/)_):
+This `start:contract` script will do a number of things that we will cover in more detail later (_[transaction commands](../agoric-cli/agd-query-tx#transaction-commands), [permissioned deployment](../coreeval/)_):
1. Bundle the contract with `agoric run ...`
2. Collect some ATOM with `agd tx bank send ...`.
diff --git a/main/guides/README.md b/main/guides/index.md
similarity index 100%
rename from main/guides/README.md
rename to main/guides/index.md
diff --git a/main/guides/integration/name-services.md b/main/guides/integration/name-services.md
index 4e512c5ee..588c63fe8 100644
--- a/main/guides/integration/name-services.md
+++ b/main/guides/integration/name-services.md
@@ -50,7 +50,7 @@ The `NameAdmin` interface has an `onUpdate` method for registering a callback.
This is used to reflect the brand entries, that is: `E(E(agoricNames).lookup('brand')).entries()`
into vstorage at `published.agoricNames.brand` each time they change.
The entries for `instance` and the other keys of `agoricNames` are likewise reflected under `published.agoricNames`.
-See [marshalling amounts and instance](../getting-started/contract-rpc.md#marshalling-amounts-and-instances)
+See [marshalling amounts and instance](../getting-started/contract-rpc#marshalling-amounts-and-instances)
for details on the format of the data stored in vstorage.
@@ -103,5 +103,5 @@ can look up the object:
const instance = await E(board).getValue('board023423')
```
-See also: [marshalling amounts and instance](../getting-started/contract-rpc.md#marshalling-amounts-and-instances)
-for details on using board ids to refer to objects from structures stored in vstorage,
\ No newline at end of file
+See also: [marshalling amounts and instance](../getting-started/contract-rpc#marshalling-amounts-and-instances)
+for details on using board ids to refer to objects from structures stored in vstorage,
diff --git a/main/guides/js-programming/eventual-send.md b/main/guides/js-programming/eventual-send.md
index 6ace9cb3c..dfb0227d0 100644
--- a/main/guides/js-programming/eventual-send.md
+++ b/main/guides/js-programming/eventual-send.md
@@ -3,12 +3,12 @@
In web browsers, a common pattern of remote communication is using the
[asynchronous fetch API with promises](https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Asynchronous/Introducing#promises):
-<<< @/snippets/test-distributed-programming.js#asyncFetch
+<<< @/../snippets/test-distributed-programming.js#asyncFetch
In the Agoric platform, communicating with remote objects is similar,
using the `E()` wrapper. For example,
-a [deploy script](../getting-started/deploying.md) may want to use the
-[Zoe Service API](/reference/zoe-api/zoe.md) to install a contract on a blockchain.
+a [deploy script](../getting-started/deploying) may want to use the
+[Zoe Service API](/reference/zoe-api/zoe) to install a contract on a blockchain.
But the deploy script cannot call `zoe.install(bundle)`, because it does not have local
access to the `zoe` object. However, the deploy
script is given a `zoe` _remote presence_. To call methods on the
@@ -24,7 +24,7 @@ E(zoe).install(bundle)
## Eventual Send
-One of the ways [Zoe partitions risk](https://www.youtube.com/watch?v=T6h6TMuVHKQ&t=368s) is by running in its own [vat](../../glossary/README.md#vat), separate from any smart contract that might
+One of the ways [Zoe partitions risk](https://www.youtube.com/watch?v=T6h6TMuVHKQ&t=368s) is by running in its own [vat](../../glossary/index#vat), separate from any smart contract that might
use too much compute time or heap space. The smart contracts also run in separate vats.
@@ -32,7 +32,7 @@ use too much compute time or heap space. The smart contracts also run in separat
What happens when we call `E(zoe).install(bundle)` is an _eventual send_:
1. A message consisting of the method name `install`
- with the `bundle` argument [marshaled](./far.md)
+ with the `bundle` argument [marshaled](./far)
to a flat string and queued for delivery to
the vat that `zoe` comes from.
2. `E(zoe).install(bundle)` returns a promise for the result.
@@ -101,24 +101,24 @@ In [@endo/marshal](https://github.com/endojs/endo/tree/master/packages/marshal#r
For example, we can marshal a remotable counter using the slot identifier `c1`:
-<<< @/snippets/test-marshal.js#marshal-remotable
+<<< @/../snippets/test-marshal.js#marshal-remotable
Each end of a connection between vats typically keeps
a table to translate slots to capabilities and back:
-<<< @/snippets/test-marshal.js#marshal-table
+<<< @/../snippets/test-marshal.js#marshal-table
Each call to `E(rx)` makes a proxy for the reciver `rx`;
each `E(rx).p` property reference invokes the `get` proxy trap.
From the `get` trap, `E` returns a function that queues
`rx`, `p`, and its arguments (in marshalled form) and returns a promise:
-<<< @/snippets/test-marshal.js#marshal-messages-e
+<<< @/../snippets/test-marshal.js#marshal-messages-e
Now we can see the result in some detail. Note the way the promise from
`E(zoe).install()` is passed to `E(zoe).startInstance()`.
-<<< @/snippets/test-marshal.js#marshal-messages
+<<< @/../snippets/test-marshal.js#marshal-messages
::: tip Watch: How Agoric Solves Reentrancy Hazards (November 2020)
for more on eventual send and remote communication
diff --git a/main/guides/js-programming/far.md b/main/guides/js-programming/far.md
index 688cd8c7b..d9453aa44 100644
--- a/main/guides/js-programming/far.md
+++ b/main/guides/js-programming/far.md
@@ -1,29 +1,29 @@
# Far(), Remotable, and Marshaling
-Let's look more closely at an [eventual send](./eventual-send.md) between vats:
+Let's look more closely at an [eventual send](./eventual-send) between vats:
-In the exporting vat, we'll take the `makeCounter` [Hardened JavaScript example](./hardened-js.md#example-hardened-javascript-code) and refine it to make _remotable_ counters
+In the exporting vat, we'll take the `makeCounter` [Hardened JavaScript example](./hardened-js#example-hardened-javascript-code) and refine it to make _remotable_ counters
by marking them with [Far](#far-api):
-<<< @/snippets/test-distributed-programming.js#makeFarCounter
+<<< @/../snippets/test-distributed-programming.js#makeFarCounter
## Marshaling by Copy or by Presence
-Recall that the first step in an [eventual send](./eventual-send.md#eventual-send) is
+Recall that the first step in an [eventual send](./eventual-send#eventual-send) is
to _marshal_ the method name and arguments. [Marshalling](https://en.wikipedia.org/wiki/Marshalling_%28computer_science%29) is transforming a data structure into a format suitable for storage or transmission.
The [@endo/marshal](https://github.com/endojs/endo/tree/master/packages/marshal#readme) package uses [JSON](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON), but it can handle
Javascript values that cannot be expressed directly as JSON,
such as `undefined` and `BigInt`s.
-<<< @/snippets/test-marshal.js#marshal-json-steroids
+<<< @/../snippets/test-marshal.js#marshal-json-steroids
Also, while many forms of data are copied between vats,
remotables are marshalled so that they become remote _presences_ when unmarshaled.
Another vat can then make and use the exported counters:
-<<< @/snippets/test-distributed-programming.js#useFarCounter
+<<< @/../snippets/test-distributed-programming.js#useFarCounter
## Pass Styles and harden
@@ -41,7 +41,7 @@ There are four broad kinds of Passable:
_CopyRecords_ like `harden({ keys: [0, 1], values: ['foo', 'bar'] })`, and
_CopyTaggeds_ representing types like CopySet, CopyBag, and CopyMap
(which extend the `passStyleOf` level of abstraction with
- [tag-specific shapes and semantics](https://github.com/endojs/endo/blob/master/packages/patterns/docs/marshal-vs-patterns-level.md#kindof-vs-passstyleof))
+ [tag-specific shapes and semantics](https://github.com/endojs/endo/blob/master/packages/patterns/docs/marshal-vs-patterns-level#kindof-vs-passstyleof))
- Pass-by-reference "**PassableCaps**":
- _Remotables_: objects that can be shared with remote systems which can then
invoke methods using e.g. `E()` eventual send notation. Remotables are created by [`Far()`](#far-api)
@@ -69,7 +69,7 @@ data leads to behavior across vats that is straightforward to reason about.
## passStyleOf API
-<<< @/snippets/test-distributed-programming.js#import-pass-style
+<<< @/../snippets/test-distributed-programming.js#import-pass-style
`passStyleOf(passable)` returns a `PassStyle` string that categorizes `passable`.
@@ -93,7 +93,7 @@ this prevents malicious clients from playing tricks with cyclic data etc.
## Far() API
-<<< @/snippets/test-distributed-programming.js#importFar
+<<< @/../snippets/test-distributed-programming.js#importFar
`Far(farName, objectWithMethods)` marks an object as Remotable.
diff --git a/main/guides/js-programming/hardened-js.md b/main/guides/js-programming/hardened-js.md
index a02f6f33b..2dc20fa4d 100644
--- a/main/guides/js-programming/hardened-js.md
+++ b/main/guides/js-programming/hardened-js.md
@@ -13,7 +13,7 @@ The last 10 minutes are Q&A._
The example below demonstrates several features of Hardened JavaScript.
-<<< @/snippets/test-hardened-js.js#makeCounter
+<<< @/../snippets/test-hardened-js.js#makeCounter
We'll unpack this a bit [below](#objects-and-the-maker-pattern), but for now please
note the use of functions and records:
@@ -38,14 +38,14 @@ when people exit the room.
We can give the `entryGuard` access to the `incr` function
and give the `exitGuard` access to the `decr` function.
-<<< @/snippets/test-hardened-js.js#entryExit
+<<< @/../snippets/test-hardened-js.js#entryExit
The result is that the `entryGuard` can _only_ count up
and the `exitGuard` can _only_ count down.
::: tip Eventual send syntax
The `entryGuard ! use(counter.incr);` code in the video
-uses a proposed syntax for [eventual send](./eventual-send.md),
+uses a proposed syntax for [eventual send](./eventual-send),
which we will get to soon.
:::
@@ -144,12 +144,12 @@ Let's unpack the `makeCounter` example a bit.
JavaScript is somewhat novel in that objects need not belong to any
class; they can just stand on their own:
-<<< @/snippets/test-hardened-js.js#singleton
+<<< @/../snippets/test-hardened-js.js#singleton
We can make a new such object each time a function is called
using the _maker pattern_:
-<<< @/snippets/test-hardened-js.js#maker
+<<< @/../snippets/test-hardened-js.js#maker
::: tip Use lexically scoped variables rather than properties of `this`.
The style above avoids boilerplate such as `this.x = x; this.y = y`.
@@ -166,22 +166,22 @@ for conciseness and to avoid `this`.
By default, anyone can clobber the properties of
our objects so that they fail to conform to the expected API:
-<<< @/snippets/test-hardened-js.js#clobber
+<<< @/../snippets/test-hardened-js.js#clobber
Worse yet is to clobber a property so that it misbehaves but
covers its tracks so that we don't notice:
-<<< @/snippets/test-hardened-js.js#exploit
+<<< @/../snippets/test-hardened-js.js#exploit
Our goal is **defensive correctness**: a program is _defensively correct_ if it remains correct despite arbitrary behavior on the part of its clients. _For further discussion, see [Concurrency Among Strangers](http://erights.org/talks/promises/paper/tgc05.pdf) and other [Agoric papers on Robust Composition](https://papers.agoric.com/papers/#robust-composition)_.
To prevent tampering, use the [harden](https://github.com/endojs/endo/blob/HEAD/packages/ses/README.md#harden) function, which is a deep form of [Object.freeze](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze).
-<<< @/snippets/test-hardened-js.js#defensiveMaker
+<<< @/../snippets/test-hardened-js.js#defensiveMaker
Any attempt to modify the properties of a hardened object throws:
-<<< @/snippets/test-hardened-js.js#thwarted
+<<< @/../snippets/test-hardened-js.js#thwarted
`harden()` should be called on all objects that will be transferred
across a trust boundary. It's important to `harden()` an object before exposing the object by returning it or passing it to some other function.
@@ -194,7 +194,7 @@ For more details, see [harden API in the `ses` package](https://github.com/endoj
Now let's review the `makeCounter` example:
-<<< @/snippets/test-hardened-js.js#counterAnimation
+<<< @/../snippets/test-hardened-js.js#counterAnimation
Each call to `makeCounter` creates a new encapsulated `count` variable
along with `incr` and `decr` functions. The `incr` and `decr` functions
@@ -227,12 +227,12 @@ ordinary JavaScript is the ability to redefine built-ins
(shown above as "mutable primordials").
Consider this `changePassword` function:
-<<< @/snippets/test-no-ses.js#changePassword
+<<< @/../snippets/test-no-ses.js#changePassword
In ordinary JavaScript we run the risk of stolen passwords because someone might have redefined
the `includes` method on `Array` objects:
-<<< @/snippets/test-no-ses.js#exfiltrate
+<<< @/../snippets/test-no-ses.js#exfiltrate
In Hardened JavaScript, the `Object.assign` fails because `Array.prototype` and all other
[standard, built-in objects](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects)
@@ -276,7 +276,7 @@ or not:
- `setImmediate`, `clearImmediate`, `setTimeout`
- but `Promise` is available, so sometimes
`Promise.resolve().then(_ => fn())` suffices
- - see also [Timer Service](/reference/repl/timerServices.md)
+ - see also [Timer Service](/reference/repl/timerServices)
- `require` (Use `import` module syntax instead.)
- `localStorage`
- [SwingSet](../platform/#swingset) orthogonal persistence means state lives indefinitely in ordinary variables and data structures and need not be explicitly written to storage.
diff --git a/main/guides/js-programming/README.md b/main/guides/js-programming/index.md
similarity index 84%
rename from main/guides/js-programming/README.md
rename to main/guides/js-programming/index.md
index 8cf976ae5..60f6bfb37 100644
--- a/main/guides/js-programming/README.md
+++ b/main/guides/js-programming/index.md
@@ -23,32 +23,32 @@ We refer to this combination of an event loop with a message queue, a stack, and
Vats are the unit of synchrony. We can only use ordinary synchronous
function calls within the same vat. But we can use asynchronous function calls
-(with [eventual send](./eventual-send.md)) either within the same vat or between vats.
+(with [eventual send](./eventual-send)) either within the same vat or between vats.
Vats may be on remote machines, including massively replicated machines such as blockchains.
## Parts of the Framework
The framework includes:
-- **[Hardened JavaScript](./hardened-js.md)**
+- **[Hardened JavaScript](./hardened-js)**
- Hardened JavaScript provides a platform for
making objects that can interact with code you don't completely trust,
without being vulnerable to bugs or bad intentions.
- We introduce [object capabilities](./hardened-js.md#object-capabilities-ocaps) and how to use them
- to apply the [principle of least authority](./hardened-js.md#the-principle-of-least-authority-pola).
+ We introduce [object capabilities](./hardened-js#object-capabilities-ocaps) and how to use them
+ to apply the [principle of least authority](./hardened-js#the-principle-of-least-authority-pola).
-- **[`E()` for Eventual Send to Remote Presences](./eventual-send.md)**
+- **[`E()` for Eventual Send to Remote Presences](./eventual-send)**
- The `E()` wrapper function lets
you invoke methods within or between vats.
Given a local representative (a *presence*) for a remote object,
it sends messages to the origin of the presence.
`E(obj).myMethod(...args)` is an asynchronous form of `obj.myMethod(...args)`.
-- **[`Far()`, Remoteable Objects, and Marshaling](./far.md)**
+- **[`Far()`, Remoteable Objects, and Marshaling](./far)**
- Objects used across vats are called *remotables*.
To mark an object for exporting from a vat, use the `Far()` function.
-- **[Notifiers and Subscriptions](./notifiers.md)**
+- **[Notifiers and Subscriptions](./notifiers)**
- Notifiers and Subscriptions distribute state change
updates. Both deliver an asynchronous stream of messages as a publish-subscribe system
might, without requiring explicit management of lists of subscribers. Notifiers are
diff --git a/main/guides/js-programming/notifiers.md b/main/guides/js-programming/notifiers.md
index fd2c1a658..9c69e5d42 100644
--- a/main/guides/js-programming/notifiers.md
+++ b/main/guides/js-programming/notifiers.md
@@ -155,19 +155,19 @@ Individual contracts can use notifiers and subscriptions to provide updates givi
The following methods use or return notifiers.
-- [aPurse.getCurrentAmountNotifier()](/reference/ertp-api/purse.md#apurse-getcurrentamountnotifier)
+- [aPurse.getCurrentAmountNotifier()](/reference/ertp-api/purse#apurse-getcurrentamountnotifier)
- Part of the ERTP API. Returns a lossy notifier for changes to this purse's balance.
-- [getPursesNotifier()](/reference/wallet-api.md#getpursesnotifier)
+- [getPursesNotifier()](/reference/wallet-api/wallet-bridge#getpursesnotifier)
- Part of the Wallet API. It returns a notifier that follows changes in the purses in the Wallet.
-- [getOffersNotifier()](/reference/wallet-api.md#getoffersnotifier)
+- [getOffersNotifier()](/reference/wallet-api/wallet-bridge#getoffersnotifier)
- Part of the Wallet API. It returns a notifier that follows changes to the offers received by the Wallet.
-- [makeQuoteNotifier(amountIn,brandOut)](/reference/repl/priceAuthority.md#makequotenotifier-amountin-brandout)
+- [makeQuoteNotifier(amountIn,brandOut)](/reference/repl/priceAuthority#makequotenotifier-amountin-brandout)
- Part of the PriceAuthority API. Notifies the latest `PriceQuotes` for the given `amountIn`.
-- [getPriceNotifier(brandIn, brandOut)](/reference/repl/priceAuthority.md#getpricenotifier-brandin-brandout)
+- [getPriceNotifier(brandIn, brandOut)](/reference/repl/priceAuthority#getpricenotifier-brandin-brandout)
- Part of the PriceAuthority API. Returns a notifier for the specified brands. Different PriceAuthorities may issue these at very
different rates.
- [E(home.localTimerService).makeNotifier(delay, interval) and
- E(home.chainTimerService).makeNotifier(delay, interval)](/repl/timerServices.md#e-home-chain-or-local-timerservice-makenotifier-delay-interval)
+ E(home.chainTimerService).makeNotifier(delay, interval)](/reference/repl/timerServices#e-home-chain-or-local-timerservice-makenotifier-delay-interval)
- Part of the REPL's TimerService API. It creates and returns a `Notifier` object
that repeatedly delivers updates at times that are a multiple of the provided `interval` value,
with the first update happening after the provided `delay` value.
@@ -250,7 +250,7 @@ hang or miss values.
For distributed operations, all the iteration values—non-final values,
successful completion value, failure reason—must be *Passable*, which means they're values that
-can somehow be passed between [vats](../../glossary/README.md#vat). The rest of this doc assumes all these
+can somehow be passed between [vats](../../glossary/index#vat). The rest of this doc assumes all these
values are Passable.
The `makeNotifierKit()` or `makeSubscriptionKit()` call makes the notifier/updater
diff --git a/main/guides/platform/README.md b/main/guides/platform/index.md
similarity index 100%
rename from main/guides/platform/README.md
rename to main/guides/platform/index.md
diff --git a/main/guides/wallet/README.md b/main/guides/wallet/index.md
similarity index 97%
rename from main/guides/wallet/README.md
rename to main/guides/wallet/index.md
index 81b4df51f..e7ca9a0c5 100644
--- a/main/guides/wallet/README.md
+++ b/main/guides/wallet/index.md
@@ -1,7 +1,7 @@
# Agoric Wallet
This page documents the *Agoric Wallet*, including its use of *petnames* and its place in the Agoric Platform
-architecture. See also [tour of the Wallet UI](./ui.md), [Wallet API reference](/reference/wallet-api.md).
+architecture. See also [tour of the Wallet UI](./ui), [Wallet API reference](/reference/wallet-api/).
## Wallet and Agoric Architecture
@@ -110,7 +110,7 @@ communication method you like; private email, an email blast to a mailing list
or many individuals, buying an ad on a website, tv program, or newspaper,
listing it on your website, etc.
-<<< @/snippets/ertp/guide/test-readme.js#getValue
+<<< @/../snippets/ertp/guide/test-readme.js#getValue
To get an object, such as a depositFacet, using the Board, first you have
to be told what Board Id is associated with it. Using the `getValue()` method,
diff --git a/main/guides/zoe/actual-contracts/README.md b/main/guides/zoe/actual-contracts/index.md
similarity index 90%
rename from main/guides/zoe/actual-contracts/README.md
rename to main/guides/zoe/actual-contracts/index.md
index 27474b48a..6505b29f8 100644
--- a/main/guides/zoe/actual-contracts/README.md
+++ b/main/guides/zoe/actual-contracts/index.md
@@ -12,7 +12,7 @@ In the [mainnet-1B release of agoric-sdk](https://github.com/Agoric/agoric-sdk/r
| binaryVoteCounter | instantiated once for each question that a committee votes on |
| econCommitteeCharter | controls what questions can be put to the economic committee |
| contractGovernor | each governed contract is started by starting its governor |
-| [PSM](./PSM.md) | The Parity Stability Module (PSM) supports efficiently minting and burning Inter Stable Tokens (ISTs) in exchange for approved external stable tokens. |
+| [PSM](./PSM) | The Parity Stability Module (PSM) supports efficiently minting and burning Inter Stable Tokens (ISTs) in exchange for approved external stable tokens. |
| vaultFactory| allows users to mint IST backed by collateral such as ATOM; hands off vaults to auctioneer when value of collateral in a vault falls below a governed threshold |
| auctioneer | auctions collateral from liquidated vaults |
| fluxAggregator | aggregates prices from oracle oeprators |
diff --git a/main/guides/zoe/contract-basics.md b/main/guides/zoe/contract-basics.md
index f7b961cca..42a6d5dbd 100644
--- a/main/guides/zoe/contract-basics.md
+++ b/main/guides/zoe/contract-basics.md
@@ -6,25 +6,25 @@ basic dapp](./) in the previous section, let's cover some basics.
A contract is defined by a JavaScript module that exports a `start` function
that implements the contract's API.
-<<< @/snippets/zoe/src/01-hello.js#start
+<<< @/../snippets/zoe/src/01-hello.js#start
Let's start with a contract with a simple `greet` function:
-<<< @/snippets/zoe/src/01-hello.js#greet
+<<< @/../snippets/zoe/src/01-hello.js#greet
The `start` function can expose the `greet` function
as part of the contract API by making it
a method of the contract's `publicFacet`:
-<<< @/snippets/zoe/src/01-hello.js#publicFacet
+<<< @/../snippets/zoe/src/01-hello.js#publicFacet
We mark it `Far(...)` to allow callers to use it from outside the contract
and give it a suggestive interface name for debugging.
-_We'll discuss [Far in more detail](../js-programming/far.md) later._
+_We'll discuss [Far in more detail](../js-programming/far) later._
Putting it all together:
-<<< @/snippets/zoe/src/01-hello.js#contract
+<<< @/../snippets/zoe/src/01-hello.js#contract
## Using, testing a contract
@@ -32,25 +32,25 @@ Let's use some tests to explore how a contract is used.
Agoric contracts are typically tested
using the [ava](https://github.com/avajs/ava) framework.
-They start with `@endo/init` to establish a [Hardened JavaScript](../js-programming/hardened-js.md) environment:
+They start with `@endo/init` to establish a [Hardened JavaScript](../js-programming/hardened-js) environment:
-<<< @/snippets/zoe/contracts/test-zoe-hello.js#test-imports
+<<< @/../snippets/zoe/contracts/test-zoe-hello.js#test-imports
-_We'll talk more about [using `E()` for async method calls](../js-programming/eventual-send.md) later._
+_We'll talk more about [using `E()` for async method calls](../js-programming/eventual-send) later._
A test that the `greet` method works as expected looks like:
-<<< @/snippets/zoe/contracts/test-zoe-hello.js#test1
+<<< @/../snippets/zoe/contracts/test-zoe-hello.js#test1
## State
Contracts can use ordinary variables and data structures for state.
-<<< @/snippets/zoe/src/02-state.js#startfn
+<<< @/../snippets/zoe/src/02-state.js#startfn
Using `makeRoom` changes the results of the following call to `getRoomCount`:
-<<< @/snippets/zoe/contracts/test-zoe-hello.js#test-state
+<<< @/../snippets/zoe/contracts/test-zoe-hello.js#test-state
::: tip Heap state is persistent
@@ -58,7 +58,7 @@ Ordinary heap state persists between contract invocations.
We'll discuss more explicit state management for
large numbers of objects (_virtual objects_) and
-objects that last across upgrades ([durable objects](./contract-upgrade.md#durability)) later.
+objects that last across upgrades ([durable objects](./contract-upgrade#durability)) later.
:::
@@ -68,17 +68,17 @@ We can limit the `publicFacet` API to read-only by omitting the `set()` method.
The `creatorFacet` is provided only to the caller who creates the contract instance.
-<<< @/snippets/zoe/src/03-access.js
+<<< @/../snippets/zoe/src/03-access.js
Trying to `set` using the `publicFacet` throws, but
using the `creatorFacet` works:
-<<< @/snippets/zoe/contracts/test-zoe-hello.js#test-access
+<<< @/../snippets/zoe/contracts/test-zoe-hello.js#test-access
Note that the `set()` method has no access check inside it.
Access control is based on separation of powers between
the `publicFacet`, which is expected to be shared widely,
and the `creatorFacet`, which is closely held.
-_We'll discuss this [object capabilities](../js-programming/hardened-js.md#object-capabilities-ocaps) approach more later._
+_We'll discuss this [object capabilities](../js-programming/hardened-js#object-capabilities-ocaps) approach more later._
Next, let's look at minting and trading assets with [Zoe](../zoe/).
diff --git a/main/guides/zoe/contract-requirements.md b/main/guides/zoe/contract-requirements.md
index 069dba000..dd13be991 100644
--- a/main/guides/zoe/contract-requirements.md
+++ b/main/guides/zoe/contract-requirements.md
@@ -39,7 +39,7 @@ Put it right before the start of your contract code.
*/
```
Your contract code must export a function `start` as a non-default export.
-`zcf` is the [Zoe Contract Facet](/reference/zoe-api/zoe-contract-facet.md) and is
+`zcf` is the [Zoe Contract Facet](/reference/zoe-api/zoe-contract-facet) and is
the first argument provided to the contract.
The second argument, `privateArgs`, is used by the caller of `startInstance`
to pass in any arguments that should not be part of the public terms.
@@ -131,7 +131,7 @@ between multiple offers, or create new assets to order.
## Making an Invitation
To create an invitation in the contract, use the Zoe Contract
-Facet method [`zcf.makeInvitation(...)`](/reference/zoe-api/zoe-contract-facet.md#zcf-makeinvitation-offerhandler-description-customdetails-proposalshape).
+Facet method [`zcf.makeInvitation(...)`](/reference/zoe-api/zoe-contract-facet#zcf-makeinvitation-offerhandler-description-customdetails-proposalshape).
## Using bundleSource
diff --git a/main/guides/zoe/contract-upgrade.md b/main/guides/zoe/contract-upgrade.md
index bbf3cf221..990bb25d0 100644
--- a/main/guides/zoe/contract-upgrade.md
+++ b/main/guides/zoe/contract-upgrade.md
@@ -62,7 +62,7 @@ There are a few requirements for the contract that differ from non-upgradable co
The new code bundle declares that it supports upgrade by exporting a `prepare` function in place of `start`.
-<<< @/snippets/zoe/src/02b-state-durable.js#export-prepare
+<<< @/../snippets/zoe/src/02b-state-durable.js#export-prepare
### Durability
@@ -97,17 +97,17 @@ The `zone` API is a convenient way to manage durability. Its store methods integ
::: details import { makeDurableZone } ...
-<<< @/snippets/zoe/src/02b-state-durable.js#import-zone
+<<< @/../snippets/zoe/src/02b-state-durable.js#import-zone
:::
-<<< @/snippets/zoe/src/02b-state-durable.js#zone1
+<<< @/../snippets/zoe/src/02b-state-durable.js#zone1
::: details What happens if we don't use baggage?
When the contract instance is restarted, its [vat](../js-programming/#vats-the-unit-of-synchrony) gets a fresh heap, so [ordinary heap state](./contract-basics.md#state) does not survive upgrade. This implementation does not persist the rooms nor their counts between incarnations:
-<<< @/snippets/zoe/src/02-state.js#heap-state{2}
+<<< @/../snippets/zoe/src/02-state.js#heap-state{2}
:::
@@ -115,18 +115,18 @@ When the contract instance is restarted, its [vat](../js-programming/#vats-the-u
Use `zone.exoClass()` to define state and methods of kinds of durable objects such as `Room`:
-<<< @/snippets/zoe/src/02b-state-durable.js#exoclass
+<<< @/../snippets/zoe/src/02b-state-durable.js#exoclass
Defining `publicFacet` as a singleton `exo` allows clients to
continue to use it after an upgrade:
-<<< @/snippets/zoe/src/02b-state-durable.js#exo
+<<< @/../snippets/zoe/src/02b-state-durable.js#exo
Now we have all the parts of an upgradable contract.
::: details full contract listing
-<<< @/snippets/zoe/src/02b-state-durable.js#contract
+<<< @/../snippets/zoe/src/02b-state-durable.js#contract
:::
diff --git a/main/guides/zoe/contracts/README.md b/main/guides/zoe/contracts/README.md
deleted file mode 100644
index f435f2ff1..000000000
--- a/main/guides/zoe/contracts/README.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Example Zoe Contracts
-
-
-<<< @/snippets/zoe/contracts/alice-trade.js#queryInstance
+<<< @/../snippets/zoe/contracts/alice-trade.js#queryInstance
Then she constructs a _proposal_ to give the `joinPrice` in exchange
for 1 Park Place and 1 Boardwalk, denominated in the game's `Place` brand; and she withdraws a payment from her purse:
-<<< @/snippets/zoe/contracts/alice-trade.js#makeProposal
+<<< @/../snippets/zoe/contracts/alice-trade.js#makeProposal
She then requests an _invitation_ to join the game; makes an _offer_ with
(a promise for) this invitation, her proposal, and her payment;
@@ -238,7 +238,7 @@ and awaits her **Places** payout:
-<<< @/snippets/zoe/contracts/alice-trade.js#trade
+<<< @/../snippets/zoe/contracts/alice-trade.js#trade
::: details Troubleshooting missing brands in offers
@@ -249,12 +249,12 @@ Error#1: key Object [Alleged: IST brand] {} not found in collection brandToIssue
```
then it may be that your offer uses brands that are not known to the contract.
-Use [E(zoe).getTerms()](/reference/zoe-api/zoe.md#e-zoe-getterms-instance) to find out what issuers
+Use [E(zoe).getTerms()](/reference/zoe-api/zoe#e-zoe-getterms-instance) to find out what issuers
are known to the contract.
If you're writing or instantiating the contract, you can tell the contract about issuers
when you are [creating an instance](#starting-a-contract-instance) or by using
-[zcf.saveIssuer()](/reference/zoe-api/zoe-contract-facet.md#zcf-saveissuer-issuer-keyword).
+[zcf.saveIssuer()](/reference/zoe-api/zoe-contract-facet#zcf-saveissuer-issuer-keyword).
:::
@@ -263,7 +263,7 @@ The contract gets Alice's `E(publicFacet).makeJoinInvitation()` call and uses `z
-<<< @/snippets/zoe/src/gameAssetContract.js#makeInvitation
+<<< @/../snippets/zoe/src/gameAssetContract.js#makeInvitation
The offer handler is invoked with a _seat_ representing the party making the offer.
It extracts the `give` and `want` from the party's offer and checks that
@@ -277,7 +277,7 @@ and allocate the minted places to the player. Finally, it concludes its business
-<<< @/snippets/zoe/src/gameAssetContract.js#handler
+<<< @/../snippets/zoe/src/gameAssetContract.js#handler
Zoe checks that the contract's instructions are consistent with
the offer and with conservation of assets. Then it allocates
@@ -290,19 +290,19 @@ and tests that it's what she wanted.
-<<< @/snippets/zoe/contracts/alice-trade.js#payouts
+<<< @/../snippets/zoe/contracts/alice-trade.js#payouts
## Example Contracts
Agoric has written [a number of example contracts that you can
-use](/zoe/guide/contracts/), including:
+use](./contracts/index), including:
- an [Automated Market Maker (AMM)
- implementation](/zoe/guide/contracts/constantProductAMM.md)
-- a [covered call option contract](./contracts/covered-call.md)
-- an [OTC Desk market maker contract](./contracts/otc-desk.md)
-- contracts for [minting fungible](./contracts/mint-payments.md) and
- [non-fungible tokens](./contracts/mint-and-sell-nfts.md)
+ implementation](./contracts/constantProductAMM)
+- a [covered call option contract](./contracts/covered-call)
+- an [OTC Desk market maker contract](./contracts/otc-desk)
+- contracts for [minting fungible](./contracts/mint-payments) and
+ [non-fungible tokens](./contracts/mint-and-sell-nfts)
::: warning Beta Features
diff --git a/main/guides/zoe/offer-enforcement.md b/main/guides/zoe/offer-enforcement.md
index 06d554103..7bc9c0360 100644
--- a/main/guides/zoe/offer-enforcement.md
+++ b/main/guides/zoe/offer-enforcement.md
@@ -24,7 +24,7 @@ payments) involve an exchange of digital assets that can be put in
terms of offer proposals. We
can say things like, "I'll give you [three wool for two
bricks](https://en.wikipedia.org/wiki/Catan)." [Learn more about the
-particulars of structuring an offer proposal here](./proposal.md).
+particulars of structuring an offer proposal here](./proposal).
Offers are a structured way of describing user intent. To a certain
extent, an offer's rules (called a *proposal*) are the user's
@@ -66,7 +66,7 @@ even if we don't trust each other. We are assured that at worst, if
the swap contract behaves badly, we both get a refund, and at
best, we get what we each wanted.
-Let's look at the basic [Atomic Swap contract](/guides/zoe/contracts/atomic-swap.md)
+Let's look at the basic [Atomic Swap contract](/guides/zoe/contracts/atomic-swap)
(link includes [real contract code](https://github.com/Agoric/agoric-sdk/blob/f29591519809dbadf19db0a26f38704d87429b89/packages/zoe/src/contracts/atomicSwap.js)).
Here's a high-level overview of what happens:
@@ -91,7 +91,7 @@ Here's a high-level overview of what happens:
## How to Write Smart Contracts
Writing smart contracts that run on Zoe is easy. Let's look
-at a simple contract like [Automatic Refund](/guides/zoe/contracts/automatic-refund.md)
+at a simple contract like [Automatic Refund](/guides/zoe/contracts/automatic-refund)
(link includes [real contract
code](https://github.com/Agoric/agoric-sdk/blob/4e0aece631d8310c7ab8ef3f46fad8981f64d208/packages/zoe/src/contracts/automaticRefund.js)).
It only does one thing, and it's pretty useless—it gives you back what you put in.
@@ -135,12 +135,12 @@ several optional properties:
## Diving Deeper
-Let's dive back into the [Atomic Swap contract](/guides/zoe/contracts/atomic-swap.md)
+Let's dive back into the [Atomic Swap contract](/guides/zoe/contracts/atomic-swap)
(link includes [real contract code](https://github.com/Agoric/agoric-sdk/blob/f29591519809dbadf19db0a26f38704d87429b89/packages/zoe/src/contracts/atomicSwap.js)).
The contract first confirms that `issuers` are setup for the `Asset` and `Price` keywords. Those are the two items that will be swapped.
-The following uses the [`assertIssuerKeywords` helper function](/reference/zoe-api/zoe-helpers.md#assertissuerkeywords-zcf-expected). It
+The following uses the [`assertIssuerKeywords` helper function](/reference/zoe-api/zoe-helpers#assertissuerkeywords-zcf-expected). It
checks properties of the running contract instance's terms.
```js
const start = zcf => {
@@ -153,7 +153,7 @@ the contract. When the associated `creatorInvitation` is used to make an offer,
with the `seat` for that offer.
This contract uses the
-[`assertProposalShape` helper function](/reference/zoe-api/zoe-helpers.md#assertproposalshape-seat-expected) to
+[`assertProposalShape` helper function](/reference/zoe-api/zoe-helpers#assertproposalshape-seat-expected) to
check that the offer proposes the kind of trade the contract accepts. In this case, offers must
have a proposal of the form:
```js
@@ -177,7 +177,7 @@ The contract then uses `getProposal()` to extract the properties of the proposal
`makeMatchingInvitation()` then constructs a `matchingSeatOfferHandler()` handler
for the second offer, with the first offer's `want` and `give` in scope. This second
handler is responsible for the final step.
-It uses the [`swap` helper function](/reference/zoe-api/zoe-helpers.md#swap-zcf-leftseat-rightseat)
+It uses the [`swap` helper function](/reference/zoe-api/zoe-helpers#swap-zcf-leftseat-rightseat)
to attempt asset reallocation between the two seats as described above and then
(whether or not the attempt succeeds) exits both seats, making payouts available to
both parties. Finally, `matchingSeatOfferHandler()` shuts down the contract.
@@ -217,5 +217,5 @@ and returns it as `creatorInvitation`.
```
The `creatorInvitation` is only available to the contract instance's creator
-(see [`startInstance`](/reference/zoe-api/zoe.md#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs)).
+(see [`startInstance`](/reference/zoe-api/zoe#e-zoe-startinstance-installation-issuerkeywordrecord-terms-privateargs)).
The creator can use it to make their own offer, or can send it to some other party.
diff --git a/main/guides/zoe/price-authority.md b/main/guides/zoe/price-authority.md
index 4a2b189ee..73bedaa3e 100644
--- a/main/guides/zoe/price-authority.md
+++ b/main/guides/zoe/price-authority.md
@@ -56,5 +56,5 @@ by changing its trigger levels or by cancelling it.
## API Reference
-The Price Authority API reference is a section of the [Zoe API reference](/reference/zoe-api/price-authority.md)
+The Price Authority API reference is a section of the [Zoe API reference](/reference/zoe-api/price-authority)
diff --git a/main/guides/zoe/proposal.md b/main/guides/zoe/proposal.md
index 265240773..5e92b0297 100644
--- a/main/guides/zoe/proposal.md
+++ b/main/guides/zoe/proposal.md
@@ -4,15 +4,15 @@
## Making An offer
-To make an offer, you use [`E(zoe).offer(...)`](/reference/zoe-api/zoe.md#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs), which takes up to four arguments:
+To make an offer, you use [`E(zoe).offer(...)`](/reference/zoe-api/zoe#e-zoe-offer-invitation-proposal-paymentpkeywordrecord-offerargs), which takes up to four arguments:
- An **invitation** to participate in this contract instance.
- A **proposal** stating your offer conditions.
-- The **payments** escrowed for the offer, each corresponding with a **give** [Keyword](/reference/zoe-api/zoe-data-types.md#keyword) in **proposal**.
-- **offerArgs** expressing additional arguments for the **offerHandler** associated with the invitation by [`zcf.makeInvitation(...)`](/reference/zoe-api/zoe-contract-facet.md#zcf-makeinvitation-offerhandler-description-customdetails-proposalshape).
+- The **payments** escrowed for the offer, each corresponding with a **give** [Keyword](/reference/zoe-api/zoe-data-types#keyword) in **proposal**.
+- **offerArgs** expressing additional arguments for the **offerHandler** associated with the invitation by [`zcf.makeInvitation(...)`](/reference/zoe-api/zoe-contract-facet#zcf-makeinvitation-offerhandler-description-customdetails-proposalshape).
## 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
+An [Invitation](/reference/zoe-api/zoe-data-types#invitation) is a special case of ERTP [Payment](/reference/ertp-api/payment). Each is linked to a specific contract [Instance](/reference/zoe-api/zoe-data-types#instance), and
having one gives you the right to participate in that contract instance
by using that invitation as the first argument to `E(zoe).offer(...)`.
@@ -33,13 +33,13 @@ const myProposal = harden({
exit: { onDemand: null },
});
```
-**give** and **want** use [Keywords](/reference/zoe-api/zoe-data-types.md#keyword) defined by the contract.
+**give** and **want** use [Keywords](/reference/zoe-api/zoe-data-types#keyword) defined by the contract.
Keywords are unique identifiers per contract, that tie together proposals,
payments to be escrowed, and payouts to users.
In the example above, "Asset" and "Price" are the Keywords. However, in an auction contract,
the Keywords might be "Asset" and "Bid".
-Each `AmountMath.make` call above is just making an ERTP [Amount](/reference/ertp-api/ertp-data-types.md#amount), or description of digital assets.
+Each `AmountMath.make` call above is just making an ERTP [Amount](/reference/ertp-api/ertp-data-types#amount), or description of digital assets.
In this case, `AmountMath.make(quatloosBrand, 4n)` creates a description of 4 units
of our imaginary Quatloos currency and `AmountMath.make(moolaBrand, 15n)` creates a description
of 15 units of our imaginary Moola currency. (The "n" appended after each number indicates that
@@ -48,7 +48,7 @@ rather than a [Number](https://developer.mozilla.org/en-US/docs/Web/JavaScript/R
::: warning Note
Amounts are just _descriptions_ of assets, and have no intrinsic value of their own.
-In contrast, [Payments](/reference/ertp-api/payment.md) hold actual digital assets.
+In contrast, [Payments](/reference/ertp-api/payment) hold actual digital assets.
:::
**exit** specifies how the offer can be cancelled. It must conform to one of three shapes:
@@ -57,11 +57,11 @@ In contrast, [Payments](/reference/ertp-api/payment.md) hold actual digital asse
- `{ afterDeadline: deadlineDetails }`: The offer is automatically cancelled after a deadline,
as determined by its `timer` and `deadline` properties.
-For more details, see [Proposals](/reference/zoe-api/zoe.md#proposals).
+For more details, see [Proposals](/reference/zoe-api/zoe#proposals).
## Escrowed Payments
-Using the same Keywords as the **give** object in your **proposal**, you must specify a [PaymentPKeywordRecord](/reference/zoe-api/zoe-data-types.md#keywordrecord) containing [Payments](/reference/ertp-api/payment.md) of the corresponding digital assets.
+Using the same Keywords as the **give** object in your **proposal**, you must specify a [PaymentPKeywordRecord](/reference/zoe-api/zoe-data-types#keywordrecord) containing [Payments](/reference/ertp-api/payment) of the corresponding digital assets.
Zoe escrows these payments on behalf of your offer until it is completed
or rejected or the assets are reassigned to another offer.
```js
diff --git a/main/index.md b/main/index.md
new file mode 100644
index 000000000..6dab9851c
--- /dev/null
+++ b/main/index.md
@@ -0,0 +1,112 @@
+---
+####
+# YAML section setting up the home page
+# run `yarn docs:dev` at any time to start local dev server and access
+# website at localhost:8080 by default
+####
+layout: page
+footer: Apache-2.0 Licensed | Copyright © 2023 - Agoric
+---
+
+
+
+
+
diff --git a/main/public/agoric-logo-red.svg b/main/public/agoric-logo-red.svg
new file mode 100644
index 000000000..28822fa58
--- /dev/null
+++ b/main/public/agoric-logo-red.svg
@@ -0,0 +1,10 @@
+
+
+
diff --git a/main/.vuepress/public/favicon-full.ico b/main/public/favicon-full.ico
similarity index 100%
rename from main/.vuepress/public/favicon-full.ico
rename to main/public/favicon-full.ico
diff --git a/main/.vuepress/public/logo.svg b/main/public/logo.svg
similarity index 100%
rename from main/.vuepress/public/logo.svg
rename to main/public/logo.svg
diff --git a/main/reference/assets/README.md b/main/reference/assets/index.md
similarity index 100%
rename from main/reference/assets/README.md
rename to main/reference/assets/index.md
diff --git a/main/reference/ertp-api/README.md b/main/reference/ertp-api/README.md
deleted file mode 100644
index 5ac6fcc2e..000000000
--- a/main/reference/ertp-api/README.md
+++ /dev/null
@@ -1,31 +0,0 @@
-# ERTP API
-
-The ERTP API supports the following objects:
-
-| Object | Description |
-| --- | --- |
-| [Issuer](./issuer.md) | The authority on what holds digital assets of its kind. |
-| [Mint](./mint.md) | Can issue new digital assets. |
-| [Brand](./brand.md) | Identifies the asset type of the associated **Issuer** and **Mint**. |
-| [Purse](./purse.md) | Holds digital assets. |
-| [Payment](./payment.md) | Holds digital assets that are in transit. |
-
-
-
-The ETRP API uses the following library:
-
-| Object | Description |
-| --- | --- |
-| [AmountMath](./amount-math.md) | The **AmountMath** object has several methods which can be used to manipulate and analyze **[Amounts](./ertp-data-types.md#amount)**. |
-
-
-The ERTP API introduces and uses the following data types:
-
-| Data Type | Description |
-| --- | --- |
-| [Amount](./ertp-data-types.md#amount) | Describes digital assets, specifying the number and **[Brand](./brand.md)** of assets. Note that **Amounts** can describe either fungible or non-fungible assets. |
-| [AmountShape](./ertp-data-types.md#amountshape) | Describes digital assets, specifying the properties and **[Brand](./brand.md)** of assets. |
-| [AmountValue](./ertp-data-types.md#amountvalue) | Describes how much of something there is. |
-| [AssetKind](./ertp-data-types.md#assetkind) | Specifies whether an **Amount** is fungible or non-fungible. |
-| [DisplayInfo](./ertp-data-types.md#displayinfo) | Specifies how to display a **Brand**'s **Amounts**. |
-
diff --git a/main/reference/ertp-api/amount-math.md b/main/reference/ertp-api/amount-math.md
index b2ca9610e..abfb11b7e 100644
--- a/main/reference/ertp-api/amount-math.md
+++ b/main/reference/ertp-api/amount-math.md
@@ -1,6 +1,6 @@
# AmountMath Object
-Library for manipulating and analyzing **[Amounts](./ertp-data-types.md#amount)**.
+Library for manipulating and analyzing **[Amounts](./ertp-data-types#amount)**.
## Importing and Using AmountMath
@@ -9,18 +9,18 @@ To use **AmountMath**, import it from ERTP:
## Brand Parameters
-Note that many **AmountMath** methods have an optional **[Brand](./brand.md)** parameter.
+Note that many **AmountMath** methods have an optional **[Brand](./brand)** parameter.
For these methods, you should pass in a **Brand** argument you got from when
-you need to do an "absolute" check on the **Brand** within an **[Amount](./ertp-data-types.md#amount)** parameter.
+you need to do an "absolute" check on the **Brand** within an **[Amount](./ertp-data-types#amount)** parameter.
In this case, you want to use the **Brand** you got from the **Issuer** (or from Zoe)
as the optional parameter to compare the **Amount** **Brand**(s) to. If they are
not equal, an error is thrown and no changes are made.
## AmountMath.make(brand, allegedValue)
-- **brand**: **[Brand](./brand.md)**
-- **allegedValue**: **[AmountValue](./ertp-data-types.md#amountvalue)**
-- Returns: **[Amount](./ertp-data-types.md#amount)**
+- **brand**: **[Brand](./brand)**
+- **allegedValue**: **[AmountValue](./ertp-data-types#amountvalue)**
+- Returns: **[Amount](./ertp-data-types#amount)**
Creates an **Amount** from a given **Brand** and **AmountValue**.
@@ -29,8 +29,8 @@ const bid = AmountMath.make(quatloosBrand, 300n);
```
## AmountMath.coerce(brand, allegedAmount)
-- **brand**: **[Brand](./brand.md)**
-- **allegedAmount**: **[Amount](./ertp-data-types.md#amount)**
+- **brand**: **[Brand](./brand)**
+- **allegedAmount**: **[Amount](./ertp-data-types#amount)**
- Returns: **Amount**
Verifies that an **Amount** is for the specified *brand* and returns an equivalent **Amount**.
@@ -41,9 +41,9 @@ const verifiedAmount = AmountMath.coerce(quatloosBrand, bid);
```
## AmountMath.getValue(brand, amount)
-- **brand**: **[Brand](./brand.md)**
-- **amount**: **[Amount](./ertp-data-types.md#amount)**
-- Returns: **[AmountValue](./ertp-data-types.md#amountvalue)**
+- **brand**: **[Brand](./brand)**
+- **amount**: **[Amount](./ertp-data-types#amount)**
+- Returns: **[AmountValue](./ertp-data-types#amountvalue)**
Returns the **AmountValue** from the given **Amount**.
@@ -55,9 +55,9 @@ AmountMath.getValue(quatloosBrand, quatloos123);
```
## AmountMath.makeEmpty(brand, assetKind)
-- **brand**: **[Brand](./brand.md)**
-- **assetKind**: **[AssetKind](./ertp-data-types.md#assetkind)**
-- Returns: **[Amount](./ertp-data-types.md#amount)**
+- **brand**: **[Brand](./brand)**
+- **assetKind**: **[AssetKind](./ertp-data-types#assetkind)**
+- Returns: **[Amount](./ertp-data-types#amount)**
Returns the **Amount** representing an empty **Amount** for the *brand* parameter's
**Brand**. This is the identity element for **AmountMath.add()**
@@ -70,7 +70,7 @@ const empty = AmountMath.makeEmpty(quatloosBrand, AssetKind.NAT);
```
## AmountMath.makeEmptyFromAmount(amount)
-- **amount**: **[Amount](./ertp-data-types.md#amount)**
+- **amount**: **[Amount](./ertp-data-types#amount)**
- Returns: **Amount**
Returns an empty **Amount** for the **Brand** of the *amount* parameter.
@@ -83,8 +83,8 @@ const zeroQuatloos = AmountMath.makeEmptyFromAmount(bid);
```
## AmountMath.isEmpty(amount, brand?)
-- **amount**: **[Amount](./ertp-data-types.md#amount)**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **amount**: **[Amount](./ertp-data-types#amount)**
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Boolean**
Returns **true** if the **Amount** is empty. Otherwise returns **false**.
@@ -103,12 +103,12 @@ const result = AmountMath.isEmpty(quatloos1);
```
## AmountMath.isGTE(leftAmount, rightAmount, brand?)
-- **leftAmount**: **[Amount](./ertp-data-types.md#amount)**
+- **leftAmount**: **[Amount](./ertp-data-types#amount)**
- **rightAmount**: **Amount**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Boolean**
-Returns **true** if the **[AmountValue](./ertp-data-types.md#amountvalue)** of *leftAmount* is greater than or equal to
+Returns **true** if the **[AmountValue](./ertp-data-types#amountvalue)** of *leftAmount* is greater than or equal to
the **AmountValue** of *rightAmount*.
Both **Amount** arguments must have the same **Brand**.
@@ -136,19 +136,19 @@ AmountMath.isGTE(quatloos5, quatloos5);
```
## AmountMath.isEqual(leftAmount, rightAmount, brand?)
-- **leftAmount**: **[Amount](./ertp-data-types.md#amount)**
+- **leftAmount**: **[Amount](./ertp-data-types#amount)**
- **rightAmount**: **Amount**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Boolean**
-Returns **true** if the **[AmountValue](./ertp-data-types.md#amountvalue)** of *leftAmount* is equal to
+Returns **true** if the **[AmountValue](./ertp-data-types#amountvalue)** of *leftAmount* is equal to
the **AmountValue** of *rightAmount*.
Both **Amount** arguments must have the same **Brand**.
If the optional *brand* argument doesn't match the **Amount**s' **Brand**, an error is thrown.
For non-fungible **AmountValues**, "equal to" depends on the value of the
-**Brand's** **[AssetKind](./ertp-data-types.md#assetkind)**.
+**Brand's** **[AssetKind](./ertp-data-types#assetkind)**.
For example, { 'seat 1', 'seat 2' } is considered
unequal to { 'seat 2' } because the number of elements differ.
@@ -171,9 +171,9 @@ AmountMath.isEqual(empty, quatloos10);
```
## AmountMath.add(leftAmount, rightAmount, brand?)
-- **leftAmount**: **[Amount](./ertp-data-types.md#amount)**
+- **leftAmount**: **[Amount](./ertp-data-types#amount)**
- **rightAmount**: **Amount**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Amount**
Returns a new **Amount** that is the combination of *leftAmount* and *rightAmount*.
@@ -181,7 +181,7 @@ Both **Amount** arguments must have the same **Brand**.
If the optional *brand* argument doesn't match the **Amount**s' **Brand**, an error is thrown.
-For fungible **Amounts** this means adding their **[AmountValues](./ertp-data-types.md#amountvalue)**. For non-fungible
+For fungible **Amounts** this means adding their **[AmountValues](./ertp-data-types#amountvalue)**. For non-fungible
**Amounts**, it usually means including all of the elements from *leftAmount*
and *rightAmount*.
@@ -199,9 +199,9 @@ const combinedList = AmountMath.add(listAmountA, listAmountB);
```
## AmountMath.subtract(leftAmount, rightAmount, brand?)
-- **leftAmount**: **[Amount](./ertp-data-types.md#amount)**
+- **leftAmount**: **[Amount](./ertp-data-types#amount)**
- **rightAmount**: **Amount**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Amount**
Returns a new **Amount** that is the *leftAmount* minus the *rightAmount* (i.e.,
@@ -232,9 +232,9 @@ const badList = AmountMath.subtract(listAmountA, listAmountB)
```
## AmountMath.min(x, y, brand?)
-- **x**: **[Amount](./ertp-data-types.md#amount)**
+- **x**: **[Amount](./ertp-data-types#amount)**
- **y**: **Amount**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Amount**
Returns the minimum value between *x* and *y*.
@@ -252,9 +252,9 @@ const comparisonResult = AmountMath.min(smallerAmount, largerAmount);
```
## AmountMath.max(x, y, brand?)
-- **x**: **[Amount](./ertp-data-types.md#amount)**
+- **x**: **[Amount](./ertp-data-types#amount)**
- **y**: **Amount**
-- **brand**: **[Brand](./brand.md)** - Optional, defaults to **undefined**.
+- **brand**: **[Brand](./brand)** - Optional, defaults to **undefined**.
- Returns: **Amount**
Returns the maximum value between *x* and *y*.
@@ -276,9 +276,9 @@ const comparisonResult = AmountMath.max(smallerAmount, largerAmount);
The following methods on other ERTP components and objects also either operate
on or return an **Amount** or **AssetKind**.
-- [**anIssuer.getAmountOf()**](./issuer.md#anissuer-getamountof-payment)
+- [**anIssuer.getAmountOf()**](./issuer#anissuer-getamountof-payment)
- Returns the **Amount** of a **Payment**.
-- [**anIssuer.getAssetKind()**](./issuer.md#anissuer-getassetkind)
+- [**anIssuer.getAssetKind()**](./issuer#anissuer-getassetkind)
- Returns the **AssetKind** of the **Issuer**'s associated math helpers.
-- [**zcf.getAssetKind()**](/reference/zoe-api/zoe-contract-facet.md#zcf-getassetkind-brand)
+- [**zcf.getAssetKind()**](/reference/zoe-api/zoe-contract-facet#zcf-getassetkind-brand)
- Returns the **AssetKind** associated with a **Brand**.
diff --git a/main/reference/ertp-api/brand.md b/main/reference/ertp-api/brand.md
index 157ae0a00..b550677cb 100644
--- a/main/reference/ertp-api/brand.md
+++ b/main/reference/ertp-api/brand.md
@@ -1,8 +1,8 @@
# Brand Object
-A **Brand** identifies the asset type of the **[Issuer](./issuer.md)** and **[Mint](./mint.md)**
+A **Brand** identifies the asset type of the **[Issuer](./issuer)** and **[Mint](./mint)**
associated with the **Brand**. A given **Brand** has a one-to-one relationship
-with an **Issuer** and a **Mint**, and a one-to-many relationship with **[Purses](./purse.md)**
-and **[Payments](./payment.md)**.
+with an **Issuer** and a **Mint**, and a one-to-many relationship with **[Purses](./purse)**
+and **[Payments](./payment)**.
For example, if you were to create a **Brand** that uses *Quatloos*:
- There would be exactly one *Quatloos* **Issuer**.
@@ -16,14 +16,14 @@ will always be associated with
the *Quatloos* **Mint** and *Quatloos* **Issuer**.
## aBrand.isMyIssuer(allegedIssuer)
-- **allegedIssuer**: **[Issuer](./issuer.md)**
+- **allegedIssuer**: **[Issuer](./issuer)**
- Returns: **Boolean**
Returns **true** if *allegedIssuer* is the **Brand**'s **Issuer**. Returns **false** if it's not.
Note that a **Brand** from an untrusted source can misrepresent its association with
an **Issuer**. The claim should be cross-checked using the **Issuer's**
-[**anIssuer.getBrand()**](./issuer.md#anissuer-getbrand) method for mutual agreement.
+[**anIssuer.getBrand()**](./issuer#anissuer-getbrand) method for mutual agreement.
```js
const isIssuer = brand.isMyIssuer(issuer);
@@ -36,7 +36,7 @@ Returns the alleged name of the **Brand**.
An alleged name is a human-readable string name of a type of digital asset.
It should not be trusted as accurate since there is no public registry or
-expectation of uniqueness. This means there can be multiple **[Issuers](./issuer.md)**, **[Mints](./mint.md)**, or **Brands**
+expectation of uniqueness. This means there can be multiple **[Issuers](./issuer)**, **[Mints](./mint)**, or **Brands**
with the same alleged name, and thus the name by itself does not uniquely
identify an **Issuer**. Rather, the **Brand** object does that.
@@ -49,12 +49,12 @@ const name = brand.getAllegedName();
```
## aBrand.getDisplayInfo()
-- Returns: **[DisplayInfo](./ertp-data-types.md#displayinfo)**
+- Returns: **[DisplayInfo](./ertp-data-types#displayinfo)**
Returns the **DisplayInfo** associated with the **Brand**.
You use a **DisplayInfo** object at the dapp and UI levels to correctly
-display **[Amounts](./ertp-data-types.md#amount)**. For fungible tokens, use the **decimalPlaces** property
+display **[Amounts](./ertp-data-types#amount)**. For fungible tokens, use the **decimalPlaces** property
to display their value in the commonly used denomination, rather than
the smallest denomination used for financial accounting (e.g.,
displaying in dollars rather than cents).
@@ -64,7 +64,7 @@ const quatloosDisplay = quatloosBrand.getDisplayInfo();
```
## aBrand.getAmountShape()
-- Returns: **[AmountShape](./ertp-data-types.md#amountshape)**
+- Returns: **[AmountShape](./ertp-data-types#amountshape)**
Returns the **AmountShape** for a **Brand** associated with a non-fungible asset.
@@ -72,7 +72,7 @@ Returns the **AmountShape** for a **Brand** associated with a non-fungible asset
## Related Methods
The following methods on other ERTP components are also related to the **Brand** object.
-- [**anIssuer.getBrand()**](./issuer.md#anissuer-getbrand): Returns
+- [**anIssuer.getBrand()**](./issuer#anissuer-getbrand): Returns
the **Brand** for the **Issuer**.
-- [**aPayment.getAllegedBrand()**](./payment.md#apayment-getallegedbrand): Returns
+- [**aPayment.getAllegedBrand()**](./payment#apayment-getallegedbrand): Returns
the **Payment**'s alleged **Brand**.
diff --git a/main/reference/ertp-api/ertp-data-types.md b/main/reference/ertp-api/ertp-data-types.md
index 0e4c01d07..31ed34fd4 100644
--- a/main/reference/ertp-api/ertp-data-types.md
+++ b/main/reference/ertp-api/ertp-data-types.md
@@ -5,8 +5,8 @@ ERTP introduces and uses several data types.
## Amount
An **Amount** is a description of digital assets, answering the
-questions "how much?" (its **[AmountValue](#amountvalue)**) and "of what kind?" (its **[Brand](./brand.md)**).
-The **[AmountMath](./amount-math.md)** object
+questions "how much?" (its **[AmountValue](#amountvalue)**) and "of what kind?" (its **[Brand](./brand)**).
+The **[AmountMath](./amount-math)** object
introduces a library of methods that can be used to manipulate and analyze **Amounts**.
Note that **Amounts** can describe either fungible or non-fungible assets.
@@ -21,11 +21,11 @@ someAmount: {
## AmountShape
An **AmountShape** is a description of non-fungible digital assets. Similar to **[Amount](#amount)**,
-**AmountShape** has 2 properties: a **[Brand](./brand.md)**, which states what kind of asset this is,
+**AmountShape** has 2 properties: a **[Brand](./brand)**, which states what kind of asset this is,
and a **ValueShape**, which is an object containing however many properties are required to describe
this non-fungible asset. Note that an asset's **ValueShape** is defined by the *elementShape* parameter
-when the asset's **[Issuer](./issuer.md)** is created via the
-**[makeIssuerKit()](./issuer.md#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)** function.
+when the asset's **[Issuer](./issuer)** is created via the
+**[makeIssuerKit()](./issuer#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)** function.
```js
someAmountShape: {
@@ -41,7 +41,7 @@ An **AmountValue** is the part of an [Amount](#amount) that describes the value
that can be owned or shared: how much, how many, or a description of a unique asset, such as
$3, Pixel(3,2), or “Seat J12 for the show September 27th at 9:00pm”.
For a fungible **Amount**, the **AmountValue** is usually a non-negative **BigInt** such as `10n` or `137n`.
-For a non-fungible **Amount**, the **AmountValue** might be a [CopySet](/guides/js-programming/far.md#pass-styles-and-harden) containing strings naming particular rights or objects representing the rights directly.
+For a non-fungible **Amount**, the **AmountValue** might be a [CopySet](/guides/js-programming/far#pass-styles-and-harden) containing strings naming particular rights or objects representing the rights directly.
AmountValues must be [Keys](/glossary/#key).
## AssetKind
@@ -54,10 +54,10 @@ There are several kinds of Assets.
- **AssetKind.COPY_BAG** : Used with non-fungible assets where there can be duplicates. (e.g., weapons in a computer game). **AmountValues** are arrays of objects.
Even though very different mathematical processes are performed,
-**[AmountMath](./amount-math.md)** methods work for all kinds of assets.
+**[AmountMath](./amount-math)** methods work for all kinds of assets.
-Use **[makeIssuerKit()](./issuer.md#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)** to specify which **AssetKind**
-your contract uses. See the **[Issuer](./issuer.md)** documentation for details on how to use this method.
+Use **[makeIssuerKit()](./issuer#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)** to specify which **AssetKind**
+your contract uses. See the **[Issuer](./issuer)** documentation for details on how to use this method.
```js
import { AssetKind, makeIssuerKit } from '@agoric/ertp';
@@ -67,7 +67,7 @@ makeIssuerKit('kitties', AssetKind.COPY_SET); // Defaults to undefined DisplayIn
## DisplayInfo
-A **DisplayInfo** data type is associated with a **[Brand](./brand.md)** and gives information about how
+A **DisplayInfo** data type is associated with a **[Brand](./brand)** and gives information about how
to display that **Brand**'s **[Amounts](#amount)**. **DisplayInfo** has one optional property,
**decimalPlaces**, which takes a non-negative integer value.
diff --git a/main/reference/ertp-api/index.md b/main/reference/ertp-api/index.md
new file mode 100644
index 000000000..55821085d
--- /dev/null
+++ b/main/reference/ertp-api/index.md
@@ -0,0 +1,31 @@
+# ERTP API
+
+The ERTP API supports the following objects:
+
+| Object | Description |
+| --- | --- |
+| [Issuer](./issuer) | The authority on what holds digital assets of its kind. |
+| [Mint](./mint) | Can issue new digital assets. |
+| [Brand](./brand) | Identifies the asset type of the associated **Issuer** and **Mint**. |
+| [Purse](./purse) | Holds digital assets. |
+| [Payment](./payment) | Holds digital assets that are in transit. |
+
+
+
+The ETRP API uses the following library:
+
+| Object | Description |
+| --- | --- |
+| [AmountMath](./amount-math) | The **AmountMath** object has several methods which can be used to manipulate and analyze **[Amounts](./ertp-data-types#amount)**. |
+
+
+The ERTP API introduces and uses the following data types:
+
+| Data Type | Description |
+| --- | --- |
+| [Amount](./ertp-data-types#amount) | Describes digital assets, specifying the number and **[Brand](./brand)** of assets. Note that **Amounts** can describe either fungible or non-fungible assets. |
+| [AmountShape](./ertp-data-types#amountshape) | Describes digital assets, specifying the properties and **[Brand](./brand)** of assets. |
+| [AmountValue](./ertp-data-types#amountvalue) | Describes how much of something there is. |
+| [AssetKind](./ertp-data-types#assetkind) | Specifies whether an **Amount** is fungible or non-fungible. |
+| [DisplayInfo](./ertp-data-types#displayinfo) | Specifies how to display a **Brand**'s **Amounts**. |
+
diff --git a/main/reference/ertp-api/issuer.md b/main/reference/ertp-api/issuer.md
index 89d1f96ba..d700b524d 100644
--- a/main/reference/ertp-api/issuer.md
+++ b/main/reference/ertp-api/issuer.md
@@ -1,13 +1,13 @@
# Issuer Object
An **Issuer** is the authority on what holds digital assets of its kind.
-While it cannot create new value by creating digital assets like a **[Mint](./mint.md)** can,
-it recognizes and identifies **[Purses](./purse.md)** and **[Payments](./payment.md)** that carry actual value.
+While it cannot create new value by creating digital assets like a **[Mint](./mint)** can,
+it recognizes and identifies **[Purses](./purse)** and **[Payments](./payment)** that carry actual value.
It can create empty **Purses** and transform **Payments** (by splitting,
combining, burning, or exclusively claiming them).
An **Issuer** has an unchangeable one-to-one relationship with the **Mint** and
-**[Brand](./brand.md)** that were created with it. For any **Brands** for which you will accept
+**[Brand](./brand)** that were created with it. For any **Brands** for which you will accept
**Payments** in, you should obtain its **Issuer** from a trusted source.
You can then rely on that **Issuer** as the authority to
validate an untrusted **Payment** of that **Brand**.
@@ -17,14 +17,14 @@ are ephemeral, so any object created there dies as soon as the script ends.
## makeIssuerKit(allegedName, assetKind?, displayInfo?, optShutdownWithFailure?, elementShape?)
- **allegedName**: **String**
-- **assetKind**: **[AssetKind](./ertp-data-types.md#assetkind)** - Optional, defaults to **AssetKind.NAT**.
-- **displayInfo**: **[DisplayInfo](./ertp-data-types.md#displayinfo)** - Optional, defaults to **undefined**.
+- **assetKind**: **[AssetKind](./ertp-data-types#assetkind)** - Optional, defaults to **AssetKind.NAT**.
+- **displayInfo**: **[DisplayInfo](./ertp-data-types#displayinfo)** - Optional, defaults to **undefined**.
- **optShutdownWithFailure** - Optional, defaults to **undefined**.
- **elementShape** - Optional, defaults to **undefined**.
- Returns **IssuerKit**. This is an object with three properties:
- **issuer**: **Issuer**
- - **mint**: **[Mint](./mint.md)**
- - **brand**: **[Brand](./brand.md)**
+ - **mint**: **[Mint](./mint)**
+ - **brand**: **[Brand](./brand)**
Creates and returns a new **Issuer** and its associated **Mint** and **Brand**.
All three are in unchangeable one-to-one relationships with each other.
@@ -35,12 +35,12 @@ is useful for debugging and double-checking assumptions, but should not be trust
The optional *assetKind* parameter specifies the kind of asset associated with the **Issuer** about
to be created. If no **AssetKind** argument is passed into the method, then the **Issuer**'s asset
-kind defaults to **AssetKind.NAT**. **[AmountMath](./amount-math.md)**'s methods work with all the
+kind defaults to **AssetKind.NAT**. **[AmountMath](./amount-math)**'s methods work with all the
kinds of assets, but exactly what math or manipulation is performed varies depending on
the **AssetKind**.
The optional *displayInfo* parameter tells the UI how to
-display **[Amounts](./ertp-data-types.md#amount)** of this **Brand**.
+display **[Amounts](./ertp-data-types#amount)** of this **Brand**.
The optional *optShutdownWithFailure* parameter should be used for mission-critical
**Issuers**. This parameter is a function that will stop the vat hosting the
@@ -49,7 +49,7 @@ The optional *optShutdownWithFailure* parameter should be used for mission-criti
The optional *elementShape* parameter is only used when creating an **Issuer** that
has a non-fungible asset associated with it. When used, the *elementShape* parameter is an object
with however many properties are required to describe the asset. This object sets the
-*valueShape's* properties of the asset's **[AmountShape](./ertp-data-types.md#amountshape)**.
+*valueShape's* properties of the asset's **[AmountShape](./ertp-data-types#amountshape)**.
```js
@@ -81,7 +81,7 @@ An alleged name is a human-readable string name
of a kind of digital asset. An alleged name
should not be trusted as accurate because there is
no public registry or expectation of uniqueness. This
-means there can be multiple **Issuers**, **[Mints](./mint.md)**, or **[Brands](./brand.md)** with the
+means there can be multiple **Issuers**, **[Mints](./mint)**, or **[Brands](./brand)** with the
same alleged name, and thus the name by itself does not
uniquely identify an **Issuer**. Rather, the **Brand** does that.
@@ -97,11 +97,11 @@ const quatloosIssuerAllegedName = quatloosIssuer.getAllegedName();
```
## anIssuer.getAssetKind()
-- Returns: **[AssetKind](./ertp-data-types.md#assetkind)**
+- Returns: **[AssetKind](./ertp-data-types#assetkind)**
Returns the kind of the **Issuer**'s asset.
-The **AssetKind** specifies what kind of values are used in **[Amounts](./ertp-data-types.md#amount)** for this **Issuer**.
+The **AssetKind** specifies what kind of values are used in **[Amounts](./ertp-data-types#amount)** for this **Issuer**.
```js
const { issuer: quatloosIssuer } = makeIssuerKit('quatloos');
@@ -111,12 +111,12 @@ moolaIssuer.getAssetKind(); // Returns 'copy_set', also known as 'AssetKind.COPY
```
## anIssuer.getAmountOf(payment)
-- **payment**: **[Payment](./payment.md)**
-- Returns: **[Amount](./ertp-data-types.md#amount)**
+- **payment**: **[Payment](./payment)**
+- Returns: **[Amount](./ertp-data-types#amount)**
Describes the **Payment**'s balance as an **Amount**. Because a **Payment** from an untrusted
source cannot be trusted to provide its own true value, the **Issuer** must be used to
-validate its **[Brand](./brand.md)** and report how much the returned **Amount** contains.
+validate its **[Brand](./brand)** and report how much the returned **Amount** contains.
```js
const { issuer: quatloosIssuer, mint: quatloosMint, brand: quatloosBrand } =
@@ -126,10 +126,10 @@ quatloosIssuer.getAmountOf(quatloosPayment); // returns an amount of 100 Quatloo
```
## anIssuer.getBrand()
-- Returns: **[Brand](./brand.md)**
+- Returns: **[Brand](./brand)**
Returns the **Brand** for the **Issuer**. The **Brand** indicates the kind of digital asset
-and is the same for the **Issuer**'s associated **[Mint](./mint.md)**, and any **[Purses](./purse.md)** and **[Payments](./payment.md)** of this particular
+and is the same for the **Issuer**'s associated **[Mint](./mint)**, and any **[Purses](./purse)** and **[Payments](./payment)** of this particular
kind. The **Brand** is not closely held, so this method should not be trusted to identify
an **Issuer** alone. Fake digital assets and amounts can use another **Issuer's** **Brand**.
@@ -140,9 +140,9 @@ const quatloosBrand = quatloosIssuer.getBrand();
```
## anIssuer.makeEmptyPurse()
-- Returns: **[Purse](./purse.md)**
+- Returns: **[Purse](./purse)**
-Makes and returns an empty **Purse** that holds assets of the **[Brand](./brand.md)** associated with the **Issuer**.
+Makes and returns an empty **Purse** that holds assets of the **[Brand](./brand)** associated with the **Issuer**.
```js
const { issuer: quatloosIssuer } = makeIssuerKit('quatloos');
@@ -151,8 +151,8 @@ const quatloosPurse = quatloosIssuer.makeEmptyPurse();
## **anIssuer.burn(payment, optAmount?)**
-- **payment**: **[Payment](./payment.md)**
-- **optAmount**: **[Amount](./ertp-data-types.md#amount)** - Optional.
+- **payment**: **[Payment](./payment)**
+- **optAmount**: **[Amount](./ertp-data-types#amount)** - Optional.
- Returns: **Amount**
@@ -178,8 +178,8 @@ const burntAmount = quatloosIssuer.burn(paymentToBurn, amountToBurn);
```
## anIssuer.claim(payment, optAmount?)
-- **payment**: **[Payment](./payment.md)**
-- **optAmount**: **[Amount](./ertp-data-types.md#amount)** - Optional.
+- **payment**: **[Payment](./payment)**
+- **optAmount**: **[Amount](./ertp-data-types#amount)** - Optional.
- Returns: **Payment**
Transfers all digital assets from *payment* to a new **Payment** and consumes the
@@ -202,8 +202,8 @@ const newPayment = quatloosIssuer.claim(originalPayment, amountToTransfer);
```
## anIssuer.combine(paymentsArray, optTotalAmount?)
-- **paymentsArray**: **Array<[Payment](./payment.md)>**
-- **optTotalAmount**: **[Amount](./ertp-data-types.md#amount)** - Optional.
+- **paymentsArray**: **Array<[Payment](./payment)>**
+- **optTotalAmount**: **[Amount](./ertp-data-types#amount)** - Optional.
- Returns: **Payment**
Combines multiple **Payments** into one new **Payment**. If any item in *paymentsArray* is
@@ -215,7 +215,7 @@ the total value of all **Payments** in *paymentsArray*
must equal *optTotalAmount*. If they don't, the method throws an error,
and the original **Payment** is unmodified.
-Each **Payment** in *paymentsArray* must be associated with the same **[Brand](./brand.md)** as the **Issuer**.
+Each **Payment** in *paymentsArray* must be associated with the same **[Brand](./brand)** as the **Issuer**.
```js
const { issuer: quatloosIssuer, mint: quatloosMint, brand: quatloosBrand } =
@@ -231,8 +231,8 @@ const combinedPayment = quatloosIssuer.combine(payments);
```
## anIssuer.split(payment, paymentAmountA)
-- **payment**: **[Payment](./payment.md)**
-- **paymentAmountA**: **[Amount](./ertp-data-types.md#amount)**
+- **payment**: **[Payment](./payment)**
+- **paymentAmountA**: **[Amount](./ertp-data-types#amount)**
- Returns: **Array<Payment>**
Splits a single **Payment** into two new **Payments**, A and B, according to *paymentAmountA*.
@@ -243,7 +243,7 @@ The original **Payment** is consumed and made unavailable for later use.
If *payment* is a promise, the operation proceeds after it resolves to a **Payment**.
-*payment* and *paymentAmountA* must both be associated with the same **[Brand](./brand.md)** as the **Issuer**.
+*payment* and *paymentAmountA* must both be associated with the same **[Brand](./brand)** as the **Issuer**.
```js
const { issuer: quatloosIssuer, mint: quatloosMint, brand: quatloosBrand } =
@@ -254,8 +254,8 @@ const [paymentA, paymentB] = quatloosIssuer.split(oldPayment, AmountMath.make(qu
```
## anIssuer.splitMany(payment, amountArray)
-- **payment**: **[Payment](./payment.md)**
-- **amountArray**: **Array<[Amount](./ertp-data-types.md#amount)>**
+- **payment**: **[Payment](./payment)**
+- **amountArray**: **Array<[Amount](./ertp-data-types#amount)>**
- Returns: **Array<Payment>**
Splits a single **Payment** into multiple **Payments**.
@@ -266,7 +266,7 @@ The original **Payment** is consumed and made unavailable for later use.
If *payment* is a promise, the operation proceeds after it resolves to a **Payment**.
If the **Amounts** in *amountArray* don't add up to the value of *payment*, the operation fails.
-*payment* and each **Amount** in *amountArray* must be associated with the same **[Brand](./brand.md)** as **Issuer**.
+*payment* and each **Amount** in *amountArray* must be associated with the same **[Brand](./brand)** as **Issuer**.
```js
const { issuer: quatloosIssuer, mint: quatloosMint, brand: quatloosBrand } =
@@ -288,7 +288,7 @@ quatloosIssuer.splitMany(payment, badAmounts);
```
## anIssuer.isLive(payment)
-- **payment**: **[Payment](./payment.md)**
+- **payment**: **[Payment](./payment)**
- Returns: **Boolean**
Returns **true** if the *payment* was created by the **Issuer** and is available for use
diff --git a/main/reference/ertp-api/mint.md b/main/reference/ertp-api/mint.md
index 679d66092..c12ca26bd 100644
--- a/main/reference/ertp-api/mint.md
+++ b/main/reference/ertp-api/mint.md
@@ -2,14 +2,14 @@
Only a **Mint** can issue new digital assets.
-A **Mint** has a one-to-one relationship with both an **[Issuer](./issuer.md)** and a **[Brand](./brand.md)**.
+A **Mint** has a one-to-one relationship with both an **[Issuer](./issuer)** and a **[Brand](./brand)**.
So it can only mint new assets of that **Brand** and is the only **Mint** that can mint
new assets of that **Brand**.
-**Mints** are created by cqlling the **[makeIssuerKit()](./issuer.md#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)** function. See the **[Issuer](./issuer.md)** documentation for detailed information about how to use this function.
+**Mints** are created by cqlling the **[makeIssuerKit()](./issuer#makeissuerkit-allegedname-assetkind-displayinfo-optshutdownwithfailure-elementshape)** function. See the **[Issuer](./issuer)** documentation for detailed information about how to use this function.
## aMint.getIssuer()
-- Returns: **[Issuer](./issuer.md)**
+- Returns: **[Issuer](./issuer)**
Returns the **Issuer** uniquely associated with this **Mint**. From its creation, a **Mint** is always
in an unchangeable one-to-one relationship with a particular **Issuer**.
@@ -23,10 +23,10 @@ issuer === quatloosMintIssuer;
```
## aMint.mintPayment(newAmount)
-- **newAmount**: **[Amount](./ertp-data-types.md#amount)**
-- Returns: **[Payment](./payment.md)**
+- **newAmount**: **[Amount](./ertp-data-types#amount)**
+- Returns: **[Payment](./payment)**
-Creates and returns new digital assets of the **Mint**'s associated **[Brand](./brand.md)**.
+Creates and returns new digital assets of the **Mint**'s associated **[Brand](./brand)**.
From its creation, a **Mint** is always in an unchangeable
one-to-one relationship with a **Brand**.
diff --git a/main/reference/ertp-api/payment.md b/main/reference/ertp-api/payment.md
index 54bf0085c..652cf4998 100644
--- a/main/reference/ertp-api/payment.md
+++ b/main/reference/ertp-api/payment.md
@@ -1,6 +1,6 @@
# Payment Object
A **Payment** holds digital assets that are in transit or
-expected to soon be in transit. It can be deposited in **[Purses](./purse.md)**,
+expected to soon be in transit. It can be deposited in **[Purses](./purse)**,
split into or combined with multiple **Payments**, or claimed (i.e., getting
an exclusive **Payment** and revoking access from anyone else).
@@ -16,22 +16,22 @@ take out, say, only 3 *Quatloos* from it.
However, you can split a **Payment** into multiple **Payments**. For example, you could split a
10 *Quatloos* **Payment** into two new **Payments** of 3 *Quatloos* and 7 *Quatloos* by calling the
-**[anIssuer.split()](./issuer.md#anissuer-split-payment-paymentamounta)** method which consumes the
+**[anIssuer.split()](./issuer#anissuer-split-payment-paymentamounta)** method which consumes the
original 10 *Quatloos* **Payment** and creates two new smaller **Payments**.
**Payments** are often received from other actors. Since they are not self-verifying,
-you cannot trust **Payments**. To get the verified balance of a **Payment**, call the **[anIssuer.getAmountOf()](./issuer.md#anissuer-getamountof-payment)** method.
+you cannot trust **Payments**. To get the verified balance of a **Payment**, call the **[anIssuer.getAmountOf()](./issuer#anissuer-getamountof-payment)** method.
To convert a **Payment** into a new **Purse**:
-1. Get the **Payment**'s trusted **[Issuer](./issuer.md)**.
+1. Get the **Payment**'s trusted **[Issuer](./issuer)**.
2. Use the **Issuer** to create an empty **Purse**.
3. Deposit the **Payment** into the new **Purse**.
-**[aPurse.deposit()](./purse.md#apurse-deposit-payment-optamount)** consumes the **Payment**,
+**[aPurse.deposit()](./purse#apurse-deposit-payment-optamount)** consumes the **Payment**,
making it unavailable for later use.
## aPayment.getAllegedBrand()
-- Returns: **[Brand](./brand.md)**
+- Returns: **[Brand](./brand)**
Returns the **Brand** indicating the kind of digital asset this **Payment** purports to be.
Because **Payments** are not trusted, any method calls on them
@@ -49,25 +49,25 @@ const allegedBrand = payment.getAllegedBrand();
The following methods on other ERTP components either operate
on or return a **Payment**.
-- [**anIssuer.burn()**](./issuer.md#anissuer-burn-payment-optamount)
+- [**anIssuer.burn()**](./issuer#anissuer-burn-payment-optamount)
- Destroys all of the digital assets in the **Payment**.
-- [**anIssuer.claim()**](./issuer.md#anissuer-claim-payment-optamount)
+- [**anIssuer.claim()**](./issuer#anissuer-claim-payment-optamount)
- Transfers all digital assets from *payment* to a new **Payment**.
-- [**anIssuer.combine()**](./issuer.md#anissuer-combine-paymentsarray-opttotalamount)
+- [**anIssuer.combine()**](./issuer#anissuer-combine-paymentsarray-opttotalamount)
- Combines multiple **Payments** into one new **Payment**.
-- [**anIssuer.getAmountOf()**](./issuer.md#anissuer-getamountof-payment)
+- [**anIssuer.getAmountOf()**](./issuer#anissuer-getamountof-payment)
- Describes the **Payment**'s balance as an **Amount**.
-- [**anIssuer.isLive()**](./issuer.md#anissuer-islive-payment)
+- [**anIssuer.isLive()**](./issuer#anissuer-islive-payment)
- Returns **true** if the **Payment** was created by the **Issuer** and is available for use (i.e., has not been consumed or burned).
-- [**anIssuer.split()**](./issuer.md#anissuer-split-payment-paymentamounta)
+- [**anIssuer.split()**](./issuer#anissuer-split-payment-paymentamounta)
- Splits a single **Payment** into two new **Payments**.
-- [**anIssuer.splitMany()**](./issuer.md#anissuer-splitmany-payment-amountarray)
+- [**anIssuer.splitMany()**](./issuer#anissuer-splitmany-payment-amountarray)
- Split a single **Payment** into multiple **Payments**.
-- [**aMint.mintPayment()**](./mint.md#amint-mintpayment-newamount)
+- [**aMint.mintPayment()**](./mint#amint-mintpayment-newamount)
- Create new digital assets of the **Mint**'s associated **Brand**.
-- [**aPurse.deposit()**](./purse.md#apurse-deposit-payment-optamount)
+- [**aPurse.deposit()**](./purse#apurse-deposit-payment-optamount)
- Deposits all the contents of *payment* into the **Purse**.
-- [**aPurse.getDepositFacet()**](./purse.md#apurse-getdepositfacet)
+- [**aPurse.getDepositFacet()**](./purse#apurse-getdepositfacet)
- Creates and returns a new deposit-only facet of the **Purse** that allows arbitrary other parties to deposit **Payments** into the **Purse**.
-- [**aPurse.withdraw()**](./purse.md#apurse-withdraw-amount)
+- [**aPurse.withdraw()**](./purse#apurse-withdraw-amount)
- Withdraws the *amount* of specified digital assets from **Purse** into a new **Payment**.
diff --git a/main/reference/ertp-api/purse.md b/main/reference/ertp-api/purse.md
index 706b4bb71..af1a96de8 100644
--- a/main/reference/ertp-api/purse.md
+++ b/main/reference/ertp-api/purse.md
@@ -1,6 +1,6 @@
# Purse Object
-**Purses** hold digital assets. They are created to hold assets of a single **[Brand](./brand.md)**,
+**Purses** hold digital assets. They are created to hold assets of a single **[Brand](./brand)**,
and the **Brand** that the **Purse** holds cannot be changed. For example, if you were to create a **Purse** that holds *Quatloos*, that **Purse** wouldn't ever be able to hold *Moola*, theater
tickets, or any other non-*Quatloo* asset type.
@@ -13,8 +13,8 @@ While each **Purse** can only hold assets of one **Brand**, any number of **Purs
created that hold that **Brand**. So you could have, say, three *Quatloos* **Purses**, your
friend Alice could have eight *Quatloos* **Purses**, and so on.
-**Purses** are created by calling the **[anIssuer.makeEmptyPurse()](./issuer.md#anissuer-makeemptypurse)**
-method on the **[Issuer](./issuer.md)** associated with the **Brand** of assets you want the
+**Purses** are created by calling the **[anIssuer.makeEmptyPurse()](./issuer#anissuer-makeemptypurse)**
+method on the **[Issuer](./issuer)** associated with the **Brand** of assets you want the
new **Purse** to hold.
```js
@@ -28,15 +28,15 @@ You change a **Purse**'s balance by calling either
a fungible currency means it has a value of 0. If it holds a non-fungible asset (e.g., theater tickets),
then the **Purse** simply doesn't contain any assets if it's empty.
-Unlike **[Payments](./payment.md)**, **Purses** are not meant to be sent to others.
+Unlike **[Payments](./payment)**, **Purses** are not meant to be sent to others.
To transfer digital assets, you should withdraw a **Payment** from a **Purse** and
send the **Payment** to another party.
## aPurse.getCurrentAmount()
-- Returns: **[Amount](./ertp-data-types.md#amount)**
+- Returns: **[Amount](./ertp-data-types#amount)**
Returns the **Purse**'s current balance as an **Amount**.
-The returned **Amount** **[AmountValue](./ertp-data-types.md#amountvalue)** might be empty, and might be different the next time you
+The returned **Amount** **[AmountValue](./ertp-data-types#amountvalue)** might be empty, and might be different the next time you
call **aPurse.getCurrentAmount()** on the same **Purse** if assets have been deposited or
withdrawn in the interim.
@@ -50,10 +50,10 @@ const currentBalance = quatloosPurse.getCurrentAmount();
```
## aPurse.getCurrentAmountNotifier()
-- Returns: **Notifier<[Amount](./ertp-data-types.md#amount)>**
+- Returns: **Notifier<[Amount](./ertp-data-types#amount)>**
Returns a lossy notifier for changes to this **Purse**'s balance. For more details,
-see [Notifiers](/guides/js-programming/notifiers.md).
+see [Notifiers](/guides/js-programming/notifiers).
```js
const notifier = purse.getCurrentAmountNotifier();
@@ -66,8 +66,8 @@ const checkNotifier = async () => {
```
## aPurse.deposit(payment, optAmount?)
-- **payment**: **[Payment](./payment.md)**
-- **optAmount**: **[Amount](./ertp-data-types.md#amount)** - Optional.
+- **payment**: **[Payment](./payment)**
+- **optAmount**: **[Amount](./ertp-data-types#amount)** - Optional.
- Returns: **Amount**
Deposit all the contents of *payment* into the **Purse**, returning an **Amount** describing the
@@ -102,8 +102,8 @@ const depositAmountB = quatloosPurse.deposit(secondPayment, quatloos123);
## aPurse.withdraw(amount)
-- **amount**: **[Amount](./ertp-data-types.md#amount)**
-- Returns: **[Payment](./payment.md)**
+- **amount**: **[Amount](./ertp-data-types#amount)**
+- Returns: **[Payment](./payment)**
Withdraws the specified **Amount** of digital assets from the **Purse** into a new **Payment** object.
@@ -131,11 +131,11 @@ purse.getCurrentAmount();
```
## aPurse.getAllegedBrand()
-- Returns: **[Brand](./brand.md)**
+- Returns: **[Brand](./brand)**
Returns an alleged brand (Note: a **Brand**, not a **String** as **allegedName()** methods do),
indicating what kind of digital asset the **Purse** purports to hold. This can identify the
-**Purse**'s **Brand** if the **Purse** was made by a trusted **[Issuer](./issuer.md)** using **[anIssuer.makeEmptyPurse()](./issuer.md#anissuer-makeemptypurse)**.
+**Purse**'s **Brand** if the **Purse** was made by a trusted **[Issuer](./issuer)** using **[anIssuer.makeEmptyPurse()](./issuer#anissuer-makeemptypurse)**.
```js
const purseBrand = quatloosPurse.getAllegedBrand();
@@ -145,11 +145,11 @@ const purseBrand = quatloosPurse.getAllegedBrand();
- Returns: **DepositFacet**
Creates and returns a **DepositFacet**, a new deposit-only facet of the **Purse** that allows
-other parties to deposit **[Payments](./payment.md)** into the **Purse** without the ability
+other parties to deposit **[Payments](./payment)** into the **Purse** without the ability
to check the **Purse's** balance or withdraw from it.
This makes it a safe way to let other people send you **Payments**.
-You can only deposit a **Payment** into a **DepositFacet** that's the same **[Brand](./brand.md)** as the original **Purse**.
+You can only deposit a **Payment** into a **DepositFacet** that's the same **[Brand](./brand)** as the original **Purse**.
```js
const depositOnlyFacet = purse.getDepositFacet();
@@ -169,8 +169,8 @@ To add assets to a **Purse** directly, you use **aPurse.deposit()**. To add asse
to a **Purse** via its **DepositFacet**, you use **aDepositFacet.receive()**.
## aDepositFacet.receive(payment, optAmount?)
-- **payment**: **[Payment](./payment.md)**
-- **optAmount**: **[Amount](./ertp-data-types.md#amount)** - Optional.
+- **payment**: **[Payment](./payment)**
+- **optAmount**: **[Amount](./ertp-data-types#amount)** - Optional.
- Returns **Amount**
The **DepositFacet** takes the **Payment** and adds it to the balance of the **DepositFacet**'s associated **Purse**.
diff --git a/main/reference/repl/board.md b/main/reference/repl/board.md
index a7445b869..8944cf601 100644
--- a/main/reference/repl/board.md
+++ b/main/reference/repl/board.md
@@ -20,7 +20,7 @@ This means anyone can access any Board-stored value. The Board is public,
not private.
Note that when calling from the REPL's `home` object, you must use
-the [`E` syntax](/guides/js-programming/eventual-send.md)
+the [`E` syntax](/guides/js-programming/eventual-send)
as shown below.
## `E(home.board).getId(value)`
diff --git a/main/reference/repl/README.md b/main/reference/repl/index.md
similarity index 89%
rename from main/reference/repl/README.md
rename to main/reference/repl/index.md
index d31ab1a41..b47acb360 100644
--- a/main/reference/repl/README.md
+++ b/main/reference/repl/index.md
@@ -69,39 +69,39 @@ Several `home` objects are either for internal Agoric use only or have been depr
are listed together in the final section. External developers should ignore them and not try to use
them.
-### [`wallet`](../wallet-api.md)
+### [`wallet`](../wallet-api/)
Holds on-chain digital assets and object capabilities on behalf of the user.
The header link takes you to the standard non-REPL specific `wallet` API documentation. When calling
`wallet` API methods from the REPL, `wallet` must be prefaced by `home.` and use `E()`. For
example, `E(home.wallet).getPurses()`. [Full Wallet API documentation.](/guides/wallet/)
-### [`chainTimerService`](./timerServices.md)
-On-chain time authority used to schedule events. [Full `chainTimerService` documentation.](./timerServices.md)
+### [`chainTimerService`](./timerServices)
+On-chain time authority used to schedule events. [Full `chainTimerService` documentation.](./timerServices)
-### [`localTimerService`](./timerServices.md)
-Local off-chain time authority used to schedule events. [Full `localTimerService` documentation.](./timerServices.md)
+### [`localTimerService`](./timerServices)
+Local off-chain time authority used to schedule events. [Full `localTimerService` documentation.](./timerServices)
-### [`board`](./board.md)
-Shared on-chain location where users can post generally accessible values. [Full `board` documentation.](./board.md)
+### [`board`](./board)
+Shared on-chain location where users can post generally accessible values. [Full `board` documentation.](./board)
-### [`ibcport`](./networking.md)
+### [`ibcport`](./networking)
IBC implementation that lets vats open and close listening ports,
connect and disconnect to/from remote ports, and send and receive
-data over those connections. [Full `ibcport` documentation.](./networking.md)
+data over those connections. [Full `ibcport` documentation.](./networking)
-### [`zoe`](../zoe-api/zoe.md)
+### [`zoe`](../zoe-api/zoe)
Deploy and interact with smart contracts. Zoe protects smart contract users by escrowing
digital assets and guaranteeing users get either what they want or get a refund of what
they escrowed. Even if the contract is buggy or malicious. The header link takes you to the
standard, non-REPL specific, `zoe` API documentation. When calling any of the `zoe` API
methods from the REPL, `zoe` must be prefaced by `home.` and use `E()`. For
-example, `E(home.zoe).getFoo()`. [Full Zoe API documentation.](../zoe-api/zoe.md)
+example, `E(home.zoe).getFoo()`. [Full Zoe API documentation.](../zoe-api/zoe)
-### [`priceAuthority`](./priceAuthority.md)
-Get price quotes for pairs of digital assets. [Full `priceAuthority` documentation.](./priceAuthority.md)
+### [`priceAuthority`](./priceAuthority)
+Get price quotes for pairs of digital assets. [Full `priceAuthority` documentation.](./priceAuthority)
-### [`scratch`](./scratch.md)
-An off-chain, private, place to store key-value pairs on your ag-solo for later use. [Full `scratch` documentation.](./scratch.md)
+### [`scratch`](./scratch)
+An off-chain, private, place to store key-value pairs on your ag-solo for later use. [Full `scratch` documentation.](./scratch)
### Deprecated and Internal-Only Objects
@@ -109,7 +109,7 @@ An off-chain, private, place to store key-value pairs on your ag-solo for later
- `faucet`: Internal for chain setup.
- `http`: `api/deploy.js` uses this to install new HTTP and WebSocket handlers in an
ag-solo. You should not need to use it.
-- `network`: Privileged object for internal use. [Full Network documentation.](./networking.md)
+- `network`: Privileged object for internal use. [Full Network documentation.](./networking)
- `plugin`: Privileged object for internal use.
- `priceAuthorityAdmin`: Privileged object for internal use.
- `registrar`: Deprecated.
diff --git a/main/reference/repl/networking.md b/main/reference/repl/networking.md
index 7dbb99e03..a77e5d85c 100644
--- a/main/reference/repl/networking.md
+++ b/main/reference/repl/networking.md
@@ -14,9 +14,9 @@ vaguely like the BSD socket API. This code can:
The type of connection is limited by the host in which the vat is running. Chain-based machines must operate in a platonic realm of replicated consensus, so their network options are limited to protocols like IBC, which allow one gestalt chain to talk to other chain-like entities. Each such entity is defined by an evolving set of consensus rules, which typically include a current set of validator public keys and a particular history of hashed block identifiers.
**CAVEAT:** IBC uses
-[Connection](https://github.com/cosmos/ibc/tree/main/spec/core/ics-003-connection-semantics/README.md)
+[Connection](https://github.com/cosmos/ibc/tree/main/spec/core/ics-003-connection-semantics/README)
to mean a chain-to-chain hop, and
-[Channel](https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics/README.md)
+[Channel](https://github.com/cosmos/ibc/tree/main/spec/core/ics-004-channel-and-packet-semantics/README)
to mean a Port-to-Port pathway through a series of hops.
This is unfortunate, because IBC "Channels" correspond most precisely to
TCP "connections", and most discussions of network APIs (including this one,
diff --git a/main/reference/repl/priceAuthority.md b/main/reference/repl/priceAuthority.md
index 51f78d97e..54460e613 100644
--- a/main/reference/repl/priceAuthority.md
+++ b/main/reference/repl/priceAuthority.md
@@ -4,7 +4,7 @@
triggers and notifiers for changes in the price.
`PriceAuthority` objects use timer services. You should be familiar with the objects
-and methods in the [REPL TimerService document](./timerServices.md)
+and methods in the [REPL TimerService document](./timerServices)
## Price quote objects
diff --git a/main/reference/repl/scratch.md b/main/reference/repl/scratch.md
index 8a231df7c..1ffd09b5a 100644
--- a/main/reference/repl/scratch.md
+++ b/main/reference/repl/scratch.md
@@ -2,7 +2,7 @@
You use `scratch` to save key-value pairs for later. It is only on the ag-solo and is not accessible from the chain, making it private to the ag-solo user. Since deploy scripts are ephemeral, use `scratch` to save objects from a deploy script for later scripts to use.
-Note that when calling from the REPL's home object, you must use the [E() syntax](/guides/js-programming/eventual-send.md) as shown below.
+Note that when calling from the REPL's home object, you must use the [E() syntax](/guides/js-programming/eventual-send) as shown below.
Keys can be anything.
diff --git a/main/reference/wallet-api.md b/main/reference/wallet-api.md
deleted file mode 100644
index a36072e8d..000000000
--- a/main/reference/wallet-api.md
+++ /dev/null
@@ -1,137 +0,0 @@
-# Wallet API
-
-You can interact with a Wallet via the JavaScript *REPL* (*Read-Eval-Print Loop*),
-which is visible at the bottom of the Wallet UI display.
-In the REPL, you send messages to `home.wallet`, which is the Wallet running on that
-page/process. Typing `E(home.wallet).foo()` in the REPL returns the names of all the Wallet
-API methods by the clever method of asking it to evaluate a non-existent API method and
-getting an error message listing all the valid methods.
-
-Running `agoric open --repl only` opens a browser tab that shows only the REPL, and not
-the combination of Wallet UI and REPL area. When issuing commands to the Wallet from the
-REPL, they must be of the form `E(home.wallet).
+
+
+
+
+
+
+
+
+ + Learn the basics of HardenedJS +
+ It's JavaScript with the safety you expect - see why MetaMask uses it to safely run their Snaps technology for 30M+ customers. ++ See the safety properties of our Zoe Framework +
+ From Offer Safety to the POLA, the Zoe Framework protects devs (and users) while writing your smart contract logic. +
+
+
+
+
+
+
+
+