Skip to content

Commit

Permalink
add remappings examples to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sammyshakes committed Sep 15, 2023
1 parent 16189d4 commit 338d19d
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,20 @@ forge-std/=lib/forge-std/src/
era-system-contracts/=lib/era-system-contracts/
```
### To use remapped imports:
```solidity
import "era-system-contracts/contracts/Constants.sol";
import "era-system-contracts/contracts/libraries/SystemContractsCaller.sol";
import "@openzeppelin/contracts/token/ERC20/ERC20.sol";
import {ERC721} from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
```
NOTES:
- The `remappings.txt` file must be in the project root.
- For remappings **_suggestions_**, use the command `zkforge remappings`, but double check output for your use case, if the remappings are correct, you can use `zkforge remappings > remappings.txt` to create the file.
---
## Deploy with `zkforge zk-create`
Expand Down

0 comments on commit 338d19d

Please sign in to comment.