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

package/src/offerWatcher.js

@@ -0,0 +1,343 @@
+import { E, passStyleOf } from '@endo/far';
+
+import { isUpgradeDisconnection } from '@agoric/internal/src/upgrade-api.js';
+import { prepareExoClassKit, watchPromise } from '@agoric/vat-data';
+import { M } from '@agoric/store';
+import {
+  PaymentPKeywordRecordShape,
+  SeatShape,
+} from '@agoric/zoe/src/typeGuards.js';
+import { AmountShape } from '@agoric/ertp/src/typeGuards.js';
+import { deeplyFulfilledObject, objectMap } from '@agoric/internal';
+
+import { UNPUBLISHED_RESULT } from './offers.js';
+
+/**
+ * @import {OfferSpec} from './offers.js';
+ * @import {ContinuingOfferResult} from './types.js';
+ * @import {Passable} from '@endo/pass-style';
+ * @import {PromiseWatcher} from '@agoric/swingset-liveslots';
+ * @import {Baggage} from '@agoric/vat-data';
+ * @import {Vow, VowTools} from '@agoric/vow';
+ * @import {PaymentPKeywordRecord, Proposal, UserSeat, ZoeService} from '@agoric/zoe';
+ */
+
+/**
+ * @template {any} T
+ * @typedef {PromiseWatcher<T, [UserSeat]>} OfferPromiseWatcher<T, [UserSeat]
+ */
+
+/**
+ * @typedef {{
+ *   resultWatcher: OfferPromiseWatcher<Passable>;
+ *   numWantsWatcher: OfferPromiseWatcher<number>;
+ *   paymentWatcher: OfferPromiseWatcher<PaymentPKeywordRecord>;
+ * }} OutcomeWatchers
+ */
+
+/** @param {VowTools} vowTools */
+const makeWatchForOfferResult = ({ watch }) => {
+  /**
+   * @param {OutcomeWatchers} watchers
+   * @param {UserSeat} seat
+   * @returns {Vow<void>} Vow that resolves when offer result has been processed
+   *   by the resultWatcher
+   */
+  const watchForOfferResult = ({ resultWatcher }, seat) => {
+    // Offer result may be anything, including a Vow, so watch it durably.
+    return watch(E(seat).getOfferResult(), resultWatcher, seat);
+  };
+  return watchForOfferResult;
+};
+
+/**
+ * @param {OutcomeWatchers} watchers
+ * @param {UserSeat} seat
+ */
+const watchForNumWants = ({ numWantsWatcher }, seat) => {
+  const p = E(seat).numWantsSatisfied();
+  watchPromise(p, numWantsWatcher, seat);
+  return p;
+};
+
+/**
+ * @param {OutcomeWatchers} watchers
+ * @param {UserSeat} seat
+ */
+const watchForPayout = ({ paymentWatcher }, seat) => {
+  const p = E(seat).getPayouts();
+  watchPromise(p, paymentWatcher, seat);
+  return p;
+};
+
+/** @param {VowTools} vowTools */
+export const makeWatchOfferOutcomes = vowTools => {
+  const watchForOfferResult = makeWatchForOfferResult(vowTools);
+  const { when, allVows } = vowTools;
+  /**
+   * @param {OutcomeWatchers} watchers
+   * @param {UserSeat} seat
+   */
+  const watchOfferOutcomes = (watchers, seat) => {
+    // Use `when` to get a promise from the vow.
+    // Unlike `asPromise` this doesn't warn in case of disconnections, which is
+    // fine since we actually handle the outcome durably through the watchers.
+    // Only the `executeOffer` caller relies on the settlement of this promise,
+    // and only in tests.
+    return when(
+      allVows([
+        watchForOfferResult(watchers, seat),
+        watchForNumWants(watchers, seat),
+        watchForPayout(watchers, seat),
+      ]),
+    );
+  };
+  return watchOfferOutcomes;
+};
+
+const offerWatcherGuard = harden({
+  helper: M.interface('InstanceAdminStorage', {
+    updateStatus: M.call(M.any()).returns(),
+    onNewContinuingOffer: M.call(
+      M.or(M.number(), M.string()),
+      AmountShape,
+      M.any(),
+    )
+      .optional(M.record())
+      .returns(),
+    publishResult: M.call(M.any()).returns(),
+    handleError: M.call(M.error()).returns(),
+  }),
+  paymentWatcher: M.interface('paymentWatcher', {
+    onFulfilled: M.call(PaymentPKeywordRecordShape, SeatShape).returns(
+      M.promise(),
+    ),
+    onRejected: M.call(M.any(), SeatShape).returns(),
+  }),
+  resultWatcher: M.interface('resultWatcher', {
+    onFulfilled: M.call(M.any(), SeatShape).returns(),
+    onRejected: M.call(M.any(), SeatShape).returns(),
+  }),
+  numWantsWatcher: M.interface('numWantsWatcher', {
+    onFulfilled: M.call(M.number(), SeatShape).returns(),
+    onRejected: M.call(M.any(), SeatShape).returns(),
+  }),
+});
+
+/**
+ * @param {Baggage} baggage
+ * @param {VowTools} vowTools
+ */
+export const prepareOfferWatcher = (baggage, vowTools) => {
+  const watchForOfferResult = makeWatchForOfferResult(vowTools);
+  return prepareExoClassKit(
+    baggage,
+    'OfferWatcher',
+    offerWatcherGuard,
+    // XXX walletHelper is `any` because the helper facet is too nested to export its type
+    /**
+     * @param {any} walletHelper
+     * @param {{ receive: (payment: Payment) => Promise<Amount> }} deposit
+     * @param {OfferSpec} offerSpec
+     * @param {string} address
+     * @param {Amount<'set'>} invitationAmount
+     * @param {UserSeat} seatRef
+     */
+    (walletHelper, deposit, offerSpec, address, invitationAmount, seatRef) => ({
+      walletHelper,
+      deposit,
+      status: offerSpec,
+      address,
+      invitationAmount,
+      seatRef,
+    }),
+    {
+      helper: {
+        /**
+         * @param {Record<string, unknown>} offerStatusUpdates
+         */
+        updateStatus(offerStatusUpdates) {
+          const { state } = this;
+          state.status = harden({ ...state.status, ...offerStatusUpdates });
+
+          state.walletHelper.updateStatus(state.status);
+        },
+        /**
+         * @param {string} offerId
+         * @param {Amount<'set'>} invitationAmount
+         * @param {import('./types.js').InvitationMakers} invitationMakers
+         * @param {import('./types.js').PublicSubscribers} publicSubscribers
+         */
+        onNewContinuingOffer(
+          offerId,
+          invitationAmount,
+          invitationMakers,
+          publicSubscribers,
+        ) {
+          const { state } = this;
+
+          void state.walletHelper.addContinuingOffer(
+            offerId,
+            invitationAmount,
+            invitationMakers,
+            publicSubscribers,
+          );
+        },
+
+        /** @param {Passable | ContinuingOfferResult} result */
+        publishResult(result) {
+          const { state, facets } = this;
+
+          const passStyle = passStyleOf(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':
+              facets.helper.updateStatus({ result });
+              break;
+            case 'copyRecord':
+              // @ts-expect-error narrowed by passStyle
+              if ('invitationMakers' in result) {
+                // save for continuing invitation offer
+
+                void facets.helper.onNewContinuingOffer(
+                  String(state.status.id),
+                  state.invitationAmount,
+                  // @ts-expect-error narrowed by passStyle
+                  result.invitationMakers,
+                  result.publicSubscribers,
+                );
+              }
+              facets.helper.updateStatus({ result: UNPUBLISHED_RESULT });
+              break;
+            default:
+              // drop the result
+              facets.helper.updateStatus({ result: UNPUBLISHED_RESULT });
+          }
+        },
+        /**
+         * Called when the offer result promise rejects. The other two watchers
+         * are waiting for particular values out of Zoe but they settle at the
+         * same time and don't need their own error handling.
+         *
+         * @param {Error} err
+         */
+        handleError(err) {
+          const { facets } = this;
+          facets.helper.updateStatus({ error: err.toString() });
+          const { seatRef } = this.state;
+          void E.when(E(seatRef).hasExited(), hasExited => {
+            if (!hasExited) {
+              void E(seatRef).tryExit();
+            }
+          });
+        },
+      },
+
+      /** @type {OutcomeWatchers['paymentWatcher']} */
+      paymentWatcher: {
+        async onFulfilled(payouts) {
+          const { state, facets } = this;
+
+          // This will block until all payouts succeed, but user will be updated
+          // since each payout will trigger its corresponding purse notifier.
+          const amountPKeywordRecord = objectMap(payouts, paymentRef =>
+            E.when(paymentRef, payment => state.deposit.receive(payment)),
+          );
+          const amounts = await deeplyFulfilledObject(amountPKeywordRecord);
+          facets.helper.updateStatus({ payouts: amounts });
+        },
+        /**
+         * If promise disconnected, watch again. Or if there's an Error, handle
+         * it.
+         *
+         * @param {Error
+         *   | import('@agoric/internal/src/upgrade-api.js').UpgradeDisconnection} reason
+         * @param {UserSeat} seat
+         */
+        onRejected(reason, seat) {
+          const { facets } = this;
+          if (isUpgradeDisconnection(reason)) {
+            void watchForPayout(facets, seat);
+          } else {
+            facets.helper.handleError(reason);
+          }
+        },
+      },
+
+      /** @type {OutcomeWatchers['resultWatcher']} */
+      resultWatcher: {
+        onFulfilled(result) {
+          const { facets } = this;
+          const { walletHelper } = this.state;
+          const { saveResult } = this.state.status;
+          if (saveResult) {
+            // Note: result is passable and storable since it was received from another vat
+            const name = walletHelper.saveEntry(saveResult, result);
+            facets.helper.updateStatus({
+              result: {
+                name,
+                passStyle: passStyleOf(result),
+              },
+            });
+          } else {
+            facets.helper.publishResult(result);
+          }
+        },
+        /**
+         * If promise disconnected, watch again. Or if there's an Error, handle
+         * it.
+         *
+         * @param {Error
+         *   | import('@agoric/internal/src/upgrade-api.js').UpgradeDisconnection} reason
+         * @param {UserSeat} seat
+         */
+        onRejected(reason, seat) {
+          const { facets } = this;
+          if (isUpgradeDisconnection(reason)) {
+            void watchForOfferResult(facets, seat);
+          } else {
+            facets.helper.handleError(reason);
+          }
+          // throw so the vow watcher propagates the rejection
+          throw reason;
+        },
+      },
+
+      /** @type {OutcomeWatchers['numWantsWatcher']} */
+      numWantsWatcher: {
+        onFulfilled(numSatisfied) {
+          const { facets } = this;
+
+          facets.helper.updateStatus({ numWantsSatisfied: numSatisfied });
+        },
+        /**
+         * If promise disconnected, watch again.
+         *
+         * Errors are handled by the paymentWatcher because numWantsSatisfied()
+         * and getPayouts() settle the same (they await the same promise and
+         * then synchronously return a local value).
+         *
+         * @param {Error
+         *   | import('@agoric/internal/src/upgrade-api.js').UpgradeDisconnection} reason
+         * @param {UserSeat} seat
+         */
+        onRejected(reason, seat) {
+          const { facets } = this;
+          if (isUpgradeDisconnection(reason)) {
+            void watchForNumWants(facets, seat);
+          }
+        },
+      },
+    },
+  );
+};
+harden(prepareOfferWatcher);
+
+/** @typedef {ReturnType<typeof prepareOfferWatcher>} MakeOfferWatcher */
+/** @typedef {ReturnType<MakeOfferWatcher>} OfferWatcher */

package/src/offers.d.ts

@@ -1,51 +1,81 @@
+/**
+ * @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";
-export function makeOfferExecutor({ zoe, depositFacet, invitationIssuer, powers, onStatusChange, onNewContinuingOffer, }: {
-    zoe: ERef<ZoeService>;
-    depositFacet: {
-        receive: (payment: any) => Promise<Amount>;
-    };
-    invitationIssuer: ERef<Issuer<'set'>>;
-    powers: {
-        logger: Pick<Console, 'info' | 'error'>;
-        invitationFromSpec: (spec: import('./invitations').InvitationSpec) => ERef<Invitation>;
-        purseForBrand: (brand: Brand) => Promise<import('./types').RemotePurse>;
-    };
-    onStatusChange: (status: OfferStatus) => void;
-    onNewContinuingOffer: (offerId: string, invitationAmount: Amount<'set'>, invitationMakers: import('./types').RemoteInvitationMakers, publicSubscribers: import('./types').PublicSubscribers | import('@agoric/zoe/src/contractSupport').TopicsRecord) => Promise<void>;
-}): {
+export type OfferId = number | string;
+export type ResultPlan = {
+    /**
+     * by which to save the item
+     */
+    name: string;
     /**
-     * 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()`
+     * whether to overwrite an existing item.
+     * If false and there is a conflict, the contract will autogen a similar
+     * name.
      */
-    executeOffer(offerSpec: OfferSpec, onSeatCreated: (seatRef: UserSeat) => void): Promise<void>;
+    overwrite?: boolean | undefined;
 };
-export type OfferId = number | string;
+export type InvokeEntryMessage = {
+    targetName: string;
+    method: string;
+    args: Passable[];
+    saveResult?: ResultPlan;
+    id?: number | string;
+};
+/**
+ * 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).
+ */
 export type OfferSpec = {
     id: OfferId;
-    invitationSpec: import('./invitations').InvitationSpec;
+    invitationSpec: import("./invitations.js").InvitationSpec;
     proposal: Proposal;
-    offerArgs?: unknown;
+    offerArgs?: any;
+    saveResult?: ResultPlan;
 };
-export type OfferStatus = import('./offers.js').OfferSpec & {
+export type OfferStatus = OfferSpec & {
     error?: string;
     numWantsSatisfied?: number;
-    result?: unknown | typeof UNPUBLISHED_RESULT;
+    result?: unknown | typeof UNPUBLISHED_RESULT | {
+        name: string;
+        passStyle: string;
+    };
     payouts?: AmountKeywordRecord;
 };
+import type { Passable } from '@endo/pass-style';
+import type { Proposal } from '@agoric/zoe';
 //# sourceMappingURL=offers.d.ts.map

package/src/offers.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"offers.d.ts","sourceRoot":"","sources":["offers.js"],"names":[],"mappings":"AAIA;;GAEG;AAEH;;;;;;;GAOG;AAEH,kEAAkE;AAClE,+CAAgD;AAwBzC;SAVI,KAAK,UAAU,CAAC;;mCACW,QAAQ,MAAM,CAAC;;sBAC1C,KAAK,OAAO,KAAK,CAAC,CAAC;;gBAEnB,KAAK,OAAO,EAAE,MAAM,GAAE,OAAO,CAAC;mCACvB,OAAO,eAAe,EAAE,cAAc,KAAK,KAAK,UAAU,CAAC;+BAC1D,KAAK,KAAK,QAAQ,OAAO,SAAS,EAAE,WAAW,CAAC;;6BAC/C,WAAW,KAAK,IAAI;oCACnB,MAAM,oBAAoB,OAAO,KAAK,CAAC,oBAAoB,OAAO,SAAS,EAAE,sBAAsB,qBAAqB,OAAO,SAAS,EAAE,iBAAiB,GAAG,OAAO,iCAAiC,EAAE,YAAY,KAAM,QAAQ,IAAI,CAAC;;IAaxP;;;;;;;OAOG;4BAJQ,SAAS,2BACC,QAAQ,KAAK,IAAI,GACzB,QAAQ,IAAI,CAAC;EA0I7B;sBA/LY,MAAM,GAAG,MAAM;wBAIf;IACZ,EAAM,EAAE,OAAO,CAAC;IAChB,cAAkB,EAAE,OAAO,eAAe,EAAE,cAAc,CAAC;IAC3D,QAAY,EAAE,QAAQ,CAAC;IACvB,SAAa,CAAC,EAAE,OAAO,CAAA;CACpB;0BAOS,OAAO,aAAa,EAAE,SAAS,GAAG;IAC9C,KAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAmB,CAAC,EAAE,MAAM,CAAA;IAC5B,MAAQ,CAAC,EAAE,OAAO,GAAG,yBAAyB,CAAC;IAC/C,OAAS,CAAC,EAAE,mBAAmB,CAAC;CAC7B"}
+{"version":3,"file":"offers.d.ts","sourceRoot":"","sources":["offers.js"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;GAEG;AAEH;;;;;;GAMG;AAEH;;;;;;;;GAQG;AAEH;;;;;;;;;;;GAWG;AAEH,kEAAkE;AAClE,iCAAkC,aAAa,CAAC;sBAnCnC,MAAM,GAAG,MAAM;;;;;UAKd,MAAM;;;;;;;;iCAOP;IACR,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,QAAQ,EAAE,CAAC;IACjB,UAAU,CAAC,EAAE,UAAU,CAAC;IACxB,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;CACtB;;;;;;wBAIS;IACR,EAAE,EAAE,OAAO,CAAC;IACZ,cAAc,EAAE,OAAO,kBAAkB,EAAE,cAAc,CAAC;IAC1D,QAAQ,EAAE,QAAQ,CAAC;IACnB,SAAS,CAAC,EAAE,GAAG,CAAC;IAChB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;0BAUS,SAAS,GAAG;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B,MAAM,CAAC,EACH,OAAO,GACP,OAAO,kBAAkB,GACzB;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IACxC,OAAO,CAAC,EAAE,mBAAmB,CAAC;CAC/B;8BAlDuB,kBAAkB;8BADlB,aAAa"}