refactor: clean up VaultFactory exported types

Agoric · Jul 22, 2022 · 72ceb6f · 72ceb6f
1 parent 4163bf8
commit 72ceb6f
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 9 deletions.
diff --git a/packages/inter-protocol/exported.js b/packages/inter-protocol/exported.js
@@ -1,3 +1,4 @@
 import './src/runStake/types.js';
+import './src/psm/types.js';
 import './src/vaultFactory/types.js';
 import './src/vpool-xyk-amm/types.js';
diff --git a/packages/inter-protocol/src/exported.js b/packages/inter-protocol/src/exported.js
diff --git a/packages/inter-protocol/src/proposals/econ-behaviors.js b/packages/inter-protocol/src/proposals/econ-behaviors.js
@@ -49,7 +49,7 @@ const CENTRAL_DENOM_NAME = 'urun';
  *   reserveCreatorFacet: import('../reserve/assetReserve.js').AssetReserveCreatorFacet,
  *   reserveGovernorCreatorFacet: GovernedContractFacetAccess<unknown>,
  *   runStakeCreatorFacet: import('../runStake/runStake.js').RunStakeCreator,
- *   vaultFactoryCreator: VaultFactory,
+ *   vaultFactoryCreator: VaultFactoryCreatorFacet,
  *   vaultFactoryGovernorCreator: GovernedContractFacetAccess<unknown>,
  *   vaultFactoryVoteCreator: unknown,
  *   minInitialDebt: NatValue,

diff --git a/packages/inter-protocol/src/vaultFactory/types.js b/packages/inter-protocol/src/vaultFactory/types.js
@@ -8,6 +8,7 @@
  * @typedef {import('./vaultManager').CollateralManager} CollateralManager
  * @typedef {import('../reserve/assetReserve.js').AssetReserveCreatorFacet} AssetReserveCreatorFacet
  * @typedef {import('../reserve/assetReserve.js').AssetReservePublicFacet} AssetReservePublicFacet
+ * @typedef {import('./vaultFactory.js').VaultFactoryContract['publicFacet']} VaultFactoryPublicFacet
  */
 
 /**
@@ -45,7 +46,7 @@
  */
 
 /**
- * @typedef  {object} VaultFactory - the creator facet
+ * @typedef  {object} VaultFactoryCreatorFacet
  * @property {AddVaultType} addVaultType
  * @property {() => Promise<Array<Collateral>>} getCollaterals
  * @property {() => Allocation} getRewardAllocation

diff --git a/packages/inter-protocol/src/vaultFactory/vaultDirector.js b/packages/inter-protocol/src/vaultFactory/vaultDirector.js
@@ -260,7 +260,7 @@ const watchGovernance = (govParams, vaultManager, oldInstall, oldTerms) => {
   });
 };
 
-/** @type {import('@agoric/vat-data/src/types').FunctionsPlusContext<MethodContext, VaultFactory>} */
+/** @type {import('@agoric/vat-data/src/types').FunctionsPlusContext<MethodContext, VaultFactoryCreatorFacet>} */
 const machineBehavior = {
   // TODO move this under governance #3924
   /**

diff --git a/packages/inter-protocol/test/vaultFactory/driver.js b/packages/inter-protocol/test/vaultFactory/driver.js
@@ -309,7 +309,7 @@ const setupServices = async (
   await startVaultFactory(space, { loanParams: loanTiming }, minInitialDebt);
 
   const governorCreatorFacet = consume.vaultFactoryGovernorCreator;
-  /** @type {Promise<VaultFactory & LimitedCreatorFacet<any>>} */
+  /** @type {Promise<VaultFactoryCreatorFacet & LimitedCreatorFacet<any>>} */
   const vaultFactoryCreatorFacet = /** @type { any } */ (
     E(governorCreatorFacet).getCreatorFacet()
   );
@@ -321,7 +321,7 @@ const setupServices = async (
     rates,
   );
 
-  /** @type {[any, VaultFactory, VFC['publicFacet'], VaultManager]} */
+  /** @type {[any, VaultFactoryCreatorFacet, VFC['publicFacet'], VaultManager]} */
   // @ts-expect-error cast
   const [governorInstance, vaultFactory, lender, aethVaultManager] =
     await Promise.all([

diff --git a/packages/inter-protocol/test/vaultFactory/test-vaultFactory.js b/packages/inter-protocol/test/vaultFactory/test-vaultFactory.js
@@ -338,7 +338,7 @@ const setupServices = async (
   await startVaultFactory(space, { loanParams: loanTiming }, minInitialDebt);
 
   const governorCreatorFacet = consume.vaultFactoryGovernorCreator;
-  /** @type {Promise<VaultFactory & LimitedCreatorFacet<VaultFactory>>} */
+  /** @type {Promise<VaultFactoryCreatorFacet & LimitedCreatorFacet<VaultFactoryCreatorFacet>>} */
   const vaultFactoryCreatorFacetP = E(governorCreatorFacet).getCreatorFacet();
   const reserveCreatorFacet = consume.reserveCreatorFacet;
   const reserveFacets = { reserveCreatorFacet };
@@ -350,7 +350,7 @@ const setupServices = async (
     'AEth',
     rates,
   );
-  /** @type {[any, VaultFactory, VFC['publicFacet'], VaultManager, PriceAuthority]} */
+  /** @type {[any, VaultFactoryCreatorFacet, VFC['publicFacet'], VaultManager, PriceAuthority]} */
   // @ts-expect-error cast
   const [
     governorInstance,