@agoric/inter-protocol 0.16.2-upgrade-14-dev-0169c7e.0 → 0.16.2-upgrade-16-dev-8879538.0

package/src/feeDistributor.d.ts

@@ -0,0 +1,224 @@
+/** @type {ContractMeta} */
+export const meta: ContractMeta;
+export function makeContractFeeCollector(zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>): {
+    collectFees: () => Promise<globalThis.Payment<any>>;
+} & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+    collectFees: () => Promise<globalThis.Payment<any>>;
+}>;
+export function startDistributing(schedulePayments: () => Promise<unknown>, timerService: globalThis.ERef<TimerService>, collectionInterval?: RelativeTime | undefined): void;
+export function makeShareConfig(destinations?: Record<string, globalThis.ERef<FeeDestination>> | undefined, keywordShares?: Record<string, bigint> | undefined): {
+    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: globalThis.ERef<TimerService>;
+    collectionInterval: RelativeTime;
+}): {
+    creatorFacet: {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any>>;
+        } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<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>;
+        } & import("@endo/pass-style").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[] | undefined) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & import("@endo/pass-style").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;
+    } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any>>;
+        } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<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>;
+        } & import("@endo/pass-style").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[] | undefined) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & import("@endo/pass-style").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>;
+    } & import("@endo/pass-style").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>>;
+        } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<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>;
+        } & import("@endo/pass-style").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[] | undefined) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & import("@endo/pass-style").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;
+    } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+        makeContractFeeCollector: (zoe: ERef<ZoeService>, creatorFacet: ERef<CollectibleContractFacet>) => {
+            collectFees: () => Promise<globalThis.Payment<any>>;
+        } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            collectFees: () => Promise<globalThis.Payment<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>;
+        } & import("@endo/pass-style").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[] | undefined) => {
+            pushPayment: (payment: any, issuer: any) => Promise<any>;
+        } & import("@endo/pass-style").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>;
+    } & import("@endo/pass-style").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":"AAWA,2BAA2B;AAC3B,mBADW,YAAY,CAOrB;AAgCK,8CAHI,IAAI,CAAC,UAAU,CAAC,gBAChB,IAAI,CAAC,wBAAwB,CAAC;;;;GAWxC;AAeM,oDAPI,MAAM,OAAO,CAAC,OAAO,CAAC,oGAiChC;AASM;;;;;;EAaN;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;mBAEV,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC;;;;;wCAvJlC,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;;;;;QAsCtB,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;;;;;QAsCtB,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;;;;;QAsCtB,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;;;;;QAsCtB,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;IACZ,WAAe,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

@@ -9,23 +9,23 @@ 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.
- */
-export const customTermsShape = harden({
-  keywordShares: KeywordSharesShape,
-  timerService: M.eref(M.remotable('TimerService')),
-  collectionInterval: RelativeTimeShape,
-});
+/** @type {ContractMeta} */
+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 +65,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 +101,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 +164,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 +195,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 +268,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 +323,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 +350,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,3 @@
+export function calculateCurrentDebt(debtSnapshot: Amount<"nat">, interestSnapshot: Ratio, currentCompoundedInterest: Ratio): Amount<"nat">;
+export function reverseInterest(debt: Amount<"nat">, interestApplied: Ratio): Amount<"nat">;
+//# 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":"AAgCO,mDALI,MAAM,CAAC,KAAK,CAAC,oBACb,KAAK,6BACL,KAAK,GACH,MAAM,CAAC,KAAK,CAAC,CAiBzB;AAOM,sCAJI,MAAM,CAAC,KAAK,CAAC,mBACb,KAAK,GACH,MAAM,CAAC,KAAK,CAAC,CAIzB"}

package/src/interest.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @import {Timestamp} from '@agoric/time'
+ * @import {RelativeTime} from '@agoric/time'
+ */
+export const SECONDS_PER_YEAR: bigint;
+export function makeInterestCalculator(annualRate: Ratio, chargingPeriod: RelativeTime, recordingPeriod: RelativeTime): CalculatorKit;
+export function calculateCompoundedInterest(priorCompoundedInterest: Ratio, priorDebt: NatValue, newDebt: NatValue): Ratio;
+export function chargeInterest(powers: {
+    mint: ZCFMint<"nat">;
+    mintAndTransferWithFee: MintAndTransfer;
+    poolIncrementSeat: ZCFSeat;
+    seatAllocationKeyword: Keyword;
+}, params: {
+    interestRate: Ratio;
+    chargingPeriod: RelativeTime;
+    recordingPeriod: RelativeTime;
+}, prior: {
+    latestInterestUpdate: Timestamp;
+    compoundedInterest: Ratio;
+    totalDebt: Amount<"nat">;
+}, accruedUntil: Timestamp): {
+    compoundedInterest: Ratio;
+    latestInterestUpdate: Timestamp;
+    totalDebt: Amount<"nat">;
+};
+import type { RelativeTime } from '@agoric/time';
+import type { Timestamp } from '@agoric/time';
+//# sourceMappingURL=interest.d.ts.map

package/src/interest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"interest.d.ts","sourceRoot":"","sources":["interest.js"],"names":[],"mappings":"AAYA;;;GAGG;AAEH,sCAAuD;AAchD,mDALI,KAAK,gEAGH,aAAa,CA+EzB;AASM,qEAJI,KAAK,aACL,QAAQ,WACR,QAAQ,SAalB;AAyCM,uCAvBI;IACV,IAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,CAAC;IACzB,sBAA0B,EAAE,eAAe,CAAC;IAC5C,iBAAqB,EAAE,OAAO,CAAC;IAC/B,qBAAyB,EAAE,OAAO,CAAC;CAChC;kBAEe,KAAK;;;;;wBAMC,KAAK;eACd,MAAM,CAAC,KAAK,CAAC;;wBAIJ,KAAK;;eAEd,MAAM,CAAC,KAAK,CAAC;EA+D5B;kCAvN8B,cAAc;+BADjB,cAAc"}

package/src/interest.js

@@ -11,8 +11,8 @@ import { Fail } from '@agoric/assert';
 import { TimeMath } from '@agoric/time';
 
 /**
- * @typedef {import('@agoric/time/src/types').Timestamp} Timestamp
- * @typedef {import('@agoric/time/src/types').RelativeTime} RelativeTime
+ * @import {Timestamp} from '@agoric/time'
+ * @import {RelativeTime} from '@agoric/time'
  */
 
 export const SECONDS_PER_YEAR = 60n * 60n * 24n * 365n;
@@ -20,9 +20,7 @@ const BASIS_POINTS = 10000;
 // single digit APR is less than a basis point per day.
 const LARGE_DENOMINATOR = BASIS_POINTS * BASIS_POINTS;
 
-/**
- * Number chosen from 6 digits for a basis point, doubled for multiplication.
- */
+/** Number chosen from 6 digits for a basis point, doubled for multiplication. */
 const COMPOUNDED_INTEREST_DENOMINATOR = 10n ** 20n;
 
 /**
@@ -147,20 +145,27 @@ const validatedBrand = (mint, debt) => {
  * Charge interest accrued between `latestInterestUpdate` and `accruedUntil`.
  *
  * @param {{
- *  mint: ZCFMint<'nat'>,
- *  mintAndTransferWithFee: MintAndTransfer,
- *  poolIncrementSeat: ZCFSeat,
- *  seatAllocationKeyword: Keyword }} powers
+ *   mint: ZCFMint<'nat'>;
+ *   mintAndTransferWithFee: MintAndTransfer;
+ *   poolIncrementSeat: ZCFSeat;
+ *   seatAllocationKeyword: Keyword;
+ * }} powers
  * @param {{
- *  interestRate: Ratio,
- *  chargingPeriod: RelativeTime,
- *  recordingPeriod: RelativeTime}} params
+ *   interestRate: Ratio;
+ *   chargingPeriod: RelativeTime;
+ *   recordingPeriod: RelativeTime;
+ * }} params
  * @param {{
- *  latestInterestUpdate: Timestamp,
- *  compoundedInterest: Ratio,
- *  totalDebt: Amount<'nat'>}} prior
+ *   latestInterestUpdate: Timestamp;
+ *   compoundedInterest: Ratio;
+ *   totalDebt: Amount<'nat'>;
+ * }} prior
  * @param {Timestamp} accruedUntil
- * @returns {{compoundedInterest: Ratio, latestInterestUpdate: Timestamp, totalDebt: Amount<'nat'> }}
+ * @returns {{
+ *   compoundedInterest: Ratio;
+ *   latestInterestUpdate: Timestamp;
+ *   totalDebt: Amount<'nat'>;
+ * }}
  */
 export const chargeInterest = (powers, params, prior, accruedUntil) => {
   const brand = validatedBrand(powers.mint, prior.totalDebt);

package/src/price/README.md

@@ -4,6 +4,19 @@ This directory contains the `fluxAggregatorKit.js` contract which takes prices a
 input and outputs a best known price. There are multiple ways to get the price,
 including a PriceAuthority interface.
 
+## Design
+
+The authorities are hierarchical. Many authorities can be registered in the priceAuthorityRegistry.
+
+For oracles, there must be two: the negotiable brand and the _oracle_ brand (an inert one).
+
+The intended flow is that:
+1. a negotiable brand is created (e.g. ATOM)
+2. a price provider says “i can give you quotes for that” and runs price-feed-proposal. That makes “oracleBrands” (which are inert and have a separate identity so that they don’t have the authority to say they’re the real quote for it).
+3. Some higher authority (eg EC, Stakers) decides that should be the quote source for negotiable brand so it registers it under the real brand identity in the registry (with a new instance of a scaledPriceAuthority ).
+
+In practice we do these all in one core proposal. And each vault manager is started with a limit on minting to the EC has another way to gate transactions.
+
 ## Usage
 
 See the [Smart Wallet integration test](/packages/inter-protocol/test/smartWallet/test-oracle-integration.js) for how it's used.

package/src/price/fluxAggregatorContract.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @import {Baggage} from '@agoric/vat-data'
+ * @import {TimerService} from '@agoric/time'
+ */
+/** @type {ContractMeta} */
+export const meta: ContractMeta;
+export function start(zcf: ZCF<import("./fluxAggregatorKit.js").ChainlinkConfig & {
+    timer: TimerService;
+    brandIn: Brand<"nat">;
+    brandOut: Brand<"nat">;
+    description: string;
+    unitAmountIn?: Amount<"nat">;
+}>, privateArgs: {
+    highPrioritySendersManager?: import("@agoric/internal/src/priority-senders.js").PrioritySendersManager;
+    initialPoserInvitation: Invitation;
+    marshaller: ERef<Marshaller>;
+    namesByAddressAdmin: ERef<import("@agoric/vats").NameAdmin>;
+    storageNode: StorageNode;
+}, baggage: Baggage): Promise<{
+    creatorFacet: import("@endo/exo").Guarded<{
+        getParamMgrRetriever: () => {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                Electorate: "invitation";
+            }>;
+        } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+            get: () => import("@agoric/governance/src/contractGovernance/typedParamManager.js").TypedParamManager<{
+                Electorate: "invitation";
+            }>;
+        }>;
+        getInvitation: (name: any) => Promise<Invitation<unknown, undefined>>;
+        getLimitedCreatorFacet: () => import("@endo/exo").Guarded<{
+            makeOracleInvitation(oracleId: string): Promise<Invitation<{
+                invitationMakers: {
+                    PushPrice(result: import("./roundsManager.js").PriceRound): Promise<Invitation<void, undefined>>;
+                } & import("@endo/pass-style").RemotableObject<`Alleged: ${string}`> & import("@endo/eventual-send").RemotableBrand<{}, {
+                    PushPrice(result: import("./roundsManager.js").PriceRound): Promise<Invitation<void, undefined>>;
+                }>;
+                oracle: import("@endo/exo").Guarded<{
+                    pushPrice({ roundId: roundIdRaw, unitPrice: valueRaw, }: PriceDatum): Promise<void>;
+                    getStatus(): import("./priceOracleKit.js").OracleStatus;
+                }>;
+            }, undefined>>;
+            removeOracle(oracleId: string): Promise<void>;
+            getRoundData: (roundIdRaw: any) => Promise<import("./roundsManager.js").RoundData>;
+            initOracle(oracleId: string): Promise<import("@endo/exo").GuardedKit<{
+                admin: {
+                    disable(): void;
+                };
+                oracle: {
+                    pushPrice({ roundId: roundIdRaw, unitPrice: valueRaw, }: PriceDatum): Promise<void>;
+                    getStatus(): import("./priceOracleKit.js").OracleStatus;
+                };
+            }>>;
+            oracleRoundState(oracleId: string, queriedRoundId: bigint): Promise<import("./fluxAggregatorKit.js").RoundState>;
+        }>;
+        getGovernedApis: () => globalThis.GovernedApis;
+        getGovernedApiNames: () => string[];
+        setOfferFilter: (strings: any) => Promise<void>;
+    }>;
+    publicFacet: import("@endo/exo").Guarded<{
+        getPriceAuthority(): import("@agoric/zoe/tools/types.js").PriceAuthority;
+        getPublicTopics(): {
+            quotes: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("@agoric/zoe/tools/types.js").PriceDescription>;
+            latestRound: import("@agoric/zoe/src/contractSupport/topics.js").PublicTopic<import("./roundsManager.js").LatestRound>;
+        };
+    }>;
+}>;
+import type { TimerService } from '@agoric/time';
+import type { Baggage } from '@agoric/vat-data';
+//# sourceMappingURL=fluxAggregatorContract.d.ts.map

package/src/price/fluxAggregatorContract.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fluxAggregatorContract.d.ts","sourceRoot":"","sources":["fluxAggregatorContract.js"],"names":[],"mappings":"AAcA;;;GAGG;AAEH,2BAA2B;AAC3B,mBADW,YAAY,CAmBrB;AA0BK;;aAfS,KAAK,CAAC,KAAK,CAAC;cACX,KAAK,CAAC,KAAK,CAAC;iBACT,MAAM;mBACJ,MAAM,CAAC,KAAK,CAAC;iBAGxB;IACV,0BAA8B,CAAC,EAAE,OAAO,0CAA0C,EAAE,sBAAsB,CAAC;IAC3G,sBAA0B,EAAE,UAAU,CAAC;IACvC,UAAc,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACjC,mBAAuB,EAAE,IAAI,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,CAAC;IAChE,WAAe,EAAE,WAAW,CAAC;CAC1B;;;;;;;;;;;;;;;sCAwI45F,OAAO,oBAAoB,EAAE,UAAU;;mEAAV,UAAU;;;6EA5It8F,UAAQ;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0IR;kCAnL8B,cAAc;6BADnB,kBAAkB"}