Skip to content

blindbit-lib tests: one shared fixture module, drop duplicate tests (SNB-666) - #57

Closed
setavenger wants to merge 7 commits into
integrationfrom
snb-666-shared-test-fixtures
Closed

setavenger wants to merge 7 commits into
integrationfrom
snb-666-shared-test-fixtures

Conversation

@setavenger

@setavenger setavenger commented Oct 3, 2026 •

Copy link
Copy Markdown
Owner

Stacked on #52 (on #47, on #44); review only the commits after it. The merge commit 7fecbc8 only brings in #52's later fix (72104e0).

Linear: SNB-666

Net: 223 insertions, 394 deletions (−171 lines), tests only. The new scanner/test_support.rs is 120 lines of that.

What was merged and why

  • One fixture module, scanner/test_support.rs. The test wallet's keys (secret, keys), run, the never-connecting oracle client, state-file paths, TempState and the scanner constructors were each defined again in five or six test modules. They are now secret, keys, run, oracle_client, state_file, TempState, scanner(tag), scanner_at(path, max_label_num) and restore_from(path).
    • Replaced: stream_safety's scanner/run/keys/secret/TempState; reorg's wallet/restart/client/socket/state_file/TempState/run/keys/secret; owned_outputs' oracle_client/state_file/scanner/keys/secret/block_on (its restore now uses restore_from); state_file_tests' client/new_scanner (its config uses keys()); witness' restart (uses restore_from); bip352_vectors' oracle_client/state_file.
    • bip352_vectors keeps its own default_scanner, because it uses the vectors' keys on mainnet.
    • The oracle URL parameter of stream_safety's scanner is gone: every caller passed "http://127.0.0.1:1".
  • a_fetched_block_keeps_its_witnesses is dropped. It is covered by the next test, a_block_stripped_of_its_witnesses_is_refused_and_fetched_again. That test's first case fetches the same kind of taproot block and asserts got == block, which compares witnesses too, after a stripped serve. The removed test's extra wtxid check follows from that equality.
  • p2p_tests::Node: three constructors instead of four. full and serving both call one spawn(services, height, block, script); the block-less spawn had one caller.
  • The witness-stripping loop is one helper. p2p_tests::stripped is used by the fake node's Served and by the witness tests.
  • Stale #[allow(dead_code)] removed on the vectors' sending field: it is read (case.sending.is_empty()).

Changes in test behaviour (deliberate, small)

  • oracle_client() builds on the caller's Tokio runtime when there is one (the async tests, exactly as before), and otherwise on a process-wide runtime (the synchronous owned-output and vector tests, exactly as their own copies did).
  • All tests now point the oracle client and the P2P peer at 127.0.0.1:1, where nothing listens. owned_outputs and bip352 used [::1]:50051 and 127.0.0.1:8333; neither test module contacts the oracle or the peer, and port 8333 could have been a real local node.
  • state_file(tag) adds a per-call counter to the file name. Two modules used the same tag ("restart"), which only stayed safe because their name prefixes differed; now no two calls can collide.
  • The pre-owned-outputs restore test now restores the file it just saved, instead of writing a re-serialised copy to a second path. This also stops it leaving a temp file behind.

Review follow-up (6cde6b1)

  • owned_outputs_labels_and_spends_survive_restart now builds its scanner on the same state file it saves, restores and removes (scanner_at(path.clone(), 2)). Before, a second state_file() call returned a different path.
  • bip352_vectors::default_scanner now uses 127.0.0.1:1 too, so every test points at a port where nothing listens, as stated above.
  • Re-run on 6cde6b1: check 0 warnings, --no-default-features 5 warnings, clippy and fmt clean, cargo test --workspace 253 passed, 1 ignored, 0 failed, and no blindbit-test-* files left behind.

Verification

  • cargo check --workspace --all-targets --all-features → 0 warnings.
  • cargo check -p blindbit-lib --no-default-features --all-targets → 5 warnings (baseline 5).
  • cargo clippy --no-deps -p friglet -p friglet-ipc -p friglet-tray --all-targets -- -D warnings → clean.
  • cargo fmt -p friglet -p friglet-ipc -p friglet-tray -- --check → clean.
  • cargo test --workspace → 253 passed, 1 ignored, 0 failed. The baseline is 254 passed; the one test removed is the duplicate witness_tests::a_fetched_block_keeps_its_witnesses.
  • cargo test -p blindbit-lib --all-features was run two more times: 76 passed each time, and no blindbit-test-* files were left in the temp dir.

setavenger and others added 4 commits October 3, 2026 08:43
Remove public items nothing calls, in this workspace or in the other
repos that use blindbit-lib (blindbit-node-apps, testkit, the talk
benchmark):

- broadcast_tx: its only caller, friglet's Electrum broadcast, uses
  friglet's own relay since #26.
- Scanner::from_config, get_last_scanned_block_height_rescan,
  staged_mut, take_staged and the commented-out get_outputs.
- watch_chain: friglet calls watch_chain_until; its doc moves there.
- BlockIdentifierDisplay (only .0.block_height was read), OwnedOutput
  (never built), ProbableMatch::new, _match_short_pubkey_bytes and the
  commented-out ScannerConfig Default. electrum_index becomes a private
  module; its items stay re-exported.
- The spent-outpoint and probabilistic-match channels and the code that
  only fed them. They had no subscribers and never sent anything: the
  sends were guarded by Sender::is_empty(), which means "no queued
  value", so they were always skipped. The malformed-hash branch that
  guarded them cannot run: check_block_identifier rejects such a block
  before scan_short_block_data sees it. The "possible spend of owned
  output" log line stays.
- save_to_file's back-fill of keys and max_label_num: stage holds them
  from construction on and only take_staged could clear them. A test
  run with assertions in place of the back-fill passed every workspace
  test.
- P2P: TimeoutParams setters the handshake never reads (it only uses
  the ping interval; the socket timeouts are set directly), history
  notes about deleted code, and a retry doc that predates the
  witness-stripped and bad-block retries.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Scanner::new and from_changeset each wrote out the whole struct; both
now hand their staged changeset to one private constructor,
from_stage, which derives the rest (checkpoints with genesis, owned
outputs, remembered hashes, Electrum index) from it.

- "New indexer, labels 0..=max, then apply_changeset" was written in
  from_changeset and in the reorg rollback; it is restored_indexer now,
  with the reason the labels must come first.
- The genesis checkpoint hash was built in three places; genesis_hash().
- new() merged add_label(0..=max) into the stage a second time after
  initial_changeset() already carried those labels (label_lookup is a
  set, so the merge changed nothing); dropped.
- The remembered-hash lookup in reorg.rs is one helper.
- Scanner.last_scanned_block_height_rescan was only restored, lowered on
  rollback and copied into every save. The stage already holds the same
  value, so the field goes; the ChangeSet field and the state format
  stay as they are.

A probe (not committed) dumped stage, saved file and full scanner
state for fresh scanners, a test-produced wallet, the old-format
fixture, restores and rollbacks of each, before and after this change:
all 42 outputs identical.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- The scan loop's two arms (no match / matched block) each advanced
  the scanned height, recorded the block hash and notified Electrum;
  that now happens once after the optional matched-block step, in the
  same order as before. The periodic checkpoint still runs only for
  blocks without a match (a matched block is saved earlier).
- The oracle's display-order block hash is decoded once:
  check_block_identifier returns it (via health.rs's
  indexed_block_hash, the same length and all-zero rules), and the P2P
  fetch uses it instead of decoding the bytes again.
  block_hash_from_oracle goes.
- The balance over the sparse checkpoints is one helper, balance_at,
  used for the per-block "balance" log, the "balance after scan" log
  and the owned-output tests (which had a third copy).
- The matched block's scan_progress write is dropped; the progress
  notification right after it writes the same value.
- The debug loop that logged every graph transaction after each
  matched block is dropped.
- apply_matched_block computed every transaction's txid once per
  matched txid; it now builds a txid map and hashes each transaction
  once.
- OracleStreams only delegated to the oracle client: the client now
  implements BlockStreamSource itself (it already implemented
  OracleProbe). An identity match in probabilistic_match goes.
- Stale TODOs and comments (notifications that no longer exist, a
  config-constructor TODO the talk benchmark rules out, Electrum index
  docs that missed the restore and broadcast writers).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…SNB-666)

The test wallet's keys, the Tokio runner, the never-connecting oracle
client, state-file paths, TempState and the scanner constructors were
defined again in five to six test modules. They now live in
scanner/test_support.rs:

- oracle_client() uses the caller's runtime when there is one and a
  process-wide one otherwise, so it serves both the async tests and the
  synchronous owned-output and BIP-352 tests. All tests now point at
  127.0.0.1:1, where nothing listens (two modules used [::1]:50051 and
  127.0.0.1:8333).
- state_file(tag) returns a path no other call returns, so modules
  can no longer collide on a tag (reorg and owned-output tests both
  used "restart").
- scanner(tag), scanner_at(path, max_label_num) and restore_from(path)
  replace stream_safety's scanner, reorg's wallet/restart,
  owned_outputs' scanner/restore, witness' restart and state_file's
  new_scanner/client. bip352_vectors keeps its own constructor (vector
  keys, mainnet) on the shared client and paths.

Also:
- a_fetched_block_keeps_its_witnesses is dropped: the next test fetches
  the same kind of block whole on its second connection and compares
  the whole block, witnesses included.
- p2p_tests' Node has three constructors instead of four, and the
  witness-stripping loop is one helper (stripped) used by the fake node
  and the witness tests.
- The stale allow(dead_code) on the vectors' `sending` field goes (the
  field is read).
- The pre-owned-outputs restore test restores the file it just saved
  instead of a re-serialised copy, so it leaves no file behind.

Test count: 254 -> 253 passed (the one duplicate removed), 1 ignored.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
setavenger and others added 3 commits October 3, 2026 10:10
A block fetched only because an owned output may be spent carries no
matched txids. The txid filter still hashed every transaction of it
(about 2 ms per block); the code before #52 did nothing there. Skip
the filter when there are no matched txids.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…NB-666)

Brings #52's spend-only fix (skip the txid filter when no txid
matched) into this stacked branch.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
- owned_outputs_labels_and_spends_survive_restart builds its scanner on
  the state file it saves, restores and removes. state_file() returns a
  new path on every call, so the second call gave the scanner a
  different file than the one the test checks.
- default_scanner in the BIP-352 vectors points its P2P peer at
  127.0.0.1:1 like every other test (it is never contacted).

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
setavenger added a commit that referenced this pull request Oct 3, 2026
…nfirmed (SNB-687)

Picks up #57's review nits and #52's follow-up.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
setavenger added a commit that referenced this pull request Oct 3, 2026
…688)

Picks up #57's review nits and #52's follow-up.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@setavenger

Copy link
Copy Markdown
Owner Author

Merged into integration through #68 on 2026-10-11 (the user live-tested the combined stack first). GitHub's stacked-PR merge rebased the stack, so this PR's commits landed with new IDs and GitHub can't mark it merged itself. The code is identical: integration now has the same tree as the tested branch friglet-deslop-live-test (08bf11d), which contains this PR's head. Closing as merged via #68.

@setavenger setavenger closed this Oct 11, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant