Skip to content

Commit 16e4100

Browse files
committed
launch notes
1 parent d0b77e1 commit 16e4100

File tree

3 files changed

+27
-13
lines changed

3 files changed

+27
-13
lines changed

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,13 @@ Scroll SDK is in active development, and parts of this guide may change. We aim
2929
*Guide last updated October 15, 2024, referencing example files from [this commit](https://github.com/scroll-tech/scroll-sdk/tree/2988c80996b0f6413c6c374d5e9ce8bd788d52ca).*
3030
</Aside>
3131

32+
<Aside type="tip" title="Blockscout Issues">
33+
As we migrate to the Blockscout with native Scroll SDK support, we haven't yet updated the guide or CLI tool.
34+
35+
Please be aware that Blockscout will take a few extra steps to setup without automation. We'll get this fixed soon.
36+
</Aside>
37+
38+
3239
## Getting your machine ready
3340

3441
### Installing Prerequisites

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,10 @@ This guide does not include running the coordinator or a prover. The coordinator
2626
You can enable it in the `values.yaml` file if wanting to locally test external proof generation services. Provers need dedicated machines to run and require additional configuration.
2727
</Aside>
2828

29+
<Aside type="tip" title="Blockscout Issues">
30+
As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven't yet re-integrated the L1 explorer.
31+
</Aside>
32+
2933
<ToggleElement anchor="Guide Updates">
3034
<div slot="title">Updates to the Guide</div>
3135
<span>
@@ -237,7 +241,6 @@ then, set it as a env var and run: `echo $ghcr_pat | docker login ghcr.io -u [gi
237241
<Aside type="tip" title="Want to test faster?">
238242
If you want finalization to L1 to happen more quickly on your devnet, you set the following values in the `config.toml` [rollup] section:
239243
- `MAX_BLOCK_IN_CHUNK`: 3
240-
- `MAX_CHUNK_IN_BATCH`: 3
241244
- `MAX_BATCH_IN_BUNDLE`: 3
242245
- `TEST_ENV_MOCK_FINALIZE_TIMEOUT_SEC`: 10
243246

src/content/docs/en/sdk/guides/digital-ocean-alt-gas-token.mdx

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,18 @@ Though this isn't the most "sophisticated" cloud setup, it is a step more compli
3636

3737
This guide is intended for chain owners and those that aren't DevOps professionals, to see what's involved and show the additional considerations that need to be made.
3838

39-
Because AltGas token introduces another element of complexity, we will use it here as well.
39+
Because using an alternative gas token introduces another element of complexity, we will use it here as well.
4040

4141
<Aside type="caution">
4242
Scroll SDK is still in development, so certain pieces of guides may see breaking changes. We hope to slow down changes soon.
4343

44-
*Guide last updated October 8, 2024 and refers to example files from [this commit](https://github.com/scroll-tech/scroll-sdk/tree/4a4092736486664df96277565e8d14e3ce023e60).*
44+
*Guide last updated October 31, 2024 and refers to example files from [this commit](https://github.com/scroll-tech/scroll-sdk/tree/1dd4d02d7bff64a33783511e2d97ef24bf890a55).*
45+
</Aside>
46+
47+
<Aside type="tip" title="Blockscout Issues">
48+
As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven't yet updated the guide or CLI tool.
49+
50+
Please be aware that Blockscout will take a few extra steps to setup without automation. We'll get this fixed soon.
4551
</Aside>
4652

4753
## Getting your machine ready
@@ -297,6 +303,12 @@ L1_GAS_TOKEN = "0xFF34B3d4Aee8ddCd6F9AFFFB6Fe49bD371b8a357"
297303

298304
You can follow the prompt by running `scrollsdk setup gas-token`
299305

306+
<Aside type="danger">
307+
The CLI tool does not yet support advanced configuration of gas token values. Please manually update `config.toml` for now. See the [Gas Token](/en/sdk/operation/gas-and-fees#alternative-gas-token) section for more information.
308+
</Aside>
309+
310+
{/* TODO: Document using CLI for advanced configuration here. */}
311+
300312
### Generate Configuration Files
301313

302314
Now, we'll do the last steps for generating each service's configuration files based on our values in `config.toml`.
@@ -307,19 +319,11 @@ You'll see a few prompts to update a few remaining values, like the L1 height at
307319

308320
Now, we'll simulate contract deployment to get contract addresses and build the config files and secrets files for all SDK services. Secrets will be written to `./secrets` and config files to `./values`. If you want the config files written to a different directory, pass the `--configs-dir` flag.
309321

310-
### Pull Charts and Move Config Files
322+
### Prep Charts Values
311323

312324
Now, we need to prepare the Helm charts. We will check access to charts, review the Makefile and check the values files for any missing values.
313325

314-
To do this, run `scrollsdk setup prep-charts`
315-
316-
<Aside type="danger">
317-
If you haven't setup docker permissions for accessing the private repo, you can create a legacy token with access to the `scroll-sdk` repo and run this command:
318-
319-
`scrollsdk setup prep-charts --github-username=[username] --github-token=[token]`
320-
</Aside>
321-
322-
After pulling the charts, the CLI tool will try to auto-fill each chart's `production.yaml` file.
326+
To do this, run `scrollsdk setup prep-charts` and the CLI tool will try to auto-fill each chart's `production.yaml` file.
323327

324328
You will be prompted with each update, and even flagged for empty values. Be sure to sanity check these values to make sure you didn't setup something incorrectly earlier. If you did, re-run any earlier steps, being sure to rerun the `setup configs` command before running `setup prep-charts` .
325329

0 commit comments

Comments
 (0)