missing Remotable and PassByRef types

[turadg]

The description is correct but its type is aliased to Passable (which is wrong). Moreover since Passable is any, Passable is any.

endo/packages/pass-style/src/types.js

Lines 20 to 74 in 686ab61

	/**
	* @typedef {*} Passable
	*
	* A Passable value that may be marshalled. It is classified as one of
	* PassStyle. A Passable must be hardened.
	*
	* A Passable has a pass-by-copy superstructure. This includes
	* * the atomic pass-by-copy primitives ("undefined" | "null" |
	* "boolean" | "number" | "bigint" | "string" | "symbol"),
	* * the pass-by-copy containers
	* ("copyRecord" | "copyArray" | "tagged") that
	* contain other Passables,
	* * and the special cases ("error" | "promise").
	*
	* A Passable's pass-by-copy superstructure ends in
	* PassableCap leafs ("remotable" | "promise"). Since a
	* Passable is hardened, its structure and classification is stable --- its
	* structure and classification cannot change even if some of the objects are
	* proxies.
	*/
	/**
	* @callback PassStyleOf
	* @param {Passable} passable
	* @returns {PassStyle}
	*/
	/**
	* @typedef {Passable} PureData
	*
	* A Passable is PureData when its pass-by-copy superstructure whose
	* nodes are pass-by-copy composites (CopyArray, CopyRecord, Tagged) leaves are
	* primitives or empty composites. No remotables, promises, or errors.
	*
	* This check assures purity *given* that none of these pass-by-copy composites
	* can be a Proxy. TODO SECURITY BUG we plan to enforce this, giving these
	* pass-by-copy composites much of the same security properties as the
	* proposed Records and Tuples (TODO need link).
	*
	* Given this (currently counter-factual) assumption, a PureData value cannot
	* be used as a communications channel,
	* and can therefore be safely shared with subgraphs that should not be able
	* to communicate with each other.
	*/
	/**
	* @typedef {Passable} Remotable
	* Might be an object explicitly declared to be `Remotable` using the
	* `Far` or `Remotable` functions, or a remote presence of a Remotable.
	*/
	/**
	* @typedef {Promise | Remotable} PassableCap
	* The authority-bearing leaves of a Passable's pass-by-copy superstructure.
	*/

https://docs.agoric.com/guides/js-programming/far.html

Remotable = Far object or local presence for a Far object (can be done with a tag b/c only Far() and unserialize return it)

PassByCopy needs a def.

PureData is deeply PassByCopy. (currently Passable/any)

PassByRef = Remotable | Promise<Remotable> | Promise<PassByCopy> (in snippet as PassableCap)

Passable = PassByRef | PassByCopy (but probably not feasible to fully define)

@gibson042 points out adjustments may be needed for error handling

[erights]

PassByCopy !== PureData

PassByCopy is shallow. PureData is deeply PassByCopy. harden([Far('x',{})]) is a PassByCopy CopyArray, but is not PureData because it contains a Remotable.

[erights]

@gibson042 points out adjustments may be needed for error handling

Points out where? Or what?

[erights]

Remotable = Far object or local presence for a Far object (can be done with a tag b/c only Far() and serialize return it)

Did you mean "unserialize"?

[erights]

PassByRef = Remotable | Promise | Promise (in snippet as PassableCap)

What does the third disjunct mean?

[turadg]

For context, this issue body was from a huddle (@gibson042, @dckc and me)

PassByCopy !== PureData

Thanks. I've updated the body.

Points out where? Or what?

It was merely a verbal statement like "adjustments may be needed for error handling" (paraphrase)

Did you mean "unserialize"?

Yes, corrected.

What does the third disjunct mean?

Markdown interpreted the <> as HTML tag. I've now wrapped in backticks.

[kriskowal]

What’s the status of this change?

[turadg]

What’s the status of this change?

This is an issue so no changes have yet been made.

I'd still like to see this problem solved. The any cropped up for me again in #1928 just now.

I'll see if I can make some progress today

[mhofman]

Wondering if this is linked, and possibly was worked around by the manual type generation step before publish

[aj-agoric]

Decided this is high priority in the endo project meeting cc @turadg