Add the receiver PIR restore client

.github/workflows/verify.yml

@@ -79,7 +79,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        config: [default, orchard, transparent, transparent-import, sqlite, enhance-wallet, enhance, transparent-pir, transparent-pir-sqlite, transparent-pir-testing]
+        config: [default, orchard, transparent, transparent-import, sqlite, enhance-wallet, enhance, transparent-pir, transparent-pir-sqlite, transparent-pir-testing, pir-receiver]
     env:
       WALLET_LIB_BUILD_ROOT: ${{ github.workspace }}/target/dev-lanes
     steps:

Cargo.toml

@@ -21,6 +21,7 @@ members = [
     "zakura/transaction-status",
     "zakura/pir-transparent",
     "zakura/dynamic-ivk",
+    "zakura/pir-receiver",
 ]
 
 resolver = "2"

README.md

@@ -57,7 +57,9 @@ regeneration command, separate from ordinary builds.
 The [dynamic IVK](zakura/dynamic-ivk/README.md) crate provides shared
 derivation of receiving keys that keep an account's spending authority with their
 own incoming viewing keys, and refund memo helpers, with an Ironwood proof test for
-mixed ordinary, refund, and incoming inputs.
+mixed ordinary, refund, and incoming inputs. The unpublished
+[receiver PIR](zakura/pir-receiver/README.md) crate runs the restore sweeps that
+find payments to those keys through a receiver directory.
 
 ## How the rewiring works
 

librustzcash/zcash_client_sqlite/src/wallet/dynamic_ivk.rs

@@ -22,7 +22,7 @@
 //!   [`WalletDb::begin_receive_operation`], [`WalletDb::finish_receive_operation`] and
 //!   [`WalletDb::start_receive_operation`].
 //! - [`WalletDb::record_operation_status`] for each provider status of either.
-//! - The [`DynamicIvkWrite`] sweep steps for restore sweeps, and
+//! - `zakura_pir_receiver::sweep` for restore sweeps, and
 //!   [`WalletDb::recheck_dynamic_key_history`] when the user asks to recheck swaps.
 //!
 //! [`DynamicIvkRead`]: zcash_client_backend::data_api::dynamic_ivk::DynamicIvkRead

manifests/sources.toml

@@ -27,7 +27,7 @@ vendored_directory = "librustzcash"
 vendor_branch = "vendor/librustzcash"
 upstream_manifest = "librustzcash/upstream-workspace.toml"
 # `zakura/` members are added here as they are written.
-extra_members = ["wallet-lib", "zakura/pir-enhance", "zakura/pir-enhance-types", "zakura/pir-native", "zakura/pir-status", "zakura/transaction-status", "zakura/pir-transparent", "zakura/dynamic-ivk"]
+extra_members = ["wallet-lib", "zakura/pir-enhance", "zakura/pir-enhance-types", "zakura/pir-native", "zakura/pir-status", "zakura/transaction-status", "zakura/pir-transparent", "zakura/dynamic-ivk", "zakura/pir-receiver"]
 # The backend selector. Named separately because the verification scripts have
 # to build it one backend at a time, unlike every other member.
 facade = "wallet-lib"

scripts/dev.py

@@ -15,7 +15,7 @@
 
 ROOT = Path(__file__).resolve().parents[1]
 CONFIGS = {
-    "default": (["--workspace", "--exclude", "zakura-wallet-lib", "--exclude", "zakura-pir-enhance", "--exclude", "zakura-pir-transparent"], []),
+    "default": (["--workspace", "--exclude", "zakura-wallet-lib", "--exclude", "zakura-pir-enhance", "--exclude", "zakura-pir-transparent", "--exclude", "zakura-pir-receiver"], []),
     "orchard": (["-p", "zakura-client-backend", "-p", "zakura-client-sqlite"], ["orchard", "test-dependencies"]),
     "transparent": (["-p", "zakura-client-backend", "-p", "zakura-client-sqlite"], ["orchard", "transparent-inputs", "test-dependencies", "unstable"]),
     "transparent-import": (["-p", "zakura-client-backend", "-p", "zakura-client-sqlite"], ["orchard", "transparent-inputs", "transparent-key-import", "test-dependencies", "unstable"]),
@@ -25,6 +25,7 @@
     "transparent-pir": (["-p", "zakura-pir-transparent"], ["wallet"]),
     "transparent-pir-sqlite": (["-p", "zakura-pir-transparent"], ["sqlite"]),
     "transparent-pir-testing": (["-p", "zakura-pir-transparent"], ["sqlite", "testing"]),
+    "pir-receiver": (["-p", "zakura-pir-receiver"], ["wallet"]),
 }
 VERIFY = ("zakura-graph", "wallet-lib-modes", "vendor-ancestry")
 

scripts/verify-zakura-graph.sh

@@ -36,10 +36,11 @@ PY
 cargo check --manifest-path "$repo_root/Cargo.toml" \
   --workspace --exclude "$facade" --all-targets --all-features --locked
 
-# No development lane builds the transparent PIR adapter without `wallet`: its
-# tests serve shards in process, so the `default` lane leaves it out.
+# No development lane builds the transparent PIR adapter or the receiver PIR
+# client without `wallet`: their tests serve shards or directories in process,
+# so the `default` lane leaves them out.
 cargo check --manifest-path "$repo_root/Cargo.toml" \
-  -p zakura-pir-transparent --lib --locked
+  -p zakura-pir-transparent -p zakura-pir-receiver --lib --locked
 
 cargo metadata --locked --manifest-path "$repo_root/Cargo.toml" \
   --format-version 1 --all-features \
@@ -101,6 +102,16 @@ for name, found in sorted(versions.items()):
     if len(found) > 1 and (name.startswith("zakura-") or name in expected_packages):
         problems.append(f"{name}: {len(found)} versions in the graph: {sorted(found)}")
 
+# Two git sources of one name are separate crates even at one version. Checked
+# over the whole workspace graph, where the PIR clients share wallet-pir crates.
+git_sources = defaultdict(set)
+for package in packages.values():
+    if (package["source"] or "").startswith("git+"):
+        git_sources[package["name"]].add(package["source"])
+for name, found in sorted(git_sources.items()):
+    if len(found) > 1:
+        problems.append(f"{name}: {len(found)} git sources in the graph: {sorted(found)}")
+
 missing = expected_packages - versions.keys()
 for name in sorted(missing):
     problems.append(f"{name}: vendored crate is not in the resolved graph")

zakura/dynamic-ivk/README.md

@@ -26,8 +26,9 @@ owns reservation, persistence, coverage, lifecycle, and note selection. There is
 no alternate balance store in this crate.
 
 The SQLite backend implements this contract with its `orchard` feature: durable
-key registration, scanning, completion, and restore sweeps. Its rustdoc, starting
-at `zcash_client_sqlite::wallet::dynamic_ivk`, documents the calls a wallet makes.
+key registration, scanning, completion, and the restore sweeps that
+`zakura-pir-receiver` runs. Its rustdoc, starting at
+`zcash_client_sqlite::wallet::dynamic_ivk`, documents the calls a wallet makes.
 
 Software PCZT signing of dynamic-key notes works through the same builder.
 Hardware signers need firmware qualification before dynamic keys are enabled for

zakura/pir-receiver/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [Unreleased]
+
+### Added
+
+- `sweep`, behind the `wallet` feature, which runs a restored wallet's
+  receiver-directory sweeps of its dynamic keys for any store implementing the
+  backend's `DynamicIvkWrite`, with `Transport`, `NoteSource`, `EnhanceNotes`, `WriteLock`,
+  `Swept`, `Error` and `MAINNET_GENESIS`. It reads a publication's labeled filter
+  sets `paid` and each provider's `seen`. The receiver PIR client moved here from
+  Vizor.
+- `fetch_seen` and `Seen`: a publication's swap provider seen sets, which a wallet
+  checks before issuing a swap address. A publication without seen sets, or in which
+  a provider with sets lacks a dated seen set, is malformed, for `fetch_seen` and
+  `sweep` alike. They need no `wallet` feature.

zakura/pir-receiver/Cargo.toml

@@ -0,0 +1,47 @@
+[package]
+name = "zakura-pir-receiver"
+version = "0.0.1-rc0"
+publish = false
+description = "Restore sweeps of dynamic IVKs through a receiver directory over PIR"
+edition.workspace = true
+rust-version.workspace = true
+license.workspace = true
+repository.workspace = true
+readme = "README.md"
+
+[features]
+default = []
+## The restore sweep, over a wallet store's dynamic IVK traits.
+wallet = ["dep:futures-util", "dep:thiserror", "dep:zakura-pir-enhance", "dep:zakura-dynamic-ivk", "dep:zcash_client_backend", "dep:zcash_protocol"]
+
+[dependencies]
+futures-util = { version = "0.3", optional = true }
+thiserror = { version = "2", optional = true }
+zakura-pir-enhance = { version = "=0.0.1-rc1", path = "../pir-enhance", features = ["wallet"], optional = true }
+zakura-dynamic-ivk = { version = "=0.0.1-rc0", path = "../dynamic-ivk", optional = true }
+zcash_client_backend = { workspace = true, features = ["orchard"], optional = true }
+zcash_protocol = { workspace = true, optional = true }
+# The receiver crates come from wallet-pir's `main`.
+receiver-directory = { git = "https://github.com/valargroup/wallet-pir", rev = "9d2cbda0b4336258cfce76ca8ee77b095daa7fd7" }
+receiver-pir = { git = "https://github.com/valargroup/wallet-pir", rev = "9d2cbda0b4336258cfce76ca8ee77b095daa7fd7" }
+
+[dev-dependencies]
+axum = "0.7"
+base64.workspace = true
+hex.workspace = true
+orchard.workspace = true
+receiver-pir = { git = "https://github.com/valargroup/wallet-pir", rev = "9d2cbda0b4336258cfce76ca8ee77b095daa7fd7", features = ["server"] }
+receiver-pir-server = { git = "https://github.com/valargroup/wallet-pir", rev = "9d2cbda0b4336258cfce76ca8ee77b095daa7fd7" }
+rusqlite = { workspace = true, features = ["hooks"] }
+serde_json.workspace = true
+sha2.workspace = true
+tokio = { workspace = true, features = ["macros", "rt"] }
+tower = { workspace = true, features = ["util"] }
+zcash_client_backend = { workspace = true, features = ["orchard", "test-dependencies"] }
+zcash_client_sqlite = { path = "../../librustzcash/zcash_client_sqlite", package = "zakura-client-sqlite", features = ["orchard", "test-dependencies"] }
+zcash_note_encryption.workspace = true
+zcash_primitives.workspace = true
+
+[[test]]
+name = "sweep"
+required-features = ["wallet"]