Skip to content

Commit

Permalink
launch notes
Browse files Browse the repository at this point in the history
  • Loading branch information
dghelm committed Oct 31, 2024
1 parent d0b77e1 commit 16e4100
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 13 deletions.
7 changes: 7 additions & 0 deletions src/content/docs/en/sdk/guides/aws-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,13 @@ Scroll SDK is in active development, and parts of this guide may change. We aim
*Guide last updated October 15, 2024, referencing example files from [this commit](https://github.com/scroll-tech/scroll-sdk/tree/2988c80996b0f6413c6c374d5e9ce8bd788d52ca).*
</Aside>

<Aside type="tip" title="Blockscout Issues">
As we migrate to the Blockscout with native Scroll SDK support, we haven't yet updated the guide or CLI tool.

Please be aware that Blockscout will take a few extra steps to setup without automation. We'll get this fixed soon.
</Aside>


## Getting your machine ready

### Installing Prerequisites
Expand Down
5 changes: 4 additions & 1 deletion src/content/docs/en/sdk/guides/devnet-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,10 @@ This guide does not include running the coordinator or a prover. The coordinator
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.
</Aside>

<Aside type="tip" title="Blockscout Issues">
As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven't yet re-integrated the L1 explorer.
</Aside>

<ToggleElement anchor="Guide Updates">
<div slot="title">Updates to the Guide</div>
<span>
Expand Down Expand Up @@ -237,7 +241,6 @@ then, set it as a env var and run: `echo $ghcr_pat | docker login ghcr.io -u [gi
<Aside type="tip" title="Want to test faster?">
If you want finalization to L1 to happen more quickly on your devnet, you set the following values in the `config.toml` [rollup] section:
- `MAX_BLOCK_IN_CHUNK`: 3
- `MAX_CHUNK_IN_BATCH`: 3
- `MAX_BATCH_IN_BUNDLE`: 3
- `TEST_ENV_MOCK_FINALIZE_TIMEOUT_SEC`: 10

Expand Down
28 changes: 16 additions & 12 deletions src/content/docs/en/sdk/guides/digital-ocean-alt-gas-token.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,18 @@ Though this isn't the most "sophisticated" cloud setup, it is a step more compli

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.

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

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

*Guide last updated October 8, 2024 and refers to example files from [this commit](https://github.com/scroll-tech/scroll-sdk/tree/4a4092736486664df96277565e8d14e3ce023e60).*
*Guide last updated October 31, 2024 and refers to example files from [this commit](https://github.com/scroll-tech/scroll-sdk/tree/1dd4d02d7bff64a33783511e2d97ef24bf890a55).*
</Aside>

<Aside type="tip" title="Blockscout Issues">
As we migrate to the Blockscout upgrade with native Scroll SDK support, we haven't yet updated the guide or CLI tool.

Please be aware that Blockscout will take a few extra steps to setup without automation. We'll get this fixed soon.
</Aside>

## Getting your machine ready
Expand Down Expand Up @@ -297,6 +303,12 @@ L1_GAS_TOKEN = "0xFF34B3d4Aee8ddCd6F9AFFFB6Fe49bD371b8a357"

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

<Aside type="danger">
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.
</Aside>

{/* TODO: Document using CLI for advanced configuration here. */}

### Generate Configuration Files

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

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.

### Pull Charts and Move Config Files
### Prep Charts Values

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.

To do this, run `scrollsdk setup prep-charts`

<Aside type="danger">
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:

`scrollsdk setup prep-charts --github-username=[username] --github-token=[token]`
</Aside>

After pulling the charts, the CLI tool will try to auto-fill each chart's `production.yaml` file.
To do this, run `scrollsdk setup prep-charts` and the CLI tool will try to auto-fill each chart's `production.yaml` file.

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` .

Expand Down

0 comments on commit 16e4100

Please sign in to comment.