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: Initialize the Faucet

First, we need to initialize the faucet with a new 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 SQLite store. 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 init \
  --token-symbol MIDEN \
  --decimals 6 \
  --max-supply 100000000000000000 \
  --node-url https://rpc.testnet.miden.io

Step 2: Start the Faucet

Next, start the faucet by specifying the addresses where the API and the frontend will be served, the address of the Miden node, and the network configuration. The API server will handle incoming token requests and manage the minting process.

miden-faucet start \
  --frontend-url http://localhost:8080 \
  --api-url http://localhost:8000 \
  --node-url https://rpc.testnet.miden.io \
  --network testnet

Step 3: 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 (if frontend is enabled)

Open http://localhost:8080 in your browser to access the web interface for generating token requests. Then:

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 REST API is running at http://localhost:8000 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 init \
  --token-symbol MIDEN \
  --decimals 6 \
  --max-supply 100000000000000000

miden-faucet start \
  --frontend-url http://localhost:8080 \
  --api-url http://localhost:8000

Development

Connect to the node deployed in Miden Devnet.

miden-faucet init \
  --token-symbol MIDEN \
  --decimals 6 \
  --max-supply 100000000000000000 \
  --network devnet

miden-faucet start \
  --frontend-url http://localhost:8080 \
  --api-url http://localhost:8000 \
  --network devnet

Testnet

Connect to the node deployed in Miden Testnet.

miden-faucet init \
  --token-symbol MIDEN \
  --decimals 6 \
  --max-supply 100000000000000000 \
  --network testnet

miden-faucet start \
  --frontend-url http://localhost:8080 \
  --api-url http://localhost:8000 \
  --explorer-url https://testnet.midenscan.com \
  --network testnet

Faucet API Only (No Frontend)

If you only need the API and don’t want to serve the web interface:

miden-faucet start \
  --api-url http://localhost:8000 \
  --network testnet