chore(amm): types

Agoric · Apr 16, 2022 · cad92bb · cad92bb
1 parent d773ba6
commit cad92bb
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 10 deletions.
diff --git a/packages/run-protocol/src/vpool-xyk-amm/doublePool.js b/packages/run-protocol/src/vpool-xyk-amm/doublePool.js
@@ -27,7 +27,7 @@ const publicPrices = prices => {
  * @param {() => bigint} getProtocolFeeBP - retrieve governed protocol fee value
  * @param {() => bigint} getPoolFeeBP - retrieve governed pool fee value
  * @param {ZCFSeat} feeSeat
- * @returns {VPoolWrapper<VPoolInternalFacet>}
+ * @returns {VPoolWrapper<DoublePoolInternalFacet>}
  */
 export const makeDoublePool = (
   zcf,

diff --git a/packages/run-protocol/src/vpool-xyk-amm/multipoolMarketMaker.js b/packages/run-protocol/src/vpool-xyk-amm/multipoolMarketMaker.js
@@ -178,7 +178,7 @@ const start = async (zcf, privateArgs) => {
   /**
    * @param {Brand} brandIn
    * @param {Brand} brandOut
-   * @returns {VPoolWrapper<unknown>}
+   * @returns {VPoolWrapper<DoublePoolInternalFacet>}
    */
   const provideVPool = (brandIn, brandOut) => {
     if (isSecondary(brandIn) && isSecondary(brandOut)) {
@@ -193,6 +193,7 @@ const start = async (zcf, privateArgs) => {
     }
 
     const pool = isSecondary(brandOut) ? getPool(brandOut) : getPool(brandIn);
+    // @ts-expect-error cast
     return pool.getVPool();
   };
 

diff --git a/packages/run-protocol/src/vpool-xyk-amm/swap.js b/packages/run-protocol/src/vpool-xyk-amm/swap.js
@@ -1,15 +1,13 @@
 // @ts-check
 
-// @ts-ignore
 import { assertProposalShape } from '@agoric/zoe/src/contractSupport/index.js';
 
 import '@agoric/zoe/exported.js';
-// @ts-ignore
 import { AmountMath } from '@agoric/ertp';
 
 /**
  * @param {ZCF} zcf
- * @param {(brandIn: Brand, brandOut: Brand) => VPoolWrapper<unknown>} provideVPool
+ * @param {(brandIn: Brand, brandOut: Brand) => VPoolWrapper<DoublePoolInternalFacet>} provideVPool
  */
 export const makeMakeSwapInvitation = (zcf, provideVPool) => {
   /**
@@ -32,16 +30,13 @@ export const makeMakeSwapInvitation = (zcf, provideVPool) => {
     const maxOut = args.maxOut;
     if (maxOut) {
       AmountMath.coerce(amountOut.brand, maxOut);
-      // @ts-ignore
       prices = pool.getPriceForOutput(amountIn, maxOut);
     }
     if (!prices || !AmountMath.isGTE(prices.swapperGets, maxOut)) {
       // `amountIn` is not enough to sell for maxOut so just sell it all
-      // @ts-ignore
       prices = pool.getPriceForInput(amountIn, amountOut);
     }
     assert(amountIn.brand === prices.swapperGives.brand);
-    // @ts-ignore
     return pool.allocateGainsAndLosses(seat, prices);
   };
 

diff --git a/packages/run-protocol/src/vpool-xyk-amm/types.js b/packages/run-protocol/src/vpool-xyk-amm/types.js
@@ -38,10 +38,10 @@
  */
 
 /**
- * @typedef {Object} VPoolInternalFacet - virtual pool for price quotes and trading
+ * @typedef {Object} DoublePoolInternalFacet - virtual pool for price quotes and trading
  * @property {GetDoublePoolSwapQuote} getPriceForInput
  * @property {GetDoublePoolSwapQuote} getPriceForOutput
- * @property {(ZCFSeat, DoublePoolSwapResult) => string} allocateGainsAndLosses
+ * @property {(seat: ZCFSeat, result: DoublePoolSwapResult) => string} allocateGainsAndLosses
  */
 
 /**