-
Notifications
You must be signed in to change notification settings - Fork 60
feat: update faucet docs #130
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
feat: update faucet docs #130
Conversation
📝 WalkthroughWalkthroughThe pull request simplifies the faucet setup documentation by replacing an extensive multi-section guide with a streamlined Morph Faucet usage flow. The change removes detailed instructions for third-party faucets, wallet addresses, and bridging procedures while retaining essential claiming steps. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 2
🤖 Fix all issues with AI agents
In `@docs/quick-start/3-faucet.md`:
- Line 16: Update the vague instruction "Click to claim testnet tokens" to
specify the exact UI element or button label users should interact with (for
example, replace that sentence with "Click the 'Claim' button" or "Click the
'Claim Testnet Tokens' button" depending on the actual label), so readers know
precisely which control to click; locate the text "Click to claim testnet
tokens" in the 3-faucet.md content and replace it with the clearer button-label
instruction.
- Around line 8-18: Update the "## Morph Faucet" section to include operational
details: state the typical token amount dispensed per claim (e.g., "X test
tokens per claim"), the rate limit (e.g., "one claim per 24 hours" or the actual
limit enforced), and a short troubleshooting subsection with steps such as
verifying the correct wallet address, checking network explorers for pending
transactions, waiting a few minutes, and contacting support/raising an issue if
tokens don't arrive. Reference the "Morph Faucet" header and add a brief
"Troubleshooting" bullet list so users can immediately see token amount, rate
limits, and next steps if a claim fails.
| ## Morph Faucet | ||
|
|
||
| You can claim testnet tokens through the [Morph Faucet](https://morph-rails-hoodi.morph.network/faucet). | ||
|
|
||
| ### How to Use | ||
|
|
||
| 1. Visit the [Morph Faucet](https://morph-rails-hoodi.morph.network/faucet). | ||
| 2. Enter your wallet address (not your private key). | ||
| 3. Click to claim testnet tokens. | ||
|
|
||
| ## Our Faucet is Live | ||
|
|
||
|
|
||
| Users can claim Morph ETH & USDT to fund their initial activities. | ||
|
|
||
|
|
||
| ### 3rd Party Ethereum Hoodi ETH Faucet | ||
|
|
||
| To use Morph's public testnet, obtain testnet ETH on Hoodi, then bridge it to the Morph testnet. | ||
|
|
||
| Here are a few Hoodi faucet apps: | ||
|
|
||
| https://stakely.io/faucet/ethereum-hoodi-testnet-eth | ||
|
|
||
| https://faucet.quicknode.com/ethereum/hoodi | ||
|
|
||
| https://hoodi-faucet.pk910.de/ | ||
|
|
||
| https://cloud.google.com/application/web3/faucet/ethereum (needs a Google account) | ||
|
|
||
| Once you receive ETH on Hoodi, it should appear in your wallet on the Hoodi Network. | ||
|
|
||
| It may take a few seconds for the funds to show. You can check the status by searching your address on the [Hoodi Block Explorer](https://hoodi.etherscan.io). | ||
|
|
||
|
|
||
| ### Discord Morph Hoodi Faucet | ||
|
|
||
| ### Morph Hoodi ETH | ||
|
|
||
| You can obtain the Morph Hoodi ETH in our discord too for development purposes. | ||
|
|
||
| Using the */morph_eth* command followed by your wallet address to receive 0.01 Morph Hoodi ETH. | ||
|
|
||
| If successful, you will see a confirmation message. | ||
|
|
||
| ### ERC20 USDT | ||
|
|
||
| :::tip | ||
|
|
||
| Currently, each Discord user can only request tokens once every 24 hours. | ||
|
|
||
| ::: | ||
|
|
||
| You can obtain Morph’s version of USDT on Hoodi through our Discord faucet. Here’s how: | ||
|
|
||
|
|
||
| 1. Join our Discord server using this [link](https://discord.gg/invite/MorphNetwork). | ||
|
|
||
| 2. Navigate to the *#| discord-faucet* channel. | ||
|
|
||
| 3. Type */faucet* followed by your Hoodi address. | ||
|
|
||
| 4. Wait for a few seconds. | ||
|
|
||
| 5. If the request is successful, you will see a confirmation message in the channel. | ||
|
|
||
| 6. Add the Morph Hoodi USDT information to your wallet. | ||
|
|
||
| ~~~ | ||
|
|
||
| Ethereum Hoodi USDT address: "0x625849788c16315680f34ee72a5e9961cd15d581" | ||
|
|
||
| Morph Hoodi USDT address: "0xF48EFcDb83c8478528bDDe96f1B8c736BBF5BC87" | ||
|
|
||
| ~~~ | ||
|
|
||
| 7. Check your wallet for the USDT balance, then start bridging. | ||
|
|
||
|  | ||
|
|
||
|
|
||
|
|
||
|
|
||
| The tokens will be sent to your wallet shortly. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Search for network setup, wallet configuration, and faucet-related documentation
echo "=== Searching for network configuration docs ==="
fd -e md -e mdx . docs/ | xargs rg -l "Morph.*Holesky|network.*add|add.*network|wallet.*setup|RPC.*endpoint" 2>/dev/null | head -20
echo ""
echo "=== Searching for faucet or testnet token references ==="
fd -e md -e mdx . docs/ | xargs rg -l "faucet|testnet.*token|claim.*token" 2>/dev/null | head -20
echo ""
echo "=== Listing quick-start directory structure ==="
fd -e md -e mdx . docs/quick-start/ 2>/dev/null | sort
echo ""
echo "=== Checking for troubleshooting or FAQ docs ==="
fd -e md -e mdx . docs/ | xargs rg -l "troubleshoot|FAQ|error|fail" 2>/dev/null | grep -i -E "(trouble|faq|error|help)" | head -10Repository: morph-l2/morph-doc
Length of output: 1653
🏁 Script executed:
#!/bin/bash
# Check wallet-setup doc for Morph Holesky network configuration
echo "=== Content of wallet-setup.md (lines 1-60) ==="
head -60 docs/quick-start/2-wallet-setup.md
echo ""
echo "=== Checking for 'Morph Holesky' or 'network' in wallet-setup ==="
rg "Morph.*Holesky|add.*network|network.*config" docs/quick-start/2-wallet-setup.md -A 3 -B 1
echo ""
echo "=== Checking FAQ for faucet-related content ==="
rg "faucet|claim.*token|testnet.*token" docs/about-morph/7-faqs.md -A 3 -B 1
echo ""
echo "=== Checking if there's rate limiting or token amount info elsewhere ==="
rg "rate.*limit|token.*limit|amount.*claim|daily.*claim" docs/ -l 2>/dev/null | head -5Repository: morph-l2/morph-doc
Length of output: 4083
Simplification is appropriate given the sequential documentation flow, but add operational details.
The wallet setup prerequisites are already covered in the preceding document (2-wallet-setup.md), which users complete before reaching the faucet step. However, consider adding practical information that users may encounter:
- Token amount: How many testnet tokens are dispensed per claim?
- Rate limits: How often can users claim (e.g., once per 24 hours)?
- Troubleshooting: What should users do if the claim fails or tokens don't arrive?
These details would make the documentation more self-sufficient without requiring users to discover this information through trial and error.
🤖 Prompt for AI Agents
In `@docs/quick-start/3-faucet.md` around lines 8 - 18, Update the "## Morph
Faucet" section to include operational details: state the typical token amount
dispensed per claim (e.g., "X test tokens per claim"), the rate limit (e.g.,
"one claim per 24 hours" or the actual limit enforced), and a short
troubleshooting subsection with steps such as verifying the correct wallet
address, checking network explorers for pending transactions, waiting a few
minutes, and contacting support/raising an issue if tokens don't arrive.
Reference the "Morph Faucet" header and add a brief "Troubleshooting" bullet
list so users can immediately see token amount, rate limits, and next steps if a
claim fails.
|
|
||
| 1. Visit the [Morph Faucet](https://morph-rails-hoodi.morph.network/faucet). | ||
| 2. Enter your wallet address (not your private key). | ||
| 3. Click to claim testnet tokens. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make the claim instruction more specific.
The instruction "Click to claim testnet tokens" is vague. Users would benefit from knowing the exact button label or element to interact with (e.g., "Click the 'Claim' button").
📝 Suggested improvement
-3. Click to claim testnet tokens.
+3. Click the "Claim" button to receive testnet tokens.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| 3. Click to claim testnet tokens. | |
| 3. Click the "Claim" button to receive testnet tokens. |
🤖 Prompt for AI Agents
In `@docs/quick-start/3-faucet.md` at line 16, Update the vague instruction "Click
to claim testnet tokens" to specify the exact UI element or button label users
should interact with (for example, replace that sentence with "Click the 'Claim'
button" or "Click the 'Claim Testnet Tokens' button" depending on the actual
label), so readers know precisely which control to click; locate the text "Click
to claim testnet tokens" in the 3-faucet.md content and replace it with the
clearer button-label instruction.
Summary by CodeRabbit
Release Notes