Tutorial on writing remappings.txt for Hardhat projects.

[TilakMaddy]

MASSIVE UPDATE:
See comment below

(This happens automatically now)

Solidity projects that import code from libraries with a shorthand like @ozrequire remappings in order to map the shorthand to an actual path on the file system.

Hardhat tends to generate these mappings internally when pnpm hardhat XXX commands are run. Therefore, you don't see a remappings.txt by default when you create a HH project.

Aderyn however does not have access to those remappings so for now, we require that users specify the remappings manually
in reamppings.txt and place the file at the root.

One example of that could be the following:

@openzeppelin/=node_modules/@openzeppelin/
@hardhat/=node_modules/hardhat/

However you need to verify that the path on the right hand side actually exists such that all the file imports point to a real solidity file.

This may not be ideal experience. We're definitely working towards bettering the human experience but until then please feel free to reach out and ask questions. We're always looking to help.

Thank you

[TilakMaddy]

UPDATE:

We've launched a massive update after-rewriting the backend for AST Generation in aderyn-v0.5.4 The problem above should be mostly fixed. In other words, we will make an educated guess about these remappings by looking inside node_modules. However chances are sometimes the package name inside node_modules does not necessarily match with how you would import it in the contracts. So remappings may still be required if your aderyn fails to compile

Thanks :)