Merge pull request #9 from Jorge-Lopes/anil/develop

Liquidation Visibility - Iteration One
Jorge-Lopes · Feb 8, 2024 · c60c099 · c60c099
2 parents 7d47297 + 728d695
commit c60c099
Show file tree

Hide file tree

Showing 11 changed files with 2,083 additions and 18 deletions.
diff --git a/packages/inter-protocol/src/vaultFactory/liquidation.js b/packages/inter-protocol/src/vaultFactory/liquidation.js
@@ -18,6 +18,13 @@ const trace = makeTracer('LIQ');
 /** @typedef {import('@agoric/time').CancelToken} CancelToken */
 /** @typedef {import('@agoric/time').RelativeTimeRecord} RelativeTimeRecord */
 
+/**
+ * @typedef {MapStore<
+ *   Vault,
+ *   { collateralAmount: Amount<'nat'>; debtAmount: Amount<'nat'> }
+ * >} VaultData
+ */
+
 const makeCancelToken = makeCancelTokenMaker('liq');
 
 /**
@@ -269,12 +276,7 @@ export const getLiquidatableVaults = (
   const vaultsToLiquidate = prioritizedVaults.removeVaultsBelow(
     collateralizationDetails,
   );
-  /**
-   * @type {MapStore<
-   *   Vault,
-   *   { collateralAmount: Amount<'nat'>; debtAmount: Amount<'nat'> }
-   * >}
-   */
+  /** @type {VaultData} */
   const vaultData = makeScalarMapStore();
 
   const { zcfSeat: liqSeat } = zcf.makeEmptySeatKit();

diff --git a/packages/inter-protocol/src/vaultFactory/types.js b/packages/inter-protocol/src/vaultFactory/types.js
@@ -21,6 +21,8 @@
  *
  * @typedef {import('@agoric/time').Timestamp} Timestamp
  *
+ * @typedef {import('@agoric/time').TimestampRecord} TimestampRecord
+ *
  * @typedef {import('@agoric/time').RelativeTime} RelativeTime
  */
 
@@ -142,3 +144,26 @@
  */
 
 /** @typedef {{ key: 'governedParams' | { collateralBrand: Brand } }} VaultFactoryParamPath */
+
+/**
+ * @typedef {{
+ *   plan: import('./proceeds.js').DistributionPlan;
+ *   vaultsInPlan: Array;
+ * }} PostAuctionParams
+ *
+ * @typedef {{
+ *   plan: import('./proceeds.js').DistributionPlan;
+ *   totalCollateral: Amount<'nat'>;
+ *   totalDebt: Amount<'nat'>;
+ *   auctionSchedule: import('../auction/scheduler.js').FullSchedule;
+ * }} AuctionResultsParams
+ */
+
+/**
+ * @typedef {import('./liquidation.js').VaultData} VaultData
+ *
+ * @typedef {object} LiquidationVisibilityWriters
+ * @property {(vaultData: VaultData) => Promise<void>} writePreAuction
+ * @property {(postAuctionParams: PostAuctionParams) => Promise<void>} writePostAuction
+ * @property {(auctionResultParams: AuctionResultsParams) => Promise<void>} writeAuctionResults
+ */
diff --git a/packages/inter-protocol/src/vaultFactory/vault.js b/packages/inter-protocol/src/vaultFactory/vault.js
@@ -131,6 +131,9 @@ export const VaultI = M.interface('Vault', {
   getCurrentDebt: M.call().returns(AmountShape),
   getNormalizedDebt: M.call().returns(AmountShape),
   getVaultSeat: M.call().returns(SeatShape),
+  getVaultState: M.call().returns(
+    harden({ idInManager: M.string(), phase: M.string() }),
+  ),
   initVaultKit: M.call(SeatShape, StorageNodeShape).returns(M.promise()),
   liquidated: M.call().returns(undefined),
   liquidating: M.call().returns(undefined),
@@ -597,6 +600,13 @@ export const prepareVault = (baggage, makeRecorderKit, zcf) => {
           return this.state.vaultSeat;
         },
 
+        getVaultState() {
+          return {
+            idInManager: this.state.idInManager,
+            phase: this.state.phase,
+          };
+        },
+
         /**
          * @param {ZCFSeat} seat
          * @param {StorageNode} storageNode

diff --git a/packages/inter-protocol/src/vaultFactory/vaultDirector.js b/packages/inter-protocol/src/vaultFactory/vaultDirector.js
@@ -423,7 +423,7 @@ const prepareVaultDirector = (
         makeLiquidationWaker() {
           return makeWaker('liquidationWaker', _timestamp => {
             // XXX floating promise
-            allManagersDo(vm => vm.liquidateVaults(auctioneer));
+            allManagersDo(vm => vm.liquidateVaults(auctioneer, _timestamp));
           });
         },
         makeReschedulerWaker() {