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

package/src/clientSupport.js

@@ -9,16 +9,22 @@ import { parseRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
 const COSMOS_UNIT = 1_000_000n;
 const scaleDecimals = num => BigInt(num * Number(COSMOS_UNIT));
 
-// TODO use '@satisfies" in TS 5.1 to make sure these each conform to OfferMaker interface
-
 // NB: not really a Proposal because the brands are not remotes
 // Instead they're copyRecord like  "{"boardId":"board0257","iface":"Alleged: IST brand"}" to pass through the boardId
 // mustMatch(harden(proposal), ProposalShape);
 /**
  * Give/want
  *
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
- * @param {{ giveMinted?: number, wantMinted?: number } | { collateralBrandKey: string, giveCollateral?: number, wantCollateral?: number }} opts
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {| { giveMinted?: number; wantMinted?: number }
+ *   | {
+ *       collateralBrandKey: string;
+ *       giveCollateral?: number;
+ *       wantCollateral?: number;
+ *     }} opts
  * @returns {Proposal}
  */
 const makeVaultProposal = ({ brand }, opts) => {
@@ -56,8 +62,16 @@ const makeVaultProposal = ({ brand }, opts) => {
 };
 
 /**
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
- * @param {{ offerId: string, wantMinted: number, giveCollateral: number, collateralBrandKey: string }} opts
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   wantMinted: number;
+ *   giveCollateral: number;
+ *   collateralBrandKey: string;
+ * }} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
 const makeOpenOffer = ({ brand }, opts) => {
@@ -84,8 +98,18 @@ const makeOpenOffer = ({ brand }, opts) => {
 };
 
 /**
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
- * @param {{ offerId: string, collateralBrandKey?: string, giveCollateral?: number, wantCollateral?: number, giveMinted?: number, wantMinted?: number }} opts
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   collateralBrandKey?: string;
+ *   giveCollateral?: number;
+ *   wantCollateral?: number;
+ *   giveMinted?: number;
+ *   wantMinted?: number;
+ * }} opts
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
@@ -107,8 +131,15 @@ const makeAdjustOffer = ({ brand }, opts, previousOffer) => {
 };
 
 /**
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
- * @param {{ offerId: string, collateralBrandKey?: string, giveMinted: number }} opts
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
+ * @param {{
+ *   offerId: string;
+ *   collateralBrandKey?: string;
+ *   giveMinted: number;
+ * }} opts
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
@@ -128,7 +159,9 @@ const makeCloseOffer = ({ brand }, opts, previousOffer) => {
 
 /**
  * @param {string} vaultId
- * @param {Promise<import('@agoric/smart-wallet/src/smartWallet').CurrentWalletRecord>} currentP
+ * @param {Promise<
+ *   import('@agoric/smart-wallet/src/smartWallet.js').CurrentWalletRecord
+ * >} currentP
  * @returns {Promise<string>} offer id in which the vault was made
  */
 export const lookupOfferIdForVault = async (vaultId, currentP) => {
@@ -143,11 +176,14 @@ export const lookupOfferIdForVault = async (vaultId, currentP) => {
 };
 
 /**
- * @param {Record<string, Brand>} brands
- * @param {({ wantMinted: number, giveMinted?: undefined } | { giveMinted: number, wantMinted?: undefined })} opts
- * @param {number} [fee=0]
+ * @param {Record<
+ *   string,
+ *   import('@agoric/internal/src/marshal.js').BoardRemote
+ * >} brands
+ * @param {| { wantMinted: number; giveMinted?: undefined }
+ *   | { giveMinted: number; wantMinted?: undefined }} opts
+ * @param {number} [fee]
  * @param {string} [anchor]
- * @returns {Proposal} XXX not a real proposal, uses BoardRemote
  */
 const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
   const giving = 'giveMinted' in opts ? 'minted' : 'anchor';
@@ -173,10 +209,15 @@ const makePsmProposal = (brands, opts, fee = 0, anchor = 'AUSD') => {
 };
 
 /**
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
  * @param {Instance} instance
- * @param {{ offerId: string, feePct?: number, pair: [string, string] } &
- *         ({ wantMinted: number } | { giveMinted: number })} opts
+ * @param {{ offerId: string; feePct?: number; pair: [string, string] } & (
+ *   | { wantMinted: number }
+ *   | { giveMinted: number }
+ * )} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
 const makePsmSwapOffer = ({ brand }, instance, opts) => {
@@ -202,15 +243,16 @@ const makePsmSwapOffer = ({ brand }, instance, opts) => {
       instance,
       publicInvitationMaker: method,
     },
+    // @ts-expect-error BoardRemote not a Brand object
     proposal,
   };
 };
 
 /**
- * @param {{
- *   brand: Record<string, Brand>,
- *   vbankAsset: Record<string, { brand: Brand, displayInfo: DisplayInfo }>,
- * }} agoricNames
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand' | 'vbankAsset'
+ * >} agoricNames
  * @param {(msg: string) => Error} makeError error constructor
  * @returns {(a: string) => Amount<'nat'>}
  */
@@ -250,17 +292,23 @@ export const makeParseAmount =
   };
 
 /**
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand' | 'vbankAsset'>} agoricNames
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand' | 'vbankAsset'
+ * >} agoricNames
  * @param {{
- *   offerId: string,
- *   give: string,
- *   maxBuy: string,
- *   wantMinimum?: string,
- * } & ({
- *   price: number,
- * } | {
- *   discount: number,  // -1 to 1. e.g. 0.10 for 10% discount, -0.05 for 5% markup
- * })} opts
+ *   offerId: string;
+ *   give: string;
+ *   maxBuy: string;
+ *   wantMinimum?: string;
+ * } & (
+ *   | {
+ *       price: number;
+ *     }
+ *   | {
+ *       discount: number; // -1 to 1. e.g. 0.10 for 10% discount, -0.05 for 5% markup
+ *     }
+ * )} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
 const makeBidOffer = (agoricNames, opts) => {
@@ -319,11 +367,14 @@ const makeBidOffer = (agoricNames, opts) => {
 };
 
 /**
- * @param {Pick<import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes, 'brand'>} agoricNames
+ * @param {Pick<
+ *   import('@agoric/vats/tools/board-utils.js').AgoricNamesRemotes,
+ *   'brand'
+ * >} agoricNames
  * @param {{
- *   offerId: string,
- *   give: number,
- *   collateralBrandKey: string,
+ *   offerId: string;
+ *   give: number;
+ *   collateralBrandKey: string;
  * }} opts
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
  */
@@ -331,6 +382,7 @@ const makeAddCollateralOffer = ({ brand }, opts) => {
   /** @type {AmountKeywordRecord} */
   const give = {
     Collateral: AmountMath.make(
+      // @ts-expect-error BoardRemote not a Brand object
       brand[opts.collateralBrandKey],
       scaleDecimals(opts.give),
     ),
@@ -350,12 +402,11 @@ const makeAddCollateralOffer = ({ brand }, opts) => {
 };
 
 /**
- *
  * @param {unknown} _agoricNames
  * @param {{
- *   offerId: string,
- *   roundId?: bigint,
- *   unitPrice: bigint,
+ *   offerId: string;
+ *   roundId?: bigint;
+ *   unitPrice: bigint;
  * }} opts
  * @param {string} previousOffer
  * @returns {import('@agoric/smart-wallet/src/offers.js').OfferSpec}
@@ -375,6 +426,12 @@ const makePushPriceOffer = (_agoricNames, opts, previousOffer) => {
   };
 };
 
+/**
+ * @satisfies {Record<
+ *   string,
+ *   Record<string, import('@agoric/smart-wallet/src/types.js').OfferMaker>
+ * >}
+ */
 export const Offers = {
   auction: {
     Bid: makeBidOffer,

package/src/collectFees.d.ts

@@ -0,0 +1,2 @@
+export function makeCollectFeesInvitation(zcf: ZCF, feeSeat: ZCFSeat, feeBrand: Brand, keyword: string): Promise<Invitation<string>>;
+//# sourceMappingURL=collectFees.d.ts.map

package/src/collectFees.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"collectFees.d.ts","sourceRoot":"","sources":["collectFees.js"],"names":[],"mappings":"AAaO,+CANI,GAAG,WACH,OAAO,YACP,KAAK,WACL,MAAM,GACJ,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,CAYvC"}

package/src/contractSupport.d.ts

@@ -0,0 +1,28 @@
+export namespace amountPattern {
+    let brand: import("@endo/patterns").Matcher;
+    let value: import("@endo/patterns").Matcher;
+}
+export namespace ratioPattern {
+    export { amountPattern as numerator };
+    export { amountPattern as denominator };
+}
+export function addSubtract<A extends globalThis.Amount>(base: A, gain: A, loss: A): A;
+export function subtractToEmpty<T extends globalThis.Amount>(left: T, right: T): T;
+export function assertOnlyKeys(proposal: ProposalRecord, keys: string[]): void;
+export function allEmpty(amounts: Amount[]): boolean;
+export function checkDebtLimit(debtLimit: Amount<"nat">, totalDebt: Amount<"nat">, toMint: Amount<"nat">): void;
+export function makeNatAmountShape(brand: Brand, min?: bigint | undefined): {
+    brand: globalThis.Brand;
+    value: import("@endo/patterns").Matcher;
+};
+export function quoteAsRatio(quoteAmount: Pick<PriceDescription, "amountIn" | "amountOut">): Ratio;
+export type MetricsPublisherKit<T> = {
+    metricsPublication: IterationObserver<T>;
+    metricsSubscription: StoredSubscription<T>;
+};
+export type MetricsPublishKit<T> = {
+    metricsPublisher: Publisher<T>;
+    metricsSubscriber: StoredSubscriber<T>;
+};
+import type { PriceDescription } from '@agoric/zoe/tools/types.js';
+//# sourceMappingURL=contractSupport.d.ts.map

package/src/contractSupport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contractSupport.d.ts","sourceRoot":"","sources":["contractSupport.js"],"names":[],"mappings":";;;;;;;;AA6BO,4BAFM,CAAC,kCAAD,CAAC,AAHF,QAGC,CAAC,AAFF,QAEC,CAAC,AADF,GACC,CAAC,CAGyC;AAQhD,gCAFM,CAAC,kCAAD,CAAC,AAFF,SAEC,CAAC,AADF,GACC,CAAC,CAK2C;AAQlD,yCAHI,cAAc,QACd,MAAM,EAAE,QAQlB;AAMM,kCAHI,MAAM,EAAE,GACN,OAAO,CAInB;AAQM,0CALI,MAAM,CAAC,KAAK,CAAC,aACb,MAAM,CAAC,KAAK,CAAC,UACb,MAAM,CAAC,KAAK,CAAC,QASvB;AAoBM,0CAHI,KAAK;;;EAIsC;AAG/C,mGAC4D;gCAnBlC,CAAC;wBADpB,iBAAiB,CACE,CAAC,AADD,CAAC;yBACpB,kBAAkB,CAAC,CAAC,CAAC;;8BAOJ,CAAC;sBADlB,SAAS,CACQ,CAAC,AADP,CAAC;uBACZ,gBAAgB,CAAC,CAAC,CAAC;;sCApF6D,4BAA4B"}

package/src/contractSupport.js

@@ -4,6 +4,8 @@ import { AmountMath } from '@agoric/ertp';
 import { M } from '@agoric/store';
 import { makeRatioFromAmounts } from '@agoric/zoe/src/contractSupport/index.js';
 
+/** @import {PriceAuthority, PriceDescription, PriceQuote, PriceQuoteValue, PriceQuery,} from '@agoric/zoe/tools/types.js'; */
+
 const { Fail, quote: q } = assert;
 
 export const amountPattern = harden({ brand: M.remotable(), value: M.any() });
@@ -13,17 +15,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);
@@ -77,14 +79,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,39 @@
+/**
+ * @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} */
+export const meta: ContractMeta;
+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 | undefined) => void;
+        makeCharterMemberInvitation: () => Promise<Invitation<{
+            invitationMakers: import("@endo/exo").Guarded<{
+                VoteOnParamChange: () => Promise<Invitation<import("@agoric/governance/src/types.js").ContractGovernanceVoteResult, ParamChangesOfferArgs>>;
+                VoteOnPauseOffers: (instance: any, strings: any, deadline: any) => Promise<Invitation<import("@agoric/governance/src/types.js").ContractGovernanceVoteResult, undefined>>;
+                VoteOnApiCall: (instance: Instance, methodName: string, methodArgs: string[], deadline: import("@agoric/time").TimestampValue) => Promise<Invitation<import("@agoric/governance/src/types.js").ContractGovernanceVoteResult, undefined>>;
+            }>;
+        }, undefined>>;
+    }>;
+}>;
+export type ParamChangesOfferArgs = {
+    deadline: bigint;
+    instance: Instance;
+    params: Record<string, unknown>;
+    path?: {
+        paramPath: {
+            key: string;
+        };
+    } | 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;;;;;GAKG;AAEH,iEAAkE;AAoBlE,2BAA2B;AAC3B,mBADW,YAAY,CAMrB;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;;;;;0CAxE7B,QAAQ,cACR,MAAM,cACN,MAAM,EAAE,YACR,OAAO,cAAc,EAAE,cAAc;;;;GAkFjD;;cAjKa,MAAM;cACN,QAAQ;YACR,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;;mBACV;YAAE,GAAG,EAAE,MAAM,CAAA;SAAE"}

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,10 @@ 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.
+ * @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 +25,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: { key: string } }} [path]
  */
 const ParamChangesOfferArgsShape = M.splitRecord(
   {
@@ -41,19 +38,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} */
+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 +78,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 +156,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 +166,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
   const creatorFacet = prepareExo(
     baggage,
     'Charter creatorFacet',
-    charterCreatorI,
+    CharterCreatorI,
     {
       /**
        * @param {Instance} governedInstance
@@ -184,3 +184,4 @@ export const prepare = async (zcf, privateArgs, baggage) => {
 
   return harden({ creatorFacet });
 };
+harden(start);