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

package/src/proposals/replaceElectorate.js

@@ -15,7 +15,7 @@ import {
   assertPathSegment,
   makeStorageNodeChild,
 } from '@agoric/internal/src/lib-chainStorage.js';
-import { reserveThenDeposit } from './utils.js';
+import { provideRetiredInstances, reserveThenDeposit } from './utils.js';
 
 /** @import {EconomyBootstrapPowers} from './econ-behaviors.js' */
 /** @import {EconCharterStartResult} from './econ-behaviors.js' */
@@ -181,8 +181,10 @@ const inviteToEconCharter = async (
  * Starts a new Economic Committee (EC) by creating an instance with the
  * provided committee specifications.
  *
- * @param {EconomyBootstrapPowers} powers - The resources and capabilities
- *   required to start the committee.
+ * @param {EconomyBootstrapPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance> }>} powers
+ *   - The resources and capabilities required to start the committee.
+ *
  * @param {{
  *   options: {
  *     committeeName: string;
@@ -196,12 +198,22 @@ const inviteToEconCharter = async (
  */
 const startNewEconomicCommittee = async (
   {
-    consume: { board, chainStorage, startUpgradable },
-    produce: { economicCommitteeKit, economicCommitteeCreatorFacet },
+    consume: {
+      board,
+      chainStorage,
+      startUpgradable,
+      retiredContractInstances: retiredInstancesP,
+    },
+    produce: {
+      economicCommitteeKit,
+      economicCommitteeCreatorFacet,
+      retiredContractInstances: produceRetiredInstances,
+    },
     installation: {
       consume: { committee },
     },
     instance: {
+      consume: { economicCommittee: economicCommitteeOriginalP },
       produce: { economicCommittee },
     },
   },
@@ -214,6 +226,19 @@ const startNewEconomicCommittee = async (
   trace(`committeeName ${committeeName}`);
   trace(`committeeSize ${committeeSize}`);
 
+  const retiredInstances = await provideRetiredInstances(
+    retiredInstancesP,
+    produceRetiredInstances,
+  );
+
+  // Record the retired electorate instance so we can manage it later.
+  const economicCommitteeOriginal = await economicCommitteeOriginalP;
+  const boardID = await E(board).getId(economicCommitteeOriginal);
+  retiredInstances.init(
+    `economicCommittee-${boardID}`,
+    economicCommitteeOriginal,
+  );
+
   const committeesNode = await makeStorageNodeChild(
     chainStorage,
     COMMITTEES_ROOT,
@@ -264,33 +289,87 @@ const startNewEconomicCommittee = async (
  * Starts a new Economic Committee Charter by creating an instance with the
  * provided committee specifications.
  *
- * @param {EconomyBootstrapPowers} powers - The resources and capabilities
- *   required to start the committee.
+ * @param {EconomyBootstrapPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance> }>} powers
+ *   - The resources and capabilities required to start the committee.
+ *
  * @returns {Promise<EconCharterStartResult>} A promise that resolves to the
  *   charter kit result.
  */
 const startNewEconCharter = async ({
-  consume: { startUpgradable },
-  produce: { econCharterKit },
+  consume: {
+    board,
+    startUpgradable,
+    contractKits: contractKitsP,
+    econCharterKit: econCharterKitP,
+    retiredContractInstances: retiredContractInstancesP,
+  },
+  produce: {
+    econCharterKit: produceEconCharterKit,
+    retiredContractInstances: produceRetiredInstances,
+  },
   installation: {
     consume: { binaryVoteCounter: counterP, econCommitteeCharter: installP },
   },
   instance: {
     produce: { econCommitteeCharter },
+    consume: { econCommitteeCharter: previousInstanceP },
   },
 }) => {
-  const [charterInstall, counterInstall] = await Promise.all([
+  const [
+    charterInstall,
+    counterInstall,
+    previousInstance,
+    contractKits,
+    econCharterKit,
+    retiredInstances,
+  ] = await Promise.all([
     installP,
     counterP,
+    previousInstanceP,
+    contractKitsP,
+    econCharterKitP,
+    provideRetiredInstances(retiredContractInstancesP, produceRetiredInstances),
   ]);
-  const terms = await harden({
-    binaryVoteCounterInstallation: counterInstall,
-  });
+
+  const label = 'econCommitteeCharter';
+  const previousCharterKit = { ...econCharterKit, label };
+
+  const boardID = await E(board).getId(previousCharterKit.instance);
+  const identifier = `${label}-${boardID}`;
+  trace('Saving previous EC Charter Instance', label);
+
+  // save the old charter instance kit so we can manage it later
+  if (retiredInstances.has(identifier)) {
+    // 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: collision on storing Charter in retireInstances not' +
+        ' expected during chain upgrade.   It IS normal during bootstrap tests',
+    );
+  } else {
+    retiredInstances.init(identifier, previousCharterKit.instance);
+  }
+  if (contractKits.has(previousInstance)) {
+    // 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: collision on storing Charter in contractKits not' +
+        ' expected during chain upgrade.   It IS normal during bootstrap tests',
+    );
+  } else {
+    contractKits.init(previousInstance, previousCharterKit);
+  }
 
   trace('Starting new EC Charter Instance');
 
+  const terms = harden({
+    binaryVoteCounterInstallation: counterInstall,
+  });
   const startResult = await E(startUpgradable)({
-    label: 'econCommitteeCharter',
+    label,
     installation: charterInstall,
     terms,
   });
@@ -300,8 +379,8 @@ const startNewEconCharter = async ({
   econCommitteeCharter.reset();
   econCommitteeCharter.resolve(E.get(startResult).instance);
 
-  econCharterKit.reset();
-  econCharterKit.resolve(startResult);
+  produceEconCharterKit.reset();
+  produceEconCharterKit.resolve(startResult);
   return startResult;
 };
 
@@ -309,6 +388,7 @@ const startNewEconCharter = async ({
  * @typedef {PromiseSpaceOf<{
  *   auctionUpgradeNewInstance: Instance;
  *   auctionUpgradeNewGovCreator: any;
+ *   retiredContractInstances: MapStore<string, Instance>;
  * }>} interlockPowers
  */
 
@@ -485,13 +565,17 @@ export const getManifestForReplaceAllElectorates = async (
   manifest: {
     [replaceAllElectorates.name]: {
       consume: {
+        agoricNames: true,
         auctionUpgradeNewGovCreator: true,
         auctionUpgradeNewInstance: true,
         psmKit: true,
+        contractKits: true,
+        econCharterKit: true,
         governedContractKits: true,
         chainStorage: true,
         highPrioritySendersManager: true,
         namesByAddressAdmin: true,
+        retiredContractInstances: true,
         // Rest of these are designed to be widely shared
         board: true,
         startUpgradable: true,
@@ -501,6 +585,7 @@ export const getManifestForReplaceAllElectorates = async (
         economicCommitteeKit: true,
         economicCommitteeCreatorFacet: true,
         auctionUpgradeNewGovCreator: true,
+        retiredContractInstances: true,
       },
       installation: {
         consume: {
@@ -514,6 +599,10 @@ export const getManifestForReplaceAllElectorates = async (
           economicCommittee: true,
           econCommitteeCharter: true,
         },
+        consume: {
+          economicCommittee: true,
+          econCommitteeCharter: true,
+        },
       },
     },
   },

package/src/proposals/startEconCommittee.js

@@ -5,6 +5,10 @@ import {
 } from '@agoric/internal/src/lib-chainStorage.js';
 import { E } from '@endo/far';
 
+/**
+ * @import {EconomyBootstrapPowers} from './econ-behaviors.js';
+ */
+
 const trace = makeTracer('RunEconCommittee', true);
 
 /** @type {(name: string) => string} */
@@ -21,7 +25,7 @@ const sanitizePathSegment = name => {
  */
 
 /**
- * @param {import('./econ-behaviors.js').EconomyBootstrapPowers} powers
+ * @param {EconomyBootstrapPowers} powers
  * @param {object} config
  * @param {object} [config.options]
  * @param {EconCommitteeOptions} [config.options.econCommitteeOptions]

package/src/proposals/startPSM.js

@@ -11,7 +11,7 @@ import {
   makeHistoryReviver,
   makeBoardRemote,
   slotToBoardRemote,
-} from '@agoric/internal/src/marshal.js';
+} from '@agoric/internal/src/marshal/board-client-utils.js';
 import { deeplyFulfilledObject } from '@agoric/internal';
 import { makeScalarBigMapStore } from '@agoric/vat-data';
 import { Stable } from '@agoric/internal/src/tokens.js';
@@ -24,7 +24,10 @@ import {
   inviteToEconCharter,
 } from './committee-proposal.js';
 
-/** @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js' */
+/**
+ * @import {BootstrapManifest} from '@agoric/vats/src/core/lib-boot.js'
+ * @import {PSMKit} from './econ-behaviors.js';
+ */
 /** @import {MetricsNotification} from '../psm/psm.js' */
 /** @import {EconomyBootstrapPowers} from './econ-behaviors.js' */
 
@@ -249,7 +252,7 @@ export const startPSM = async (
   };
   await (oldState.metrics && restoreMetrics(oldState.metrics));
 
-  /** @type {import('./econ-behaviors.js').PSMKit} */
+  /** @type {PSMKit} */
   const newpsmKit = harden({
     label: instanceKey,
     psm,
@@ -262,7 +265,7 @@ export const startPSM = async (
   // Provide pattern with a promise.
   producepsmKit.resolve(makeScalarBigMapStore('PSM Kits', { durable: true }));
 
-  /** @type {MapStore<Brand, import('./econ-behaviors.js').PSMKit>} */
+  /** @type {MapStore<Brand, PSMKit>} */
   const psmKitMap = await psmKit;
 
   // TODO init into governedContractKits too to simplify testing

package/src/proposals/upgrade-vaults.js

@@ -1,9 +1,21 @@
+/**
+ * @file this core-eval proposal is specific to the upgrade-18 scenario,
+ *   handling tasks beyond generic Vault Factory null upgrade. For a reusable
+ *   proposal, see upgrade-vaultFactory-proposal.js.
+ */
+
 import { E } from '@endo/far';
 import { makeNotifierFromAsyncIterable } from '@agoric/notifier';
 import { makeTracer } from '@agoric/internal/src/index.js';
 import { Fail } from '@endo/errors';
 import { TimeMath } from '@agoric/time';
 
+/**
+ * @import {EconomyBootstrapPowers} from '../../src/proposals/econ-behaviors';
+ * @import {start} from '../auction/auctioneer.js';
+ * @import {VaultFactoryContract} from '../../src/vaultFactory/vaultFactory';
+ */
+
 const trace = makeTracer('upgrade Vaults proposal');
 
 /**
@@ -15,8 +27,7 @@ const trace = makeTracer('upgrade Vaults proposal');
  */
 
 /**
- * @param {import('../../src/proposals/econ-behaviors').EconomyBootstrapPowers &
- *     interlockPowers} powers
+ * @param {EconomyBootstrapPowers & interlockPowers} powers
  * @param {{
  *   options: {
  *     VaultFactoryBundle: { bundleID: string };
@@ -49,10 +60,10 @@ export const upgradeVaults = async (
 
   await priceAuthority8400;
 
+  /** @type {Instance<typeof start>} */
   const auctionNewInstance = await auctionUpgradeNewInstance;
   auctionUpgradeNewInstanceProducer.reset();
   const publicFacet = E(zoe).getPublicFacet(auctionNewInstance);
-  /** @type {import('@agoric/inter-protocol/src/auction/scheduler.js').FullSchedule} */
   const schedules = await E(publicFacet).getSchedules();
   const now = await E(chainTimerService).getCurrentTimestamp();
   (schedules.nextAuctionSchedule &&
@@ -91,7 +102,6 @@ export const upgradeVaults = async (
     for (const kwd of Object.keys(vaultBrands)) {
       const collateralBrand = vaultBrands[kwd];
 
-      /** @type {any} */
       const governedParams = await E(directorPF).getGovernedParams({
         collateralBrand,
       });
@@ -124,7 +134,7 @@ export const upgradeVaults = async (
       electorateCreatorFacet,
     ).getPoserInvitation();
 
-    /** @type {import('../../src/vaultFactory/vaultFactory').VaultFactoryContract['privateArgs']} */
+    /** @type {VaultFactoryContract['privateArgs']} */
     const newPrivateArgs = harden({
       ...privateArgs,
       auctioneerInstance: auctionNewInstance,

package/src/proposals/utils.d.ts

@@ -1,8 +1,8 @@
-export function reserveThenGetNamePaths(nameAdmin: ERef<import("@agoric/vats").NameAdmin>, paths: string[][]): Promise<any[]>;
-export function reserveThenGetNames(nameAdmin: ERef<import("@agoric/vats").NameAdmin>, names: string[]): Promise<any[]>;
-export function reserveThenDeposit(debugName: string, namesByAddressAdmin: ERef<import("@agoric/vats").NameAdmin>, addr: string, payments: ERef<Payment>[]): Promise<void>;
+export function reserveThenGetNamePaths(nameAdmin: ERef<NameAdmin>, paths: string[][]): Promise<any[]>;
+export function reserveThenGetNames(nameAdmin: ERef<NameAdmin>, names: string[]): Promise<any[]>;
+export function reserveThenDeposit(debugName: string, namesByAddressAdmin: ERef<NameAdmin>, addr: string, payments: ERef<Payment>[]): Promise<void>;
 export function makeInstallCache(homeP: Promise<{
-    scratch: ERef<import("@agoric/internal/src/scratch.js").ScratchPad>;
+    scratch: ERef<ScratchPad>;
 }>, { installCacheKey, loadBundle }: {
     loadBundle: (specifier: string) => Promise<{
         default: Bundle;
@@ -16,4 +16,8 @@ export function oracleBrandFeedName(inBrandName: any, outBrandName: any): string
 export function scaledPriceFeedName(issuerName: any): string;
 /** @type {(name: string) => string} */
 export const sanitizePathSegment: (name: string) => string;
+export function provideRetiredInstances(consume: Promise<MapStore>, produce: Producer<MapStore>): Promise<MapStore>;
+import type { NameAdmin } from '@agoric/vats';
+import type { ScratchPad } from '@agoric/internal/src/scratch.js';
+import type { MapStore } from '@agoric/store';
 //# sourceMappingURL=utils.d.ts.map

package/src/proposals/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAYO,mDAHI,IAAI,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,SACtC,MAAM,EAAE,EAAE,kBA+BpB;AAMM,+CAHI,IAAI,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,SACtC,MAAM,EAAE,kBAMhB;AAQI,8CALI,MAAM,uBACN,IAAI,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,QACtC,MAAM,YACN,IAAI,CAAC,OAAO,CAAC,EAAE,iBAuBzB;AA6BM,wCAPI,OAAO,CAAC;IACd,OAAO,EAAE,IAAI,CAAC,OAAO,iCAAiC,EAAE,UAAU,CAAC,CAAC;CACrE,CAAC,mCAEF;IAAkE,UAAU,EAApE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,eAAe;CAAC;;;GAoDxC;AAEM,iFACsC;AAEtC,6DAC+B;AAEtC,uCAAuC;AACvC,kCADW,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAKjC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAkBO,mDAHI,IAAI,CAAC,SAAS,CAAC,SACf,MAAM,EAAE,EAAE,kBA+BpB;AAMM,+CAHI,IAAI,CAAC,SAAS,CAAC,SACf,MAAM,EAAE,kBAMhB;AAQI,8CALI,MAAM,uBACN,IAAI,CAAC,SAAS,CAAC,QACf,MAAM,YACN,IAAI,CAAC,OAAO,CAAC,EAAE,iBAuBzB;AA2BM,wCAPI,OAAO,CAAC;IACd,OAAO,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;CAC3B,CAAC,mCAEF;IAAkE,UAAU,EAApE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IACrC,eAAe;CAAC;oCAkCD,UAAK,EAAE,UAAK,EAAE,SAAI;;GAkBzD;AAEM,iFACsC;AAEtC,6DAC+B;AAEtC,uCAAuC;AACvC,kCADW,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,CAKjC;AAUK,iDAJI,OAAO,CAAC,QAAQ,CAAC,WACjB,QAAQ,CAAC,QAAQ,CAAC,GAChB,OAAO,CAAC,QAAQ,CAAC,CAW7B;+BAzL2B,cAAc;gCACb,iCAAiC;8BAFzB,eAAe"}

package/src/proposals/utils.js

@@ -3,16 +3,22 @@ import { E } from '@endo/far';
 import { WalletName } from '@agoric/internal';
 import { getCopyMapEntries, makeCopyMap } from '@agoric/store';
 import { assertPathSegment } from '@agoric/internal/src/lib-chainStorage.js';
+import { makeScalarBigMapStore } from '@agoric/vat-data';
 
-/** @import {CopyMap} from '@endo/patterns'; */
+/**
+ * @import {CopyMap} from '@endo/patterns';
+ * @import {MapStore, SetStore} from '@agoric/store';
+ * @import {NameAdmin} from '@agoric/vats';
+ * @import {ScratchPad} from '@agoric/internal/src/scratch.js';
+ */
 
 /**
- * @param {ERef<import('@agoric/vats').NameAdmin>} nameAdmin
+ * @param {ERef<NameAdmin>} nameAdmin
  * @param {string[][]} paths
  */
 export const reserveThenGetNamePaths = async (nameAdmin, paths) => {
   /**
-   * @param {ERef<import('@agoric/vats').NameAdmin>} nextAdmin
+   * @param {ERef<NameAdmin>} nextAdmin
    * @param {string[]} path
    */
   const nextPath = async (nextAdmin, path) => {
@@ -42,7 +48,7 @@ export const reserveThenGetNamePaths = async (nameAdmin, paths) => {
 };
 
 /**
- * @param {ERef<import('@agoric/vats').NameAdmin>} nameAdmin
+ * @param {ERef<NameAdmin>} nameAdmin
  * @param {string[]} names
  */
 export const reserveThenGetNames = async (nameAdmin, names) =>
@@ -53,7 +59,7 @@ export const reserveThenGetNames = async (nameAdmin, names) =>
 
 /**
  * @param {string} debugName
- * @param {ERef<import('@agoric/vats').NameAdmin>} namesByAddressAdmin
+ * @param {ERef<NameAdmin>} namesByAddressAdmin
  * @param {string} addr
  * @param {ERef<Payment>[]} payments
  */
@@ -82,9 +88,7 @@ export const reserveThenDeposit = async (
 
 /**
  * @type {<T>(
- *   store: ERef<
- *     Map<string, T> | import('@agoric/internal/src/scratch.js').ScratchPad
- *   >,
+ *   store: ERef<Map<string, T> | ScratchPad>,
  *   key: string,
  *   make: () => T,
  * ) => Promise<T>}
@@ -101,7 +105,7 @@ const provideWhen = async (store, key, make) => {
 
 /**
  * @param {Promise<{
- *   scratch: ERef<import('@agoric/internal/src/scratch.js').ScratchPad>;
+ *   scratch: ERef<ScratchPad>;
  * }>} homeP
  * @param {object} opts
  * @param {(specifier: string) => Promise<{ default: Bundle }>} opts.loadBundle
@@ -171,3 +175,22 @@ export const sanitizePathSegment = name => {
   assertPathSegment(candidate);
   return candidate;
 };
+
+/**
+ * Idempotently provide an empty MapStore for the `retiredContractInstances`
+ * value in promise space
+ *
+ * @param {Promise<MapStore>} consume
+ * @param {Producer<MapStore>} produce
+ * @returns {Promise<MapStore>}
+ */
+export const provideRetiredInstances = async (consume, produce) => {
+  // Promise space has no way to look for an existing value other than awaiting a promise,
+  // but it does allow extra production so it's safe to do this redundantly.
+  produce.resolve(
+    makeScalarBigMapStore('retiredContractInstances', {
+      durable: true,
+    }),
+  );
+  return consume;
+};

package/src/proposals/withdraw-reserve-proposal.js

@@ -0,0 +1,63 @@
+import { E } from '@endo/far';
+import { makeTracer } from '@agoric/internal/src/debug.js';
+import { reserveThenDeposit } from './utils.js';
+
+/**
+ * @param {BootstrapPowers & {
+ *   consume: {
+ *     reserveKit: Promise<
+ *       ReturnType<typeof import('../reserve/assetReserve.js').start>
+ *     >;
+ *   };
+ * }} powers
+ * @param {{ options: { address: string; count?: number } }} namedArgs
+ */
+export const inviteReserveWithdrawer = async (
+  { consume: { namesByAddressAdmin, reserveKit } },
+  { options: { address, count = 1 } },
+) => {
+  const trace = makeTracer('InviteReserveWithdrawer');
+
+  const maybeGovernedCreatorFacetP = E.get(reserveKit).creatorFacet;
+  const creatorFacetP = E(maybeGovernedCreatorFacetP)
+    .getLimitedCreatorFacet()
+    .catch(err => {
+      trace('Failed to get limited creator facet:', err);
+      return maybeGovernedCreatorFacetP;
+    });
+
+  const makeInvitation = () =>
+    // @ts-expect-error tolerate translation from governed to limited creatorFacet
+    E(creatorFacetP).makeSingleWithdrawalInvitation();
+
+  const invitations = await Promise.all(
+    Array.from({ length: count }, makeInvitation),
+  );
+
+  // Deposit the invitations, but don't block in case the address does not yet
+  // have a smart wallet.
+  void reserveThenDeposit(
+    `reserve withdrawer ${address}`,
+    namesByAddressAdmin,
+    address,
+    invitations,
+  );
+};
+harden(inviteReserveWithdrawer);
+
+export const getManifestForInviteWithdrawer = async (
+  { restoreRef: _ },
+  { address, count },
+) => {
+  return {
+    manifest: {
+      [inviteReserveWithdrawer.name]: /** @type {const} */ ({
+        consume: {
+          namesByAddressAdmin: true,
+          reserveKit: true,
+        },
+      }),
+    },
+    options: { address, count },
+  };
+};