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 2 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
51 changes: 47 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,62 @@
use std::fmt::{Debug, Display};

use zcash_primitives::{
consensus::{self, BranchId},
consensus::{self, BranchId, NetworkUpgrade},
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);
let height = data
.get_tx_height(tx.txid())
.await?
.or(max_height)
Copy link

Choose a reason for hiding this comment

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

For unconfirmed transactions which this PR is for, will using the max height cause problems in decrypt_transaction? get_tx_height will return nothing as it's not in db so max height will be used.

Copy link
Member Author

@borngraced borngraced Dec 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

So using max_height would only cause issues during the Canopy network upgrade window and we're way past the Canopy grace period (ended late 2020) and all new transactions now uses 0x02 note version

librustzcash/zcash_primitives/src/sapling/note_encryption.rs

Lines 322 to 338 in e92443a

if params.is_nu_active(Canopy, height) {
let grace_period_end_height =
params.activation_height(Canopy).unwrap() + ZIP212_GRACE_PERIOD;
if height < grace_period_end_height && leadbyte != 0x01 && leadbyte != 0x02 {
// non-{0x01,0x02} received after Canopy activation and before grace period has elapsed
false
} else if height >= grace_period_end_height && leadbyte != 0x02 {
// non-0x02 received past (Canopy activation height + grace period)
false
} else {
true
}
} else {
// return false if non-0x01 received when Canopy is not active
leadbyte == 0x01
}

Copy link

Choose a reason for hiding this comment

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

As discussed in DM, it makes sense to use the max height since it's the next anticipated block which we wish the transaction to be in. We should remove this though

librustzcash/zcash_extras/src/wallet.rs

Lines 44 to 45 in 6aa3917

.or_else(|| params.activation_height(NetworkUpgrade::Sapling))
.ok_or(Error::SaplingNotActive)?;
and use unwrap_or_else instead of map here

librustzcash/zcash_extras/src/wallet.rs

Line 39 in 6aa3917

let max_height = data.block_height_extrema().await?.map(|(_, max)| max + 1);

Copy link
Member Author

Choose a reason for hiding this comment

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

We should remove this though

Why? I mean height will be optional which isn't what we want.

Copy link

Choose a reason for hiding this comment

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

That's why I suggested to use unwrap_or_else, we use max height when it's none not NetworkUpgrade::Sapling. We should return an error if we can't get block_height_extrema, what do you think?

Copy link
Member Author

@borngraced borngraced Dec 5, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

ok that makes sense..we assume block_height_extrema shouldn't return an error except some internal error with db or syncing so it make sense to return an error

Copy link

Choose a reason for hiding this comment

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

So using max_height would only cause issues during the Canopy network upgrade window

AFAIK we do not support zcash privacy transactions (yet), right?
Only supporting PIRATE which is still on Sapling.

Copy link
Member Author

@borngraced borngraced Dec 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

Yep.. you mean shielded transactions.

.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(())
}
}

#[allow(clippy::needless_doctest_main)]
/// Creates a transaction paying the specified address from the given account.
///
Expand Down Expand Up @@ -182,8 +221,7 @@ where
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 +247,11 @@ where
}
};

// 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