-
Notifications
You must be signed in to change notification settings - Fork 100
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a scanning results reader (#8104)
* Add a scanning results reader * Simplify intro & titles in `zebra-utils/README.md` * Add a tutorial for the scanning results reader * Reformat `zebra-utils/Cargo.toml` Co-authored-by: teor <teor@riseup.net> * Update `zebra-utils/README.md` Co-authored-by: teor <teor@riseup.net> * standard grouping Co-authored-by: teor <teor@riseup.net> * Add a comment on a first empty memo Co-authored-by: teor <teor@riseup.net> * Use `exactly_one()` instead of `next()` * Simplify various type conversions --------- Co-authored-by: teor <teor@riseup.net>
- Loading branch information
Showing
6 changed files
with
223 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| //! Displays Zebra's scanning results: | ||
| //! | ||
| //! 1. Opens Zebra's scanning storage and reads the results containing scanning keys and TXIDs. | ||
| //! 2. Fetches the transactions by their TXIDs from Zebra using the `getrawtransaction` RPC. | ||
| //! 3. Decrypts the tx outputs using the corresponding scanning key. | ||
| //! 4. Prints the memos in the outputs. | ||
|
|
||
| use std::collections::HashMap; | ||
|
|
||
| use hex::ToHex; | ||
| use itertools::Itertools; | ||
| use jsonrpc::simple_http::SimpleHttpTransport; | ||
| use jsonrpc::Client; | ||
| use serde_json::value::RawValue; | ||
|
|
||
| use zcash_client_backend::decrypt_transaction; | ||
| use zcash_client_backend::keys::UnifiedFullViewingKey; | ||
| use zcash_primitives::consensus::{BlockHeight, BranchId}; | ||
| use zcash_primitives::transaction::Transaction; | ||
| use zcash_primitives::zip32::AccountId; | ||
|
|
||
| use zebra_scan::scan::sapling_key_to_scan_block_keys; | ||
| use zebra_scan::{storage::Storage, Config}; | ||
|
|
||
| /// Prints the memos of transactions from Zebra's scanning results storage. | ||
| /// | ||
| /// Reads the results storage, iterates through all decrypted memos, and prints the them to standard | ||
| /// output. Filters out some frequent and uninteresting memos typically associated with ZECPages. | ||
| /// | ||
| /// Notes: | ||
| /// | ||
| /// - `#[allow(clippy::print_stdout)]` is set to allow usage of `println!` for displaying the memos. | ||
| /// - This function expects Zebra's RPC server to be available. | ||
| /// | ||
| /// # Panics | ||
| /// | ||
| /// When: | ||
| /// | ||
| /// - The Sapling key from the storage is not valid. | ||
| /// - There is no diversifiable full viewing key (dfvk) available. | ||
| /// - The RPC response cannot be decoded from a hex string to bytes. | ||
| /// - The transaction fetched via RPC cannot be deserialized from raw bytes. | ||
| #[allow(clippy::print_stdout)] | ||
| pub fn main() { | ||
| let network = zcash_primitives::consensus::Network::MainNetwork; | ||
| let storage = Storage::new(&Config::default(), network.into(), true); | ||
| // If the first memo is empty, it doesn't get printed. But we never print empty memos anyway. | ||
| let mut prev_memo = "".to_owned(); | ||
|
|
||
| for (key, _) in storage.sapling_keys_last_heights().iter() { | ||
| let dfvk = sapling_key_to_scan_block_keys(key, network.into()) | ||
| .expect("Scanning key from the storage should be valid") | ||
| .0 | ||
| .into_iter() | ||
| .exactly_one() | ||
| .expect("There should be exactly one dfvk"); | ||
|
|
||
| let ufvk_with_acc_id = HashMap::from([( | ||
| AccountId::from(1), | ||
| UnifiedFullViewingKey::new(Some(dfvk), None).expect("`dfvk` should be `Some`"), | ||
| )]); | ||
|
|
||
| for (height, txids) in storage.sapling_results(key) { | ||
| let height = BlockHeight::from(height); | ||
|
|
||
| for txid in txids.iter() { | ||
| let tx = Transaction::read( | ||
| &hex::decode(&get_tx_via_rpc(txid.encode_hex())) | ||
| .expect("RPC response should be decodable from hex string to bytes")[..], | ||
| BranchId::for_height(&network, height), | ||
| ) | ||
| .expect("TX fetched via RPC should be deserializable from raw bytes"); | ||
|
|
||
| for output in decrypt_transaction(&network, height, &tx, &ufvk_with_acc_id) { | ||
| let memo = memo_bytes_to_string(output.memo.as_array()); | ||
|
|
||
| if !memo.is_empty() | ||
| // Filter out some uninteresting and repeating memos from ZECPages. | ||
| && !memo.contains("LIKE:") | ||
| && !memo.contains("VOTE:") | ||
| && memo != prev_memo | ||
| { | ||
| println!("{memo}\n"); | ||
| prev_memo = memo; | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Trims trailing zeroes from a memo, and returns the memo as a [`String`]. | ||
| fn memo_bytes_to_string(memo: &[u8; 512]) -> String { | ||
| match memo.iter().rposition(|&byte| byte != 0) { | ||
| Some(i) => String::from_utf8_lossy(&memo[..=i]).into_owned(), | ||
| None => "".to_owned(), | ||
| } | ||
| } | ||
|
|
||
| /// Uses the `getrawtransaction` RPC to retrieve a transaction by its TXID. | ||
| fn get_tx_via_rpc(txid: String) -> String { | ||
| // Wrap the TXID with `"` so that [`RawValue::from_string`] eats it. | ||
| let txid = format!("\"{}\"", txid); | ||
| let transport = SimpleHttpTransport::builder() | ||
| .url("127.0.0.1:8232") | ||
| .expect("URL should be valid") | ||
| .build(); | ||
| let client = Client::with_transport(transport); | ||
| let params = [RawValue::from_string(txid).expect("Provided TXID should be a valid JSON")]; | ||
| let request = client.build_request("getrawtransaction", ¶ms); | ||
| let response = client | ||
| .send_request(request) | ||
| .expect("Sending the `getrawtransaction` request should succeed"); | ||
|
|
||
| response | ||
| .result() | ||
| .expect("Zebra's RPC response should contain a valid result") | ||
| } |