zync-core 0.6.0

Trust-minimized Zcash light client primitives: verification, scanning, proving
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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

//! gRPC clients for Zcash light wallet services
//!
//! provides unified interface for both zidecar (our server) and lightwalletd (public fallback)

#[cfg(feature = "client")]
mod lightwalletd;
#[cfg(feature = "client")]
mod zidecar;

#[cfg(feature = "client")]
pub use lightwalletd::LightwalletdClient;
#[cfg(feature = "client")]
pub use zidecar::ZidecarClient;

// re-export endpoints from the non-gated module for backwards compat
pub use crate::endpoints::*;

/// generated protobuf types for zidecar
#[cfg(feature = "client")]
pub mod zidecar_proto {
    tonic::include_proto!("zidecar.v1");
}

/// generated protobuf types for lightwalletd
#[cfg(feature = "client")]
pub mod lightwalletd_proto {
    tonic::include_proto!("cash.z.wallet.sdk.rpc");
}

/// sync status from server
#[derive(Debug, Clone)]
pub struct SyncStatus {
    pub current_height: u32,
    pub current_epoch: u32,
    pub blocks_in_epoch: u32,
    pub complete_epochs: u32,
    pub epoch_proof_ready: bool,
    pub blocks_until_ready: u32,
    pub last_epoch_proof_height: u32,
}

/// tree state at a block height
#[derive(Debug, Clone)]
pub struct TreeState {
    pub height: u32,
    pub hash: Vec<u8>,
    pub time: u64,
    pub sapling_tree: String,
    pub orchard_tree: String,
}

/// transparent UTXO
#[derive(Debug, Clone)]
pub struct Utxo {
    pub address: String,
    pub txid: [u8; 32],
    pub output_index: u32,
    pub script: Vec<u8>,
    pub value_zat: u64,
    pub height: u32,
}

/// send transaction response
#[derive(Debug, Clone)]
pub struct SendResult {
    pub txid: String,
    pub error_code: i32,
    pub error_message: String,
}

impl SendResult {
    pub fn is_success(&self) -> bool {
        self.error_code == 0
    }
}

/// compact block for wallet scanning
#[derive(Debug, Clone)]
pub struct CompactBlock {
    pub height: u32,
    pub hash: Vec<u8>,
    pub actions: Vec<CompactAction>,
}

/// compact orchard action for trial decryption
#[derive(Debug, Clone)]
pub struct CompactAction {
    pub cmx: [u8; 32],
    pub ephemeral_key: [u8; 32],
    pub ciphertext: Vec<u8>,
    pub nullifier: [u8; 32],
}