@agoric/inter-protocol 0.16.2-other-dev-8f8782b.0 → 0.16.2-other-dev-3eb1a1d.0

package/src/psm/psm.js

@@ -1,9 +1,9 @@
 // @jessie-check
+/// <reference types="@agoric/governance/exported" />
+/// <reference types="@agoric/zoe/exported" />
 
-import '@agoric/governance/exported.js';
-import '@agoric/zoe/exported.js';
-import '@agoric/zoe/src/contracts/exported.js';
-
+import { Fail } from '@endo/errors';
+import { E } from '@endo/eventual-send';
 import { AmountMath, AmountShape, BrandShape, RatioShape } from '@agoric/ertp';
 import {
   CONTRACT_ELECTORATE,
@@ -14,7 +14,6 @@ import {
 import { StorageNodeShape } from '@agoric/internal';
 import { M, prepareExo, provide } from '@agoric/vat-data';
 import {
-  atomicRearrange,
   atomicTransfer,
   ceilMultiplyBy,
   floorDivideBy,
@@ -31,90 +30,96 @@ import {
   InstanceHandleShape,
   InvitationShape,
 } from '@agoric/zoe/src/typeGuards.js';
-import { E } from '@endo/eventual-send';
 
 import { mustMatch } from '@agoric/store';
 import { makeCollectFeesInvitation } from '../collectFees.js';
 import { makeNatAmountShape } from '../contractSupport.js';
 
-const { Fail } = assert;
-
 /**
  * @file The Parity Stability Module supports efficiently minting/burning a
- * stable token at a specified fixed ratio to a reference stable token, which
- * thereby acts as an anchor to provide additional stability. For flexible
- * economic policies, the fee percentage for trading into and out of the stable
- * token are specified separately.
+ *   stable token at a specified fixed ratio to a reference stable token, which
+ *   thereby acts as an anchor to provide additional stability. For flexible
+ *   economic policies, the fee percentage for trading into and out of the
+ *   stable token are specified separately.
  */
 
 /**
- * @typedef {object} MetricsNotification
- * Metrics naming scheme is that nouns are present values and past-participles
- * are accumulative.
- *
- * @property {Amount<'nat'>} anchorPoolBalance  amount of Anchor token
- * available to be swapped
- * @property {Amount<'nat'>} mintedPoolBalance  amount of Minted token
- * outstanding (the amount minted minus the amount burned).
- * @property {Amount<'nat'>} feePoolBalance     amount of Minted token
- * fees available to be collected
- *
- * @property {Amount<'nat'>} totalAnchorProvided  running sum of Anchor
- * ever given by this contract
- * @property {Amount<'nat'>} totalMintedProvided  running sum of Minted
- * ever given by this contract
+ * @typedef {object} MetricsNotification Metrics naming scheme is that nouns are
+ *   present values and past-participles are accumulative.
+ * @property {Amount<'nat'>} anchorPoolBalance amount of Anchor token available
+ *   to be swapped
+ * @property {Amount<'nat'>} mintedPoolBalance amount of Minted token
+ *   outstanding (the amount minted minus the amount burned).
+ * @property {Amount<'nat'>} feePoolBalance amount of Minted token fees
+ *   available to be collected
+ * @property {Amount<'nat'>} totalAnchorProvided running sum of Anchor ever
+ *   given by this contract
+ * @property {Amount<'nat'>} totalMintedProvided running sum of Minted ever
+ *   given by this contract
  */
 
-/** @typedef {import('@agoric/vat-data').Baggage} Baggage */
+/**
+ * @import {TypedPattern} from '@agoric/internal';
+ * @import {Baggage} from '@agoric/vat-data'
+ */
 
-export const customTermsShape = {
-  anchorBrand: BrandShape,
-  anchorPerMinted: RatioShape,
-  electionManager: InstanceHandleShape,
-  governedParams: {
-    [CONTRACT_ELECTORATE]: {
-      type: ParamTypes.INVITATION,
-      value: AmountShape,
+/** @type {ContractMeta} */
+export const meta = {
+  upgradability: 'canUpgrade',
+  customTermsShape: {
+    anchorBrand: BrandShape,
+    anchorPerMinted: RatioShape,
+    electionManager: InstanceHandleShape,
+    governedParams: {
+      [CONTRACT_ELECTORATE]: {
+        type: ParamTypes.INVITATION,
+        value: AmountShape,
+      },
+      WantMintedFee: {
+        type: ParamTypes.RATIO,
+        value: RatioShape,
+      },
+      GiveMintedFee: {
+        type: ParamTypes.RATIO,
+        value: RatioShape,
+      },
+      MintLimit: { type: ParamTypes.AMOUNT, value: AmountShape },
     },
-    WantMintedFee: {
-      type: ParamTypes.RATIO,
-      value: RatioShape,
+  },
+  privateArgsShape: M.splitRecord(
+    {
+      marshaller: M.remotable('Marshaller'),
+      storageNode: StorageNodeShape,
     },
-    GiveMintedFee: {
-      type: ParamTypes.RATIO,
-      value: RatioShape,
+    {
+      // only necessary on first invocation, not subsequent
+      feeMintAccess: FeeMintAccessShape,
+      initialPoserInvitation: InvitationShape,
     },
-    MintLimit: { type: ParamTypes.AMOUNT, value: AmountShape },
-  },
+  ),
 };
-harden(customTermsShape);
-
-export const privateArgsShape = M.splitRecord(
-  harden({
-    marshaller: M.remotable('Marshaller'),
-    storageNode: StorageNodeShape,
-  }),
-  harden({
-    // only necessary on first invocation, not subsequent
-    feeMintAccess: FeeMintAccessShape,
-    initialPoserInvitation: InvitationShape,
-  }),
-);
-harden(privateArgsShape);
+harden(meta);
 
 /**
- * @param {ZCF<GovernanceTerms<{
- *    GiveMintedFee: 'ratio',
- *    WantMintedFee: 'ratio',
- *    MintLimit: 'amount',
+ * @param {ZCF<
+ *   GovernanceTerms<{
+ *     GiveMintedFee: 'ratio';
+ *     WantMintedFee: 'ratio';
+ *     MintLimit: 'amount';
  *   }> & {
- *    anchorBrand: Brand<'nat'>,
- *    anchorPerMinted: Ratio,
- * }>} zcf
- * @param {{feeMintAccess: FeeMintAccess, initialPoserInvitation: Invitation, storageNode: StorageNode, marshaller: Marshaller}} privateArgs
+ *     anchorBrand: Brand<'nat'>;
+ *     anchorPerMinted: Ratio;
+ *   }
+ * >} zcf
+ * @param {{
+ *   feeMintAccess: FeeMintAccess;
+ *   initialPoserInvitation: Invitation;
+ *   storageNode: StorageNode;
+ *   marshaller: Marshaller;
+ * }} privateArgs
  * @param {Baggage} baggage
  */
-export const prepare = async (zcf, privateArgs, baggage) => {
+export const start = async (zcf, privateArgs, baggage) => {
   const { anchorBrand, anchorPerMinted } = zcf.getTerms();
   console.log('PSM Starting', anchorBrand, anchorPerMinted);
 
@@ -171,9 +176,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
       E.when(E(privateArgs.storageNode).makeChildNode('metrics'), node =>
         makeRecorderKit(
           node,
-          /** @type {import('@agoric/zoe/src/contractSupport/recorder.js').TypedMatcher<MetricsNotification>} */ (
-            M.any()
-          ),
+          /** @type {TypedPattern<MetricsNotification>} */ (M.any()),
         ),
       ),
   });
@@ -231,9 +234,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     updateMetrics();
   };
 
-  /**
-   * @param {Amount<'nat'>} toMint
-   */
+  /** @param {Amount<'nat'>} toMint */
   const assertUnderLimit = toMint => {
     const mintedAfter = AmountMath.add(
       baggage.get('mintedPoolBalance'),
@@ -262,7 +263,8 @@ export const prepare = async (zcf, privateArgs, baggage) => {
   /**
    * @param {ZCFSeat} seat
    * @param {Amount<'nat'>} given
-   * @param {Amount<'nat'>} [wanted] defaults to maximum anchor (given exchange rate minus fees)
+   * @param {Amount<'nat'>} [wanted] defaults to maximum anchor (given exchange
+   *   rate minus fees)
    */
   const giveMinted = (seat, given, wanted = emptyAnchor) => {
     const fee = ceilMultiplyBy(given, params.getGiveMintedFee());
@@ -270,8 +272,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     const maxAnchor = floorMultiplyBy(afterFee, anchorPerMinted);
     AmountMath.isGTE(maxAnchor, wanted) ||
       Fail`wanted ${wanted} is more than ${given} minus fees ${fee}`;
-    atomicRearrange(
-      zcf,
+    zcf.atomicRearrange(
       harden([
         [seat, stage, { In: afterFee }, { Minted: afterFee }],
         [seat, feePool, { In: fee }, { Minted: fee }],
@@ -302,8 +303,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
       Fail`wanted ${wanted} is more than ${given} minus fees ${fee}`;
     mintMinted(asStable);
     try {
-      atomicRearrange(
-        zcf,
+      zcf.atomicRearrange(
         harden([
           [seat, anchorPool, { In: given }, { Anchor: given }],
           [stage, seat, { Minted: afterFee }, { Out: afterFee }],
@@ -440,5 +440,6 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     publicFacet,
   });
 };
+harden(start);
 
-/** @typedef {Awaited<ReturnType<typeof prepare>>['publicFacet']} PsmPublicFacet */
+/** @typedef {Awaited<ReturnType<typeof start>>['publicFacet']} PsmPublicFacet */

package/src/psm/types-ambient.d.ts

@@ -0,0 +1,2 @@
+import type { PsmPublicFacet } from './psm.js';
+//# sourceMappingURL=types-ambient.d.ts.map

package/src/psm/types-ambient.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types-ambient.d.ts","sourceRoot":"","sources":["types-ambient.js"],"names":[],"mappings":"oCAEkC,UAAU"}

package/src/psm/types-ambient.js

@@ -0,0 +1,3 @@
+// @jessie-check
+
+/** @import {PsmPublicFacet} from './psm.js' */

package/src/reserve/assetReserve.d.ts

@@ -0,0 +1,47 @@
+/** @type {ContractMeta<typeof start>} */
+export const meta: ContractMeta<typeof start>;
+export function start(zcf: ZCF<GovernanceTerms<{}> & {
+    governedApis: ["burnFeesToReduceShortfall"];
+}>, privateArgs: {
+    feeMintAccess: FeeMintAccess;
+    initialPoserInvitation: Invitation;
+    marshaller: ERef<Marshaller>;
+    storageNode: ERef<StorageNode>;
+}, baggage: Baggage): Promise<{
+    /** @type {GovernedCreatorFacet<typeof assetReserveKit.machine>} */
+    creatorFacet: GovernedCreatorFacet<import("@endo/exo").Guarded<{
+        addIssuer(issuer: Issuer, keyword: string): Promise<void>;
+        getAllocations(): Allocation;
+        makeShortfallReportingInvitation(): Promise<Invitation<import("@endo/exo").Guarded<{
+            increaseLiquidationShortfall(shortfall: Amount<"nat">): void;
+            reduceLiquidationShortfall(reduction: Amount<"nat">): void;
+        }>, undefined>>;
+    }>>;
+    /** @type {GovernedPublicFacet<typeof assetReserveKit.public>} */
+    publicFacet: GovernedPublicFacet<import("@endo/exo").Guarded<{
+        makeAddCollateralInvitation(): Promise<Invitation<string, never>>;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./assetReserveKit.js").MetricsNotification>;
+        };
+    }>>;
+}>;
+export type ShortfallReportingFacet = {
+    increaseLiquidationShortfall: (increase: Amount) => void;
+    reduceLiquidationShortfall: (reduction: Amount) => void;
+};
+export type ShortfallReporter = {
+    increaseLiquidationShortfall: (shortfall: Amount) => void;
+    reduceLiquidationShortfall: (shortfall: Amount) => void;
+};
+export type AssetReserveLimitedCreatorFacet = {
+    addIssuer: (issuer: Issuer, kwd: string) => void;
+    getAllocations: () => Allocation;
+    makeShortfallReportingInvitation: () => Promise<Invitation<ShortfallReporter>>;
+};
+export type AssetReservePublicFacet = Awaited<ReturnType<typeof start>>["publicFacet"];
+/**
+ * the creator facet for the governor
+ */
+export type AssetReserveCreatorFacet = Awaited<ReturnType<typeof start>>["creatorFacet"];
+import type { Baggage } from '@agoric/vat-data';
+//# sourceMappingURL=assetReserve.d.ts.map

package/src/reserve/assetReserve.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetReserve.d.ts","sourceRoot":"","sources":["assetReserve.js"],"names":[],"mappings":"AAYA,yCAAyC;AACzC,mBADW,YAAY,CAAC,OAAO,KAAK,CAAC,CAGnC;AAgCK,2BAbI,GAAG,CACT,eAAe,CAAC,EAAE,CAAC,GAAG;IACpB,YAAY,EAAE,CAAC,2BAA2B,CAAC,CAAC;CAC7C,CACF,eACO;IACN,aAAa,EAAE,aAAa,CAAC;IAC7B,sBAAsB,EAAE,UAAU,CAAC;IACnC,UAAU,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC7B,WAAW,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;CAChC,WACO,OAAO;IA6Dd,mEAAmE;kBAAxD,oBAAoB;;;;;;;OAAgC;IAE/D,iEAAiE;iBAAtD,mBAAmB;;;;;OAA+B;GAKhE;sCA9FY;IACR,4BAA4B,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IACzD,0BAA0B,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI,CAAC;CACzD;;kCAgGU,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI;gCAC3B,CAAC,SAAS,EAAE,MAAM,KAAK,IAAI;;;eAK3B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,IAAI;oBACrC,MAAM,UAAU;sCAChB,MAAM,OAAO,CAAC,UAAU,CAAC,iBAAiB,CAAC,CAAC;;sCAG5C,OAAO,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,aAAa,CAAC;;;;uCAEjD,OAAO,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,cAAc,CAAC;6BA1GnC,kBAAkB"}

package/src/reserve/assetReserve.js

@@ -10,36 +10,42 @@ import { prepareAssetReserveKit } from './assetReserveKit.js';
 
 const trace = makeTracer('AR', true);
 
+/** @type {ContractMeta<typeof start>} */
+export const meta = {
+  upgradability: 'canUpgrade',
+};
+harden(meta);
+
 /**
  * @typedef {{
- *   increaseLiquidationShortfall: (increase: Amount) => void
- *   reduceLiquidationShortfall: (reduction: Amount) => void
+ *   increaseLiquidationShortfall: (increase: Amount) => void;
+ *   reduceLiquidationShortfall: (reduction: Amount) => void;
  * }} ShortfallReportingFacet
  */
 
-/** @typedef {import('@agoric/vat-data').Baggage} Baggage */
+/** @import {Baggage} from '@agoric/vat-data' */
 
 /**
- * Asset Reserve holds onto assets for the Inter Protocol, and can
- * dispense it for various purposes under governance control.
+ * Asset Reserve holds onto assets for the Inter Protocol, and can dispense it
+ * for various purposes under governance control.
  *
  * This contract has the ability to mint Fee tokens, granted through its private
  * arguments.
  *
- * @param {ZCF<GovernanceTerms<{}> &
- * {
- *   governedApis: ['burnFeesToReduceShortfall'],
- * }
+ * @param {ZCF<
+ *   GovernanceTerms<{}> & {
+ *     governedApis: ['burnFeesToReduceShortfall'];
+ *   }
  * >} zcf
  * @param {{
- *   feeMintAccess: FeeMintAccess,
- *   initialPoserInvitation: Invitation,
- *   marshaller: ERef<Marshaller>,
- *   storageNode: ERef<StorageNode>,
+ *   feeMintAccess: FeeMintAccess;
+ *   initialPoserInvitation: Invitation;
+ *   marshaller: ERef<Marshaller>;
+ *   storageNode: ERef<StorageNode>;
  * }} privateArgs
  * @param {Baggage} baggage
  */
-export const prepare = async (zcf, privateArgs, baggage) => {
+export const start = async (zcf, privateArgs, baggage) => {
   trace('prepare', Object.keys(privateArgs), [...baggage.keys()]);
   // This contract mixes two styles of access to durable state. durableStores
   // are declared at the top level and referenced lexically. local state is
@@ -66,11 +72,11 @@ export const prepare = async (zcf, privateArgs, baggage) => {
   };
   trace('awaiting takeFeeMint');
   const feeMint = await takeFeeMint();
+  const storageNode = await privateArgs.storageNode;
   const makeAssetReserveKit = await prepareAssetReserveKit(baggage, {
     feeMint,
     makeRecorderKit,
-    // eslint-disable-next-line @jessie.js/no-nested-await -- spurious
-    storageNode: await privateArgs.storageNode,
+    storageNode,
     zcf,
   });
 
@@ -106,7 +112,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     publicFacet: /** @type {any} */ (assetReserveKit.public),
   };
 };
-harden(prepare);
+harden(start);
 
 /**
  * @typedef {object} ShortfallReporter
@@ -121,5 +127,8 @@ harden(prepare);
  * @property {() => Promise<Invitation<ShortfallReporter>>} makeShortfallReportingInvitation
  */
 
-/** @typedef {Awaited<ReturnType<typeof prepare>>['publicFacet']} AssetReservePublicFacet */
-/** @typedef {Awaited<ReturnType<typeof prepare>>['creatorFacet']} AssetReserveCreatorFacet the creator facet for the governor */
+/** @typedef {Awaited<ReturnType<typeof start>>['publicFacet']} AssetReservePublicFacet */
+/**
+ * @typedef {Awaited<ReturnType<typeof start>>['creatorFacet']} AssetReserveCreatorFacet
+ *   the creator facet for the governor
+ */

package/src/reserve/assetReserveKit.d.ts

@@ -0,0 +1,74 @@
+export function prepareAssetReserveKit(baggage: import("@agoric/vat-data").Baggage, { feeMint, makeRecorderKit, storageNode, zcf }: {
+    feeMint: ZCFMint<"nat">;
+    makeRecorderKit: import("@agoric/zoe/src/contractSupport/recorder.js").MakeRecorderKit;
+    storageNode: StorageNode;
+    zcf: ZCF;
+}): Promise<() => Promise<import("@endo/exo").GuardedKit<{
+    helper: {
+        /** @param {Brand} brand */
+        getKeywordForBrand(brand: Brand): string;
+        /**
+         * @param {Brand} brand
+         * @param {Keyword} keyword
+         */
+        saveBrandKeyword(brand: Brand, keyword: Keyword): void;
+        writeMetrics(): void;
+    };
+    governedApis: {
+        /**
+         * @param {Amount<'nat'>} reduction
+         * @returns {void}
+         */
+        burnFeesToReduceShortfall(reduction: Amount<"nat">): void;
+    };
+    machine: {
+        /**
+         * @param {Issuer} issuer
+         * @param {string} keyword
+         */
+        addIssuer(issuer: Issuer, keyword: string): Promise<void>;
+        /** XXX redundant with getPublicTopics metrics `allocation` */
+        getAllocations(): Allocation;
+        makeShortfallReportingInvitation(): Promise<Invitation<import("@endo/exo").Guarded<{
+            /** @param {Amount<'nat'>} shortfall */
+            increaseLiquidationShortfall(shortfall: Amount<"nat">): void;
+            /** @param {Amount<'nat'>} reduction */
+            reduceLiquidationShortfall(reduction: Amount<"nat">): void;
+        }>, undefined>>;
+    };
+    /**
+     * XXX missing governance public methods
+     * https://github.com/Agoric/agoric-sdk/issues/5200
+     */
+    public: {
+        /** Anyone can deposit any assets to the reserve */
+        makeAddCollateralInvitation(): Promise<Invitation<string, never>>;
+        getPublicTopics(): {
+            metrics: import("@agoric/zoe/src/contractSupport").PublicTopic<MetricsNotification>;
+        };
+    };
+    shortfallReportingFacet: {
+        /** @param {Amount<'nat'>} shortfall */
+        increaseLiquidationShortfall(shortfall: Amount<"nat">): void;
+        /** @param {Amount<'nat'>} reduction */
+        reduceLiquidationShortfall(reduction: Amount<"nat">): void;
+    };
+}>>>;
+export type MetricsNotification = {
+    allocations: AmountKeywordRecord;
+    /**
+     * shortfall from liquidation that
+     * has not yet been compensated.
+     */
+    shortfallBalance: Amount<"nat">;
+    /**
+     * total Fee tokens minted to date
+     */
+    totalFeeMinted: Amount<"nat">;
+    /**
+     * total Fee tokens burned to date
+     */
+    totalFeeBurned: Amount<"nat">;
+};
+export type AssetReserveKit = ReturnType<Awaited<ReturnType<typeof prepareAssetReserveKit>>>;
+//# sourceMappingURL=assetReserveKit.d.ts.map

package/src/reserve/assetReserveKit.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"assetReserveKit.d.ts","sourceRoot":"","sources":["assetReserveKit.js"],"names":[],"mappings":"AAqCO,gDARI,OAAO,kBAAkB,EAAE,OAAO,kDAClC;IACN,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACxB,eAAe,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IACvF,WAAW,EAAE,WAAW,CAAC;IACzB,GAAG,EAAE,GAAG,CAAC;CACV;;QAoEI,2BAA2B;kCAAf,KAAK;QAUjB;;;WAGG;gCAFQ,KAAK,WACL,OAAO;;;;QAqBlB;;;WAGG;6CAFQ,MAAM,CAAC,KAAK,CAAC,GACX,IAAI;;;QA6BjB;;;WAGG;0BAFQ,MAAM,WACN,MAAM;QAmBjB,8DAA8D;;;YA2D9D,uCAAuC;oDAA3B,MAAM,CAAC,KAAK,CAAC;YAWzB,uCAAuC;kDAA3B,MAAM,CAAC,KAAK,CAAC;;;IArD3B;;;OAGG;;QAED,mDAAmD;;;;;;;QAqCnD,uCAAuC;gDAA3B,MAAM,CAAC,KAAK,CAAC;QAWzB,uCAAuC;8CAA3B,MAAM,CAAC,KAAK,CAAC;;KA8BhC;;iBA3Qa,mBAAmB;;;;;sBACnB,MAAM,CAAC,KAAK,CAAC;;;;oBAEb,MAAM,CAAC,KAAK,CAAC;;;;oBACb,MAAM,CAAC,KAAK,CAAC;;8BAyQb,UAAU,CAAC,OAAO,CAAC,UAAU,CAAC,OAAO,sBAAsB,CAAC,CAAC,CAAC"}

package/src/reserve/assetReserveKit.js

@@ -1,4 +1,4 @@
-import { Fail } from '@agoric/assert';
+import { Fail, q } from '@endo/errors';
 import { AmountMath, AmountShape, IssuerShape } from '@agoric/ertp';
 import { makeTracer } from '@agoric/internal';
 import { M, makeScalarBigMapStore, prepareExoClassKit } from '@agoric/vat-data';
@@ -9,15 +9,16 @@ import {
 } from '@agoric/zoe/src/contractSupport/topics.js';
 import { AmountKeywordRecordShape } from '@agoric/zoe/src/typeGuards.js';
 import { E } from '@endo/eventual-send';
-import { UnguardedHelperI } from '../typeGuards.js';
-
-const { quote: q } = assert;
+import { UnguardedHelperI } from '@agoric/internal/src/typeGuards.js';
 
 const trace = makeTracer('ReserveKit', true);
 
+/**
+ * @import {TypedPattern} from '@agoric/internal';
+ */
+
 /**
  * @typedef {object} MetricsNotification
- *
  * @property {AmountKeywordRecord} allocations
  * @property {Amount<'nat'>} shortfallBalance shortfall from liquidation that
  *   has not yet been compensated.
@@ -28,10 +29,11 @@ const trace = makeTracer('ReserveKit', true);
 /**
  * @param {import('@agoric/vat-data').Baggage} baggage
  * @param {{
- * feeMint: ZCFMint<'nat'>,
- * makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit,
- * storageNode: StorageNode,
- * zcf: ZCF}} powers
+ *   feeMint: ZCFMint<'nat'>;
+ *   makeRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').MakeRecorderKit;
+ *   storageNode: StorageNode;
+ *   zcf: ZCF;
+ * }} powers
  */
 export const prepareAssetReserveKit = async (
   baggage,
@@ -63,10 +65,7 @@ export const prepareAssetReserveKit = async (
         reduceLiquidationShortfall: M.call(AmountShape).returns(),
       }),
     },
-    /**
-     *
-     * @param {StorageNode} metricsNode
-     */
+    /** @param {StorageNode} metricsNode */
     metricsNode => {
       /**
        * Used to look up the unique keyword for each brand, including Fee brand.
@@ -77,7 +76,8 @@ export const prepareAssetReserveKit = async (
         durable: true,
       });
       /**
-       * Used to look up the brands for keywords, excluding Fee because it's a special case.
+       * Used to look up the brands for keywords, excluding Fee because it's a
+       * special case.
        *
        * @type {MapStore<Keyword, Brand>}
        */
@@ -92,9 +92,7 @@ export const prepareAssetReserveKit = async (
         keywordForBrand,
         metricsKit: makeRecorderKit(
           metricsNode,
-          /** @type {import('@agoric/zoe/src/contractSupport/recorder.js').TypedMatcher<MetricsNotification>} */ (
-            M.any()
-          ),
+          /** @type {TypedPattern<MetricsNotification>} */ (M.any()),
         ),
         totalFeeMinted: emptyAmount,
         totalFeeBurned: emptyAmount,
@@ -137,7 +135,6 @@ export const prepareAssetReserveKit = async (
       },
       governedApis: {
         /**
-         *
          * @param {Amount<'nat'>} reduction
          * @returns {void}
          */
@@ -146,8 +143,10 @@ export const prepareAssetReserveKit = async (
           trace('burnFeesToReduceShortfall', reduction);
           reduction = AmountMath.coerce(feeKit.brand, reduction);
           const feeKeyword = state.keywordForBrand.get(feeKit.brand);
-          const feeBalance =
-            state.collateralSeat.getAmountAllocated(feeKeyword);
+          const feeBalance = state.collateralSeat.getAmountAllocated(
+            feeKeyword,
+            feeKit.brand,
+          );
           const amountToBurn = AmountMath.min(reduction, feeBalance);
           if (AmountMath.isEmpty(amountToBurn)) {
             return;
@@ -205,12 +204,11 @@ export const prepareAssetReserveKit = async (
         },
       },
       /**
-       * XXX missing governance public methods https://github.com/Agoric/agoric-sdk/issues/5200
+       * XXX missing governance public methods
+       * https://github.com/Agoric/agoric-sdk/issues/5200
        */
       public: {
-        /**
-         * Anyone can deposit any assets to the reserve
-         */
+        /** Anyone can deposit any assets to the reserve */
         makeAddCollateralInvitation() {
           /** @type {OfferHandler<Promise<string>>} */
           const handler = async seat => {
@@ -247,9 +245,7 @@ export const prepareAssetReserveKit = async (
         },
       },
       shortfallReportingFacet: {
-        /**
-         * @param {Amount<"nat">} shortfall
-         */
+        /** @param {Amount<'nat'>} shortfall */
         increaseLiquidationShortfall(shortfall) {
           const { facets, state } = this;
           state.shortfallBalance = AmountMath.add(
@@ -260,9 +256,7 @@ export const prepareAssetReserveKit = async (
         },
 
         // currently exposed for testing. Maybe it only gets called internally?
-        /**
-         * @param {Amount<"nat">} reduction
-         */
+        /** @param {Amount<'nat'>} reduction */
         reduceLiquidationShortfall(reduction) {
           const { state } = this;
           if (AmountMath.isGTE(reduction, state.shortfallBalance)) {

package/src/reserve/params.d.ts

@@ -0,0 +1,10 @@
+export function makeReserveTerms(poserInvitationAmount: any, timer: any): {
+    timer: any;
+    governedParams: {
+        Electorate: {
+            type: "invitation";
+            value: any;
+        };
+    };
+};
+//# sourceMappingURL=params.d.ts.map

package/src/reserve/params.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"params.d.ts","sourceRoot":"","sources":["params.js"],"names":[],"mappings":"AAIA;;;;;;;;EAQE"}

package/src/tokens.d.ts

@@ -0,0 +1,3 @@
+export type TokenKeyword = "IST" | "BLD";
+export { Stable, Stake } from "@agoric/internal/src/tokens.js";
+//# sourceMappingURL=tokens.d.ts.map

package/src/tokens.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tokens.d.ts","sourceRoot":"","sources":["tokens.js"],"names":[],"mappings":"2BAEc,KAAK,GAAG,KAAK"}

package/src/tokens.js

@@ -0,0 +1,5 @@
+// @ts-check
+
+/** @typedef {'IST' | 'BLD'} TokenKeyword */
+
+export { Stable, Stake } from '@agoric/internal/src/tokens.js';

package/src/vaultFactory/burn.d.ts

@@ -0,0 +1,2 @@
+export function paymentFromZCFMint(zcf: ZCF, zcfMint: ZCFMint, amount: Amount): Promise<globalThis.Payment<any>>;
+//# sourceMappingURL=burn.d.ts.map

package/src/vaultFactory/burn.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"burn.d.ts","sourceRoot":"","sources":["burn.js"],"names":[],"mappings":"AAWO,wCAJI,GAAG,WACH,OAAO,UACP,MAAM,oCAOhB"}

package/src/vaultFactory/burn.js

@@ -1,6 +1,6 @@
 // @jessie-check
 
-import '@agoric/zoe/exported.js';
+/// <reference types="@agoric/zoe/exported" />
 
 import { E } from '@endo/eventual-send';