bsv-wallet-toolbox 0.2.23

Pure Rust BSV wallet-toolbox implementation
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
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110

//! Status enums for wallet entities.
//!
//! Each enum serializes to camelCase strings matching the TypeScript values exactly.
//! All enums derive serde for JSON serialization and strum for Display/FromStr conversions.
//! Database encoding/decoding is handled by the `impl_sqlx_string_enum!` macro in
//! the sqlx_string_enum module, which treats each enum as a VARCHAR/TEXT string column.

use serde::{Deserialize, Serialize};
use strum::{Display, EnumString};

/// Status of a wallet transaction.
///
/// Maps to TS `TransactionStatus` in `wallet-toolbox/src/sdk/types.ts`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Display, EnumString)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum TransactionStatus {
    /// Transaction completed successfully and is proven on chain.
    Completed,
    /// Transaction failed to broadcast or was rejected.
    Failed,
    /// Transaction has not yet been processed.
    Unprocessed,
    /// Transaction is currently being broadcast to the network.
    Sending,
    /// Transaction was broadcast but is not yet proven in a block.
    Unproven,
    /// Transaction is awaiting signatures before it can be broadcast.
    Unsigned,
    /// Transaction was created with noSend flag and will not be broadcast.
    Nosend,
    /// Transaction contains nLockTime or nSequence constraints and is not yet final.
    Nonfinal,
    /// Transaction is being unfailed (moved from failed back to processing).
    Unfail,
}

/// Status of a proven transaction request.
///
/// Maps to TS `ProvenTxReqStatus` in `wallet-toolbox/src/sdk/types.ts`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Display, EnumString)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum ProvenTxReqStatus {
    /// Request is currently being sent to miners.
    Sending,
    /// Request has not yet been sent.
    Unsent,
    /// Request was created with noSend flag and will not be sent.
    Nosend,
    /// Request status is unknown or uninitialized.
    Unknown,
    /// Request contains a non-final transaction.
    Nonfinal,
    /// Request has not yet been processed.
    Unprocessed,
    /// Transaction was broadcast but is not yet mined.
    Unmined,
    /// Waiting for a callback from the broadcast service.
    Callback,
    /// Transaction is in a block but not yet sufficiently confirmed.
    Unconfirmed,
    /// Proof request completed successfully.
    Completed,
    /// Transaction was determined to be invalid.
    Invalid,
    /// Transaction was detected as a double spend.
    DoubleSpend,
    /// Request is being unfailed (moved from failed back to processing).
    Unfail,
}

/// Status of wallet synchronization.
///
/// Maps to TS `SyncStatus` in `wallet-toolbox/src/sdk/WalletStorage.interfaces.ts`.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Display, EnumString)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum SyncStatus {
    /// Synchronization completed successfully.
    Success,
    /// Synchronization encountered an error.
    Error,
    /// Remote storage has been identified but not yet synced.
    Identified,
    /// Records have been updated from the remote storage.
    Updated,
    /// Sync status has not been determined.
    Unknown,
}

/// Status of a transaction output.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize, Display, EnumString)]
#[serde(rename_all = "camelCase")]
#[strum(serialize_all = "camelCase")]
pub enum OutputStatus {
    /// The output has not been spent and is available for use.
    Unspent,
    /// The output has been consumed as an input in another transaction.
    Spent,
}

#[cfg(any(feature = "sqlite", feature = "mysql", feature = "postgres"))]
impl_sqlx_string_enum!(TransactionStatus);
#[cfg(any(feature = "sqlite", feature = "mysql", feature = "postgres"))]
impl_sqlx_string_enum!(ProvenTxReqStatus);
#[cfg(any(feature = "sqlite", feature = "mysql", feature = "postgres"))]
impl_sqlx_string_enum!(SyncStatus);
#[cfg(any(feature = "sqlite", feature = "mysql", feature = "postgres"))]
impl_sqlx_string_enum!(OutputStatus);