From 6a1dbb9fd91dc0d82af4db4b952ef73cfa16cfdb Mon Sep 17 00:00:00 2001 From: d1onys1us <13951458+d1onys1us@users.noreply.github.com> Date: Mon, 17 Apr 2023 12:55:34 +0900 Subject: [PATCH] Revert "docs(website): add alerts for hackathon network config (#13601)" This reverts commit 7e2de09770f933bda7e9d2cd22501337dc24535d. --- .../pages/docs/guides/build-a-dapp.mdx | 7 ---- .../docs/guides/configure-your-wallet.mdx | 7 +--- .../pages/docs/guides/deploy-a-contract.mdx | 34 ++++++++----------- .../pages/docs/guides/enable-a-prover.mdx | 10 +++--- .../pages/docs/guides/receive-tokens.mdx | 8 +---- .../website/pages/docs/guides/run-a-node.mdx | 5 --- .../website/pages/docs/guides/swap-tokens.mdx | 8 +---- .../pages/docs/guides/use-the-bridge.mdx | 11 ++---- packages/website/theme.config.tsx | 4 +-- 9 files changed, 25 insertions(+), 69 deletions(-) diff --git a/packages/website/pages/docs/guides/build-a-dapp.mdx b/packages/website/pages/docs/guides/build-a-dapp.mdx index 745dca96d4b..e90b072ecc9 100644 --- a/packages/website/pages/docs/guides/build-a-dapp.mdx +++ b/packages/website/pages/docs/guides/build-a-dapp.mdx @@ -1,10 +1,3 @@ -import { Callout } from "nextra-theme-docs"; - - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - - This guide will help you build a dapp on Taiko (Askja testnet)! The starter dapp highlights an important feature of Taiko: sending secure cross-chain messages between Taiko and Ethereum. Read more about cross-chain messaging [here](/docs/concepts/bridging/cross-chain-messaging). ## Prerequisites diff --git a/packages/website/pages/docs/guides/configure-your-wallet.mdx b/packages/website/pages/docs/guides/configure-your-wallet.mdx index 864216ce11c..27bd307f6c9 100644 --- a/packages/website/pages/docs/guides/configure-your-wallet.mdx +++ b/packages/website/pages/docs/guides/configure-your-wallet.mdx @@ -1,10 +1,5 @@ import AddEthereumChainButton from "../../../components/AddEthereumChainButton"; -import { Steps, Callout } from "nextra-theme-docs"; - - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - +import { Steps } from "nextra-theme-docs"; This guide help you connect your wallet to Taiko (Askja testnet). There are two networks to configure your wallet with: **Ethereum (Sepolia testnet)** and **Taiko (Askja testnet)**. diff --git a/packages/website/pages/docs/guides/deploy-a-contract.mdx b/packages/website/pages/docs/guides/deploy-a-contract.mdx index 46fb0a9fa80..f4d92643f0d 100644 --- a/packages/website/pages/docs/guides/deploy-a-contract.mdx +++ b/packages/website/pages/docs/guides/deploy-a-contract.mdx @@ -1,13 +1,7 @@ import { Callout, Steps } from "nextra-theme-docs"; - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - - - Make sure you are using a test / throwaway wallet, to be safe. Don't ever - reveal the private key of your main wallet! + Make sure you are using a test / throwaway wallet, to be safe. Don't ever reveal the private key of your main wallet! This guide will help you deploy a smart contract to Taiko (Askja testnet) using Foundry. @@ -16,12 +10,12 @@ This guide will help you deploy a smart contract to Taiko (Askja testnet) using - [Foundry](https://book.getfoundry.sh/getting-started/installation) is installed. - You have the private key handy to an account that has testnet ETH on Taiko (to pay the transaction fee for deploying the contract). - - [Retrieve private key with MetaMask](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key#:~:text=On%20the%20account%20page%2C%20click,click%20%E2%80%9CConfirm%E2%80%9D%20to%20proceed.). - - [Generate wallet keys with OpenSSL](https://gist.github.com/miguelmota/3793b160992b4ea0b616497b8e5aee2f). - - [Generate wallet keys with ethereumjs-wallet](https://piyopiyo.medium.com/how-to-generate-ethereum-private-key-and-address-in-local-offline-environment-90294308593c). + - [Retrieve private key with MetaMask](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key#:~:text=On%20the%20account%20page%2C%20click,click%20%E2%80%9CConfirm%E2%80%9D%20to%20proceed.). + - [Generate wallet keys with OpenSSL](https://gist.github.com/miguelmota/3793b160992b4ea0b616497b8e5aee2f). + - [Generate wallet keys with ethereumjs-wallet](https://piyopiyo.medium.com/how-to-generate-ethereum-private-key-and-address-in-local-offline-environment-90294308593c). - Have some testnet ETH on Taiko: - - First, [request Sepolia ETH](/docs/guides/receive-tokens) from the faucet. - - Then, [use the bridge](/docs/guides/use-the-bridge) to send the testnet ETH to Taiko. + - First, [request Sepolia ETH](/docs/guides/receive-tokens) from the faucet. + - Then, [use the bridge](/docs/guides/use-the-bridge) to send the testnet ETH to Taiko. ## Steps @@ -31,13 +25,13 @@ This guide will help you deploy a smart contract to Taiko (Askja testnet) using forge init hello_foundry && cd hello_foundry ``` -### Deploy the contract -Deploy the contract located at `src/Counter.sol`. Replace `YOUR_PRIVATE_KEY` below with your private key which has some testnet ETH on Taiko. -> Note: The `--legacy` flag is needed because EIP-1559 is currently disabled on Taiko—it will be re-enabled in the future. -```sh -forge create --legacy --rpc-url https://rpc.a2.taiko.xyz --private-key YOUR_PRIVATE_KEY src/Counter.sol:Counter -``` + ### Deploy the contract + Deploy the contract located at `src/Counter.sol`. Replace `YOUR_PRIVATE_KEY` below with your private key which has some testnet ETH on Taiko. + > Note: The `--legacy` flag is needed because EIP-1559 is currently disabled on Taiko—it will be re-enabled in the future. + ```sh + forge create --legacy --rpc-url https://rpc.a2.taiko.xyz --private-key YOUR_PRIVATE_KEY src/Counter.sol:Counter + ``` -### View your contract -Paste the address from the output into the [Taiko block explorer](https://explorer.a2.taiko.xyz) and verify that the contract was deployed. + ### View your contract + Paste the address from the output into the [Taiko block explorer](https://explorer.a2.taiko.xyz) and verify that the contract was deployed. diff --git a/packages/website/pages/docs/guides/enable-a-prover.mdx b/packages/website/pages/docs/guides/enable-a-prover.mdx index 781640509ac..efb111f1ba1 100644 --- a/packages/website/pages/docs/guides/enable-a-prover.mdx +++ b/packages/website/pages/docs/guides/enable-a-prover.mdx @@ -1,19 +1,17 @@ import { Callout, Steps } from "nextra-theme-docs"; - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - Only the first prover can get the reward, and others will be rejected by the protocol smart contract. This means the fastest prover will be able to prove the block and earn the reward, **if you have just the minimum hardware outlined in the prerequisited below, running a single prover, it's unlikely you will be able to prove any blocks (because you will be competing against other high-performance provers)**. Meaning, if you do not have a powerful prover, the primary purpose of running a prover is to help test out and provide community feedback on running the node software. Keep in mind this will have a cost in electricity on your computer, and if you are not proving blocks, it's unlikely you will receive a reward to offset that electricity cost. + ## Prerequisites - Must have some ETH on Sepolia (see [receive tokens](/docs/guides/receive-tokens)). - Should have at least 8/16 core CPU and 32GB of RAM. (**note: see warning above**) + ## Steps @@ -24,8 +22,8 @@ Set the following environment variables to enable your node as a prover: ### Verify prover logs Verify you have some prover logs: -- `💰 Your block proof was accepted` means you are the first prover and receive the reward. -- `✅ Valid block proven` just means a proposed block was successfully proved on TaikoL1 (by anyone). + - `💰 Your block proof was accepted` means you are the first prover and receive the reward. + - `✅ Valid block proven` just means a proposed block was successfully proved on TaikoL1 (by anyone). ## Troubleshooting diff --git a/packages/website/pages/docs/guides/receive-tokens.mdx b/packages/website/pages/docs/guides/receive-tokens.mdx index 6b5f0a29475..9a95447345d 100644 --- a/packages/website/pages/docs/guides/receive-tokens.mdx +++ b/packages/website/pages/docs/guides/receive-tokens.mdx @@ -1,13 +1,7 @@ import { Callout, Steps } from "nextra-theme-docs"; - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - - - The HORSE token and BLL token are both dummy test tokens that are used for - testing the bridge and swap. +The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap. This guide will help you receive testnet tokens from the faucet(s). diff --git a/packages/website/pages/docs/guides/run-a-node.mdx b/packages/website/pages/docs/guides/run-a-node.mdx index 2c97ddfba62..739868283bd 100644 --- a/packages/website/pages/docs/guides/run-a-node.mdx +++ b/packages/website/pages/docs/guides/run-a-node.mdx @@ -1,10 +1,5 @@ import { Callout, Steps, Tab, Tabs } from "nextra-theme-docs"; - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - - This guide will walk you through the process of operating a Taiko node via [simple-taiko-node](https://github.com/taikoxyz/simple-taiko-node). You will be able to: - Run a Taiko node easily from the command line on Windows, Mac, and Linux. diff --git a/packages/website/pages/docs/guides/swap-tokens.mdx b/packages/website/pages/docs/guides/swap-tokens.mdx index cc1123c3a78..4cbee55befb 100644 --- a/packages/website/pages/docs/guides/swap-tokens.mdx +++ b/packages/website/pages/docs/guides/swap-tokens.mdx @@ -1,13 +1,7 @@ import { Callout, Steps } from "nextra-theme-docs"; - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - - - The HORSE token and BLL token are both dummy test tokens that are used for - testing the bridge and swap. +The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap. This guide will help you interact with Swap, which is a fork of Uniswap v2 which Taiko has deployed only for testing purposes. diff --git a/packages/website/pages/docs/guides/use-the-bridge.mdx b/packages/website/pages/docs/guides/use-the-bridge.mdx index 4f6050308af..b1e30a0987f 100644 --- a/packages/website/pages/docs/guides/use-the-bridge.mdx +++ b/packages/website/pages/docs/guides/use-the-bridge.mdx @@ -1,17 +1,10 @@ import { Callout, Steps } from "nextra-theme-docs"; - - Please use the [ETHTokyo network - config](/docs/reference/ethglobal-tokyo-reference.mdx) for the hackathon! - - - The BLL token should succeed when **minting** from the faucet, and when - **sending the bridge message** to Sepolia or Taiko. However, it will fail - about 50% of the time when **claiming** on Sepolia—this is intentionally done - so we can test the error handling. + The BLL token should succeed when **minting** from the faucet, and when **sending the bridge message** to Sepolia or Taiko. However, it will fail about 50% of the time when **claiming** on Sepolia—this is intentionally done so we can test the error handling. + This guide will help you use the bridge to send tokens between Sepolia and Taiko (Askja testnet). You can read more about how bridging works [here](/docs/concepts/bridging/cross-chain-messaging). > The HORSE token and BLL token are both dummy test tokens that are used for testing the bridge and swap. diff --git a/packages/website/theme.config.tsx b/packages/website/theme.config.tsx index 176c541317d..f229eb1ff9a 100644 --- a/packages/website/theme.config.tsx +++ b/packages/website/theme.config.tsx @@ -8,10 +8,10 @@ export default { key: "banner", text: ( - 📌 Please use the ETHTokyo network config for the hackathon → + 🌋 Askja testnet is here! Learn more → ), },