@agoric/inter-protocol 0.15.0 → 0.16.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.15.0",
+  "version": "0.16.0",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -30,28 +30,28 @@
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
     "@agoric/assert": "^0.6.0",
-    "@agoric/ertp": "^0.16.1",
-    "@agoric/governance": "^0.10.1",
-    "@agoric/internal": "^0.3.1",
-    "@agoric/notifier": "^0.6.1",
-    "@agoric/store": "^0.9.1",
-    "@agoric/time": "^0.3.1",
-    "@agoric/vat-data": "^0.5.1",
-    "@agoric/vats": "^0.14.1",
-    "@agoric/zoe": "^0.26.1",
+    "@agoric/ertp": "^0.16.2",
+    "@agoric/governance": "^0.10.2",
+    "@agoric/internal": "^0.3.2",
+    "@agoric/notifier": "^0.6.2",
+    "@agoric/store": "^0.9.2",
+    "@agoric/time": "^0.3.2",
+    "@agoric/vat-data": "^0.5.2",
+    "@agoric/vats": "^0.15.0",
+    "@agoric/zoe": "^0.26.2",
     "@endo/captp": "^3.1.1",
     "@endo/eventual-send": "^0.17.2",
     "@endo/far": "^0.2.18",
     "@endo/marshal": "^0.8.5",
     "@endo/nat": "^4.1.27",
-    "agoric": "^0.20.0",
+    "agoric": "^0.21.0",
     "jessie.js": "^0.3.2"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "^0.10.1",
-    "@agoric/smart-wallet": "^0.5.1",
-    "@agoric/swingset-liveslots": "^0.10.1",
-    "@agoric/swingset-vat": "^0.32.1",
+    "@agoric/deploy-script-support": "^0.10.2",
+    "@agoric/smart-wallet": "^0.5.2",
+    "@agoric/swingset-liveslots": "^0.10.2",
+    "@agoric/swingset-vat": "^0.32.2",
     "@endo/bundle-source": "^2.5.1",
     "@endo/init": "^0.5.56",
     "@endo/promise-kit": "^0.2.56",
@@ -79,5 +79,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "676e947a6fba6e1bab0717ca7228824c32509bda"
+  "gitHead": "b66bf7c881ae462fcb617cd6e8d41b5c40ec58ef"
 }

package/scripts/init-core.js

@@ -132,7 +132,7 @@ export const defaultProposalBuilder = async (
   const {
     vaultFactoryControllerAddress = env.VAULT_FACTORY_CONTROLLER_ADDR,
     minInitialPoolLiquidity = env.MIN_INITIAL_POOL_LIQUIDITY,
-    endorsedUi,
+    referencedUi,
     anchorOptions: {
       anchorDenom = env.ANCHOR_DENOM,
       anchorDecimalPlaces = '6',
@@ -168,7 +168,7 @@ export const defaultProposalBuilder = async (
       {
         vaultFactoryControllerAddress,
         minInitialPoolLiquidity: optBigInt(minInitialPoolLiquidity),
-        endorsedUi,
+        referencedUi,
         anchorOptions,
         econCommitteeOptions,
         installKeys: {

package/scripts/start-local-chain.sh

@@ -55,7 +55,7 @@ make scenario2-setup-nobuild >>"$CHAIN_LOG" 2>&1
 echo "Starting the chain..."
 # use -economy target to get the kitchen sink
 # disable pruning to keep all history https://docs.desmos.network/fullnode/overview/
-make AGC_START_ARGS="--pruning=nothing" CHAIN_BOOTSTRAP_VAT_CONFIG=@agoric/vats/decentral-test-vaults-config.json scenario2-run-chain >>"$CHAIN_LOG" 2>&1 &
+make AGC_START_ARGS="--pruning=nothing" CHAIN_BOOTSTRAP_VAT_CONFIG=@agoric/vats/decentral-itest-vaults-config.json scenario2-run-chain >>"$CHAIN_LOG" 2>&1 &
 make wait-for-cosmos
 
 # xxx sleep to let it settle

package/src/auction/auctionBook.js

@@ -514,7 +514,11 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
               calcTargetRatio(),
             );
 
-            if (state.remainingProceedsGoal !== null) {
+            if (
+              state.remainingProceedsGoal !== null ||
+              // XXX use this as an indication that the auction is active
+              state.curAuctionPrice !== null
+            ) {
               const incrementToGoal = state.startProceedsGoal
                 ? AmountMath.subtract(nextProceedsGoal, state.startProceedsGoal)
                 : nextProceedsGoal;
@@ -625,7 +629,11 @@ export const prepareAuctionBook = (baggage, zcf, makeRecorderKit) => {
             Fail`capturedPriceForRound must be set before each round`;
           assert(capturedPriceForRound);
 
-          trace('set startPrice', capturedPriceForRound);
+          trace(
+            'set startPrice',
+            capturedPriceForRound,
+            this.state.startProceedsGoal,
+          );
           this.state.remainingProceedsGoal = this.state.startProceedsGoal;
           this.state.curAuctionPrice = multiplyRatios(
             capturedPriceForRound,

package/src/clientSupport.js

@@ -142,13 +142,13 @@ export const lookupOfferIdForVault = async (vaultId, currentP) => {
 
 /**
  * @param {Record<string, Brand>} brands
- * @param {({ wantMinted: number | undefined, giveMinted: number | undefined })} opts
+ * @param {({ wantMinted: number, giveMinted?: undefined } | { giveMinted: number, wantMinted?: undefined })} opts
  * @param {number} [fee=0]
  * @param {string} [anchor]
  * @returns {Proposal} XXX not a real proposal, uses BoardRemote
  */
 const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
-  const giving = opts.giveMinted ? 'minted' : 'anchor';
+  const giving = 'giveMinted' in opts ? 'minted' : 'anchor';
   const brand =
     giving === 'anchor'
       ? { in: brands[anchor], out: brands.IST }
@@ -173,14 +173,15 @@ const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
 /**
  * @param {Instance} instance
  * @param {Record<string, Brand>} brands
- * @param {{ offerId: number, feePct?: number } &
- *         ({ wantMinted: number | undefined, giveMinted: number | undefined, pair: [string, string] })} opts
+ * @param {{ offerId: string, feePct?: number, pair: [string, string] } &
+ *         ({ wantMinted: number } | { giveMinted: number })} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
 const makePsmSwapOffer = (instance, brands, opts) => {
-  const method = opts.wantMinted
-    ? 'makeWantMintedInvitation'
-    : 'makeGiveMintedInvitation'; // ref psm.js
+  const method =
+    'wantMinted' in opts
+      ? 'makeWantMintedInvitation'
+      : 'makeGiveMintedInvitation'; // ref psm.js
   const proposal = makePsmProposal(
     brands,
     opts,
@@ -305,10 +306,81 @@ const makeAddCollateralOffer = (brands, opts) => {
   return offerSpec;
 };
 
+/**
+ *
+ * @param {Record<string, Brand>} _brands
+ * @param {{
+ *   offerId: string,
+ *   roundId?: bigint,
+ *   unitPrice: bigint,
+ * }} opts
+ * @param {string} previousOffer
+ * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
+ */
+const makePushPriceOffer = (_brands, opts, previousOffer) => {
+  return {
+    id: opts.offerId,
+    invitationSpec: {
+      source: 'continuing',
+      previousOffer,
+      invitationMakerName: 'PushPrice',
+      invitationArgs: harden([
+        { unitPrice: opts.unitPrice, roundId: opts.roundId },
+      ]),
+    },
+    proposal: {},
+  };
+};
+
+// TODO DRY with CLI wallet.js
+/**
+ * @param {{
+ *   brand: Record<string, Brand>,
+ *   vbankAsset: Record<string, { brand: Brand, displayInfo: DisplayInfo }>,
+ * }} agoricNames
+ * @param {(msg: string) => Error} makeError error constructor
+ * @returns {(a: string) => Amount<'nat'>}
+ */
+export const makeParseAmount =
+  (agoricNames, makeError = msg => RangeError(msg)) =>
+  opt => {
+    assert.typeof(opt, 'string', 'parseAmount expected string');
+    const m = opt.match(/^(?<value>[\d_]+(\.[\d_]+)?)(?<brand>[A-Z]\w*?)$/);
+    if (!m || !m.groups) {
+      throw makeError(`invalid amount: ${opt}`);
+    }
+    const anyBrand = agoricNames.brand[m.groups.brand];
+    if (!anyBrand) {
+      throw makeError(`unknown brand: ${m.groups.brand}`);
+    }
+    const assetDesc = Object.values(agoricNames.vbankAsset).find(
+      d => d.brand === anyBrand,
+    );
+    if (!assetDesc) {
+      throw makeError(`unknown brand: ${m.groups.brand}`);
+    }
+    const { displayInfo } = assetDesc;
+    if (!displayInfo.decimalPlaces || displayInfo.assetKind !== 'nat') {
+      throw makeError(`bad brand: ${displayInfo}`);
+    }
+    const value = BigInt(
+      Number(m.groups.value.replace(/_/g, '')) *
+        10 ** displayInfo.decimalPlaces,
+    );
+    /** @type {Brand<'nat'>} */
+    // @ts-expect-error dynamic cast
+    const natBrand = anyBrand;
+    const amt = { value, brand: natBrand };
+    return amt;
+  };
+
 export const Offers = {
   auction: {
     Bid: makeBidOffer,
   },
+  fluxAggregator: {
+    PushPrice: makePushPriceOffer,
+  },
   psm: {
     // lowercase because it's not an invitation name. Instead it's an abstraction over two invitation makers.
     swap: makePsmSwapOffer,

package/src/contractSupport.js

@@ -1,9 +1,8 @@
 // @jessie-check
 
 import { AmountMath } from '@agoric/ertp';
-import { makeStoredPublisherKit, makeStoredPublishKit } from '@agoric/notifier';
 import { M } from '@agoric/store';
-import { E } from '@endo/eventual-send';
+import { makeRatioFromAmounts } from '@agoric/zoe/src/contractSupport/index.js';
 
 const { Fail, quote: q } = assert;
 
@@ -29,6 +28,17 @@ export const ratioPattern = harden({
 export const addSubtract = (base, gain, loss) =>
   AmountMath.subtract(AmountMath.add(base, gain), loss);
 
+/**
+ * @template {Amount} T
+ * @param {T} left
+ * @param {T} right
+ * @returns {T}
+ */
+export const subtractToEmpty = (left, right) =>
+  AmountMath.isGTE(right, left)
+    ? /** @type {T} */ (AmountMath.makeEmptyFromAmount(left))
+    : /** @type {T} */ (AmountMath.subtract(left, right));
+
 /**
  * Verifies that every key in the proposal is in the provided list
  *
@@ -65,27 +75,6 @@ export const checkDebtLimit = (debtLimit, totalDebt, toMint) => {
     )} would hit total debt limit ${q(debtLimit)}`;
 };
 
-/**
- * @deprecated incompatible with durability; instead handle vstorage ephemerally on a durable PublishKit
- * @template T
- * @param {ERef<StorageNode>} storageNode
- * @param {ERef<Marshaller>} marshaller
- * @returns {MetricsPublisherKit<T>}
- */
-export const makeMetricsPublisherKit = (storageNode, marshaller) => {
-  assert(
-    storageNode && marshaller,
-    'makeMetricsPublisherKit missing storageNode or marshaller',
-  );
-  /** @type {import('@agoric/notifier').StoredPublisherKit<T>} */
-  const kit = makeStoredPublisherKit(storageNode, marshaller, 'metrics');
-  return {
-    metricsPublication: kit.publisher,
-    metricsSubscription: kit.subscriber,
-  };
-};
-harden(makeMetricsPublisherKit);
-
 /**
  * @template T
  * @typedef {object} MetricsPublisherKit<T>
@@ -100,31 +89,13 @@ harden(makeMetricsPublisherKit);
  * @property {StoredSubscriber<T>} metricsSubscriber
  */
 
-/**
- * @deprecated incompatible with durability; instead handle vstorage ephemerally on a durable PublishKit
- * @template T
- * @param {ERef<StorageNode>} storageNode
- * @param {ERef<Marshaller>} marshaller
- * @returns {MetricsPublishKit<T>}
- */
-export const makeMetricsPublishKit = (storageNode, marshaller) => {
-  assert(
-    storageNode && marshaller,
-    'makeMetricsPublisherKit missing storageNode or marshaller',
-  );
-  const metricsNode = E(storageNode).makeChildNode('metrics');
-  /** @type {StoredPublishKit<T>} */
-  const kit = makeStoredPublishKit(metricsNode, marshaller);
-  return {
-    metricsPublisher: kit.publisher,
-    metricsSubscriber: kit.subscriber,
-  };
-};
-harden(makeMetricsPublishKit);
-
 /**
  * @param {Brand} brand must be a 'nat' brand, not checked
  * @param {NatValue} [min]
  */
 export const makeNatAmountShape = (brand, min) =>
   harden({ brand, value: min ? M.gte(min) : M.nat() });
+
+/** @param {Pick<PriceDescription, 'amountIn' | 'amountOut'>} quoteAmount */
+export const quoteAsRatio = quoteAmount =>
+  makeRatioFromAmounts(quoteAmount.amountIn, quoteAmount.amountOut);

package/src/price/fluxAggregatorContract.js

@@ -15,7 +15,7 @@ import { E } from '@endo/eventual-send';
 import { reserveThenDeposit } from '../proposals/utils.js';
 import { prepareFluxAggregatorKit } from './fluxAggregatorKit.js';
 
-const trace = makeTracer('FluxAgg');
+const trace = makeTracer('FluxAgg', false);
 /**
  * @typedef {import('@agoric/vat-data').Baggage} Baggage
  * @typedef {import('@agoric/time/src/types').TimerService} TimerService

package/src/price/fluxAggregatorKit.js

@@ -5,11 +5,7 @@
  */
 import { AmountMath } from '@agoric/ertp';
 import { assertAllDefined, makeTracer } from '@agoric/internal';
-import {
-  makeNotifierFromSubscriber,
-  observeNotifier,
-  SubscriberShape,
-} from '@agoric/notifier';
+import { makeNotifierFromSubscriber, observeNotifier } from '@agoric/notifier';
 import { M, makeScalarBigMapStore, prepareExoClassKit } from '@agoric/vat-data';
 import {
   defineRecorderKit,
@@ -189,6 +185,7 @@ export const prepareFluxAggregatorKit = async (
     priceAuthority.makeQuoteNotifier(unitAmountIn, brandOut),
     {
       updateState: quote => {
+        trace('new quote', quote);
         void priceKit.recorder.write(priceDescriptionFromQuote(quote));
       },
       fail: reason => {
@@ -207,8 +204,6 @@ export const prepareFluxAggregatorKit = async (
       creator: M.interface('fluxAggregator creatorFacet', {}, { sloppy: true }),
       public: M.interface('fluxAggregator publicFacet', {
         getPriceAuthority: M.call().returns(M.any()),
-        getSubscriber: M.call().returns(SubscriberShape),
-        getRoundStartNotifier: M.call().returns(SubscriberShape),
         getPublicTopics: M.call().returns({
           quotes: M.any(),
           latestRound: M.any(),
@@ -345,14 +340,6 @@ export const prepareFluxAggregatorKit = async (
         getPriceAuthority() {
           return priceAuthority;
         },
-        /** @deprecated use getPublicTopics */
-        getSubscriber: () => {
-          return priceKit.subscriber;
-        },
-        /** @deprecated use getPublicTopics */
-        getRoundStartNotifier() {
-          return latestRoundKit.subscriber;
-        },
         getPublicTopics() {
           return {
             quotes: makeRecorderTopic(

package/src/price/roundsManager.js

@@ -1,5 +1,6 @@
 import { Fail, q } from '@agoric/assert';
 import { AmountMath } from '@agoric/ertp';
+import { makeTracer } from '@agoric/internal';
 import { TimeMath } from '@agoric/time';
 import { M, makeScalarBigMapStore, prepareExoClassKit } from '@agoric/vat-data';
 import {
@@ -25,6 +26,8 @@ const V3_NO_DATA_ERROR = 'No data present';
 /** @type {bigint} */
 export const ROUND_MAX = BigInt(2 ** 32 - 1);
 
+const trace = makeTracer('RoundsM', false);
+
 /**
  * @param {bigint} roundId
  */
@@ -290,6 +293,7 @@ export const prepareRoundsManagerKit = baggage =>
          * @returns {OracleStatus} the new status
          */
         recordSubmission(submission, roundId, status) {
+          trace('recordSubmission', submission, roundId, status);
           const { helper } = this.facets;
           const { details } = this.state;
           helper.acceptingSubmissions(roundId) ||
@@ -670,6 +674,7 @@ export const prepareRoundsManagerKit = baggage =>
           status,
           { roundId: roundIdRaw = undefined, unitPrice: valueRaw },
         ) {
+          trace('handlePush', status, roundIdRaw, valueRaw);
           const value = Nat(valueRaw);
           const { minSubmissionValue, maxSubmissionValue, timerPresence } =
             this.state;
@@ -681,6 +686,7 @@ export const prepareRoundsManagerKit = baggage =>
             Fail`value above maxSubmissionValue ${q(maxSubmissionValue)}`;
 
           const blockTimestamp = await E(timerPresence).getCurrentTimestamp();
+          trace('handlePush blockTimestamp', blockTimestamp.absValue);
 
           let roundId;
           if (roundIdRaw === undefined) {
@@ -719,6 +725,8 @@ export const prepareRoundsManagerKit = baggage =>
           helper.updateRoundAnswer(roundId, blockTimestamp);
           helper.deleteRoundDetails(roundId);
 
+          trace('handlePush returning', settledStatus);
+
           return settledStatus;
         },
       },

package/src/proposals/core-proposal.js

@@ -200,7 +200,7 @@ export const getManifestForMain = (
     installKeys,
     vaultFactoryControllerAddress,
     minInitialPoolLiquidity,
-    endorsedUi,
+    referencedUi,
   },
 ) => {
   return {
@@ -214,7 +214,7 @@ export const getManifestForMain = (
     options: {
       vaultFactoryControllerAddress,
       minInitialPoolLiquidity,
-      endorsedUi,
+      referencedUi,
     },
   };
 };
@@ -226,7 +226,7 @@ export const getManifestForInterProtocol = (
     installKeys,
     vaultFactoryControllerAddress,
     minInitialPoolLiquidity,
-    endorsedUi,
+    referencedUi,
   },
 ) => {
   const econCommitteeManifest = getManifestForEconCommittee(
@@ -239,7 +239,7 @@ export const getManifestForInterProtocol = (
       installKeys,
       vaultFactoryControllerAddress,
       minInitialPoolLiquidity,
-      endorsedUi,
+      referencedUi,
     },
   );
   return {

package/src/proposals/econ-behaviors.js

@@ -17,6 +17,7 @@ import { makeGovernedTerms as makeGovernedVFTerms } from '../vaultFactory/params
 
 const trace = makeTracer('RunEconBehaviors', true);
 
+export const SECONDS_PER_MINUTE = 60n;
 export const SECONDS_PER_HOUR = 60n * 60n;
 export const SECONDS_PER_DAY = 24n * SECONDS_PER_HOUR;
 export const SECONDS_PER_WEEK = 7n * SECONDS_PER_DAY;
@@ -173,7 +174,7 @@ export const setupReserve = async ({
  * @param {object} config
  * @param {InterestTiming} [config.interestTiming]
  * @param {object} [config.options]
- * @param {string} [config.options.endorsedUi]
+ * @param {string} [config.options.referencedUi]
  * @param {Amount<'nat'>} minInitialDebt
  */
 export const setupVaultFactoryArguments = async (
@@ -183,7 +184,7 @@ export const setupVaultFactoryArguments = async (
       chargingPeriod: SECONDS_PER_HOUR,
       recordingPeriod: SECONDS_PER_DAY,
     },
-    options: { endorsedUi } = {},
+    options: { referencedUi } = {},
   } = {},
   minInitialDebt,
 ) => {
@@ -237,7 +238,7 @@ export const setupVaultFactoryArguments = async (
     minInitialDebt,
     bootstrapPaymentValue: 0n,
     shortfallInvitationAmount,
-    endorsedUi,
+    referencedUi,
   });
 
   const vaultFactoryPrivateArgs = {
@@ -256,7 +257,7 @@ export const setupVaultFactoryArguments = async (
  * @param {object} config
  * @param {InterestTiming} [config.interestTiming]
  * @param {object} [config.options]
- * @param {string} [config.options.endorsedUi]
+ * @param {string} [config.options.referencedUi]
  * @param {bigint} minInitialDebt
  */
 export const startVaultFactory = async (
@@ -411,7 +412,7 @@ export const startRewardDistributor = async ({
   const feeDistributorTerms = await deeplyFulfilledObject(
     harden({
       timerService,
-      collectionInterval: 60n * 60n, // 1 hour
+      collectionInterval: 1n * SECONDS_PER_HOUR,
       keywordShares: {
         RewardDistributor: 0n,
         Reserve: 1n,
@@ -518,18 +519,18 @@ export const startAuctioneer = async (
       },
     },
     issuer: {
-      consume: { [Stable.symbol]: runIssuerP },
+      consume: { [Stable.symbol]: stableIssuerP },
     },
   },
   {
     auctionParams = {
-      StartFrequency: 3600n,
-      ClockStep: 3n * 60n,
+      StartFrequency: 1n * SECONDS_PER_HOUR,
+      ClockStep: 3n * SECONDS_PER_MINUTE,
       StartingRate: 10500n,
       LowestRate: 6500n,
       DiscountStep: 500n,
       AuctionStartDelay: 2n,
-      PriceLockPeriod: 30n * 60n, // half an hour
+      PriceLockPeriod: SECONDS_PER_HOUR / 2n,
     },
   } = {},
 ) => {
@@ -538,11 +539,11 @@ export const startAuctioneer = async (
 
   const poserInvitationP = E(electorateCreatorFacet).getPoserInvitation();
 
-  const [initialPoserInvitation, electorateInvitationAmount, runIssuer] =
+  const [initialPoserInvitation, electorateInvitationAmount, stableIssuer] =
     await Promise.all([
       poserInvitationP,
       E(E(zoe).getInvitationIssuer()).getAmountOf(poserInvitationP),
-      runIssuerP,
+      stableIssuerP,
     ]);
 
   const timerBrand = await E(chainTimerService).getTimerBrand();
@@ -570,7 +571,7 @@ export const startAuctioneer = async (
       governedContractInstallation: auctionInstallation,
       governed: {
         terms: auctionTerms,
-        issuerKeywordRecord: { Bid: runIssuer },
+        issuerKeywordRecord: { Bid: stableIssuer },
         storageNode,
         marshaller,
         label: 'auctioneer',

package/src/reserve/assetReserveKit.js

@@ -5,7 +5,6 @@ import { M, makeScalarBigMapStore, prepareExoClassKit } from '@agoric/vat-data';
 import { atomicTransfer } from '@agoric/zoe/src/contractSupport/atomicTransfer.js';
 import {
   makeRecorderTopic,
-  SubscriberShape,
   TopicsRecordShape,
 } from '@agoric/zoe/src/contractSupport/topics.js';
 import { AmountKeywordRecordShape } from '@agoric/zoe/src/typeGuards.js';
@@ -57,7 +56,6 @@ export const prepareAssetReserveKit = async (
       }),
       public: M.interface('AssetReserve public', {
         makeAddCollateralInvitation: M.call().returns(M.promise()),
-        getMetrics: M.call().returns(SubscriberShape),
         getPublicTopics: M.call().returns(TopicsRecordShape),
       }),
       shortfallReportingFacet: M.interface('AssetReserve shortfall reporter', {
@@ -189,7 +187,7 @@ export const prepareAssetReserveKit = async (
           await zcf.saveIssuer(issuer, keyword);
         },
 
-        /** @deprecated use getPublicTopics metrics allocation */
+        /** XXX redundant with getPublicTopics metrics `allocation` */
         getAllocations() {
           return this.state.collateralSeat.getCurrentAllocation();
         },
@@ -239,10 +237,6 @@ export const prepareAssetReserveKit = async (
           };
           return zcf.makeInvitation(handler, 'Add Collateral');
         },
-        /** @deprecated */
-        getMetrics() {
-          return this.state.metricsKit.subscriber;
-        },
         getPublicTopics() {
           return {
             metrics: makeRecorderTopic(

package/src/reserve/doc.md

@@ -90,20 +90,20 @@ sequenceDiagram
 participant caller
 participant reserveContract
 participant collateralSeat
-participant runMint
+participant stableMint
 participant runSeat
 participant zcf
 participant ammPublicFacet
 participant liquidityInvite
 
-caller ->> reserveContract: addLiquidityToAmmPool(collateralAmount, runAmount)
+caller ->> reserveContract: addLiquidityToAmmPool(collateralAmount, stableAmount)
 reserveContract ->> reserveContract: get collateralKeyword from collateralAmount.brand
 reserveContract ->> collateralSeat: get current allocation for collateralKeyword
 reserveContract ->> reserveContract: ensure  current allocation for collateralKeyword is >= collateralAmount
 
 
 note right of reserveContract: create the IST
-reserveContract ->> runMint: mintGains of runAmount, and get runSeat
+reserveContract ->> stableMint: mintGains of stableAmount, and get runSeat
 reserveContract ->> runSeat: increment collateralKeyword: collateralAmount
 reserveContract ->> collateralSeat: decrement collateralKeyword: collateralAmount
 reserveContract ->> zcf: reallocate(runSeat, collateralSeat)
@@ -112,7 +112,7 @@ note right of reserveContract: Add IST and collateral to the AMM
 reserveContract ->> ammPublicFacet: get invite for makeAddLiquidityAtRateInvitation
 reserveContract ->> reserveContract: create mapping, IST = central, collateralKeyword: secondary
 reserveContract ->> reserveContract: get liquidity brand for collateralKeyword
-reserveContract ->> reserveContract: terms mapping, give Central: runAmount, Secondary collateralAmount, want liquidity
+reserveContract ->> reserveContract: terms mapping, give Central: stableAmount, Secondary collateralAmount, want liquidity
 reserveContract ->> zcf: offer
 
 

package/src/vaultFactory/Liquidation.md

@@ -13,7 +13,7 @@ There are two interesting exception cases. All the collateral might be sold
 without covering the debt (flow 2a), or there might not be enough bids to
 purchase all the collateral (flow 2b). In the first case, vault-holders don't
 get anything back, we burn the currency we received to cover a portion of the
-debt, any excess collateral is sent to the reserve, and we report a shortfall.
+debt, and we report a shortfall.
 
 In the second case, we can't tell whether it's due to a downturn in the
 market or a DoS attack on the exchange. In hopes that it's not the latter, we