zec
/
librustzcash
mirror of https://github.com/zcash/librustzcash.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

zcash_client_sqlite: Ensure that re-adding the same checkpoint information does not cause a database conflict. 

The `add_checkpoint` method is intended to be idempotent. In the case
that we add a checkpoint at an already-checkpointed block height, we
should only raise an error in the case that the note commitment tree
position or the set of notes spent in the checkpointed block has
changed.
This commit is contained in:
Kris Nuttycombe 2023-08-03 11:19:40 -06:00
parent 0ee45e40c4
commit 027b3c9af8
6 changed files with 133 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
zcash_client_sqlite/CHANGELOG.md
View File

@ -12,6 +12,8 @@ and this library adheres to Rust's notion of
- A new default-enabled feature flag `multicore`. This allows users to disable
multicore support by setting `default_features = false` on their
`zcash_primitives`, `zcash_proofs`, and `zcash_client_sqlite` dependencies.
- `zcash_client_sqlite::wallet::commitment_tree` A new module containing a
sqlite-backed implementation of `shardtree::store::ShardStore`.
### Changed
- MSRV is now 1.65.0.

4
zcash_client_sqlite/src/lib.rs
View File

@ -38,7 +38,7 @@ use maybe_rayon::{
};
use rusqlite::{self, Connection};
use secrecy::{ExposeSecret, SecretVec};
use std::{borrow::Borrow, collections::HashMap, convert::AsRef, fmt, io, ops::Range, path::Path};
use std::{borrow::Borrow, collections::HashMap, convert::AsRef, fmt, ops::Range, path::Path};
use incrementalmerkletree::Position;
use shardtree::{error::ShardTreeError, ShardTree};
@ -76,8 +76,8 @@ use crate::{error::SqliteClientError, wallet::commitment_tree::SqliteShardStore}
#[cfg(feature = "unstable")]
use {
crate::chain::{fsblockdb_with_blocks, BlockMeta},
std::fs,
std::path::PathBuf,
std::{fs, io},
};
pub mod chain;

2
zcash_client_sqlite/src/wallet.rs
View File

@ -111,7 +111,7 @@ use {
},
};
pub(crate) mod commitment_tree;
pub mod commitment_tree;
pub mod init;
pub(crate) mod sapling;
pub(crate) mod scanning;

170
zcash_client_sqlite/src/wallet/commitment_tree.rs
View File

@ -26,6 +26,15 @@ pub enum Error {
Serialization(io::Error),
/// Errors encountered querying stored shard data
Query(rusqlite::Error),
/// Raised when the caller attempts to add a checkpoint at a block height where a checkpoint
/// already exists, but the tree state being checkpointed or the marks removed at that
/// checkpoint conflict with the existing tree state.
CheckpointConflict {
checkpoint_id: BlockHeight,
checkpoint: Checkpoint,
extant_tree_state: TreeState,
extant_marks_removed: Option<BTreeSet<Position>>,
},
}
impl fmt::Display for Error {
@ -33,6 +42,18 @@ impl fmt::Display for Error {
match &self {
Error::Serialization(err) => write!(f, "Commitment tree serializtion error: {}", err),
Error::Query(err) => write!(f, "Commitment tree query or update error: {}", err),
Error::CheckpointConflict {
checkpoint_id,
checkpoint,
extant_tree_state,
extant_marks_removed,
} => {
write!(
f,
"Conflict at checkpoint id {}, tried to insert {:?}, which is incompatible with existing state ({:?}, {:?})",
checkpoint_id, checkpoint, extant_tree_state, extant_marks_removed
)
}
}
}
}
@ -42,6 +63,7 @@ impl error::Error for Error {
match &self {
Error::Serialization(e) => Some(e),
Error::Query(e) => Some(e),
Error::CheckpointConflict { .. } => None,
}
}
}
@ -508,39 +530,89 @@ pub(crate) fn add_checkpoint(
checkpoint_id: BlockHeight,
checkpoint: Checkpoint,
) -> Result<(), Error> {
let mut stmt_insert_checkpoint = conn
.prepare_cached(&format!(
"INSERT INTO {}_tree_checkpoints (checkpoint_id, position)
VALUES (:checkpoint_id, :position)",
table_prefix
))
let extant_tree_state = conn
.query_row(
&format!(
"SELECT position FROM {}_tree_checkpoints WHERE checkpoint_id = :checkpoint_id",
table_prefix
),
named_params![":checkpoint_id": u32::from(checkpoint_id),],
|row| {
row.get::<_, Option<u64>>(0).map(|opt| {
opt.map_or_else(
|| TreeState::Empty,
|pos| TreeState::AtPosition(Position::from(pos)),
)
})
},
)
.optional()
.map_err(Error::Query)?;
stmt_insert_checkpoint
.execute(named_params![
":checkpoint_id": u32::from(checkpoint_id),
":position": checkpoint.position().map(u64::from)
])
.map_err(Error::Query)?;
match extant_tree_state {
Some(current) => {
if current != checkpoint.tree_state() {
// If the checkpoint position for a given checkpoint identifier has changed, we treat
// this as an error because the wallet should have detected a chain reorg and truncated
// the tree.
Err(Error::CheckpointConflict {
checkpoint_id,
checkpoint,
extant_tree_state: current,
extant_marks_removed: None,
})
} else {
// if the existing spends are the same, we can skip the insert; if the
// existing spends have changed, this is also a conflict.
let marks_removed = get_marks_removed(conn, table_prefix, checkpoint_id)?;
if &marks_removed == checkpoint.marks_removed() {
Ok(())
} else {
Err(Error::CheckpointConflict {
checkpoint_id,
checkpoint,
extant_tree_state: current,
extant_marks_removed: Some(marks_removed),
})
}
}
}
None => {
let mut stmt_insert_checkpoint = conn
.prepare_cached(&format!(
"INSERT INTO {}_tree_checkpoints (checkpoint_id, position)
VALUES (:checkpoint_id, :position)",
table_prefix
))
.map_err(Error::Query)?;
let mut stmt_insert_mark_removed = conn
.prepare_cached(&format!(
"INSERT INTO {}_tree_checkpoint_marks_removed (checkpoint_id, mark_removed_position)
VALUES (:checkpoint_id, :position)",
table_prefix
))
.map_err(Error::Query)?;
stmt_insert_checkpoint
.execute(named_params![
":checkpoint_id": u32::from(checkpoint_id),
":position": checkpoint.position().map(u64::from)
])
.map_err(Error::Query)?;
for pos in checkpoint.marks_removed() {
stmt_insert_mark_removed
.execute(named_params![
":checkpoint_id": u32::from(checkpoint_id),
":position": u64::from(*pos)
])
.map_err(Error::Query)?;
let mut stmt_insert_mark_removed = conn
.prepare_cached(&format!(
"INSERT INTO {}_tree_checkpoint_marks_removed (checkpoint_id, mark_removed_position)
VALUES (:checkpoint_id, :position)",
table_prefix
))
.map_err(Error::Query)?;
for pos in checkpoint.marks_removed() {
stmt_insert_mark_removed
.execute(named_params![
":checkpoint_id": u32::from(checkpoint_id),
":position": u64::from(*pos)
])
.map_err(Error::Query)?;
}
Ok(())
}
}
Ok(())
}
pub(crate) fn checkpoint_count(
@ -555,6 +627,29 @@ pub(crate) fn checkpoint_count(
.map_err(Error::Query)
}
fn get_marks_removed(
conn: &rusqlite::Connection,
table_prefix: &'static str,
checkpoint_id: BlockHeight,
) -> Result<BTreeSet<Position>, Error> {
let mut stmt = conn
.prepare_cached(&format!(
"SELECT mark_removed_position
FROM {}_tree_checkpoint_marks_removed
WHERE checkpoint_id = ?",
table_prefix
))
.map_err(Error::Query)?;
let mark_removed_rows = stmt
.query([u32::from(checkpoint_id)])
.map_err(Error::Query)?;
mark_removed_rows
.mapped(|row| row.get::<_, u64>(0).map(Position::from))
.collect::<Result<BTreeSet<_>, _>>()
.map_err(Error::Query)
}
pub(crate) fn get_checkpoint(
conn: &rusqlite::Connection,
table_prefix: &'static str,
@ -579,26 +674,9 @@ pub(crate) fn get_checkpoint(
checkpoint_position
.map(|pos_opt| {
let mut stmt = conn
.prepare_cached(&format!(
"SELECT mark_removed_position
FROM {}_tree_checkpoint_marks_removed
WHERE checkpoint_id = ?",
table_prefix
))
.map_err(Error::Query)?;
let mark_removed_rows = stmt
.query([u32::from(checkpoint_id)])
.map_err(Error::Query)?;
let marks_removed = mark_removed_rows
.mapped(|row| row.get::<_, u64>(0).map(Position::from))
.collect::<Result<BTreeSet<_>, _>>()
.map_err(Error::Query)?;
Ok(Checkpoint::from_parts(
pos_opt.map_or(TreeState::Empty, TreeState::AtPosition),
marks_removed,
get_marks_removed(conn, table_prefix, checkpoint_id)?,
))
})
.transpose()

3
zcash_client_sqlite/src/wallet/init.rs
View File

@ -454,7 +454,8 @@ mod tests {
checkpoint_id INTEGER NOT NULL,
mark_removed_position INTEGER NOT NULL,
FOREIGN KEY (checkpoint_id) REFERENCES sapling_tree_checkpoints(checkpoint_id)
ON DELETE CASCADE
ON DELETE CASCADE,
CONSTRAINT spend_position_unique UNIQUE (checkpoint_id, mark_removed_position)
)",
"CREATE TABLE sapling_tree_checkpoints (
checkpoint_id INTEGER PRIMARY KEY,

3
zcash_client_sqlite/src/wallet/init/migrations/shardtree_support.rs
View File

@ -99,7 +99,8 @@ impl RusqliteMigration for Migration {
checkpoint_id INTEGER NOT NULL,
mark_removed_position INTEGER NOT NULL,
FOREIGN KEY (checkpoint_id) REFERENCES sapling_tree_checkpoints(checkpoint_id)
ON DELETE CASCADE
ON DELETE CASCADE,
CONSTRAINT spend_position_unique UNIQUE (checkpoint_id, mark_removed_position)
);",
)?;