@agoric/smart-wallet 0.5.4-u12.0 → 0.5.4-upgrade-14-dev-0a0580c.0

package/src/types.d.ts

@@ -5,9 +5,11 @@
  * Downside is it can't reference any ambient types, which most of agoric-sdk type are presently.
  */
 
-import { ERef, FarRef } from '@endo/far';
+import type { ERef, FarRef } from '@endo/far';
 import type { CapData } from '@endo/marshal';
 import type { MsgWalletSpendAction } from '@agoric/cosmic-proto/swingset/msgs';
+import type { AgoricNamesRemotes } from '@agoric/vats/tools/board-utils.js';
+import type { OfferSpec } from './offers.js';
 
 declare const CapDataShape: unique symbol;
 
@@ -74,3 +76,11 @@ export type WalletSpendActionMsg = {
  * the sending of the message (as is the case for WALLET_SPEND_ACTION).
  */
 export type WalletBridgeMsg = WalletActionMsg | WalletSpendActionMsg;
+
+/**
+ * Used for clientSupport helpers
+ */
+export type OfferMaker = (
+  agoricNames: AgoricNamesRemotes,
+  ...rest: any[]
+) => OfferSpec;

package/src/walletFactory.d.ts

@@ -42,8 +42,8 @@ export function prepare(zcf: ZCF<SmartWalletContractTerms>, privateArgs: {
                 receive(payment: Payment<AssetKind>): Promise<Amount<AssetKind>>;
             };
             getOffersFacet(): {
-                executeOffer(offerSpec: import("./offers.js").OfferSpec): Promise<void>;
-                tryExitOffer(offerId: import("./offers.js").OfferId): Promise<void>;
+                executeOffer(offerSpec: import("./smartWallet.js").OfferSpec): Promise<void>;
+                tryExitOffer(offerId: import("./smartWallet.js").OfferId): Promise<void>;
             };
             getCurrentSubscriber(): Subscriber<import("./smartWallet.js").CurrentWalletRecord>;
             getUpdatesSubscriber(): Subscriber<import("./smartWallet.js").UpdateRecord>;
@@ -59,6 +59,7 @@ export function prepare(zcf: ZCF<SmartWalletContractTerms>, privateArgs: {
                     storagePath: Promise<string>;
                 };
             };
+            repairWalletForIncarnation2(key: any): void;
         }, isNew: boolean]>;
     } & import("@endo/eventual-send").RemotableBrand<{}, {
         /**
@@ -75,8 +76,8 @@ export function prepare(zcf: ZCF<SmartWalletContractTerms>, privateArgs: {
                 receive(payment: Payment<AssetKind>): Promise<Amount<AssetKind>>;
             };
             getOffersFacet(): {
-                executeOffer(offerSpec: import("./offers.js").OfferSpec): Promise<void>;
-                tryExitOffer(offerId: import("./offers.js").OfferId): Promise<void>;
+                executeOffer(offerSpec: import("./smartWallet.js").OfferSpec): Promise<void>;
+                tryExitOffer(offerId: import("./smartWallet.js").OfferId): Promise<void>;
             };
             getCurrentSubscriber(): Subscriber<import("./smartWallet.js").CurrentWalletRecord>;
             getUpdatesSubscriber(): Subscriber<import("./smartWallet.js").UpdateRecord>;
@@ -92,6 +93,7 @@ export function prepare(zcf: ZCF<SmartWalletContractTerms>, privateArgs: {
                     storagePath: Promise<string>;
                 };
             };
+            repairWalletForIncarnation2(key: any): void;
         }, isNew: boolean]>;
     }>;
 }>;

package/src/walletFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletFactory.d.ts","sourceRoot":"","sources":["walletFactory.js"],"names":[],"mappings":";;;;;AAwBA,gEAKE;AAUK,6CAJI,MAAM,UACN,OAAO,kBAAkB,EAAE,WAAW,uBACtC,KAAK,OAAO,cAAc,EAAE,SAAS,CAAC,oBAehD;AAWM,kDAFI,cAAc;IAwCrB,2BAA2B;iBAAf,KAAK;IAEjB,2BAA2B;iBAAf,KAAK;eApCP,KAAK;qBACC,WAAW;gBAChB,MAAM;iBACL,OAAO,SAAS,EAAE,OAAO;;;eAH3B,KAAK;qBACC,WAAW;gBAChB,MAAM;iBACL,OAAO,SAAS,EAAE,OAAO;;EAsCxC;AAmCM,6BARI,IAAI,wBAAwB,CAAC;iBAEtB,KAAK,WAAW,CAAC;;;;;QAiH7B;;;;;;;WAOG;oCANQ,MAAM,QACN,KAAK,OAAO,2BAA2B,EAAE,IAAI,CAAC,uBAC9C,KAAK,OAAO,eAAe,EAAE,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;QAHlD;;;;;;;WAOG;oCANQ,MAAM,QACN,KAAK,OAAO,2BAA2B,EAAE,IAAI,CAAC,uBAC9C,KAAK,OAAO,eAAe,EAAE,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;GAoDvD;uCAlMY;IACZ,WAAe,EAAE,KAAK,OAAO,CAAC,CAAC;IAC/B,KAAS,EAAE,KAAK,OAAO,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9C,cAAkB,EAAE,cAAc,CAAC;CAChC;sBAES,OAAO,cAAc,EAAE,OAAO;6BAE9B;IACZ,oBAAwB,EAAE,MAAM,KAChC,kBAAwB,OAAO,2BAA2B,EAAE,eAAe,CAAC,CAAC,CAAA;CAC1E;uBAES,OAAO;;4BAES,MAAM,KAAK,QAAQ,OAAO,eAAe,EAAE,WAAW,CAAC;yBAC1D,MAAM,KAAK,QAAQ;;oBAuL/B,cAAc"}
+{"version":3,"file":"walletFactory.d.ts","sourceRoot":"","sources":["walletFactory.js"],"names":[],"mappings":";;;;;AA2BA,gEAKE;AAaK,6CAJI,MAAM,UACN,OAAO,kBAAkB,EAAE,WAAW,uBACtC,KAAK,OAAO,cAAc,EAAE,SAAS,CAAC,oBAehD;AAWM,kDAFI,cAAc;IAwCrB,2BAA2B;iBAAf,KAAK;IAEjB,2BAA2B;iBAAf,KAAK;eApCP,KAAK;qBACC,WAAW;gBAChB,MAAM;iBACL,OAAO,SAAS,EAAE,OAAO;;;eAH3B,KAAK;qBACC,WAAW;gBAChB,MAAM;iBACL,OAAO,SAAS,EAAE,OAAO;;EAsCxC;AAmCM,6BARI,IAAI,wBAAwB,CAAC;iBAEtB,KAAK,WAAW,CAAC;;;;;QA2I7B;;;;;;;WAOG;oCANQ,MAAM,QACN,KAAK,OAAO,2BAA2B,EAAE,IAAI,CAAC,uBAC9C,KAAK,OAAO,eAAe,EAAE,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;QAHlD;;;;;;;WAOG;oCANQ,MAAM,QACN,KAAK,OAAO,2BAA2B,EAAE,IAAI,CAAC,uBAC9C,KAAK,OAAO,eAAe,EAAE,SAAS,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDvD;uCA5NY;IACZ,WAAe,EAAE,KAAK,OAAO,CAAC,CAAC;IAC/B,KAAS,EAAE,KAAK,OAAO,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9C,cAAkB,EAAE,cAAc,CAAC;CAChC;sBAES,OAAO,cAAc,EAAE,OAAO;6BAE9B;IACZ,oBAAwB,EAAE,MAAM,KAChC,kBAAwB,OAAO,2BAA2B,EAAE,eAAe,CAAC,CAAC,CAAA;CAC1E;uBAES,OAAO;;4BAES,MAAM,KAAK,QAAQ,OAAO,eAAe,EAAE,WAAW,CAAC;yBAC1D,MAAM,KAAK,QAAQ;;oBAiN/B,cAAc"}

package/src/walletFactory.js

@@ -2,6 +2,9 @@
  * @file Wallet Factory
  *
  * Contract to make smart wallets.
+ *
+ * Note: The upgrade test uses a slightly modified copy of this file. When the
+ * interface changes here, that will also need to change.
  */
 
 import { makeTracer, WalletName } from '@agoric/internal';
@@ -29,6 +32,9 @@ export const privateArgsShape = harden(
   ),
 );
 
+const WALLETS_BY_ADDRESS = 'walletsByAddress';
+const UPGRADE_TO_INCARNATION_TWO = 'upgrade to incarnation two';
+
 /**
  * Provide a NameHub for this address and insert depositFacet only if not
  * already done.
@@ -129,7 +135,7 @@ export const makeAssetRegistry = assetPublisher => {
  * }} WalletReviver
  */
 
-// NB: even though all the wallets share this contract, they
+// NB: even though all the wallets share this contract,
 // 1. they should not rely on that; they may be partitioned later
 // 2. they should never be able to detect behaviors from another wallet
 /**
@@ -142,14 +148,14 @@ export const makeAssetRegistry = assetPublisher => {
  * @param {import('@agoric/vat-data').Baggage} baggage
  */
 export const prepare = async (zcf, privateArgs, baggage) => {
-  const upgrading = baggage.has('walletsByAddress');
+  const upgrading = baggage.has(WALLETS_BY_ADDRESS);
   const { agoricNames, board, assetPublisher } = zcf.getTerms();
 
   const zoe = zcf.getZoeService();
   const { storageNode, walletBridgeManager, walletReviver } = privateArgs;
 
   /** @type {MapStore<string, import('./smartWallet.js').SmartWallet>} */
-  const walletsByAddress = provideDurableMapStore(baggage, 'walletsByAddress');
+  const walletsByAddress = provideDurableMapStore(baggage, WALLETS_BY_ADDRESS);
   const provider = makeAtomicProvider(walletsByAddress);
 
   const handleWalletAction = makeExo(
@@ -220,6 +226,15 @@ export const prepare = async (zcf, privateArgs, baggage) => {
 
   const registry = makeAssetRegistry(assetPublisher);
 
+  /**
+   * An object known only to walletFactory and smartWallets. The WalletFactory
+   * only has the self facet for the pre-existing wallets that must be repaired.
+   * Self is too accessible, so use of the repair function requires use of a
+   * secret that clients won't have. This can be removed once the upgrade has
+   * taken place.
+   */
+  const upgradeToIncarnation2Key = harden({});
+
   const shared = harden({
     agoricNames,
     invitationBrand,
@@ -228,6 +243,7 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     publicMarshaller,
     registry,
     zoe,
+    secretWalletFactoryKey: upgradeToIncarnation2Key,
   });
 
   /**
@@ -237,6 +253,22 @@ export const prepare = async (zcf, privateArgs, baggage) => {
    */
   const makeSmartWallet = prepareSmartWallet(baggage, shared);
 
+  // One time repair for incarnation 2. We're adding WatchedPromises to allow
+  // wallets to durably monitor offer outcomes, but wallets that already exist
+  // need to be backfilled. This code needs to run once at the beginning of
+  // incarnation 2, and then shouldn't be needed again.
+  if (!baggage.has(UPGRADE_TO_INCARNATION_TWO)) {
+    trace('Wallet Factory upgrading to incarnation 2');
+
+    // This could take a while, depending on how many outstanding wallets exist.
+    // The current plan is that it will run exactly once, and inside an upgrade
+    // handler, between blocks.
+    for (const wallet of walletsByAddress.values()) {
+      wallet.repairWalletForIncarnation2(upgradeToIncarnation2Key);
+    }
+    baggage.init(UPGRADE_TO_INCARNATION_TWO, 'done');
+  }
+
   const creatorFacet = prepareExo(
     baggage,
     'walletFactoryCreator',

package/src/payments.d.ts

@@ -1,20 +0,0 @@
-export function makePaymentsHelper(purseForBrand: (brand: Brand) => Promise<import('./types').RemotePurse>, depositFacet: {
-    receive: (payment: any) => Promise<Amount>;
-}): {
-    /**
-     * @param {AmountKeywordRecord} give
-     * @returns {PaymentPKeywordRecord}
-     */
-    withdrawGive(give: AmountKeywordRecord): PaymentPKeywordRecord;
-    /**
-     * Try reclaiming any of our payments that we successfully withdrew, but
-     * were left unclaimed.
-     */
-    tryReclaimingWithdrawnPayments(): Promise<undefined> | Promise<PromiseSettledResult<Amount<unknown> | undefined>[]>;
-    /**
-     * @param {PaymentPKeywordRecord} payouts
-     * @returns {Promise<AmountKeywordRecord>} amounts for deferred deposits will be empty
-     */
-    depositPayouts(payouts: PaymentPKeywordRecord): Promise<AmountKeywordRecord>;
-};
-//# sourceMappingURL=payments.d.ts.map

package/src/payments.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"payments.d.ts","sourceRoot":"","sources":["payments.js"],"names":[],"mappings":"AAUO,0DAHY,KAAK,KAAK,QAAQ,OAAO,SAAS,EAAE,WAAW,CAAC;+BAC7B,QAAQ,MAAM,CAAC;;IAcjD;;;OAGG;uBAFQ,mBAAmB,GACjB,qBAAqB;IAkBlC;;;OAGG;;IA8BH;;;OAGG;4BAFQ,qBAAqB,GACnB,QAAQ,mBAAmB,CAAC;EAU5C"}

package/src/payments.js

@@ -1,89 +0,0 @@
-import { Fail } from '@agoric/assert';
-import { deeplyFulfilledObject, objectMap } from '@agoric/internal';
-import { E } from '@endo/far';
-
-/**
- * Used in an offer execution to manage payments state safely.
- *
- * @param {(brand: Brand) => Promise<import('./types').RemotePurse>} purseForBrand
- * @param {{ receive: (payment: *) => Promise<Amount> }} depositFacet
- */
-export const makePaymentsHelper = (purseForBrand, depositFacet) => {
-  /** @type {PaymentPKeywordRecord | null} */
-  let keywordPaymentPromises = null;
-
-  /**
-   * Tracks from whence our payment came.
-   *
-   * @type {Map<Payment, import('./types').RemotePurse>}
-   */
-  const paymentToPurse = new Map();
-
-  return {
-    /**
-     * @param {AmountKeywordRecord} give
-     * @returns {PaymentPKeywordRecord}
-     */
-    withdrawGive(give) {
-      !keywordPaymentPromises ||
-        Fail`withdrawPayments can be called once per helper`;
-      keywordPaymentPromises = objectMap(give, amount => {
-        /** @type {Promise<import('./types').RemotePurse<any>>} */
-        const purseP = purseForBrand(amount.brand);
-        return Promise.all([purseP, E(purseP).withdraw(amount)]).then(
-          ([purse, payment]) => {
-            paymentToPurse.set(payment, purse);
-            return payment;
-          },
-        );
-      });
-      return keywordPaymentPromises;
-    },
-
-    /**
-     * Try reclaiming any of our payments that we successfully withdrew, but
-     * were left unclaimed.
-     */
-    tryReclaimingWithdrawnPayments() {
-      if (!keywordPaymentPromises) return Promise.resolve(undefined);
-      const paymentPromises = Object.values(keywordPaymentPromises);
-      // Use allSettled to ensure we attempt all the deposits, regardless of
-      // individual rejections.
-      return Promise.allSettled(
-        paymentPromises.map(async paymentP => {
-          // Wait for the withdrawal to complete.  This protects against a race
-          // when updating paymentToPurse.
-          const payment = await paymentP;
-
-          // Find out where it came from.
-          const purse = paymentToPurse.get(payment);
-          if (purse === undefined) {
-            // We already tried to reclaim this payment, so stop here.
-            return undefined;
-          }
-
-          // Now send it back to the purse.
-          try {
-            return E(purse).deposit(payment);
-          } finally {
-            // Once we've called addPayment, mark this one as done.
-            paymentToPurse.delete(payment);
-          }
-        }),
-      );
-    },
-
-    /**
-     * @param {PaymentPKeywordRecord} payouts
-     * @returns {Promise<AmountKeywordRecord>} amounts for deferred deposits will be empty
-     */
-    async depositPayouts(payouts) {
-      /** Record<string, Promise<Amount>> */
-      const amountPKeywordRecord = objectMap(payouts, paymentRef =>
-        E.when(paymentRef, payment => depositFacet.receive(payment)),
-      );
-      return deeplyFulfilledObject(amountPKeywordRecord);
-    },
-  };
-};
-harden(makePaymentsHelper);