Skip to content
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

feat(faucet-docs): added faucet docs #533

Merged
merged 8 commits into from
Oct 25, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/mlc_config.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,5 @@
"timeout": "10s",
"retryOn429": true,
"retryCount": 5,
"aliveStatusCodes": [200, 206, 406]
"aliveStatusCodes": [200, 206, 406, 400]
}
24 changes: 24 additions & 0 deletions docs/platform/faucet.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: Stacks Testnet Faucet
---

# Stacks Testnet Faucet

Check warning on line 5 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L5

[Google.Headings] 'Stacks Testnet Faucet' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Stacks Testnet Faucet' should use sentence-style capitalization.", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 5, "column": 3}}}, "severity": "WARNING"}

The Stacks Testnet Faucet is a dedicated utility for developers building on the Stacks blockchain. To aid you in deploying and running smart contracts on the Stacks testnet, we've provided this faucet that offers easy access to testnet STX tokens.

Check warning on line 7 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L7

[Google.We] Try to avoid using first-person plural like 'we'.
Raw output
{"message": "[Google.We] Try to avoid using first-person plural like 'we'.", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 7, "column": 175}}}, "severity": "WARNING"}

![Create Chainhook Window](./images/faucet.jpeg)

Check warning on line 9 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L9

[Hiro.Spellcheck] Verify the spelling of 'Chainhook'
Raw output
{"message": "[Hiro.Spellcheck] Verify the spelling of 'Chainhook'", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 9, "column": 10}}}, "severity": "WARNING"}

## Why Use the Stacks Testnet Faucet?

Check warning on line 11 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L11

[Google.Headings] 'Why Use the Stacks Testnet Faucet?' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'Why Use the Stacks Testnet Faucet?' should use sentence-style capitalization.", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 11, "column": 4}}}, "severity": "WARNING"}

Building and testing on a blockchain requires a certain amount of native tokens to facilitate various operations, from contract deployments to transaction executions. However, sourcing these tokens can often be a cumbersome process. The Stacks Testnet Faucet simplifies this by offering a hassle-free way to acquire STX tokens for testing purposes.

## How to Request Testnet STX

Check warning on line 15 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L15

[Google.Headings] 'How to Request Testnet STX' should use sentence-style capitalization.
Raw output
{"message": "[Google.Headings] 'How to Request Testnet STX' should use sentence-style capitalization.", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 15, "column": 4}}}, "severity": "WARNING"}

1. **Visit the Faucet Page**: Navigate to [platform.hiro.so/faucet](https://platform.hiro.so/faucet).
2. **Login into Your Wallet**: Log into the platform with the wallet that has the test account that you want funded. Click _Connect Wallet_ to login.
3. **Request Tokens**: You'll find a straightforward interface with a button to request tokens. Simply click on the button _Request STX_.

Check warning on line 19 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L19

[Google.WordList] Use 'click' or 'click in' instead of 'click on'.
Raw output
{"message": "[Google.WordList] Use 'click' or 'click in' instead of 'click on'.", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 19, "column": 104}}}, "severity": "WARNING"}
4. **Receive 500 STX Tokens**: By clicking the button, you'll receive 500 STX tokens to your testnet account.

### Note:

- **Daily Limit**: To ensure fair distribution and availability for all developers, there's a limit of one request per day. Plan your testing accordingly!

Check warning on line 24 in docs/platform/faucet.md

View workflow job for this annotation

GitHub Actions / vale

[vale] docs/platform/faucet.md#L24

[Google.Exclamation] Don't use exclamation points in text.
Raw output
{"message": "[Google.Exclamation] Don't use exclamation points in text.", "location": {"path": "docs/platform/faucet.md", "range": {"start": {"line": 24, "column": 153}}}, "severity": "WARNING"}
Binary file added docs/platform/images/faucet.jpeg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -345,6 +345,7 @@ module.exports = {
'platform/deployment-plans',
'platform/deploy-project',
'platform/archive-project',
'platform/faucet',
'platform/faq',
],
},
Expand Down
Loading