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.

Sign up for GitHub

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

Jump to bottom

fix: use Node.js in local environment docs #108

Merged
merged 1 commit into from
Nov 4, 2023
Merged

fix: use Node.js in local environment docs #108

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions docs/contracts/v2/guides/01-local-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,20 +79,22 @@ The folder structure should be intuitive:
- `script` is where you'll write scripts to perform actions like deploying contracts (you guessed it, in Solidity)
- `foundry.toml` is where you can configure your Foundry settings, which we will leave as is in this guide

Let's install the Sablier contracts:
Let's install the Sablier Node.js packages using Pnpm:

```shell
$ forge install sablier-labs/v2-core sablier-labs/v2-periphery
$ pnpm install @sablier/v2-core @sablier/v2-periphery
```

Under the hood, Foundry will clone the Sablier repositories and install the contracts as git submodules.
Pnpm will download the Sablier contracts and put them in the `node_modules` directory.

Finally, let's remap the `@sablier/v2-core` and `@sablier/v2-periphery` paths to point to the installed contracts. This
step is required so that the Solidity compiler can find the Sablier contracts when you import them:
Let's remap the package names to point to the installed contracts. This step is required so that the Solidity compiler
can find the Sablier contracts when you import them:

```shell
$ echo "@sablier/v2-core=lib/v2-core/src" >> remappings.txt
$ echo "@sablier/v2-periphery=lib/v2-periphery/src" >> remappings.txt
$ echo "@sablier/v2-core=node_modules/@sablier/v2-core/" >> remappings.txt
$ echo "@sablier/v2-periphery=node_modules/@sablier/v2-periphery/" >> remappings.txt
$ echo "@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/" >> remappings.txt
$ echo "@prb/math/=node_modules/@prb/math/" >> remappings.txt
```

That's it! You should now have a functional development environment to start building on-chain Sablier integrations.
Expand Down