@agoric/inter-protocol 0.13.3 → 0.13.4-dev-800c2bb.0

package/src/vaultFactory/types.js

@@ -1,4 +1,4 @@
-// @ts-check
+// @jessie-check
 
 /**
  * @typedef {import('./vault').VaultNotification} VaultNotification
@@ -8,7 +8,11 @@
  * @typedef {import('./vaultManager').CollateralManager} CollateralManager
  * @typedef {import('../reserve/assetReserve.js').AssetReserveLimitedCreatorFacet} AssetReserveCreatorFacet
  * @typedef {import('../reserve/assetReserve.js').AssetReservePublicFacet} AssetReservePublicFacet
+ * @typedef {import('../auction/auctioneer.js').AuctioneerPublicFacet} AuctioneerPublicFacet
  * @typedef {import('./vaultFactory.js').VaultFactoryContract['publicFacet']} VaultFactoryPublicFacet
+ *
+ * @typedef {import('@agoric/time/src/types').Timestamp} Timestamp
+ * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
  */
 
 /**
@@ -31,10 +35,11 @@
  * @property {Ratio} liquidationMargin - margin below which collateral will be
  * liquidated to satisfy the debt.
  * @property {Ratio} liquidationPenalty - penalty charged upon liquidation as proportion of debt
- * @property {Ratio} interestRate - annual interest rate charged on loans
- * @property {Ratio} loanFee - The fee (in BasisPoints) charged when opening
- * or increasing a loan.
+ * @property {Ratio} interestRate - annual interest rate charged on debt positions
+ * @property {Ratio} mintFee - The fee (in BasisPoints) charged when creating
+ * or increasing a debt position.
  * @property {Amount<'nat'>} debtLimit
+ * @property {Ratio} [liquidationPadding] - vault must maintain this in order to remove collateral or add debt
  */
 
 /**
@@ -48,24 +53,21 @@
 /**
  * @typedef  {object} VaultFactoryCreatorFacet
  * @property {AddVaultType} addVaultType
- * @property {() => Promise<Array<Collateral>>} getCollaterals
  * @property {() => Allocation} getRewardAllocation
- * @property {() => Instance} getContractGovernor
- * @property {() => Promise<Invitation>} makeCollectFeesInvitation
- * @property {() => void} updateMetrics
+ * @property {() => Promise<Invitation<string, never>>} makeCollectFeesInvitation
+ * @property {() => import('@agoric/time/src/types').TimerWaker} makeLiquidationWaker
+ * @property {() => import('@agoric/time/src/types').TimerWaker} makePriceLockWaker
  */
 
 /**
- * @callback MintAndReallocate
- *
+ * @callback MintAndTransfer
  * Mint new debt `toMint` and transfer the `fee` portion to the vaultFactory's reward
  * pool. Then reallocate over all the seat arguments and the rewardPoolSeat. Update
  * the `totalDebt` if the reallocate succeeds.
- *
- * @param {Amount} toMint
- * @param {Amount} fee
- * @param {ZCFSeat} fromSeat
- * @param {...ZCFSeat} otherSeats
+ * @param {ZCFSeat} mintReceiver
+ * @param {Amount<'nat'>} toMint
+ * @param {Amount<'nat'>} fee
+ * @param {import('@agoric/zoe/src/contractSupport/atomicTransfer.js').TransferPart[]} transfers
  * @returns {void}
  */
 
@@ -83,13 +85,13 @@
 /**
  * @typedef {object} GetVaultParams
  * @property {() => Ratio} getLiquidationMargin
- * @property {() => Ratio} getLoanFee
+ * @property {() => Ratio} getMintFee
  * @property {() => Promise<PriceQuote>} getCollateralQuote
- * @property {() => Ratio} getInterestRate - The annual interest rate on a loan
+ * @property {() => Ratio} getInterestRate - The annual interest rate on a debt position
  * @property {() => RelativeTime} getChargingPeriod - The period (in seconds) at
- *   which interest is charged to the loan.
+ *   which interest is charged to the debt position.
  * @property {() => RelativeTime} getRecordingPeriod - The period (in seconds)
- *   at which interest is recorded to the loan.
+ *   at which interest is recorded to the debt position.
  */
 
 /**
@@ -97,17 +99,11 @@
  */
 
 /**
- * @typedef {object} LoanTiming
+ * @typedef {object} InterestTiming
  * @property {RelativeTime} chargingPeriod in seconds
  * @property {RelativeTime} recordingPeriod in seconds
  */
 
-/**
- * @typedef {object} AMMFees
- * @property {bigint} poolFee
- * @property {bigint} protocolFee
- */
-
 /**
  * @typedef {object} LiquidationStrategy
  * @property {() => KeywordKeywordRecord} keywordMapping