-
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.
- Loading branch information
Showing
10 changed files
with
214 additions
and
0 deletions.
There are no files selected for viewing
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
26 changes: 26 additions & 0 deletions
26
packages/website/pages/docs/alpha-testnet-guide/_meta.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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
{ | ||
"get-started": { | ||
"title": "👋 Get started" | ||
}, | ||
"configure-wallet": { | ||
"title": "➕ Add networks to wallet" | ||
}, | ||
"request-from-faucet": { | ||
"title": "💧 Request from faucet" | ||
}, | ||
"use-the-bridge": { | ||
"title": "🌉 Use the bridge" | ||
}, | ||
"deploy-a-contract": { | ||
"title": "🚀 Deploy a contract" | ||
}, | ||
"run-a-node": { | ||
"title": "🌐 Run a node" | ||
}, | ||
"explore-the-network": { | ||
"title": "🔎 Explore the network" | ||
}, | ||
"get-help": { | ||
"title": "❓ Get help" | ||
} | ||
} |
21 changes: 21 additions & 0 deletions
21
packages/website/pages/docs/alpha-testnet-guide/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,21 @@ | ||
import AddEthereumChainButton from "../../../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` (for example, 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 | |
27 changes: 27 additions & 0 deletions
27
packages/website/pages/docs/alpha-testnet-guide/deploy-a-contract.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,27 @@ | ||
# 🚀 Deploy a contract | ||
|
||
These steps will show you how to deploy a smart contract to Taiko A1 using Foundry. You can find the latest Foundry docs at the Foundry Book: https://book.getfoundry.sh/getting-started/first-steps. This guide uses snippets / examples from there. | ||
|
||
## Prerequisites | ||
|
||
- Have the private key to an account that has some ETH on Taiko A1. This is to pay the small transaction fee for deploying the contract. You can check the following articles if you are unsure how to do this: | ||
- [With MetaMask](https://www.herongyang.com/Ethereum/Ethereum-Account-Public-Private-Key-Example.html) | ||
- [With OpenSSL](https://gist.github.com/miguelmota/3793b160992b4ea0b616497b8e5aee2f) | ||
- [With ethereumjs-wallet](https://piyopiyo.medium.com/how-to-generate-ethereum-private-key-and-address-in-local-offline-environment-90294308593c) | ||
|
||
## Steps | ||
|
||
1. [Install Foundry](https://book.getfoundry.sh/getting-started/installation) | ||
2. Create a project with Foundry, and `cd` into it: | ||
```sh | ||
forge init hello_foundry && cd hello_foundry | ||
``` | ||
3. Deploy the contract from your project, located at `src/Counter.sol`. Replace `<YOUR_PRIVATE_KEY>` with your private key, mentioned in the previous prerequisites section. | ||
```sh | ||
forge create --legacy --rpc-url https://l2rpc.a1.taiko.xyz --private-key <YOUR_PRIVATE_KEY> src/Counter.sol:Counter | ||
``` | ||
Note: Remove `<` and `>` from `<YOUR_PRIVATE_KEY>` | ||
|
||
We're using the `--legacy` flag because EIP-1559 is currently disabled on Taiko. We've 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/ |
40 changes: 40 additions & 0 deletions
40
packages/website/pages/docs/alpha-testnet-guide/explore-the-network.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,40 @@ | ||
# 🔍 Explore the network | ||
|
||
Taiko's Alpha-1 testnet consists of L1 / L2 nodes with all [Taiko protocol contracts](/docs/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,6 @@ | ||
# ❓ Get help | ||
|
||
Here are two places for you to get help: | ||
|
||
- [Chat on Discord](https://discord.gg/taikoxyz) | ||
- [Post your question on GitHub Discussions](https://github.com/orgs/taikoxyz/discussions/new?category=questions) |
26 changes: 26 additions & 0 deletions
26
packages/website/pages/docs/alpha-testnet-guide/get-started.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,26 @@ | ||
# 👋 Get started | ||
|
||
Welcome to Taiko's Alpha-1 testnet, **Snæfellsjökull**. There are two networks involved in the testnet: | ||
|
||
- **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. | ||
|
||
## Use the testnet | ||
|
||
In this testnet, you can: | ||
|
||
- 🌉 Bridge tokens between Ethereum A1 and Taiko A1. | ||
- 🤝 Send transactions (e.g., deploy a dapp, interact with a contract). | ||
- 🌐 Run a node—this makes **you** a part of Taiko! | ||
|
||
## Navigate Snæfellsjökull | ||
|
||
All 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 | |
12 changes: 12 additions & 0 deletions
12
packages/website/pages/docs/alpha-testnet-guide/request-from-faucet.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,12 @@ | ||
# 💧 Request from faucet | ||
|
||
**ETH** | ||
|
||
- Ethereum A1: https://l1faucet.a1.taiko.xyz/ | ||
- Taiko A1: https://l2faucet.a1.taiko.xyz/ | ||
|
||
**HORSE** | ||
|
||
1. Visit the [bridge](https://bridge.a1.taiko.xyz/) | ||
2. Select the network as Taiko A1 and the token dropdown as HORSE | ||
3. Click the faucet button that appears |
26 changes: 26 additions & 0 deletions
26
packages/website/pages/docs/alpha-testnet-guide/run-a-node.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,26 @@ | ||
# 🌐 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're not running any provers. | ||
## System requirements | ||
|
||
Because we're a fork of Geth, you can consult the [Geth minimum requirements](https://github.com/ethereum/go-ethereum#hardware-requirements), which are outlined below. | ||
|
||
### Minimum: | ||
|
||
- CPU with 2+ cores | ||
- 4GB RAM | ||
- 1TB free storage space to sync the Mainnet | ||
- (**only ~50GB for the Taiko A1 testnet**) | ||
- 8 MBit/sec download Internet service | ||
|
||
### Recommended: | ||
|
||
- Fast CPU with 4+ cores | ||
- 16GB+ RAM | ||
- High-performance SSD with at least 1TB of free space | ||
- 25+ MBit/sec download Internet service |
26 changes: 26 additions & 0 deletions
26
packages/website/pages/docs/alpha-testnet-guide/use-the-bridge.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,26 @@ | ||
# 🌉 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 between Ethereum A1 and Taiko A1 | ||
- Bridge HORSE between Ethereum A1 and Taiko A1 | ||
|
||
## 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. | ||
|
||
## Where are the HORSE contracts? | ||
|
||
L1: https://l1explorer.a1.taiko.xyz/address/0x3E3a3416DbCc5cb4448B6b171fF15f9Da35Ab72d | ||
L2: https://l2explorer.a1.taiko.xyz/address/0xb8ea36284d1fa062cc0c969e28a49f3531cfb1bf | ||
|
||
## Bridge contract explained | ||
|
||
Read the bridge documentation on GitHub: https://github.com/taikoxyz/taiko-mono/tree/main/packages/protocol/contracts/bridge. |