sui-client-faucet
Get test SUI tokens from faucet
TLDR
Get a SUI coin from the faucet associated with the active network
Get a SUI coin for the address (accepts also an alias)
Get a SUI coin from custom faucet
SYNOPSIS
sui client faucet
DESCRIPTION
The `sui-client-faucet` command interacts with a local or remote Sui faucet to obtain SUI tokens for testing and development purposes. This command is crucial for developers building on the Sui blockchain, as it provides a convenient way to fund their accounts with test SUI without needing to purchase real tokens. The faucet, in essence, is a service that dispenses small amounts of SUI to users upon request. This command simplifies the process of making that request. The faucet is typically configured to only work in a development or test environment to prevent abuse and ensure fair distribution of tokens. The command can optionally accept a recipient address and gas object ID, but typically uses the address from the active SUI keystore to ensure requested SUI is allocated to the right account.
CAVEATS
- The faucet usually only works in devnet or local testnet environments.
- There are rate limits on how often you can request tokens.
USAGE EXAMPLES
To simply request SUI tokens for the default active address in your Sui keystore, run:sui client faucet
.
The tokens will be sent to that address, allowing you to begin interacting with the Sui network.
TROUBLESHOOTING
If you receive an error message, ensure that the faucet service is running and accessible. Also, check if you have exceeded the request limit. If you are using a local testnet, make sure the Sui network is properly configured and running correctly.
HISTORY
The `sui-client-faucet` command was introduced alongside the Sui blockchain to provide developers with a convenient way to acquire test tokens. It's been instrumental in fostering a vibrant development ecosystem by removing the initial barrier of acquiring SUI for testing and experimentation. As Sui has evolved, so too has the `sui-client-faucet` command, with improvements in its reliability and user experience.
SEE ALSO
sui(1), sui-client(1)