-
Notifications
You must be signed in to change notification settings - Fork 206
/
types.d.ts
252 lines (239 loc) · 6.83 KB
/
types.d.ts
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
import type { Passable } from '@endo/pass-style';
import type { Vow } from '@agoric/vow';
import type { LogStore } from './log-store.js';
import type { Bijection } from './bijection.js';
export type FlowState =
| 'Running'
| 'Sleeping'
| 'Replaying'
| 'Failed'
| 'Done';
/**
* `T` defaults to `any`, not `Passable`, because unwrapped guests include
* non-passables, like unwrapped functions and unwrapped state records.
* (Unwrapped functions could be made into Remotables,
* but since they still could not be made durable, in this context
* it'd be pointless.)
*/
export type Guest<T extends unknown = any> = T;
export type Host<T extends Passable = Passable> = T;
/**
* A HostVow must be durably storable. It corresponds to an
* ephemeral guest promise.
*/
export type HostVow<T extends Passable = Passable> = Host<Vow<T>>;
export type GuestAsyncFunc = (
...activationArgs: Guest[]
) => Guest<Promise<any>>;
export type HostAsyncFuncWrapper = (...activationArgs: Host[]) => HostVow;
/**
* The function from the host as it will be available in the guest.
*
* Specifically, Vow return values are converted to Promises.
*/
export type GuestOf<F extends HostAsyncFuncWrapper> = F extends (
...args: infer A
) => Vow<infer R>
? (...args: A) => Promise<R>
: F;
/**
* Convert an entire Guest interface into what the host will implement.
*/
type HostInterface<T> = {
[K in keyof T]: HostOf<T[K]>;
};
/**
* The function the host must provide to match an interface the guest expects.
*
* Specifically, Promise return values are converted to Vows.
*/
export type HostOf<F> = F extends (...args: infer A) => Promise<infer R>
? (...args: A) => Vow<R extends Passable ? R : HostInterface<R>>
: F;
export type PreparationOptions = {
vowTools?:
| {
when: <
T,
TResult1 = import('@agoric/vow').EUnwrap<T>,
TResult2 = never,
>(
specimenP: T,
onFulfilled?:
| ((
value: import('@agoric/vow').EUnwrap<T>,
) => TResult1 | PromiseLike<TResult1>)
| undefined,
onRejected?:
| ((reason: any) => TResult2 | PromiseLike<TResult2>)
| undefined,
) => Promise<TResult1 | TResult2>;
watch: <
T = any,
TResult1 = T,
TResult2 = never,
C extends any[] = any[],
>(
specimenP: import('@agoric/vow').EVow<T>,
watcher?:
| import('@agoric/vow').Watcher<T, TResult1, TResult2, C>
| undefined,
...watcherArgs: C
) => Vow<
Exclude<TResult1, void> | Exclude<TResult2, void> extends never
? TResult1
: Exclude<TResult1, void> | Exclude<TResult2, void>
>;
makeVowKit: <T>() => import('@agoric/vow').VowKit<T>;
allVows: (
maybeVows: import('@agoric/vow').EVow<unknown>[],
) => Vow<any[]>;
asVow: <T extends unknown>(
fn: (
...args: any[]
) =>
| Vow<Awaited<T>>
| Awaited<T>
| import('@agoric/vow').PromiseVow<T>,
) => Vow<Awaited<T>>;
asPromise: import('@agoric/vow').AsPromiseFunction;
retriable: <F extends (...args: any[]) => Promise<any>>(
fnZone: import('@agoric/base-zone').Zone,
name: string,
fn: F,
) => F extends (...args: infer Args) => Promise<infer R>
? (...args: Args) => Vow<R>
: never;
}
| undefined;
makeLogStore?: (() => LogStore) | undefined;
makeBijection?: (() => Bijection) | undefined;
endowmentTools?:
| {
prepareEndowment: (
zone: import('@agoric/base-zone').Zone,
tag: string,
e: unknown,
) => any;
unwrap: (wrapped: any, guestWrapped: any) => any;
}
| undefined;
};
export type OutcomeKind = 'return' | 'throw';
export type Outcome =
| {
kind: 'return';
result: any;
}
| {
kind: 'throw';
problem: any;
};
export type Ephemera<S extends WeakKey = WeakKey, V extends unknown = any> = {
for: (self: S) => V;
resetFor: (self: S) => void;
};
/**
* This is the typedef for the membrane log entries we currently implement.
* See comment below for the commented-out typedef for the full
* membrane log entry, which we do not yet support.
*/
export type LogEntry =
| [
// ///////////////// From Host to Guest /////////////////////////
op: 'doFulfill',
vow: HostVow,
fulfillment: Host,
]
| [op: 'doReject', vow: HostVow, reason: Host]
| [op: 'doReturn', callIndex: number, result: Host]
| [op: 'doThrow', callIndex: number, problem: Host]
| [
// ///////////////////// From Guest to Host /////////////////////////
op: 'checkCall',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [
op: 'checkSendOnly',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [
op: 'checkSend',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
];
/**
* This would be the typedef for the full membrane log, if we supported
* - the guest sending guest-promises and guest-remotables to the host
* - the guest using `E` to eventual-send to guest wrappers of host
* vows and remotables.
*/
export type FutureLogEntry =
| [
// ///////////////// From Host to Guest ///////////////////////
op: 'doFulfill',
vow: HostVow,
fulfillment: Host,
]
| [op: 'doReject', vow: HostVow, reason: Host]
| [
op: 'doCall',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [
op: 'doSendOnly',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [
op: 'doSend',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [op: 'doReturn', callIndex: number, result: Host]
| [op: 'doThrow', callIndex: number, problem: Host]
| [
// ///////////////////// From Guest to Host /////////////////////////
op: 'checkFulfill',
vow: HostVow,
fulfillment: Host,
]
| [op: 'checkReject', vow: HostVow, reason: Host]
| [
op: 'checkCall',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [
op: 'checkSendOnly',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [
op: 'checkSend',
target: Host,
optVerb: PropertyKey | undefined,
args: Host[],
callIndex: number,
]
| [op: 'checkReturn', callIndex: number, result: Host]
| [op: 'checkThrow', callIndex: number, problem: Host];