-
Notifications
You must be signed in to change notification settings - Fork 206
/
offers.js
196 lines (177 loc) · 6.65 KB
/
offers.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
import { E, passStyleOf } from '@endo/far';
import { deeplyFulfilledObject } from '@agoric/internal';
import { makePaymentsHelper } from './payments.js';
/**
* @typedef {number | string} OfferId
*/
/**
* @typedef {{
* id: OfferId,
* invitationSpec: import('./invitations').InvitationSpec,
* proposal: Proposal,
* offerArgs?: unknown
* }} OfferSpec
*/
/** 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,
* }} 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<Purse>} opts.powers.purseForBrand
* @param {(status: OfferStatus) => void} opts.onStatusChange
* @param {(offerId: string, invitationAmount: Amount<'set'>, invitationMakers: import('./types').InvitationMakers, 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.
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);