docs(auction): types for prepareAuctionHook

the `any` type for `zcf` cascaded to the rest of the function
Agoric · Mar 21, 2023 · 818edfb · 818edfb
1 parent 1199c85
commit 818edfb
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/packages/inter-protocol/src/auction/auctionBook.js b/packages/inter-protocol/src/auction/auctionBook.js
@@ -85,6 +85,10 @@ export const makeBidSpecShape = (currencyBrand, collateralBrand) => {
 
 /** @typedef {import('@agoric/vat-data').Baggage} Baggage */
 
+/**
+ * @param {Baggage} baggage
+ * @param {ZCF} zcf
+ */
 export const prepareAuctionBook = (baggage, zcf) => {
   const makeScaledBidBook = prepareScaledBidBook(baggage);
   const makePriceBook = preparePriceBook(baggage);