Remapping Troubleshooting FAQ to README #2236
Closed
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
alexbabits
requested review from
montyly,
0xalpharush and
smonicas
as code owners
|
|
0xalpharush
suggested changes
Nov 17, 2023
| @@ -274,6 +274,22 @@ If you have a `node_modules/` folder, it must be in the same directory as `contr | |||
| run the compilation command for the framework you are using e.g `npx hardhat compile`. That must work successfully; | |||
| otherwise, slither's compilation engine, crytic-compile, cannot generate the AST. | |||
|
|
|||
| * If `node_modules/` is not in your `contracts/` directory of your project, you will need to involve **remappings**. If a project has dependencies like OpenZeppelin or Chainlink, but you want to run Slither on a single `.sol` file or use [slither's tools](https://github.com/crytic/slither#tools) like `slither-check-erc`, you can add the `--solc-remaps @=node_modules/@` flag and/or configure `slither.config.json` in your project's root with the remapping. If `slither.config.json` remappings are setup the flag is no longer needed unless using [slither's tools](https://github.com/crytic/slither#tools). Foundry projects also require remappings if you want to analyze a specific `.sol` file that requires imports. Read more here: [Foundry Static Analysis Docs](https://book.getfoundry.sh/config/static-analyzers). | |||
|
|
|||
There was a problem hiding this comment.
Foundry projects also require remappings if you want to analyze a specific
.solfile that requires imports. Read more here: Foundry Static Analysis Docs.
I'm not sure this is accurate as of the 0.10.0 release. We use Foundry (which automatically configures the remappings) to compile single files
There was a problem hiding this comment.
I'm not sure if the last bit ("... or use a slither tool like slither-check-erc...") is accurate either. You can run both slither and tools like slither-check-erc with a project directory (like .) as target and not worry about remappings; in the case of standalone tools, they take the contract name you want to analyze:
% slither-check-erc . Counter
# Check Counter
## Check functions
[ ] totalSupply() is missing
[ ] balanceOf(address) is missing
[ ] transfer(address,uint256) is missing
[ ] transferFrom(address,address,uint256) is missing
...
There was a problem hiding this comment.
elopez is correct my mistake, slither-check-erc . Counter does work without any remappings.
README.md
Outdated
| @@ -274,6 +274,22 @@ If you have a `node_modules/` folder, it must be in the same directory as `contr | |||
| run the compilation command for the framework you are using e.g `npx hardhat compile`. That must work successfully; | |||
| otherwise, slither's compilation engine, crytic-compile, cannot generate the AST. | |||
|
|
|||
| * If `node_modules/` is not in your `contracts/` directory of your project, you will need to involve **remappings**. If a project has dependencies like OpenZeppelin or Chainlink, but you want to run Slither on a single `.sol` file or use [slither's tools](https://github.com/crytic/slither#tools) like `slither-check-erc`, you can add the `--solc-remaps @=node_modules/@` flag and/or configure `slither.config.json` in your project's root with the remapping. If `slither.config.json` remappings are setup the flag is no longer needed unless using [slither's tools](https://github.com/crytic/slither#tools). Foundry projects also require remappings if you want to analyze a specific `.sol` file that requires imports. Read more here: [Foundry Static Analysis Docs](https://book.getfoundry.sh/config/static-analyzers). | |||
There was a problem hiding this comment.
Suggested change
| * If `node_modules/` is not in your `contracts/` directory of your project, you will need to involve **remappings**. If a project has dependencies like OpenZeppelin or Chainlink, but you want to run Slither on a single `.sol` file or use [slither's tools](https://github.com/crytic/slither#tools) like `slither-check-erc`, you can add the `--solc-remaps @=node_modules/@` flag and/or configure `slither.config.json` in your project's root with the remapping. If `slither.config.json` remappings are setup the flag is no longer needed unless using [slither's tools](https://github.com/crytic/slither#tools). Foundry projects also require remappings if you want to analyze a specific `.sol` file that requires imports. Read more here: [Foundry Static Analysis Docs](https://book.getfoundry.sh/config/static-analyzers). | |
| * If `node_modules/` is not in the `contracts/` directory of your project, you may need to use **remappings**. If a project has dependencies such as OpenZeppelin and you want to run Slither on a single `.sol` file or use a [slither tool](https://github.com/crytic/slither#tools) like `slither-check-erc`, add the remapping on the command line e.g. `--solc-remaps @=node_modules/@` or to the `slither.config.json` in your project's root. Note, this should not be required for Foundry projects as it is handled automatically. |
There was a problem hiding this comment.
Thank you for this! We need to publish the FAQs somewhere besides the README but this is fine in the meantime
|
Please run https://github.com/DavidAnson/markdownlint |
|
Let me know if you'd like anything else, latest attempt is |
|
(I ran the markdownlint in both cases and passed, but the Lint Code Base Superlinter failed). |
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.
FAQ for others figuring out the remappings in order to run slither on a single contract that had imports from OpenZeppelin. I also found that remapping was needed for the special slither tools like
slither-check-erc.This adds another bullet point to the FAQ about remaps and setting up slither.config.json if node_modules is not in the same housing as contracts/, using hardhat as an example.