refactor: stop using deprecated "sloppy" interface option#11931
Merged
mergify[bot] merged 1 commit intomasterfrom Feb 3, 2026
Merged
refactor: stop using deprecated "sloppy" interface option#11931mergify[bot] merged 1 commit intomasterfrom
mergify[bot] merged 1 commit intomasterfrom
Conversation
Deploying agoric-sdk with
|
| Latest commit: |
0ca5765
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://6fa28407.agoric-sdk.pages.dev |
| Branch Preview URL: | https://markm-stop-using-sloppy-opti.agoric-sdk.pages.dev |
erights
commented
Sep 14, 2025
| }; | ||
|
|
||
| const ZCFSeatI = M.interface('ZCFSeat', {}, { sloppy: true }); | ||
| const ZCFSeatI = M.interface('ZCFSeat', {}, { defaultGuards: 'passable' }); |
Member
Author
There was a problem hiding this comment.
This strikes me as a particular dangerous place to omit explicit method guards. Am I missing something?
Member
Author
There was a problem hiding this comment.
This question is not relevant to this PR though. Just asking.
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR refactors the codebase to replace the deprecated "sloppy" interface option with the newer "defaultGuards: 'passable'" option in Marshal interface definitions.
- Updates interface definitions from
{ sloppy: true }to{ defaultGuards: 'passable' } - Updates associated comments to reflect the new interface option terminology
- Maintains the same functional behavior while using the current API
Reviewed Changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| packages/zoe/src/contractFacet/zcfSeat.js | Updates ZCFSeat interface to use defaultGuards instead of sloppy |
| packages/internal/src/typeGuards.js | Updates UnguardedHelperI interface and comment |
| packages/inter-protocol/src/vaultFactory/vaultManager.js | Updates helper interface definition and comment |
| packages/inter-protocol/src/price/fluxAggregatorKit.js | Updates creator interface to use defaultGuards with multi-line formatting |
rekmarks
added a commit
to endojs/endo
that referenced
this pull request
Sep 17, 2025
Refs: #1831, Agoric/agoric-sdk#11931 ## Description We wish to visibly deprecate the `sloppy` option of `@endo/patterns` interface guards. To avoid an explosion of `@typedef` blocks, we migrate the `@endo/patterns` types to TypeScript and then add the minimally required `@deprecated` tags. ### Security Considerations N/A ### Scaling Considerations N/A ### Documentation Considerations N/A ### Testing Considerations This modifies the implementation of the `@endo/patterns` types, but should not modify them. Since the number of lines changed is larged, we should attempt to convince ourselves that the types are in fact the same. ### Compatibility Considerations N/A ### Upgrade Considerations Deprecates but does not remove the `sloppy` option. `NEWS.md` is updated.
0ca5765 to
8a708e3
Compare
📝 WalkthroughWalkthroughGuard configuration in four interface declarations is updated from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches
🧪 Generate unit tests (beta)
Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
closes: #XXXX
refs: #XXXX
Description
The copilot text at #11931 (review) seems like a fine description.
This PR refactors the codebase to replace the deprecated "sloppy" interface option with the newer "defaultGuards: 'passable'" option in Marshal interface definitions.
Updates interface definitions from { sloppy: true } to { defaultGuards: 'passable' }
Updates associated comments to reflect the new interface option terminology
Maintains the same functional behavior while using the current API
Security Considerations
Should be semantically identical, but easier to understand, so slight security improvement
Scaling Considerations
none
Documentation Considerations
If we can stop using
sloppycompletely, perhaps we can avoid documenting it in normal developer-facing documentation.Testing Considerations
Adequate testing already in heap-classes.test.js in
@endo/exoUpgrade Considerations
Since we still support the deprecated option at this time, none.
Summary by CodeRabbit