chore: merge main into next #212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

igamigo merged 25 commits into next from kbg/merge-main-to-next

Jan 23, 2026

CHANGELOG.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -9,6 +9,7 @@ @@
     - Updated faucet optional deployment to use an empty transaction (#[182](https://github.com/0xMiden/miden-faucet/pull/182)).
     - Added a feature `tokio` for the `miden-pow-rate-limiter` crate ([#188](https://github.com/0xMiden/miden-faucet/pull/188).)
     - Added integration to import mint private notes directly to the wallet ([#189](https://github.com/0xMiden/miden-faucet/pull/189)).
+    - Added a new `miden-faucet-client` binary with the `mint` command ([#196](https://github.com/0xMiden/miden-faucet/pull/196)).
     ## 0.12.4 (2025-12-04)
@@ Expand Down Expand Up / @@ -87,7 +88,7 @@ @@
     - Redesigned the home frontend ([#20](https://github.com/0xMiden/miden-faucet/pull/20)).
     - Redesigned the tokens request flows ([#25](https://github.com/0xMiden/miden-faucet/pull/25)).
     - Added faucet supply amounts to the metadata ([#30](https://github.com/0xMiden/miden-faucet/pull/30)).
-    - Added supply exceeded check ([#31](https://github.com/0xMiden/miden-faucet/pull/31)).
+    - Added supply exceeded check ([#31](https://github.com/0xMiden/miden-faucet/pull/31)).
     - Use HTTP 429 status code for rate limited error ([#51](https://github.com/0xMiden/miden-faucet/pull/51)).
     - Replace amount options validation for maximum claimable amount ([#52](https://github.com/0xMiden/miden-faucet/pull/52)).
     - Added `mdbook` documentation ([#61](https://github.com/0xMiden/miden-faucet/pull/61)).
@@ Expand Down @@

Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Cargo.toml

-Original file line number
+Diff line change
@@ -1,5 +1,5 @@
     [workspace]
-    members = ["bin/faucet", "crates/faucet"]
+    members = ["bin/faucet", "bin/faucet-client", "crates/faucet"]
     resolver = "2"
@@ Expand Down @@

Makefile

-Original file line number
+Diff line change
@@ Expand Up @@
     .PHONY: install-faucet
     install-faucet: ## Installs faucet
     	${BUILD_PROTO} cargo install --path bin/faucet --locked
+    	${BUILD_PROTO} cargo install --path bin/faucet-client --locked
     .PHONY: check-tools
     check-tools: ## Checks if development tools are installed
@@ Expand Down @@

README.md

-Original file line number
+Diff line change
@@ Expand Up @@
     ## Running the faucet
-. Install the faucet:
+    The faucet comes with two CLI tools:
+    - **miden-faucet**: Runs the faucet, used for initializing and starting the faucet.
+    - **miden-faucet-client**: Used for interacting with a live faucet, i.e. for requesting tokens from a running faucet.
+. Install both faucet binaries:
     ```bash
     make install-faucet
     ```
-. Initialize the faucet. This will generate a new account with the specified token configuration and save the account data to a local SQLite store:
+. Initialize the faucet server. This will generate a new account with the specified token configuration and save the account data to a local SQLite store:
     ```bash
     miden-faucet init \
@@ Expand All / @@ -32,6 +36,13 @@ miden-faucet start \ @@
       --network testnet
     ```
+    ## Requesting tokens from a live faucet
+    You can use the `miden-faucet-client` binary to request tokens from any running faucet instance, whether it's your local faucet or the remote testnet faucet:
+    ```bash
+    miden-faucet-client mint --url <FAUCET_API_URL> --target-account <ACCOUNT_ID> --amount <BASE_UNITS>
+    ```
     After a few seconds you may go to `http://localhost:8080` and see the faucet UI.
     ## Faucet security features:
@@ Expand Down @@

bin/faucet-client/Cargo.toml

-Original file line number
+Diff line change
@@ -0,0 +1,33 @@
+    [package]
+    authors.workspace      = true
+    description            = "Client CLI to request tokens from a remote Miden faucet (PoW mint)"
+    edition.workspace      = true
+    homepage.workspace     = true
+    license.workspace      = true
+    name                   = "miden-faucet-client"
+    readme                 = "README.md"
+    repository.workspace   = true
+    rust-version.workspace = true
+    version.workspace      = true
+    [lints]
+    workspace = true
+    [dependencies]
+    anyhow                 = { workspace = true }
+    clap                   = { features = ["derive", "env", "string"], version = "4.5" }
+    hex                    = { version = "0.4" }
+    miden-client           = { workspace = true }
+    miden-faucet-lib       = { workspace = true }
+    miden-pow-rate-limiter = { workspace = true }
+    rand                   = { features = ["thread_rng"], workspace = true }
+    reqwest                = { default-features = false, features = ["json", "rustls-tls"], version = "0.12" }
+    serde_json             = { workspace = true }
+    thiserror              = { workspace = true }
+    tokio                  = { features = ["macros", "net", "rt-multi-thread", "sync", "time"], workspace = true }
+    url                    = { workspace = true }
+    [dev-dependencies]
+    axum  = { features = ["tokio"], version = "0.8" }
+    serde = { workspace = true }
+    tokio = { features = ["macros", "net", "rt-multi-thread", "time"], workspace = true }

bin/faucet-client/README.md

-Original file line number
+Diff line change
@@ -0,0 +1,13 @@
+    # miden-faucet-client
+    Command-line tool for interacting with a live Miden faucet.
+    ## Commands
+    ### `mint`
+    Requests tokens from a faucet by solving its PoW challenge and minting a public P2ID note.
+    ```bash
+    miden-faucet-client mint --url <FAUCET_API_URL> --target-account <ACCOUNT_ID> --amount <AMOUNT>
+    ```

bin/faucet-client/src/lib.rs

Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		pub mod mint;

bin/faucet-client/src/main.rs

-Original file line number
+Diff line change
@@ -0,0 +1,29 @@
+    use clap::{Parser, Subcommand};
+    use miden_faucet_client::mint;
+    /// Client CLI for interacting with a live faucet.
+    #[derive(Parser)]
+    #[command(version, about, long_about = None)]
+    struct Cli {
+        #[command(subcommand)]
+        command: Command,
+    }
+    #[derive(Subcommand)]
+    enum Command {
+        /// Request tokens from a remote faucet (does not consume the resulting note).
+        Mint(mint::MintCmd),
+    }
+    #[tokio::main]
+    async fn main() -> anyhow::Result<()> {
+        let cli = Cli::parse();
+        match cli.command {
+            Command::Mint(cmd) => {
+                cmd.execute().await.map_err(anyhow::Error::from)?;
+            },
+        }
+        Ok(())
+    }

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: merge main into next #212

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!

Uh oh!