Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix unconfirmed change note tracking in transactions #10

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

fix unconfirmed change note tracking in transactions #10

Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6aa3917
add change output to unspent/received notes
borngraced Nov 19, 2024
d78f4df
comment out adding sapling_output
borngraced Nov 19, 2024
ced9107
use max_height for unmined transactions
borngraced Dec 5, 2024
c910d19
fix nit
borngraced Dec 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 49 additions & 4 deletions zcash_extras/src/wallet.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,23 +2,64 @@
use std::fmt::{Debug, Display};

use zcash_primitives::{
consensus::{self, BranchId},
consensus::{self, BranchId, NetworkUpgrade},

Check warning on line 5 in zcash_extras/src/wallet.rs

View workflow job for this annotation

GitHub Actions / Clippy (nightly)

unused import: `NetworkUpgrade` 

warning: unused import: `NetworkUpgrade`
 --> zcash_extras/src/wallet.rs:5:33
  |
5 |     consensus::{self, BranchId, NetworkUpgrade},
  |                                 ^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default

Check warning on line 5 in zcash_extras/src/wallet.rs

View workflow job for this annotation

GitHub Actions / Clippy (nightly)

unused import: `NetworkUpgrade` 

warning: unused import: `NetworkUpgrade`
 --> zcash_extras/src/wallet.rs:5:33
  |
5 |     consensus::{self, BranchId, NetworkUpgrade},
  |                                 ^^^^^^^^^^^^^^
  |
  = note: `#[warn(unused_imports)]` on by default
memo::MemoBytes,
sapling::prover::TxProver,
transaction::{
builder::Builder,
components::{amount::DEFAULT_FEE, Amount},
Transaction,
},
zip32::{ExtendedFullViewingKey, ExtendedSpendingKey},
};

use crate::WalletWrite;
use zcash_client_backend::{
address::RecipientAddress,
data_api::{error::Error, SentTransaction},
data_api::{error::Error, ReceivedTransaction, SentTransaction},
decrypt_transaction,
wallet::{AccountId, OvkPolicy},
};

/// Scans a [`Transaction`] for any information that can be decrypted by the accounts in
/// the wallet, and saves it to the wallet.
pub async fn decrypt_and_store_transaction<N, E, P, D>(
params: &P,
data: &mut D,
tx: &Transaction,
) -> Result<(), E>
where
E: From<Error<N>>,
P: consensus::Parameters,
D: WalletWrite<Error = E>,
{
// Fetch the ExtendedFullViewingKeys we are tracking
let extfvks = data.get_extended_full_viewing_keys().await?;

let max_height = data
.block_height_extrema()
.await?
.map(|(_, max)| max + 1)
.ok_or(Error::ScanRequired)?;
let height = data
.get_tx_height(tx.txid())
.await?
.unwrap_or_else(|| max_height);

Check warning on line 47 in zcash_extras/src/wallet.rs

View workflow job for this annotation

GitHub Actions / Clippy (nightly)

unnecessary closure used to substitute value for `Option::None` 

warning: unnecessary closure used to substitute value for `Option::None`
  --> zcash_extras/src/wallet.rs:44:18
   |
44 |       let height = data
   |  __________________^
45 | |         .get_tx_height(tx.txid())
46 | |         .await?
47 | |         .unwrap_or_else(|| max_height);
   | |______________________________________^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_lazy_evaluations
   = note: `-W clippy::unnecessary-lazy-evaluations` implied by `-W clippy::all`
   = help: to override `-W clippy::all` add `#[allow(clippy::unnecessary_lazy_evaluations)]`
help: use `unwrap_or` instead
   |
47 |         .unwrap_or(max_height);
   |          ~~~~~~~~~~~~~~~~~~~~~

Check warning on line 47 in zcash_extras/src/wallet.rs

View workflow job for this annotation

GitHub Actions / Clippy (nightly)

unnecessary closure used to substitute value for `Option::None` 

warning: unnecessary closure used to substitute value for `Option::None`
  --> zcash_extras/src/wallet.rs:44:18
   |
44 |       let height = data
   |  __________________^
45 | |         .get_tx_height(tx.txid())
46 | |         .await?
47 | |         .unwrap_or_else(|| max_height);
   | |______________________________________^
   |
   = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#unnecessary_lazy_evaluations
   = note: `-W clippy::unnecessary-lazy-evaluations` implied by `-W clippy::all`
   = help: to override `-W clippy::all` add `#[allow(clippy::unnecessary_lazy_evaluations)]`
help: use `unwrap_or` instead
   |
47 |         .unwrap_or(max_height);
   |          ~~~~~~~~~~~~~~~~~~~~~
shamardy marked this conversation as resolved.
Show resolved Hide resolved

let outputs = decrypt_transaction(params, height, tx, &extfvks);
if outputs.is_empty() {
Ok(())
} else {
data.store_received_tx(&ReceivedTransaction {
tx,
outputs: &outputs,
})
.await?;

Ok(())
}
}

#[allow(clippy::needless_doctest_main)]
/// Creates a transaction paying the specified address from the given account.
///
Expand Down Expand Up @@ -182,8 +223,7 @@
RecipientAddress::Shielded(to) => {
builder.add_sapling_output(ovk, to.clone(), value, memo.clone())
}

RecipientAddress::Transparent(to) => builder.add_transparent_output(&to, value),
RecipientAddress::Transparent(to) => builder.add_transparent_output(to, value),
}
.map_err(Error::Builder)?;

Expand All @@ -209,6 +249,11 @@
}
};

// Automatically decrypt and store any outputs sent to our wallet, including change.
// This uses our viewing keys to find any outputs we can decrypt, creates decrypted
// note data for spendability, and saves them to the wallet database.
decrypt_and_store_transaction(params, wallet_db, &tx).await?;
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Without this code we would need to wait until the block is scanned, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

with the case above, we need this fix in kdf directly after building txs..


wallet_db
.store_sent_tx(&SentTransaction {
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like this store_sent_tx call stores the created transaction output in the walletdb.
Wouldn't the decrypt_and_store_transaction call do a similar thing?

Copy link
Member Author

@borngraced borngraced Nov 20, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

store_sent_tx - stores notes we created to send value to others, while decrypt_and_store_transaction calls store_received_tx(stores notes we can spend) internally

librustzcash/zcash_extras/src/wallet.rs

Lines 24 to 60 in d78f4df

/// Scans a [`Transaction`] for any information that can be decrypted by the accounts in
/// the wallet, and saves it to the wallet.
pub async fn decrypt_and_store_transaction<N, E, P, D>(
params: &P,
data: &mut D,
tx: &Transaction,
) -> Result<(), E>
where
E: From<Error<N>>,
P: consensus::Parameters,
D: WalletWrite<Error = E>,
{
// Fetch the ExtendedFullViewingKeys we are tracking
let extfvks = data.get_extended_full_viewing_keys().await?;
let max_height = data.block_height_extrema().await?.map(|(_, max)| max + 1);
let height = data
.get_tx_height(tx.txid())
.await?
.or(max_height)
.or_else(|| params.activation_height(NetworkUpgrade::Sapling))
.ok_or(Error::SaplingNotActive)?;
let outputs = decrypt_transaction(params, height, tx, &extfvks);
if outputs.is_empty() {
Ok(())
} else {
data.store_received_tx(&ReceivedTransaction {
tx,
outputs: &outputs,
})
.await?;
Ok(())
}
}

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Aha, we need to add the change as a received output, to fix the balance

tx: &tx,
Expand Down
Loading