@agoric/smart-wallet 0.5.3 → 0.5.4-calypso-dev-84eb287.0

package/src/typeGuards.d.ts

@@ -1,4 +1,4 @@
 export namespace shape {
-    const WalletBridgeMsg: import("@endo/patterns").Matcher;
+    let WalletBridgeMsg: import("@endo/patterns").Matcher;
 }
 //# sourceMappingURL=typeGuards.d.ts.map

package/src/types.d.ts

@@ -5,9 +5,12 @@
  * 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 } from '@endo/far';
 import type { CapData } from '@endo/marshal';
-import type { MsgWalletSpendAction } from '@agoric/cosmic-proto/swingset/msgs';
+import type { agoric } from '@agoric/cosmic-proto';
+import type { AgoricNamesRemotes } from '@agoric/vats/tools/board-utils.js';
+import type { StoredFacet } from '@agoric/internal/src/lib-chainStorage.js';
+import type { OfferSpec } from './offers.js';
 
 declare const CapDataShape: unique symbol;
 
@@ -19,33 +22,33 @@ declare const CapDataShape: unique symbol;
  */
 export type Petname = string | string[];
 
-export type RemotePurse<T = unknown> = FarRef<Purse<T>>;
-
-export type RemoteInvitationMakers = FarRef<
-  Record<string, (...args: any[]) => Promise<Invitation>>
+export type InvitationMakers = Record<
+  string,
+  (...args: any[]) => Promise<Invitation>
 >;
 
 export type PublicSubscribers = Record<string, ERef<StoredFacet>>;
 
+export interface ContinuingOfferResult {
+  invitationMakers: InvitationMakers;
+  publicSubscribers: PublicSubscribers;
+}
+
 export type Cell<T> = {
   get: () => T;
   set(val: T): void;
 };
 
-export type BridgeActionCapData = WalletCapData<
-  import('./smartWallet.js').BridgeAction
->;
-
 /**
  * Defined by walletAction struct in msg_server.go
  *
- * @see {MsgWalletSpendAction} and walletSpendAction in msg_server.go
+ * @see {agoric.swingset.MsgWalletAction} and walletSpendAction in msg_server.go
  */
 export type WalletActionMsg = {
   type: 'WALLET_ACTION';
   /** base64 of Uint8Array of bech32 data  */
   owner: string;
-  /** JSON of BridgeActionCapData */
+  /** JSON of marshalled BridgeAction */
   action: string;
   blockHeight: unknown; // int64
   blockTime: unknown; // int64
@@ -54,7 +57,7 @@ export type WalletActionMsg = {
 /**
  * Defined by walletSpendAction struct in msg_server.go
  *
- * @see {MsgWalletSpendAction} and walletSpendAction in msg_server.go
+ * @see {agoric.swingset.MsgWalletSpendAction} and walletSpendAction in msg_server.go
  */
 export type WalletSpendActionMsg = {
   type: 'WALLET_SPEND_ACTION';
@@ -74,3 +77,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/utils.d.ts

@@ -1,26 +1,29 @@
+/** @import {OfferId, OfferStatus} from './offers.js'; */
 export const NO_SMART_WALLET_ERROR: "no smart wallet";
-export function makeWalletStateCoalescer(invitationBrand?: Brand<"set"> | undefined): {
+export function makeWalletStateCoalescer(invitationBrand?: globalThis.Brand<"set"> | undefined): {
     state: {
-        invitationsReceived: Map<import("./offers").OfferId, {
-            acceptedIn: import('./offers').OfferId;
+        invitationsReceived: Map<OfferId, {
+            acceptedIn: OfferId;
             description: string;
             instance: Instance;
         }>;
-        offerStatuses: Map<import("./offers").OfferId, import("./offers").OfferStatus>;
-        balances: Map<Brand<AssetKind>, Amount<AssetKind>>;
+        offerStatuses: Map<OfferId, OfferStatus>;
+        balances: Map<globalThis.Brand, globalThis.Amount>;
     };
-    update: (updateRecord: import('./smartWallet').UpdateRecord | {}) => void;
+    update: (updateRecord: import("./smartWallet.js").UpdateRecord | {}) => void;
 };
-export function coalesceUpdates(updates: ERef<Subscriber<import('./smartWallet').UpdateRecord>>, invitationBrand?: Brand<"set"> | undefined): {
-    invitationsReceived: Map<import("./offers").OfferId, {
-        acceptedIn: import('./offers').OfferId;
+export function coalesceUpdates(updates: ERef<Subscriber<import("./smartWallet.js").UpdateRecord>>, invitationBrand?: globalThis.Brand<"set"> | undefined): {
+    invitationsReceived: Map<OfferId, {
+        acceptedIn: OfferId;
         description: string;
         instance: Instance;
     }>;
-    offerStatuses: Map<import("./offers").OfferId, import("./offers").OfferStatus>;
-    balances: Map<Brand<AssetKind>, Amount<AssetKind>>;
+    offerStatuses: Map<OfferId, OfferStatus>;
+    balances: Map<globalThis.Brand, globalThis.Amount>;
 };
-export function assertHasData(follower: import('@agoric/casting').Follower<any>): Promise<void>;
-export function objectMapStoragePath(subscribers?: import("@agoric/zoe/src/contractSupport").TopicsRecord | import("./types.js").PublicSubscribers | undefined): ERef<Record<string, string>> | null;
-export type CoalescedWalletState = ReturnType<typeof makeWalletStateCoalescer>['state'];
+export function assertHasData(follower: import("@agoric/casting").Follower<any>): Promise<void>;
+export function objectMapStoragePath(subscribers?: import("@agoric/zoe/src/contractSupport/topics.js").TopicsRecord | import("./types.js").PublicSubscribers | undefined): ERef<Record<string, string>> | null;
+export type CoalescedWalletState = ReturnType<typeof makeWalletStateCoalescer>["state"];
+import type { OfferId } from './offers.js';
+import type { OfferStatus } from './offers.js';
 //# sourceMappingURL=utils.d.ts.map

package/src/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAKA,sDAAuD;AAKhD;;;wBASmD,OAAO,UAAU,EAAE,OAAO;yBAAe,MAAM;sBAAY,QAAQ;;;;;2BAI/G,OAAO,eAAe,EAAE,YAAY,GAAG,EAAE;EA8DtD;AAaM,yCAHI,KAAK,WAAW,OAAO,eAAe,EAAE,YAAY,CAAC,CAAC;;oBA5EP,OAAO,UAAU,EAAE,OAAO;qBAAe,MAAM;kBAAY,QAAQ;;;;EAwF5H;AAMM,wCAHI,OAAO,iBAAiB,EAAE,QAAQ,CAAC,GAAG,CAAC,iBAYjD;AAQM,iKAFM,KAAK,OAAO,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,IAAI,CAW/C;mCArDa,WAAW,+BAA+B,CAAC,CAAC,OAAO,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["utils.js"],"names":[],"mappings":"AAIA,yDAAyD;AAEzD,sDAAuD;AAKhD;;;wBAYc,OAAO;yBACN,MAAM;sBACT,QAAQ;;;;;2BAOd,OAAO,kBAAkB,EAAE,YAAY,GAAG,EAAE;EAgExD;AAaM,yCAHI,IAAI,CAAC,UAAU,CAAC,OAAO,kBAAkB,EAAE,YAAY,CAAC,CAAC;;oBAnF/C,OAAO;qBACN,MAAM;kBACT,QAAQ;;;;EA6F1B;AAMM,wCAHI,OAAO,iBAAiB,EAAE,QAAQ,CAAC,GAAG,CAAC,iBAYjD;AASM,2KAFM,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,GAAG,IAAI,CAW/C;mCAtDa,UAAU,CAAC,OAAO,wBAAwB,CAAC,CAAC,OAAO,CAAC;6BA7F1B,aAAa;iCAAb,aAAa"}

package/src/utils.js

@@ -1,15 +1,16 @@
-/* eslint-disable no-undef-init */
 import { deeplyFulfilledObject, objectMap, makeTracer } from '@agoric/internal';
 import { observeIteration, subscribeEach } from '@agoric/notifier';
 import { E } from '@endo/far';
 
+/** @import {OfferId, OfferStatus} from './offers.js'; */
+
 export const NO_SMART_WALLET_ERROR = 'no smart wallet';
 
 const trace = makeTracer('WUTIL', false);
 
 /** @param {Brand<'set'>} [invitationBrand] */
 export const makeWalletStateCoalescer = (invitationBrand = undefined) => {
-  /** @type {Map<import('./offers').OfferId, import('./offers').OfferStatus>} */
+  /** @type {Map<OfferId, OfferStatus>} */
   const offerStatuses = new Map();
   /** @type {Map<Brand, Amount>} */
   const balances = new Map();
@@ -17,11 +18,21 @@ export const makeWalletStateCoalescer = (invitationBrand = undefined) => {
   /**
    * keyed by description; xxx assumes unique
    *
-   * @type {Map<import('./offers').OfferId, { acceptedIn: import('./offers').OfferId, description: string, instance: Instance }>}
+   * @type {Map<
+   *   OfferId,
+   *   {
+   *     acceptedIn: OfferId;
+   *     description: string;
+   *     instance: Instance;
+   *   }
+   * >}
    */
   const invitationsReceived = new Map();
 
-  /** @param {import('./smartWallet').UpdateRecord | {}} updateRecord newer than previous */
+  /**
+   * @param {import('./smartWallet.js').UpdateRecord | {}} updateRecord newer
+   *   than previous
+   */
   const update = updateRecord => {
     if (!('updated' in updateRecord)) {
       return;
@@ -93,7 +104,7 @@ export const makeWalletStateCoalescer = (invitationBrand = undefined) => {
  * If this proves to be a problem we can add an option to this or a related
  * utility to reset state from RPC.
  *
- * @param {ERef<Subscriber<import('./smartWallet').UpdateRecord>>} updates
+ * @param {ERef<Subscriber<import('./smartWallet.js').UpdateRecord>>} updates
  * @param {Brand<'set'>} [invitationBrand]
  */
 export const coalesceUpdates = (updates, invitationBrand) => {
@@ -125,7 +136,8 @@ export const assertHasData = async follower => {
 /**
  * Handles the case of falsy argument so the caller can consistently await.
  *
- * @param {import('./types.js').PublicSubscribers | import('@agoric/zoe/src/contractSupport').TopicsRecord} [subscribers]
+ * @param {import('./types.js').PublicSubscribers
+ *   | import('@agoric/zoe/src/contractSupport/index.js').TopicsRecord} [subscribers]
  * @returns {ERef<Record<string, string>> | null}
  */
 export const objectMapStoragePath = subscribers => {

package/src/walletFactory.d.ts

@@ -1,10 +1,10 @@
-export const privateArgsShape: import("@endo/patterns").Matcher;
 export namespace customTermsShape {
-    const agoricNames: any;
-    const board: any;
-    const assetPublisher: any;
+    let agoricNames: globalThis.Pattern;
+    let board: globalThis.Pattern;
+    let assetPublisher: globalThis.Pattern;
 }
-export function publishDepositFacet(address: string, wallet: import('./smartWallet.js').SmartWallet, namesByAddressAdmin: ERef<import('@agoric/vats').NameAdmin>): Promise<unknown>;
+export const privateArgsShape: import("@endo/patterns").Matcher;
+export function publishDepositFacet(address: string, wallet: import("./smartWallet.js").SmartWallet, namesByAddressAdmin: ERef<import("@agoric/vats").NameAdmin>): Promise<unknown>;
 export function makeAssetRegistry(assetPublisher: AssetPublisher): {
     /** @param {Brand} brand */
     has: (brand: Brand) => boolean;
@@ -13,100 +13,47 @@ export function makeAssetRegistry(assetPublisher: AssetPublisher): {
         brand: Brand;
         displayInfo: DisplayInfo;
         issuer: Issuer;
-        petname: import('./types').Petname;
+        petname: import("./types.js").Petname;
     };
     values: () => Iterable<{
         brand: Brand;
         displayInfo: DisplayInfo;
         issuer: Issuer;
-        petname: import('./types').Petname;
+        petname: import("./types.js").Petname;
     }>;
 };
 export function prepare(zcf: ZCF<SmartWalletContractTerms>, privateArgs: {
     storageNode: ERef<StorageNode>;
-    walletBridgeManager?: ERef<import("@agoric/vats").ScopedBridgeManager> | undefined;
-    walletReviver?: ERef<WalletReviver> | undefined;
-}, baggage: MapStore<string, unknown>): Promise<{
-    creatorFacet: {
-        /**
-         * @param {string} address
-         * @param {ERef<import('@agoric/vats/src/vat-bank').Bank>} bank
-         * @param {ERef<import('@agoric/vats/').NameAdmin>} namesByAddressAdmin
-         * @returns {Promise<[wallet: import('./smartWallet').SmartWallet, isNew: boolean]>} wallet
-         *   along with a flag to distinguish between looking up an existing wallet
-         *   and creating a new one.
-         */
-        provideSmartWallet(address: string, bank: ERef<import('@agoric/vats/src/vat-bank').Bank>, namesByAddressAdmin: ERef<import('@agoric/vats/').NameAdmin>): Promise<[wallet: {
-            handleBridgeAction(actionCapData: import("@endo/marshal").CapData<string>, canSpend?: boolean | undefined): Promise<void>;
-            getDepositFacet(): {
-                receive(payment: import("@endo/far").FarRef<Payment<AssetKind>, import("@endo/eventual-send").DataOnly<Payment<AssetKind>>>): Promise<Amount<AssetKind>>;
-            };
-            getOffersFacet(): {
-                executeOffer(offerSpec: import("./offers.js").OfferSpec): Promise<void>;
-                tryExitOffer(offerId: import("./offers.js").OfferId): Promise<void>;
-            };
-            getCurrentSubscriber(): Subscriber<import("./smartWallet.js").CurrentWalletRecord>;
-            getUpdatesSubscriber(): Subscriber<import("./smartWallet.js").UpdateRecord>;
-            getPublicTopics(): {
-                current: {
-                    description: string;
-                    subscriber: Subscriber<import("./smartWallet.js").CurrentWalletRecord>;
-                    storagePath: Promise<string>;
-                };
-                updates: {
-                    description: string;
-                    subscriber: Subscriber<import("./smartWallet.js").UpdateRecord>;
-                    storagePath: Promise<string>;
-                };
-            };
-        }, isNew: boolean]>;
-    } & import("@endo/eventual-send").RemotableBrand<{}, {
+    walletBridgeManager?: ERef<import("@agoric/vats").ScopedBridgeManager<"wallet">>;
+    walletReviver?: ERef<WalletReviver>;
+}, baggage: import("@agoric/vat-data").Baggage): Promise<{
+    creatorFacet: import("@endo/exo").Guarded<{
         /**
          * @param {string} address
-         * @param {ERef<import('@agoric/vats/src/vat-bank').Bank>} bank
-         * @param {ERef<import('@agoric/vats/').NameAdmin>} namesByAddressAdmin
-         * @returns {Promise<[wallet: import('./smartWallet').SmartWallet, isNew: boolean]>} wallet
-         *   along with a flag to distinguish between looking up an existing wallet
-         *   and creating a new one.
+         * @param {ERef<import('@agoric/vats/src/vat-bank.js').Bank>} bank
+         * @param {ERef<import('@agoric/vats/src/types.js').NameAdmin>} namesByAddressAdmin
+         * @returns {Promise<
+         *   [wallet: import('./smartWallet.js').SmartWallet, isNew: boolean]
+         * >}
+         *   wallet along with a flag to distinguish between looking up an existing
+         *   wallet and creating a new one.
          */
-        provideSmartWallet(address: string, bank: ERef<import('@agoric/vats/src/vat-bank').Bank>, namesByAddressAdmin: ERef<import('@agoric/vats/').NameAdmin>): Promise<[wallet: {
-            handleBridgeAction(actionCapData: import("@endo/marshal").CapData<string>, canSpend?: boolean | undefined): Promise<void>;
-            getDepositFacet(): {
-                receive(payment: import("@endo/far").FarRef<Payment<AssetKind>, import("@endo/eventual-send").DataOnly<Payment<AssetKind>>>): Promise<Amount<AssetKind>>;
-            };
-            getOffersFacet(): {
-                executeOffer(offerSpec: import("./offers.js").OfferSpec): Promise<void>;
-                tryExitOffer(offerId: import("./offers.js").OfferId): Promise<void>;
-            };
-            getCurrentSubscriber(): Subscriber<import("./smartWallet.js").CurrentWalletRecord>;
-            getUpdatesSubscriber(): Subscriber<import("./smartWallet.js").UpdateRecord>;
-            getPublicTopics(): {
-                current: {
-                    description: string;
-                    subscriber: Subscriber<import("./smartWallet.js").CurrentWalletRecord>;
-                    storagePath: Promise<string>;
-                };
-                updates: {
-                    description: string;
-                    subscriber: Subscriber<import("./smartWallet.js").UpdateRecord>;
-                    storagePath: Promise<string>;
-                };
-            };
-        }, isNew: boolean]>;
+        provideSmartWallet(address: string, bank: ERef<import("@agoric/vats/src/vat-bank.js").Bank>, namesByAddressAdmin: ERef<import("@agoric/vats/src/types.js").NameAdmin>): Promise<[wallet: import("./smartWallet.js").SmartWallet, isNew: boolean]>;
     }>;
 }>;
 export type SmartWalletContractTerms = {
     agoricNames: ERef<NameHub>;
-    board: ERef<import('@agoric/vats').Board>;
+    board: ERef<import("@agoric/vats").Board>;
     assetPublisher: AssetPublisher;
 };
-export type NameHub = import('@agoric/vats').NameHub;
 export type AssetPublisher = {
-    getAssetSubscription: () => ERef<IterableEachTopic<import('@agoric/vats/src/vat-bank').AssetDescriptor>>;
+    getAssetSubscription: () => ERef<IterableEachTopic<import("@agoric/vats/src/vat-bank.js").AssetDescriptor>>;
 };
-export type isRevive = boolean;
+export type IsRevive = boolean;
 export type WalletReviver = {
-    reviveWallet: (address: string) => Promise<import('./smartWallet').SmartWallet>;
-    ackWallet: (address: string) => isRevive;
+    reviveWallet: (address: string) => Promise<import("./smartWallet.js").SmartWallet>;
+    ackWallet: (address: string) => IsRevive;
 };
+export type start = typeof prepare;
+import type { NameHub } from '@agoric/vats';
 //# sourceMappingURL=walletFactory.d.ts.map

package/src/walletFactory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletFactory.d.ts","sourceRoot":"","sources":["walletFactory.js"],"names":[],"mappings":"AAkBA,gEAKE;;;;;;AAgBK,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;;;;;QAgH7B;;;;;;;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;;;;;;;;;;;;;;;;;;;;;;;;;GAgDvD;uCA7LY;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"}
+{"version":3,"file":"walletFactory.d.ts","sourceRoot":"","sources":["walletFactory.js"],"names":[],"mappings":";;;;;AA6BA,gEAKE;AAaK,6CAJI,MAAM,UACN,OAAO,kBAAkB,EAAE,WAAW,uBACtC,IAAI,CAAC,OAAO,cAAc,EAAE,SAAS,CAAC,oBAehD;AAWM,kDAFI,cAAc;IAyCrB,2BAA2B;iBAAf,KAAK;IAEjB,2BAA2B;iBAAf,KAAK;eArCP,KAAK;qBACC,WAAW;gBAChB,MAAM;iBACL,OAAO,YAAY,EAAE,OAAO;;;eAH9B,KAAK;qBACC,WAAW;gBAChB,MAAM;iBACL,OAAO,YAAY,EAAE,OAAO;;EAuC3C;AAyCM,6BAVI,GAAG,CAAC,wBAAwB,CAAC,eAC7B;IACV,WAAe,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;IACnC,mBAAuB,CAAC,EAAE,IAAI,CAC9B,OAAa,cAAc,EAAE,mBAAmB,CAAC,QAAQ,CAAC,CACrD,CAAC;IACN,aAAiB,CAAC,EAAE,IAAI,CAAC,aAAa,CAAC,CAAC;CACrC,WACO,OAAO,kBAAkB,EAAE,OAAO;;QA2IvC;;;;;;;;;WASG;oCARQ,MAAM,QACN,IAAI,CAAC,OAAO,8BAA8B,EAAE,IAAI,CAAC,uBACjD,IAAI,CAAC,OAAO,2BAA2B,EAAE,SAAS,CAAC,GACjD,OAAO,CACnB,CAAK,MAAM,EAAE,OAAO,kBAAkB,EAAE,WAAW,EAAE,KAAK,EAAE,OAAO,CAAC,CACjE;;GAuDT;uCA5OY;IACZ,WAAe,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;IAC/B,KAAS,EAAE,IAAI,CAAC,OAAO,cAAc,EAAE,KAAK,CAAC,CAAC;IAC9C,cAAkB,EAAE,cAAc,CAAC;CAChC;6BAGS;IACZ,oBAAwB,EAAE,MAAM,IAAI,CACpC,iBAAuB,CAAC,OAAO,8BAA8B,EAAE,eAAe,CAAC,CAC1E,CAAC;CACH;uBAGS,OAAO;4BAEP;IACZ,YAAgB,EAAE,CAClB,OAAa,EAAE,MAAM,KACZ,OAAO,CAAC,OAAO,kBAAkB,EAAE,WAAW,CAAC,CAAC;IACzD,SAAa,EAAE,CAAC,OAAO,EAAE,MAAM,KAAK,QAAQ,CAAC;CAC1C;oBA4NU,OAAO,OAAO;6BAtVD,cAAc"}

package/src/walletFactory.js

@@ -1,7 +1,10 @@
 /**
  * @file Wallet Factory
  *
- * Contract to make smart wallets.
+ *   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';
@@ -14,8 +17,16 @@ import { E } from '@endo/far';
 import { prepareSmartWallet } from './smartWallet.js';
 import { shape } from './typeGuards.js';
 
+/** @import {NameHub} from '@agoric/vats'; */
+
 const trace = makeTracer('WltFct');
 
+export const customTermsShape = harden({
+  agoricNames: M.eref(M.remotable('agoricNames')),
+  board: M.eref(M.remotable('board')),
+  assetPublisher: M.eref(M.remotable('Bank')),
+});
+
 export const privateArgsShape = harden(
   M.splitRecord(
     { storageNode: M.eref(M.remotable('StorageNode')) },
@@ -23,11 +34,8 @@ export const privateArgsShape = harden(
   ),
 );
 
-export const customTermsShape = harden({
-  agoricNames: M.eref(M.remotable('agoricNames')),
-  board: M.eref(M.remotable('board')),
-  assetPublisher: M.eref(M.remotable('Bank')),
-});
+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
@@ -56,8 +64,8 @@ export const publishDepositFacet = async (
  * Make a registry for use by the wallet instances.
  *
  * This doesn't need to persist durably because the `assetPublisher` has a
- * "pinned" topic and call to getAssetSubscription gets a fresh stream of all the
- * assets that it knows of.
+ * "pinned" topic and call to getAssetSubscription gets a fresh stream of all
+ * the assets that it knows of.
  *
  * @param {AssetPublisher} assetPublisher
  */
@@ -65,12 +73,13 @@ export const makeAssetRegistry = assetPublisher => {
   trace('makeAssetRegistry', assetPublisher);
   /**
    * @typedef {{
-   *   brand: Brand,
-   *   displayInfo: DisplayInfo,
-   *   issuer: Issuer,
-   *   petname: import('./types').Petname
+   *   brand: Brand;
+   *   displayInfo: DisplayInfo;
+   *   issuer: Issuer;
+   *   petname: import('./types.js').Petname;
    * }} BrandDescriptor
-   * For use by clients to describe brands to users. Includes `displayInfo` to save a remote call.
+   *   For use by clients to describe brands to users. Includes `displayInfo` to
+   *   save a remote call.
    */
   /** @type {MapStore<Brand, BrandDescriptor>} */
   const brandDescriptors = makeScalarMapStore();
@@ -110,45 +119,52 @@ export const makeAssetRegistry = assetPublisher => {
 
 /**
  * @typedef {{
- *   agoricNames: ERef<NameHub>,
- *   board: ERef<import('@agoric/vats').Board>,
- *   assetPublisher: AssetPublisher,
+ *   agoricNames: ERef<NameHub>;
+ *   board: ERef<import('@agoric/vats').Board>;
+ *   assetPublisher: AssetPublisher;
  * }} SmartWalletContractTerms
  *
- * @typedef {import('@agoric/vats').NameHub} NameHub
  *
  * @typedef {{
  *   getAssetSubscription: () => ERef<
- *     IterableEachTopic<import('@agoric/vats/src/vat-bank').AssetDescriptor>>
+ *     IterableEachTopic<import('@agoric/vats/src/vat-bank.js').AssetDescriptor>
+ *   >;
  * }} AssetPublisher
  *
- * @typedef {boolean} isRevive
+ *
+ * @typedef {boolean} IsRevive
+ *
  * @typedef {{
- *   reviveWallet: (address: string) => Promise<import('./smartWallet').SmartWallet>,
- *   ackWallet: (address: string) => isRevive,
+ *   reviveWallet: (
+ *     address: string,
+ *   ) => Promise<import('./smartWallet.js').SmartWallet>;
+ *   ackWallet: (address: string) => IsRevive;
  * }} 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
 /**
  * @param {ZCF<SmartWalletContractTerms>} zcf
  * @param {{
- *   storageNode: ERef<StorageNode>,
- *   walletBridgeManager?: ERef<import('@agoric/vats').ScopedBridgeManager>,
- *   walletReviver?: ERef<WalletReviver>,
+ *   storageNode: ERef<StorageNode>;
+ *   walletBridgeManager?: ERef<
+ *     import('@agoric/vats').ScopedBridgeManager<'wallet'>
+ *   >;
+ *   walletReviver?: ERef<WalletReviver>;
  * }} privateArgs
  * @param {import('@agoric/vat-data').Baggage} baggage
  */
 export const prepare = async (zcf, privateArgs, baggage) => {
+  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(
@@ -160,17 +176,20 @@ export const prepare = async (zcf, privateArgs, baggage) => {
       /**
        * Designed to be called by the bridgeManager vat.
        *
-       * If this errors before calling handleBridgeAction(), the failure will not be observable. The
-       * promise does reject, but as of now bridge manager drops instead of handling it. Eventually
-       * we'll make the bridge able to give feedback about the requesting transaction. Meanwhile we
-       * could write the error to chainStorage but we don't have a guarantee of the wallet owner to
-       * associate it with. (We could have a shared `lastError` node but it would be so noisy as to
-       * not provide much info to the end user.)
+       * If this errors before calling handleBridgeAction(), the failure will
+       * not be observable. The promise does reject, but as of now bridge
+       * manager drops instead of handling it. Eventually we'll make the bridge
+       * able to give feedback about the requesting transaction. Meanwhile we
+       * could write the error to chainStorage but we don't have a guarantee of
+       * the wallet owner to associate it with. (We could have a shared
+       * `lastError` node but it would be so noisy as to not provide much info
+       * to the end user.)
        *
-       * Once the owner is known, this calls handleBridgeAction which ensures that all errors
-       * are published in the owner wallet's vstorage path.
+       * Once the owner is known, this calls handleBridgeAction which ensures
+       * that all errors are published in the owner wallet's vstorage path.
        *
-       * @param {import('./types.js').WalletBridgeMsg} obj validated by shape.WalletBridgeMsg
+       * @param {import('./types.js').WalletBridgeMsg} obj validated by
+       *   shape.WalletBridgeMsg
        * @returns {Promise<void>}
        */
       fromBridge: async obj => {
@@ -219,6 +238,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,
@@ -227,15 +255,33 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     publicMarshaller,
     registry,
     zoe,
+    secretWalletFactoryKey: upgradeToIncarnation2Key,
   });
 
   /**
    * Holders of this object:
+   *
    * - vat (transitively from holding the wallet factory)
    * - wallet-ui (which has key material; dapps use wallet-ui to propose actions)
    */
   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',
@@ -249,16 +295,22 @@ export const prepare = async (zcf, privateArgs, baggage) => {
     {
       /**
        * @param {string} address
-       * @param {ERef<import('@agoric/vats/src/vat-bank').Bank>} bank
-       * @param {ERef<import('@agoric/vats/').NameAdmin>} namesByAddressAdmin
-       * @returns {Promise<[wallet: import('./smartWallet').SmartWallet, isNew: boolean]>} wallet
-       *   along with a flag to distinguish between looking up an existing wallet
-       *   and creating a new one.
+       * @param {ERef<import('@agoric/vats/src/vat-bank.js').Bank>} bank
+       * @param {ERef<import('@agoric/vats/src/types.js').NameAdmin>} namesByAddressAdmin
+       * @returns {Promise<
+       *   [wallet: import('./smartWallet.js').SmartWallet, isNew: boolean]
+       * >}
+       *   wallet along with a flag to distinguish between looking up an existing
+       *   wallet and creating a new one.
        */
       provideSmartWallet(address, bank, namesByAddressAdmin) {
         let isNew = false;
 
-        /** @type {(address: string) => Promise<import('./smartWallet').SmartWallet>} */
+        /**
+         * @type {(
+         *   address: string,
+         * ) => Promise<import('./smartWallet.js').SmartWallet>}
+         */
         const maker = async _address => {
           const invitationPurse = await E(invitationIssuer).makeEmptyPurse();
           const walletStorageNode = E(storageNode).makeChildNode(address);
@@ -292,10 +344,19 @@ export const prepare = async (zcf, privateArgs, baggage) => {
   if (walletBridgeManager) {
     // NB: may not be in service when creatorFacet is used, or ever
     // It can't be awaited because that fails vat restart
-    void E(walletBridgeManager).initHandler(handleWalletAction);
+    if (upgrading) {
+      void E(walletBridgeManager).setHandler(handleWalletAction);
+    } else {
+      void E(walletBridgeManager).initHandler(handleWalletAction);
+    }
   }
 
   return {
     creatorFacet,
   };
 };
+harden(prepare);
+
+// So we can consistently import `start` from contracts.
+// Can't be a value export because Zoe enforces that contracts export one or the other.
+/** @typedef {typeof prepare} start */