Skip to content

Friglet cleanup 2/6: simplify scanner and P2P paths (SNB-661) - #68

Merged
setavenger merged 10 commits into
integrationfrom
snb-661-stack-02-library
Oct 11, 2026
Merged

setavenger merged 10 commits into
integrationfrom
snb-661-stack-02-library

Conversation

@setavenger

Copy link
Copy Markdown
Owner

Stacked on #67; review only this stage's commits and diff.

Purpose

Consolidate the scanner and P2P cleanup into one traceable library stage. It removes dead scanner APIs and duplicate scan paths, centralizes scanner construction and test fixtures, corrects confirmed-balance logging, distinguishes stalled transfers from missing blocks, and makes fake-peer shutdown deterministic.

The stage preserves the original reviewed commits and authorship. It is cumulative with stage 1 for SNB-661.

Stack

  1. Predecessor: snb-661-stack-01-foundation (#67)
  2. This PR: snb-661-stack-02-library → snb-661-stack-01-foundation
  3. Successor: snb-661-stack-03-ipc

Included original PRs, in merge order: #44 (SNB-663), #47 (SNB-673), #52 (SNB-669), #57 (SNB-666), #61 (SNB-687), #62 (SNB-688), #66 (SNB-692).

Verification

Full accumulated debug gate on this exact head:

  • cargo check --workspace --all-targets --all-features: clean, 0 warnings.
  • cargo check -p blindbit-lib --no-default-features --all-targets: 5 baseline warnings, no growth.
  • 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: 256 passed, 1 ignored, 0 failed.

The combined suite includes the scanner stream, balance, retry, cancellation, and real-TCP fake-peer regression cases from the source PRs. The source PRs distinguished runtime evidence from test coverage; this grouped stage did not add a live Bitcoin Core mid-transfer fault injection or a new external-service scan.

Landing

Merge the six grouped PRs in numeric order with merge commits. After #67 lands, retarget this PR to integration, verify its base and diff, and only then merge it. Preserve the predecessor branch until this PR has been retargeted if necessary. After this PR lands, apply the same process to stage 3. Never merge a child PR into its feature-branch base.

@setavenger
setavenger added this pull request to stack #77 October 11, 2026 12:17
Base automatically changed from snb-661-stack-01-foundation to integration October 11, 2026 18:13
setavenger and others added 10 commits October 11, 2026 20:13
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>
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>
…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>
- 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>
…an" (SNB-687)

The end-of-range "balance after scan" line computed the balance with the
last block matched in that range as the chain tip, and with genesis when
no block in the range paid the wallet. bdk_chain cannot place an anchor
above the tip it is given, so it counted every output as pending: the
line logged confirmed=0 and the whole balance as trusted_pending. That
is every range while the daemon follows the tip, as a rule.

The balance is now counted up to the highest checkpoint. When the range
matched a block above every earlier checkpoint (any forward scan), that
block is the highest checkpoint, so the logged values are the same as
before. The message and field names are unchanged; friglet-ui matches
the line by its text.

balance_after_scan_counts_earlier_outputs_as_confirmed scans a paying
block, then a block that pays nobody, and checks the fields of both
lines. Before the fix the second line read confirmed="0 BTC",
trusted_pending="0.00011800 BTC".

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

bitcoin-p2p reads each message with read_exact, so a read timeout part
way through the block throws away the bytes read so far. A node that
sent half a block and went quiet therefore looked like one that sent
nothing: at the deadline the fetch reported NoAnswer, with advice that
the node is probably pruned, and NoAnswer is not tried again in that
round.

The fetch now sends a ping right after getdata. A node handles a peer's
messages in order, so it answers the ping once it has sent the block or
decided not to. At the deadline, a pong means the node does not serve
the block (NoAnswer, as before). No pong means the node went quiet, so
the attempt fails as a broken connection, which is tried again on a
fresh one. The wait itself is unchanged.

Tests: a_transfer_that_stalls_mid_block_is_retried_on_a_fresh_connection
and a_transfer_that_keeps_stalling_is_not_reported_as_a_missing_block
use the fake node's StallMidBlock. Before the fix both ended after one
attempt with NoAnswer and "the node sent nothing for 303 ms ... It is
probably pruned below this height". The fake node's Ignore now answers
pings, as Bitcoin Core does while ignoring a request for a block it
does not have.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
A no-pong deadline is still exposed as a broken connection, but keep its
private attempt classification long enough to allow one fresh connection
and then end the round. This reports a persistent stall after about 181 s
instead of consuming all five 90 s attempts, while other transient
failures retain their configured retry budget.

Correct the NoAnswer message now that a matching pong proves the peer did
answer, and strengthen the fake-peer tests for both recovery and the
quiet-stall retry cap.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
The CloseAfterHandshake fake peer closed as soon as it read verack, while
bitcoin-p2p could still be writing its remaining handshake messages. That
made the expected post-handshake Closed failure race with a legitimate
during-handshake failure.

Wait for getdata, which is sent only after the client handshake returns,
then half-close the fake peer's write side and drain its input. Rename the
fixture behavior to describe this deterministic boundary.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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