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

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

@@ -0,0 +1,341 @@
+import { makeTracer } from '@agoric/internal';
+import { makeStorageNodeChild } from '@agoric/internal/src/lib-chainStorage.js';
+import { E } from '@endo/far';
+
+import { unitAmount } from '@agoric/zoe/src/contractSupport/priceQuote.js';
+import {
+  oracleBrandFeedName,
+  provideRetiredInstances,
+  reserveThenDeposit,
+  sanitizePathSegment,
+} from './utils.js';
+import { replaceScaledPriceAuthorities } from './replace-scaledPriceAuthorities.js';
+
+const STORAGE_PATH = 'priceFeed';
+
+/** @type {ChainlinkConfig} */
+export const DEFAULT_CONTRACT_TERMS = {
+  maxSubmissionCount: 1000,
+  minSubmissionCount: 2,
+  restartDelay: 1n, // the number of rounds an Oracle has to wait before they can initiate another round
+  timeout: 10, // in seconds according to chainTimerService
+  minSubmissionValue: 1,
+  maxSubmissionValue: 2 ** 256,
+};
+
+/** @import {EconomyBootstrapPowers} from './econ-behaviors.js'; */
+/** @import {ChainlinkConfig} from '@agoric/inter-protocol/src/price/fluxAggregatorKit.js'; */
+/** @import {FluxStartFn} from '@agoric/inter-protocol/src/price/fluxAggregatorContract.js'; */
+
+const trace = makeTracer('DeployPriceFeed', true);
+
+/**
+ * @typedef {{
+ *   oracleAddresses: string[];
+ *   inBrandNames: string[];
+ *   contractTerms?: Partial<ChainlinkConfig>;
+ * }} PriceFeedConfig
+ */
+
+/**
+ * @param {EconomyBootstrapPowers} powers
+ * @param {string} bundleID
+ */
+const installPriceAggregator = async (
+  {
+    consume: { zoe },
+    installation: {
+      produce: { priceAggregator },
+    },
+  },
+  bundleID,
+) => {
+  /** @type {Installation<FluxStartFn>} */
+  const installation = await E(zoe).installBundleID(bundleID);
+  priceAggregator.reset();
+  priceAggregator.resolve(installation);
+  trace('installed priceAggregator', bundleID.slice(0, 'b1-1234567'.length));
+  return installation;
+};
+
+/**
+ * Provide (find/create) inert brands (no mint or issuer) referred to by oracles
+ *
+ * @param {EconomyBootstrapPowers & NamedVatPowers} space
+ * @param {{ name: string; decimalPlaces: number }} opt
+ * @returns {Promise<Brand<'nat'>>}
+ */
+export const ensureOracleBrand = async (
+  {
+    namedVat: {
+      consume: { agoricNames },
+    },
+    oracleBrand: { produce: oracleBrandProduce },
+  },
+  { name, decimalPlaces },
+) => {
+  const brand = E(agoricNames).provideInertBrand(name, {
+    assetKind: 'nat',
+    decimalPlaces,
+  });
+
+  oracleBrandProduce[name].reset();
+  oracleBrandProduce[name].resolve(brand);
+  return brand;
+};
+
+/**
+ * @param {EconomyBootstrapPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance> }>} powers
+ * @param {{
+ *   AGORIC_INSTANCE_NAME: string;
+ *   contractTerms: import('@agoric/inter-protocol/src/price/fluxAggregatorKit.js').ChainlinkConfig;
+ *   brandIn: Brand<'nat'>;
+ *   brandOut: Brand<'nat'>;
+ * }} config
+ * @param {Installation<FluxStartFn>} installation
+ */
+const startPriceAggregatorInstance = async (
+  {
+    consume: {
+      agoricNames,
+      board,
+      chainStorage,
+      chainTimerService,
+      econCharterKit,
+      highPrioritySendersManager,
+      namesByAddressAdmin,
+      startGovernedUpgradable,
+      retiredContractInstances: retiredContractInstancesP,
+    },
+    instance: { produce: produceInstance },
+    produce: { retiredContractInstances: produceRetiredInstances },
+  },
+  { AGORIC_INSTANCE_NAME, contractTerms, brandIn, brandOut },
+  installation,
+) => {
+  trace('startPriceAggregatorInstance', AGORIC_INSTANCE_NAME);
+  const label = sanitizePathSegment(AGORIC_INSTANCE_NAME);
+
+  const feedsStorage = await makeStorageNodeChild(chainStorage, STORAGE_PATH);
+  const storageNode = await E(feedsStorage).makeChildNode(label);
+  const marshaller = await E(board).getReadonlyMarshaller();
+
+  const terms = harden({
+    ...contractTerms,
+    description: AGORIC_INSTANCE_NAME,
+    brandIn,
+    brandOut,
+    // XXX powerful TimerService, see #6003
+    timer: await chainTimerService,
+    unitAmountIn: await unitAmount(brandIn),
+  });
+  const privateArgs = {
+    highPrioritySendersManager: await highPrioritySendersManager,
+    marshaller,
+    namesByAddressAdmin,
+    storageNode,
+  };
+  const governedKit = await E(startGovernedUpgradable)({
+    governedParams: {},
+    privateArgs,
+    terms,
+    label,
+    // @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(
+    'new instance',
+    label,
+    { terms, privateArgs, installation },
+    governedKit,
+  );
+
+  await E(E.get(econCharterKit).creatorFacet).addInstance(
+    governedKit.instance,
+    governedKit.governorCreatorFacet,
+    AGORIC_INSTANCE_NAME,
+  );
+  trace('added', label, 'instance to econCharter');
+
+  /** @type {import('@agoric/zoe/src/zoeService/utils.js').StartedInstanceKit<FluxStartFn>} */
+  // @ts-expect-error
+  const { instance, publicFacet, creatorFacet } = governedKit;
+
+  return harden({ instance, publicFacet, creatorFacet });
+};
+
+/**
+ * Send invitations to oracle operators for a price feed.
+ *
+ * @param {EconomyBootstrapPowers} powers
+ * @param {{ oracleAddresses: string[]; AGORIC_INSTANCE_NAME: string }} config
+ * @param {any} creatorFacet
+ */
+const distributeInvitations = async (
+  { consume: { namesByAddressAdmin } },
+  { oracleAddresses, AGORIC_INSTANCE_NAME },
+  creatorFacet,
+) => {
+  /** @param {string} addr */
+  const addOracle = async addr => {
+    const invitation = await E(creatorFacet).makeOracleInvitation(addr);
+    const debugName = `${AGORIC_INSTANCE_NAME} member ${addr}`;
+    await reserveThenDeposit(debugName, namesByAddressAdmin, addr, [
+      invitation,
+    ]).catch(err => console.error(`failed deposit to ${debugName}`, err));
+  };
+
+  trace('distributing invitations', oracleAddresses);
+  // This doesn't resolve until oracle operators create their smart wallets.
+  // Don't block completion on it.
+  void Promise.all(oracleAddresses.map(addOracle));
+  trace('createPriceFeed complete');
+};
+
+/**
+ * @param {EconomyBootstrapPowers &
+ *   NamedVatPowers &
+ *   PromiseSpaceOf<{ retiredContractInstances: MapStore<string, Instance> }>} powers
+ * @param {{
+ *   options: PriceFeedConfig & {
+ *     priceAggregatorRef: { bundleID: string };
+ *     scaledPARef: { bundleID: string };
+ *     inBrandsDecimals?: number;
+ *     contractTerms?: ChainlinkConfig;
+ *     outBrandName?: string;
+ *     outBrandDecimals?: number;
+ *   };
+ * }} config
+ */
+export const deployPriceFeeds = async (powers, config) => {
+  const {
+    inBrandNames,
+    oracleAddresses,
+    contractTerms,
+    priceAggregatorRef,
+    scaledPARef,
+    inBrandsDecimals = 6,
+    outBrandName = 'USD',
+    outBrandDecimals = 6,
+  } = config.options;
+  await null;
+
+  const installation = await installPriceAggregator(
+    powers,
+    priceAggregatorRef.bundleID,
+  );
+
+  const { priceAuthorityAdmin, priceAuthority } = powers.consume;
+
+  trace({ oracleAddresses });
+  trace({ inBrandNames });
+  for (const inBrandName of inBrandNames) {
+    const AGORIC_INSTANCE_NAME = oracleBrandFeedName(inBrandName, outBrandName);
+    const brandIn = await ensureOracleBrand(powers, {
+      name: inBrandName,
+      decimalPlaces: inBrandsDecimals,
+    });
+    const brandOut = await ensureOracleBrand(powers, {
+      name: outBrandName,
+      decimalPlaces: outBrandDecimals,
+    });
+    const kit = await startPriceAggregatorInstance(
+      powers,
+      {
+        AGORIC_INSTANCE_NAME,
+        brandIn,
+        brandOut,
+        contractTerms: { ...DEFAULT_CONTRACT_TERMS, ...contractTerms },
+      },
+      installation,
+    );
+
+    const forceReplace = true;
+    await E(priceAuthorityAdmin).registerPriceAuthority(
+      E(kit.publicFacet).getPriceAuthority(),
+      brandIn,
+      brandOut,
+      forceReplace,
+    );
+
+    await distributeInvitations(
+      powers,
+      { oracleAddresses, AGORIC_INSTANCE_NAME },
+      kit.creatorFacet,
+    );
+  }
+
+  // @ts-expect-error replaceScaledPriceAuthorities uses a subset of the powers.
+  await replaceScaledPriceAuthorities(powers, {
+    options: { scaledPARef },
+  });
+
+  trace('resolving priceAuthority8400');
+  // cf. #8400 QuotePayments storage leak
+  powers.produce.priceAuthority8400.resolve(priceAuthority);
+};
+
+const t = 'priceFeed';
+
+/**
+ * Thread price feed upgrade options through from builder to core-eval.
+ *
+ * @param {object} utils
+ * @param {any} utils.restoreRef
+ * @param {PriceFeedConfig & { priceAggregatorRef: any }} priceFeedOptions
+ */
+export const getManifestForPriceFeeds = async (
+  { restoreRef: _restoreRef },
+  priceFeedOptions,
+) => ({
+  manifest: {
+    [deployPriceFeeds.name]: {
+      namedVat: t,
+      consume: {
+        agoricNamesAdmin: t,
+        agoricNames: t,
+        board: t,
+        chainStorage: t,
+        chainTimerService: t,
+        contractKits: t,
+        econCharterKit: t,
+        highPrioritySendersManager: t,
+        instancePrivateArgs: t,
+        namesByAddressAdmin: t,
+        priceAuthority: t,
+        priceAuthorityAdmin: t,
+        retiredContractInstances: t,
+        startGovernedUpgradable: t,
+        startUpgradable: t,
+        zoe: t,
+      },
+      installation: { produce: { priceAggregator: t } },
+      instance: {
+        produce: t,
+        consume: t,
+      },
+      oracleBrand: { produce: t },
+      produce: { priceAuthority8400: t, retiredContractInstances: t },
+    },
+  },
+  options: { ...priceFeedOptions },
+});

package/src/proposals/econ-behaviors.js

@@ -1,20 +1,30 @@
 // @jessie-check
 
-import '../../exported.js';
-
 import { AmountMath } from '@agoric/ertp';
-import '@agoric/governance/exported.js';
 import { deeplyFulfilledObject, makeTracer } from '@agoric/internal';
 import { makeStorageNodeChild } from '@agoric/internal/src/lib-chainStorage.js';
-import '@agoric/vats/exported.js';
-import '@agoric/vats/src/core/types.js';
-import { Stable } from '@agoric/vats/src/tokens.js';
 import { E } from '@endo/far';
 import { makeScalarBigMapStore } from '@agoric/vat-data';
+import { Stable } from '@agoric/internal/src/tokens.js';
 import { makeGovernedTerms as makeGovernedATerms } from '../auction/params.js';
 import { makeReserveTerms } from '../reserve/params.js';
 import { makeGovernedTerms as makeGovernedVFTerms } from '../vaultFactory/params.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);
 
 export const SECONDS_PER_MINUTE = 60n;
@@ -22,54 +32,75 @@ export const SECONDS_PER_HOUR = 60n * 60n;
 export const SECONDS_PER_DAY = 24n * SECONDS_PER_HOUR;
 export const SECONDS_PER_WEEK = 7n * SECONDS_PER_DAY;
 
-/**
- * @typedef {import('../vaultFactory/vaultFactory.js').VaultFactoryContract['publicFacet']} VaultFactoryPublicFacet
- * @typedef {import('../auction/auctioneer.js').AuctioneerPublicFacet} AuctioneerPublicFacet
- * @typedef {import('../auction/auctioneer.js').AuctioneerCreatorFacet} AuctioneerCreatorFacet
- */
+/** @import {start as VFStart} from '../vaultFactory/vaultFactory.js' */
+/** @typedef {Awaited<ReturnType<VFStart>>['publicFacet']} VaultFactoryPublicFacet */
 
 /**
  * @typedef {object} PSMKit
  * @property {string} label
- * @property {Instance} psm
- * @property {Instance} psmGovernor
- * @property {Awaited<ReturnType<Awaited<ReturnType<import('../psm/psm.js')['prepare']>>['creatorFacet']['getLimitedCreatorFacet']>>} psmCreatorFacet
- * @property {GovernorCreatorFacet<import('../../src/psm/psm.js')['prepare']>} psmGovernorCreatorFacet
+ * @property {Instance<import('../psm/psm.js').start>} psm
+ * @property {Instance<
+ *   import('../../../governance/src/contractGovernor.js').start
+ * >} psmGovernor
+ * @property {Awaited<
+ *   ReturnType<
+ *     Awaited<
+ *       ReturnType<import('../psm/psm.js')['start']>
+ *     >['creatorFacet']['getLimitedCreatorFacet']
+ *   >
+ * >} psmCreatorFacet
+ * @property {GovernorCreatorFacet<import('../../src/psm/psm.js')['start']>} psmGovernorCreatorFacet
  * @property {AdminFacet} psmAdminFacet
  */
 
-/**
- * @typedef {GovernanceFacetKit<import('../auction/auctioneer.js').start>} AuctioneerKit
- */
+/** @typedef {GovernanceFacetKit<import('../auction/auctioneer.js').start>} AuctioneerKit */
 
 /**
- * @typedef { WellKnownSpaces & ChainBootstrapSpace & EconomyBootstrapSpace
- * } EconomyBootstrapPowers
+ * @typedef {WellKnownSpaces & ChainBootstrapSpace & EconomyBootstrapSpace} EconomyBootstrapPowers
+ *
+ *
  * @typedef {PromiseSpaceOf<{
- *   economicCommitteeKit: CommitteeStartResult,
- *   economicCommitteeCreatorFacet: import('@agoric/governance/src/committee.js').CommitteeElectorateCreatorFacet,
- *   feeDistributorKit: StartedInstanceKit<typeof import('../feeDistributor.js').start>,
- *   periodicFeeCollectors: MapStore<number, import('../feeDistributor.js').PeriodicFeeCollector>,
- *   psmKit: MapStore<Brand, PSMKit>,
- *   anchorBalancePayments: MapStore<Brand, Payment<'nat'>>,
- *   econCharterKit: EconCharterStartResult,
- *   reserveKit: GovernanceFacetKit<import('../reserve/assetReserve.js')['prepare']>,
- *   vaultFactoryKit: GovernanceFacetKit<import('../vaultFactory/vaultFactory.js')['prepare']>,
- *   auctioneerKit: AuctioneerKit,
- *   minInitialDebt: NatValue,
+ *   economicCommitteeKit: CommitteeStartResult;
+ *   economicCommitteeCreatorFacet: import('@agoric/governance/src/committee.js').CommitteeElectorateCreatorFacet;
+ *   feeDistributorKit: StartedInstanceKit<
+ *     typeof import('../feeDistributor.js').start
+ *   >;
+ *   periodicFeeCollectors: MapStore<
+ *     number,
+ *     import('../feeDistributor.js').PeriodicFeeCollector
+ *   >;
+ *   psmKit: MapStore<Brand, PSMKit>;
+ *   anchorBalancePayments: MapStore<Brand, Payment<'nat'>>;
+ *   econCharterKit: EconCharterStartResult;
+ *   reserveKit: GovernanceFacetKit<
+ *     import('../reserve/assetReserve.js')['start']
+ *   >;
+ *   vaultFactoryKit: GovernanceFacetKit<VFStart>;
+ *   auctioneerKit: AuctioneerKit;
+ *   newAuctioneerKit: AuctioneerKit | undefined;
+ *   minInitialDebt: NatValue;
  * }>} EconomyBootstrapSpace
  */
 
-/** @typedef {import('@agoric/zoe/src/zoeService/utils.js').StartedInstanceKit<import('../econCommitteeCharter')['prepare']>} EconCharterStartResult */
-/** @typedef {import('@agoric/zoe/src/zoeService/utils.js').StartedInstanceKit<import('@agoric/governance/src/committee.js')['prepare']>} CommitteeStartResult */
+/**
+ * @typedef {StartedInstanceKit<
+ *   import('../econCommitteeCharter.js')['start']
+ * >} EconCharterStartResult
+ */
+/**
+ * @typedef {StartedInstanceKit<
+ *   import('@agoric/governance/src/committee.js')['start']
+ * >} CommitteeStartResult
+ */
 
 /**
  * @file A collection of productions, each of which declares inputs and outputs.
- * Each function is passed a set of powers for reading from and writing to the vat config.
+ *   Each function is passed a set of powers for reading from and writing to the
+ *   vat config.
  *
- * Each of the things they produce they're responsible for resolving or setting.
+ *   Each of the things they produce they're responsible for resolving or setting.
  *
- * In production called by @agoric/vats to bootstrap.
+ *   In production called by @agoric/vats to bootstrap.
  */
 
 /** @param {EconomyBootstrapPowers} powers */
@@ -141,9 +172,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(),
   ]);
 
@@ -153,7 +185,7 @@ export const setupReserve = async ({
       instance,
       publicFacet,
       creatorFacet,
-      adminFacet: g.adminFacet,
+      adminFacet,
 
       governor: g.instance,
       governorCreatorFacet: g.creatorFacet,
@@ -214,14 +246,14 @@ export const setupVaultFactoryArguments = async (
     initialShortfallInvitation,
     shortfallInvitationAmount,
     feeMintAccess,
-    auctioneerPublicFacet,
+    auctioneerInstance,
   ] = await Promise.all([
     poserInvitationP,
     E(E(zoe).getInvitationIssuer()).getAmountOf(poserInvitationP),
     shortfallInvitationP,
     E(E(zoe).getInvitationIssuer()).getAmountOf(shortfallInvitationP),
     feeMintAccessP,
-    E.get(auctioneerKit).publicFacet,
+    E.get(auctioneerKit).instance,
   ]);
 
   const reservePublicFacet = await E.get(reserveKit).publicFacet;
@@ -230,7 +262,6 @@ export const setupVaultFactoryArguments = async (
 
   const vaultFactoryTerms = makeGovernedVFTerms({
     priceAuthority,
-    auctioneerPublicFacet,
     reservePublicFacet,
     interestTiming,
     timer: chainTimerService,
@@ -242,6 +273,7 @@ export const setupVaultFactoryArguments = async (
   });
 
   const vaultFactoryPrivateArgs = {
+    auctioneerInstance,
     feeMintAccess,
     initialPoserInvitation,
     initialShortfallInvitation,
@@ -301,7 +333,11 @@ export const startVaultFactory = async (
     }),
   );
 
-  /** @type {GovernorStartedInstallationKit<typeof vaultFactoryInstallation>} */
+  /**
+   * @type {GovernorStartedInstallationKit<
+   *   typeof vaultFactoryInstallation
+   * >}
+   */
   const g = await E(consume.zoe).startInstance(
     contractGovernorInstallation,
     undefined,
@@ -350,8 +386,8 @@ export const startVaultFactory = async (
 };
 
 /**
- * Grant access to the VaultFactory creatorFacet
- * to up to one user based on address.
+ * Grant access to the VaultFactory creatorFacet to up to one user based on
+ * address.
  *
  * @param {EconomyBootstrapPowers} powers
  * @param {object} [root0]
@@ -436,19 +472,18 @@ export const startRewardDistributor = async ({
     });
 
   /**
-   * @type {Awaited<
-   *   ReturnType<typeof import('../feeDistributor.js').makeFeeDistributor>>
-   *   & { adminFacet: AdminFacet, instance: Instance }
-   * }
+   * @type {StartedInstanceKit<
+   *   typeof import('@agoric/inter-protocol/src/feeDistributor.js').start
+   * >}
    */
   const instanceKit = await E(zoe).startInstance(
     feeDistributor,
     { Fee: centralIssuer },
+    // @ts-expect-error XXX
     feeDistributorTerms,
     undefined,
     'feeDistributor',
   );
-  /** @type {ERef<import('../feeDistributor.js').FeeDestination>} */
   await E(instanceKit.creatorFacet).setDestinations({
     ...(rewardDistributorDepositFacet && {
       RewardDistributor: E(