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

package/src/proposals/add-auction.js

@@ -1,22 +1,28 @@
 import { deeplyFulfilledObject, makeTracer } from '@agoric/internal';
 import { makeStorageNodeChild } from '@agoric/internal/src/lib-chainStorage.js';
-import { E } from '@endo/far';
 import { Stable } from '@agoric/internal/src/tokens.js';
+import { E } from '@endo/far';
 import { makeGovernedTerms as makeGovernedATerms } from '../auction/params.js';
+import { provideRetiredInstances } from './utils.js';
 
 const trace = makeTracer('NewAuction', true);
 
+/**
+ * @import {Remote} from '@agoric/internal';
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js';
+ */
+
 /**
  * @typedef {PromiseSpaceOf<{
  *   auctionUpgradeNewInstance: Instance;
  *   auctionUpgradeNewGovCreator: any;
  *   newContractGovBundleId: string;
+ *   retiredContractInstances: MapStore<string, Instance>;
  * }>} interlockPowers
  */
 
 /**
- * @param {import('./econ-behaviors.js').EconomyBootstrapPowers &
- *   interlockPowers} powers
+ * @param {EconomyBootstrapPowers & interlockPowers} powers
  * @param {{
  *   options: {
  *     contractGovernorRef: { bundleID: string };
@@ -35,6 +41,7 @@ export const addAuction = async (
       economicCommitteeCreatorFacet: electorateCreatorFacet,
       governedContractKits: governedContractKitsP,
       priceAuthority8400,
+      retiredContractInstances: retiredContractInstancesP,
       zoe,
     },
     produce: {
@@ -42,6 +49,7 @@ export const addAuction = async (
       auctionUpgradeNewInstance,
       auctionUpgradeNewGovCreator,
       newContractGovBundleId,
+      retiredContractInstances: produceRetiredInstances,
     },
     instance: {
       consume: { reserve: reserveInstance },
@@ -79,6 +87,30 @@ export const addAuction = async (
     auctioneerInstallationP,
   ]);
 
+  const retiredInstances = await provideRetiredInstances(
+    retiredContractInstancesP,
+    produceRetiredInstances,
+  );
+
+  const governedContractKits = await governedContractKitsP;
+  trace('has', governedContractKits.has(legacyKit.instance));
+  if (governedContractKits.has(legacyKit.instance)) {
+    // bootstrap tests start having already run this upgrade. Actual upgrades on
+    // mainNet or testnets should start with the promiseSpace post upgrade-17,
+    // which doesn't have this entry in the map.
+    trace(
+      '⚠️ WARNING: not expected during chain upgrade.  It IS normal during bootstrap tests',
+    );
+  } else {
+    // @ts-expect-error The original auctioneerKit had everything it needs
+    governedContractKits.init(legacyKit.instance, legacyKit);
+  }
+
+  // save the auctioneer instance so we can manage it later
+  const boardID = await E(board).getId(legacyKit.instance);
+  const identifier = `auctioneer-${boardID}`;
+  retiredInstances.init(identifier, legacyKit.instance);
+
   // Each field has an extra layer of type +  value:
   // AuctionStartDelay: { type: 'relativeTime', value: { relValue: 2n, timerBrand: Object [Alleged: timerBrand] {} } }
   /** @type {any} */
@@ -95,6 +127,7 @@ export const addAuction = async (
   const timerBrand = await E(chainTimerService).getTimerBrand();
 
   const storageNode = await makeStorageNodeChild(chainStorage, STORAGE_PATH);
+  /** @type {Remote<Marshaller>} */
   const marshaller = await E(board).getReadonlyMarshaller();
 
   const reservePublicFacet = await E(zoe).getPublicFacet(reserveInstance);
@@ -191,7 +224,6 @@ export const addAuction = async (
     governedInstance,
   );
 
-  const governedContractKits = await governedContractKitsP;
   governedContractKits.init(kit.instance, kit);
   auctionUpgradeNewInstance.resolve(governedInstance);
   auctionUpgradeNewGovCreator.resolve(kit.governorCreatorFacet);
@@ -210,6 +242,7 @@ export const ADD_AUCTION_MANIFEST = harden({
       economicCommitteeCreatorFacet: true,
       governedContractKits: true,
       priceAuthority8400: true,
+      retiredContractInstances: true,
       zoe: true,
     },
     produce: {
@@ -217,6 +250,7 @@ export const ADD_AUCTION_MANIFEST = harden({
       auctionUpgradeNewInstance: true,
       auctionUpgradeNewGovCreator: true,
       newContractGovBundleId: true,
+      retiredContractInstances: true,
     },
     instance: {
       consume: { reserve: true },

package/src/proposals/addAssetToVault.js

@@ -7,7 +7,7 @@ import { Far } from '@endo/marshal';
 import { AmountMath, AssetKind } from '@agoric/ertp';
 import { deeplyFulfilledObject } from '@agoric/internal';
 import { makeRatio } from '@agoric/zoe/src/contractSupport/index.js';
-import { parseRatio } from '@agoric/zoe/src/contractSupport/ratio.js';
+import { parseRatio } from '@agoric/ertp/src/ratio.js';
 import { E } from '@endo/far';
 import { Stable } from '@agoric/internal/src/tokens.js';
 import { TimeMath } from '@agoric/time/src/timeMath.js';
@@ -34,7 +34,11 @@ export * from './startPSM.js';
  * @property {number} [initialPrice]
  */
 
-/** @import {EconomyBootstrapPowers} from './econ-behaviors.js' */
+/**
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js'
+ * @import {FullSchedule} from '../auction/scheduler.js';
+ * @import {TimerService} from '@agoric/time';
+ */
 
 /**
  * @param {BootstrapPowers} powers
@@ -269,8 +273,8 @@ const COMPLETION = 20n * 60n;
  * defined, 3) run now. If there is only a nextSchedule, 4) run now if startTime
  * is far enough away, else 5) run after endTime
  *
- * @param {import('../auction/scheduler.js').FullSchedule} schedules
- * @param {ERef<import('@agoric/time').TimerService>} timer
+ * @param {FullSchedule} schedules
+ * @param {ERef<TimerService>} timer
  * @param {() => void} thunk
  */
 const whenQuiescent = async (schedules, timer, thunk) => {

package/src/proposals/committee-proposal.js

@@ -2,6 +2,11 @@ import { deeplyFulfilledObject } from '@agoric/internal';
 import { E } from '@endo/far';
 import { reserveThenDeposit } from './utils.js';
 
+/**
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js';
+ * @import {EconCharterStartResult} from './econ-behaviors.js';
+ */
+
 const { values } = Object;
 
 /** @type {<X, Y>(xs: X[], ys: Y[]) => [X, Y][]} */
@@ -10,7 +15,7 @@ const zip = (xs, ys) => xs.map((x, i) => [x, ys[i]]);
 const EC_HIGH_PRIORITY_SENDERS_NAMESPACE = 'economicCommittee';
 
 /**
- * @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  * @param {{ options: { voterAddresses: Record<string, string> } }} param1
  */
 export const inviteCommitteeMembers = async (
@@ -51,7 +56,7 @@ export const inviteCommitteeMembers = async (
 
 harden(inviteCommitteeMembers);
 
-/** @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers */
+/** @param {EconomyBootstrapPowers} powers */
 export const startEconCharter = async ({
   consume: { zoe },
   produce: { econCharterKit },
@@ -72,7 +77,7 @@ export const startEconCharter = async ({
     }),
   );
 
-  /** @type {Promise<import('./econ-behaviors.js').EconCharterStartResult>} */
+  /** @type {Promise<EconCharterStartResult>} */
   const startResult = E(zoe).startInstance(
     charterInstall,
     undefined,
@@ -88,7 +93,7 @@ harden(startEconCharter);
 /**
  * Introduce charter to governed creator facets.
  *
- * @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  */
 export const addGovernorsToEconCharter = async ({
   consume: { reserveKit, vaultFactoryKit, econCharterKit, auctioneerKit },
@@ -126,7 +131,7 @@ export const addGovernorsToEconCharter = async ({
 harden(addGovernorsToEconCharter);
 
 /**
- * @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  * @param {{ options: { voterAddresses: Record<string, string> } }} param1
  */
 export const inviteToEconCharter = async (

package/src/proposals/core-proposal.js

@@ -4,6 +4,12 @@ import { Stable } from '@agoric/internal/src/tokens.js';
 import * as econBehaviors from './econ-behaviors.js';
 import { ECON_COMMITTEE_MANIFEST } from './startEconCommittee.js';
 
+/**
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js';
+ * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js';
+ * @import {BootstrapManifestPermit} from '@agoric/vats/src/core/lib-boot.js';
+ */
+
 export * from './econ-behaviors.js';
 export * from './startPSM.js';
 export * from './startEconCommittee.js';
@@ -13,7 +19,7 @@ export * from './startEconCommittee.js';
 // require updating a lot of tests. So for now, we just
 // grab the kits afterward and store them.
 
-/** @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers */
+/** @param {EconomyBootstrapPowers} powers */
 export const storeInterContractStartKits = async ({
   consume: {
     contractKits,
@@ -50,9 +56,9 @@ export const storeInterContractStartKits = async ({
   ]);
 };
 
-/** @type {import('@agoric/vats/src/core/lib-boot.js').BootstrapManifest} */
+/** @type {BootstrapManifest} */
 const SHARED_MAIN_MANIFEST = harden({
-  /** @type {import('@agoric/vats/src/core/lib-boot.js').BootstrapManifestPermit} */
+  /** @type {BootstrapManifestPermit} */
   [econBehaviors.startVaultFactory.name]: {
     consume: {
       board: 'board',

package/src/proposals/deploy-price-feeds.js

@@ -5,6 +5,7 @@ import { E } from '@endo/far';
 import { unitAmount } from '@agoric/zoe/src/contractSupport/priceQuote.js';
 import {
   oracleBrandFeedName,
+  provideRetiredInstances,
   reserveThenDeposit,
   sanitizePathSegment,
 } from './utils.js';
@@ -22,8 +23,11 @@ export const DEFAULT_CONTRACT_TERMS = {
   maxSubmissionValue: 2 ** 256,
 };
 
-/** @import {EconomyBootstrapPowers} from './econ-behaviors.js'; */
-/** @import {ChainlinkConfig} from '@agoric/inter-protocol/src/price/fluxAggregatorKit.js'; */
+/**
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js';
+ * @import {ChainlinkConfig} from '@agoric/inter-protocol/src/price/fluxAggregatorKit.js';
+ * @import {StartedInstanceKit} from '@agoric/zoe/src/zoeService/utils.js';
+ */
 /** @import {FluxStartFn} from '@agoric/inter-protocol/src/price/fluxAggregatorContract.js'; */
 
 const trace = makeTracer('DeployPriceFeed', true);
@@ -84,10 +88,11 @@ export const ensureOracleBrand = async (
 };
 
 /**
- * @param {EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance> }>} powers
  * @param {{
  *   AGORIC_INSTANCE_NAME: string;
- *   contractTerms: import('@agoric/inter-protocol/src/price/fluxAggregatorKit.js').ChainlinkConfig;
+ *   contractTerms: ChainlinkConfig;
  *   brandIn: Brand<'nat'>;
  *   brandOut: Brand<'nat'>;
  * }} config
@@ -96,6 +101,7 @@ export const ensureOracleBrand = async (
 const startPriceAggregatorInstance = async (
   {
     consume: {
+      agoricNames,
       board,
       chainStorage,
       chainTimerService,
@@ -103,8 +109,10 @@ const startPriceAggregatorInstance = async (
       highPrioritySendersManager,
       namesByAddressAdmin,
       startGovernedUpgradable,
+      retiredContractInstances: retiredContractInstancesP,
     },
     instance: { produce: produceInstance },
+    produce: { retiredContractInstances: produceRetiredInstances },
   },
   { AGORIC_INSTANCE_NAME, contractTerms, brandIn, brandOut },
   installation,
@@ -139,6 +147,22 @@ const startPriceAggregatorInstance = async (
     // @ts-expect-error GovernableStartFn vs. fluxAggregatorContract.js start
     installation,
   });
+  const retiredContractInstances = await provideRetiredInstances(
+    retiredContractInstancesP,
+    produceRetiredInstances,
+  );
+
+  // save the instance so we can manage it later
+  const retiringInstance = await E(agoricNames).lookup(
+    'instance',
+    AGORIC_INSTANCE_NAME,
+  );
+  const boardID = await E(board).getId(retiringInstance);
+  retiredContractInstances.init(
+    `priceFeed-${AGORIC_INSTANCE_NAME}-${boardID}`,
+    retiringInstance,
+  );
+
   produceInstance[AGORIC_INSTANCE_NAME].reset();
   produceInstance[AGORIC_INSTANCE_NAME].resolve(governedKit.instance);
   trace(
@@ -155,7 +179,7 @@ const startPriceAggregatorInstance = async (
   );
   trace('added', label, 'instance to econCharter');
 
-  /** @type {import('@agoric/zoe/src/zoeService/utils.js').StartedInstanceKit<FluxStartFn>} */
+  /** @type {StartedInstanceKit<FluxStartFn>} */
   // @ts-expect-error
   const { instance, publicFacet, creatorFacet } = governedKit;
 
@@ -191,7 +215,9 @@ const distributeInvitations = async (
 };
 
 /**
- * @param {EconomyBootstrapPowers & NamedVatPowers} powers
+ * @param {EconomyBootstrapPowers &
+ *   NamedVatPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance> }>} powers
  * @param {{
  *   options: PriceFeedConfig & {
  *     priceAggregatorRef: { bundleID: string };
@@ -300,6 +326,7 @@ export const getManifestForPriceFeeds = async (
         namesByAddressAdmin: t,
         priceAuthority: t,
         priceAuthorityAdmin: t,
+        retiredContractInstances: t,
         startGovernedUpgradable: t,
         startUpgradable: t,
         zoe: t,
@@ -307,9 +334,10 @@ export const getManifestForPriceFeeds = async (
       installation: { produce: { priceAggregator: t } },
       instance: {
         produce: t,
+        consume: t,
       },
       oracleBrand: { produce: t },
-      produce: { priceAuthority8400: t },
+      produce: { priceAuthority8400: t, retiredContractInstances: t },
     },
   },
   options: { ...priceFeedOptions },

package/src/proposals/econ-behaviors.js

@@ -10,7 +10,20 @@ import { makeGovernedTerms as makeGovernedATerms } from '../auction/params.js';
 import { makeReserveTerms } from '../reserve/params.js';
 import { makeGovernedTerms as makeGovernedVFTerms } from '../vaultFactory/params.js';
 
-/** @import {StartedInstanceKit} from '@agoric/zoe/src/zoeService/utils.js' */
+/**
+ * @import {GovernorCreatorFacet, GovernanceFacetKit, GovernorStartedInstallationKit} from '@agoric/governance/src/types.js';
+ * @import {StartedInstanceKit} from '@agoric/zoe/src/zoeService/utils.js';
+ * @import {AdminFacet} from '@agoric/zoe';
+ * @import {MapStore, SetStore} from '@agoric/store';
+ */
+
+// Duplicated from vaultFactory/types-ambient.js to solve a CI problem.
+// Not worth refactoring to DRY because vaultFactory is going away.
+/**
+ * @typedef {object} InterestTiming
+ * @property {import('@agoric/time').RelativeTime} chargingPeriod in seconds
+ * @property {import('@agoric/time').RelativeTime} recordingPeriod in seconds
+ */
 
 const trace = makeTracer('RunEconBehaviors', true);
 
@@ -25,20 +38,28 @@ export const SECONDS_PER_WEEK = 7n * SECONDS_PER_DAY;
 /**
  * @typedef {object} PSMKit
  * @property {string} label
- * @property {Instance} psm
- * @property {Instance} psmGovernor
+ * @property {Instance<typeof import('../psm/psm.js').start>} psm
+ * @property {Instance<
+ *   typeof import('../../../governance/src/contractGovernor.js').start
+ * >} psmGovernor
  * @property {Awaited<
  *   ReturnType<
  *     Awaited<
- *       ReturnType<import('../psm/psm.js')['start']>
+ *       ReturnType<typeof import('../psm/psm.js').start>
  *     >['creatorFacet']['getLimitedCreatorFacet']
  *   >
  * >} psmCreatorFacet
- * @property {GovernorCreatorFacet<import('../../src/psm/psm.js')['start']>} psmGovernorCreatorFacet
+ * @property {GovernorCreatorFacet<
+ *   typeof import('../../src/psm/psm.js').start
+ * >} psmGovernorCreatorFacet
  * @property {AdminFacet} psmAdminFacet
  */
 
-/** @typedef {GovernanceFacetKit<import('../auction/auctioneer.js').start>} AuctioneerKit */
+/**
+ * @typedef {GovernanceFacetKit<
+ *   typeof import('../auction/auctioneer.js').start
+ * >} AuctioneerKit
+ */
 
 /**
  * @typedef {WellKnownSpaces & ChainBootstrapSpace & EconomyBootstrapSpace} EconomyBootstrapPowers
@@ -58,7 +79,7 @@ export const SECONDS_PER_WEEK = 7n * SECONDS_PER_DAY;
  *   anchorBalancePayments: MapStore<Brand, Payment<'nat'>>;
  *   econCharterKit: EconCharterStartResult;
  *   reserveKit: GovernanceFacetKit<
- *     import('../reserve/assetReserve.js')['start']
+ *     typeof import('../reserve/assetReserve.js').start
  *   >;
  *   vaultFactoryKit: GovernanceFacetKit<VFStart>;
  *   auctioneerKit: AuctioneerKit;
@@ -69,12 +90,12 @@ export const SECONDS_PER_WEEK = 7n * SECONDS_PER_DAY;
 
 /**
  * @typedef {StartedInstanceKit<
- *   import('../econCommitteeCharter.js')['start']
+ *   typeof import('../econCommitteeCharter.js').start
  * >} EconCharterStartResult
  */
 /**
  * @typedef {StartedInstanceKit<
- *   import('@agoric/governance/src/committee.js')['start']
+ *   typeof import('@agoric/governance/src/committee.js').start
  * >} CommitteeStartResult
  */
 
@@ -157,9 +178,10 @@ export const setupReserve = async ({
     'reserve.governor',
   );
 
-  const [creatorFacet, publicFacet, instance] = await Promise.all([
+  const [creatorFacet, publicFacet, adminFacet, instance] = await Promise.all([
     E(g.creatorFacet).getCreatorFacet(),
     E(g.creatorFacet).getPublicFacet(),
+    E(g.creatorFacet).getAdminFacet(),
     E(g.publicFacet).getGovernedContract(),
   ]);
 
@@ -169,7 +191,7 @@ export const setupReserve = async ({
       instance,
       publicFacet,
       creatorFacet,
-      adminFacet: g.adminFacet,
+      adminFacet,
 
       governor: g.instance,
       governorCreatorFacet: g.creatorFacet,
@@ -463,7 +485,6 @@ export const startRewardDistributor = async ({
   const instanceKit = await E(zoe).startInstance(
     feeDistributor,
     { Fee: centralIssuer },
-    // @ts-expect-error XXX
     feeDistributorTerms,
     undefined,
     'feeDistributor',

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

@@ -13,6 +13,11 @@ import {
   reserveThenGetNames,
 } from './utils.js';
 
+/**
+ * @import {ChainlinkConfig} from '@agoric/inter-protocol/src/price/fluxAggregatorKit.js';
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js';
+ */
+
 // backwards compatibility
 export { oracleBrandFeedName as instanceNameFor };
 
@@ -88,7 +93,7 @@ export const ensureOracleBrands = async (
  *     priceFeedOptions: {
  *       AGORIC_INSTANCE_NAME: string;
  *       oracleAddresses: string[];
- *       contractTerms: import('@agoric/inter-protocol/src/price/fluxAggregatorKit.js').ChainlinkConfig;
+ *       contractTerms: ChainlinkConfig;
  *       IN_BRAND_NAME: string;
  *       OUT_BRAND_NAME: string;
  *       priceAggregatorRef: Installation;
@@ -167,7 +172,9 @@ export const createPriceFeed = async (
   /**
    * @type {[
    *   [Brand<'nat'>, Brand<'nat'>],
-   *   Installation<import('@agoric/inter-protocol/src/price/fluxAggregatorContract.js')['start]>,
+   *   Installation<
+   *     typeof import('@agoric/inter-protocol/src/price/fluxAggregatorContract.js').start
+   *   >,
    *   Timer,
    * ]}
    */
@@ -316,7 +323,7 @@ export const getManifestForPriceFeed = async (
 });
 
 /**
- * @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  * @param {object} [config]
  * @param {object} [config.options]
  * @param {string[]} [config.options.demoOracleAddresses]

package/src/proposals/replace-fee-distributor.js

@@ -3,12 +3,17 @@ import { Stable } from '@agoric/internal/src/tokens.js';
 import { makeScalarBigMapStore } from '@agoric/vat-data';
 import { getInterfaceOf, E } from '@endo/far';
 
+/**
+ * @import {EconomyBootstrapPowers} from './econ-behaviors';
+ * @import {start} from '@agoric/inter-protocol/src/feeDistributor.js';
+ */
+
 const trace = makeTracer('ReplaceFeeDistributer', true);
 
 /**
  * Start the reward distributor.
  *
- * @param {import('./econ-behaviors').EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  * @param {{
  *   options: {
  *     keywordShares: Record<string, bigint>;
@@ -76,9 +81,7 @@ export const replaceFeeDistributor = async (
     });
 
   /**
-   * @type {StartedInstanceKit<
-   *   typeof import('@agoric/inter-protocol/src/feeDistributor.js').start
-   * >}
+   * @type {StartedInstanceKit<typeof start>}
    */
   const instanceKit = await E(zoe).startInstance(
     feeDistributor,
@@ -159,8 +162,8 @@ harden(replaceFeeDistributor);
 
 const t = 'replaceFeeDistributor';
 export const getManifestForReplaceFeeDistributor = async (
-  _,
-  feeDistributorOptions,
+  { restoreRef },
+  { feeDistributorRef, ...feeDistributorOptions },
 ) => ({
   manifest: {
     [replaceFeeDistributor.name]: {
@@ -191,5 +194,8 @@ export const getManifestForReplaceFeeDistributor = async (
       },
     },
   },
+  installations: {
+    feeDistributor: restoreRef(feeDistributorRef),
+  },
   options: { ...feeDistributorOptions },
 });