-
Notifications
You must be signed in to change notification settings - Fork 206
/
smartWallet.js
775 lines (722 loc) · 27 KB
/
smartWallet.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
import {
AmountShape,
BrandShape,
DisplayInfoShape,
IssuerShape,
PaymentShape,
PurseShape,
} from '@agoric/ertp';
import { StorageNodeShape, makeTracer } from '@agoric/internal';
import { observeNotifier } from '@agoric/notifier';
import { M, mustMatch } from '@agoric/store';
import {
appendToStoredArray,
provideLazy,
} from '@agoric/store/src/stores/store-utils.js';
import {
makeScalarBigMapStore,
makeScalarBigWeakMapStore,
prepareExoClassKit,
provide,
} from '@agoric/vat-data';
import {
SubscriberShape,
TopicsRecordShape,
prepareRecorderKit,
} from '@agoric/zoe/src/contractSupport/index.js';
import { E } from '@endo/far';
import { makeInvitationsHelper } from './invitations.js';
import { makeOfferExecutor } from './offers.js';
import { shape } from './typeGuards.js';
import { objectMapStoragePath } from './utils.js';
const { Fail, quote: q } = assert;
const trace = makeTracer('SmrtWlt');
/**
* @file Smart wallet module
*
* @see {@link ../README.md}}
*/
/**
* @typedef {{
* method: 'executeOffer'
* offer: import('./offers.js').OfferSpec,
* }} ExecuteOfferAction
*/
/**
* @typedef {{
* method: 'tryExitOffer'
* offerId: import('./offers.js').OfferId,
* }} TryExitOfferAction
*/
// Discriminated union. Possible future messages types:
// maybe suggestIssuer for https://github.com/Agoric/agoric-sdk/issues/6132
// setting petnames and adding brands for https://github.com/Agoric/agoric-sdk/issues/6126
/**
* @typedef { ExecuteOfferAction | TryExitOfferAction } BridgeAction
*/
/**
* Purses is an array to support a future requirement of multiple purses per brand.
*
* Each map is encoded as an array of entries because a Map doesn't serialize directly.
* We also considered having a vstorage key for each offer but for now are sticking with this design.
*
* Cons
* - Reserializes previously written results when a new result is added
* - Optimizes reads though writes are on-chain (~100 machines) and reads are off-chain (to 1 machine)
*
* Pros
* - Reading all offer results happens much more (>100) often than storing a new offer result
* - Reserialization and writes are paid in execution gas, whereas reads are not
*
* This design should be revisited if ever batch querying across vstorage keys become cheaper or reads be paid.
*
* @typedef {{
* purses: Array<{brand: Brand, balance: Amount}>,
* offerToUsedInvitation: Array<[ offerId: string, usedInvitation: Amount ]>,
* offerToPublicSubscriberPaths: Array<[ offerId: string, publicTopics: { [subscriberName: string]: string } ]>,
* liveOffers: Array<[import('./offers.js').OfferId, import('./offers.js').OfferStatus]>,
* }} CurrentWalletRecord
*/
/**
* @typedef {{ updated: 'offerStatus', status: import('./offers.js').OfferStatus }
* | { updated: 'balance'; currentAmount: Amount }
* | { updated: 'walletAction'; status: { error: string } }
* } UpdateRecord Record of an update to the state of this wallet.
*
* Client is responsible for coalescing updates into a current state. See `coalesceUpdates` utility.
*
* The reason for this burden on the client is that publishing
* the full history of offers with each change is untenable.
*
* `balance` update supports forward-compatibility for more than one purse per
* brand. An additional key will be needed to disambiguate. For now the brand in
* the amount suffices.
*/
/**
* @typedef {{
* brand: Brand,
* displayInfo: DisplayInfo,
* issuer: Issuer,
* petname: import('./types').Petname
* }} BrandDescriptor
* For use by clients to describe brands to users. Includes `displayInfo` to save a remote call.
*/
/**
* @typedef {{
* address: string,
* bank: ERef<import('@agoric/vats/src/vat-bank').Bank>,
* currentStorageNode: StorageNode,
* invitationPurse: Purse<'set'>,
* walletStorageNode: StorageNode,
* }} UniqueParams
*
* @typedef {Pick<MapStore<Brand, BrandDescriptor>, 'has' | 'get' | 'values'>} BrandDescriptorRegistry
* @typedef {{
* agoricNames: ERef<import('@agoric/vats').NameHub>,
* registry: BrandDescriptorRegistry,
* invitationIssuer: Issuer<'set'>,
* invitationBrand: Brand<'set'>,
* invitationDisplayInfo: DisplayInfo,
* publicMarshaller: Marshaller,
* zoe: ERef<ZoeService>,
* }} SharedParams
*
* @typedef {ImmutableState & MutableState} State
* - `brandPurses` is precious and closely held. defined as late as possible to reduce its scope.
* - `offerToInvitationMakers` is precious and closely held.
* - `offerToPublicSubscriberPaths` is precious and closely held.
* - `purseBalances` is a cache of what we've received from purses. Held so we can publish all balances on change.
*
* @typedef {Readonly<UniqueParams & {
* paymentQueues: MapStore<Brand, Array<Payment>>,
* offerToInvitationMakers: MapStore<string, import('./types').InvitationMakers>,
* offerToPublicSubscriberPaths: MapStore<string, Record<string, string>>,
* offerToUsedInvitation: MapStore<string, Amount>,
* purseBalances: MapStore<Purse, Amount>,
* updateRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<UpdateRecord>,
* currentRecorderKit: import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<CurrentWalletRecord>,
* liveOffers: MapStore<import('./offers.js').OfferId, import('./offers.js').OfferStatus>,
* liveOfferSeats: WeakMapStore<import('./offers.js').OfferId, UserSeat<unknown>>,
* }>} ImmutableState
*
* @typedef {BrandDescriptor & { purse: Purse }} PurseRecord
* @typedef {{
* }} MutableState
*/
/**
* NameHub reverse-lookup, finding 0 or more names for a target value
*
* TODO: consider moving to nameHub.js?
*
* @param {unknown} target - passable Key
* @param {ERef<import('@agoric/vats').NameHub>} nameHub
*/
const namesOf = async (target, nameHub) => {
const entries = await E(nameHub).entries();
const matches = [];
for (const [name, candidate] of entries) {
if (candidate === target) {
matches.push(name);
}
}
return harden(matches);
};
/**
* Check that an issuer and its brand belong to each other.
*
* TODO: move to ERTP?
*
* @param {Issuer} issuer
* @param {Brand} brand
* @returns {Promise<boolean>} true iff the the brand and issuer match
*/
const checkMutual = (issuer, brand) =>
Promise.all([
E(issuer)
.getBrand()
.then(b => b === brand),
E(brand).isMyIssuer(issuer),
]).then(checks => checks.every(Boolean));
export const BRAND_TO_PURSES_KEY = 'brandToPurses';
const getBrandToPurses = (walletPurses, key) => {
const brandToPurses = provideLazy(walletPurses, key, _k => {
/** @type {MapStore<Brand, PurseRecord[]>} */
const store = makeScalarBigMapStore('purses by brand', {
durable: true,
});
return store;
});
return brandToPurses;
};
/**
* @param {import('@agoric/vat-data').Baggage} baggage
* @param {SharedParams} shared
*/
export const prepareSmartWallet = (baggage, shared) => {
const { registry: _r, ...passableShared } = shared;
mustMatch(
harden(passableShared),
harden({
agoricNames: M.eref(M.remotable('agoricNames')),
invitationIssuer: IssuerShape,
invitationBrand: BrandShape,
invitationDisplayInfo: DisplayInfoShape,
publicMarshaller: M.remotable('Marshaller'),
zoe: M.eref(M.remotable('ZoeService')),
}),
);
const makeRecorderKit = prepareRecorderKit(baggage, shared.publicMarshaller);
const walletPurses = provide(baggage, BRAND_TO_PURSES_KEY, () => {
trace('make purses by wallet and save in baggage at', BRAND_TO_PURSES_KEY);
/** @type {WeakMapStore<unknown, MapStore<Brand, PurseRecord[]>>} */
const store = makeScalarBigWeakMapStore('purses by wallet', {
durable: true,
});
return store;
});
/**
*
* @param {UniqueParams} unique
* @returns {State}
*/
const initState = unique => {
// Some validation of inputs.
mustMatch(
unique,
harden({
address: M.string(),
bank: M.eref(M.remotable()),
invitationPurse: PurseShape,
currentStorageNode: M.eref(StorageNodeShape),
walletStorageNode: M.eref(StorageNodeShape),
}),
);
const preciousState = {
// Payments that couldn't be deposited when received.
// NB: vulnerable to uncapped growth by unpermissioned deposits.
paymentQueues: makeScalarBigMapStore('payments queues', {
durable: true,
}),
// Invitation amounts to save for persistent lookup
offerToUsedInvitation: makeScalarBigMapStore(
'invitation amounts by offer',
{
durable: true,
},
),
// Invitation makers yielded by offer results
offerToInvitationMakers: makeScalarBigMapStore(
'invitation makers by offer',
{
durable: true,
},
),
// Public subscribers yielded by offer results
offerToPublicSubscriberPaths: makeScalarBigMapStore(
'public subscribers by offer',
{
durable: true,
},
),
};
/** @type {import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<UpdateRecord>} */
const updateRecorderKit = makeRecorderKit(unique.walletStorageNode);
// NB: state size must not grow monotonically
// This is the node that UIs subscribe to for everything they need.
// e.g. agoric follow :published.wallet.agoric1nqxg4pye30n3trct0hf7dclcwfxz8au84hr3ht
/** @type {import('@agoric/zoe/src/contractSupport/recorder.js').RecorderKit<CurrentWalletRecord>} */
const currentRecorderKit = makeRecorderKit(unique.currentStorageNode);
const nonpreciousState = {
// What purses have reported on construction and by getCurrentAmountNotifier updates.
purseBalances: makeScalarBigMapStore('purse balances', { durable: true }),
updateRecorderKit,
currentRecorderKit,
liveOffers: makeScalarBigMapStore('live offers', { durable: true }),
// Keep seats separate from the offers because we don't want to publish these.
liveOfferSeats: makeScalarBigMapStore('live offer seats', {
durable: true,
}),
};
return {
...unique,
...nonpreciousState,
...preciousState,
};
};
const behaviorGuards = {
helper: M.interface('helperFacetI', {
assertUniqueOfferId: M.call(M.string()).returns(),
updateBalance: M.call(PurseShape, AmountShape).optional('init').returns(),
getPurseIfKnownBrand: M.call(BrandShape)
.optional(M.eref(M.remotable()))
.returns(M.promise()),
publishCurrentState: M.call().returns(),
watchPurse: M.call(M.eref(PurseShape)).returns(M.promise()),
}),
deposit: M.interface('depositFacetI', {
receive: M.callWhen(M.await(M.eref(PaymentShape))).returns(AmountShape),
}),
offers: M.interface('offers facet', {
executeOffer: M.call(shape.OfferSpec).returns(M.promise()),
tryExitOffer: M.call(M.scalar()).returns(M.promise()),
}),
self: M.interface('selfFacetI', {
handleBridgeAction: M.call(shape.StringCapData, M.boolean()).returns(
M.promise(),
),
getDepositFacet: M.call().returns(M.remotable()),
getOffersFacet: M.call().returns(M.remotable()),
getCurrentSubscriber: M.call().returns(SubscriberShape),
getUpdatesSubscriber: M.call().returns(SubscriberShape),
getPublicTopics: M.call().returns(TopicsRecordShape),
}),
};
/**
* Make the durable object to return, but taking some parameters that are awaited by a wrapping function.
* This is necessary because the class kit construction helpers, `initState` and `finish` run synchronously
* and the child storage node must be awaited until we have durable promises.
*/
const makeWalletWithResolvedStorageNodes = prepareExoClassKit(
baggage,
'SmartWallet',
behaviorGuards,
initState,
{
helper: {
/**
* Assert this ID is unique with respect to what has been stored. The
* wallet doesn't store every offer ID but the offers for which it
* doesn't are unlikely to be impacted by re-use.
*
* @type {(id: string) => void}
*/
assertUniqueOfferId(id) {
const {
liveOffers,
liveOfferSeats,
offerToInvitationMakers,
offerToPublicSubscriberPaths,
offerToUsedInvitation,
} = this.state;
const used =
liveOffers.has(id) ||
liveOfferSeats.has(id) ||
offerToInvitationMakers.has(id) ||
offerToPublicSubscriberPaths.has(id) ||
offerToUsedInvitation.has(id);
!used || Fail`cannot re-use offer id ${id}`;
},
/**
* @param {Purse} purse
* @param {Amount<any>} balance
*/
updateBalance(purse, balance) {
const { purseBalances, updateRecorderKit } = this.state;
if (purseBalances.has(purse)) {
purseBalances.set(purse, balance);
} else {
purseBalances.init(purse, balance);
}
void updateRecorderKit.recorder.write({
updated: 'balance',
currentAmount: balance,
});
const { helper } = this.facets;
helper.publishCurrentState();
},
publishCurrentState() {
const {
currentRecorderKit,
offerToUsedInvitation,
offerToPublicSubscriberPaths,
purseBalances,
liveOffers,
} = this.state;
void currentRecorderKit.recorder.write({
purses: [...purseBalances.values()].map(a => ({
brand: a.brand,
balance: a,
})),
offerToUsedInvitation: [...offerToUsedInvitation.entries()],
offerToPublicSubscriberPaths: [
...offerToPublicSubscriberPaths.entries(),
],
liveOffers: [...liveOffers.entries()],
});
},
/** @type {(purse: ERef<Purse>) => Promise<void>} */
async watchPurse(purseRef) {
const { address } = this.state;
const purse = await purseRef; // promises don't fit in durable storage
const { helper } = this.facets;
// publish purse's balance and changes
void E.when(
E(purse).getCurrentAmount(),
balance => helper.updateBalance(purse, balance),
err =>
console.error(
address,
'initial purse balance publish failed',
err,
),
);
void observeNotifier(E(purse).getCurrentAmountNotifier(), {
updateState(balance) {
helper.updateBalance(purse, balance);
},
fail(reason) {
console.error(address, `failed updateState observer`, reason);
},
});
},
/**
* Provide a purse given a NameHub of issuers and their
* brands.
*
* We current support only one NameHub, agoricNames, and
* hence one purse per brand. But we store an array of them
* to facilitate a transition to decentralized introductions.
*
* @param {Brand} brand
* @param {ERef<import('@agoric/vats').NameHub>} known - namehub with brand, issuer branches
* @returns {Promise<Purse | undefined>} undefined if brand is not known
*/
async getPurseIfKnownBrand(brand, known) {
const { helper, self } = this.facets;
const brandToPurses = getBrandToPurses(walletPurses, self);
if (brandToPurses.has(brand)) {
const purses = brandToPurses.get(brand);
if (purses.length > 0) {
// UNTIL https://github.com/Agoric/agoric-sdk/issues/6126
// multiple purses
return purses[0].purse;
}
}
const found = await namesOf(brand, E(known).lookup('brand'));
if (found.length === 0) {
return undefined;
}
const [edgeName] = found;
const issuer = await E(known).lookup('issuer', edgeName);
// Even though we rely on this nameHub, double-check
// that the issuer and the brand belong to each other.
if (!(await checkMutual(issuer, brand))) {
// if they don't, it's not a "known" brand in a coherent way
return undefined;
}
// Accept the issuer; rely on it in future offers.
const [displayInfo, purse] = await Promise.all([
E(issuer).getDisplayInfo(),
E(issuer).makeEmptyPurse(),
]);
// adopt edgeName as petname
// NOTE: for decentralized introductions, qualify edgename by nameHub petname
const petname = edgeName;
const assetInfo = { petname, brand, issuer, purse, displayInfo };
appendToStoredArray(brandToPurses, brand, assetInfo);
// NOTE: when we decentralize introduction of issuers,
// process queued payments for this brand.
void helper.watchPurse(purse);
return purse;
},
},
/**
* Similar to {DepositFacet} but async because it has to look up the purse.
*/
deposit: {
/**
* Put the assets from the payment into the appropriate purse.
*
* If the purse doesn't exist, we hold the payment in durable storage.
*
* @param {Payment} payment
* @returns {Promise<Amount>}
* @throws if there's not yet a purse, though the payment is held to try again when there is
*/
async receive(payment) {
const { helper } = this.facets;
const { paymentQueues: queues, bank, invitationPurse } = this.state;
const { registry, invitationBrand } = shared;
const brand = await E(payment).getAllegedBrand();
// When there is a purse deposit into it
if (registry.has(brand)) {
const purse = E(bank).getPurse(brand);
return E(purse).deposit(payment);
} else if (invitationBrand === brand) {
// @ts-expect-error narrow assetKind to 'set'
return E(invitationPurse).deposit(payment);
}
const purse = await helper.getPurseIfKnownBrand(
brand,
shared.agoricNames,
);
if (purse) {
return E(purse).deposit(payment);
}
// When there is no purse, save the payment into a queue.
// It's not yet ever read but a future version of the contract can
appendToStoredArray(queues, brand, payment);
throw Fail`cannot deposit payment with brand ${brand}: no purse`;
},
},
offers: {
/**
* Take an offer description provided in capData, augment it with payments and call zoe.offer()
*
* @param {import('./offers.js').OfferSpec} offerSpec
* @returns {Promise<void>} after the offer has been both seated and exited by Zoe.
* @throws if any parts of the offer can be determined synchronously to be invalid
*/
async executeOffer(offerSpec) {
const { facets, state } = this;
const {
address,
bank,
invitationPurse,
offerToInvitationMakers,
offerToUsedInvitation,
offerToPublicSubscriberPaths,
updateRecorderKit,
} = this.state;
const { invitationBrand, zoe, invitationIssuer, registry } = shared;
facets.helper.assertUniqueOfferId(String(offerSpec.id));
const logger = {
info: (...args) => console.info('wallet', address, ...args),
error: (...args) => console.error('wallet', address, ...args),
};
const executor = makeOfferExecutor({
zoe,
depositFacet: facets.deposit,
invitationIssuer,
powers: {
invitationFromSpec: makeInvitationsHelper(
zoe,
shared.agoricNames,
invitationBrand,
invitationPurse,
offerToInvitationMakers.get,
),
/**
* @param {Brand} brand
* @returns {Promise<Purse>}
*/
purseForBrand: async brand => {
const { helper } = facets;
if (registry.has(brand)) {
// @ts-expect-error virtual purse
return E(bank).getPurse(brand);
} else if (invitationBrand === brand) {
return invitationPurse;
}
const purse = await helper.getPurseIfKnownBrand(
brand,
shared.agoricNames,
);
if (purse) {
return purse;
}
throw Fail`cannot find/make purse for ${brand}`;
},
logger,
},
onStatusChange: offerStatus => {
logger.info('offerStatus', offerStatus);
void updateRecorderKit.recorder.write({
updated: 'offerStatus',
status: offerStatus,
});
const isSeatExited = 'numWantsSatisfied' in offerStatus;
if (isSeatExited) {
if (state.liveOfferSeats.has(offerStatus.id)) {
state.liveOfferSeats.delete(offerStatus.id);
}
if (state.liveOffers.has(offerStatus.id)) {
state.liveOffers.delete(offerStatus.id);
facets.helper.publishCurrentState();
}
}
},
/** @type {(offerId: string, invitationAmount: Amount<'set'>, invitationMakers: import('./types').InvitationMakers, publicSubscribers?: import('./types').PublicSubscribers | import('@agoric/zoe/src/contractSupport').TopicsRecord) => Promise<void>} */
onNewContinuingOffer: async (
offerId,
invitationAmount,
invitationMakers,
publicSubscribers,
) => {
offerToUsedInvitation.init(offerId, invitationAmount);
offerToInvitationMakers.init(offerId, invitationMakers);
const pathMap = await objectMapStoragePath(publicSubscribers);
if (pathMap) {
logger.info('recording pathMap', pathMap);
offerToPublicSubscriberPaths.init(offerId, pathMap);
}
facets.helper.publishCurrentState();
},
});
return executor.executeOffer(offerSpec, seatRef => {
state.liveOffers.init(offerSpec.id, offerSpec);
facets.helper.publishCurrentState();
state.liveOfferSeats.init(offerSpec.id, seatRef);
});
},
/**
* Take an offer's id, look up its seat, try to exit.
*
* @param {import('./offers.js').OfferId} offerId
* @returns {Promise<void>}
* @throws if the seat can't be found or E(seatRef).tryExit() fails.
*/
async tryExitOffer(offerId) {
const seatRef = this.state.liveOfferSeats.get(offerId);
await E(seatRef).tryExit();
},
},
self: {
/**
* Umarshals the actionCapData and delegates to the appropriate action handler.
*
* @param {import('@endo/marshal').CapData<string>} actionCapData of type BridgeAction
* @param {boolean} [canSpend]
* @returns {Promise<void>}
*/
handleBridgeAction(actionCapData, canSpend = false) {
const { publicMarshaller } = shared;
const { offers } = this.facets;
/** @param {Error} err */
const recordError = err => {
const { address, updateRecorderKit } = this.state;
console.error('wallet', address, 'handleBridgeAction error:', err);
void updateRecorderKit.recorder.write({
updated: 'walletAction',
status: { error: err.message },
});
};
// use E.when to retain distributed stack trace
return E.when(
E(publicMarshaller).fromCapData(actionCapData),
/** @param {BridgeAction} action */
action => {
try {
switch (action.method) {
case 'executeOffer': {
canSpend || Fail`executeOffer requires spend authority`;
return offers.executeOffer(action.offer);
}
case 'tryExitOffer': {
assert(canSpend, 'tryExitOffer requires spend authority');
return offers.tryExitOffer(action.offerId);
}
default: {
throw Fail`invalid handle bridge action ${q(action)}`;
}
}
} catch (err) {
// record synchronous error in the action delegator above
// but leave async rejections alone because the offer handler recorded them
// with greater detail
recordError(err);
}
},
// record errors in the unserialize and leave the rejection handled
recordError,
);
},
getDepositFacet() {
return this.facets.deposit;
},
getOffersFacet() {
return this.facets.offers;
},
/** @deprecated use getPublicTopics */
getCurrentSubscriber() {
return this.state.currentRecorderKit.subscriber;
},
/** @deprecated use getPublicTopics */
getUpdatesSubscriber() {
return this.state.updateRecorderKit.subscriber;
},
getPublicTopics() {
const { currentRecorderKit, updateRecorderKit } = this.state;
return harden({
current: {
description: 'Current state of wallet',
subscriber: currentRecorderKit.subscriber,
storagePath: currentRecorderKit.recorder.getStoragePath(),
},
updates: {
description: 'Changes to wallet',
subscriber: updateRecorderKit.subscriber,
storagePath: updateRecorderKit.recorder.getStoragePath(),
},
});
},
},
},
{
finish: ({ state, facets }) => {
const { invitationPurse } = state;
const { helper } = facets;
void helper.watchPurse(invitationPurse);
},
},
);
/**
* @param {Omit<UniqueParams, 'currentStorageNode' | 'walletStorageNode'> & {walletStorageNode: ERef<StorageNode>}} uniqueWithoutChildNodes
*/
const makeSmartWallet = async uniqueWithoutChildNodes => {
const [walletStorageNode, currentStorageNode] = await Promise.all([
uniqueWithoutChildNodes.walletStorageNode,
E(uniqueWithoutChildNodes.walletStorageNode).makeChildNode('current'),
]);
return makeWalletWithResolvedStorageNodes(
harden({
...uniqueWithoutChildNodes,
currentStorageNode,
walletStorageNode,
}),
).self;
};
return makeSmartWallet;
};
harden(prepareSmartWallet);
/** @typedef {Awaited<ReturnType<ReturnType<typeof prepareSmartWallet>>>} SmartWallet */