Skip to content

Commit

Permalink
fix(docs): Update integration guide env variables and fs_permission c…
Browse files Browse the repository at this point in the history
…onfiguration
  • Loading branch information
RPate97 committed Jan 11, 2024
1 parent 49b565e commit 1640d3c
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 6 deletions.
5 changes: 5 additions & 0 deletions .changeset/late-dots-sip.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@sphinx-labs/plugins': patch
---

Use more specific fs_permissions configuration
8 changes: 3 additions & 5 deletions docs/cli-existing-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,6 @@ SPHINX_API_KEY=<your_api_key>
Also, if you haven't added your node provider API key as an environment variable, please do so now. For example:
```
ALCHEMY_API_KEY=<your_api_key>
INFURA_API_KEY=<your_api_key>
```

## 8. Update RPC endpoints
Expand All @@ -188,9 +187,9 @@ Here's what your `foundry.toml` might look like if you're using Alchemy:

```toml
[rpc_endpoints]
sepolia = "https://eth-sepolia.g.alchemy.com/v2/${RPC_API_KEY}"
optimism_sepolia = "https://opt-sepolia.g.alchemy.com/v2/${RPC_API_KEY}"
arbitrum_sepolia = "https://arb-sepolia.g.alchemy.com/v2/${RPC_API_KEY}"
sepolia = "https://eth-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}"
optimism_sepolia = "https://opt-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}"
arbitrum_sepolia = "https://arb-sepolia.g.alchemy.com/v2/${ALCHEMY_API_KEY}"
```

## 9. Update `foundry.toml` settings
Expand All @@ -201,7 +200,6 @@ Update your `foundry.toml` file to include a few settings required by Sphinx. We
build_info = true
extra_output = ['storageLayout']
fs_permissions = [{ access = "read-write", path = "./"}]
allow_paths = ["../.."]
```

## 10. Run tests
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ script = 'script'
test = 'test'
build_info = true
extra_output = ['storageLayout']
fs_permissions = [{ access = "read-write", path = "./"}]
fs_permissions=[{access="read", path="./out"}, {access="read-write", path="./cache"}]
allow_paths = ["../.."]
${fetchConfigRemappings(pnpm, includeStandard)}
Expand Down

0 comments on commit 1640d3c

Please sign in to comment.