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

Merge pull request #1511 from zcash/sqlite_legacy_support 

Support older sqlite versions.
This commit is contained in:
Kris Nuttycombe 2024-09-03 13:25:40 -06:00 committed by GitHub
parent 50cdf73dfd f063e7ab7e
commit db065805e1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
8 changed files with 168 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Cargo.lock generated
View File

@ -5877,7 +5877,7 @@ dependencies = [
[[package]]
name = "zcash_client_sqlite"
version = "0.11.1"
version = "0.11.2"
dependencies = [
"assert_matches",
"bip32",

4
supply-chain/imports.lock
View File

@ -238,8 +238,8 @@ user-login = "nuttycom"
user-name = "Kris Nuttycombe"
[[publisher.zcash_client_sqlite]]
version = "0.11.1"
when = "2024-08-21"
version = "0.11.2"
when = "2024-09-03"
user-id = 169181
user-login = "nuttycom"
user-name = "Kris Nuttycombe"

21
zcash_client_sqlite/CHANGELOG.md
View File

@ -7,6 +7,19 @@ and this library adheres to Rust's notion of
## [Unreleased]
## [0.11.2] - 2024-08-21
### Changed
- The `v_tx_outputs` view was modified slightly to support older versions of
`sqlite`. Queries to the exposed `v_tx_outputs` and `v_transactions` views
are supported for SQLite versions back to `3.19.x`.
- `zcash_client_sqlite::wallet::init::WalletMigrationError` has an additional
variant, `DatabaseNotSupported`. The `init_wallet_db` function now checks
that the sqlite version in use is compatible with the features required by
the wallet and returns this error if not. SQLite version `3.35` or higher
is required for use with `zcash_client_sqlite`.
## [0.11.1] - 2024-08-21
### Fixed
@ -18,7 +31,7 @@ and this library adheres to Rust's notion of
`zcash_client_sqlite` now provides capabilities for the management of ephemeral
transparent addresses in support of the creation of ZIP 320 transaction pairs.
In addition, `zcash_client_sqlite` now provides improved tracking of transparent
In addition, `zcash_client_sqlite` now provides improved tracking of transparent
wallet history in support of the API changes in `zcash_client_backend 0.13`,
and the `v_transactions` view has been modified to provide additional metadata
about the relationship of each transaction to the wallet, in particular whether
@ -65,11 +78,11 @@ or not the transaction represents a wallet-internal shielding operation.
## [0.10.1] - 2024-03-25
### Fixed
- The `sent_notes` table's `received_note` constraint was excessively restrictive
after zcash/librustzcash#1306. Any databases that have migrations from
- The `sent_notes` table's `received_note` constraint was excessively restrictive
after zcash/librustzcash#1306. Any databases that have migrations from
zcash_client_sqlite 0.10.0 applied should be wiped and restored from seed.
In order to ensure that the incorrect migration is not used, the migration
id for the `full_account_ids` migration has been changed from
id for the `full_account_ids` migration has been changed from
`0x1b104345_f27e_42da_a9e3_1de22694da43` to `0x6d02ec76_8720_4cc6_b646_c4e2ce69221c`
## [0.10.0] - 2024-03-25

4
zcash_client_sqlite/Cargo.toml
View File

@ -1,7 +1,7 @@
[package]
name = "zcash_client_sqlite"
description = "An SQLite-based Zcash light client"
version = "0.11.1"
version = "0.11.2"
authors = [
"Jack Grigg <jack@z.cash>",
"Kris Nuttycombe <kris@electriccoin.co>"
@ -71,6 +71,7 @@ schemer.workspace = true
schemer-rusqlite.workspace = true
time.workspace = true
uuid.workspace = true
regex = "1.4"
# Dependencies used internally:
# (Breaking upgrades to these are usually backwards-compatible, but check MSRVs.)
@ -87,7 +88,6 @@ orchard = { workspace = true, features = ["test-dependencies"] }
proptest.workspace = true
rand_chacha.workspace = true
rand_core.workspace = true
regex = "1.4"
tempfile = "3.5.0"
zcash_keys = { workspace = true, features = ["test-dependencies"] }
zcash_note_encryption.workspace = true

2
zcash_client_sqlite/src/wallet/db.rs
View File

@ -883,7 +883,7 @@ SELECT transactions.txid AS txid,
NULL AS to_account_id,
sent_notes.to_address AS to_address,
sent_notes.value AS value,
FALSE AS is_change,
0 AS is_change,
sent_notes.memo AS memo
FROM sent_notes
JOIN transactions

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

@ -3,6 +3,7 @@
use std::fmt;
use std::rc::Rc;
use regex::Regex;
use schemer::{Migrator, MigratorError};
use schemer_rusqlite::RusqliteAdapter;
use secrecy::SecretVec;
@ -20,8 +21,15 @@ use crate::{error::SqliteClientError, WalletDb};
mod migrations;
const SQLITE_MAJOR_VERSION: u32 = 3;
const MIN_SQLITE_MINOR_VERSION: u32 = 35;
#[derive(Debug)]
pub enum WalletMigrationError {
/// A feature required by the wallet database is not supported by the version of
/// SQLite that the migration is running against.
DatabaseNotSupported(String),
/// The seed is required for the migration.
SeedRequired,
@ -100,6 +108,13 @@ impl From<SqliteClientError> for WalletMigrationError {
impl fmt::Display for WalletMigrationError {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
match &self {
WalletMigrationError::DatabaseNotSupported(version) => {
write!(
f,
"The installed SQLite version {} does not support operations required by the wallet.",
version
)
}
WalletMigrationError::SeedRequired => {
write!(
f,
@ -305,6 +320,8 @@ fn init_wallet_db_internal<P: consensus::Parameters + 'static>(
) -> Result<(), MigratorError<WalletMigrationError>> {
let seed = seed.map(Rc::new);
verify_sqlite_version_compatibility(&wdb.conn).map_err(MigratorError::Adapter)?;
// Turn off foreign key enforcement, to ensure that table replacement does not break foreign
// key references in table definitions.
//
@ -357,6 +374,40 @@ fn init_wallet_db_internal<P: consensus::Parameters + 'static>(
Ok(())
}
/// Verify that the sqlite version in use supports the features required by this library.
/// Note that the version of sqlite available to the database backend may be different
/// from what is used to query the views that are part of the public API.
fn verify_sqlite_version_compatibility(
conn: &rusqlite::Connection,
) -> Result<(), WalletMigrationError> {
let sqlite_version =
conn.query_row("SELECT sqlite_version()", [], |row| row.get::<_, String>(0))?;
let version_re = Regex::new(r"^(?<major>[0-9]+)\.(?<minor>[0-9]+).*$").unwrap();
let captures =
version_re
.captures(&sqlite_version)
.ok_or(WalletMigrationError::DatabaseNotSupported(
"Unknown".to_owned(),
))?;
let parse_version_part = |part: &str| {
captures[part].parse::<u32>().map_err(|_| {
WalletMigrationError::CorruptedData(format!(
"Cannot decode SQLite {} version component {}",
part, &captures[part]
))
})
};
let major = parse_version_part("major")?;
let minor = parse_version_part("minor")?;
if major != SQLITE_MAJOR_VERSION || minor < MIN_SQLITE_MINOR_VERSION {
Err(WalletMigrationError::DatabaseNotSupported(sqlite_version))
} else {
Ok(())
}
}
#[cfg(test)]
#[allow(deprecated)]
mod tests {

4
zcash_client_sqlite/src/wallet/init/migrations.rs
View File

@ -15,6 +15,7 @@ mod sapling_memo_consistency;
mod sent_notes_to_internal;
mod shardtree_support;
mod spend_key_available;
mod support_legacy_sqlite;
mod tx_retrieval_queue;
mod ufvk_support;
mod utxos_table;
@ -74,6 +75,8 @@ pub(super) fn all_migrations<P: consensus::Parameters + 'static>(
// \ \ ephemeral_addresses / /
// \ \ | / /
// ------------------------------ tx_retrieval_queue ----------------------------
// |
// support_legacy_sqlite
vec![
Box::new(initial_setup::Migration {}),
Box::new(utxos_table::Migration {}),
@ -131,6 +134,7 @@ pub(super) fn all_migrations<P: consensus::Parameters + 'static>(
Box::new(tx_retrieval_queue::Migration {
params: params.clone(),
}),
Box::new(support_legacy_sqlite::Migration),
]
}

90
zcash_client_sqlite/src/wallet/init/migrations/support_legacy_sqlite.rs Normal file
View File

@ -0,0 +1,90 @@
//! Modifies definitions to avoid keywords that may not be available in older SQLite versions.
use std::collections::HashSet;
use rusqlite;
use schemer;
use schemer_rusqlite::RusqliteMigration;
use uuid::Uuid;
use crate::wallet::init::{migrations::tx_retrieval_queue, WalletMigrationError};
pub(super) const MIGRATION_ID: Uuid = Uuid::from_u128(0x156d8c8f_2173_4b59_89b6_75697d5a2103);
const DEPENDENCIES: &[Uuid] = &[tx_retrieval_queue::MIGRATION_ID];
pub(super) struct Migration;
impl schemer::Migration for Migration {
fn id(&self) -> Uuid {
MIGRATION_ID
}
fn dependencies(&self) -> HashSet<Uuid> {
DEPENDENCIES.iter().copied().collect()
}
fn description(&self) -> &'static str {
"Modifies definitions to avoid keywords that may not be available in older SQLite versions."
}
}
impl RusqliteMigration for Migration {
type Error = WalletMigrationError;
fn up(&self, transaction: &rusqlite::Transaction) -> Result<(), WalletMigrationError> {
transaction.execute_batch(
r#"
DROP VIEW v_tx_outputs;
CREATE VIEW v_tx_outputs AS
-- select all outputs received by the wallet
SELECT transactions.txid AS txid,
ro.pool AS output_pool,
ro.output_index AS output_index,
sent_notes.from_account_id AS from_account_id,
ro.account_id AS to_account_id,
NULL AS to_address,
ro.value AS value,
ro.is_change AS is_change,
ro.memo AS memo
FROM v_received_outputs ro
JOIN transactions
ON transactions.id_tx = ro.transaction_id
-- join to the sent_notes table to obtain `from_account_id`
LEFT JOIN sent_notes ON sent_notes.id = ro.sent_note_id
UNION
-- select all outputs sent from the wallet to external recipients
SELECT transactions.txid AS txid,
sent_notes.output_pool AS output_pool,
sent_notes.output_index AS output_index,
sent_notes.from_account_id AS from_account_id,
NULL AS to_account_id,
sent_notes.to_address AS to_address,
sent_notes.value AS value,
0 AS is_change,
sent_notes.memo AS memo
FROM sent_notes
JOIN transactions
ON transactions.id_tx = sent_notes.tx
LEFT JOIN v_received_outputs ro ON ro.sent_note_id = sent_notes.id
-- exclude any sent notes for which a row exists in the v_received_outputs view
WHERE ro.account_id IS NULL
"#,
)?;
Ok(())
}
fn down(&self, _: &rusqlite::Transaction) -> Result<(), WalletMigrationError> {
Err(WalletMigrationError::CannotRevert(MIGRATION_ID))
}
}
#[cfg(test)]
mod tests {
use crate::wallet::init::migrations::tests::test_migrate;
#[test]
fn migrate() {
test_migrate(&[super::MIGRATION_ID]);
}
}