@agoric/smart-wallet 0.5.4-other-dev-8f8782b.0 → 0.5.4-other-dev-fbe72e7.0.fbe72e7

package/src/offers.js

@@ -1,198 +1,54 @@
-import { E, passStyleOf } from '@endo/far';
-import { deeplyFulfilledObject } from '@agoric/internal';
-import { makePaymentsHelper } from './payments.js';
+/**
+ * @import {Proposal} from '@agoric/zoe';
+ * @import {Passable} from '@endo/pass-style';
+ */
 
 /**
  * @typedef {number | string} OfferId
  */
 
+/**
+ * @typedef {object} ResultPlan
+ * @property {string} name by which to save the item
+ * @property {boolean} [overwrite=false] whether to overwrite an existing item.
+ *   If false and there is a conflict, the contract will autogen a similar
+ *   name.
+ */
+
 /**
  * @typedef {{
- *   id: OfferId,
- *   invitationSpec: import('./invitations').InvitationSpec,
- *   proposal: Proposal,
- *   offerArgs?: unknown
+ *   targetName: string;
+ *   method: string;
+ *   args: Passable[];
+ *   saveResult?: ResultPlan;
+ *   id?: number | string;
+ * }} InvokeEntryMessage
+ */
+
+/**
+ * @typedef {{
+ *   id: OfferId;
+ *   invitationSpec: import('./invitations.js').InvitationSpec;
+ *   proposal: Proposal;
+ *   offerArgs?: any;
+ *   saveResult?: ResultPlan;
  * }} OfferSpec
+ *   If `saveResult` is provided, the result of the invocation will be saved to
+ *   the specified location. Otherwise it will be published directly to vstorage
+ *   (or 'UNPUBLISHED' if it cannot be).
  */
 
 /** Value for "result" field when the result can't be published */
 export const UNPUBLISHED_RESULT = 'UNPUBLISHED';
 
 /**
- * @typedef {import('./offers.js').OfferSpec & {
- * error?: string,
- * numWantsSatisfied?: number
- * result?: unknown | typeof UNPUBLISHED_RESULT,
- * payouts?: AmountKeywordRecord,
+ * @typedef {OfferSpec & {
+ *   error?: string;
+ *   numWantsSatisfied?: number;
+ *   result?:
+ *     | unknown
+ *     | typeof UNPUBLISHED_RESULT
+ *     | { name: string; passStyle: string };
+ *   payouts?: AmountKeywordRecord;
  * }} OfferStatus
  */
-
-/* eslint-disable jsdoc/check-param-names -- bug(?) with nested objects */
-/**
- * @param {object} opts
- * @param {ERef<ZoeService>} opts.zoe
- * @param {{ receive: (payment: *) => Promise<Amount> }} opts.depositFacet
- * @param {ERef<Issuer<'set'>>} opts.invitationIssuer
- * @param {object} opts.powers
- * @param {Pick<Console, 'info'| 'error'>} opts.powers.logger
- * @param {(spec: import('./invitations').InvitationSpec) => ERef<Invitation>} opts.powers.invitationFromSpec
- * @param {(brand: Brand) => Promise<import('./types').RemotePurse>} opts.powers.purseForBrand
- * @param {(status: OfferStatus) => void} opts.onStatusChange
- * @param {(offerId: string, invitationAmount: Amount<'set'>, invitationMakers: import('./types').RemoteInvitationMakers, publicSubscribers: import('./types').PublicSubscribers | import('@agoric/zoe/src/contractSupport').TopicsRecord ) => Promise<void>} opts.onNewContinuingOffer
- */
-export const makeOfferExecutor = ({
-  zoe,
-  depositFacet,
-  invitationIssuer,
-  powers,
-  onStatusChange,
-  onNewContinuingOffer,
-}) => {
-  const { invitationFromSpec, logger, purseForBrand } = powers;
-
-  return {
-    /**
-     * Take an offer description provided in capData, augment it with payments and call zoe.offer()
-     *
-     * @param {OfferSpec} offerSpec
-     * @param {(seatRef: UserSeat) => void} onSeatCreated
-     * @returns {Promise<void>} when the offer has been sent to Zoe; payouts go into this wallet's purses
-     * @throws if any parts of the offer are determined to be invalid before calling Zoe's `offer()`
-     */
-    async executeOffer(offerSpec, onSeatCreated) {
-      logger.info('starting executeOffer', offerSpec.id);
-
-      const paymentsManager = makePaymentsHelper(purseForBrand, depositFacet);
-
-      /** @type {OfferStatus} */
-      let status = {
-        ...offerSpec,
-      };
-      /** @param {Partial<OfferStatus>} changes */
-      const updateStatus = changes => {
-        status = { ...status, ...changes };
-        onStatusChange(status);
-      };
-
-      /** @type {UserSeat} */
-      let seatRef;
-
-      const tryBody = async () => {
-        // 1. Prepare values and validate synchronously.
-        const { id, invitationSpec, proposal, offerArgs } = offerSpec;
-
-        /** @type {PaymentKeywordRecord | undefined} */
-        const paymentKeywordRecord = await (proposal?.give &&
-          deeplyFulfilledObject(paymentsManager.withdrawGive(proposal.give)));
-
-        const invitation = invitationFromSpec(invitationSpec);
-        const invitationAmount = await E(invitationIssuer).getAmountOf(
-          invitation,
-        );
-
-        // 2. Begin executing offer
-        // No explicit signal to user that we reached here but if anything above
-        // failed they'd get an 'error' status update.
-
-        // eslint-disable-next-line @jessie.js/no-nested-await -- unconditional
-        seatRef = await E(zoe).offer(
-          invitation,
-          proposal,
-          paymentKeywordRecord,
-          offerArgs,
-        );
-        logger.info(id, 'seated');
-        onSeatCreated(seatRef);
-
-        const publishResult = E.when(E(seatRef).getOfferResult(), result => {
-          const passStyle = passStyleOf(result);
-          logger.info(id, 'offerResult', passStyle, result);
-          // someday can we get TS to type narrow based on the passStyleOf result match?
-          switch (passStyle) {
-            case 'bigint':
-            case 'boolean':
-            case 'null':
-            case 'number':
-            case 'string':
-            case 'symbol':
-            case 'undefined':
-              updateStatus({ result });
-              break;
-            case 'copyRecord':
-              // @ts-expect-error result narrowed by passStyle
-              if ('invitationMakers' in result) {
-                // save for continuing invitation offer
-                void onNewContinuingOffer(
-                  String(id),
-                  invitationAmount,
-                  // @ts-expect-error result narrowed by passStyle
-                  result.invitationMakers,
-                  // @ts-expect-error result narrowed by passStyle
-                  result.publicSubscribers,
-                );
-              }
-              // copyRecord is valid to publish but not safe as it may have private info
-              updateStatus({ result: UNPUBLISHED_RESULT });
-              break;
-            default:
-              // drop the result
-              updateStatus({ result: UNPUBLISHED_RESULT });
-          }
-        });
-
-        const publishWantsSatisfied = E.when(
-          E(seatRef).numWantsSatisfied(),
-          numSatisfied => {
-            logger.info(id, 'numSatisfied', numSatisfied);
-            if (numSatisfied === 0) {
-              updateStatus({ numWantsSatisfied: 0 });
-            }
-            updateStatus({
-              numWantsSatisfied: numSatisfied,
-            });
-          },
-        );
-
-        // This will block until all payouts succeed, but user will be updated
-        // as each payout will trigger its corresponding purse notifier.
-        const publishPayouts = E.when(E(seatRef).getPayouts(), payouts =>
-          paymentsManager.depositPayouts(payouts).then(amountsOrDeferred => {
-            updateStatus({ payouts: amountsOrDeferred });
-          }),
-        );
-
-        // The offer is complete when these promises are resolved.
-        // If any reject then executeOffer rejects and that must be handled.
-        return Promise.all([
-          publishResult,
-          publishWantsSatisfied,
-          publishPayouts,
-        ]);
-      };
-
-      await tryBody().catch(err => {
-        logger.error('OFFER ERROR:', err);
-        // Notify the user
-        updateStatus({ error: err.toString() });
-        // Attempt to recover payments
-        void paymentsManager.tryReclaimingWithdrawnPayments().then(result => {
-          if (result) {
-            updateStatus({ result });
-          }
-        });
-        if (seatRef) {
-          void E(seatRef)
-            .hasExited()
-            .then(hasExited => {
-              if (!hasExited) {
-                void E(seatRef).tryExit();
-              }
-            });
-        }
-        // propagate to caller
-        throw err;
-      });
-    },
-  };
-};
-harden(makeOfferExecutor);

package/src/proposals/upgrade-wallet-factory2-proposal.js

@@ -0,0 +1,61 @@
+// @ts-check
+/// <reference types="@agoric/vats/src/core/types-ambient" />
+
+import { E } from '@endo/far';
+import { makeStorageNodeChild } from '@agoric/internal/src/lib-chainStorage.js';
+
+/**
+ * @param {BootstrapPowers & ChainBootstrapSpace} powers
+ * @param {object} options
+ * @param {{ walletRef: VatSourceRef }} options.options
+ */
+export const upgradeWalletFactory = async (
+  {
+    consume: {
+      walletFactoryStartResult,
+      provisionPoolStartResult,
+      chainStorage,
+      walletBridgeManager: walletBridgeManagerP,
+    },
+  },
+  options,
+) => {
+  const WALLET_STORAGE_PATH_SEGMENT = 'wallet';
+
+  const { walletRef } = options.options;
+
+  const [walletBridgeManager, walletStorageNode, ppFacets] = await Promise.all([
+    walletBridgeManagerP,
+    makeStorageNodeChild(chainStorage, WALLET_STORAGE_PATH_SEGMENT),
+    provisionPoolStartResult,
+  ]);
+  const walletReviver = await E(ppFacets.creatorFacet).getWalletReviver();
+
+  const privateArgs = {
+    storageNode: walletStorageNode,
+    walletBridgeManager,
+    walletReviver,
+  };
+
+  const { adminFacet } = await walletFactoryStartResult;
+
+  assert(walletRef.bundleID);
+  await E(adminFacet).upgradeContract(walletRef.bundleID, privateArgs);
+
+  console.log(`Successfully upgraded WalletFactory`);
+};
+
+export const getManifestForUpgradeWallet = ({ restoreRef }, { walletRef }) => ({
+  manifest: {
+    [upgradeWalletFactory.name]: {
+      consume: {
+        walletFactoryStartResult: 'walletFactoryStartResult',
+        provisionPoolStartResult: 'provisionPoolStartResult',
+        chainStorage: 'chainStorage',
+        walletBridgeManager: 'walletBridgeManager',
+      },
+    },
+  },
+  installations: { walletFactory: restoreRef(walletRef) },
+  options: { walletRef },
+});

package/src/proposals/upgrade-walletFactory-proposal.js

@@ -1,28 +1,32 @@
 // @ts-check
+import { Fail } from '@endo/errors';
 import { E } from '@endo/far';
 import { makeMarshal } from '@endo/marshal';
 import { allValues } from '@agoric/internal';
 
 console.warn('upgrade-walletFactory-proposal.js module evaluating');
 
-const { Fail } = assert;
-
 // vstorage paths under published.*
+const WALLET_STORAGE_PATH_SEGMENT = 'wallet';
 const BOARD_AUX = 'boardAux';
 
 const marshalData = makeMarshal(_val => Fail`data only`);
 
 /**
- * @param { BootstrapPowers } powers
- *
+ * @param {BootstrapPowers} powers
  * @param {object} config
  * @param {{ walletFactoryRef: VatSourceRef & { bundleID: string } }} config.options
  */
 export const upgradeWalletFactory = async (
   {
-    consume: { contractKits: kitsP, instancePrivateArgs: argsP },
+    consume: {
+      contractKits,
+      governedContractKits,
+      chainStorage,
+      walletBridgeManager: walletBridgeManagerP,
+    },
     instance: {
-      consume: { walletFactory: wfInstanceP },
+      consume: { walletFactory: wfInstanceP, provisionPool: ppInstanceP },
     },
   },
   config,
@@ -30,26 +34,42 @@ export const upgradeWalletFactory = async (
   console.log('upgradeWalletFactory: config', config);
   const { walletFactoryRef } = config.options;
 
-  console.log('upgradeWalletFactory: awaiting instance');
-  const wfInstance = await wfInstanceP;
-  console.log('upgradeWalletFactory: awaiting contract kits');
-  const { contractKits, instancePrivateArgs } = await allValues({
-    contractKits: kitsP,
-    instancePrivateArgs: argsP,
+  // console.log('upgradeWalletFactory: awaiting instances etc.');
+  const { wfInstance, ppInstance, walletBridgeManager, storageNode } =
+    await allValues({
+      wfInstance: wfInstanceP,
+      ppInstance: ppInstanceP,
+      walletBridgeManager: walletBridgeManagerP,
+      // @ts-expect-error chainStorage is only falsy in testing
+      storageNode: E(chainStorage).makeChildNode(WALLET_STORAGE_PATH_SEGMENT),
+    });
+  // console.log('upgradeWalletFactory: awaiting contract kits');
+  const { wfKit, ppKit } = await allValues({
+    wfKit: E(contractKits).get(wfInstance),
+    ppKit: E(governedContractKits).get(ppInstance),
   });
-  const { adminFacet } = contractKits.get(wfInstance);
-  /** @type {Parameters<typeof import('../walletFactory').prepare>[1]} */
-  // @ts-expect-error cast
-  const unsettledArgs = instancePrivateArgs.get(wfInstance);
-  const privateArgs = await allValues(unsettledArgs);
-  console.log('upgradeWalletFactory: upgrading with privateArgs', privateArgs);
-  await E(adminFacet).upgradeContract(walletFactoryRef.bundleID, privateArgs);
+  // console.log('upgradeWalletFactory: awaiting walletReviver');
+  const walletReviver = await E(ppKit.creatorFacet).getWalletReviver();
+  const newPrivateArgs = harden({
+    storageNode,
+    walletBridgeManager,
+    walletReviver,
+  });
+
+  console.log(
+    'upgradeWalletFactory: upgrading with newPrivateArgs',
+    newPrivateArgs,
+  );
+  await E(wfKit.adminFacet).upgradeContract(
+    walletFactoryRef.bundleID,
+    newPrivateArgs,
+  );
   console.log('upgradeWalletFactory: done');
 };
 harden(upgradeWalletFactory);
 
 /**
- * @param { BootstrapPowers } powers
+ * @param {BootstrapPowers} powers
  */
 export const publishAgoricBrandsDisplayInfo = async ({
   consume: { agoricNames, board, chainStorage },
@@ -68,7 +88,7 @@ export const publishAgoricBrandsDisplayInfo = async ({
     await E(node).setValue(JSON.stringify(aux));
   };
 
-  /** @type {ERef<NameHub>} */
+  /** @type {ERef<import('@agoric/vats').NameHub>} */
   const brandHub = E(agoricNames).lookup('brand');
   const brands = await E(brandHub).values();
   // tolerate failure; in particular, for the timer brand
@@ -76,13 +96,16 @@ export const publishAgoricBrandsDisplayInfo = async ({
 };
 harden(publishAgoricBrandsDisplayInfo);
 
-/** @type { import("@agoric/vats/src/core/lib-boot").BootstrapManifest } */
+/** @type {import('@agoric/vats/src/core/lib-boot').BootstrapManifest} */
 const manifest = {
   [upgradeWalletFactory.name]: {
     // include rationale for closely-held, high authority capabilities
     consume: {
       contractKits: `to upgrade walletFactory using its adminFacet`,
-      instancePrivateArgs: `to get privateArgs for walletFactory`,
+      governedContractKits:
+        'to get walletReviver from provisionPool.creatorFacet',
+      chainStorage: 'to allow walletFactory to (continue) write to vstorage',
+      walletBridgeManager: 'to handle bridged cosmos SpendAction messages',
     },
     // widely-shared, low authority instance handles need no rationale
     instance: {