docs(pegasus): Remote<T> -> ERef<T> for board, namesByAddress

[dckc]

refs: #9027, #8852 , Agoric/documentation#1031

Description / Documentation Considerations

yarn build-ts was reporting type errors; that interferes with work on reference docs.

It's not clear to me nor to @turadg why yarn lint was not reporting errors.

Security / Scaling / Testing / Upgrade Considerations

I looked for any reason namesByAddress or board couldn't be a promise; for example, if they were in an exo state and hence in durable storage. I didn't see any.

[michaelfig]

This seems to indicate the need for another type:

/**
 * @template T
 * @typedef {import('@endo/far').ERef<import('@agoric/vow').Remote<T>>} ERemote
 * A promise for a potentially remote object (an "eventual remote object"),
 * or just a non-promise immediate reference (presence) for a remote object.
 */

The expansion is thus:

• ERemote<...>
• ERef<Remote<...>>
• Remote<...> | PromiseLike<Remote<...>>

@iomekam, would you be able to pick up this change? If not, I could probably get it done tomorrow.

[dckc]

@michaelfig maybe we want to constrain the interface so that these are not promises in order to make it easier to make pegasus durable / upgradable later?

[dckc]

@michaelfig maybe we want to constrain the interface so that these are not promises in order to make it easier to make pegasus durable / upgradable later?

After some discussion, we agreed I should close this on that basis.

I want to think about what other type change I should make to make the doc gen tool happy instead 1st.