Skip to content

Commit cd366ed

Browse files
committed
fixes to devnet guide
1 parent 2980090 commit cd366ed

File tree

1 file changed

+15
-11
lines changed

1 file changed

+15
-11
lines changed

src/content/docs/en/sdk/guides/devnet-deployment.mdx

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,12 @@ import { Tabs, TabsContent } from "../../../../../components/Tabs"
1414

1515
## Overview
1616

17-
This guide should get you started with running a local Scroll SDK devnet. Additionally, it has specific asides for running is on macos.
17+
This guide should get you started with running a local Scroll SDK devnet. Additionally, it has specific asides for running on macOS and Ubuntu.
1818

19-
This guide assumes you have access to the [scroll-sdk github repo](https://github.com/scroll-tech/scroll-sdk) using your local machine.
20-
21-
We’ve written this guide because local deployments for Kubernetes clusters can be finicky.
19+
We've written this guide because local deployments of Kubernetes clusters can be finicky. Even the prerequisites can be tricky without help.
2220

2321
By the end of the guide, you should have a Scroll SDK running with a block explorer, RPC, webUI, monitoring and metrics, and a local L1. These are all accessible to wallets, browsers, and applications running on your local machine.
2422

25-
{/* <Aside type="caution">
26-
This guide assumes the user is using macos. Windows is not supported, and Linux flavors might require modifications.
27-
</Aside> */}
28-
2923
<Aside type="caution">
3024
This guide does not include running the coordinator or a prover. The coordinator currently requires 20GB of RAM to run, so we disable it by default in the devnet configuration.
3125

@@ -226,13 +220,17 @@ then, set it as a env var and run: `echo $ghcr_pat | docker login ghcr.io -u [gi
226220

227221
Your chain is now starting! Run `kubectl get pods` to check in on their progress. In the next section we'll expose the chain to your local machine so you can interact with the stack.
228222

229-
<Aside type="tip">
230223
The install process for the various containers can take several minutes as new docker images are downloaded and services wait on others to be online to start.
231-
</Aside>
232224
</Steps>
233225

234226
<Aside type="tip" title="Want to test faster?">
235-
If you want finalization to L1 to happen extra fast on your devnet, you set `` in `config.toml` to be X. This
227+
If you want finalization to L1 to happen more quickly on your devnet, you set the following values in the `config.toml` [rollup] section:
228+
- `MAX_BLOCK_IN_CHUNK`: 3
229+
- `MAX_CHUNK_IN_BATCH`: 3
230+
- `MAX_BATCH_IN_BUNDLE`: 3
231+
- `TEST_ENV_MOCK_FINALIZE_TIMEOUT_SEC`: 10
232+
233+
Be sure to run `make config` again before installing.
236234
</Aside>
237235

238236
<Aside title="Production Workflows Differ Slightly">
@@ -458,6 +456,12 @@ To connect directly to an RPC or using MetaMask, use:
458456
Because the devnet does not use `https`, you need to manually set these up in MetaMask. By default, MetaMask rejects auto-configuration for network rpcs over `http`.
459457
</Aside>
460458
459+
## What's Next?
460+
461+
If you're a developer, you might want to try [customizing specific sdk components](/sdk/customization).
462+
463+
If you're looking to learn more about running a public testnet, try out a production deployment with our [Digital Ocean guide](/sdk/guides/production-deployment-digital-ocean) or our [AWS guide](/sdk/guides/production-deployment-aws).
464+
461465
### Helpful Commands
462466
463467
Anvil has a lot of [useful methods](https://book.getfoundry.sh/reference/anvil/#custom-methods) that can manipulate the L1. Proper documentation for using them is available in the [Hardhat docs](https://hardhat.org/hardhat-network/docs/reference#hardhat-network-methods) (replacing `hardhat_` with `anvil_`)

0 commit comments

Comments
 (0)