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.

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

Inject extension scopes while running the resolution algorithm #1170

Draft
wants to merge 83 commits into
base: main
Choose a base branch
from

Conversation

ggiraldez
Copy link
Contributor

@ggiraldez ggiraldez commented Nov 27, 2024

This PR builds on top of #1149

This changes the way we handle extension scopes (ie. using directives) in bindings. Instead of using the scope stack from the stack graph, we hook into the resolution algorithm and inject new graph edges from nodes designated as extension hooks (usually the source unit's lexical scope) to extension scopes which are defined at each contract/library and contain the definition nodes from using directives. This simplifies the rules quite a bit and greatly improves performance, particularly in the case of Solidity < 0.7.0 where using directives are inherited from base contracts.

This PR also moves built-ins parsing and ingestion to slang_solidity crate. Since the built-ins file needs to be pre-processed to transform the symbols as to ensure no conflicts can occur with user code, adding the built-ins requires a couple of manual steps that were replicated in every construction of Solidity bindings API. By encapsulating this functionality in the slang_solidity crate we remove a source of user error and make it easier to make changes to the built-ins ingestion code.

- `string` and `bytes` are exported as built-in variables resolving to types
that provide a `concat` function
- `address` can be used as a function to cast a parameter to `address` to eg.
retrieve the balance
This makes resolving to attached functions on types even when the reference of
those types happen in a different lexical scope.
And also provide alternative paths with and without propagating the dynamic
scope. Otherwise, since scope accumulate on the stack it's possible we'll need
to resolve an attached function with the wrong dynamic scope at the top of the
scope stack.
Both contracts and libraries can optionally push the dynamics scope when
traversing to the parent lexical scope (ie. the source unit). But for libraries,
they can also optionally push their name to correctly bind internal types which
were extended (with `using`) by their qualified name (ie. `Lib.Type`).
Applying a function call with a type will always return a value of that type, so
a symbol stack `type,()` is equivalent to `type,@typeof`. Reflect on the binding
entry point of the using clause.
These are parsed as modifiers, and they need a similar treatment as parent
constructor calls in new constructor definitions.
This avoids some oddities, such as `this` used in libraries which we previously
had to bind to an artificial built-in.
The ResolverCandidates will insert arbitrary edges to the graph connecting to
the extension scopes determined available at the beginning of resolution (these
are context dependent) when reaching nodes marked as extension hooks (usually
the source unit's lexical scope).
There's an initial dual purpose:
- make resolution reentrant-safe, as some of the resolution tweaks require
resolving references themselves
- enable recursive lookup of extension scopes for Solidity < 0.7.0
Since extensions are now injected during the resolution phases, it's no longer
needed to have a separate extended scope. This simplifies the existing rules
quite a bit.

Also removes all previous commented out rules that dealt with pushing the
extension scope to the scope stack, since that mechanism is no longer used.
Instead of having to manually customize the resolver. Also, simplify
`ResolveOptions` to an enum with two possible values: `Full` and `NonRecursive`.
`NonRecursive` is used internally from `simple_resolve` to disable code paths
that could lead to infinite recursions when attempting to resolve a reference.
Copy link

changeset-bot bot commented Nov 27, 2024

⚠️ No Changeset found

Latest commit: 58fa2b8

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Since the built-ins file needs to be pre-processed to transform the symbols as
to ensure no conflicts can occur with user code, adding the built-ins requires a
couple of manual steps that were replicated in every construction of Solidity
bindings API. By encapsulating this functionality in the `slang_solidity` crate
we remove a source of user error and make it easier to make changes to the
built-ins ingestion code.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant