Merge pull request #27 from agoric-labs/fix-upgradability

fix: upgradability

Author: WietzeSlagman

agoric/contract/src/index.js

@@ -10,7 +10,9 @@ import { makeRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
 import { InvitationShape } from '@agoric/zoe/src/typeGuards.js';
 import { handleParamGovernance } from '@agoric/governance';
 
-import { prepareKreadKit } from './kreadKit.js';
+import { prepareKreadKit, provideKreadKitRecorderKits } from './kreadKit.js';
+import { provide } from '@agoric/vat-data';
+import { provideRecorderKits } from './utils.js';
 
 /**
  * This contract handles the mint of KREAd characters,
@@ -78,22 +80,6 @@ export const start = async (zcf, privateArgs, baggage) => {
   // TODO: move to proposal
   const assetNames = terms.assetNames;
 
-  const storageNodePaths = {
-    infoKit: 'info',
-    characterKit: 'character',
-    itemKit: 'item',
-    marketCharacterKit: 'market-characters',
-    marketItemKit: 'market-items',
-    marketCharacterMetricsKit: 'market-metrics-character',
-    marketItemMetricsKit: 'market-metrics-item',
-  };
-
-  const { makeDurableGovernorFacet } = await handleParamGovernance(
-    zcf,
-    privateArgs.initialPoserInvitation,
-    {},
-  );
-
   // Setting up the mint capabilities here in the prepare function, as discussed with Turadg
   // durability is not a concern with these, and defining them here, passing on what's needed
   // ensures that the capabilities are where they need to be
@@ -125,6 +111,12 @@ export const start = async (zcf, privateArgs, baggage) => {
     powers.marshaller,
   );
 
+  const recorderKits = await provideKreadKitRecorderKits(
+    baggage,
+    powers.storageNode,
+    makeRecorderKit,
+  );
+
   assert(paymentBrand, 'missing paymentBrand');
   const mintFeeAmount = AmountMath.make(paymentBrand, mintFee);
 
@@ -136,33 +128,39 @@ export const start = async (zcf, privateArgs, baggage) => {
   const royaltyRateRatio = objectToRatio(paymentBrand, royaltyRate);
   const platformFeeRatio = objectToRatio(paymentBrand, platformFeeRate);
 
-  const kreadKit = await harden(
-    prepareKreadKit(
-      baggage,
-      zcf,
-      {
-        seed,
-        mintFeeAmount,
-        royaltyRate: royaltyRateRatio,
-        platformFeeRate: platformFeeRatio,
-        mintRoyaltyRate: mintRoyaltyRateRatio,
-        mintPlatformFeeRate: mintPlatformFeeRatio,
-        royaltyDepositFacet,
-        platformFeeDepositFacet,
-        paymentBrand,
-        minUncommonRating,
-      },
-      harden({
-        characterIssuerRecord,
-        characterMint,
-        itemIssuerRecord,
-        itemMint,
-        clock,
-        storageNode: powers.storageNode,
-        makeRecorderKit,
-        storageNodePaths,
-      }),
-    ),
+  const makeKreadKit = prepareKreadKit(
+    baggage,
+    zcf,
+    {
+      seed,
+      mintFeeAmount,
+      royaltyRate: royaltyRateRatio,
+      platformFeeRate: platformFeeRatio,
+      mintRoyaltyRate: mintRoyaltyRateRatio,
+      mintPlatformFeeRate: mintPlatformFeeRatio,
+      royaltyDepositFacet,
+      platformFeeDepositFacet,
+      paymentBrand,
+      minUncommonRating,
+    },
+    harden({
+      recorderKits,
+      characterMint,
+      characterIssuerRecord,
+      itemIssuerRecord,
+      itemMint,
+      clock,
+      storageNode: powers.storageNode,
+      makeRecorderKit,
+    }),
+  );
+
+  const kreadKit = provide(baggage, 'kitSingleton', () => makeKreadKit());
+
+  const { makeDurableGovernorFacet } = handleParamGovernance(
+    zcf,
+    privateArgs.initialPoserInvitation,
+    {},
   );
 
   const { governorFacet } = makeDurableGovernorFacet(

agoric/contract/src/kreadKit.js

@@ -11,9 +11,9 @@ import { E } from '@endo/eventual-send';
 import { errors } from './errors.js';
 import {
   makeCharacterNftObjs,
-  makeStorageNodeRecorderKits,
   makeCopyBagAmountShape,
   addAllToMap,
+  provideRecorderKits,
 } from './utils.js';
 
 import { text } from './text.js';
@@ -28,14 +28,14 @@ import {
   CharacterGuardBagShape,
   ItemGuard,
   ItemGuardBagShape,
-  CharacterRecorderGuard,
   ItemRecorderGuard,
   MarketRecorderGuard,
   MarketMetricsGuard,
   RarityGuard,
   BaseCharacterGuard,
   MarketEntryGuard,
   CharacterEntryGuard,
+  CharacterRecorderGuard,
 } from './type-guards.js';
 import { atomicRearrange } from '@agoric/zoe/src/contractSupport/index.js';
 import { multiplyBy } from '@agoric/zoe/src/contractSupport/ratio.js';
@@ -68,12 +68,18 @@ import '@agoric/zoe/exported.js';
  *   itemIssuerRecord: IssuerRecord<"copyBag">
  *   itemMint: ZCFMint<"copyBag">
  *   clock: import('@agoric/time/src/types.js').Clock
- *   storageNode: StorageNode
- *   makeRecorderKit: import('@agoric/zoe/src/contractSupport').MakeRecorderKit
- *   storageNodePaths: Object
+ *   makeRecorderKit: import('@agoric/zoe/src/contractSupport').MakeRecorderKit,
+ *   recorderKits: {
+ *     characterKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<unknown>;
+ *     itemKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<unknown>;
+ *     marketCharacterKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<unknown>;
+ *     marketItemKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<unknown>;
+ *     marketCharacterMetricsKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<unknown>;
+ *     marketItemMetricsKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<unknown>;
+ *   };
  * }} powers
  */
-export const prepareKreadKit = async (
+export const prepareKreadKit = (
   baggage,
   zcf,
   {
@@ -94,34 +100,20 @@ export const prepareKreadKit = async (
     itemIssuerRecord,
     itemMint,
     clock,
-    storageNode,
     makeRecorderKit,
-    storageNodePaths,
+    recorderKits: {
+      characterKit,
+      itemKit,
+      marketCharacterKit,
+      marketCharacterMetricsKit,
+      marketItemKit,
+      marketItemMetricsKit,
+    },
   },
 ) => {
   const { brand: characterBrand } = characterIssuerRecord;
   const { brand: itemBrand } = itemIssuerRecord;
 
-  const {
-    characterKit,
-    itemKit,
-    marketCharacterKit,
-    marketItemKit,
-    marketCharacterMetricsKit,
-    marketItemMetricsKit,
-  } = await makeStorageNodeRecorderKits(
-    storageNode,
-    makeRecorderKit,
-    storageNodePaths,
-    {
-      characterKit: CharacterRecorderGuard,
-      itemKit: ItemRecorderGuard,
-      marketCharacterKit: M.arrayOf(MarketRecorderGuard),
-      marketItemKit: M.arrayOf(MarketRecorderGuard),
-      marketCharacterMetricsKit: MarketMetricsGuard,
-      marketItemMetricsKit: MarketMetricsGuard,
-    },
-  );
   const marketItemNode = marketItemKit.recorder.getStorageNode();
   const marketCharacterNode = marketCharacterKit.recorder.getStorageNode();
 
@@ -133,7 +125,7 @@ export const prepareKreadKit = async (
   );
   const itemShape = makeCopyBagAmountShape(itemBrand, ItemGuardBagShape);
 
-  const makeKreadKitInternal = prepareExoClassKit(
+  return prepareExoClassKit(
     baggage,
     'KreadKit',
     {
@@ -1793,11 +1785,41 @@ export const prepareKreadKit = async (
       },
     },
   );
-  const facets = makeKreadKitInternal();
-  return harden({
-    public: facets.public,
-    creator: facets.creator,
-  });
 };
 
 harden(prepareKreadKit);
+
+/**
+ *
+ * @param {import('@agoric/vat-data').Baggage} baggage
+ * @param {StorageNode} storageNode
+ * @param {import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit} makeRecorderKit
+ * @returns
+ */
+export const provideKreadKitRecorderKits = (
+  baggage,
+  storageNode,
+  makeRecorderKit,
+) =>
+  provideRecorderKits(
+    baggage,
+    storageNode,
+    makeRecorderKit,
+    {
+      infoKit: 'info',
+      characterKit: 'character',
+      itemKit: 'item',
+      marketCharacterKit: 'market-characters',
+      marketItemKit: 'market-items',
+      marketCharacterMetricsKit: 'market-metrics-character',
+      marketItemMetricsKit: 'market-metrics-item',
+    },
+    {
+      characterKit: CharacterRecorderGuard,
+      itemKit: ItemRecorderGuard,
+      marketCharacterKit: M.arrayOf(MarketRecorderGuard),
+      marketItemKit: M.arrayOf(MarketRecorderGuard),
+      marketCharacterMetricsKit: MarketMetricsGuard,
+      marketItemMetricsKit: MarketMetricsGuard,
+    },
+  );

agoric/contract/src/utils.js

@@ -1,4 +1,5 @@
 // @ts-check
+import { allValues, objectMap } from '@agoric/internal';
 import { E } from '@endo/eventual-send';
 import { M, matches, getCopyMapEntries } from '@endo/patterns';
 
@@ -33,57 +34,44 @@ export const makeCharacterNftObjs = (
 };
 
 /**
- * @template T
- * @typedef {object} RecorderKit<T>
- * @property {Publisher<T>} publisher
- * @property {StoredSubscriber<T>} subscriber
- */
-
-/**
- * @template T
- * @param {ERef<StorageNode>} storageNode
- * @param {import('@agoric/zoe/src/contractSupport').MakeRecorderKit} makeRecorderKit
- * @param {string} path
- * @param {Pattern} typeMatcher
- * @returns {Promise<import('@agoric/zoe/src/contractSupport').RecorderKit<T>>}
- */
-export const makeStorageNodeRecorderKit = async (
-  storageNode,
-  makeRecorderKit,
-  path,
-  typeMatcher,
-) => {
-  const node = await E(storageNode).makeChildNode(path);
-  return makeRecorderKit(node, typeMatcher);
-};
-
-/**
+ * @param {import('@agoric/vat-data').Baggage} baggage
  * @param {ERef<StorageNode>} storageNode
  * @param {import('@agoric/zoe/src/contractSupport').MakeRecorderKit} makeRecorderKit
  * @param {{[key: string]: string}} paths
  * @param {{[key: string]: Pattern}} typeMatchers
- * @returns {Promise<{[key: string]: import('@agoric/zoe/src/contractSupport').RecorderKit<T>}>}
+ * @returns {Promise<{[key: string]: import('@agoric/zoe/src/contractSupport').RecorderKit<unknown>}>}
  */
-export const makeStorageNodeRecorderKits = async (
+export const provideRecorderKits = async (
+  baggage,
   storageNode,
   makeRecorderKit,
   paths,
   typeMatchers,
 ) => {
-  const recorderMap = {};
-  await Promise.all(
-    Object.keys(paths).map(async (key) => {
-      const recorderKit = await makeStorageNodeRecorderKit(
-        storageNode,
-        makeRecorderKit,
-        paths[key],
-        typeMatchers[key],
-      );
-      recorderMap[key] = recorderKit;
-    }),
-  );
+  console.log('provideRecorderKits', paths, typeMatchers);
+  const keys = Object.keys(paths);
+  // assume if any keys are defined they all are
+  const inBaggage = baggage.has(keys[0]);
+  if (inBaggage) {
+    const obj = objectMap(
+      paths,
+      /** @type {(value: any, key: string) => any} */
+      (_, k) => baggage.get(k),
+    );
+    return Promise.resolve(harden(obj));
+  }
+
+  const keyedPromises = objectMap(paths, async (_path, key) => {
+    const node = await E(storageNode).makeChildNode(paths[key]);
+    return makeRecorderKit(node, typeMatchers[key]);
+  });
 
-  return recorderMap;
+  return allValues(keyedPromises).then((keyedVals) => {
+    for (const [k, v] of Object.entries(keyedVals)) {
+      baggage.init(k, v);
+    }
+    return keyedVals;
+  });
 };
 
 /**