@agoric/inter-protocol 0.13.2-dev-02e99df.0 → 0.13.2-dev-ab7a341.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.13.2-dev-02e99df.0+02e99df",
+  "version": "0.13.2-dev-ab7a341.0+ab7a341",
   "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.5.2-dev-02e99df.0+02e99df",
-    "@agoric/ertp": "0.15.4-dev-02e99df.0+02e99df",
-    "@agoric/governance": "0.9.2-dev-02e99df.0+02e99df",
-    "@agoric/internal": "0.2.2-dev-02e99df.0+02e99df",
-    "@agoric/notifier": "0.5.2-dev-02e99df.0+02e99df",
-    "@agoric/store": "0.8.4-dev-02e99df.0+02e99df",
-    "@agoric/time": "0.2.2-dev-02e99df.0+02e99df",
-    "@agoric/vat-data": "0.4.4-dev-02e99df.0+02e99df",
-    "@agoric/vats": "0.13.1-dev-02e99df.0+02e99df",
-    "@agoric/zoe": "0.25.4-dev-02e99df.0+02e99df",
+    "@agoric/assert": "0.5.2-dev-ab7a341.0+ab7a341",
+    "@agoric/ertp": "0.15.4-dev-ab7a341.0+ab7a341",
+    "@agoric/governance": "0.9.2-dev-ab7a341.0+ab7a341",
+    "@agoric/internal": "0.2.2-dev-ab7a341.0+ab7a341",
+    "@agoric/notifier": "0.5.2-dev-ab7a341.0+ab7a341",
+    "@agoric/store": "0.8.4-dev-ab7a341.0+ab7a341",
+    "@agoric/time": "0.2.2-dev-ab7a341.0+ab7a341",
+    "@agoric/vat-data": "0.4.4-dev-ab7a341.0+ab7a341",
+    "@agoric/vats": "0.13.1-dev-ab7a341.0+ab7a341",
+    "@agoric/zoe": "0.25.4-dev-ab7a341.0+ab7a341",
     "@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.18.3-dev-02e99df.0+02e99df",
+    "agoric": "0.18.3-dev-ab7a341.0+ab7a341",
     "jessie.js": "^0.3.2"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.9.5-dev-02e99df.0+02e99df",
-    "@agoric/smart-wallet": "0.4.3-dev-02e99df.0+02e99df",
-    "@agoric/swingset-liveslots": "0.9.1-dev-02e99df.0+02e99df",
-    "@agoric/swingset-vat": "0.30.3-dev-02e99df.0+02e99df",
+    "@agoric/deploy-script-support": "0.9.5-dev-ab7a341.0+ab7a341",
+    "@agoric/smart-wallet": "0.4.3-dev-ab7a341.0+ab7a341",
+    "@agoric/swingset-liveslots": "0.9.1-dev-ab7a341.0+ab7a341",
+    "@agoric/swingset-vat": "0.30.3-dev-ab7a341.0+ab7a341",
     "@endo/bundle-source": "^2.5.1",
     "@endo/init": "^0.5.56",
     "@endo/promise-kit": "^0.2.56",
@@ -77,5 +77,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "02e99df0d4ef3709c2c413cbcb10cd6779a28036"
+  "gitHead": "ab7a341a734f6a7c951819e528defc0d6b527c50"
 }

package/src/proposals/econ-behaviors.js

@@ -27,7 +27,6 @@ const BASIS_POINTS = 10_000n;
 /**
  * @typedef {GovernedCreatorFacet<import('../stakeFactory/stakeFactory.js').StakeFactoryCreator>} StakeFactoryCreator
  * @typedef {import('../stakeFactory/stakeFactory.js').StakeFactoryPublic} StakeFactoryPublic
- * @typedef {import('../reserve/assetReserve.js').GovernedAssetReserveFacetAccess} GovernedAssetReserveFacetAccess
  * @typedef {import('../vaultFactory/vaultFactory.js').VaultFactoryContract['publicFacet']} VaultFactoryPublicFacet
  * @typedef {import('../auction/auctioneer.js').AuctioneerPublicFacet} AuctioneerPublicFacet
  * @typedef {import('../auction/auctioneer.js').AuctioneerCreatorFacet} AuctioneerCreatorFacet
@@ -63,7 +62,7 @@ const BASIS_POINTS = 10_000n;
  *   psmKit: MapStore<Brand, PSMKit>,
  *   anchorBalancePayments: MapStore<Brand, Payment<'nat'>>,
  *   econCharterKit: EconCharterStartResult,
- *   reserveKit: GovernanceFacetKit<import('../reserve/assetReserve.js')['start']>,
+ *   reserveKit: GovernanceFacetKit<import('../reserve/assetReserve.js')['prepare']>,
  *   stakeFactoryKit: GovernanceFacetKit<import('../stakeFactory/stakeFactory.js')['start']>,
  *   vaultFactoryKit: GovernanceFacetKit<import('../vaultFactory/vaultFactory.js')['prepare']>,
  *   auctioneerKit: AuctioneerKit,

package/src/reserve/assetReserve.js

@@ -1,27 +1,14 @@
 // @jessie-check
 
-import { E, Far } from '@endo/far';
-import { AmountMath } from '@agoric/ertp';
 import { handleParamGovernance } from '@agoric/governance';
-import { atomicTransfer } from '@agoric/zoe/src/contractSupport/index.js';
-import { provideDurableMapStore, prepareKindMulti } from '@agoric/vat-data';
 import { makeTracer } from '@agoric/internal';
+import {
+  prepareRecorderKitMakers,
+  provideAll,
+} from '@agoric/zoe/src/contractSupport/index.js';
+import { prepareAssetReserveKit } from './assetReserveKit.js';
 
-import { makeMetricsPublisherKit } from '../contractSupport.js';
-
-const { Fail, quote: q } = assert;
-
-const trace = makeTracer('Reserve', false);
-
-/**
- * @typedef {object} MetricsNotification
- *
- * @property {AmountKeywordRecord} allocations
- * @property {Amount<'nat'>} shortfallBalance shortfall from liquidation that
- *   has not yet been compensated.
- * @property {Amount<'nat'>} totalFeeMinted total Fee tokens minted to date
- * @property {Amount<'nat'>} totalFeeBurned total Fee tokens burned to date
- */
+const trace = makeTracer('AR', false);
 
 /**
  * @typedef {{
@@ -30,22 +17,6 @@ const trace = makeTracer('Reserve', false);
  * }} ShortfallReportingFacet
  */
 
-/**
- * @typedef {{
- *   state: {
- *     totalFeeBurned: Amount<'nat'>,
- *     totalFeeMinted: Amount<'nat'>,
- *   },
- *   facets: {
- *     publicFacet: {},
- *     creatorFacet: {},
- *     shortfallReportingFacet: ShortfallReportingFacet,
- *     limitedCreatorFacet: {},
- *     governedApis: {},
- *      },
- * }} MethodContext
- */
-
 /** @typedef {import('@agoric/vat-data').Baggage} Baggage */
 
 /**
@@ -68,24 +39,17 @@ const trace = makeTracer('Reserve', false);
  * }} privateArgs
  * @param {Baggage} baggage
  */
-const start = async (zcf, privateArgs, baggage) => {
+export const prepare = async (zcf, privateArgs, baggage) => {
+  trace('prepare', Object.keys(privateArgs), [...baggage.keys()]);
   // This contract mixes two styles of access to durable state. durableStores
   // are declared at the top level and referenced lexically. local state is
   // accessed via the `state` object. The latter means updates are made directly
   // to state and don't require reference to baggage.
 
-  /**
-   * Used to look up the unique keyword for each brand, including Fee brand.
-   *
-   * @type {MapStore<Brand, Keyword>}
-   */
-  const keywordForBrand = provideDurableMapStore(baggage, 'keywordForBrand');
-  /**
-   * Used to look up the brands for keywords, excluding Fee because it's a special case.
-   *
-   * @type {MapStore<Keyword, Brand>}
-   */
-  const brandForKeyword = provideDurableMapStore(baggage, 'brandForKeyword');
+  const { makeRecorderKit } = prepareRecorderKitMakers(
+    baggage,
+    privateArgs.marshaller,
+  );
 
   /** @type {() => Promise<ZCFMint<'nat'>>} */
   const takeFeeMint = async () => {
@@ -100,214 +64,49 @@ const start = async (zcf, privateArgs, baggage) => {
     baggage.init('feeMint', feeMintTemp);
     return feeMintTemp;
   };
+  trace('awaiting takeFeeMint');
   const feeMint = await takeFeeMint();
-  const feeKit = feeMint.getIssuerRecord();
-  const emptyAmount = AmountMath.makeEmpty(feeKit.brand);
-
-  /**
-   * @param {Brand} brand
-   * @param {Keyword} keyword
-   */
-  const saveBrandKeyword = (brand, keyword) => {
-    keywordForBrand.init(brand, keyword);
-    brandForKeyword.init(keyword, brand);
-  };
-
-  saveBrandKeyword(feeKit.brand, 'Fee');
-  // no need to saveIssuer() b/c registerFeeMint did it
-
-  const { augmentVirtualPublicFacet, makeVirtualGovernorFacet } =
-    await handleParamGovernance(
-      zcf,
-      privateArgs.initialPoserInvitation,
-      {},
-      privateArgs.storageNode,
-      privateArgs.marshaller,
-    );
-
-  /**
-   * @param {MethodContext} _context
-   * @param {Issuer} issuer
-   * @param {string} keyword
-   */
-  const addIssuer = async (_context, issuer, keyword) => {
-    const brand = await E(issuer).getBrand();
-    trace('addIssuer', { brand, keyword });
-    assert(
-      keyword !== 'Fee' && brand !== feeKit.brand,
-      `'Fee' brand is a special case handled by the reserve contract`,
-    );
-
-    trace('addIssuer storing', {
-      keyword,
-      brand,
-    });
-
-    saveBrandKeyword(brand, keyword);
-    await zcf.saveIssuer(issuer, keyword);
-  };
-
-  const getKeywordForBrand = brand => {
-    keywordForBrand.has(brand) ||
-      Fail`Issuer not defined for brand ${q(brand)}; first call addIssuer()`;
-    return keywordForBrand.get(brand);
-  };
-
-  // We keep the associated liquidity tokens in the same seat
-  const { zcfSeat: collateralSeat } = zcf.makeEmptySeatKit();
-  const getAllocations = () => {
-    return collateralSeat.getCurrentAllocation();
-  };
-
-  /**
-   * Anyone can deposit any assets to the reserve
-   *
-   * @param {*} state
-   */
-  const addCollateralHook = state => async (/** @type {ZCFSeat} */ seat) => {
-    const {
-      give: { Collateral: amountIn },
-    } = seat.getProposal();
-
-    const collateralKeyword = getKeywordForBrand(amountIn.brand);
-
-    atomicTransfer(
-      zcf,
-      seat,
-      collateralSeat,
-      { Collateral: amountIn },
-      { [collateralKeyword]: amountIn },
-    );
-    seat.exit();
-    // eslint-disable-next-line no-use-before-define
-    updateMetrics({ state });
-
-    trace('received collateral', amountIn);
-    return 'added Collateral to the Reserve';
-  };
+  const makeAssetReserveKit = await prepareAssetReserveKit(baggage, {
+    feeMint,
+    makeRecorderKit,
+    // eslint-disable-next-line @jessie.js/no-nested-await -- spurious
+    storageNode: await privateArgs.storageNode,
+    zcf,
+  });
 
-  const makeAddCollateralInvitation = ({ state }) =>
-    zcf.makeInvitation(addCollateralHook(state), 'Add Collateral');
+  const { assetReserveKit } = await provideAll(baggage, {
+    assetReserveKit: makeAssetReserveKit,
+  });
 
-  /** @type {import('../contractSupport.js').MetricsPublisherKit<MetricsNotification>} */
-  const { metricsPublication, metricsSubscription } = makeMetricsPublisherKit(
+  trace('awaiting handleParamGovernance');
+  const { makeDurableGovernorFacet } = await handleParamGovernance(
+    zcf,
+    privateArgs.initialPoserInvitation,
+    {},
     privateArgs.storageNode,
     privateArgs.marshaller,
   );
 
-  const updateMetrics = ({ state }) => {
-    const metrics = harden({
-      allocations: getAllocations(),
-      shortfallBalance: state.shortfallBalance,
-      totalFeeMinted: state.totalFeeMinted,
-      totalFeeBurned: state.totalFeeBurned,
-    });
-    metricsPublication.updateState(metrics);
-  };
-
-  const increaseLiquidationShortfall = ({ state }, shortfall) => {
-    state.shortfallBalance = AmountMath.add(state.shortfallBalance, shortfall);
-    updateMetrics({ state });
-  };
-
-  const reduceLiquidationShortfall = ({ state }, reduction) => {
-    if (AmountMath.isGTE(reduction, state.shortfallBalance)) {
-      state.shortfallBalance = emptyAmount;
-    } else {
-      state.shortfallBalance = AmountMath.subtract(
-        state.shortfallBalance,
-        reduction,
-      );
-    }
-    updateMetrics({ state });
-  };
-
-  const init = () => {
-    const initialState = {
-      totalFeeMinted: emptyAmount,
-      totalFeeBurned: emptyAmount,
-      shortfallBalance: emptyAmount,
-    };
-    updateMetrics({ state: initialState });
-    return initialState;
-  };
-
-  /**
-   *
-   * @param {MethodContext} context
-   * @param {Amount<'nat'>} reduction
-   * @returns {void}
-   */
-  const burnFeesToReduceShortfall = ({ state }, reduction) => {
-    trace('burnFeesToReduceShortfall', reduction);
-    reduction = AmountMath.coerce(feeKit.brand, reduction);
-    const feeKeyword = keywordForBrand.get(feeKit.brand);
-    const feeBalance = collateralSeat.getAmountAllocated(feeKeyword);
-    const amountToBurn = AmountMath.min(reduction, feeBalance);
-    if (AmountMath.isEmpty(amountToBurn)) {
-      return;
-    }
-
-    feeMint.burnLosses(harden({ [feeKeyword]: amountToBurn }), collateralSeat);
-    state.totalFeeBurned = AmountMath.add(state.totalFeeBurned, amountToBurn);
-    updateMetrics({ state });
-  };
-
-  const shortfallReportingFacet = {
-    increaseLiquidationShortfall,
-    // currently exposed for testing. Maybe it only gets called internally?
-    reduceLiquidationShortfall,
-  };
-
-  /** @param {MethodContext} context */
-  const makeShortfallReportingInvitation = ({ facets }) => {
-    const handleShortfallReportingOffer = () => {
-      return facets.shortfallReportingFacet;
-    };
-
-    return zcf.makeInvitation(
-      handleShortfallReportingOffer,
-      'getFacetForReportingShortfalls',
-    );
-  };
-
-  const { governorFacet, limitedCreatorFacet } = makeVirtualGovernorFacet({
-    makeAddCollateralInvitation,
-    // add makeRedeemLiquidityTokensInvitation later. For now just store them
-    getAllocations,
-    addIssuer,
-    makeShortfallReportingInvitation,
-    getMetrics: () => metricsSubscription,
-  });
-
-  const governedApis = { burnFeesToReduceShortfall };
-
-  const publicFacet = augmentVirtualPublicFacet(
-    Far('Collateral Reserve public', {
-      makeAddCollateralInvitation,
-    }),
+  const { governorFacet } = makeDurableGovernorFacet(
+    baggage,
+    assetReserveKit.machine,
+    // reconstruct facet so that the keys are enumerable and that the client can't depend on object identity
+    {
+      burnFeesToReduceShortfall: reduction =>
+        assetReserveKit.governedApis.burnFeesToReduceShortfall(reduction),
+    },
   );
 
-  const makeAssetReserve = prepareKindMulti(baggage, 'assetReserve', init, {
-    publicFacet,
-    creatorFacet: governorFacet,
-    shortfallReportingFacet,
-    limitedCreatorFacet,
-    governedApis,
-  });
-
-  const { creatorFacet, publicFacet: pFacet } = makeAssetReserve();
   return {
-    /** @type {GovernedCreatorFacet<OriginalAssetReserveCreatorFacet>} */
-    // @ts-expect-error cast
-    creatorFacet,
-    publicFacet: pFacet,
+    /** @type {GovernedCreatorFacet<typeof assetReserveKit.machine>} */
+    creatorFacet: governorFacet,
+    /** @type {GovernedPublicFacet<typeof assetReserveKit.public>} */
+    // cast due to missing governance mixins
+    // XXX https://github.com/Agoric/agoric-sdk/issues/5200
+    publicFacet: /** @type {any} */ (assetReserveKit.public),
   };
 };
-
-harden(start);
-
-export { start };
+harden(prepare);
 
 /**
  * @typedef {object} ShortfallReporter
@@ -316,20 +115,11 @@ export { start };
  */
 
 /**
- * @typedef {object} OriginalAssetReserveCreatorFacet
- * @property {() => Invitation} makeAddCollateralInvitation
- * @property {() => Allocation} getAllocations
+ * @typedef {object} AssetReserveLimitedCreatorFacet
  * @property {(issuer: Issuer, kwd: string) => void} addIssuer
- * @property {() => Invitation<ShortfallReporter>} makeShortfallReportingInvitation
- * @property {() => StoredSubscription<MetricsNotification>} getMetrics
- */
-
-/**
- * @typedef {object} OriginalAssetReservePublicFacet
- * @property {() => Invitation} makeAddCollateralInvitation
+ * @property {() => Allocation} getAllocations
+ * @property {() => Promise<Invitation<ShortfallReporter>>} makeShortfallReportingInvitation
  */
 
-/** @typedef {Awaited<ReturnType<typeof start>>['publicFacet']} AssetReservePublicFacet */
-/** @typedef {Awaited<ReturnType<typeof start>>['creatorFacet']} AssetReserveCreatorFacet the creator facet for the governor */
-/** @typedef {OriginalAssetReserveCreatorFacet} AssetReserveLimitedCreatorFacet */
-/** @typedef {GovernorCreatorFacet<typeof start>} GovernedAssetReserveFacetAccess */
+/** @typedef {Awaited<ReturnType<typeof prepare>>['publicFacet']} AssetReservePublicFacet */
+/** @typedef {Awaited<ReturnType<typeof prepare>>['creatorFacet']} AssetReserveCreatorFacet the creator facet for the governor */