Quick Start

Get the Miden Faucet running in minutes.

Prerequisites

• Miden Faucet installed (see Installation)
• Access to a Miden node (testnet, devnet, or local)

Step 1: Create a Faucet Account

First, we need to create a faucet account that will hold the tokens to be distributed. This command generates a new account with the specified token configuration and saves the account data to a local file (faucet.mac). The account is not yet deployed to the network - that will happen when the faucet is running and the first transaction is sent to the node.

miden-faucet create-faucet-account \
  --output-path ./faucet.mac \
  --token-symbol MIDEN \
  --decimals 6 \
  --max-supply 100000000000000000

Step 2: Start the Faucet Server

Next, start the faucet server by specifying the endpoint it should listen on, the Miden node it will connect to, and the account file to use for distributing tokens. The server will handle incoming token requests and manage the minting process.

miden-faucet start \
  --endpoint http://localhost:8080 \
  --node-url https://rpc.testnet.miden.io \
  --account ./faucet.mac

Step 3: Access the Web Interface

The faucet provides a web interface for easy token requests. Open http://localhost:8080 in your browser to access it.

Step 4: Request Test Tokens

Once the faucet is running, you can request test tokens through either the web interface or the REST API.

Via Web Interface

1. Enter your Miden account ID or account bech32 address.
2. Select token amount
3. Choose note type (private or public)
4. Submit request

Via API

You can also programmatically interact with the REST API to mint tokens. Check out the complete working examples below. Make sure the faucet is running at http://localhost:8080 before using them.

• Rust
• TypeScript

Common Configurations

Localhost

If you have a Miden Node running locally, you can run the faucet against that node.

miden-faucet start \
  --endpoint http://localhost:8080 \
  --node-url http://localhost:57291 \
  --account ./faucet.mac \
  --network localhost

Development

Connect to the node deployed in Miden Devnet.

miden-faucet start \
  --endpoint http://localhost:8080 \
  --node-url https://rpc.devnet.miden.io \
  --account ./faucet.mac \
  --network devnet

Testnet

Connect to the node deployed in Miden Testnet.

miden-faucet start \
  --endpoint http://localhost:8080 \
  --node-url https://rpc.testnet.miden.io \
  --account ./faucet.mac \
  --explorer-url https://testnet.midenscan.com \
  --network testnet