@agoric/inter-protocol 0.14.1-dev-80bdc60.0 → 0.14.1-dev-effbf7f.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.14.1-dev-80bdc60.0+80bdc60",
+  "version": "0.14.1-dev-effbf7f.0+effbf7f",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -29,29 +29,29 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-80bdc60.0+80bdc60",
-    "@agoric/ertp": "0.16.1-dev-80bdc60.0+80bdc60",
-    "@agoric/governance": "0.10.1-dev-80bdc60.0+80bdc60",
-    "@agoric/internal": "0.3.1-dev-80bdc60.0+80bdc60",
-    "@agoric/notifier": "0.6.1-dev-80bdc60.0+80bdc60",
-    "@agoric/store": "0.9.1-dev-80bdc60.0+80bdc60",
-    "@agoric/time": "0.3.1-dev-80bdc60.0+80bdc60",
-    "@agoric/vat-data": "0.5.1-dev-80bdc60.0+80bdc60",
-    "@agoric/vats": "0.14.1-dev-80bdc60.0+80bdc60",
-    "@agoric/zoe": "0.26.1-dev-80bdc60.0+80bdc60",
+    "@agoric/assert": "0.6.1-dev-effbf7f.0+effbf7f",
+    "@agoric/ertp": "0.16.1-dev-effbf7f.0+effbf7f",
+    "@agoric/governance": "0.10.1-dev-effbf7f.0+effbf7f",
+    "@agoric/internal": "0.3.1-dev-effbf7f.0+effbf7f",
+    "@agoric/notifier": "0.6.1-dev-effbf7f.0+effbf7f",
+    "@agoric/store": "0.9.1-dev-effbf7f.0+effbf7f",
+    "@agoric/time": "0.3.1-dev-effbf7f.0+effbf7f",
+    "@agoric/vat-data": "0.5.1-dev-effbf7f.0+effbf7f",
+    "@agoric/vats": "0.14.1-dev-effbf7f.0+effbf7f",
+    "@agoric/zoe": "0.26.1-dev-effbf7f.0+effbf7f",
     "@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.19.1-dev-80bdc60.0+80bdc60",
+    "agoric": "0.19.1-dev-effbf7f.0+effbf7f",
     "jessie.js": "^0.3.2"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.10.1-dev-80bdc60.0+80bdc60",
-    "@agoric/smart-wallet": "0.5.1-dev-80bdc60.0+80bdc60",
-    "@agoric/swingset-liveslots": "0.10.1-dev-80bdc60.0+80bdc60",
-    "@agoric/swingset-vat": "0.32.1-dev-80bdc60.0+80bdc60",
+    "@agoric/deploy-script-support": "0.10.1-dev-effbf7f.0+effbf7f",
+    "@agoric/smart-wallet": "0.5.1-dev-effbf7f.0+effbf7f",
+    "@agoric/swingset-liveslots": "0.10.1-dev-effbf7f.0+effbf7f",
+    "@agoric/swingset-vat": "0.32.1-dev-effbf7f.0+effbf7f",
     "@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": "80bdc601d42ab5b1e832b57995e4659caef60892"
+  "gitHead": "effbf7f7a278863b88419e0a19ae19f0db4b30a0"
 }

package/src/contractSupport.js

@@ -1,9 +1,7 @@
 // @jessie-check
 
 import { AmountMath } from '@agoric/ertp';
-import { makeStoredPublisherKit, makeStoredPublishKit } from '@agoric/notifier';
 import { M } from '@agoric/store';
-import { E } from '@endo/eventual-send';
 
 const { Fail, quote: q } = assert;
 
@@ -65,27 +63,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,28 +77,6 @@ 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]

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,
@@ -208,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(),
@@ -346,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/proposals/econ-behaviors.js

@@ -519,7 +519,7 @@ export const startAuctioneer = async (
       },
     },
     issuer: {
-      consume: { [Stable.symbol]: runIssuerP },
+      consume: { [Stable.symbol]: stableIssuerP },
     },
   },
   {
@@ -539,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();
@@ -571,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/types.js

@@ -21,15 +21,6 @@
  * @property {() => Invitation} makeSwapInvitation
  */
 
-/**
- * @typedef {object} Collateral
- * @property {Ratio} liquidationMargin
- * @property {Ratio} stabilityFee
- * @property {Ratio} marketPrice
- * @property {Ratio} interestRate
- * @property {Brand} brand
- */
-
 /**
  * @typedef {object} VaultManagerParamValues
  * @property {Ratio} liquidationMargin - margin below which collateral will be
@@ -108,7 +99,7 @@
  * @typedef {object} LiquidationStrategy
  * @property {() => KeywordKeywordRecord} keywordMapping
  * @property {(collateral: Amount, run: Amount) => Proposal} makeProposal
- * @property {(runDebt: Amount) => Promise<Invitation>} makeInvitation
+ * @property {(debt: Amount) => Promise<Invitation>} makeInvitation
  */
 
 /**

package/src/vaultFactory/vaultDirector.js

@@ -15,9 +15,6 @@ import {
 import { assertKeywordName } from '@agoric/zoe/src/cleanProposal.js';
 import {
   atomicRearrange,
-  getAmountIn,
-  getAmountOut,
-  makeRatioFromAmounts,
   makeRecorderTopic,
   provideEmptySeat,
   SubscriberShape,
@@ -299,9 +296,7 @@ export const prepareVaultDirector = (
       }),
       public: M.interface('public', {
         getCollateralManager: M.call(BrandShape).returns(M.remotable()),
-        getCollaterals: M.call().returns(M.promise()),
-        getMetrics: M.call().returns(SubscriberShape),
-        getRunIssuer: M.call().returns(IssuerShape),
+        getDebtIssuer: M.call().returns(IssuerShape),
         getSubscription: M.call({ collateralBrand: BrandShape }).returns(
           SubscriberShape,
         ),
@@ -454,44 +449,10 @@ export const prepareVaultDirector = (
           /** @type {VaultManager} */
           return managerForCollateral(brandIn).getPublicFacet();
         },
-        /**
-         * @deprecated get `collaterals` list from metrics
-         */
-        async getCollaterals() {
-          // should be collateralManagers.map((vm, brand) => ({
-          return harden(
-            Promise.all(
-              [...collateralManagers.entries()].map(
-                async ([brand, managerIndex]) => {
-                  const vm = vaultManagers.get(managerIndex).self;
-                  const priceQuote = await vm.getCollateralQuote();
-                  return {
-                    brand,
-                    interestRate: vm.getGovernedParams().getInterestRate(),
-                    liquidationMargin: vm
-                      .getGovernedParams()
-                      .getLiquidationMargin(),
-                    stabilityFee: vm.getGovernedParams().getMintFee(),
-                    marketPrice: makeRatioFromAmounts(
-                      getAmountOut(priceQuote),
-                      getAmountIn(priceQuote),
-                    ),
-                  };
-                },
-              ),
-            ),
-          );
-        },
-        /** @deprecated use getPublicTopics */
-        getMetrics() {
-          return metricsKit.subscriber;
-        },
-        getRunIssuer() {
+        getDebtIssuer() {
           return debtMint.getIssuerRecord().issuer;
         },
         /**
-         * @deprecated get from the CollateralManager directly
-         *
          * subscription for the paramManager for a particular vaultManager
          *
          * @param {{ collateralBrand: Brand }} selector

package/src/vaultFactory/vaultHolder.js

@@ -3,10 +3,7 @@
  */
 import { AmountShape } from '@agoric/ertp';
 import { M, prepareExoClassKit } from '@agoric/vat-data';
-import {
-  SubscriberShape,
-  TopicsRecordShape,
-} from '@agoric/zoe/src/contractSupport/index.js';
+import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/index.js';
 import { UnguardedHelperI } from '../typeGuards.js';
 
 const { Fail } = assert;
@@ -22,7 +19,6 @@ const HolderI = M.interface('holder', {
   getCollateralAmount: M.call().returns(AmountShape),
   getCurrentDebt: M.call().returns(AmountShape),
   getNormalizedDebt: M.call().returns(AmountShape),
-  getSubscriber: M.call().returns(SubscriberShape),
   getPublicTopics: M.call().returns(TopicsRecordShape),
   makeAdjustBalancesInvitation: M.call().returns(M.promise()),
   makeCloseInvitation: M.call().returns(M.promise()),
@@ -91,10 +87,6 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
         },
       },
       holder: {
-        /** @deprecated use getPublicTopics */
-        getSubscriber() {
-          return this.state.topicKit.subscriber;
-        },
         getPublicTopics() {
           const { topicKit } = this.state;
           return harden({

package/src/vaultFactory/vaultManager.js

@@ -73,6 +73,8 @@ const trace = makeTracer('VM');
 /**
  * @typedef {object} MetricsNotification
  *
+ * @property {Ratio | null} lockedQuote      priceQuote that will be used for liquidation.
+ *                                   Non-null from priceLock time until liquidation has taken place.
  * @property {number}         numActiveVaults          present count of vaults
  * @property {number}         numLiquidatingVaults  present count of liquidating vaults
  * @property {Amount<'nat'>}  totalCollateral    present sum of collateral across all vaults
@@ -254,8 +256,6 @@ export const prepareVaultManagerKit = (
     {
       collateral: M.interface('collateral', {
         makeVaultInvitation: M.call().returns(M.promise()),
-        getSubscriber: M.call().returns(SubscriberShape),
-        getMetrics: M.call().returns(SubscriberShape),
         getPublicTopics: M.call().returns(TopicsRecordShape),
         getQuotes: M.call().returns(NotifierShape),
         getCompoundedInterest: M.call().returns(RatioShape),
@@ -318,14 +318,6 @@ export const prepareVaultManagerKit = (
             }),
           );
         },
-        /** @deprecated use getPublicTopics */
-        getSubscriber() {
-          return this.state.assetTopicKit.subscriber;
-        },
-        /** @deprecated use getPublicTopics */
-        getMetrics() {
-          return this.state.metricsTopicKit.subscriber;
-        },
         getQuotes() {
           const ephemera = collateralEphemera(this.state.collateralBrand);
           return ephemera.storedQuotesNotifier;
@@ -609,6 +601,11 @@ export const prepareVaultManagerKit = (
             retainedCollateralSeat.getCurrentAllocation()?.Collateral ??
             AmountMath.makeEmpty(collateralBrand, 'nat');
 
+          const quote = state.lockedQuote;
+          const lockedQuoteRatio = quote
+            ? quoteAsRatio(quote.quoteAmount.value[0])
+            : null;
+
           /** @type {MetricsNotification} */
           const payload = harden({
             numActiveVaults: prioritizedVaults.getCount(),
@@ -625,6 +622,7 @@ export const prepareVaultManagerKit = (
             totalOverageReceived: state.totalOverageReceived,
             totalProceedsReceived: state.totalProceedsReceived,
             totalShortfallReceived: state.totalShortfallReceived,
+            lockedQuote: lockedQuoteRatio,
           });
 
           return E(metricsTopicKit.recorder).write(payload);
@@ -1231,7 +1229,7 @@ export const prepareVaultManagerKit = (
         },
 
         lockOraclePrices() {
-          const { state } = this;
+          const { state, facets } = this;
           const { storedCollateralQuote } = collateralEphemera(
             state.collateralBrand,
           );
@@ -1244,6 +1242,7 @@ export const prepareVaultManagerKit = (
           );
 
           state.lockedQuote = storedCollateralQuote;
+          facets.helper.writeMetrics();
           return storedCollateralQuote;
         },
         /**