Skip to content

Commit f5cdd43

Browse files
Turupawnknikolaeffjuve4everdghelmHolybasil
authored
Update prod branch from develop (#88)
* Removed trailing slashes in the urls (#63) Fix: faucet link broken because of the double slash * Fix: What's next link on ERC721 bridge page when you're on ERC721 NFT Bridge page and scrolling down to whats next you see ERC1155 Token Bridge tap, when you click on it. it doesn't take you to ERC1155 Token Bridge page. it will reload the same page. so i fixed by editing the whats next line. * Update: Add Bware Faucet (#64) * add bware faucet * fix dangling html close comment * fix: apply new logo (#66) * Rebranding (#69) * Update: 8/23/23 (#65) * Removed trailing slashes in the urls (#63) Fix: faucet link broken because of the double slash * Fix: What's next link on ERC721 bridge page when you're on ERC721 NFT Bridge page and scrolling down to whats next you see ERC1155 Token Bridge tap, when you click on it. it doesn't take you to ERC1155 Token Bridge page. it will reload the same page. so i fixed by editing the whats next line. * Update: Add Bware Faucet (#64) * add bware faucet * fix dangling html close comment --------- Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> * fix: apply new logo (#67) * update press link and change zero-knowledge to zero knowledge --------- Co-authored-by: Daniel Helm <[email protected]> Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> Co-authored-by: Holybasil <[email protected]> * Prod to develop fixing icons to resolve PRs to different branches (#72) * Update: 8/23/23 (#65) * Removed trailing slashes in the urls (#63) Fix: faucet link broken because of the double slash * Fix: What's next link on ERC721 bridge page when you're on ERC721 NFT Bridge page and scrolling down to whats next you see ERC1155 Token Bridge tap, when you click on it. it doesn't take you to ERC1155 Token Bridge page. it will reload the same page. so i fixed by editing the whats next line. * Update: Add Bware Faucet (#64) * add bware faucet * fix dangling html close comment --------- Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> * fix: apply new logo (#67) * fix: Apple touch icon 256x256 (#68) * Update prod for rebrand. (#71) * Removed trailing slashes in the urls (#63) Fix: faucet link broken because of the double slash * Fix: What's next link on ERC721 bridge page when you're on ERC721 NFT Bridge page and scrolling down to whats next you see ERC1155 Token Bridge tap, when you click on it. it doesn't take you to ERC1155 Token Bridge page. it will reload the same page. so i fixed by editing the whats next line. * Update: Add Bware Faucet (#64) * add bware faucet * fix dangling html close comment * fix: apply new logo (#66) * Rebranding (#69) * Update: 8/23/23 (#65) * Removed trailing slashes in the urls (#63) Fix: faucet link broken because of the double slash * Fix: What's next link on ERC721 bridge page when you're on ERC721 NFT Bridge page and scrolling down to whats next you see ERC1155 Token Bridge tap, when you click on it. it doesn't take you to ERC1155 Token Bridge page. it will reload the same page. so i fixed by editing the whats next line. * Update: Add Bware Faucet (#64) * add bware faucet * fix dangling html close comment --------- Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> * fix: apply new logo (#67) * update press link and change zero-knowledge to zero knowledge --------- Co-authored-by: Daniel Helm <[email protected]> Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> Co-authored-by: Holybasil <[email protected]> --------- Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> Co-authored-by: Holybasil <[email protected]> Co-authored-by: zzq0826 <[email protected]> --------- Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> Co-authored-by: Holybasil <[email protected]> Co-authored-by: zzq0826 <[email protected]> * Update blocks.mdx (#76) * Update erc721-nft-bridge.mdx (#78) * Update helper.tsx (#75) * Update/repo banner (#83) * update: new banner * add badges * fix not translate in React Components inside Astro (#85) * fixed broken links and fixed some whats-nexts (#87) * fix spelling of "Merkle" (#91) * Fixed wrong address (#90) * Update bridge-erc20-through-the-custom-gateway.mdx Fixed wrong address * Update bridge-erc20-through-the-custom-gateway.mdx * Update PureFooter.tsx (#84) Open a new target URL in new tab, current its overriding this page(main domain) --------- Co-authored-by: Kirill Nikolaev <[email protected]> Co-authored-by: monem <[email protected]> Co-authored-by: Daniel Helm <[email protected]> Co-authored-by: Holybasil <[email protected]> Co-authored-by: zzq0826 <[email protected]> Co-authored-by: Péter Garamvölgyi <[email protected]> Co-authored-by: diposs <[email protected]> Co-authored-by: ManuGodzilla <[email protected]> Co-authored-by: Anton Livaja <[email protected]> Co-authored-by: jrsurya <[email protected]>
1 parent d74468b commit f5cdd43

File tree

12 files changed

+20
-17
lines changed

12 files changed

+20
-17
lines changed

README.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
![Contribute to Scroll](./src/assets/banner.png)
2+
3+
[![Twitter Follow](https://img.shields.io/twitter/follow/Scroll_ZKP?style=social)](https://twitter.com/Scroll_ZKP)
4+
[![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/scroll)
5+
16
This is the open source project for the Scroll documentation.
27

38
## Developing
@@ -8,13 +13,9 @@ npm install && npm run dev
813

914
## Docs architecture
1015

11-
- All docs are markdown and stored in `/src/pages`.
16+
- All articles are markdown and stored in `/src/content/docs/`.
1217
- Navigation is JSON in `/src/config/sidebar.ts`
1318

14-
## Deployment
15-
16-
Managed by Scroll using Netlify at https://app.netlify.com/sites/scroll-documentation/overview.
17-
1819
## Credits
1920

2021
- Special thanks to the Chainlink team whose documentation we forked. Their repo is available [here](https://github.com/smartcontractkit/documentation) and viewable at [https://docs.chain.link/](https://docs.chain.link/).

astro-i18next.config.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,5 @@ export default {
33
defaultLocale: "en",
44
showDefaultLocale: true,
55
locales: ["en", "zh"],
6+
load: ["server", "client"],
67
}

src/assets/banner.png

45.7 KB
Loading

src/components/Footer/PureFooter/PureFooter.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ const Footer = () => {
3333
<p className={styles.title}>Follow Us</p>
3434
<div>
3535
{mediaList.map((item) => (
36-
<a external href={item.href} key={item.name}>
36+
<a external href={item.href} key={item.name} target="_blank">
3737
{<item.icon />}
3838
</a>
3939
))}

src/content/docs/en/developers/guides/bridge-erc20-through-the-custom-gateway.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@ contract L1Token is ERC20 {
3636

3737
## Step 2: Launch the counterpart token on Scroll Sepolia testnet
3838

39-
Next, launch you'll launch a counterpart to this token on Scroll, which will represent the original token on Sepolia. This token can implement custom logic to match that of the L1 token or even add additional features beyond those of the L1 token.
39+
Next, you'll launch a counterpart to this token on Scroll, which will represent the original token on Sepolia. This token can implement custom logic to match that of the L1 token or even add additional features beyond those of the L1 token.
4040

4141
For this to work:
4242

43-
- The token must implement the `IScrollStandardERC20`` interface in order to be compatible with the bridge.
43+
- The token must implement the `IScrollStandardERC20` interface in order to be compatible with the bridge.
4444
- The contract should provide the gateway address and the counterpart token addresses (the L1 token we just launched) under the `gateway()` and `counterpart()` functions. It should also allow the L2 gateway to call the token `mint()` and `burn()` functions, which are called when a token is deposited and withdrawn.
4545

46-
The following is a complete example of a token compatible with the bridge. To the constructor, you will pass the official Scroll Custom Gateway address (`0x31C994F2017E71b82fd4D8118F140c81215bbb37`) and the address of the token launched on Sepolia.
46+
The following is a complete example of a token compatible with the bridge. To the constructor, you will pass the official Scroll Custom Gateway address (`0x058dec71E53079F9ED053F3a0bBca877F6f3eAcf`) and the address of the token launched on Sepolia.
4747

4848
```solidity
4949
// SPDX-License-Identifier: MIT

src/content/docs/en/developers/guides/contract-deployment-tutorial.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: "Contract Deployment Tutorial"
55
lang: "en"
66
permalink: "developers/guides/contract-deployment-tutorial"
77
excerpt: "The Scroll Sepolia Testnet allows the community to deploy smart contracts on Scroll. In this tutorial, we will teach you how to deploy a contract on Scroll Sepolia."
8-
whatsnext: { "Contract Deployment Tutorial": "/developers/developer-quickstart/" }
8+
whatsnext: { "Scroll Messenger Cross-chain Interaction": "/developers/guides/scroll-messenger-cross-chain-interaction/" }
99
---
1010

1111
import Aside from "../../../../../components/Aside.astro"

src/content/docs/en/developers/guides/scroll-messenger-cross-chain-interaction.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ date: Last Modified
44
title: "Scroll Messenger Cross-chain Interaction"
55
lang: "en"
66
permalink: "developers/guides/scroll-messenger-cross-chain-interaction"
7+
whatsnext: { "Bridge ERC20 through the Custom Gateway": "/developers/guides/bridge-erc20-through-the-custom-gateway" }
78
excerpt: "In this example, we will launch a dummy smart contract on either Sepolia or Scroll Sepolia testnet and interact with it from the opposite chain."
89
---
910

src/content/docs/en/developers/scroll-contracts.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@ date: Last Modified
44
title: "Scroll Sepolia Contracts"
55
lang: "en"
66
permalink: "developers/scroll-contracts"
7+
whatsnext: { "Ethereum & Scroll Differences": "/developers/ethereum-and-scroll-differences" }
78
excerpt: "The network info and contract addresses you need to start with Scroll Sepolia Testnet."
89
---
910

src/content/docs/en/technology/bridge/cross-domain-messaging.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -217,7 +217,7 @@ function sendMessage(
217217

218218
Next, the cross-domain message hash is appended to `L2MessageQueue` by calling its `appendMessage` function. The `L2MessageQueue` contract maintains the [Withdraw Trie](#withdraw-trie), an append-only Merkle tree. Every time a new message is appended to the queue, the contract inserts it into the Withdraw Trie and updates the trie's root hash.
219219

220-
After the transaction batch containing users' L2-to-L1 messages is finalized on the L1 rollup contract, users need to submit corresponding _Execute Withdrawal_ transactions to call `relayMessageWithProof` method in the `L1ScrollMessenger` contract that executes the withdrawal on L1. Thanks to the Merle proofs, the finalization of withdrawal transactions on L1 is trustless and can be submitted by user themselves or by a third party on behalf of users.
220+
After the transaction batch containing users' L2-to-L1 messages is finalized on the L1 rollup contract, users need to submit corresponding _Execute Withdrawal_ transactions to call `relayMessageWithProof` method in the `L1ScrollMessenger` contract that executes the withdrawal on L1. Thanks to the Merkle proofs, the finalization of withdrawal transactions on L1 is trustless and can be submitted by user themselves or by a third party on behalf of users.
221221

222222
To make it easier to construct a withdraw MIP, Scroll maintains a service called Bridge History API. Bridge History API monitors `SentMessage` events emitted from `L2ScrollMessenger` and maintains a Withdraw Trie internally. It continuously generates Merkle proofs for every withdrawal messages. Users and third-party services can query Merkle proofs from the Bridge History API to include in the _Execute Withdrawal_ transactions.
223223

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,15 @@ First, users can directly submit transactions to L2 sequencers. To do so, users
6262

6363
Second, deposit and enforced transactions are originated on L1. Scroll L1 bridge contract provides three entry points for users and smart contracts to send transactions from the L1. All messages sent through these three entry points will be appended to the `L1MessageQueue` contract.
6464

65-
- The `ScrollGatewayRouter` contract and several standard token gateways allow users and contracts to deposit standard tokens to L2. See more details in the [Deposit Token Gateways](/-oscADc8SoKAOxjtpcEqKg).
66-
- The `L1ScrollMessenger` contract allows users and contracts to send arbitrary messages to L2. See more details in the [Sending Arbitrary Messages](/UPyw7afFQE6q-9CIdIRBag#Sending-Arbitrary-Messages).
67-
- The `EnforcedTxGateway` contract allows EOAs to initiate an enforced transaction from the same address to withdraw tokens or call other contracts on L2. See more details in the [Sending Enforced Transaction](/UPyw7afFQE6q-9CIdIRBag#Sending-Enforced-Transactions).
65+
- The `ScrollGatewayRouter` contract and several standard token gateways allow users and contracts to deposit standard tokens to L2. See more details in the [Deposit Token Gateways](/technology/bridge/deposit-gateways).
66+
- The `L1ScrollMessenger` contract allows users and contracts to send arbitrary messages to L2. See more details in the [Sending Arbitrary Messages](/technology/bridge/cross-domain-messaging#sending-arbitrary-messages).
67+
- The `EnforcedTxGateway` contract allows EOAs to initiate an enforced transaction from the same address to withdraw tokens or call other contracts on L2. See more details in the [Sending Enforced Transaction](/technology/bridge/cross-domain-messaging#sending-enforced-transactions).
6868

6969
The Scroll sequencer periodically starts a new mining job. It pulls the L1 messages from the `L1MessageQueue` contract and transactions in the L2 mempool and seals a block. Once a transaction is included in a L2 block, its status becomes `Confirmed`.
7070

7171
### Commit Transaction Data
7272

73-
The rollup node collects new L2 blocks and packs them into chunks and batches (see more details in [Transaction Batching](/RxRWLFtiQ7W_wbc0jMnQNA)). Periodically it sends a _Commit Transaction_ that posts the data of a batch of transactions to the L1 `ScrollChain` contract. After the Commit Transaction is finalized in a L1 block, the status of the transactions in this batch becomes `Committed`. At this time, users can reconstruct L2 state themselves completely based on the committed data from the L1 contract.
73+
The rollup node collects new L2 blocks and packs them into chunks and batches (see more details in [Transaction Batching](/technology/chain/transactions#transaction-batching)). Periodically it sends a _Commit Transaction_ that posts the data of a batch of transactions to the L1 `ScrollChain` contract. After the Commit Transaction is finalized in a L1 block, the status of the transactions in this batch becomes `Committed`. At this time, users can reconstruct L2 state themselves completely based on the committed data from the L1 contract.
7474

7575
### Finalize Transactions
7676

0 commit comments

Comments
 (0)