@agoric/inter-protocol 0.16.2-dev-1b64aa6.0 → 0.16.2-dev-47d00ff.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agoric/inter-protocol",
-  "version": "0.16.2-dev-1b64aa6.0+1b64aa6",
+  "version": "0.16.2-dev-47d00ff.0+47d00ff",
   "description": "Core cryptoeconomy contracts",
   "type": "module",
   "main": "src/index.js",
@@ -84,5 +84,5 @@
   "typeCoverage": {
     "atLeast": 95.72
   },
-  "gitHead": "1b64aa63f7c8ef9cfd8a9a852c19924050ed8ae1"
+  "gitHead": "47d00ffad8c595b0a9be215efc6665204ff90525"
 }

package/src/provisionPool.d.ts

@@ -48,8 +48,8 @@ export function start(zcf: ZCF<ProvisionTerms>, privateArgs: {
         getUnknown: (name: string) => any;
         getSubscription: () => globalThis.StoredSubscription<globalThis.GovernanceSubscriptionState>;
         getGovernedParams: () => globalThis.ERef<globalThis.ParamStateRecord>;
-        getMetrics(): any;
-        getPublicTopics(): any;
+        getMetrics(): Promise<any>;
+        getPublicTopics(): Promise<any>;
     }>;
 }>;
 /**

package/src/provisionPool.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provisionPool.d.ts","sourceRoot":"","sources":["provisionPool.js"],"names":[],"mappings":"AAmBA;;;;;GAKG;AAEH,2BAA2B;AAC3B,mBADW,YAAY,CAerB;AAsBK,2BAbI,IAAI,cAAc,CAAC,eACnB;IACN,QAAQ,EAAE,OAAO,WAAW,EAAE,IAAI,CACtC,OAAa,8BAA8B,EAAE,IAAI,CAC5C,CAAC;IACF,sBAAsB,EAAE,UAAU,CAAC;IACnC,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,QAAQ,GAAG,CAAC,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,uBAAuB,EAAE,mBAAmB,CAAC;IACtE,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;CAC7D,WACO,OAAO,kBAAkB,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAwE5C;;;;6BAxFY,aAAa,GACzB,gBAAoB;IACd,uBAAuB,EAAE,QAAQ,CAAC;CACnC,CAAC;kCA1BwD,aAAa;yBAAb,aAAa;gCAAb,aAAa;6BAFlD,eAAe;4BACO,cAAc;2BAAd,cAAc;mCACC,aAAa;qCAC1C,iCAAiC"}
+{"version":3,"file":"provisionPool.d.ts","sourceRoot":"","sources":["provisionPool.js"],"names":[],"mappings":"AAmBA;;;;;GAKG;AAEH,2BAA2B;AAC3B,mBADW,YAAY,CAerB;AAsBK,2BAbI,IAAI,cAAc,CAAC,eACnB;IACN,QAAQ,EAAE,OAAO,WAAW,EAAE,IAAI,CACtC,OAAa,8BAA8B,EAAE,IAAI,CAC5C,CAAC;IACF,sBAAsB,EAAE,UAAU,CAAC;IACnC,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,EAAE,QAAQ,GAAG,CAAC,CAAC;IACzB,eAAe,CAAC,EAAE,OAAO,uBAAuB,EAAE,mBAAmB,CAAC;IACtE,sBAAsB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;CAC7D,WACO,OAAO,kBAAkB,EAAE,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0E5C;;;;6BA1FY,aAAa,GACzB,gBAAoB;IACd,uBAAuB,EAAE,QAAQ,CAAC;CACnC,CAAC;kCA1BwD,aAAa;yBAAb,aAAa;gCAAb,aAAa;6BAFlD,eAAe;4BACO,cAAc;2BAAd,cAAc;mCACC,aAAa;qCAC1C,iCAAiC"}

package/src/provisionPool.js

@@ -93,33 +93,35 @@ export const start = async (zcf, privateArgs, baggage) => {
     makeBridgeProvisionTool,
   });
 
+  const poolBrand = /** @type {Brand<'nat'>} */ (
+    params.getPerAccountInitialAmount().brand
+  );
   const provisionPoolKit = await provideSingleton(
     baggage,
     'provisionPoolKit',
     () =>
       makeProvisionPoolKit({
-        // XXX governance can change the brand of the amount but should only be able to change the value
-        // NB: changing the brand will break this pool
-        // @ts-expect-error XXX Brand AssetKind
-        poolBrand: params.getPerAccountInitialAmount().brand,
+        poolBrand,
         storageNode: privateArgs.storageNode,
       }),
-    kit => kit.helper.start({ metrics: metricsOverride }),
   );
+  provisionPoolKit.helper.start(poolBrand, { metrics: metricsOverride });
 
   const publicFacet = prepareExo(
     baggage,
     'Provisioning Pool public',
     M.interface('ProvisionPool', {
-      getMetrics: M.call().returns(M.remotable('MetricsSubscriber')),
-      getPublicTopics: M.call().returns(TopicsRecordShape),
+      getMetrics: M.callWhen().returns(M.remotable('MetricsSubscriber')),
+      getPublicTopics: M.callWhen().returns(TopicsRecordShape),
       ...publicMixinAPI,
     }),
     {
-      getMetrics() {
+      async getMetrics() {
+        await null;
         return provisionPoolKit.public.getPublicTopics().metrics.subscriber;
       },
-      getPublicTopics() {
+      async getPublicTopics() {
+        await null;
         return provisionPoolKit.public.getPublicTopics();
       },
       ...publicMixin,

package/src/provisionPoolKit.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provisionPoolKit.d.ts","sourceRoot":"","sources":["provisionPoolKit.js"],"names":[],"mappings":"AAkFO,iDAFI,OAAO,cAAc,EAAE,IAAI;;;;;eA+ds7E,CAAC;;;;;;IAtcv9E,iCAAiC;oBAArB,aAAa;GA6B5B;AAYI,8CATI,OAAO,cAAc,EAAE,IAAI,uEAC3B;IACN,eAAe,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IACvF,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,OAAO,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,GAAG,EAAE,GAAG,CAAC;IACT,uBAAuB,EAAE,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC;CACxE,gCA8YC;IAA2B,SAAS,EAA5B,MAAM,KAAK,CAAC;IACY,WAAW,EAAnC,KAAK,WAAW,CAAC;CACzB,KAAU,OAAO,CAAC,gBAAgB,CAAC,CAcvC;+BAngBY;IACR,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,GAAG,CAAC;CACb;0BAIS,OAAO,qCAAqC,EAAE,QAAQ,CAClE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyD,CACtD;;iBAKU,KAAK,WAAW,CAAC;yBACjB,KAAK,OAAO,cAAc,EAAE,SAAS,CAAC;mBACtC,KACb,OAAW,6CAA6C,EAAE,wBAAwB,CAAC,cAAc,CAAC,CAC/F;;;;;;;;;;wBAMU,MAAM;;;;;yBACN,OAAO,KAAK,CAAC;;;;;0BAEb,OAAO,KAAK,CAAC;;0BAzCJ,WAAW;6BAHc,cAAc;0BAI1B,8BAA8B;mCALlC,sCAAsC;yBAGhD,aAAa;2BAFa,cAAc;iCAChC,0CAA0C;4BADxB,cAAc;iCAI1B,8BAA8B"}
+{"version":3,"file":"provisionPoolKit.d.ts","sourceRoot":"","sources":["provisionPoolKit.js"],"names":[],"mappings":"AAmFO,iDAFI,OAAO,cAAc,EAAE,IAAI;;;;;eA8gBoqB,CAAC;;;;;;IArfrsB,iCAAiC;oBAArB,aAAa;GA6B5B;AAYI,8CATI,OAAO,cAAc,EAAE,IAAI,uEAC3B;IACN,eAAe,EAAE,OAAO,6CAA6C,EAAE,eAAe,CAAC;IACvF,MAAM,EAAE,GAAG,CAAC;IACZ,QAAQ,EAAE,OAAO,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;IACzC,GAAG,EAAE,GAAG,CAAC;IACT,uBAAuB,EAAE,UAAU,CAAC,OAAO,0BAA0B,CAAC,CAAC;CACxE,gCA6bC;IAA2B,SAAS,EAA5B,MAAM,KAAK,CAAC;IACY,WAAW,EAAnC,KAAK,WAAW,CAAC;CACzB,KAAU,OAAO,CAAC,gBAAgB,CAAC,CAcvC;+BAljBY;IACR,OAAO,EAAE,GAAG,CAAC;IACb,MAAM,EAAE,GAAG,CAAC;IACZ,UAAU,EAAE,GAAG,CAAC;IAChB,MAAM,EAAE,GAAG,CAAC;CACb;0BAIS,OAAO,qCAAqC,EAAE,QAAQ,CAClE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAAyD,CACtD;;iBAKU,KAAK,WAAW,CAAC;yBACjB,KAAK,OAAO,cAAc,EAAE,SAAS,CAAC;mBACtC,KACb,OAAW,6CAA6C,EAAE,wBAAwB,CAAC,cAAc,CAAC,CAC/F;;;;;;;;;;wBAMU,MAAM;;;;;yBACN,OAAO,KAAK,CAAC;;;;;0BAEb,OAAO,KAAK,CAAC;;0BAzCJ,WAAW;6BAHc,cAAc;0BAI1B,8BAA8B;mCALlC,sCAAsC;yBAGhD,aAAa;2BAFa,cAAc;iCAChC,0CAA0C;4BADxB,cAAc;iCAI1B,8BAA8B"}

package/src/provisionPoolKit.js

@@ -15,6 +15,7 @@ import {
   makeScalarBigMapStore,
   makeScalarBigSetStore,
 } from '@agoric/vat-data';
+import { makeAtomicProvider, makeScalarMapStore } from '@agoric/store';
 import { PowerFlags } from '@agoric/vats/src/walletFlags.js';
 import {
   PublicTopicShape,
@@ -149,6 +150,20 @@ export const prepareProvisionPoolKit = (
   { makeRecorderKit, params, poolBank, zcf, makeBridgeProvisionTool },
 ) => {
   const zoe = zcf.getZoeService();
+  const ephemeralPurses = makeScalarMapStore('fundingPurseForBrand');
+  const purseProvider = makeAtomicProvider(ephemeralPurses);
+  const getFundingPurseForBrand = async poolBrand => {
+    await null;
+    try {
+      const purse = await purseProvider.provideAsync(poolBrand, brand =>
+        E(poolBank).getPurse(brand),
+      );
+      return purse;
+    } catch (err) {
+      trace(`🚨 could not get purse for brand ${poolBrand}`, err);
+      throw err;
+    }
+  };
 
   const makeProvisionPoolKitInternal = zone.exoClassKit(
     'ProvisionPoolKit',
@@ -180,7 +195,7 @@ export const prepareProvisionPoolKit = (
     },
     /**
      * @param {object} opts
-     * @param {Purse<'nat'>} opts.fundPurse
+     * @param {Purse<'nat'>} [opts.fundPurse]
      * @param {Brand<'nat'>} opts.poolBrand
      * @param {StorageNode} opts.metricsNode
      */
@@ -335,35 +350,43 @@ export const prepareProvisionPoolKit = (
           );
           facets.helper.publishMetrics();
         },
+        /**
+         * @param {Amount} amount
+         * @param {ERef<Purse>} srcPurse
+         */
+        async onPoolDeposit(amount, srcPurse) {
+          const { helper } = this.facets;
+          const { brandToPSM, poolBrand } = this.state;
+
+          const { brand } = amount;
+          if (AmountMath.isEmpty(amount) || brand === poolBrand) {
+            return;
+          }
+
+          // `amount` doesn't match the current `poolBrand`, so we need to swap
+          // it.
+          if (!brandToPSM.has(brand)) {
+            console.error('funds arrived but no PSM instance', brand);
+            return;
+          }
+          const instance = brandToPSM.get(brand);
+          const payment = E(srcPurse).withdraw(amount);
+          await helper.swap(payment, amount, instance).catch(async reason => {
+            console.error(X`swap failed: ${reason}`);
+            const resolvedPayment = await payment;
+            return E(srcPurse).deposit(resolvedPayment);
+          });
+        },
         /**
          * @param {ERef<Purse>} exchangePurse
          * @param {ERef<Brand>} brand
          */
         watchCurrentAmount(exchangePurse, brand) {
-          const {
-            state: { brandToPSM, poolBrand },
-            facets: { helper },
-          } = this;
-
+          const { helper } = this.facets;
           void observeNotifier(E(exchangePurse).getCurrentAmountNotifier(), {
             updateState: async amount => {
               trace('provisionPool balance update', amount);
-              if (AmountMath.isEmpty(amount) || amount.brand === poolBrand) {
-                return;
-              }
-              if (!brandToPSM.has(brand)) {
-                console.error('funds arrived but no PSM instance', brand);
-                return;
-              }
-              const instance = brandToPSM.get(brand);
-              const payment = E(exchangePurse).withdraw(amount);
-              await helper
-                .swap(payment, amount, instance)
-                .catch(async reason => {
-                  console.error(X`swap failed: ${reason}`);
-                  const resolvedPayment = await payment;
-                  return E(exchangePurse).deposit(resolvedPayment);
-                });
+              await helper.onPoolDeposit(amount, exchangePurse);
             },
             fail: reason => {
               if (isUpgradeDisconnection(reason)) {
@@ -429,40 +452,50 @@ export const prepareProvisionPoolKit = (
           );
         },
         /**
+         * @param {Brand<'nat'>} poolBrand
          * @param {object} [options]
          * @param {MetricsNotification} [options.metrics]
          */
-        start({ metrics } = {}) {
-          const {
-            state: { poolBrand },
-            facets: { helper },
-          } = this;
+        start(poolBrand, { metrics } = {}) {
+          const { facets, state } = this;
+          const { helper } = facets;
+          const lastPoolBrand = state.poolBrand;
 
-          // Must match. poolBrand is from durable state and the param is from
-          // the contract, so it technically can change between incarnations.
-          // That would be a severe bug.
+          // The PerAccountInitialAmount param must use the correct brand for
+          // this incarnation.
           AmountMath.coerce(poolBrand, params.getPerAccountInitialAmount());
 
-          void helper.watchAssetSubscription();
-
+          // Restore old metrics.
           if (metrics) {
-            // Restore state.
-            // we publishMetrics() below
             const {
               walletsProvisioned,
               totalMintedProvided,
               totalMintedConverted,
             } = metrics;
             assert.typeof(walletsProvisioned, 'bigint');
-            AmountMath.coerce(poolBrand, totalMintedProvided);
-            AmountMath.coerce(poolBrand, totalMintedConverted);
-            Object.assign(this.state, {
+            AmountMath.coerce(lastPoolBrand, totalMintedProvided);
+            AmountMath.coerce(lastPoolBrand, totalMintedConverted);
+            Object.assign(state, {
               walletsProvisioned,
               totalMintedProvided,
               totalMintedConverted,
             });
             helper.publishMetrics();
           }
+
+          // Update as needed when `poolBrand` changes.
+          if (poolBrand !== lastPoolBrand) {
+            state.poolBrand = poolBrand;
+            state.fundPurse = undefined;
+            void getFundingPurseForBrand(poolBrand).then(purse =>
+              helper.updateFundPurse(purse, poolBrand),
+            );
+            state.totalMintedProvided = AmountMath.makeEmpty(poolBrand);
+            state.totalMintedConverted = AmountMath.makeEmpty(poolBrand);
+            helper.publishMetrics();
+          }
+
+          void helper.watchAssetSubscription();
         },
         /**
          * @param {ERef<Payment>} payIn
@@ -470,10 +503,13 @@ export const prepareProvisionPoolKit = (
          * @param {PsmInstance} instance
          */
         async swap(payIn, amount, instance) {
+          await null;
+          const { facets, state } = this;
+          const { helper } = facets;
           const {
-            facets: { helper },
-            state: { fundPurse },
-          } = this;
+            poolBrand,
+            fundPurse = await getFundingPurseForBrand(poolBrand),
+          } = state;
           const psmPub = E(zoe).getPublicFacet(instance);
           const proposal = harden({ give: { In: amount } });
           const invitation = E(psmPub).makeWantMintedInvitation();
@@ -483,19 +519,31 @@ export const prepareProvisionPoolKit = (
           helper.onTrade(rxd);
           return rxd;
         },
+        /**
+         * @param {Purse<'nat'>} purse
+         * @param {Brand<'nat'>} brand
+         */
+        updateFundPurse(purse, brand) {
+          const { state } = this;
+          if (brand !== state.poolBrand || state.fundPurse) return;
+          state.fundPurse = purse;
+        },
       },
       forHandler: {
         onProvisioned() {
-          const { state, facets } = this;
+          const { facets, state } = this;
           state.walletsProvisioned += 1n;
           facets.helper.publishMetrics();
         },
         /** @param {ERef<Bank>} destBank */
         async sendInitialPayment(destBank) {
+          await null;
+          const { facets, state } = this;
+          const { helper } = facets;
           const {
-            facets: { helper },
-            state: { fundPurse, poolBrand },
-          } = this;
+            poolBrand,
+            fundPurse = await getFundingPurseForBrand(poolBrand),
+          } = state;
           const perAccountInitialAmount = /** @type {Amount<'nat'>} */ (
             params.getPerAccountInitialAmount()
           );
@@ -545,7 +593,7 @@ export const prepareProvisionPoolKit = (
    * @returns {Promise<ProvisionPoolKit>}
    */
   const makeProvisionPoolKit = async ({ poolBrand, storageNode }) => {
-    const fundPurse = await E(poolBank).getPurse(poolBrand);
+    const fundPurse = await getFundingPurseForBrand(poolBrand);
     const metricsNode = await E(storageNode).makeChildNode('metrics');
 
     return makeProvisionPoolKitInternal({