feat(sol-macro): provide a way to override import paths for dependencies #527
Conversation
This file contains 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
DaniPopes
force-pushed
the
dani/sol-configurable-imports
branch
5 times, most recently
from
18c3044
to
3c1ac68
Compare
DaniPopes
force-pushed
the
dani/sol-configurable-imports
branch
from
3c1ac68
to
71abb2f
Compare
DaniPopes
commented
Feb 13, 2024
| /// [`sol!`](alloy_sol_types::sol!) macro wrapper to route imports to the correct crate. | ||
| /// | ||
| /// See [`sol!`](alloy_sol_types::sol!) for the actual macro documentation. | ||
| #[cfg(all(not(doc), feature = "sol-types"))] |
There was a problem hiding this comment.
not(doc) so that generated documentation (e.g. docs.rs) displays the sol! re-export instead of this wrapper.
mattsse
approved these changes
Feb 13, 2024
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.
Allows creating
sol!wrappers to specify the import path for dependencies so downstream users don't have to worry about the dependency import problem.For example
alloy_core::sol!is a wrapper that provides#![sol(alloy_sol_types = $crate::sol_types)].Achieved by:
::from imports#[sol({alloy_sol_types,alloy_contract} = <path>)]attributesuse #attribute_value_or_default as alloy_sol_types;import where possible, or directly using the value where not possible (like in struct or type declarations, because we don't "own" the scope multiplesol!calls would fail)Tested with
alloy-contractby patching to this branch locally and using#![sol(alloy_contract = crate)].