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.

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

fix: typos #412

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ For Canvas and badge questions, please join the [Scroll dev support channel](htt
| --- | --- |
| Name | Name your badge to be *descriptive and creative* |
| Description | Brief description of the *purpose* of this badge and *who is eligible* |
| Structure | *One single attribute*<br/> *Multiple Badges with levels* trigged by different actions and traits |
| Structure | *One single attribute*<br/> *Multiple Badges with levels* triggered by different actions and traits |
| Category | *Achievement*: tasks you have done. e.g. Scroll Origin NFTs, tasks completion badge <br/> *Identities*: who you are. e.g. Ethereum year, Gitcoin passport, NFT community badge |
| Issuance method | *Fully permissionless*: meaning your badge can be automatically issued by checking smart contract conditions <br/> *Gifted*: Badges can also be issues with no user interaction, requires APIs <br/> *Backend-authorized*: requires APIs to enable eligibility criteria |
| Support link | *Support channel link* to your Discord/Telegram group |
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/sdk/guides/devnet-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ section: sdk
date: Last Modified
title: "Running Scroll SDK Devnet"
lang: "en"
permalink: "sdk/guides/devnet-deploymnet"
permalink: "sdk/guides/devnet-deployment"
excerpt: "Run the Scroll SDK devnet locally to get started."
---

Expand Down Expand Up @@ -454,7 +454,7 @@ You should now be able to explore the stack on your local machine and using your
- Until some activity on the network has started, gas errors may occur.
- [Rollup Explorer](http://frontends.scrollsdk/rollupscan?page=1&per_page=10)
- Shows committed batches and finalized batches
- [Granfana Dashboards](http://grafana.scrollsdk/)
- [Grafana Dashboards](http://grafana.scrollsdk/)
- Login
- User: `admin`
- Pass: `scroll-sdk`
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -455,7 +455,7 @@ Go visit the frontends, connect your wallet and try to bridge some funds!
## Next Steps

### Disable L1 Data Fee
On Scroll, transactions on L2 have two components -- the gas costs for execution and an L1 data fee. When gas on your network is paid in a token that has no standard relationship to the currency being used to pay for data fees on the L1, you will need to introduce tooling that can set the gas caluclation "scalar" values.
On Scroll, transactions on L2 have two components -- the gas costs for execution and an L1 data fee. When gas on your network is paid in a token that has no standard relationship to the currency being used to pay for data fees on the L1, you will need to introduce tooling that can set the gas calculation "scalar" values.

At the moment, we have not built any automated tooling for this, and instead of viewing the ERC20 value as 1:1 with Sepolia Ether, we suggest setting the scalars to 0 to eliminate these overheads.

Expand Down Expand Up @@ -718,7 +718,7 @@ You can modify the `config.toml` values of `TEST_ENV_MOCK_FINALIZE_ENABLED` and
{/* TODO: Update to point at actual charts once available. */}


{/* ### TODO: Add Graphana charts for Monitoring
{/* ### TODO: Add Grafana charts for Monitoring

To quickly get started with Grafana, run the following command:

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/sdk/guides/production-deployment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ section: sdk
date: Last Modified
title: "Running Scroll SDK in Production"
lang: "en"
permalink: "sdk/guides/production-deploymnet"
permalink: "sdk/guides/production-deployment"
excerpt: "Run the Scroll SDK in production."
---

Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/sdk/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ section: sdk
title: "Scroll SDK"
lang: "en"
permalink: "sdk/"
excerpt: "Learn more about how to depoly your own rollup using Scroll's zkEVM"
excerpt: "Learn more about how to deploy your own rollup using Scroll's zkEVM"
---

import NavCard from "../../../../components/NavCard.astro"
Expand All @@ -19,7 +19,7 @@ Scroll SDK allows anyone to quickly deploy an instance of the Scroll zkEVM and i

For an introduction on why, and how it fits into our broader multichain vision, read [Scroll SDK & Gadgets: Building the Foundation for Ethereum's Multichain Future](https://scroll.io/blog/scroll-sdk-and-gadgets-building-the-foundation-for-ethereums-multichain-future).

We're working with a number of clients, technology parters, and service providers to build the most robust ZK stack for Ethereum.
We're working with a number of clients, technology partners, and service providers to build the most robust ZK stack for Ethereum.

If you want to dive deeper and try launching your own L2, keep reading and check out the additional resources.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ section: sdk
title: "Upgrading Scroll SDK"
lang: "en"
permalink: "sdk/operation/contracts-verification"
excerpt: "Learn more about verify smart contract scource code on blockchain explorer"
excerpt: "Learn more about verify smart contract source code on blockchain explorer"
---

import Steps from '../../../../../components/Steps/Steps.astro';
Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/en/sdk/operation/gas-and-fees.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ L2 transaction fees are set as a minimum "floor" for the execution component of

This is set with `--miner.gasprice` on the sequencer. You can modify this value and `--gpo.ignoreprice` in the chart by overriding the `L2GETH_MIN_GAS_PRICE` environment variable [here](https://github.com/scroll-tech/scroll-sdk/blob/main/charts/l2-sequencer/values.yaml#L106).

Additionally, you could modify the `--gpo.percentile` and `--gpo.blocks` arguements, but will need to manually modify the `l2-sequencer` chart.
Additionally, you could modify the `--gpo.percentile` and `--gpo.blocks` arguments, but will need to manually modify the `l2-sequencer` chart.

Lastly, RPC nodes (or any node that accepts transactions) should set `--gpo.congestionthreshold`, which we default to 500. This configuration allows nodes to provide more accurate fee estimate. The value is the number of pending transactions to consider the network congested and suggest a minimum tip cap if there are fewer pending transactions in the txpool.[^congestion-threshold]

Expand Down Expand Up @@ -64,7 +64,7 @@ blob_util_ratio = 87.1%
// formula to calculate scalars
// tx_per_block: average transaction number per L2 block
// tx_per_batch: average transaction number per batch
// fluctuation_multiplier: multiplier used to pervent loss from transaction number and L1 gas price fluctuation
// fluctuation_multiplier: multiplier used to prevent loss from transaction number and L1 gas price fluctuation
commitScalar = (1382.58 / tx_per_block + 71621.32 / tx_per_batch) * fluctuation_multiplier * 1e9
blobScalar = fluctuation_multiplier / compression_ratio / blob_util_ratio * 1e9
```
Expand All @@ -82,7 +82,7 @@ We're currently working on tooling to help operators calculate and automate upda

### Claiming Fees from the Vault

As L2 Fees accumulate in the L2FeeVault, any user can call the `withdrawl` method to "claim" these fees. This will bridge the funds to the `L1_FEE_VAULT_ADDR` address (configured in `config.toml`) on the L1 chain.
As L2 Fees accumulate in the L2FeeVault, any user can call the `withdrawal` method to "claim" these fees. This will bridge the funds to the `L1_FEE_VAULT_ADDR` address (configured in `config.toml`) on the L1 chain.

After the funds are bridged, the bridged funds will still need to be claimed on L1 with a proof that can be easily obtained using the `bridge-history-api`. To see this process on Scroll, see [Finalizing Transactions on L1](/en/developers/l1-and-l2-bridging/the-scroll-messenger/#finalizing-transactions-on-l1)

Expand All @@ -108,7 +108,7 @@ Basic configuration for the Gas Oracle can be made in the `config.toml` file bef

#### config.toml [gas-token] values

- `GAS_ORACLE_INCORPORATE_TOKEN_EXCHANGE_RATE_ENANBLED`
- `GAS_ORACLE_INCORPORATE_TOKEN_EXCHANGE_RATE_ENABLED`
- if `true`, includes the L2/L1 exchange rate into gas price. *Should only set to true when alternative gas token enabled.*
- Default: `false`
- `EXCHANGE_RATE_UPDATE_MODE`
Expand Down
10 changes: 5 additions & 5 deletions src/content/docs/en/sdk/operation/security-and-recovery.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The well-being of your users is your responsibility, and we urge you to consider

## Protocol Security & Risks

For a comprehensive overview of the security of the protocol, L2Beat's [overview of Scroll](https://l2beat.com/scaling/projects/scroll#risk-summary) is a great place to understand the risks, centalization points and permissioned operators on Scroll chain. Because Scroll is a single entity (who also built the tech), the risk factors may increase as you coordinate with external parties (ie RaaS providers).
For a comprehensive overview of the security of the protocol, L2Beat's [overview of Scroll](https://l2beat.com/scaling/projects/scroll#risk-summary) is a great place to understand the risks, centralization points and permissioned operators on Scroll chain. Because Scroll is a single entity (who also built the tech), the risk factors may increase as you coordinate with external parties (ie RaaS providers).

<Aside>
For any discoveries of critical vulnerabilities outside of the scope of the bug bounty program, please also send reports to [email protected].
Expand Down Expand Up @@ -78,11 +78,11 @@ By default, Scroll SDK's production deployments are configured to store "hot" pr

We intend to add support for Web3Signer in the future as well, allowing more restricted access to apply to a single service.

For more information on implemententing access control to specific parts of your cluster, see [Kubernetes: Using RBAC Authorization](https://kubernetes.io/docs/reference/access-authn-authz/rbac/).
For more information on implementing access control to specific parts of your cluster, see [Kubernetes: Using RBAC Authorization](https://kubernetes.io/docs/reference/access-authn-authz/rbac/).

## Pausing the Bridge

In extreme security instances, you may need to pause the bridge. The easiest way to do this quickly from the infrastructure operator is to bring the rollup node offline. This way, even if blocks contine to be produced, finalization (and thus new withdrawals) will not be processed until the `rollup-node` is back online.
In extreme security instances, you may need to pause the bridge. The easiest way to do this quickly from the infrastructure operator is to bring the rollup node offline. This way, even if blocks continue to be produced, finalization (and thus new withdrawals) will not be processed until the `rollup-node` is back online.

## Key Rotation for Rollup Accounts

Expand Down Expand Up @@ -168,7 +168,7 @@ Ensure you maintain backups of both old and new keys until you've confirmed the

## Recovering from a Infrastructure Failure

Recoving from an infrastructure failure will depend on what components are affected.
Recovering from an infrastructure failure will depend on what components are affected.

#### Database Failure

Expand All @@ -183,7 +183,7 @@ We recommend having at least one hot standby sequencer to take its place. This s
**If all of your sequencer machines are lost:**

You will need either:
- Sync a new full node from gensis (assuming there are full nodes remaining somewhere in your p2p network).
- Sync a new full node from genesis (assuming there are full nodes remaining somewhere in your p2p network).
- Repurpose a synced RPC node. "Converting" it to be the sequencer by creating a new sequencer chart that takes over the RPC node's Persistent Volume Claim.

**If all full nodes in the network are lost:**
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/sdk/technical-stack/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Contained in the `[gas-token]` section.
| ALTERNATIVE_GAS_TOKEN_ENABLED | Enables using an alternative gas token instead of ETH. | false |
| EXAMPLE_GAS_TOKEN_DECIMAL | Decimal places for the example gas token. | 6 |
| L1_GAS_TOKEN | Address of the L1 ERC20 gas token contract. | `0x68a041e7c20Afa4784b5d9C63246c89545Ac0E66` |
| GAS_ORACLE_INCORPORATE_TOKEN_EXCHANGE_RATE_ENANBLED | Enables incorporating token exchange rates in gas oracle. | false |
| GAS_ORACLE_INCORPORATE_TOKEN_EXCHANGE_RATE_ENABLED | Enables incorporating token exchange rates in gas oracle. | false |
| EXCHANGE_RATE_UPDATE_MODE | Mode for updating exchange rates. | `Fixed` |
| FIXED_EXCHANGE_RATE | Fixed exchange rate value when using Fixed mode. | `0.01` |
| TOKEN_SYMBOL_PAIR | Symbol pair for the token exchange. | `UNIETH` |
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/sdk/technical-stack/contracts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Although there are many contracts deployed during a new chain deployment, the mo
### Scroll Message Queues

- Deployed to L1 with a proxy and pre-deployed to L2
- On L1, every depost to the bridge is added as a message to the L1 message queue.
- On L1, every deposit to the bridge is added as a message to the L1 message queue.
- Messages are read by `l2geth` instances, including the sequencer, and brought into the Scroll chain via L1Message transaction types.
- On L2, every withdrawal sent through the bridge is added as a message, and each block's resulting withdraw root is made available after finalization on the L1 Rollup Contract.
- At any time, a user can permissionlessly generate proof to [finish relaying the message on L1](/en/developers/l1-and-l2-bridging/the-scroll-messenger#finalizing-transactions-on-l1).
Expand Down Expand Up @@ -102,7 +102,7 @@ curl --location 'http://l1-devnet.scrollsdk/' \
To fund an L2 address directly via the L1 bridge, you can run the command below, replacing the RPC and setting a private key of an account funded on L1 and a recipient address on L2.

```bash
cast send --rpc-url https://rpc2.sepolia.org --private-key "$PRIVATE_KEY" "$L1_GATEWAY_ROUTER_PROXY_ADDR" "depositETH(address,uint256,uint256)" "$L2_RECIPENT_ADDR" "1ether" "300000" --value "1.1ether"
cast send --rpc-url https://rpc2.sepolia.org --private-key "$PRIVATE_KEY" "$L1_GATEWAY_ROUTER_PROXY_ADDR" "depositETH(address,uint256,uint256)" "$L2_RECIPIENT_ADDR" "1ether" "300000" --value "1.1ether"
```

You can also use the interactive `scrollsdk helper fund-accounts --layer=2 [--private-key=<private-key>]` command to fund an L2 address, optionally passing a private key as funder.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/sdk/technical-stack/proof-generation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Because different "testnet" contracts are deployed depending on if `TEST_ENV_MOC

## Outsourcing Proof Generation to External Service Providers

Teams shouldn't need to become ZK infrastructure experts (or professional GPU sourcers) to run a chain. We've partnered with proof generation specialists to make outsoucing proof generation as easy as deploying one more chart.
Teams shouldn't need to become ZK infrastructure experts (or professional GPU sourcers) to run a chain. We've partnered with proof generation specialists to make outsourcing proof generation as easy as deploying one more chart.

Using a proof generation service offers the following benefits:
- Generate proofs on-demand through API-based services
Expand Down Expand Up @@ -71,7 +71,7 @@ Our automation code for deploying a prover differs from the rest of the stack. B

The Ansible playbook for running a prover is available in the GitHub repo [here](https://github.com/scroll-tech/scroll-sdk/tree/develop/ansible/playbooks).

### Prequisities
### Prerequisites

- One ubuntu server with at least 256GB memory, 32 cores, and a GPU with at least 20GB memory.
- One user with `sudo` access, no password, and all permissions -- or you can change the [shared-vars.yaml](https://github.com/scroll-tech/scroll-sdk/blob/develop/ansible/playbooks/vars/shared-vars.yaml) to add the `ansible_become_password` variable in your file.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/en/sdk/technical-stack/services.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ The `config.toml` file is used to generate various service-specific configuratio

Each service has a number configuration values -- some quite nuanced.

In most instances, if it is not directly set or calculated from values in the `config.toml`, a sensible default is used. Occassionally, a feature most operators do not need during their initial deployment is here as well (for example LDAP configuration for the `admin-system-backend`). If you manually change these values, keep in mind that the `config.toml` processing script may overwrite your customizations -- please use git commits track changes.
In most instances, if it is not directly set or calculated from values in the `config.toml`, a sensible default is used. Occasionally, a feature most operators do not need during their initial deployment is here as well (for example LDAP configuration for the `admin-system-backend`). If you manually change these values, keep in mind that the `config.toml` processing script may overwrite your customizations -- please use git commits track changes.

### Ingress

Expand Down Expand Up @@ -206,7 +206,7 @@ The [Rollup Explorer Backend](https://github.com/scroll-tech/rollup-explorer-bac

#### Rollup Node (`rollup-node`)

The Rollup Node (also called the [Rollup Relayer](https://github.com/scroll-tech/scroll/tree/develop/rollup)) is a core component of the Scroll SDK architecture. It plays a crucial role in managing the rollup process, by proposing chunks and batches, commiting those to the basechain and relaying proofs for finalization.
The Rollup Node (also called the [Rollup Relayer](https://github.com/scroll-tech/scroll/tree/develop/rollup)) is a core component of the Scroll SDK architecture. It plays a crucial role in managing the rollup process, by proposing chunks and batches, committing those to the basechain and relaying proofs for finalization.

#### L1 Explorer (`l1-explorer`)

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/en/user-guide/bridge.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ It could take between **8 to 14 minutes** (awaiting block to become [_Safe_](htt

{/* <ClickToZoom src={bridge1} /> */}

{/* The pop-up panel lists the most recent transactions made in the Bridge app. There are two statuses: Sepolia status and Scroll Sepolia status. For deposit transactions (L1 -> L2), once your transaction becomes _Safe_ on Sepolia (**8 to 14 minutes**), you will see the **`success`** status shown. Your funds will be relayed to Scoll Sepolia after this. */}
{/* The pop-up panel lists the most recent transactions made in the Bridge app. There are two statuses: Sepolia status and Scroll Sepolia status. For deposit transactions (L1 -> L2), once your transaction becomes _Safe_ on Sepolia (**8 to 14 minutes**), you will see the **`success`** status shown. Your funds will be relayed to Scroll Sepolia after this. */}

{/* The Recent Bridge Transactions window should give you an estimate of the time expected before your transaction is _Safe_ on Sepolia. */}

Expand Down