feat(liquidationVisibility): Store liquidationsStorageNode in ephem…

…ara instead of state. Refs: #15
Jorge-Lopes · Mar 4, 2024 · ad302be · ad302be
1 parent 9b1df56
commit ad302be
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 467 deletions.
diff --git a/packages/inter-protocol/src/vaultFactory/vaultManager.js b/packages/inter-protocol/src/vaultFactory/vaultManager.js
@@ -216,7 +216,6 @@ export const prepareVaultManagerKit = (
   /**
    * @param {HeldParams & {
    *   metricsStorageNode: StorageNode;
-   *   liquidationsStorageNode: StorageNode;
    * }} params
    * @returns {HeldParams & ImmutableState & MutableState}
    */
@@ -276,7 +275,6 @@ export const prepareVaultManagerKit = (
       totalShortfallReceived: zeroDebt,
       vaultCounter: 0,
       lockedQuote: undefined,
-      liquidationsStorageNode: undefined,
     });
   };
 
@@ -390,6 +388,10 @@ export const prepareVaultManagerKit = (
 
           const ephemera = collateralEphemera(collateralBrand);
           ephemera.prioritizedVaults = makePrioritizedVaults(unsettledVaults);
+          // We have to store this in ephemera since we can't add new properties
+          // to the `state`. See https://github.com/Agoric/agoric-sdk/blob/master/packages/SwingSet/docs/virtual-objects.md
+          ephemera.liquidationsStorageNode =
+            E(storageNode).makeChildNode('liquidations');
 
           trace('helper.start() making periodNotifier');
           const periodNotifier = E(timerService).makeNotifier(
@@ -444,19 +446,6 @@ export const prepareVaultManagerKit = (
           });
           trace('helper.start() done');
         },
-        provideLiquidationStorageNode() {
-          const { state } = this;
-
-          console.log('LOG: provideLiquidationStorageNode');
-
-          const liquidationNodeP = E(state.storageNode).makeChildNode(
-            'liquidations',
-          );
-
-          E.when(liquidationNodeP, liquidationNode => {
-            state.liquidationsStorageNode = liquidationNode;
-          });
-        },
         /**
          * @param {Timestamp} updateTime
          */
@@ -750,14 +739,14 @@ export const prepareVaultManagerKit = (
          */
         async makeLiquidationRecorderKits(timestamp) {
           const {
-            state: { liquidationsStorageNode },
+            state: { collateralBrand },
           } = this;
 
-          const { state } = this;
+          const ephemera = collateralEphemera(collateralBrand);
 
-          const timestampStorageNode = E(liquidationsStorageNode).makeChildNode(
-            `${timestamp.absValue}`,
-          );
+          const timestampStorageNode = E(
+            ephemera.liquidationsStorageNode,
+          ).makeChildNode(`${timestamp.absValue}`);
 
           const [
             preAuctionStorageNode,
@@ -1454,7 +1443,6 @@ export const provideAndStartVaultManagerKits = baggage => {
 
   for (const kit of provide(baggage, key, () => noKits)) {
     kit.helper.start();
-    kit.helper.provideLiquidationStorageNode();
   }
 
   trace('provideAndStartVaultManagerKits returning');

diff --git a/packages/vats/test/bootstrapTests/liquidationVisibility/liquidation-test-utils.js b/packages/vats/test/bootstrapTests/liquidationVisibility/liquidation-test-utils.js
@@ -5,16 +5,15 @@
  */
 import * as processAmbient from 'child_process';
 import * as fsAmbient from 'fs';
-import { Fail } from '@agoric/assert';
-import { NonNullish } from '@agoric/assert/src/assert.js';
+import { Fail, NonNullish } from '@agoric/assert';
 import { Offers } from '@agoric/inter-protocol/src/clientSupport.js';
 import { TimeMath } from '@agoric/time';
-import { scale6 } from '../liquidation.js';
 import { eventLoopIteration } from '@agoric/internal/src/testing-utils.js';
 import {
   SECONDS_PER_HOUR,
   SECONDS_PER_MINUTE,
 } from '@agoric/inter-protocol/src/proposals/econ-behaviors.js';
+import { scale6 } from '../liquidation.js';
 import { makeAgoricNamesRemotesFromFakeStorage } from '../../../tools/board-utils.js';
 import { makeSwingsetTestKit } from '../supports.js';
 import {
@@ -346,6 +345,7 @@ const makeProposalExtractor = ({ childProcess, fs }) => {
     packageScriptName,
     env = {},
   }) => {
+    // eslint-disable-next-line no-undef
     const scriptEnv = Object.assign(Object.create(process.env), env);
     // XXX use '@agoric/inter-protocol'?
     const out = await runPackageScript(

diff --git a/packages/vats/test/bootstrapTests/liquidationVisibility/test-liquidation-compability.js b/packages/vats/test/bootstrapTests/liquidationVisibility/test-liquidation-compability.js
@@ -1,5 +1,4 @@
 // @ts-check
-/* global process */
 /**
  * @file Bootstrap test of restarting (almost) all vats
  */
@@ -95,11 +94,15 @@ test.serial('restart contractGovernor', async t => {
 });
 
 test.serial('visibility-after-upgrade', async t => {
+  const { storage } = t.context;
   await checkVMChildNodes({
     t,
     managerIndex: 0,
     collateralBrandKey: 'ATOM',
     liquidation: true,
     base: 3,
   });
+
+  t.log('Data', storage.data.keys());
+  t.pass();
 });