Skip to main content
Version: Canary 🚧

Faucet v0.11.2 release notes

  • Version: 0.11.2
  • Date: 2026-01-28
  • Environments: Preview, PreProd

High-level summary​

The Midnight Faucet is a token distribution service for the Midnight Network testnet environments. It enables developers and testers to request test tokens for their wallets, supporting both web-based and programmatic access.


Audience​

This release is relevant for:

  • Developers building and testing DApps on the Midnight Network
  • Testers who need test tokens for Preview or PreProd environments
  • Teams integrating Faucet functionality into their testing pipelines
  • Operators deploying Faucet infrastructure

New features​

Below are the new features introduced in this release:

Faucet server​

HTTP server that handles token distribution requests. Manages rate limiting, CAPTCHA verification, and asynchronous task processing for token transfers. Exposes REST API endpoints for token requests and status polling.

Faucet UI​

React-based web interface for requesting test tokens. Integrates Cloudflare Turnstile for CAPTCHA protection and provides real-time status updates for token requests.

Faucet client​

TypeScript client library for programmatic faucet access. Enables automated testing workflows and integration with CI/CD pipelines.

Example:

import { FaucetClient } from "@midnight-ntwrk/faucet-client";

const client = FaucetClient("http://localhost:5300/api");
const authToken = await client.login("<username>", "<password>");
const initialized = client.init(authToken);
const { transactionIdentifier } = initialized.requestTokens("<my wallet address>");

Rate limiting​

Daily request limits per wallet address to ensure fair distribution of test tokens. Automatically resets at the start of each day (UTC).


CAPTCHA protection​

Cloudflare Turnstile integration to prevent automated abuse of the faucet service.


Task queue​

Asynchronous task processing system for handling token distribution requests. Supports polling-based status updates and error recovery.


Metrics and monitoring​

Prometheus-compatible metrics endpoint for monitoring faucet health, request rates, and system performance.


New features requiring configuration updates​

Here are the new features requiring configuration updates:

Database connection​

The faucet requires PostgreSQL for persisting rate limits, task state, and request history.

Required updates:

  • Configure PostgreSQL connection string.
  • Run database migrations.

Node endpoint​

Required for submitting token transfer transactions to the network.

Required updates: Configure Midnight Node WebSocket endpoint.

Indexer endpoint​

Required for wallet synchronization and balance verification.

Required updates: Configure Midnight Indexer GraphQL endpoint.

CAPTCHA configuration​

CAPTCHA verification fails without valid Turnstile credentials.

Required updates:

  • Configure Cloudflare Turnstile site key (UI).
  • Configure Cloudflare Turnstile secret key (Server).

Deprecations​

No deprecations for this release.


Breaking changes​

No breaking changes for this release.


Known issues​

Issue: Rate limit may not immediately reset at midnight UTC.

Description: Due to caching, the rate limit reset may be delayed by a few minutes after midnight UTC.

Workaround: Wait a few minutes after midnight or restart the server to clear the cache.


Packages​

PackageVersionDescription
@midnight-ntwrk/faucet-server0.11.2HTTP server for token distribution with REST API, rate limiting, and async task processing.
@midnight-ntwrk/faucet-ui0.11.2React web interface for requesting test tokens with CAPTCHA protection.
@midnight-ntwrk/faucet0.11.2Core faucet library with wallet integration and token transfer logic.
@midnight-ntwrk/faucet-client0.11.2TypeScript client library for programmatic faucet access.
@midnight-ntwrk/faucet-auth0.11.2JWT-based authentication for faucet API access.
@midnight-ntwrk/faucet-internal-api0.11.2Shared API types and codecs for client-server communication.
@midnight-ntwrk/faucet-utils0.11.2Common utilities for functional programming patterns and testing.


Fixed defects​

  • Chore/fix health tests #407