alcmy 0.1.6

Unofficial Rust client for the Alchemy API
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
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

//! Types for the Accounts/Signer API

use serde::{Deserialize, Serialize};

/// Authentication type
#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "lowercase")]
pub enum AuthType {
    Email,
    Passkey,
}

/// Signup request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SignupRequest {
    /// Email address
    #[serde(skip_serializing_if = "Option::is_none")]
    pub email: Option<String>,
    /// Passkey credential
    #[serde(skip_serializing_if = "Option::is_none")]
    pub passkey: Option<PasskeyCredential>,
    /// Target public key (for delegated signing)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_public_key: Option<String>,
}

/// Passkey credential
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PasskeyCredential {
    /// Credential ID
    pub id: String,
    /// Raw ID (base64)
    pub raw_id: String,
    /// Response
    pub response: PasskeyResponse,
    /// Authenticator attachment
    #[serde(skip_serializing_if = "Option::is_none")]
    pub authenticator_attachment: Option<String>,
    /// Client extension results
    #[serde(skip_serializing_if = "Option::is_none")]
    pub client_extension_results: Option<serde_json::Value>,
}

/// Passkey response
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct PasskeyResponse {
    /// Client data JSON (base64)
    pub client_data_json: String,
    /// Attestation object (base64)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub attestation_object: Option<String>,
    /// Authenticator data (base64)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub authenticator_data: Option<String>,
    /// Signature (base64)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub signature: Option<String>,
}

/// Signup response
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SignupResponse {
    /// Org ID
    pub org_id: String,
    /// User ID
    pub user_id: String,
    /// Address
    pub address: String,
}

/// Auth request (email magic link)
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct AuthRequest {
    /// Email address
    pub email: String,
    /// Redirect URL after auth
    #[serde(skip_serializing_if = "Option::is_none")]
    pub redirect_url: Option<String>,
    /// Target public key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_public_key: Option<String>,
}

/// Whoami response
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct WhoamiResponse {
    /// Org ID
    pub org_id: String,
    /// User ID
    pub user_id: String,
    /// Address
    pub address: String,
    /// Email
    pub email: Option<String>,
}

/// Lookup request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct LookupRequest {
    /// Email to look up
    pub email: String,
}

/// Lookup response
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct LookupResponse {
    /// Whether the user exists
    pub exists: bool,
    /// Org ID (if exists)
    pub org_id: Option<String>,
}

/// OTP verification request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct OtpRequest {
    /// Email address
    pub email: String,
    /// OTP code
    pub otp: String,
    /// Target public key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_public_key: Option<String>,
}

/// JWT auth request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct JwtAuthRequest {
    /// JWT token
    pub jwt: String,
    /// Target public key
    #[serde(skip_serializing_if = "Option::is_none")]
    pub target_public_key: Option<String>,
}

/// Sign payload request
#[derive(Debug, Clone, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SignPayloadRequest {
    /// Payload to sign (hex)
    pub payload: String,
    /// Stamp token
    #[serde(skip_serializing_if = "Option::is_none")]
    pub stamp_token: Option<String>,
}

/// Sign payload response
#[derive(Debug, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct SignPayloadResponse {
    /// Signature (hex)
    pub signature: String,
}