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
111
112
113
114
115
116

//! Request and response types for the Wallet Authentication Backend (WAB) API.
//!
//! All types use `#[serde(rename_all = "camelCase")]` for JSON wire compatibility
//! with the WAB server protocol.

use serde::{Deserialize, Serialize};

/// WAB server info returned from GET /info.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct WABInfo {
    /// Name of the WAB server instance.
    pub server_name: Option<String>,
    /// Authentication methods supported by this server.
    pub supported_methods: Option<Vec<String>>,
    /// Feature flags enabled on the server.
    pub features: Option<serde_json::Value>,
    /// Server version string.
    pub version: Option<String>,
}

/// Response from starting an authentication flow via /auth/start.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct StartAuthResponse {
    /// Whether the auth start request succeeded.
    pub success: bool,
    /// Optional message from the server.
    pub message: Option<String>,
    /// Optional additional data (e.g., session tokens, challenge info).
    pub data: Option<serde_json::Value>,
}

/// Response from completing an authentication flow via /auth/complete.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CompleteAuthResponse {
    /// Whether the auth completion succeeded.
    pub success: bool,
    /// Optional message from the server.
    pub message: Option<String>,
    /// The authenticated presentation key, returned on success.
    pub presentation_key: Option<String>,
}

/// Response from the faucet endpoint /faucet/request.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct FaucetResponse {
    /// Transaction ID (hex-encoded).
    pub txid: Option<String>,
    /// Raw transaction (hex-encoded).
    pub tx: Option<String>,
    /// Key data (hex-encoded).
    pub k: Option<String>,
    /// Whether the faucet request succeeded.
    pub success: Option<bool>,
    /// Optional message from the server.
    pub message: Option<String>,
}

/// Response from Shamir share operations (/share/store, /share/retrieve, /share/update).
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ShamirShareResponse {
    /// Whether the share operation succeeded.
    pub success: bool,
    /// Optional message from the server.
    pub message: Option<String>,
    /// The share data (returned from retrieve operations).
    pub share_b: Option<String>,
    /// User ID (returned from store operations).
    pub user_id: Option<i64>,
    /// Share version (returned from update operations).
    pub share_version: Option<i64>,
}

/// Response from listing linked auth methods via /user/linkedMethods.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LinkedMethodsResponse {
    /// List of authentication methods linked to the user.
    pub methods: Option<Vec<LinkedMethod>>,
}

/// A single linked authentication method.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct LinkedMethod {
    /// The type of authentication method (e.g., "TwilioPhone").
    pub method_type: Option<String>,
    /// The method identifier (e.g., phone number).
    pub identifier: Option<String>,
    /// The server-assigned auth method ID.
    pub auth_method_id: Option<i64>,
}

/// Response from unlinking an auth method via /user/unlinkMethod.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct UnlinkResponse {
    /// Whether the unlink operation succeeded.
    pub success: bool,
    /// Optional message from the server.
    pub message: Option<String>,
}

/// Response from deleting a user via /user/delete or /share/delete.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DeleteUserResponse {
    /// Whether the delete operation succeeded.
    pub success: bool,
    /// Optional message from the server.
    pub message: Option<String>,
}