feat(cast): add --flatten flag to cast interface #13201
Merged
+63
−6
Conversation
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
Adds a new `--all-in-one` flag to `cast interface` that inlines
inherited/library struct types directly into the generated interface.
This addresses the issue where `cast interface` generates a separate
`library` block for struct types that originate from inherited interfaces,
making the generated interface less usable for some workflows.
With `--all-in-one`, all types are consolidated into a single interface:
```solidity
// Before (default):
library IBase {
struct TestStruct { address asset; }
}
interface Contract {
function test(IBase.TestStruct memory) external;
}
// After (with --all-in-one):
interface Contract {
struct TestStruct { address asset; }
function test(TestStruct memory) external;
}
```
Uses alloy-json-abi's `ToSolConfig::one_contract(true)` option
introduced in alloy-core 0.8.24.
Closes #9960
mattsse
requested review from
0xrusowsky,
DaniPopes,
grandizzy,
onbjerg and
zerosnacks
as code owners
zerosnacks
reviewed
Jan 23, 2026
crates/cast/src/cmd/interface.rs
Outdated
| /// | ||
| /// This can fail if there are structs with the same name in different interfaces. | ||
| #[arg(long)] | ||
| all_in_one: bool, |
Member
There was a problem hiding this comment.
maybe flatten is more intuitive here
zerosnacks
changed the title
zerosnacks
approved these changes
Jan 24, 2026
grandizzy
approved these changes
Jan 24, 2026
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.
Summary
Adds a new
--flattenflag tocast interfacethat inlines inherited/library struct types directly into the generated interface.Problem
When running
cast interfaceon a contract that uses structs from an inherited interface, the output generates alibraryfor the struct definitions instead of keeping them in the interface (#9960).Example of the issue:
Solution
Uses alloy-json-abi's
ToSolConfig::one_contract(true)option (introduced in alloy-core 0.8.24 via alloy-rs/core#911) to consolidate all types into a single interface:Changes
--flattenCLI flag tocast interfacecommandToSolConfig::new().one_contract(true)toJsonAbi::to_sol()when flag is setCloses #9960