test: add faucet E2E test by ricomateo · Pull Request #317 · 0xMiden/faucet

ricomateo · 2026-09-24T17:21:32Z

Adds an E2E test that tests the faucet along with a local network and a funding service.

ricomateo · 2026-09-24T20:47:41Z

 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;


I increased this because 3 attempts was not enough when running the E2E test in the CI

TomasArrachea · 2026-09-24T21:28:13Z

Could we implement this test in Rust instead? Also, I think the other scripts used for setup could just be Rust code as well. For the node, we might look at how the integration tests in the client spin it up, though using docker compose for it could be fine.

I think keeping the script to spin the node is fine, the client needs to compile it to be able to pin a specific commit but that is not useful here.

Migrating the test itself to Rust would allow us to remove the install-miden-client.sh script.

I migrated the test to Rust here 8c6c8b1

…irectory

…docker images

ricomateo · 2026-09-25T15:14:41Z

+      # is 0.17.0-rc.3. The release run for that tag failed before it built anything, so no images
+      # were published for it and the newest ones are 0.17.0-rc.2. Remove this once the images are
+      # published.
+      NODE_VERSION: 0.17.0-rc.2


The node docker images for 0.17.0-rc.3 haven't been published, so I pinned to the version to the previous one as a temporary fix.

The node rc.4 has been released and it's docker images should also be available.

I unpinned the node version in the CI test here 70c7f6a

TomasArrachea

Looks good. Left some suggestions for simplifying the code in the test.

TomasArrachea · 2026-10-01T22:04:49Z

+    ClientBuilder::new()
+        .rpc(Arc::new(VerifyingRpcClient::new(GrpcClient::new(
+            &endpoint,
+            REQUEST_TIMEOUT_MS,
+        ))))
+        .store(Arc::new(store))
+        .authenticator(Arc::new(keystore))
+        .build()
+        .await
+        .expect("the client should connect to the node")


We should we able to use the convenience constructors:

Suggested change

ClientBuilder::new()

.rpc(Arc::new(VerifyingRpcClient::new(GrpcClient::new(

&endpoint,

REQUEST_TIMEOUT_MS,

))))

.store(Arc::new(store))

.authenticator(Arc::new(keystore))

.build()

.await

.expect("the client should connect to the node")

ClientBuilder::<FilesystemKeyStore>::new()

.grpc_client(...)

.filesystem_keystore(...)?

.sqlite_store(...)

.build()

.await

.expect("the client should connect to the node");

TomasArrachea · 2026-10-01T22:05:51Z

+    let work_dir = std::path::Path::new(WORK_DIR);
+    // A fresh store every run, so a note or account from an earlier run cannot satisfy the test.
+    let _ = std::fs::remove_dir_all(work_dir);
+    std::fs::create_dir_all(work_dir.join("keys")).expect("the work directory should be created");


We can use a temp_dir here. For example for the keystore: temp_dir().join(format!("keystore-{}", Uuid::new_v4()));. Same for the store.

TomasArrachea · 2026-10-01T22:30:46Z

+    let key = AuthSecretKey::new_falcon512_poseidon2_with_rng(client.rng());
+    let auth = AuthSingleSig::new(Approver::new(
+        key.public_key().to_commitment(),
+        AuthSchemeId::Falcon512Poseidon2,
+    ));
+
+    let account = AccountBuilder::new(rand::random())
+        .account_type(AccountType::Public)
+        .with_component(auth)
+        .with_component(BasicWallet)
+        .build_with_schema_commitment()
+        .expect("the account should build");


We can simplify this by using AuthSingleSig::from_public_key() or replace the builder with create_basic_wallet().

TomasArrachea · 2026-10-01T22:31:43Z

+    for attempt in 1..=NOTE_ATTEMPTS {
+        client.sync_state().await.expect("the client should sync");
+
+        let consumable = client
+            .get_consumable_notes(Some(account_id))
+            .await
+            .expect("the consumable notes should be readable");
+
+        let found = consumable.into_iter().find(|(record, _)| record.id() == Some(note_id));
+        if let Some((record, _)) = found {
+            return record.try_into().expect("a committed note record holds its note");
+        }
+
+        println!("Note not committed yet, attempt {attempt}/{NOTE_ATTEMPTS}");
+        tokio::time::sleep(NOTE_DELAY).await;
+    }


I'm not sure but we might reuse the wait_for_consumable_notes() method if we use the miden_client::testing::TestClient.

TomasArrachea · 2026-10-01T22:32:24Z

+    let request = TransactionRequestBuilder::new()
+        .input_notes(vec![(note, None)])
+        .build()
+        .expect("the consume request should build");
+
+    client
+        .submit_new_transaction(account_id, request)
+        .await
+        .expect("the node should accept the consume transaction");


If we use the TestClient we can use TestClient::consume_notes for this, followed by wait_for_tx.

TomasArrachea · 2026-10-01T22:32:57Z

+fn fungible_balance(account: &Account) -> u64 {
+    account
+        .vault()
+        .assets()
+        .filter_map(|asset| asset.as_fungible().map(|asset| asset.amount().as_u64()))
+        .sum()
+}


Use the client.account_reader(account_id).get_balance(faucet_id) for this.

ricomateo · 2026-10-02T21:18:28Z

@TomasArrachea thanks! addressed the comments here f3f9b32

TomasArrachea · 2026-10-05T17:33:57Z

+#[ignore = "needs a node, funding service and faucet, run it with `make test-e2e`"]
+async fn request_tokens_and_consume_the_note() {
+    let faucet_url = env_or("FAUCET_URL", DEFAULT_FAUCET_URL);
+    let node_url = env_or("NODE_URL", DEFAULT_NODE_URL);


nit: I think we can use miden_client::rpc::Endpoint::localhost() for the node default

Done here d44a6e4

TomasArrachea · 2026-10-05T17:52:39Z

-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 }


I think this dep is unused.

Actually, this is for creating the client in the test itself

faucet/bin/faucet-client/tests/e2e.rs

Line 15 in f3f9b32

use miden_client_sqlite_store::ClientBuilderSqliteExt;

TomasArrachea · 2026-10-06T21:08:20Z

Should we remove this script as well and start the faucet process in the Rust test itself? For the network script it might be okay to use the script for the docker containers.

Removed the script and changed the Rust test to start the faucet here 8f4a492

…nstead

…f Cargo.toml

github-advanced-security Bot found potential problems Sep 24, 2026

View reviewed changes

Comment thread .github/workflows/test-e2e.yml Fixed

github-advanced-security Bot found potential problems Sep 24, 2026

View reviewed changes

Comment thread .github/workflows/test-e2e.yml Fixed

github-advanced-security Bot found potential problems Sep 24, 2026

View reviewed changes

Comment thread .github/workflows/test-e2e.yml Fixed

ricomateo force-pushed the ricomateo-e2e-test branch from 174a605 to b939900 Compare September 24, 2026 20:05

ricomateo changed the base branch from next to ricomateo-fix-ui-bugs September 24, 2026 20:07

ricomateo added the no changelog This PR does not require an entry in the `CHANGELOG.md` label Sep 24, 2026

ricomateo commented Sep 24, 2026

View reviewed changes

ricomateo changed the title ~~e2e test~~ test: add faucet E2E test Sep 24, 2026

ricomateo marked this pull request as ready for review September 24, 2026 20:48

ricomateo requested a review from TomasArrachea September 24, 2026 20:48

Base automatically changed from ricomateo-fix-ui-bugs to next September 24, 2026 21:19

TomasArrachea reviewed Sep 24, 2026

View reviewed changes

github-advanced-security Bot found potential problems Sep 25, 2026

View reviewed changes

Comment thread .github/workflows/test-e2e.yml Fixed

ricomateo force-pushed the ricomateo-e2e-test branch from c4761f4 to 88eb679 Compare September 25, 2026 14:25

ricomateo added 15 commits September 25, 2026 11:28

chore: list make targets whose name contains a digit

4043ea6

test: add an end-to-end test against a real node and funding service

566223a

ci: run the end-to-end test

70e9bbf

test: run the end-to-end test through the client binary

38bf444

test: consume the note in the end-to-end test

d7684b3

fix: wait longer for the note before consuming it

e59fc9a

ci: share the release cargo cache between the test jobs

26cfb3d

test: build the end-to-end binaries in a single invocation

5871820

test: give the end-to-end setup one make target and its own scripts d…

6bc3b6d

…irectory

chore: cleanup docs

6a3a561

fix: re-clone the node repo when the cargo cache empties it

b895caf

chore: restore error message

0b2612d

chore: rename miden-client.sh to install-miden-client.sh

97eb0a7

chore: cleanup

79c4770

test: replace the end-to-end shell test with a rust one

8c6c8b1

ricomateo force-pushed the ricomateo-e2e-test branch from 88eb679 to 8c6c8b1 Compare September 25, 2026 14:35

ricomateo added 2 commits September 25, 2026 11:39

chore: lint

c184092

fix: pin NODE_VERSION to the latest available version with published …

94121fa

…docker images

github-advanced-security Bot found potential problems Sep 25, 2026

View reviewed changes

Comment thread .github/workflows/test-e2e.yml Fixed

ricomateo commented Sep 25, 2026

View reviewed changes

TomasArrachea approved these changes Oct 1, 2026

View reviewed changes

ricomateo added 3 commits October 2, 2026 17:24

Merge branch 'next' into ricomateo-e2e-test

c8e7d40

chore: unpin node version in ci e2e test

70c7f6a

chore: address review comments

f3f9b32

TomasArrachea reviewed Oct 6, 2026

View reviewed changes

ricomateo and others added 8 commits October 7, 2026 18:01

chore: reuse Endpoint::localhost() instead of redefining it

d44a6e4

test: remove faucet.sh script and start the faucet in the rust test i…

8f4a492

…nstead

Merge branch 'next' into ricomateo-e2e-test

cd1b2c9

fix: change network.sh to read node version from Cargo.lock instead o…

9a58f29

…f Cargo.toml

fix: add missing field when creating FaucetConfig

82e4a64

fix(test): sync the client before waiting for the note to be committed

f4c580d

chore: restore main.rs

3dfc5ce

fix: github security bot comment

17ffd52

TomasArrachea approved these changes Oct 20, 2026

View reviewed changes

TomasArrachea merged commit d2d0c12 into next Oct 20, 2026
19 checks passed

TomasArrachea deleted the ricomateo-e2e-test branch October 20, 2026 18:40

Conversation

ricomateo commented Sep 24, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

ricomateo Sep 25, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TomasArrachea left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ricomateo commented Oct 2, 2026

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ricomateo commented Sep 24, 2026 •

edited

Loading

ricomateo Sep 25, 2026 •

edited

Loading