test: add faucet E2E test

.github/workflows/test-e2e.yml

@@ -0,0 +1,49 @@
+# Runs the faucet against a real node and funding service.
+
+name: test-e2e
+
+on:
+  push:
+    branches: [main, next]
+  pull_request:
+    types: [opened, reopened, synchronize]
+
+# Limits workflow concurrency to only the latest commit in the PR.
+concurrency:
+  group: "${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}"
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  test-e2e:
+    name: test-e2e
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - uses: actions/checkout@main
+      - name: Rustup
+        run: rustup update --no-self-update
+      - uses: Swatinem/rust-cache@v2
+        with:
+          # `make test` builds the whole workspace in release, which covers everything this job
+          # compiles, so both share one cache instead of each filling its own.
+          shared-key: release
+          # Saving on a pull request too means a second push to the same branch does not recompile.
+          # GitHub scopes a branch's cache to that branch, so this does not disturb other runs.
+          save-if: true
+
+      - name: Start the node and the funding service
+        run: scripts/e2e/network.sh up
+
+      - name: Run the test
+        run: cargo test --release --locked -p miden-faucet-client --test e2e -- --ignored --nocapture
+
+      - name: Network logs
+        if: failure()
+        run: scripts/e2e/network.sh logs
+
+      - name: Stop everything
+        if: always()
+        run: scripts/e2e/network.sh down

.github/workflows/test.yml

@@ -24,7 +24,9 @@ jobs:
         run: rustup update --no-self-update
       - uses: Swatinem/rust-cache@v2
         with:
+          # Shared with the end-to-end job, which builds the same release artifacts.
+          shared-key: release
           save-if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/next' }}
-      - uses: taiki-e/install-action@nextest 
+      - uses: taiki-e/install-action@nextest
       - name: Run tests
         run: make test

Cargo.toml

@@ -19,6 +19,7 @@ version      = "0.17.1"
 opt-level = 2
 
 [workspace.dependencies]
+miden-faucet           = { path = "bin/faucet", version = "0.17" }
 miden-faucet-lib       = { path = "crates/faucet", version = "0.17" }
 miden-pow-rate-limiter = { path = "crates/pow", version = "0.17" }
 

Makefile

@@ -2,7 +2,7 @@
 
 .PHONY: help
 help:
-	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+	@grep -E '^[a-zA-Z0-9_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
 
 # -- variables ------------------------------------------------------------------------------------
 
@@ -78,6 +78,16 @@ book: ## Builds the book & serves documentation site
 test:  ## Runs all tests
 	cargo nextest run --release --all-features --workspace
 
+# The end-to-end test starts a real node, funding service and faucet, requests tokens and consumes
+# the resulting note.
+.PHONY: test-e2e
+test-e2e: ## Runs the end-to-end test against a real node and funding service
+	scripts/e2e/network.sh up
+	cargo test --release --locked -p miden-faucet-client --test e2e -- --ignored --nocapture; \
+	    status=$$?; \
+	    scripts/e2e/network.sh down; \
+	    exit $$status
+
 # --- checking ------------------------------------------------------------------------------------
 
 .PHONY: check

bin/faucet-client/Cargo.toml

@@ -29,7 +29,9 @@ tokio                  = { features = ["macros", "net", "rt-multi-thread", "sync
 url                    = { workspace = true }
 
 [dev-dependencies]
-axum         = { features = ["tokio"], version = "0.8" }
-miden-client = { features = ["testing"], workspace = true }
-serde        = { workspace = true }
-tokio        = { features = ["macros", "net", "rt-multi-thread", "time"], workspace = true }
+axum                      = { features = ["tokio"], version = "0.8" }
+miden-client              = { features = ["testing"], workspace = true }
+miden-client-sqlite-store = { workspace = true }
+miden-faucet              = { workspace = true }
+serde                     = { workspace = true }
+tokio                     = { features = ["macros", "net", "rt-multi-thread", "time"], workspace = true }

bin/faucet-client/src/mint.rs

@@ -26,7 +26,7 @@ use tokio::task;
 
 const DEFAULT_FAUCET_URL: &str = "https://faucet-api.testnet.miden.io";
 const REQUEST_TIMEOUT_MS: u64 = 30_000;
-const MAX_SYNC_RETRIES: u32 = 3;
+const MAX_SYNC_RETRIES: u32 = 10;
 const SYNC_RETRY_DELAY_SECS: u64 = 5;
 
 // CLI
@@ -166,15 +166,15 @@ impl MintCmd {
 
 /// HTTP client for interacting with the faucet API.
 #[derive(Clone)]
-struct FaucetHttpClient {
+pub struct FaucetHttpClient {
     http_client: HttpClient,
     base_url: Url,
     api_key: Option<String>,
 }
 
 impl FaucetHttpClient {
     /// Creates a new `FaucetHttpClient` instance.
-    fn new(
+    pub fn new(
         endpoint: &str,
         timeout_ms: u64,
         api_key: Option<String>,
@@ -191,7 +191,7 @@ impl FaucetHttpClient {
     }
 
     /// Requests a `PoW` challenge from the faucet API.
-    async fn request_pow(
+    pub async fn request_pow(
         &self,
         account_id: &AccountId,
         amount: u64,
@@ -231,7 +231,7 @@ impl FaucetHttpClient {
     }
 
     /// Requests tokens from the faucet API.
-    async fn request_tokens(
+    pub async fn request_tokens(
         &self,
         challenge: &str,
         nonce: u64,
@@ -349,7 +349,7 @@ fn parse_account_id(input: &str) -> Result<AccountId, MintClientError> {
 /// Solves the `PoW` challenge and returns the nonce that satisfies the target.
 ///
 /// Heavy work runs on a blocking thread so we don't stall the async runtime.
-async fn solve_challenge(challenge_hex: &str, target: u64) -> Result<u64, MintClientError> {
+pub async fn solve_challenge(challenge_hex: &str, target: u64) -> Result<u64, MintClientError> {
     if target == 0 {
         return Err(MintClientError::ZeroTarget);
     }