-
Notifications
You must be signed in to change notification settings - Fork 208
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(board)!: migrate to smallCaps for boardMarshaller, vstorage, smartWallet #7013
Conversation
Any client that uses marshal |
/** @type {import('@endo/marshal').MakeMarshalOptions} */ | ||
const useSmallCaps = harden({ | ||
serializeBodyFormat: 'smallcaps', | ||
}); | ||
|
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.
I prefer that you not factor this out, but rather repeat the object literal inline in both call sites. The reason is that this is an options bag, and each call site could in theory want to add their own options over time. Think of the options like serializeBodyFormat
as approximating name-based parameters as opposed to positional parameters.
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.
Do you understand the 2 CI failures?
presumably we got away with not hardening some mocked object but smallCaps is more strict somehow
|
@turadg notes |
refs: #6822, #6646
Description
An exploration into using smallcaps for the board marshaller and hence vstorage and the smart wallet.
Security Considerations
Clients expecting the
@qclass
format could get confused.Scaling Considerations
smallCaps is quite a bit more concise. (#6646 is a nearby optimization)
IOU measurements, I suppose
Documentation Considerations
This represents a burden on clients to support smallCaps.
It also puts a burden on clients that want to read data before this gets deployed to support both formats. I suggest that it's better to put this burden on clients that want to read data from the pre-bulldozer era than migrating after the bulldozer upgrade (#6644).
Testing Considerations
test-lib-board.js
@agoric/marshal
cc @michaelfig @warner @ivanlei