@agoric/inter-protocol 0.16.1-dev-590740f.0 → 0.16.1-dev-69236fd.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.16.1-dev-590740f.0+590740f",
+  "version": "0.16.1-dev-69236fd.0+69236fd",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -10,6 +10,7 @@
   "scripts": {
     "build": "yarn build:bundles",
     "build:bundles": "node ./scripts/build-bundles.js",
+    "build:add-STARS-proposal": "agoric run scripts/add-STARS.js",
     "test": "ava",
     "test:c8": "c8 $C8_OPTIONS ava --config=ava-nesm.config.js",
     "test:xs": "exit 0",
@@ -29,29 +30,29 @@
   },
   "homepage": "https://github.com/Agoric/agoric-sdk#readme",
   "dependencies": {
-    "@agoric/assert": "0.6.1-dev-590740f.0+590740f",
-    "@agoric/ertp": "0.16.3-dev-590740f.0+590740f",
-    "@agoric/governance": "0.10.3-dev-590740f.0+590740f",
-    "@agoric/internal": "0.3.3-dev-590740f.0+590740f",
-    "@agoric/notifier": "0.6.3-dev-590740f.0+590740f",
-    "@agoric/store": "0.9.3-dev-590740f.0+590740f",
-    "@agoric/time": "0.3.3-dev-590740f.0+590740f",
-    "@agoric/vat-data": "0.5.3-dev-590740f.0+590740f",
-    "@agoric/vats": "0.15.1-dev-590740f.0+590740f",
-    "@agoric/zoe": "0.26.3-dev-590740f.0+590740f",
+    "@agoric/assert": "0.6.1-dev-69236fd.0+69236fd",
+    "@agoric/ertp": "0.16.3-dev-69236fd.0+69236fd",
+    "@agoric/governance": "0.10.3-dev-69236fd.0+69236fd",
+    "@agoric/internal": "0.3.3-dev-69236fd.0+69236fd",
+    "@agoric/notifier": "0.6.3-dev-69236fd.0+69236fd",
+    "@agoric/store": "0.9.3-dev-69236fd.0+69236fd",
+    "@agoric/time": "0.3.3-dev-69236fd.0+69236fd",
+    "@agoric/vat-data": "0.5.3-dev-69236fd.0+69236fd",
+    "@agoric/vats": "0.15.1-dev-69236fd.0+69236fd",
+    "@agoric/zoe": "0.26.3-dev-69236fd.0+69236fd",
     "@endo/captp": "^3.1.1",
     "@endo/eventual-send": "^0.17.2",
     "@endo/far": "^0.2.18",
     "@endo/marshal": "^0.8.5",
     "@endo/nat": "^4.1.27",
-    "agoric": "0.21.1-dev-590740f.0+590740f",
+    "agoric": "0.21.1-dev-69236fd.0+69236fd",
     "jessie.js": "^0.3.2"
   },
   "devDependencies": {
-    "@agoric/deploy-script-support": "0.10.3-dev-590740f.0+590740f",
-    "@agoric/smart-wallet": "0.5.3-dev-590740f.0+590740f",
-    "@agoric/swingset-liveslots": "0.10.3-dev-590740f.0+590740f",
-    "@agoric/swingset-vat": "0.32.3-dev-590740f.0+590740f",
+    "@agoric/deploy-script-support": "0.10.3-dev-69236fd.0+69236fd",
+    "@agoric/smart-wallet": "0.5.3-dev-69236fd.0+69236fd",
+    "@agoric/swingset-liveslots": "0.10.3-dev-69236fd.0+69236fd",
+    "@agoric/swingset-vat": "0.32.3-dev-69236fd.0+69236fd",
     "@endo/bundle-source": "^2.5.1",
     "@endo/init": "^0.5.56",
     "@endo/promise-kit": "^0.2.56",
@@ -79,5 +80,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "590740f3ca7597791a220239084ec1ea5b9918ba"
+  "gitHead": "69236fdbdce1521dd78da104bd54f331d4d2b28f"
 }

package/scripts/add-STARS.js

@@ -0,0 +1,43 @@
+import { makeHelpers } from '@agoric/deploy-script-support';
+import { defaultProposalBuilder as vaultProposalBuilder } from './add-collateral-core.js';
+import { defaultProposalBuilder as oraclesProposalBuilder } from './price-feed-core.js';
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
+export const starsVaultProposalBuilder = async powers => {
+  return vaultProposalBuilder(powers, {
+    interchainAssetOptions: {
+      // Values for the Stargaze token on Osmosis
+      denom:
+        'ibc/987C17B11ABC2B20019178ACE62929FE9840202CE79498E29FE8E5CB02B7C0A4',
+      decimalPlaces: 6,
+      keyword: 'STARS',
+      oracleBrand: 'STARS',
+      proposedName: 'STARS',
+    },
+  });
+};
+
+/** @type {import('@agoric/deploy-script-support/src/externalTypes.js').ProposalBuilder} */
+export const starsOraclesProposalBuilder = async powers => {
+  return oraclesProposalBuilder(powers, {
+    AGORIC_INSTANCE_NAME: `STARS-USD price feed`,
+    IN_BRAND_LOOKUP: ['agoricNames', 'oracleBrand', 'STARS'],
+    IN_BRAND_DECIMALS: 6,
+    OUT_BRAND_LOOKUP: ['agoricNames', 'oracleBrand', 'USD'],
+    OUT_BRAND_DECIMALS: 4,
+    oracleAddresses: [
+      // copied from decentral-main-vaults-config.json
+      'agoric1krunjcqfrf7la48zrvdfeeqtls5r00ep68mzkr',
+      'agoric19uscwxdac6cf6z7d5e26e0jm0lgwstc47cpll8',
+      'agoric144rrhh4m09mh7aaffhm6xy223ym76gve2x7y78',
+      'agoric19d6gnr9fyp6hev4tlrg87zjrzsd5gzr5qlfq2p',
+      'agoric1n4fcxsnkxe4gj6e24naec99hzmc4pjfdccy5nj',
+    ],
+  });
+};
+
+export default async (homeP, endowments) => {
+  const { writeCoreProposal } = await makeHelpers(homeP, endowments);
+  await writeCoreProposal('add-STARS', starsVaultProposalBuilder);
+  await writeCoreProposal('add-STARS-oracles', starsOraclesProposalBuilder);
+};

package/scripts/add-collateral-core.js

@@ -10,7 +10,7 @@ export const defaultProposalBuilder = async (
   { publishRef, install: install0, wrapInstall },
   {
     debtLimitValue = undefined,
-    interestRateValue = undefined,
+    stabilityFeeValue = undefined,
     interchainAssetOptions = /** @type {object} */ ({}),
   } = {},
   { env = process.env } = {},
@@ -38,7 +38,7 @@ export const defaultProposalBuilder = async (
       getManifestForAddAssetToVault.name,
       {
         debtLimitValue: debtLimitValue && BigInt(debtLimitValue),
-        interestRateValue: interestRateValue && BigInt(interestRateValue),
+        stabilityFeeValue: stabilityFeeValue && BigInt(stabilityFeeValue),
         interchainAssetOptions: {
           denom,
           issuerBoardId,

package/src/interest-math.js

@@ -9,39 +9,39 @@ import {
 } from '@agoric/zoe/src/contractSupport/ratio.js';
 
 /**
- * @param {Ratio} currentCompoundedInterest as coefficient
- * @param {Ratio} previousCompoundedInterest as coefficient
+ * @param {Ratio} currentCompoundedStabilityFee as coefficient
+ * @param {Ratio} previousCompoundedStabilityFee as coefficient
  * @returns {Ratio} additional compounding since the previous
  */
 const calculateRelativeCompounding = (
-  currentCompoundedInterest,
-  previousCompoundedInterest,
+  currentCompoundedStabilityFee,
+  previousCompoundedStabilityFee,
 ) => {
   // divide compounded interest by the snapshot
   return multiplyRatios(
-    currentCompoundedInterest,
-    invertRatio(previousCompoundedInterest),
+    currentCompoundedStabilityFee,
+    invertRatio(previousCompoundedStabilityFee),
   );
 };
 
 /**
  * @param {Amount<'nat'>} debtSnapshot
- * @param {Ratio} interestSnapshot as coefficient
- * @param {Ratio} currentCompoundedInterest as coefficient
+ * @param {Ratio} stabilityFeeSnapshot as coefficient
+ * @param {Ratio} currentCompoundedStabilityFee as coefficient
  * @returns {Amount<'nat'>}
  */
 export const calculateCurrentDebt = (
   debtSnapshot,
-  interestSnapshot,
-  currentCompoundedInterest,
+  stabilityFeeSnapshot,
+  currentCompoundedStabilityFee,
 ) => {
-  if (ratiosSame(interestSnapshot, currentCompoundedInterest)) {
+  if (ratiosSame(stabilityFeeSnapshot, currentCompoundedStabilityFee)) {
     return debtSnapshot;
   }
 
   const interestSinceSnapshot = calculateRelativeCompounding(
-    currentCompoundedInterest,
-    interestSnapshot,
+    currentCompoundedStabilityFee,
+    stabilityFeeSnapshot,
   );
 
   return multiplyBy(debtSnapshot, interestSinceSnapshot);

package/src/interest.js

@@ -57,8 +57,8 @@ export const makeInterestCalculator = (
    * @type {Calculate}
    */
   const calculate = (debtStatus, currentTime) => {
-    const { newDebt, latestInterestUpdate } = debtStatus;
-    let newRecent = latestInterestUpdate;
+    const { newDebt, latestStabilityFeeUpdate } = debtStatus;
+    let newRecent = latestStabilityFeeUpdate;
     let growingInterest = debtStatus.interest;
     let growingDebt = newDebt;
     while (
@@ -78,7 +78,7 @@ export const makeInterestCalculator = (
       growingDebt += newInterest;
     }
     return {
-      latestInterestUpdate: newRecent,
+      latestStabilityFeeUpdate: newRecent,
       interest: growingInterest,
       newDebt: growingDebt,
     };
@@ -93,9 +93,9 @@ export const makeInterestCalculator = (
    * @type {Calculate}
    */
   const calculateReportingPeriod = (debtStatus, currentTime) => {
-    const { latestInterestUpdate } = debtStatus;
+    const { latestStabilityFeeUpdate } = debtStatus;
     const overshoot = TimeMath.modRelRel(
-      TimeMath.subtractAbsAbs(currentTime, latestInterestUpdate),
+      TimeMath.subtractAbsAbs(currentTime, latestStabilityFeeUpdate),
       recordingPeriod,
     );
     return calculate(
@@ -111,20 +111,20 @@ export const makeInterestCalculator = (
 };
 
 /**
- * compoundedInterest *= (new debt) / (prior total debt)
+ * compoundedStabilityFee *= (new debt) / (prior total debt)
  *
- * @param {Ratio} priorCompoundedInterest
+ * @param {Ratio} priorCompoundedStabilityFee
  * @param {NatValue} priorDebt
  * @param {NatValue} newDebt
  */
-export const calculateCompoundedInterest = (
-  priorCompoundedInterest,
+export const calculateCompoundedStabilityFee = (
+  priorCompoundedStabilityFee,
   priorDebt,
   newDebt,
 ) => {
-  const brand = priorCompoundedInterest.numerator.brand;
+  const brand = priorCompoundedStabilityFee.numerator.brand;
   const compounded = multiplyRatios(
-    priorCompoundedInterest,
+    priorCompoundedStabilityFee,
     makeRatio(newDebt, brand, priorDebt, brand),
   );
   return quantize(compounded, COMPOUNDED_INTEREST_DENOMINATOR);
@@ -144,7 +144,7 @@ const validatedBrand = (mint, debt) => {
 };
 
 /**
- * Charge interest accrued between `latestInterestUpdate` and `accruedUntil`.
+ * Charge interest accrued between `latestStabilityFeeUpdate` and `accruedUntil`.
  *
  * @param {{
  *  mint: ZCFMint<'nat'>,
@@ -152,21 +152,21 @@ const validatedBrand = (mint, debt) => {
  *  poolIncrementSeat: ZCFSeat,
  *  seatAllocationKeyword: Keyword }} powers
  * @param {{
- *  interestRate: Ratio,
+ *  stabilityFee: Ratio,
  *  chargingPeriod: RelativeTime,
  *  recordingPeriod: RelativeTime}} params
  * @param {{
- *  latestInterestUpdate: Timestamp,
- *  compoundedInterest: Ratio,
+ *  latestStabilityFeeUpdate: Timestamp,
+ *  compoundedStabilityFee: Ratio,
  *  totalDebt: Amount<'nat'>}} prior
  * @param {Timestamp} accruedUntil
- * @returns {{compoundedInterest: Ratio, latestInterestUpdate: Timestamp, totalDebt: Amount<'nat'> }}
+ * @returns {{compoundedStabilityFee: Ratio, latestStabilityFeeUpdate: Timestamp, totalDebt: Amount<'nat'> }}
  */
 export const chargeInterest = (powers, params, prior, accruedUntil) => {
   const brand = validatedBrand(powers.mint, prior.totalDebt);
 
   const interestCalculator = makeInterestCalculator(
-    params.interestRate,
+    params.stabilityFee,
     params.chargingPeriod,
     params.recordingPeriod,
   );
@@ -174,7 +174,7 @@ export const chargeInterest = (powers, params, prior, accruedUntil) => {
   // calculate delta of accrued debt
   const debtStatus = interestCalculator.calculateReportingPeriod(
     {
-      latestInterestUpdate: prior.latestInterestUpdate,
+      latestStabilityFeeUpdate: prior.latestStabilityFeeUpdate,
       newDebt: prior.totalDebt.value,
       interest: 0n, // XXX this is always zero, doesn't need to be an option
     },
@@ -185,8 +185,8 @@ export const chargeInterest = (powers, params, prior, accruedUntil) => {
   // done if none
   if (interestAccrued === 0n) {
     return {
-      compoundedInterest: prior.compoundedInterest,
-      latestInterestUpdate: debtStatus.latestInterestUpdate,
+      compoundedStabilityFee: prior.compoundedStabilityFee,
+      latestStabilityFeeUpdate: debtStatus.latestStabilityFeeUpdate,
       totalDebt: prior.totalDebt,
     };
   }
@@ -196,8 +196,8 @@ export const chargeInterest = (powers, params, prior, accruedUntil) => {
   // testing with small numbers there's 5 digits of precision, and with large
   // numbers the ratios tend towards ample precision.
   // TODO adopt banker's rounding https://github.com/Agoric/agoric-sdk/issues/4573
-  const compoundedInterest = calculateCompoundedInterest(
-    prior.compoundedInterest,
+  const compoundedStabilityFee = calculateCompoundedStabilityFee(
+    prior.compoundedStabilityFee,
     prior.totalDebt.value,
     debtStatus.newDebt,
   );
@@ -218,8 +218,8 @@ export const chargeInterest = (powers, params, prior, accruedUntil) => {
   );
 
   return {
-    compoundedInterest,
-    latestInterestUpdate: debtStatus.latestInterestUpdate,
+    compoundedStabilityFee,
+    latestStabilityFeeUpdate: debtStatus.latestStabilityFeeUpdate,
     totalDebt,
   };
 };

package/src/proposals/addAssetToVault.js

@@ -1,11 +1,12 @@
 // @jessie-check
 
 import { AmountMath, AssetKind } from '@agoric/ertp';
-import { makeRatio } from '@agoric/zoe/src/contractSupport/index.js';
 import { deeplyFulfilledObject } from '@agoric/internal';
 import { Stable } from '@agoric/vats/src/tokens.js';
-import { E } from '@endo/far';
+import { makeRatio } from '@agoric/zoe/src/contractSupport/index.js';
 import { parseRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
+import { E } from '@endo/far';
+import { instanceNameFor } from './price-feed-proposal.js';
 import { reserveThenGetNames } from './utils.js';
 
 export * from './startPSM.js';
@@ -211,7 +212,7 @@ export const registerScaledPriceAuthority = async (
  * @param {object} config.options
  * @param {InterchainAssetOptions} config.options.interchainAssetOptions
  * @param {bigint | number | string} config.options.debtLimitValue
- * @param {bigint} config.options.interestRateValue
+ * @param {bigint} config.options.stabilityFeeValue
  */
 export const addAssetToVault = async (
   {
@@ -219,6 +220,7 @@ export const addAssetToVault = async (
     brand: {
       consume: { [Stable.symbol]: stableP },
     },
+    instance: { consume: consumeInstance },
   },
   {
     options: {
@@ -226,7 +228,7 @@ export const addAssetToVault = async (
       debtLimitValue = 1_000n * 1_000_000n,
       // Default to a safe value. Production will likely set this through governance.
       // Allow setting through bootstrap to simplify testing.
-      interestRateValue = 1n,
+      stabilityFeeValue = 1n,
       interchainAssetOptions,
     },
   },
@@ -239,11 +241,16 @@ export const addAssetToVault = async (
     [keyword],
   );
 
+  const oracleInstanceName = instanceNameFor(oracleBrand, 'USD');
+  // don't add the collateral offering to vaultFactory until its price feed is available
+  // eslint-disable-next-line no-restricted-syntax -- allow this computed property
+  await consumeInstance[oracleInstanceName];
+
   const stable = await stableP;
   const vaultFactoryCreator = E.get(vaultFactoryKit).creatorFacet;
   await E(vaultFactoryCreator).addVaultType(interchainIssuer, oracleBrand, {
     debtLimit: AmountMath.make(stable, BigInt(debtLimitValue)),
-    interestRate: makeRatio(interestRateValue, stable),
+    stabilityFee: makeRatio(stabilityFeeValue, stable),
     // The rest of these we use safe defaults.
     // In production they will be governed by the Econ Committee.
     // Product deployments are also expected to have a low debtLimitValue at the outset,
@@ -261,7 +268,7 @@ export const getManifestForAddAssetToVault = (
   { restoreRef },
   {
     debtLimitValue,
-    interestRateValue,
+    stabilityFeeValue,
     interchainAssetOptions,
     scaledPriceAuthorityRef,
   },
@@ -321,6 +328,11 @@ export const getManifestForAddAssetToVault = (
         brand: {
           consume: { [Stable.symbol]: true },
         },
+        instance: {
+          // allow any instance because the AGORIC_INSTANCE_NAME of
+          // priceFeedOptions cannot be known statically.
+          consume: true,
+        },
       },
     },
     installations: {
@@ -329,7 +341,7 @@ export const getManifestForAddAssetToVault = (
     options: {
       debtLimitValue,
       interchainAssetOptions,
-      interestRateValue,
+      stabilityFeeValue,
     },
   };
 };

package/src/proposals/price-feed-proposal.js

@@ -1,10 +1,10 @@
 // @ts-nocheck -- lots of type errors. low prio b/c proposals are like scripts
-import { E } from '@endo/far';
+import { makeTracer } from '@agoric/internal';
 import {
-  makeStorageNodeChild,
   assertPathSegment,
+  makeStorageNodeChild,
 } from '@agoric/internal/src/lib-chainStorage.js';
-import { makeTracer } from '@agoric/internal';
+import { E } from '@endo/far';
 
 import { unitAmount } from '@agoric/zoe/src/contractSupport/priceQuote.js';
 import { reserveThenDeposit, reserveThenGetNames } from './utils.js';
@@ -18,6 +18,9 @@ const sanitizePathSegment = name => {
   return candidate;
 };
 
+export const instanceNameFor = (inBrandName, outBrandName) =>
+  `${inBrandName}-${outBrandName} price feed`;
+
 /**
  * @typedef {{
  * brandIn?: ERef<Brand<'nat'> | undefined>,
@@ -95,6 +98,7 @@ export const createPriceFeed = async (
       priceAuthorityAdmin,
       startGovernedUpgradable,
     },
+    instance: { produce: produceInstance },
   },
   {
     options: {
@@ -160,11 +164,27 @@ export const createPriceFeed = async (
     installation: priceAggregator,
   });
 
-  E(E(agoricNamesAdmin).lookupAdmin('instance'))
+  // Publish price feed in home.priceAuthority.
+  const forceReplace = true;
+  // Make sure this PA is registered before sharing the instance in agoricNames,
+  // which allows contracts that depend on the registry value to wait for it and
+  // prevent a race.
+  await E(priceAuthorityAdmin).registerPriceAuthority(
+    E(faKit.publicFacet).getPriceAuthority(),
+    brandIn,
+    brandOut,
+    forceReplace,
+  );
+
+  await E(E(agoricNamesAdmin).lookupAdmin('instance'))
     .update(AGORIC_INSTANCE_NAME, faKit.instance)
     .catch(err =>
       console.error(`🚨 failed to update ${AGORIC_INSTANCE_NAME}`, err),
     );
+  // being after the above awaits means that when this resolves, the consumer
+  // gets notified that the authority is in the registry and its instance is in
+  // agoricNames.
+  produceInstance[AGORIC_INSTANCE_NAME].resolve(faKit.instance);
 
   E(E.get(econCharterKit).creatorFacet).addInstance(
     faKit.instance,
@@ -173,15 +193,6 @@ export const createPriceFeed = async (
   );
   trace('registered', AGORIC_INSTANCE_NAME, faKit.instance);
 
-  // Publish price feed in home.priceAuthority.
-  const forceReplace = true;
-  void E(priceAuthorityAdmin).registerPriceAuthority(
-    E(faKit.publicFacet).getPriceAuthority(),
-    brandIn,
-    brandOut,
-    forceReplace,
-  );
-
   /**
    * Initialize a new oracle and send an invitation to administer it.
    *
@@ -231,6 +242,9 @@ export const getManifestForPriceFeed = async (
         priceAuthorityAdmin: t,
         startGovernedUpgradable: t,
       },
+      instance: {
+        produce: t,
+      },
     },
     [ensureOracleBrands.name]: {
       namedVat: {
@@ -242,6 +256,7 @@ export const getManifestForPriceFeed = async (
     },
   },
   installations: {
+    // ??? will every eval of price-feed-proposal install priceAggregator ?
     priceAggregator: restoreRef(priceFeedOptions.priceAggregatorRef),
   },
   options: {
@@ -302,7 +317,7 @@ export const startPriceFeeds = async (
     {
       options: {
         priceFeedOptions: {
-          AGORIC_INSTANCE_NAME: `${inBrandName}-${outBrandName} price feed`,
+          AGORIC_INSTANCE_NAME: instanceNameFor(inBrandName, outBrandName),
           contractTerms: {
             minSubmissionCount: 2,
             minSubmissionValue: 1,

package/src/vaultFactory/params.js

@@ -21,7 +21,7 @@ export const DEBT_LIMIT_KEY = 'DebtLimit';
 export const LIQUIDATION_MARGIN_KEY = 'LiquidationMargin';
 export const LIQUIDATION_PADDING_KEY = 'LiquidationPadding';
 export const LIQUIDATION_PENALTY_KEY = 'LiquidationPenalty';
-export const INTEREST_RATE_KEY = 'InterestRate';
+export const STABILITY_FEE_KEY = 'StabilityFee';
 export const MINT_FEE_KEY = 'MintFee';
 export const MIN_INITIAL_DEBT_KEY = 'MinInitialDebt';
 export const SHORTFALL_INVITATION_KEY = 'ShortfallInvitation';
@@ -89,7 +89,7 @@ export const makeVaultParamManager = (
   publisherKit,
   {
     debtLimit,
-    interestRate,
+    stabilityFee,
     liquidationMargin,
     liquidationPadding = zeroRatio(liquidationMargin),
     liquidationPenalty,
@@ -98,7 +98,7 @@ export const makeVaultParamManager = (
 ) =>
   makeParamManagerSync(publisherKit, {
     [DEBT_LIMIT_KEY]: [ParamTypes.AMOUNT, debtLimit],
-    [INTEREST_RATE_KEY]: [ParamTypes.RATIO, interestRate],
+    [STABILITY_FEE_KEY]: [ParamTypes.RATIO, stabilityFee],
     [LIQUIDATION_PADDING_KEY]: [ParamTypes.RATIO, liquidationPadding],
     [LIQUIDATION_MARGIN_KEY]: [ParamTypes.RATIO, liquidationMargin],
     [LIQUIDATION_PENALTY_KEY]: [ParamTypes.RATIO, liquidationPenalty],
@@ -110,7 +110,7 @@ export const vaultParamPattern = M.splitRecord(
   {
     liquidationMargin: ratioPattern,
     liquidationPenalty: ratioPattern,
-    interestRate: ratioPattern,
+    stabilityFee: ratioPattern,
     mintFee: ratioPattern,
     debtLimit: amountPattern,
   },

package/src/vaultFactory/storeUtils.js

@@ -131,15 +131,15 @@ harden(fromVaultKey);
  * For use by `normalizedCollRatioKey` and tests.
  *
  * @param {PriceQuote} quote
- * @param {Ratio} compoundedInterest
+ * @param {Ratio} compoundedStabilityFee
  * @param {Ratio} margin
  * @returns {number}
  */
-export const normalizedCollRatio = (quote, compoundedInterest, margin) => {
+export const normalizedCollRatio = (quote, compoundedStabilityFee, margin) => {
   const amountIn = getAmountIn(quote).value;
   const amountOut = getAmountOut(quote).value;
-  const interestNumerator = compoundedInterest.numerator.value;
-  const interestBase = compoundedInterest.denominator.value;
+  const interestNumerator = compoundedStabilityFee.numerator.value;
+  const interestBase = compoundedStabilityFee.denominator.value;
   const numerator = multiply(
     margin.numerator.value,
     multiply(amountIn, interestNumerator),
@@ -159,13 +159,17 @@ harden(normalizedCollRatio);
  * out the numerator and the denominator, and divide only once.
  *
  * @param {PriceQuote} quote
- * @param {Ratio} compoundedInterest
+ * @param {Ratio} compoundedStabilityFee
  * @param {Ratio} margin
  * @returns {string} lexically sortable string in which highest
  * debt-to-collateral is earliest
  */
-export const normalizedCollRatioKey = (quote, compoundedInterest, margin) => {
-  const collRatio = normalizedCollRatio(quote, compoundedInterest, margin);
+export const normalizedCollRatioKey = (
+  quote,
+  compoundedStabilityFee,
+  margin,
+) => {
+  const collRatio = normalizedCollRatio(quote, compoundedStabilityFee, margin);
   return `${encodeNumber(collRatio)}:`;
 };
 harden(normalizedCollRatioKey);

package/src/vaultFactory/types.js

@@ -26,7 +26,7 @@
  * @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 debt positions
+ * @property {Ratio} stabilityFee - 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
@@ -78,7 +78,7 @@
  * @property {() => Ratio} getLiquidationMargin
  * @property {() => Ratio} getMintFee
  * @property {() => Promise<PriceQuote>} getCollateralQuote
- * @property {() => Ratio} getInterestRate - The annual interest rate on a debt position
+ * @property {() => Ratio} getStabilityFee - The annual interest rate on a debt position
  * @property {() => RelativeTime} getChargingPeriod - The period (in seconds) at
  *   which interest is charged to the debt position.
  * @property {() => RelativeTime} getRecordingPeriod - The period (in seconds)
@@ -109,8 +109,8 @@
 
 /**
  * @typedef {object} DebtStatus
- * @property {Timestamp} latestInterestUpdate
- * @property {NatValue} interest interest accrued since latestInterestUpdate
+ * @property {Timestamp} latestStabilityFeeUpdate
+ * @property {NatValue} interest interest accrued since latestStabilityFeeUpdate
  * @property {NatValue} newDebt total including principal and interest
  */