-
Notifications
You must be signed in to change notification settings - Fork 206
/
zcfZygote.js
514 lines (461 loc) · 17.1 KB
/
zcfZygote.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
/* eslint @typescript-eslint/no-floating-promises: "warn" */
import { AssetKind } from '@agoric/ertp';
import { assertPattern, mustMatch } from '@agoric/store';
import {
canBeDurable,
M,
makeScalarBigMapStore,
prepareExo,
prepareExoClass,
provideDurableMapStore,
} from '@agoric/vat-data';
import { E } from '@endo/eventual-send';
import { passStyleOf, Remotable } from '@endo/marshal';
import { makePromiseKit } from '@endo/promise-kit';
import { objectMap } from '@agoric/internal';
import { cleanProposal } from '../cleanProposal.js';
import { handlePKitWarning } from '../handleWarning.js';
import { makeInstanceRecordStorage } from '../instanceRecordStorage.js';
import { provideIssuerStorage } from '../issuerStorage.js';
import { defineDurableHandle } from '../makeHandle.js';
import { evalContractBundle } from './evalContractCode.js';
import { makeMakeExiter } from './exit.js';
import { makeOfferHandlerStorage } from './offerHandlerStorage.js';
import { createSeatManager } from './zcfSeat.js';
import { HandleOfferI, InvitationHandleShape } from '../typeGuards.js';
import { prepareZcMint } from './zcfMint.js';
/// <reference path="../internal-types.js" />
/// <reference path="./internal-types.js" />
/** @import {IssuerOptionsRecord} from '@agoric/ertp' */
const { Fail } = assert;
/**
* Make the ZCF vat in zygote-usable form. First, a generic ZCF is
* made, then the contract code is evaluated, then a particular
* instance is made.
*
* @param {VatPowers} powers
* @param {ERef<ZoeService>} zoeService
* @param {Issuer<'set'>} invitationIssuer
* @param {TestJigSetter} testJigSetter
* @param {BundleCap} contractBundleCap
* @param {import('@agoric/vat-data').Baggage} zcfBaggage
* @returns {Promise<ZCFZygote>}
*/
export const makeZCFZygote = async (
powers,
zoeService,
invitationIssuer,
testJigSetter,
contractBundleCap,
zcfBaggage = makeScalarBigMapStore('zcfBaggage', { durable: true }),
) => {
const makeSeatHandle = defineDurableHandle(zcfBaggage, 'Seat');
/** @type {ERef<ZoeInstanceAdmin>} */
let zoeInstanceAdmin;
let seatManager;
let instanceRecHolder;
const makeExiter = makeMakeExiter(zcfBaggage);
/** @type {() => InstanceState} */
const getInstanceRecHolder = () => {
instanceRecHolder || Fail`instanceRecord must be initialized before use.`;
return instanceRecHolder;
};
const {
storeIssuerRecord,
getAssetKindByBrand,
getBrandForIssuer,
getIssuerForBrand,
instantiate: instantiateIssuerStorage,
} = provideIssuerStorage(zcfBaggage);
/** @type {import('@agoric/swingset-vat').ShutdownWithFailure} */
const shutdownWithFailure = reason => {
void E(zoeInstanceAdmin).failAllSeats(reason);
seatManager.dropAllReferences();
// https://github.com/Agoric/agoric-sdk/issues/3239
powers.exitVatWithFailure(reason);
};
const { storeOfferHandler, takeOfferHandler } =
makeOfferHandlerStorage(zcfBaggage);
// Make the instanceRecord
const makeInstanceRecord = makeInstanceRecordStorage(zcfBaggage);
/**
* @param {string} keyword
* @param {IssuerRecord} issuerRecord
*/
const recordIssuer = (keyword, issuerRecord) => {
getInstanceRecHolder().addIssuer(keyword, issuerRecord);
storeIssuerRecord(issuerRecord);
};
const makeEmptySeatKit = (exit = undefined) => {
const initialAllocation = harden({});
const proposal = cleanProposal(harden({ exit }), getAssetKindByBrand);
const userSeatPromiseKit = makePromiseKit();
handlePKitWarning(userSeatPromiseKit);
const seatHandle = makeSeatHandle();
const seatData = harden({
proposal,
initialAllocation,
seatHandle,
});
const zcfSeat = seatManager.makeZCFSeat(seatData);
const exiter = makeExiter(seatData.proposal, zcfSeat);
void E(zoeInstanceAdmin)
.makeNoEscrowSeat(initialAllocation, proposal, exiter, seatHandle)
.then(userSeat => userSeatPromiseKit.resolve(userSeat));
return { zcfSeat, userSeat: userSeatPromiseKit.promise };
};
/** @type {ReturnType<typeof prepareZcMint>} */
let makeZcMint;
/**
* @template {AssetKind} [K='nat']
* @param {Keyword} keyword
* @param {K} [assetKind]
* @param {AdditionalDisplayInfo} [displayInfo]
* @param {IssuerOptionsRecord} [options]
* @returns {Promise<ZCFMint<K>>}
*/
const makeZCFMint = async (
keyword,
// @ts-expect-error possible different subtype
assetKind = AssetKind.NAT,
displayInfo = undefined,
options = undefined,
) => {
getInstanceRecHolder().assertUniqueKeyword(keyword);
/** @type {Promise<ZoeMint<K>>} */
// @ts-expect-error cast, XXX AssetKind generic
const zoeMint = E(zoeInstanceAdmin).makeZoeMint(
keyword,
assetKind,
displayInfo,
options,
);
return makeZcMint(keyword, zoeMint);
};
/** @type {ZCFRegisterFeeMint} */
const registerFeeMint = async (keyword, feeMintAccess) => {
getInstanceRecHolder().assertUniqueKeyword(keyword);
const zoeMint = E(zoeInstanceAdmin).registerFeeMint(keyword, feeMintAccess);
return makeZcMint(keyword, zoeMint);
};
const HandleOfferShape = M.remotable('HandleOffer');
// handleOfferObject gives Zoe the ability to notify ZCF when a new seat is
// added in offer(). ZCF responds with the exitObj and offerResult.
const makeHandleOfferObj = prepareExoClass(
zcfBaggage,
'handleOfferObj',
HandleOfferI,
offerHandlerTaker => ({ offerHandlerTaker }),
{
handleOffer(invitationHandle, seatData) {
const { state } = this;
const zcfSeat = seatManager.makeZCFSeat(seatData);
// TODO: provide a details that's a better diagnostic for the
// ephemeral offerHandler that did not survive upgrade.
const offerHandler = state.offerHandlerTaker.take(invitationHandle);
const offerResultP =
typeof offerHandler === 'function'
? E(offerHandler)(zcfSeat, seatData.offerArgs)
: E(offerHandler).handle(zcfSeat, seatData.offerArgs);
const offerResultPromise = offerResultP.catch(reason => {
if (reason === undefined) {
const newErr = Error(
`If an offerHandler throws, it must provide a reason of type Error, but the reason was undefined. Please fix the contract code to specify a reason for throwing.`,
);
throw zcfSeat.fail(newErr);
}
throw zcfSeat.fail(reason);
});
const exiter = makeExiter(seatData.proposal, zcfSeat);
/** @type {HandleOfferResult} */
return harden({ offerResultPromise, exitObj: exiter });
},
},
);
const HandleOfferFunctionShape = M.remotable('HandleOfferFunction');
const OfferHandlerShape = M.or(HandleOfferShape, HandleOfferFunctionShape);
const TakerI = M.interface('offer handler taker', {
take: M.call(InvitationHandleShape)
.optional(M.string())
.returns(OfferHandlerShape),
});
const taker = prepareExo(zcfBaggage, 'offer handler taker', TakerI, {
take: takeOfferHandler,
});
const handleOfferObj = makeHandleOfferObj(taker);
/**
* @type {() => Promise<
* | {
* buildRootObject: any;
* start: undefined;
* meta: undefined;
* }
* | {
* prepare: ContractStartFn;
* customTermsShape?: Pick<ContractMeta, 'customTermsShape'>,
* privateArgsShape?: Pick<ContractMeta, 'privateArgsShape'>,
* }
* | {
* buildRootObject: undefined;
* start: ContractStartFn;
* meta?: ContractMeta;
* }
* >}
*/
const evaluateContract = () => {
let bundle;
if (passStyleOf(contractBundleCap) === 'remotable') {
const bundleCap = contractBundleCap;
// @ts-expect-error vatPowers is not typed correctly: https://github.com/Agoric/agoric-sdk/issues/3239
bundle = powers.D(bundleCap).getBundle();
} else {
bundle = contractBundleCap;
}
return evalContractBundle(bundle);
};
// evaluate the contract (either the first version, or an upgrade)
const bundleResult = await evaluateContract();
//#region backwards compatibility with prepare()
const { start, meta = {} } = (() => {
if ('prepare' in bundleResult) {
if ('start' in bundleResult) {
Fail`contract must provide exactly one of "start" and "prepare"`;
}
// A contract must have one expression of upgradability
if (/** @type {any} */ (bundleResult).meta?.upgradability) {
Fail`prepare() is deprecated and incompatible with the 'upgradability' indicator`;
}
return {
start: bundleResult.prepare,
meta: {
upgradability: 'canUpgrade',
customTermsShape: bundleResult.customTermsShape,
privateArgsShape: bundleResult.privateArgsShape,
},
};
}
// normal behavior
return bundleResult;
})();
//#endregion
if (start === undefined) {
if ('buildRootObject' in bundleResult) {
// diagnose a common mistake
throw Fail`Did you provide a vat bundle instead of a contract bundle?`;
}
throw Fail`contract exports missing start`;
}
start.length <= 3 || Fail`invalid start parameters`;
const durabilityRequired =
meta.upgradability &&
['canBeUpgraded', 'canUpgrade'].includes(meta.upgradability);
/** @type {ZCF} */
// Using Remotable rather than Far because there are too many complications
// imposing checking wrappers: makeInvitation() and setJig() want to
// accept raw functions. assert cannot be a valid passable! (It's a function
// and has members.)
const zcf = Remotable('Alleged: zcf', undefined, {
atomicRearrange: transfers => seatManager.atomicRearrange(transfers),
reallocate: (...seats) => seatManager.reallocate(...seats),
assertUniqueKeyword: kwd => getInstanceRecHolder().assertUniqueKeyword(kwd),
saveIssuer: async (issuerP, keyword) => {
// TODO: The checks of the keyword for uniqueness are
// duplicated. Assess how waiting on promises to resolve might
// affect those checks and see if one can be removed.
getInstanceRecHolder().assertUniqueKeyword(keyword);
const record = await E(zoeInstanceAdmin).saveIssuer(issuerP, keyword);
// AWAIT ///
recordIssuer(keyword, record);
return record;
},
makeInvitation: (
offerHandler,
description,
customDetails = harden({}),
proposalShape = undefined,
) => {
typeof description === 'string' ||
Fail`invitations must have a description string: ${description}`;
offerHandler || Fail`offerHandler must be provided`;
if (proposalShape !== undefined) {
assertPattern(proposalShape);
}
const invitationHandle = storeOfferHandler(offerHandler);
const invitationP = E(zoeInstanceAdmin).makeInvitation(
invitationHandle,
description,
customDetails,
proposalShape,
);
// rely on the ZCF type signature
return /** @type {any} */ (invitationP);
},
// Shutdown the entire vat and give payouts
shutdown: completion => {
void E(zoeInstanceAdmin).exitAllSeats(completion);
seatManager.dropAllReferences();
powers.exitVat(completion);
},
shutdownWithFailure,
stopAcceptingOffers: () => E(zoeInstanceAdmin).stopAcceptingOffers(),
makeZCFMint,
registerFeeMint,
makeEmptySeatKit,
// The methods below are pure and have no side-effects //
getZoeService: () => zoeService,
getInvitationIssuer: () => invitationIssuer,
getTerms: () => {
const terms = getInstanceRecHolder().getTerms();
// If the contract provided customTermsShape, validate the customTerms.
const { customTermsShape } = meta;
if (customTermsShape) {
const { brands: _b, issuers: _i, ...customTerms } = terms;
mustMatch(harden(customTerms), customTermsShape, 'customTerms');
}
return terms;
},
getBrandForIssuer,
getIssuerForBrand,
getAssetKind: getAssetKindByBrand,
/** @type {SetTestJig} */
setTestJig: (testFn = () => ({})) => {
if (testJigSetter) {
testJigSetter({ ...testFn(), zcf });
}
},
getInstance: () => getInstanceRecHolder().getInstanceRecord().instance,
setOfferFilter: strings => E(zoeInstanceAdmin).setOfferFilter(strings),
getOfferFilter: () => E(zoeInstanceAdmin).getOfferFilter(),
});
// snapshot zygote here //////////////////
// the zygote object below will be created now, but its methods won't be
// invoked until after the snapshot is taken.
const contractBaggage = provideDurableMapStore(zcfBaggage, 'contractBaggage');
const initSeatMgrAndMintKind = () => {
let zcfMintReallocator;
({ seatManager, zcfMintReallocator } = createSeatManager(
zoeInstanceAdmin,
getAssetKindByBrand,
shutdownWithFailure,
zcfBaggage,
));
makeZcMint = prepareZcMint(
zcfBaggage,
recordIssuer,
getAssetKindByBrand,
makeEmptySeatKit,
zcfMintReallocator,
);
};
/**
* A zygote is a pre-image of a vat that can quickly be instantiated because
* the code has already been evaluated. SwingSet doesn't support zygotes yet.
* Once it does the code will be evaluated once when creating the zcfZygote,
* then the start() function will be called each time an instance is started.
*
* Currently, Zoe's buildRootObject calls makeZCFZygote, evaluateContract, and
* startContract every time a contract instance is created.
*
* @type {ZCFZygote}
*/
const zcfZygote = {
// wire zcf up to zoe instance-specific interfaces
startContract: async (
instanceAdminFromZoe,
instanceRecordFromZoe,
issuerStorageFromZoe,
privateArgs = undefined,
) => {
zoeInstanceAdmin = instanceAdminFromZoe;
initSeatMgrAndMintKind();
zcfBaggage.init('zcfInstanceAdmin', instanceAdminFromZoe);
instanceRecHolder = makeInstanceRecord(instanceRecordFromZoe);
instantiateIssuerStorage(issuerStorageFromZoe);
zcfBaggage.init('instanceRecHolder', instanceRecHolder);
zcfBaggage.init('repairedContractCompletionWatcher', true);
const { privateArgsShape } = meta;
if (privateArgsShape) {
mustMatch(privateArgs, privateArgsShape, 'privateArgs');
}
// start a contract for the first time
return E.when(
start(zcf, privateArgs, contractBaggage),
({
creatorFacet = undefined,
publicFacet = undefined,
creatorInvitation = undefined,
...unexpected
}) => {
const unexpectedKeys = Object.keys(unexpected);
unexpectedKeys.length === 0 ||
Fail`contract "start" returned unrecognized properties ${unexpectedKeys}`;
const areDurable = objectMap(
{ creatorFacet, publicFacet, creatorInvitation },
canBeDurable,
);
const allDurable = Object.values(areDurable).every(Boolean);
if (durabilityRequired) {
allDurable ||
Fail`with ${meta.upgradability}, values from start() must be durable ${areDurable}`;
}
if (allDurable) {
zcfBaggage.init('creatorFacet', creatorFacet);
zcfBaggage.init('publicFacet', publicFacet);
zcfBaggage.init('creatorInvitation', creatorInvitation);
}
return harden({
creatorFacet,
publicFacet,
creatorInvitation,
handleOfferObj,
});
},
);
},
restartContract: async (privateArgs = undefined) => {
if (meta.upgradability) {
meta.upgradability === 'canUpgrade' || Fail`contract cannot upgrade`;
}
zoeInstanceAdmin = zcfBaggage.get('zcfInstanceAdmin');
instanceRecHolder = zcfBaggage.get('instanceRecHolder');
initSeatMgrAndMintKind();
await null;
if (!zcfBaggage.has('repairedContractCompletionWatcher')) {
// We don't wait because it's a cross-vat call (to Zoe) that can't be
// completed during this vat's start-up
E(zoeInstanceAdmin)
.repairContractCompletionWatcher()
.catch(() => {});
zcfBaggage.init('repairedContractCompletionWatcher', true);
}
const { privateArgsShape } = meta;
if (privateArgsShape) {
mustMatch(privateArgs, privateArgsShape, 'privateArgs');
}
// restart an upgradeable contract
return E.when(
start(zcf, privateArgs, contractBaggage),
({
creatorFacet = undefined,
publicFacet = undefined,
creatorInvitation = undefined,
}) => {
const priorCreatorFacet = zcfBaggage.get('creatorFacet');
const priorPublicFacet = zcfBaggage.get('publicFacet');
const priorCreatorInvitation = zcfBaggage.get('creatorInvitation');
(priorCreatorFacet === creatorFacet &&
priorPublicFacet === publicFacet &&
priorCreatorInvitation === creatorInvitation) ||
Fail`restartContract failed: facets returned by contract changed identity`;
return harden({
creatorFacet,
publicFacet,
creatorInvitation,
handleOfferObj,
});
},
);
},
};
return harden(zcfZygote);
};