fix(cli): correct help text for faucet command #1830
+7
−7
Conversation
This file contains hidden or 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
The faucet command was incorrectly showing encrypt_keychain documentation. Updated to properly describe requesting testnet STX tokens. Closes stx-labs#1817
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The faucet command was incorrectly showing encrypt_keychain documentation. Updated to properly describe requesting testnet STX tokens. Closes #1817
@janniks @zone117x
Description
The
stacks faucetcommand help text was copy-pasted fromencrypt_keychainand showed incorrect documentation about encrypting backup phrases instead of describing the faucet functionality.Fixed by updating the help text to correctly describe requesting free testnet STX tokens.
Breaking change?
None
Example
Before (incorrect):
$ stx help faucet
Command: faucet
Encrypt a 12-word backup phrase, which can be decrypted later with the
decrypt_backup_phrasecommand...After (correct):
$ stx help faucet
Command: faucet
Request free Stacks tokens (STX) from the testnet faucet for the specified address.
This command only works on testnet and is useful for testing and development purposes.
Checklist