9449 membrane types #9685
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| export * from './src/async-flow.js'; | ||
| export * from './src/types.js'; | ||
| export { makeStateRecord } from './src/endowments.js'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,191 @@ | ||
| import type { Passable } from '@endo/pass-style'; | ||
| import type { Vow, VowTools } from '@agoric/vow'; | ||
| import type { LogStore } from './log-store.js'; | ||
| import type { Bijection } from './bijection.js'; | ||
| import type { EndowmentTools } from './endowments.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; | ||
|
Comment on lines
+41
to
+45
There was a problem hiding this comment. Wow! Thanks for translating all those type declarations into better .d.ts types. There was a problem hiding this comment. tsc did the work! |
||
|
|
||
| /** | ||
| * Convert an entire Guest interface into what the host will implement. | ||
| */ | ||
| type HostInterface<T> = { | ||
| [K in keyof T]: HostOf<T[K]>; | ||
| }; | ||
|
|
||
|
There was a problem hiding this comment. Nice work on these. Do we also need a There was a problem hiding this comment. When we define an interface it should be in the view of the guest. |
||
| /** | ||
| * 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?: VowTools; | ||
| makeLogStore?: (() => LogStore) | undefined; | ||
| makeBijection?: (() => Bijection) | undefined; | ||
| endowmentTools?: EndowmentTools; | ||
| }; | ||
| 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 type alias for the membrane log entries we currently implement. | ||
| * | ||
| * @see {FutureLogEntry} below 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 type alias 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 the 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]; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Realize this is an existing comment, but consider an
@internaldirectiveThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
when I added it there was a jsdoc lint error the tag should be empty
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What does @internal mean/do?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
https://typedoc.org/tags/internal/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#9690 fixes the lint error. I'm still not sure whether this should be
@internal.