fix(types): board values #9332
fix(types): board values #9332
Conversation
Deploying agoric-sdk with
|
| Latest commit: |
4196da3
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://b9b7bda7.agoric-sdk.pages.dev |
| Branch Preview URL: | https://1488-scalarkey.agoric-sdk.pages.dev |
packages/vats/src/lib-board.js
Outdated
| * @param {PassableCap} value | ||
| * @throws if `value` is not a Key in the @agoric/store sense | ||
| * @param {RemotableObject} value | ||
| * @throws if `value` is not a ScalarKey in the @agoric/store sense |
There was a problem hiding this comment.
I'm not sure @agoric/store has a ScalarKey sense. maybe "in the @endo/patterns sense"
There was a problem hiding this comment.
agreed. though this is one place ScalarKey ought to be mentioned, because this code only throws at runtime if it's it's not a ScalarKey. (it doesn't check that it's a remotable)
There was a problem hiding this comment.
I made it check with isRemotable()
| @@ -267,8 +270,7 @@ export const prepareBoardKit = baggage => { | |||
| * `value` for its entire lifetime. For a well-known board, this is | |||
| * essentially forever. | |||
| * | |||
| * @param {PassableCap} value | |||
| * @throws if `value` is not a Key in the @agoric/store sense | |||
There was a problem hiding this comment.
removed this because it shouldn't come as a surprise to get an error when the argument doesn't satisfy the param type
| @@ -101,7 +101,9 @@ const makeInvitation = async ( | |||
| board, | |||
| zoe, | |||
| ) => { | |||
| const instance = E(board).getValue(instanceHandleBoardId); | |||
| const instance = /** @type {Promise<Instance>} */ ( | |||
There was a problem hiding this comment.
getPublicFacet won't take any old Remotable
| * @param {PassableCap} val | ||
| * @param {RemotableObject} val |
| @@ -26,7 +26,6 @@ const makeOnChainWallet = board => { | |||
| getCurrentAmount: () => harden({ brand, value: 100 }), | |||
| }); | |||
| // only for private brands | |||
| // context.initBrandId(boardId, brand); | |||
| if (!isRemotable(value)) { | ||
| Fail`Board cannot create id for non-remotable`; | ||
| } |
There was a problem hiding this comment.
one could look at that as a breaking change... I think I'll look at it as a (non-breaking) fix: the fact that you used to be able store primitives is a bug.
Description
Follow up to #8774
Fix the Board types
Security Considerations
Scaling Considerations
Documentation Considerations
Testing Considerations
Upgrade Considerations
The one behavior change is to omit non-remotables from the board, but nothing should have been doing that and if it was this error will help.
Of course that doesn't need to go out in any particular chain upgrade, but it could to minimize divergence from master until,