Miden faucet

Token faucet application for Miden testnet.

Documentation

For comprehensive guides, API reference, and examples, see the Miden Faucet Documentation.

Running the faucet

1. Install the faucet:

make install-faucet

2. Create faucet account. This will generate authentication keypair and generate and write public faucet account data with its keypair into the file specified in output-path:

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

Tip

This account will not be created on chain yet, creation on chain will happen on the first minting transaction.

3. Start the faucet server:

miden-faucet start \
  --endpoint http://localhost:8080 \
  --node-url https://rpc.testnet.miden.io:443 \
  --network testnet \
  --account <path to faucet.mac>

After a few seconds you may go to http://localhost:8080 and see the faucet UI.

Faucet security features:

The faucet implements several security measures to prevent abuse:

• Proof of Work requests:

  • Users must complete a computational challenge before their request is processed.
  • The challenge difficulty increases with the load. The load is measured by the amount of challenges that were submitted but still haven't expired.
  • Each challenge is signed with a secret only known by the server. It should NOT be shared.
  • Rate limiting: if an account submitted a challenge, it can't submit another one until the previous one is expired. The challenge lifetime duration is fixed and set when running the faucet.
  • API Keys: the faucet is initialized with a set of API Keys that can be distributed to developers. The difficulty of the challenges requested using the API Key will increase only with the load of that key, it won't be influenced by the overall load of the faucet.

• Requests batching:

  • Maximum batch size: 256 requests
  • Requests are processed in batches to optimize performance
  • Failed requests within a batch are handled individually

Contributing

Interested in contributing? Check CONTRIBUTING.md.

License

This project is MIT licensed.