@agoric/inter-protocol 0.16.2-dev-7cc5def.0 → 0.16.2-u11.0

package/src/vaultFactory/vaultDirector.js

@@ -44,34 +44,30 @@ const trace = makeTracer('VD', true);
 
 /**
  * @typedef {{
- *   collaterals: Brand[];
- *   rewardPoolAllocation: AmountKeywordRecord;
+ * collaterals: Brand[],
+ * rewardPoolAllocation: AmountKeywordRecord,
  * }} MetricsNotification
  *
- * @typedef {Readonly<{}>} ImmutableState
+ * @typedef {Readonly<{
+ * }>} ImmutableState
  *
- * @typedef {{}} MutableState
+ * @typedef {{
+ * }} MutableState
  *
  * @typedef {ImmutableState & MutableState} State
  *
  * @typedef {{
- *   burnDebt: BurnDebt;
- *   getGovernedParams: (
- *     collateralBrand: Brand,
- *   ) => import('./vaultManager.js').GovernedParamGetters;
- *   mintAndTransfer: MintAndTransfer;
- *   getShortfallReporter: () => Promise<
- *     import('../reserve/assetReserve.js').ShortfallReporter
- *   >;
+ *  burnDebt: BurnDebt,
+ *  getGovernedParams: (collateralBrand: Brand) => import('./vaultManager.js').GovernedParamGetters,
+ *  mintAndTransfer: MintAndTransfer,
+ *  getShortfallReporter: () => Promise<import('../reserve/assetReserve.js').ShortfallReporter>,
  * }} FactoryPowersFacet
  *
  * @typedef {Readonly<{
  *   state: State;
  * }>} MethodContext
  *
- * @typedef {import('@agoric/governance/src/contractGovernance/typedParamManager').TypedParamManager<
- *     import('./params.js').VaultDirectorParams
- *   >} VaultDirectorParamManager
+ * @typedef {import('@agoric/governance/src/contractGovernance/typedParamManager').TypedParamManager<import('./params.js').VaultDirectorParams>} VaultDirectorParamManager
  */
 
 const shortfallInvitationKey = 'shortfallInvitation';
@@ -80,7 +76,7 @@ const shortfallInvitationKey = 'shortfallInvitation';
  * @param {import('@agoric/ertp').Baggage} baggage
  * @param {import('./vaultFactory.js').VaultFactoryZCF} zcf
  * @param {VaultDirectorParamManager} directorParamManager
- * @param {ZCFMint<'nat'>} debtMint
+ * @param {ZCFMint<"nat">} debtMint
  * @param {ERef<import('@agoric/time/src/types').TimerService>} timer
  * @param {ERef<import('../auction/auctioneer.js').AuctioneerPublicFacet>} auctioneer
  * @param {ERef<StorageNode>} storageNode
@@ -130,7 +126,9 @@ const prepareVaultDirector = (
 
   const managersNode = E(storageNode).makeChildNode('managers');
 
-  /** @returns {MetricsNotification} */
+  /**
+   * @returns {MetricsNotification}
+   */
   const sampleMetrics = () => {
     return harden({
       collaterals: Array.from(collateralManagers.keys()),
@@ -190,15 +188,15 @@ const prepareVaultDirector = (
     },
 
     /**
-     * Let the manager add rewards to the rewardPoolSeat without exposing the
-     * rewardPoolSeat to them.
+     * Let the manager add rewards to the rewardPoolSeat without
+     * exposing the rewardPoolSeat to them.
      *
      * @type {MintAndTransfer}
      */
     mintAndTransfer: (mintReceiver, toMint, fee, nonMintTransfers) => {
       const kept = AmountMath.subtract(toMint, fee);
       debtMint.mintGains(harden({ Minted: toMint }), mintSeat);
-      /** @type {TransferPart[]} */
+      /** @type {import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]} */
       const transfers = [
         ...nonMintTransfers,
         [mintSeat, rewardPoolSeat, { Minted: fee }],
@@ -252,7 +250,6 @@ const prepareVaultDirector = (
     metrics: makeRecorderTopic('Vault Factory metrics', metricsKit),
   });
 
-  /** @param {(vm: VaultManager) => void} fn */
   const allManagersDo = fn => {
     for (const managerIndex of collateralManagers.values()) {
       const vm = vaultManagers.get(managerIndex).self;
@@ -266,7 +263,9 @@ const prepareVaultDirector = (
     });
   };
 
-  /** @returns {State} */
+  /**
+   * @returns {State}
+   */
   const initState = () => {
     return {};
   };
@@ -276,7 +275,7 @@ const prepareVaultDirector = (
    *
    * @param {import('./vaultFactory.js').VaultFactoryZCF} zcf
    * @param {VaultDirectorParamManager} directorParamManager
-   * @param {ZCFMint<'nat'>} debtMint
+   * @param {ZCFMint<"nat">} debtMint
    */
   const makeVaultDirector = prepareExoClassKit(
     baggage,
@@ -331,7 +330,9 @@ const prepareVaultDirector = (
               }
             },
           }),
-        /** @param {string} name */
+        /**
+         * @param {string} name
+         */
         getInvitation(name) {
           return directorParamManager.getInternalParamValue(name);
         },
@@ -423,7 +424,6 @@ const prepareVaultDirector = (
 
         makeLiquidationWaker() {
           return makeWaker('liquidationWaker', _timestamp => {
-            // XXX floating promise
             allManagersDo(vm => vm.liquidateVaults(auctioneer));
           });
         },
@@ -440,7 +440,9 @@ const prepareVaultDirector = (
         },
       },
       public: {
-        /** @param {Brand} brandIn */
+        /**
+         * @param {Brand} brandIn
+         */
         getCollateralManager(brandIn) {
           collateralManagers.has(brandIn) ||
             Fail`Not a supported collateral type ${brandIn}`;
@@ -461,16 +463,22 @@ const prepareVaultDirector = (
         getPublicTopics() {
           return topics;
         },
-        /** subscription for the paramManager for the vaultFactory's electorate */
+        /**
+         * subscription for the paramManager for the vaultFactory's electorate
+         */
         getElectorateSubscription() {
           return directorParamManager.getSubscription();
         },
-        /** @param {{ collateralBrand: Brand }} selector */
+        /**
+         * @param {{ collateralBrand: Brand }} selector
+         */
         getGovernedParams({ collateralBrand }) {
           // TODO use named getters of TypedParamManager
           return vaultParamManagers.get(collateralBrand).getParams();
         },
-        /** @param {string} name */
+        /**
+         * @param {string} name
+         */
         getInvitationAmount(name) {
           return directorParamManager.getInvitationAmount(name);
         },
@@ -490,7 +498,9 @@ const prepareVaultDirector = (
             rescheduleWaker,
           );
         },
-        /** Start non-durable processes (or restart if needed after vat restart) */
+        /**
+         * Start non-durable processes (or restart if needed after vat restart)
+         */
         async start() {
           const { helper, machine } = this.facets;
 
@@ -515,9 +525,7 @@ harden(prepareVaultDirector);
 /**
  * Prepare the VaultDirector kind, get or make the singleton
  *
- * @type {(
- *   ...pvdArgs: Parameters<typeof prepareVaultDirector>
- * ) => ReturnType<ReturnType<typeof prepareVaultDirector>>}
+ * @type {(...pvdArgs: Parameters<typeof prepareVaultDirector>) => ReturnType<ReturnType<typeof prepareVaultDirector>>}
  */
 export const provideDirector = (...args) => {
   const makeVaultDirector = prepareVaultDirector(...args);

package/src/vaultFactory/vaultFactory.js

@@ -34,46 +34,40 @@ import { provideDirector } from './vaultDirector.js';
 const trace = makeTracer('VF', true);
 
 /**
- * @typedef {ZCF<
- *   GovernanceTerms<import('./params').VaultDirectorParams> & {
- *     auctioneerPublicFacet: import('../auction/auctioneer.js').AuctioneerPublicFacet;
- *     priceAuthority: ERef<PriceAuthority>;
- *     reservePublicFacet: AssetReservePublicFacet;
- *     timerService: import('@agoric/time/src/types').TimerService;
- *   }
- * >} VaultFactoryZCF
+ * @typedef {ZCF<GovernanceTerms<import('./params').VaultDirectorParams> & {
+ *   auctioneerPublicFacet: import('../auction/auctioneer.js').AuctioneerPublicFacet,
+ *   priceAuthority: ERef<PriceAuthority>,
+ *   reservePublicFacet: AssetReservePublicFacet,
+ *   timerService: import('@agoric/time/src/types').TimerService,
+ * }>} VaultFactoryZCF
  */
 
-/** @type {ContractMeta} */
-export const meta = {
-  privateArgsShape: M.splitRecord(
-    {
-      marshaller: M.remotable('Marshaller'),
-      storageNode: StorageNodeShape,
-    },
-    {
-      // only necessary on first invocation, not subsequent
-      feeMintAccess: FeeMintAccessShape,
-      initialPoserInvitation: InvitationShape,
-      initialShortfallInvitation: InvitationShape,
-    },
-  ),
-  upgradability: 'canUpgrade',
-};
-harden(meta);
+export const privateArgsShape = M.splitRecord(
+  harden({
+    marshaller: M.remotable('Marshaller'),
+    storageNode: StorageNodeShape,
+  }),
+  harden({
+    // only necessary on first invocation, not subsequent
+    feeMintAccess: FeeMintAccessShape,
+    initialPoserInvitation: InvitationShape,
+    initialShortfallInvitation: InvitationShape,
+  }),
+);
+harden(privateArgsShape);
 
 /**
  * @param {VaultFactoryZCF} zcf
  * @param {{
- *   feeMintAccess: FeeMintAccess;
- *   initialPoserInvitation: Invitation;
- *   initialShortfallInvitation: Invitation;
- *   storageNode: ERef<StorageNode>;
- *   marshaller: ERef<Marshaller>;
+ *   feeMintAccess: FeeMintAccess,
+ *   initialPoserInvitation: Invitation,
+ *   initialShortfallInvitation: Invitation,
+ *   storageNode: ERef<StorageNode>,
+ *   marshaller: ERef<Marshaller>,
  * }} privateArgs
  * @param {import('@agoric/ertp').Baggage} baggage
  */
-export const start = async (zcf, privateArgs, baggage) => {
+export const prepare = async (zcf, privateArgs, baggage) => {
   trace('prepare start', privateArgs, [...baggage.keys()]);
   const {
     initialPoserInvitation,
@@ -151,6 +145,5 @@ export const start = async (zcf, privateArgs, baggage) => {
     publicFacet: director.public,
   });
 };
-harden(start);
 
-/** @typedef {ContractOf<typeof start>} VaultFactoryContract */
+/** @typedef {ContractOf<typeof prepare>} VaultFactoryContract */

package/src/vaultFactory/vaultHolder.js

@@ -1,15 +1,17 @@
-/** @file Use-object for the owner of a vault */
+/**
+ * @file Use-object for the owner of a vault
+ */
 import { AmountShape } from '@agoric/ertp';
 import { M, prepareExoClassKit } from '@agoric/vat-data';
 import { TopicsRecordShape } from '@agoric/zoe/src/contractSupport/index.js';
-import { UnguardedHelperI } from '@agoric/internal/src/typeGuards.js';
+import { UnguardedHelperI } from '../typeGuards.js';
 
 const { Fail } = assert;
 
 /**
  * @typedef {{
- *   topicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<VaultNotification>;
- *   vault: Vault | null;
+ * topicKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<VaultNotification>,
+ * vault: Vault | null,
  * }} State
  */
 
@@ -23,7 +25,7 @@ const HolderI = M.interface('holder', {
   makeTransferInvitation: M.call().returns(M.promise()),
 });
 
-/** @type {{ [name: string]: [description: string, valueShape: Pattern] }} */
+/** @type {{ [name: string]: [ description: string, valueShape: Pattern ] }} */
 const PUBLIC_TOPICS = {
   vault: ['Vault holder status', M.any()],
 };
@@ -46,6 +48,7 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
       }),
     },
     /**
+     *
      * @param {Vault} vault
      * @param {StorageNode} storageNode
      * @returns {State}
@@ -58,7 +61,9 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
     },
     {
       helper: {
-        /** @throws if this holder no longer owns the vault */
+        /**
+         * @throws if this holder no longer owns the vault
+         */
         owned() {
           const { vault } = this.state;
           if (!vault) {
@@ -99,8 +104,8 @@ export const prepareVaultHolder = (baggage, makeRecorderKit) => {
           return this.facets.helper.owned().makeCloseInvitation();
         },
         /**
-         * Starting a transfer revokes the vault holder. The associated updater
-         * will get a special notification that the vault is being transferred.
+         * Starting a transfer revokes the vault holder. The associated updater will
+         * get a special notification that the vault is being transferred.
          */
         makeTransferInvitation() {
           const vault = this.facets.helper.owned();

package/src/vaultFactory/vaultKit.js

@@ -8,8 +8,7 @@ import { prepareVaultHolder } from './vaultHolder.js';
 const trace = makeTracer('VK', true);
 
 /**
- * Wrap the VaultHolder duration object in a record suitable for the result of
- * an invitation.
+ * Wrap the VaultHolder duration object in a record suitable for the result of an invitation.
  *
  * @param {import('@agoric/ertp').Baggage} baggage
  * @param {import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit} makeRecorderKit
@@ -44,4 +43,4 @@ export const prepareVaultKit = (baggage, makeRecorderKit) => {
   return makeVaultKit;
 };
 
-/** @typedef {ReturnType<ReturnType<typeof prepareVaultKit>>} VaultKit */
+/** @typedef {(ReturnType<ReturnType<typeof prepareVaultKit>>)} VaultKit */