Skip to content
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.

Sign up for GitHub

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

Jump to bottom

fix: psmCharter.addInstance interface shape correction #6202

Merged
merged 2 commits into from
Sep 15, 2022
Merged

fix: psmCharter.addInstance interface shape correction #6202

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
00e631d
fix: psmCharter.addInstance interface shape correction
Chris-Hibbert Sep 14, 2022
911d334
Merge branch 'master' into fix-psmCharter-addInstace-shape
mergify[bot] Sep 14, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions packages/inter-protocol/src/psm/psmCharter.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,12 +96,9 @@ export const start = async zcf => {
};

const psmCharterCreatorI = M.interface('PSM Charter creatorFacet', {
addInstance: M.call(
InstanceHandleShape,
M.any(),
BrandShape,
BrandShape,
).returns(),
addInstance: M.call(InstanceHandleShape, M.any())
.optional(BrandShape, BrandShape)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TIL .optional. Where is it documented or implemented?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's very little documentation. I dunno where the implementations are. It's tested in test-heap-classes.

Copy link
Member

@turadg turadg Sep 14, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that documentation doesn't mention optional. I've filed #6206 cc @erights

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From #6206 (comment) :

FWIW, this is implemented at

agoric-sdk/packages/store/src/patterns/patternMatchers.js

Lines 1537 to 1543 in 9b78628

optional: (...optArgGuards) => {
optionalArgGuards === undefined ||
assert.fail(X`Can only have one set of optional guards`);
restArgGuard === undefined ||
assert.fail(X`optional arg guards must come before rest arg`);
return makeMethodGuardMaker(callKind, argGuards, optArgGuards);
},
and used several times in https://github.com/Agoric/agoric-sdk/blob/master/packages/ERTP/src/typeGuards.js

I'm actually surprised I didn't write any comments explaining this at all. I certainly agree it is needed.

Also rest

.returns(),
makeCharterMemberInvitation: M.call().returns(M.promise()),
});

Expand Down