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

package/src/contractSupport.js

@@ -1,10 +1,11 @@
 // @jessie-check
 
+import { Fail, q } from '@endo/errors';
 import { AmountMath } from '@agoric/ertp';
 import { M } from '@agoric/store';
 import { makeRatioFromAmounts } from '@agoric/zoe/src/contractSupport/index.js';
 
-const { Fail, quote: q } = assert;
+/** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js'; */
 
 export const amountPattern = harden({ brand: M.remotable(), value: M.any() });
 export const ratioPattern = harden({
@@ -13,17 +14,17 @@ export const ratioPattern = harden({
 });
 
 /**
- * Apply a delta to the `base` Amount, where the delta is represented as
- * an amount to gain and an amount to lose. Typically one of those will
- * be empty because gain/loss comes from the give/want for a specific asset
- * on a proposal. We use two Amounts because an Amount cannot represent
- * a negative number (so we use a "loss" that will be subtracted).
+ * Apply a delta to the `base` Amount, where the delta is represented as an
+ * amount to gain and an amount to lose. Typically one of those will be empty
+ * because gain/loss comes from the give/want for a specific asset on a
+ * proposal. We use two Amounts because an Amount cannot represent a negative
+ * number (so we use a "loss" that will be subtracted).
  *
- * @template {AssetKind} K
- * @param {Amount<K>} base
- * @param {Amount<K>} gain
- * @param {Amount<K>} loss
- * @returns {Amount<K>}
+ * @template {Amount} A
+ * @param {A} base
+ * @param {A} gain
+ * @param {A} loss
+ * @returns {A}
  */
 export const addSubtract = (base, gain, loss) =>
   AmountMath.subtract(AmountMath.add(base, gain), loss);
@@ -66,8 +67,13 @@ export const allEmpty = amounts => {
  * @param {Amount<'nat'>} totalDebt
  * @param {Amount<'nat'>} toMint
  * @throws if minting would exceed total debt
+ *
+ *   Note: Succeeds regardless of debtLimit if toMint is empty.
  */
 export const checkDebtLimit = (debtLimit, totalDebt, toMint) => {
+  if (AmountMath.isEmpty(toMint)) {
+    return;
+  }
   const debtPost = AmountMath.add(totalDebt, toMint);
   AmountMath.isGTE(debtLimit, debtPost) ||
     Fail`Minting ${q(toMint)} past ${q(
@@ -77,14 +83,14 @@ export const checkDebtLimit = (debtLimit, totalDebt, toMint) => {
 
 /**
  * @template T
- * @typedef {object} MetricsPublisherKit<T>
+ * @typedef {object} MetricsPublisherKit
  * @property {IterationObserver<T>} metricsPublication
  * @property {StoredSubscription<T>} metricsSubscription
  */
 
 /**
  * @template T
- * @typedef {object} MetricsPublishKit<T>
+ * @typedef {object} MetricsPublishKit
  * @property {Publisher<T>} metricsPublisher
  * @property {StoredSubscriber<T>} metricsSubscriber
  */

package/src/econCommitteeCharter.d.ts

@@ -0,0 +1,43 @@
+/**
+ * @import {MapStore, SetStore} from '@agoric/store';
+ */
+/**
+ * @file This contract makes it possible for those who govern contracts to call
+ *   for votes on changes. A more complete implementation would validate
+ *   parameters, constrain deadlines and possibly split the ability to call for
+ *   votes into separate capabilities for finer grain encapsulation.
+ */
+export const INVITATION_MAKERS_DESC: "charter member invitation";
+/** @type {ContractMeta<typeof start>} */
+export const meta: ContractMeta<typeof start>;
+export function start(zcf: ZCF<{
+    binaryVoteCounterInstallation: Installation;
+}>, privateArgs: undefined, baggage: import("@agoric/vat-data").Baggage): Promise<{
+    creatorFacet: import("@endo/exo").Guarded<{
+        /**
+         * @param {Instance} governedInstance
+         * @param {GovernorCreatorFacet<any>} governorFacet
+         * @param {string} [label] for diagnostic use only
+         */
+        addInstance: (governedInstance: Instance, governorFacet: GovernorCreatorFacet<any>, label?: string) => void;
+        makeCharterMemberInvitation: () => Promise<globalThis.Invitation<{
+            invitationMakers: import("@endo/exo").Guarded<{
+                VoteOnParamChange: () => Promise<globalThis.Invitation<import("@agoric/governance/src/types").ContractGovernanceVoteResult, ParamChangesOfferArgs>>;
+                VoteOnPauseOffers: (instance: any, strings: any, deadline: any) => Promise<globalThis.Invitation<import("@agoric/governance/src/types").ContractGovernanceVoteResult, undefined>>;
+                VoteOnApiCall: (instance: Instance, methodName: string, methodArgs: string[], deadline: import("@agoric/time").TimestampValue) => Promise<globalThis.Invitation<import("@agoric/governance/src/types").ContractGovernanceVoteResult, undefined>>;
+            }>;
+        }, undefined>>;
+    }>;
+}>;
+export type ParamChangesOfferArgs = {
+    deadline: bigint;
+    instance: Instance;
+    params: Record<string, unknown>;
+    /**
+     * paramPath is determined by contract
+     */
+    path?: {
+        paramPath: unknown;
+    } | undefined;
+};
+//# sourceMappingURL=econCommitteeCharter.d.ts.map

package/src/econCommitteeCharter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"econCommitteeCharter.d.ts","sourceRoot":"","sources":["econCommitteeCharter.js"],"names":[],"mappings":"AAaA;;GAEG;AAEH;;;;;GAKG;AAEH,qCAAsC,2BAA2B,CAAC;AAoBlE,yCAAyC;AACzC,mBADW,YAAY,CAAC,OAAO,KAAK,CAAC,CAMnC;AAQK,2BAJI,GAAG,CAAC;IAAE,6BAA6B,EAAE,YAAY,CAAA;CAAE,CAAC,eACpD,SAAS,WACT,OAAO,kBAAkB,EAAE,OAAO;;QAsHvC;;;;WAIG;wCAHQ,QAAQ,iBACR,oBAAoB,CAAC,GAAG,CAAC,UACzB,MAAM;;;;;0CAzEV,QAAQ,cACR,MAAM,cACN,MAAM,EAAE,YACR,OAAO,cAAc,EAAE,cAAc;;;;GAkFjD;;cAjKa,MAAM;cACN,QAAQ;YACR,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;;;;mBACV,OAAO"}

package/src/econCommitteeCharter.js

@@ -1,11 +1,10 @@
 // @jessie-check
+/// <reference types="@agoric/governance/exported" />
+/// <reference types="@agoric/zoe/exported" />
 
-import '@agoric/governance/exported.js';
 import { M, mustMatch } from '@agoric/store';
 import { TimestampShape } from '@agoric/time';
 import { prepareExo, provideDurableMapStore } from '@agoric/vat-data';
-import '@agoric/zoe/exported.js';
-import '@agoric/zoe/src/contracts/exported.js';
 import {
   InstallationShape,
   InstanceHandleShape,
@@ -13,12 +12,14 @@ import {
 import { E } from '@endo/far';
 
 /**
- * @file
- *
- * This contract makes it possible for those who govern contracts to call for
- * votes on changes. A more complete implementation would validate parameters,
- * constrain deadlines and possibly split the ability to call for votes into
- * separate capabilities for finer grain encapsulation.
+ * @import {MapStore, SetStore} from '@agoric/store';
+ */
+
+/**
+ * @file This contract makes it possible for those who govern contracts to call
+ *   for votes on changes. A more complete implementation would validate
+ *   parameters, constrain deadlines and possibly split the ability to call for
+ *   votes into separate capabilities for finer grain encapsulation.
  */
 
 export const INVITATION_MAKERS_DESC = 'charter member invitation';
@@ -28,7 +29,7 @@ export const INVITATION_MAKERS_DESC = 'charter member invitation';
  * @property {bigint} deadline
  * @property {Instance} instance
  * @property {Record<string, unknown>} params
- * @property {{paramPath: { key: string }}} [path]
+ * @property {{ paramPath: unknown }} [path] paramPath is determined by contract
  */
 const ParamChangesOfferArgsShape = M.splitRecord(
   {
@@ -41,19 +42,21 @@ const ParamChangesOfferArgsShape = M.splitRecord(
   },
 );
 
-/**
- * A pattern for Zoe to check custom terms before `start()`ing the contract.
- */
-export const customTermsShape = harden({
-  binaryVoteCounterInstallation: InstallationShape,
-});
+/** @type {ContractMeta<typeof start>} */
+export const meta = {
+  customTermsShape: {
+    binaryVoteCounterInstallation: InstallationShape,
+  },
+  upgradability: 'canUpgrade',
+};
+harden(meta);
 
 /**
- * @param {ZCF<{binaryVoteCounterInstallation: Installation}>} zcf
+ * @param {ZCF<{ binaryVoteCounterInstallation: Installation }>} zcf
  * @param {undefined} privateArgs
  * @param {import('@agoric/vat-data').Baggage} baggage
  */
-export const prepare = async (zcf, privateArgs, baggage) => {
+export const start = async (zcf, privateArgs, baggage) => {
   const { binaryVoteCounterInstallation: counter } = zcf.getTerms();
   /** @type {MapStore<Instance, GovernorCreatorFacet<any>>} */
   const instanceToGovernor = provideDurableMapStore(
@@ -79,6 +82,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
       const governor = instanceToGovernor.get(instance);
       return E(governor).voteOnParamChanges(counter, deadline, {
         ...path,
+        // @ts-expect-error XXX
         changes: params,
       });
     };
@@ -156,7 +160,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     return harden({ invitationMakers });
   };
 
-  const charterCreatorI = M.interface('Charter creatorFacet', {
+  const CharterCreatorI = M.interface('Charter creatorFacet', {
     addInstance: M.call(InstanceHandleShape, M.any())
       .optional(M.string())
       .returns(),
@@ -166,7 +170,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
   const creatorFacet = prepareExo(
     baggage,
     'Charter creatorFacet',
-    charterCreatorI,
+    CharterCreatorI,
     {
       /**
        * @param {Instance} governedInstance
@@ -184,3 +188,4 @@ export const prepare = async (zcf, privateArgs, baggage) => {
 
   return harden({ creatorFacet });
 };
+harden(start);

package/src/feeDistributor.d.ts

@@ -0,0 +1,224 @@
+/** @type {ContractMeta<typeof start>} */
+export const meta: ContractMeta<typeof start>;
+export function makeContractFeeCollector(zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>): {
+    collectFees: () => Promise<globalThis.Payment<any, any>>;
+} & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+    collectFees: () => Promise<globalThis.Payment<any, any>>;
+}>;
+export function startDistributing(schedulePayments: () => Promise<unknown>, timerService: ERef<TimerService>, collectionInterval?: RelativeTime): void;
+export function makeShareConfig(destinations?: Record<Keyword, ERef<FeeDestination>>, keywordShares?: Record<Keyword, NatValue>): {
+    shares: {
+        share: bigint;
+        destination: globalThis.ERef<FeeDestination>;
+    }[];
+    totalShares: bigint;
+};
+export function sharePayment(payment: Payment<"nat">, issuer: ERef<Issuer<"nat">>, { shares, totalShares }: ShareConfig): Promise<void>;
+export function makeFeeDistributor(feeIssuer: ERef<Issuer<"nat">>, terms: {
+    keywordShares: Record<Keyword, NatValue>;
+    timerService: ERef<TimerService>;
+    collectionInterval: RelativeTime;
+}): {
+    creatorFacet: {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        }>;
+        /**
+         * Start distributing fees from this collector.
+         *
+         * @param {string} debugName
+         * @param {ERef<FeeCollector>} collectorP
+         */
+        startPeriodicCollection: (debugName: string, collectorP: ERef<FeeCollector>) => Promise<PeriodicFeeCollector>;
+        /**
+         * @param {import('@endo/far').EOnly<
+         *   import('@agoric/ertp/src/types.js').DepositFacet
+         * >} depositFacet
+         */
+        makeDepositFacetDestination: (depositFacet: import("@endo/far").EOnly<import("@agoric/ertp/src/types.js").DepositFacet>) => {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        }>;
+        /**
+         * Create a destination that generates invitations and makes Zoe offers.
+         *
+         * @param {ERef<ZoeService>} zoe
+         * @param {string} keyword
+         * @param {unknown} target
+         * @param {PropertyKey} makeInvitationMethod
+         * @param {unknown[]} [args]
+         */
+        makeOfferDestination: (zoe: ERef<ZoeService>, keyword: string, target: unknown, makeInvitationMethod: PropertyKey, args?: unknown[]) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        }>;
+        /** @param {Record<Keyword, ERef<FeeDestination>>} newDestinations */
+        setDestinations: (newDestinations: Record<Keyword, ERef<FeeDestination>>) => Promise<void>;
+        /** @param {Record<Keyword, bigint>} newShares */
+        setKeywordShares: (newShares: Record<Keyword, bigint>) => void;
+    } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        }>;
+        /**
+         * Start distributing fees from this collector.
+         *
+         * @param {string} debugName
+         * @param {ERef<FeeCollector>} collectorP
+         */
+        startPeriodicCollection: (debugName: string, collectorP: ERef<FeeCollector>) => Promise<PeriodicFeeCollector>;
+        /**
+         * @param {import('@endo/far').EOnly<
+         *   import('@agoric/ertp/src/types.js').DepositFacet
+         * >} depositFacet
+         */
+        makeDepositFacetDestination: (depositFacet: import("@endo/far").EOnly<import("@agoric/ertp/src/types.js").DepositFacet>) => {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        }>;
+        /**
+         * Create a destination that generates invitations and makes Zoe offers.
+         *
+         * @param {ERef<ZoeService>} zoe
+         * @param {string} keyword
+         * @param {unknown} target
+         * @param {PropertyKey} makeInvitationMethod
+         * @param {unknown[]} [args]
+         */
+        makeOfferDestination: (zoe: ERef<ZoeService>, keyword: string, target: unknown, makeInvitationMethod: PropertyKey, args?: unknown[]) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        }>;
+        /** @param {Record<Keyword, ERef<FeeDestination>>} newDestinations */
+        setDestinations: (newDestinations: Record<Keyword, ERef<FeeDestination>>) => Promise<void>;
+        /** @param {Record<Keyword, bigint>} newShares */
+        setKeywordShares: (newShares: Record<Keyword, bigint>) => void;
+    }>;
+    publicFacet: {
+        distributeFees: (payment: Payment<"nat">) => Promise<void>;
+        getKeywordShares: () => Record<string, bigint>;
+    } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        distributeFees: (payment: Payment<"nat">) => Promise<void>;
+        getKeywordShares: () => Record<string, bigint>;
+    }>;
+};
+export function start(zcf: ZCF<Parameters<typeof makeFeeDistributor>[1]>): Promise<{
+    creatorFacet: {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        }>;
+        /**
+         * Start distributing fees from this collector.
+         *
+         * @param {string} debugName
+         * @param {ERef<FeeCollector>} collectorP
+         */
+        startPeriodicCollection: (debugName: string, collectorP: ERef<FeeCollector>) => Promise<PeriodicFeeCollector>;
+        /**
+         * @param {import('@endo/far').EOnly<
+         *   import('@agoric/ertp/src/types.js').DepositFacet
+         * >} depositFacet
+         */
+        makeDepositFacetDestination: (depositFacet: import("@endo/far").EOnly<import("@agoric/ertp/src/types.js").DepositFacet>) => {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        }>;
+        /**
+         * Create a destination that generates invitations and makes Zoe offers.
+         *
+         * @param {ERef<ZoeService>} zoe
+         * @param {string} keyword
+         * @param {unknown} target
+         * @param {PropertyKey} makeInvitationMethod
+         * @param {unknown[]} [args]
+         */
+        makeOfferDestination: (zoe: ERef<ZoeService>, keyword: string, target: unknown, makeInvitationMethod: PropertyKey, args?: unknown[]) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        }>;
+        /** @param {Record<Keyword, ERef<FeeDestination>>} newDestinations */
+        setDestinations: (newDestinations: Record<Keyword, ERef<FeeDestination>>) => Promise<void>;
+        /** @param {Record<Keyword, bigint>} newShares */
+        setKeywordShares: (newShares: Record<Keyword, bigint>) => void;
+    } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<any, any>>;
+        }>;
+        /**
+         * Start distributing fees from this collector.
+         *
+         * @param {string} debugName
+         * @param {ERef<FeeCollector>} collectorP
+         */
+        startPeriodicCollection: (debugName: string, collectorP: ERef<FeeCollector>) => Promise<PeriodicFeeCollector>;
+        /**
+         * @param {import('@endo/far').EOnly<
+         *   import('@agoric/ertp/src/types.js').DepositFacet
+         * >} depositFacet
+         */
+        makeDepositFacetDestination: (depositFacet: import("@endo/far").EOnly<import("@agoric/ertp/src/types.js").DepositFacet>) => {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, _issuer: any) => Promise<globalThis.Amount>;
+        }>;
+        /**
+         * Create a destination that generates invitations and makes Zoe offers.
+         *
+         * @param {ERef<ZoeService>} zoe
+         * @param {string} keyword
+         * @param {unknown} target
+         * @param {PropertyKey} makeInvitationMethod
+         * @param {unknown[]} [args]
+         */
+        makeOfferDestination: (zoe: ERef<ZoeService>, keyword: string, target: unknown, makeInvitationMethod: PropertyKey, args?: unknown[]) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        }>;
+        /** @param {Record<Keyword, ERef<FeeDestination>>} newDestinations */
+        setDestinations: (newDestinations: Record<Keyword, ERef<FeeDestination>>) => Promise<void>;
+        /** @param {Record<Keyword, bigint>} newShares */
+        setKeywordShares: (newShares: Record<Keyword, bigint>) => void;
+    }>;
+    publicFacet: {
+        distributeFees: (payment: Payment<"nat">) => Promise<void>;
+        getKeywordShares: () => Record<string, bigint>;
+    } & RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        distributeFees: (payment: Payment<"nat">) => Promise<void>;
+        getKeywordShares: () => Record<string, bigint>;
+    }>;
+}>;
+export type FeeCollector = {
+    collectFees: () => ERef<Payment<"nat">>;
+};
+export type PeriodicFeeCollector = {
+    getCollector: () => FeeCollector;
+    collectAndDistributeNow: () => Promise<void>;
+    stop: () => void;
+};
+export type CollectibleContractFacet = {
+    makeCollectFeesInvitation: () => Promise<Invitation<string, never>>;
+};
+export type FeeDestination = {
+    pushPayment: (payment: Payment, issuer: ERef<Issuer>) => Promise<Amount>;
+};
+export type ShareConfig = ReturnType<typeof makeShareConfig>;
+export type FeeDistributorCreatorFacet = ReturnType<typeof makeFeeDistributor>["creatorFacet"];
+export type FeeDistributorPublicFacet = ReturnType<typeof makeFeeDistributor>["publicFacet"];
+import type { TimerService } from '@agoric/time';
+import type { RelativeTime } from '@agoric/time';
+//# sourceMappingURL=feeDistributor.d.ts.map

package/src/feeDistributor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"feeDistributor.d.ts","sourceRoot":"","sources":["feeDistributor.js"],"names":[],"mappings":"AAeA,yCAAyC;AACzC,mBADW,YAAY,CAAC,OAAO,KAAK,CAAC,CAOnC;AAgCK,8CAHI,IAAI,CAAC,UAAU,CAAC,gBAChB,IAAI,CAAC,wBAAwB,CAAC;;;;GAWxC;AAeM,oDAPI,MAAM,OAAO,CAAC,OAAO,CAAC,gBAEtB,IAAI,CAAC,YAAY,CAAC,uBAElB,YAAY,QA6BtB;AASM,+CAHI,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC,kBACrC,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;;;;;;EAenC;AAWM,sCAJI,OAAO,CAAC,KAAK,CAAC,UACd,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,2BACnB,WAAW,iBA8DrB;AAUM,8CAPI,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,SACnB;IACN,aAAa,EAAE,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IACzC,YAAY,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACjC,kBAAkB,EAAE,YAAY,CAAC;CAClC;;wCA1JO,IAAI,CAAC,UAAU,CAAC,gBAChB,IAAI,CAAC,wBAAwB,CAAC;;;;;QA4LrC;;;;;WAKG;6CAFQ,MAAM,cACN,IAAI,CAAC,YAAY,CAAC;QA6B7B;;;;WAIG;oDAHQ,OAAO,WAAW,EAAE,KAAK,CACnC,OAAW,2BAA2B,EAAE,YAAY,CACjD;;;;;QASJ;;;;;;;;WAQG;oCALQ,IAAI,CAAC,UAAU,CAAC,WAChB,MAAM,UACN,OAAO,wBACP,WAAW,SACX,OAAO,EAAE;;;;;QAqCpB,qEAAqE;2CAAzD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQjD,iDAAiD;sCAArC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC;;wCA9R5B,IAAI,CAAC,UAAU,CAAC,gBAChB,IAAI,CAAC,wBAAwB,CAAC;;;;;QA4LrC;;;;;WAKG;6CAFQ,MAAM,cACN,IAAI,CAAC,YAAY,CAAC;QA6B7B;;;;WAIG;oDAHQ,OAAO,WAAW,EAAE,KAAK,CACnC,OAAW,2BAA2B,EAAE,YAAY,CACjD;;;;;QASJ;;;;;;;;WAQG;oCALQ,IAAI,CAAC,UAAU,CAAC,WAChB,MAAM,UACN,OAAO,wBACP,WAAW,SACX,OAAO,EAAE;;;;;QAqCpB,qEAAqE;2CAAzD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQjD,iDAAiD;sCAArC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC;;;kCAvHzB,OAAO,CAAC,KAAK,CAAC;;;kCAAd,OAAO,CAAC,KAAK,CAAC;;;EAqI3B;AAMM,2BADK,GAAG,CAAC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC,CAAC;;wCAjT9C,IAAI,CAAC,UAAU,CAAC,gBAChB,IAAI,CAAC,wBAAwB,CAAC;;;;;QA4LrC;;;;;WAKG;6CAFQ,MAAM,cACN,IAAI,CAAC,YAAY,CAAC;QA6B7B;;;;WAIG;oDAHQ,OAAO,WAAW,EAAE,KAAK,CACnC,OAAW,2BAA2B,EAAE,YAAY,CACjD;;;;;QASJ;;;;;;;;WAQG;oCALQ,IAAI,CAAC,UAAU,CAAC,WAChB,MAAM,UACN,OAAO,wBACP,WAAW,SACX,OAAO,EAAE;;;;;QAqCpB,qEAAqE;2CAAzD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQjD,iDAAiD;sCAArC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC;;wCA9R5B,IAAI,CAAC,UAAU,CAAC,gBAChB,IAAI,CAAC,wBAAwB,CAAC;;;;;QA4LrC;;;;;WAKG;6CAFQ,MAAM,cACN,IAAI,CAAC,YAAY,CAAC;QA6B7B;;;;WAIG;oDAHQ,OAAO,WAAW,EAAE,KAAK,CACnC,OAAW,2BAA2B,EAAE,YAAY,CACjD;;;;;QASJ;;;;;;;;WAQG;oCALQ,IAAI,CAAC,UAAU,CAAC,WAChB,MAAM,UACN,OAAO,wBACP,WAAW,SACX,OAAO,EAAE;;;;;QAqCpB,qEAAqE;2CAAzD,MAAM,CAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAQjD,iDAAiD;sCAArC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC;;;kCAvHzB,OAAO,CAAC,KAAK,CAAC;;;kCAAd,OAAO,CAAC,KAAK,CAAC;;;GA8I3B;;iBAxUa,MAAM,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;;;kBAK1B,MAAM,YAAY;6BAClB,MAAM,OAAO,CAAC,IAAI,CAAC;UACnB,MAAM,IAAI;;;+BAKV,MAAM,OAAO,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;;6BA+DzC;IACR,WAAW,EAAE,CAAC,OAAO,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;CAC1E;0BAmBU,UAAU,CAAC,OAAO,eAAe,CAAC;yCAiOlC,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,cAAc,CAAC;wCACrD,UAAU,CAAC,OAAO,kBAAkB,CAAC,CAAC,aAAa,CAAC;kCAvUnC,cAAc;kCADd,cAAc"}

package/src/feeDistributor.js

@@ -7,25 +7,29 @@ import { mustMatch, makeScalarSetStore, M } from '@agoric/store';
 import { RelativeTimeShape } from '@agoric/time';
 import { KeywordShape } from '@agoric/zoe/src/typeGuards.js';
 
-const KeywordSharesShape = M.recordOf(KeywordShape, M.nat());
-
 /**
- * A pattern for Zoe to check custom terms before `start()`ing the contract.
+ * @import {MapStore, SetStore} from '@agoric/store';
  */
-export const customTermsShape = harden({
-  keywordShares: KeywordSharesShape,
-  timerService: M.eref(M.remotable('TimerService')),
-  collectionInterval: RelativeTimeShape,
-});
+
+const KeywordSharesShape = M.recordOf(KeywordShape, M.nat());
+
+/** @type {ContractMeta<typeof start>} */
+export const meta = {
+  customTermsShape: {
+    keywordShares: KeywordSharesShape,
+    timerService: M.eref(M.remotable('TimerService')),
+    collectionInterval: RelativeTimeShape,
+  },
+};
+harden(meta);
 
 /**
- * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
- * @typedef {import('@agoric/time/src/types').TimerService} TimerService
+ * @import {RelativeTime} from '@agoric/time'
+ * @import {TimerService} from '@agoric/time'
  */
 
 /**
  * @typedef {object} FeeCollector
- *
  * @property {() => ERef<Payment<'nat'>>} collectFees
  */
 
@@ -65,10 +69,12 @@ export const makeContractFeeCollector = (zoe, creatorFacet) => {
  * for fees that have been collected to date and send that payment to the
  * depositFacet.
  *
- * @param {() => Promise<unknown>} schedulePayments - distribute to the destinations
- * @param {ERef<TimerService>} timerService - timer that is used to schedule collections
+ * @param {() => Promise<unknown>} schedulePayments - distribute to the
+ *   destinations
+ * @param {ERef<TimerService>} timerService - timer that is used to schedule
+ *   collections
  * @param {RelativeTime} [collectionInterval] - how often to collect fees in the
- * `timerService` unit
+ *   `timerService` unit
  */
 export const startDistributing = (
   schedulePayments,
@@ -99,8 +105,9 @@ export const startDistributing = (
 };
 
 /**
- * @typedef {{ pushPayment: (payment: Payment, issuer: ERef<Issuer>) => Promise<Amount>}} FeeDestination
- *
+ * @typedef {{
+ *   pushPayment: (payment: Payment, issuer: ERef<Issuer>) => Promise<Amount>;
+ * }} FeeDestination
  * @param {Record<Keyword, ERef<FeeDestination>>} [destinations]
  * @param {Record<Keyword, NatValue>} [keywordShares]
  */
@@ -161,17 +168,16 @@ export const sharePayment = async (
     .filter(([_, amt]) => !AmountMath.isEmpty(amt));
 
   /**
-   * If the `sharedPayment[i]` payments that are sent to the fee
-   * `destination` with `pushPayment` never arrive, or never get deposited
-   * (or otherwise used up), then they remain in the recovery set of the
-   * `recoveryPurse`. The purpose of this, and of recovery sets in general,
-   * is to be able, in emergencies, to recover the assets of payments in flight
-   * that seem to be stuck. This is much like cancelling a check that may still
-   * be undeposited.
+   * If the `sharedPayment[i]` payments that are sent to the fee `destination`
+   * with `pushPayment` never arrive, or never get deposited (or otherwise used
+   * up), then they remain in the recovery set of the `recoveryPurse`. The
+   * purpose of this, and of recovery sets in general, is to be able, in
+   * emergencies, to recover the assets of payments in flight that seem to be
+   * stuck. This is much like cancelling a check that may still be undeposited.
    *
    * TODO: However, for this to be possible, the `recoveryPurse` holding that
-   * recovery set must remain accessible to someone that should legitimately
-   * be able to recover those payments. But this `recoveryPurse` is currently
+   * recovery set must remain accessible to someone that should legitimately be
+   * able to recover those payments. But this `recoveryPurse` is currently
    * dropped on the floor instead.
    */
   const recoveryPurse = E(issuer).makeEmptyPurse();
@@ -193,7 +199,11 @@ export const sharePayment = async (
 
 /**
  * @param {ERef<Issuer<'nat'>>} feeIssuer
- * @param {{ keywordShares: Record<Keyword, NatValue>, timerService: ERef<TimerService>, collectionInterval: RelativeTime}} terms
+ * @param {{
+ *   keywordShares: Record<Keyword, NatValue>;
+ *   timerService: ERef<TimerService>;
+ *   collectionInterval: RelativeTime;
+ * }} terms
  */
 export const makeFeeDistributor = (feeIssuer, terms) => {
   const { timerService, collectionInterval } = terms;
@@ -262,7 +272,9 @@ export const makeFeeDistributor = (feeIssuer, terms) => {
     },
 
     /**
-     * @param {import('@endo/far').EOnly<DepositFacet>} depositFacet
+     * @param {import('@endo/far').EOnly<
+     *   import('@agoric/ertp/src/types.js').DepositFacet
+     * >} depositFacet
      */
     makeDepositFacetDestination: depositFacet => {
       return Far(`DepositFacetDestination`, {
@@ -315,9 +327,7 @@ export const makeFeeDistributor = (feeIssuer, terms) => {
       });
     },
 
-    /**
-     * @param {Record<Keyword, ERef<FeeDestination>>} newDestinations
-     */
+    /** @param {Record<Keyword, ERef<FeeDestination>>} newDestinations */
     setDestinations: async newDestinations => {
       destinations = newDestinations;
       shareConfig = makeShareConfig(destinations, keywordShares);
@@ -344,9 +354,7 @@ export const makeFeeDistributor = (feeIssuer, terms) => {
 /** @typedef {ReturnType<typeof makeFeeDistributor>['creatorFacet']} FeeDistributorCreatorFacet */
 /** @typedef {ReturnType<typeof makeFeeDistributor>['publicFacet']} FeeDistributorPublicFacet */
 
-/**
- * @param {ZCF<Parameters<typeof makeFeeDistributor>[1]>} zcf
- */
+/** @param {ZCF<Parameters<typeof makeFeeDistributor>[1]>} zcf */
 export const start = async zcf => {
   const feeIssuer = E(zcf.getZoeService()).getFeeIssuer();
   return makeFeeDistributor(feeIssuer, zcf.getTerms());

package/src/index.d.ts

@@ -0,0 +1,2 @@
+export { calculateCurrentDebt } from "./interest-math.js";
+//# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

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

package/src/index.js

@@ -1,3 +1,4 @@
 // @jessie-check
+/// <reference types="@agoric/vats/src/core/types-ambient" />
 
 export { calculateCurrentDebt } from './interest-math.js';

package/src/interest-math.d.ts

@@ -0,0 +1,4 @@
+export function calculateCurrentDebt(debtSnapshot: Amount<"nat">, interestSnapshot: Ratio, currentCompoundedInterest: Ratio): Amount<"nat">;
+export function reverseInterest(debt: Amount<"nat">, interestApplied: Ratio): Amount<"nat">;
+import type { Amount } from '@agoric/ertp';
+//# sourceMappingURL=interest-math.d.ts.map

package/src/interest-math.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interest-math.d.ts","sourceRoot":"","sources":["interest-math.js"],"names":[],"mappings":"AAoCO,mDALI,OAAO,KAAK,CAAC,oBACb,KAAK,6BACL,KAAK,GACH,OAAO,KAAK,CAAC,CAiBzB;AAOM,sCAJI,OAAO,KAAK,CAAC,mBACb,KAAK,GACH,OAAO,KAAK,CAAC,CAIzB;4BAjDwC,cAAc"}

package/src/interest-math.js

@@ -6,7 +6,11 @@ import {
   invertRatio,
   multiplyRatios,
   ratiosSame,
-} from '@agoric/zoe/src/contractSupport/ratio.js';
+} from '@agoric/ertp/src/ratio.js';
+
+/**
+ * @import {Amount, Brand, Payment} from '@agoric/ertp';
+ */
 
 /**
  * @param {Ratio} currentCompoundedInterest as coefficient