Skip to content

Commit 333eddc

Browse files
committed
Merge branch 'develop' of github.com:scroll-tech/scroll-documentation into fix/past-issues
2 parents 95bb651 + ae2bc86 commit 333eddc

File tree

10 files changed

+17
-15
lines changed

10 files changed

+17
-15
lines changed

src/content/docs/en/developers/l1-and-l2-bridging.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,12 @@ In addition to token transfers, the Scroll Messenger contract enables cross-chai
2626

2727
<ClickToZoom src={L1GatewayWHITE} />
2828

29-
There are many entry points from the user to the Scroll bridge. This will depend on what you want to do and how you want to do it. If you want to send ETH or ERC20 tokens, you should use the `GatewayRouter` . If you want to send NFTs, you should use the `L1ERC721Gateway` or `L1ERC1155Gateway`. If you want to send arbitrary data, you should use the `L1ScrollMessenger`. All Gateway transfers use the Scroll Messenger to send assets cross-chain, whose job is to append the transactions to the Message Queue for L2 inclusion.
29+
There are many entry points from the user to the Scroll bridge. This will depend on what you want to do and how you want to do it. If you want to send ETH or ERC20 tokens, you should use the `GatewayRouter`. If you want to send NFTs, you should use the `L1ERC721Gateway` or `L1ERC1155Gateway`. If you want to send arbitrary data, you should use the `L1ScrollMessenger`. All Gateway transfers use the Scroll Messenger to send assets cross-chain, whose job is to append the transactions to the Message Queue for L2 inclusion.
3030

3131
## L2 Gateway architecture
3232

3333
<ClickToZoom src={withdrawWHITE} />
3434

35-
Regarding possible permissionlessly callable entry points, the L2 Gateway Architecture is very similar to L1. The difference is that when sending a message from L2, calling the `appendMessage` function will store the message in an append-only binary merkle tree (aka withdraw tree) in the `L2MessageQueue`. When a new message is sent to the `L2MessageQueue`, the relayer will detect it and store it in the database. When the block is finalized, it will generate a proof of the new merkle path and pass it to the L1geth node to execute on `L1ScrollMessenger` . All finalized withdraw roots will be stored in the rollup contract so we can verify the proof against them. In the next Scroll versions, the Relayer won't be needed since all users will be able to finalize the transaction on L1.
35+
Regarding possible permissionlessly callable entry points, the L2 Gateway Architecture is very similar to L1. The difference is that when sending a message from L2, calling the `appendMessage` function will store the message in an append-only binary merkle tree (aka withdraw tree) in the `L2MessageQueue`. When a new message is sent to the `L2MessageQueue`, the relayer will detect it and store it in the database. When the block is finalized, it will generate a proof of the new merkle path and pass it to the L1geth node to execute on `L1ScrollMessenger`. All finalized withdraw roots will be stored in the rollup contract so we can verify the proof against them. In the next Scroll versions, the Relayer won't be needed since all users will be able to finalize the transaction on L1.
3636

37-
In the upcoming sections, we will explore the technical aspects of the bridge, including the smart contract API required to utilize its capabilities. Detailed guides with code examples are provided in the Developer Guides section to assist developers and users in understanding and implementing these functionalities.
37+
In the upcoming sections, we will explore the technical aspects of the bridge, including the smart contract API required to utilize its capabilities. Detailed guides with code examples are provided in the Developer Guides section to assist developers and users in understanding and implementing these functionalities.

src/content/docs/en/developers/l1-and-l2-bridging/erc1155-token-bridge.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ interface IScrollERC1155 {
5252
/// @notice Batch mint some token to recipient's account.
5353
/// @dev Gateway Utilities, only gateway contract can call
5454
/// @param _to The address of recipient.
55-
/// @param _tokenIds The token id to mint.
55+
/// @param _tokenIds The list of token ids to mint.
5656
/// @param _amounts The list of corresponding amount of token to mint.
5757
/// @param _data The data passed to recipient
5858
function batchMint(
@@ -158,5 +158,5 @@ Update the mapping that connects an ERC1155 token contract from L2 to L1.
158158

159159
| Parameter | Description |
160160
| --------- | ------------------------------------------------- |
161-
| \_l1Token | The address of th ERC1155 token in L1. |
161+
| \_l1Token | The address of the ERC1155 token in L1. |
162162
| \_l2Token | The address of corresponding ERC1155 token in L2. |

src/content/docs/en/developers/l1-and-l2-bridging/eth-and-erc20-token-bridge.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ All Gateway contracts will form the message and send it to the `L1ScrollMessenge
3333
address of the `L1ScrollMessenger`.
3434
</Aside>
3535

36-
When a new block gets created on L1, the Watcher will detect the message on the `L1MessageQueue` and will pass it to the Relayer service, which will submit the transaction to the L2 via the l2geth node. Finally, the l2geth node will pass the transaction to the `L2ScrollMessagner` contract for execution on L2.
36+
When a new block gets created on L1, the Watcher will detect the message on the `L1MessageQueue` and will pass it to the Relayer service, which will submit the transaction to the L2 via the l2geth node. Finally, the l2geth node will pass the transaction to the `L2ScrollMessenger` contract for execution on L2.
3737

3838
## Withdraw ETH and ERC20 tokens from L2
3939

@@ -76,7 +76,7 @@ interface IScrollStandardERC20 {
7676
/// @param _amount The amount of token to mint.
7777
function mint(address _to, uint256 _amount) external;
7878
79-
/// @notice Mint some token from account.
79+
/// @notice Burn some token from account.
8080
/// @dev Gateway Utilities, only gateway contract can call
8181
/// @param _from The address of account to burn token.
8282
/// @param _amount The amount of token to mint.

src/content/docs/en/developers/verifying-smart-contracts.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ npx hardhat verify --network scrollSepolia 0xD9880690bd717189cC3Fbe7B9020F27fae7
7676
```
7777

7878
<Aside type="danger" title="Warning">
79-
You may receive an error stating `etherscan.apiKey.trim is not a function` . If so, you need to update
79+
You may receive an error stating `etherscan.apiKey.trim is not a function`. If so, you need to update
8080
`@nomiclabs/hardhat-etherscan` to be able to support custom chains. Try running `npm update
8181
@nomiclabs/hardhat-etherscan`
8282
</Aside>
@@ -98,4 +98,4 @@ forge verify-contract <contract address> <contract name> \
9898
```
9999
<Aside type="caution" title="Caution">
100100
Do not specify the chain ID.
101-
</Aside>
101+
</Aside>

src/content/docs/en/getting-started/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ whatsnext: { "User Guide": "/en/user-guide/", "Building on Scroll": "/en/develop
1010

1111
#### Welcome to the Scroll docs!
1212

13-
Scroll is a security-focused scaling solution for Ethereum, using innovations in scaling design and zero knowledge proofs to build a new layer on Ethereum. The Scroll network is more accessible, more responsive, and can support more users at once than Ethereum alone, and if you've ever used or developed an application on Ethereum, you'll be right at home on Scroll.
13+
Scroll is a security-focused scaling solution for Ethereum, using innovations in scaling design and zero knowledge proofs to build a new layer on Ethereum. The Scroll network is more accessible, more responsive and can support more users at once than Ethereum alone. If you've ever used or developed an application on Ethereum, you'll be right at home on Scroll.
1414

1515
Want to try out the Scroll Sepolia testnet with free assets before using Scroll? Check out our [User Guide](/user-guide/).
1616

@@ -20,7 +20,7 @@ Scroll is building the technology to scale Ethereum.
2020

2121
While Ethereum is the leading blockchain network for powering decentralized applications, its popularity also brings higher costs, creating a barrier to adoption for the next wave of users and developers.
2222

23-
Leveraging cutting-edge research in zero knowledge proofs (”zk”), Scroll is building a Layer 2 rollup network on Ethereum. The team, in open-source collaboration with others in the Ethereum community, has created a “zkEVM” that allows for all activity on the network, which behaves just like Ethereum, to be secured by smart contracts _on_ Ethereum. The network publishes all of the transactions to Ethereum, and the zkEVM creates and publishes cryptographic "proofs" that the Scroll network is following the rules of Ethereum.
23+
Leveraging cutting-edge research in zero knowledge (”zk”) proofs , Scroll is building a Layer 2 rollup network on Ethereum. The team, in open-source collaboration with others in the Ethereum community, has created a “zkEVM” that allows for all activity on the network, which behaves just like Ethereum, to be secured by smart contracts _on_ Ethereum. The network publishes all of the transactions to Ethereum, and the zkEVM creates and publishes cryptographic "proofs" that the Scroll network is following the rules of Ethereum.
2424

2525
Ultimately, Ethereum smart contracts verify that every transaction on Scroll is valid for these proofs, lending the network incredible security, decentralization, and censorship resistance. This level of security and scalability for Ethereum is only possible with recent breakthroughs in zero knowledge cryptography, blockchain protocol design, and hardware acceleration.
2626

src/content/docs/en/learn/zero-knowledge/kzg-commitment-scheme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ There are established methods of conducting trusted setup ceremonies with weak t
5151

5252
- Given a commitment $c = [P(\tau)]_1$, an evaluation $P(a) = b$, and a proof $\pi = [Q(\tau)]_1$
5353
- Verify that $e(\pi, [\tau - a]_2) = e(c - [b]_1, h)$
54-
- Some algebra shows that this is equivalent to checking that that the quotient polynomial is correctly formed at $\tau$: $Q(\tau) = \frac{P(\tau) -b}{\tau-a}$
54+
- Some algebra shows that this is equivalent to checking that the quotient polynomial is correctly formed at $\tau$: $Q(\tau) = \frac{P(\tau) -b}{\tau-a}$
5555
$$
5656
\begin{align*}
5757
& e(\pi, [\tau - a]_2) = e(c - [b]_1, h) \\ \iff

src/content/docs/en/technology/bridge/withdraw-gateways.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The withdrawal of ETH token works as follows.
5959

6060
The withdrawal of ERC20 tokens works as follows.
6161

62-
1. To withdraw ERC20 tokens from L1 to L2, users can use `L2GatewayRouter.withdrawERC20` and `L2GatewayRouter.withdrawERC20AndCall` showed below.
62+
1. To withdraw ERC20 tokens from L2 to L1, users can use `L2GatewayRouter.withdrawERC20` and `L2GatewayRouter.withdrawERC20AndCall` showed below.
6363

6464
```solidity
6565
function withdrawERC20(address _token, uint256 _amount, uint256 _gasLimit) external payable;

src/content/docs/en/technology/chain/blocks.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ The block header in Scroll mirrors the structure of Ethereum's. However, certain
2727
| `gasLimit` | The maximum gas allowed in the block. |
2828
| `gasUsed` | The gas used in the block. |
2929
| `timestamp` | The block time. |
30-
| `extraData` | Signature by the block's signer, followd by arbitrary additional data. |
30+
| `extraData` | Signature by the block's signer, followed by arbitrary additional data. |
3131
| `mixHash` | Always 0. |
3232
| `nonce` | Always 0. |
3333
| `baseFee` | Currently empty in Scroll because we haven't enabled the EIP-1559. |

src/content/docs/en/user-guide/common-errors.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ If no error or console logs appear, this is likely due to a nonce issue, please
3232

3333
## Block Explorer shows "Internal server error"
3434

35-
Use an incognito window, or open your browser developer console and remove the `_explorer_key` cookie (or all cookies). [See this guide for how to remove cookies.](https://www.contentstack.com/docs/developers/how-to-guides/clear-caches-and-cookies-in-different-browsers/).
35+
Use an incognito window, or open your browser developer console and remove the `_explorer_key` cookie (or all cookies). [See this guide for how to remove cookies](https://www.contentstack.com/docs/developers/how-to-guides/clear-caches-and-cookies-in-different-browsers/).
3636

3737
## Sending max amount of Ether in MetaMask results in a "Failed" error
3838

src/content/docs/en/user-guide/faucet.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ Here are a few Sepolia faucet apps:
2121
- [https://faucet.quicknode.com/drip](https://faucet.quicknode.com/drip)
2222
- [https://faucet.chainstack.com](https://faucet.chainstack.com)
2323
- [https://infura.io/faucet/sepolia](https://infura.io/faucet/sepolia)
24+
- [https://www.sepoliafaucet.io/](https://www.sepoliafaucet.io/)
2425
- [https://www.ethereum-ecosystem.com/faucets/ethereum-sepolia](https://www.ethereum-ecosystem.com/faucets/ethereum-sepolia)
2526

2627
Once you receive ETH on Sepolia, you should see it in your wallet on the _Sepolia Network_. It may take a few seconds for them to appear, but you can check the status by looking for a transaction to your address on a [Sepolia Block Explorer](https://sepolia.etherscan.io/).
@@ -38,3 +39,4 @@ If you don't want to interact with the bridge, some faucets directly distribute
3839
- [https://faucet.quicknode.com/scroll/sepolia](https://faucet.quicknode.com/scroll/sepolia)
3940
- [https://bwarelabs.com/faucets/scroll-testnet](https://bwarelabs.com/faucets/scroll-testnet)
4041
- [https://scroll.faucetme.pro](https://scroll.faucetme.pro)
42+
- [https://www.l2faucet.com/scroll](https://www.l2faucet.com/scroll)

0 commit comments

Comments
 (0)