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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
//! If a note is confirmed, it is:
//! Confirmed === on-record on-chain at `BlockHeight`
use std::io::{Read, Write};
use byteorder::{LittleEndian, ReadBytesExt, WriteBytesExt};
use zcash_primitives::consensus::BlockHeight;
/// Transaction confirmation states. Every transaction record includes exactly one of these variants.
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
pub enum ConfirmationStatus {
/// The transaction has been included in at-least one block mined to the zcash blockchain.
/// The height of a confirmed block that contains the transaction.
Confirmed(BlockHeight),
/// The transaction is known to be or have been in the mempool.
/// The `BlockHeight` is the 1 + the height of the chain as the transaction entered the mempool, i.e. the target height.
Mempool(BlockHeight),
/// The transaction has been sent to the zcash blockchain. It could be in the mempool.
/// The `BlockHeight` is the 1 + the height of the chain as the transaction was broadcast, i.e. the target height.
Transmitted(BlockHeight),
/// The transaction has been calculated but not yet broadcast to the chain.
/// The `BlockHeight` is the 1 + the height of the chain as the transaction was broadcast, i.e. the target height.
Calculated(BlockHeight),
}
impl ConfirmationStatus {
/// Converts from a blockheight and `pending`. pending is deprecated and is only needed in loading from save.
#[must_use]
pub fn from_blockheight_and_pending_bool(blockheight: BlockHeight, pending: bool) -> Self {
if pending {
Self::Transmitted(blockheight)
} else {
Self::Confirmed(blockheight)
}
}
/// A wrapper matching the Confirmed case.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed());
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed());
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed());
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed());
/// ```
#[must_use]
pub fn is_confirmed(&self) -> bool {
matches!(self, Self::Confirmed(_))
}
/// To return true, the status must be confirmed and no earlier than specified height.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_after_or_at(&9.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_after_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_after_or_at(&11.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_after_or_at(&9.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_after_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_after_or_at(&11.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_after_or_at(&9.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_after_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_after_or_at(&11.into()));
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed_after_or_at(&9.into()));
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed_after_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_confirmed_after_or_at(&11.into()));
/// ```
#[must_use]
pub fn is_confirmed_after_or_at(&self, comparison_height: &BlockHeight) -> bool {
matches!(self, Self::Confirmed(self_height) if self_height >= comparison_height)
}
/// To return true, the status must be confirmed and no earlier than specified height.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_after(&9.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_after(&10.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_after(&11.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_after(&9.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_after(&10.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_after(&11.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_after(&9.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_after(&10.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_after(&11.into()));
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed_after(&9.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_confirmed_after(&10.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_confirmed_after(&11.into()));
/// ```
#[must_use]
pub fn is_confirmed_after(&self, comparison_height: &BlockHeight) -> bool {
matches!(self, Self::Confirmed(self_height) if self_height > comparison_height)
}
/// To return true, the status must be confirmed and no later than specified height.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_before_or_at(&9.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_before_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_before_or_at(&11.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_before_or_at(&9.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_before_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_before_or_at(&11.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_before_or_at(&9.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_before_or_at(&10.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_before_or_at(&11.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_confirmed_before_or_at(&9.into()));
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed_before_or_at(&10.into()));
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed_before_or_at(&11.into()));
/// ```
// TODO: blockheight impls copy so remove ref
#[must_use]
pub fn is_confirmed_before_or_at(&self, comparison_height: &BlockHeight) -> bool {
matches!(self, Self::Confirmed(self_height) if self_height <= comparison_height)
}
/// To return true, the status must be confirmed earlier than specified height.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_before(&9.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_before(&10.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_confirmed_before(&11.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_before(&9.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_before(&10.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_confirmed_before(&11.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_before(&9.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_before(&10.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_confirmed_before(&11.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_confirmed_before(&9.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_confirmed_before(&10.into()));
/// assert!(ConfirmationStatus::Confirmed(10.into()).is_confirmed_before(&11.into()));
/// ```
#[must_use]
pub fn is_confirmed_before(&self, comparison_height: &BlockHeight) -> bool {
matches!(self, Self::Confirmed(self_height) if self_height < comparison_height)
}
/// To return true, the status must not be confirmed and it must have been submitted sufficiently far in the past. This allows deduction of expired transactions.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_pending_before(&9.into()));
/// assert!(!ConfirmationStatus::Calculated(10.into()).is_pending_before(&10.into()));
/// assert!(ConfirmationStatus::Calculated(10.into()).is_pending_before(&11.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_pending_before(&9.into()));
/// assert!(!ConfirmationStatus::Transmitted(10.into()).is_pending_before(&10.into()));
/// assert!(ConfirmationStatus::Transmitted(10.into()).is_pending_before(&11.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_pending_before(&9.into()));
/// assert!(!ConfirmationStatus::Mempool(10.into()).is_pending_before(&10.into()));
/// assert!(ConfirmationStatus::Mempool(10.into()).is_pending_before(&11.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_pending_before(&9.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_pending_before(&10.into()));
/// assert!(!ConfirmationStatus::Confirmed(10.into()).is_pending_before(&11.into()));
/// ```
// TODO remove 'pending' and fix spend status.
#[must_use]
pub fn is_pending_before(&self, comparison_height: &BlockHeight) -> bool {
match self {
Self::Calculated(self_height)
| Self::Transmitted(self_height)
| Self::Mempool(self_height) => self_height < comparison_height,
_ => false,
}
}
/// Returns none if transaction is not confirmed, otherwise returns the height it was confirmed at.
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// let status = ConfirmationStatus::Confirmed(16.into());
/// assert_eq!(status.get_confirmed_height(), Some(16.into()));
///
/// let status = ConfirmationStatus::Mempool(15.into());
/// assert_eq!(status.get_confirmed_height(), None);
/// ```
#[must_use]
pub fn get_confirmed_height(&self) -> Option<BlockHeight> {
match self {
Self::Confirmed(self_height) => Some(*self_height),
_ => None,
}
}
/// # Examples
///
/// ```
/// use zingo_status::confirmation_status::ConfirmationStatus;
/// use zcash_primitives::consensus::BlockHeight;
///
/// let status = ConfirmationStatus::Confirmed(15.into());
/// assert_eq!(status.get_height(), 15.into());
/// ```
#[must_use]
pub fn get_height(&self) -> BlockHeight {
match self {
Self::Calculated(self_height) => *self_height,
Self::Mempool(self_height) => *self_height,
Self::Transmitted(self_height) => *self_height,
Self::Confirmed(self_height) => *self_height,
}
}
fn serialized_version() -> u8 {
0
}
/// Deserialize into `reader`
pub fn read<R: Read>(mut reader: R) -> std::io::Result<Self> {
let _version = reader.read_u8()?;
let status = reader.read_u8()?;
let block_height = BlockHeight::from_u32(reader.read_u32::<LittleEndian>()?);
match status {
0 => Ok(Self::Calculated(block_height)),
1 => Ok(Self::Transmitted(block_height)),
2 => Ok(Self::Mempool(block_height)),
3 => Ok(Self::Confirmed(block_height)),
_ => Err(std::io::Error::new(
std::io::ErrorKind::InvalidData,
"failed to read status",
)),
}
}
/// Serialize into `writer`
pub fn write<W: Write>(&self, writer: &mut W) -> std::io::Result<()> {
writer.write_u8(Self::serialized_version())?;
writer.write_u8(match self {
Self::Calculated(_) => 0,
Self::Transmitted(_) => 1,
Self::Mempool(_) => 2,
Self::Confirmed(_) => 3,
})?;
writer.write_u32::<LittleEndian>(self.get_height().into())
}
}
/// a public interface, writ in stone
impl std::fmt::Display for ConfirmationStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Calculated(_h) => {
write!(f, "calculated")
}
Self::Transmitted(_h) => {
write!(f, "transmitted")
}
Self::Mempool(_h) => {
write!(f, "mempool")
}
Self::Confirmed(_h) => {
write!(f, "confirmed")
}
}
}
}
#[test]
fn stringify_display() {
let status = ConfirmationStatus::Transmitted(BlockHeight::from_u32(16_000));
let string = format!("{status}");
assert_eq!(string, "transmitted");
}
/// a more complete stringification
impl std::fmt::Debug for ConfirmationStatus {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
Self::Calculated(h) => {
let hi = u32::from(*h);
write!(f, "Calculated for {hi}")
}
Self::Transmitted(h) => {
let hi = u32::from(*h);
write!(f, "Transmitted for {hi}")
}
Self::Mempool(h) => {
let hi = u32::from(*h);
write!(f, "Mempool for {hi}")
}
Self::Confirmed(h) => {
let hi = u32::from(*h);
write!(f, "Confirmed at {hi}")
}
}
}
}
#[test]
fn stringify_debug() {
let status = ConfirmationStatus::Transmitted(BlockHeight::from_u32(16_000));
let string = format!("{status:?}");
assert_eq!(string, "Transmitted for 16000");
}
impl From<ConfirmationStatus> for String {
fn from(value: ConfirmationStatus) -> Self {
format!("{value}")
}
}