-
Notifications
You must be signed in to change notification settings - Fork 2.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(website): create testnet docs (#428)
- Loading branch information
Showing
34 changed files
with
335 additions
and
56 deletions.
There are no files selected for viewing
5 changes: 3 additions & 2 deletions
5
...es/website/docs/reference/_category_.json β ...site/docs/alpha-1-testnet/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,8 @@ | ||
{ | ||
"label": "Reference", | ||
"label": "Alpha-1 Testnet Guide", | ||
"collapsed": false, | ||
"link": { | ||
"type": "generated-index" | ||
} | ||
}, | ||
"position": 2 | ||
} |
25 changes: 25 additions & 0 deletions
25
packages/website/docs/alpha-1-testnet/configure-wallet.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
import AddEthereumChainButton from "../../src/components/AddEthereumChainButton"; | ||
|
||
# β Add networks to wallet | ||
|
||
## Automatically add networks | ||
|
||
Use the buttons below to add Ethereum A1 and Taiko A1 to any wallet that supports `wallet_addEthereumChain` (e.g., MetaMask). | ||
|
||
| Network | Add to wallet | | ||
| ----------- | ------------------------------------------------------------------ | | ||
| Ethereum A1 | <AddEthereumChainButton buttonText="Add to wallet β" chain="l1"/> | | ||
| Taiko A1 | <AddEthereumChainButton buttonText="Add to wallet β" chain="l2"/> | | ||
|
||
## Manually add networks | ||
|
||
Use this RPC configuration to add Ethereum A1 and Taiko A1 to other wallets. | ||
|
||
| Network | Chain ID | RPC URL | Symbol | Block Explorer URL | | ||
| ----------- | -------- | -------------------------- | ------ | ------------------------------- | | ||
| Ethereum A1 | 31338 | https://l1rpc.a1.taiko.xyz | ETH | https://l1explorer.a1.taiko.xyz | | ||
| Taiko A1 | 167003 | https://l2rpc.a1.taiko.xyz | ETH | https://l2explorer.a1.taiko.xyz | |
14 changes: 14 additions & 0 deletions
14
packages/website/docs/alpha-1-testnet/deploy-a-contract.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,14 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# π Deploy a contract | ||
|
||
We will deploy a smart contract to Taiko A1 using Foundry. | ||
|
||
1. Follow the Foundry Book to install Foundry and init the default project: https://book.getfoundry.sh/getting-started/first-steps | ||
2. From `~/hello_foundry` run `forge create --legacy --rpc-url https://l2rpc.a1.taiko.xyz --private-key <yourPrivateKey> src/Counter.sol:Counter` (replace `<yourPrivateKey>` with the private key of the account deploying the contract) | ||
|
||
We are using the `--legacy` flag because EIP-1559 is currently disabled on Taiko. We have plans to re-enable it in the future. | ||
|
||
You can use the block explorer to verify that the contract was deployed: https://l2explorer.a1.taiko.xyz/ |
44 changes: 44 additions & 0 deletions
44
packages/website/docs/alpha-1-testnet/explore-the-network.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
--- | ||
sidebar_position: 7 | ||
--- | ||
|
||
# π Explore the network | ||
|
||
Taiko's Alpha-1 testnet consists of L1 / L2 nodes with all [Taiko protocol contracts](/docs/category/contract-documentation) deployed. The mining interval of the L1 node is set to 12 seconds. | ||
|
||
## Endpoints | ||
|
||
### L1 | ||
|
||
- **Block Explorer:** <https://l1explorer.a1.taiko.xyz> | ||
- **HTTP RPC Endpoint:** <https://l1rpc.a1.taiko.xyz> | ||
- **Web Socket RPC Endpoint:** <wss://l1ws.a1.taiko.xyz> | ||
- **ETH faucet:** <https://l1faucet.a1.taiko.xyz> | ||
- **Chain ID:** `31338` | ||
|
||
### L2 | ||
|
||
- **Block Explorer:** <https://l2explorer.a1.taiko.xyz> | ||
- **HTTP RPC Endpoint:** <https://l2rpc.a1.taiko.xyz> | ||
- **Web Socket RPC Endpoint:** <wss://l2ws.a1.taiko.xyz> | ||
- **ETH faucet:** <https://l2faucet.a1.taiko.xyz> | ||
- **Chain ID:** `167003` | ||
|
||
## Contract addresses | ||
|
||
### L1 | ||
|
||
- **TaikoL1:** `0x7B3AF414448ba906f02a1CA307C56c4ADFF27ce7` | ||
- **TokenVault:** `0xD0dfd5baCf160B97C8eE3ecb463F18c08673160c` | ||
- **Bridge:** `0x3612E284D763f42f5E4CB72B1602b23DAEC3cA60` | ||
|
||
### L2 | ||
|
||
- **TaikoL2:** `0x0000777700000000000000000000000000000001` | ||
- **TokenVault:** `0x0000777700000000000000000000000000000002` | ||
- **EtherVault:** `0x0000777700000000000000000000000000000003` | ||
- **Bridge:** `0x0000777700000000000000000000000000000004` | ||
|
||
## Cron job | ||
|
||
There will be a cron job service that proposes empty blocks periodically (every 2 minutes). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
sidebar_position: 8 | ||
--- | ||
|
||
# β Get help | ||
|
||
Here are two places for you to get help: | ||
|
||
- [Post your question on GitHub Discussions](https://github.com/orgs/taikoxyz/discussions/new?category=questions) | ||
- [Chat with us on Discord](https://discord.gg/taikoxyz) | ||
|
||
GitHub Discussions is preferred because your question might help others who are also running into the same issue. Conversely, you might find the answer to your problem here! |
8 changes: 8 additions & 0 deletions
8
packages/website/docs/alpha-1-testnet/request-eth-from-faucet.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# π§ Request ETH from faucet | ||
|
||
- Request ETH from Ethereum A1: https://l1faucet.a1.taiko.xyz/. | ||
- Request ETH from Taiko A1: https://l2faucet.a1.taiko.xyz/. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
sidebar_position: 5 | ||
--- | ||
|
||
# π Run a node | ||
|
||
This is arguably the most important part of the testnet! Taiko is fully decentralized and relies on the community to run nodes. | ||
|
||
Follow the guide at [simple-taiko-node/README.md](https://github.com/taikoxyz/simple-taiko-node/blob/main/README.md) to get started. | ||
|
||
:::note | ||
You will only be able to run a node regularly or as a proposer. In this testnet we are not running any provers. | ||
::: |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
sidebar_position: 0 | ||
--- | ||
|
||
# π Start here | ||
|
||
Welcome to Taiko's Alpha-1 testnet, **Snæfellsjâkull**. There are two networks involved in the testnet, which we'll define: | ||
|
||
- **Taiko A1** is the Alpha-1 testnet release of Taiko β a fully decentralized, Ethereum-equivalent ZK-Rollup. | ||
- **Ethereum A1** is Taiko's privately deployed Ethereum network, which serves as the L1 for Taiko's Alpha-1 testnet. | ||
|
||
## What can I do? | ||
|
||
In this testnet, you can: | ||
|
||
- π Bridge tokens between Ethereum A1 and Taiko A1. | ||
- π€ Send transactions (e.g., deploy contracts). | ||
- π Run a node β this makes _you_ a part of Taiko! | ||
- π Submit feedback and be forever loved. | ||
- π₯ Earn a POAP by using your wallet to complete any 2 of the 3 following actions by January 31st 23:59 UTC: | ||
- Use the bridge | ||
- Contract interaction (e.g., interact w/ dapp, deploy a contract) | ||
- Transfer between accounts | ||
|
||
## Create a feedback log | ||
|
||
Create a feedback log by clicking [here](https://github.com/orgs/taikoxyz/discussions/new?category=feedback&title=Testnet%20feedback%20form&body=%23+Friction+log%0D%0A-+TODO%0D%0A%0D%0A%23+Other+notes%0D%0A-+TODO%0D%0A), and use this to write down any [friction points, bugs, suggestions, etc.] while testing Taiko. | ||
|
||
Once you are finished testing the network, please submit the feedback log to help improve Taiko! | ||
|
||
## Navigating Snæfellsjâkull | ||
|
||
All of the relevant links can be found in this site's navigation. The relevant links are: | ||
|
||
| Link | Purpose | | ||
| ----------------------------------------------- | -------------------------------------------------- | | ||
| [Bridge](https://bridge.a1.taiko.xyz/) | Bridge ETH/tokens between Ethereum A1 and Taiko A1 | | ||
| [L1 faucet](https://l1faucet.a1.taiko.xyz/) | For receiving ETH on Ethereum A1 | | ||
| [L2 faucet](https://l2faucet.a1.taiko.xyz/) | For receiving ETH on Taiko A1 | | ||
| [L1 explorer](https://l1explorer.a1.taiko.xyz/) | Explore blocks on Ethereum A1 | | ||
| [L2 explorer](https://l2explorer.a1.taiko.xyz/) | Explore blocks on Taiko A1 | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
sidebar_position: 7 | ||
--- | ||
|
||
# π Submit feedback | ||
|
||
Submit your [feedback log](/docs/alpha-1-testnet/start-here#create-a-feedback-log) to [GitHub Discussions](https://github.com/orgs/taikoxyz/discussions). | ||
|
||
Thank you for participating in the SnΓ¦fellsjΓΆkull testnet! π |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# π Use the bridge | ||
|
||
The bridge contract can be found: | ||
|
||
- Deployed on L1: https://l1explorer.a1.taiko.xyz/address/0x3612E284D763f42f5E4CB72B1602b23DAEC3cA60 | ||
- Deployed on L2: https://l2explorer.a1.taiko.xyz/address/0x0000777700000000000000000000000000000002 | ||
|
||
## Test the bridge | ||
|
||
Use the [bridge](https://bridge.a1.taiko.xyz/) for the following actions: | ||
|
||
- Bridge ETH from Ethereum A1 to Taiko A1 | ||
|
||
## Bridge contract explained | ||
|
||
Read the bridge documentation on our GitHub: https://github.com/taikoxyz/taiko-mono/tree/main/packages/protocol/contracts/bridge. | ||
|
||
## Why is my L2 -> L1 transfer taking so long? | ||
|
||
The transfer from L2 to L1 can take a while because Taiko has a several hours delay in syncing block headers to allow uncle proof generation time, and we need the synced header to match so the Merkle proof of the message being sent on L2 is valid on L1. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 5 additions & 1 deletion
6
packages/website/talks/index.md β packages/website/docs/intro/talks.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,8 @@ | ||
# Talks | ||
--- | ||
sidebar_position: 3 | ||
--- | ||
|
||
# Presentations | ||
|
||
- `2022-11-01`: [Taiko ZK-EVM: Layer 2 Finality](https://hackmd.io/@taikolabs/HkN7GR64i) (Old Friends Reunion - ETH Lisbon) | ||
- `2022-10-10`: [Taiko ZK-EVM: Overview and Optimizations](https://hackmd.io/@taikolabs/S1haywHIj) (Rollup Day - Devcon) |
6 changes: 5 additions & 1 deletion
6
...ages/website/docs/reference/whitepaper.md β packages/website/docs/intro/whitepaper.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,7 @@ | ||
# Whitepaper | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# Read the whitepaper | ||
|
||
Read about the Taiko protocol in depth with the [whitepaper](https://taikoxyz.github.io/taiko-mono/taiko-whitepaper.pdf). |
File renamed without changes.
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion
2
...reference/smart-contracts/_category_.json β ...site/docs/smart-contracts/_category_.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Oops, something went wrong.