Ecosystem/serai
Ecosystem/serai
1
0
Fork 0
mirror of https://github.com/serai-dex/serai.git synced 2024-12-22 11:39:35 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Clarify when wallet2 will decrypt payment IDs with citations

Browse source
This commit is contained in:
Luke Parker 2024-09-05 15:50:36 -04:00
parent 4e834873d3
commit efc7d70ab1
No known key found for this signature in database
1 changed files with 22 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
networks/monero/wallet/src/output.rs
View file

@ -301,12 +301,28 @@ impl WalletOutput {
/// The payment ID included with this output.
///
/// This field may be `Some` even if wallet2 would not return a payment ID. This will happen if
/// the scanned output belongs to the subaddress which spent Monero within the transaction which
/// created the output. If multiple subaddresses spent Monero within this transactions, the key
/// image with the highest index is determined to be the subaddress considered as the one
/// spending.
// TODO: Clarify and cite for point A ("highest index spent key image"??)
/// This field may be `Some` even if wallet2 would not return a payment ID. wallet2 will only
/// decrypt a payment ID if either:
///
/// A) The transaction wasn't made by the wallet (via checking if any key images are recognized)
/// B) For the highest-indexed input with a recognized key image, it spends an output with
/// subaddress account `(a, _)` which is distinct from this output's subaddress account
///
/// Neither of these cases are handled by `monero-wallet` as scanning doesn't have the context
/// of key images.
//
// Identification of the subaddress account for the highest-indexed input with a recognized key
// image:
// https://github.com/monero-project/monero/blob/a1dc85c5373a30f14aaf7dcfdd95f5a7375d3623
// /src/wallet/wallet2.cpp/#L2637-L2670
//
// Removal of 'transfers' received to this account:
// https://github.com/monero-project/monero/blob/a1dc85c5373a30f14aaf7dcfdd95f5a7375d3623
// /src/wallet/wallet2.cpp/#L2782-L2794
//
// Payment IDs only being decrypted for the remaining transfers:
// https://github.com/monero-project/monero/blob/a1dc85c5373a30f14aaf7dcfdd95f5a7375d3623
// /src/wallet/wallet2.cpp/#L2796-L2844
pub fn payment_id(&self) -> Option<PaymentId> {
self.metadata.payment_id
}