bitcoindevkit / bdk-sp / 33917752673

27%

push

github

Merge bitcoindevkit/bdk-sp#76: docs: fix the stale silent payment example in the README

5554f4270 docs: replace the stale README snippet with the example (kkdao)
7d50b1ed2 example: add a full send and scan flow (kkdao)

Pull request description:

  ### Description

  Every API reference in the README example is out of date, and nothing compiles it, so nothing caught the drift:

  - `receive::Scanner` and `send::XprivSilentPaymentSender` are not re-exported. They live at `receive::scan::Scanner` and `send::bip32::XprivSilentPaymentSender`.
  - The `SilentPaymentCode` struct literal cannot be written outside the crate because `version` is private, so it needs `new_v0`.
  - `label_to_tweak` was never declared mutable, and was a `HashMap` where `Scanner::new` takes a `BTreeMap`.
  - `SilentPaymentCode` has no `as_str`.
  - `send_to` takes inputs carrying a script pubkey alongside the derivation path, and returns the derived x-only keys grouped by recipient, not a flat list of script pubkeys.
  - `TxOut::value` is an `Amount`.

  The second commit adds `silentpayments/tests/integration_tests/readme.rs`, which runs the same flow end to end: derive a labelled code, hand it to the sender, derive the output, scan the resulting transaction, and confirm the payment is found, attributed to the label, and spendable.

  ### Notes to the reviewers

  The example stays an outline rather than becoming a compiling program. Spelling out the wallet's keys, transaction and inputs would bury the part worth reading, so it says so and links the test that does compile and run the same flow.

  Fixed by using the existing nested paths rather than adding re-exports, so the shorter paths do not become public API by accident.

  The new test is deterministic and needs no node. The scanner reads an input's public key from the prevout script pubkey rather than the witness, so a placeholder witness is enough for the inpu... (continued)

76 of 96 branches covered (79.17%)

Branch coverage included in aggregate %.

845 of 3307 relevant lines covered (25.55%)

6988.85 hits per line