zakura-client-sqlite 0.1.0-rc0

An SQLite-based Zcash light client
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71

//! This migration adds the note-locking columns to the received note/output tables. The
//! `lock_expiry_height` column supports height-based note locking during proposal creation, and
//! the `lock_owner` column records the flow that acquired a lock, so that unlocking is scoped to
//! the owner and re-locking by the same owner is idempotent.
use std::collections::HashSet;

use schemerz_rusqlite::RusqliteMigration;
use uuid::Uuid;

use crate::wallet::init::{WalletMigrationError, migrations::ironwood_received_notes};

/// This migration adds the note-locking columns to the received note/output tables.
pub const MIGRATION_ID: Uuid = Uuid::from_u128(0xa1d4a28c_7582_4457_b0f4_d3f297b62a71);

// This migration only appends a nullable column to each of the `sapling_received_notes`,
// `orchard_received_notes`, `ironwood_received_notes`, and `transparent_received_outputs`
// tables, so it need only run after the last migration that establishes the schema of those
// tables. `ironwood_received_notes` is that migration: it transitively depends on every
// migration that creates or rebuilds any of the four tables (the sapling/orchard/transparent
// rebuilds all precede it via `orchard_note_version` -> `witness_stabilized_notes` ->
// `account_delete_cascade`), and it creates the `ironwood_received_notes` table itself.
const DEPENDENCIES: &[Uuid] = &[ironwood_received_notes::MIGRATION_ID];

pub(super) struct Migration;

impl schemerz::Migration<Uuid> for Migration {
    fn id(&self) -> Uuid {
        MIGRATION_ID
    }

    fn dependencies(&self) -> HashSet<Uuid> {
        DEPENDENCIES.iter().copied().collect()
    }

    fn description(&self) -> &'static str {
        "Adds lock_expiry_height and lock_owner columns to received note tables for note locking."
    }
}

impl RusqliteMigration for Migration {
    type Error = WalletMigrationError;

    fn up(&self, conn: &rusqlite::Transaction) -> Result<(), Self::Error> {
        conn.execute_batch(
            "ALTER TABLE sapling_received_notes ADD COLUMN lock_expiry_height INTEGER;
             ALTER TABLE orchard_received_notes ADD COLUMN lock_expiry_height INTEGER;
             ALTER TABLE ironwood_received_notes ADD COLUMN lock_expiry_height INTEGER;
             ALTER TABLE transparent_received_outputs ADD COLUMN lock_expiry_height INTEGER;
             ALTER TABLE sapling_received_notes ADD COLUMN lock_owner BLOB;
             ALTER TABLE orchard_received_notes ADD COLUMN lock_owner BLOB;
             ALTER TABLE ironwood_received_notes ADD COLUMN lock_owner BLOB;
             ALTER TABLE transparent_received_outputs ADD COLUMN lock_owner BLOB;",
        )?;

        Ok(())
    }

    fn down(&self, _transaction: &rusqlite::Transaction) -> Result<(), Self::Error> {
        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]);
    }
}