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
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

//! Notify/Webhooks API implementation

use super::types::{
    CreateWebhookRequest, GraphqlVariable, ListAddressesResponse, ListNftFiltersResponse,
    ListWebhooksResponse, PatchGraphqlVariableRequest, ReplaceWebhookAddressesRequest,
    UpdateNftFiltersRequest, UpdateWebhookAddressesRequest, UpdateWebhookRequest, Webhook,
};
use crate::client::Client;
use crate::error::{Error, Result};

const NOTIFY_BASE_URL: &str = "https://dashboard.alchemy.com/api";

/// Notify API for webhook management
pub struct NotifyApi<'a> {
    client: &'a Client,
}

impl<'a> NotifyApi<'a> {
    pub(crate) fn new(client: &'a Client) -> Self {
        Self { client }
    }

    fn auth_token(&self) -> String {
        self.client.api_key().to_string()
    }

    async fn get<R>(&self, path: &str) -> Result<R>
    where
        R: serde::de::DeserializeOwned,
    {
        let url = format!("{NOTIFY_BASE_URL}{path}");
        let response = self
            .client
            .http()
            .get(&url)
            .header("X-Alchemy-Token", self.auth_token())
            .send()
            .await?;

        if response.status() == 429 {
            return Err(Error::rate_limited(None));
        }

        if response.status().is_success() {
            Ok(response.json().await?)
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    async fn post<B, R>(&self, path: &str, body: &B) -> Result<R>
    where
        B: serde::Serialize,
        R: serde::de::DeserializeOwned,
    {
        let url = format!("{NOTIFY_BASE_URL}{path}");
        let response = self
            .client
            .http()
            .post(&url)
            .header("X-Alchemy-Token", self.auth_token())
            .json(body)
            .send()
            .await?;

        if response.status() == 429 {
            return Err(Error::rate_limited(None));
        }

        if response.status().is_success() {
            Ok(response.json().await?)
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    async fn put<B, R>(&self, path: &str, body: &B) -> Result<R>
    where
        B: serde::Serialize,
        R: serde::de::DeserializeOwned,
    {
        let url = format!("{NOTIFY_BASE_URL}{path}");
        let response = self
            .client
            .http()
            .put(&url)
            .header("X-Alchemy-Token", self.auth_token())
            .json(body)
            .send()
            .await?;

        if response.status() == 429 {
            return Err(Error::rate_limited(None));
        }

        if response.status().is_success() {
            Ok(response.json().await?)
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    async fn patch<B, R>(&self, path: &str, body: &B) -> Result<R>
    where
        B: serde::Serialize,
        R: serde::de::DeserializeOwned,
    {
        let url = format!("{NOTIFY_BASE_URL}{path}");
        let response = self
            .client
            .http()
            .patch(&url)
            .header("X-Alchemy-Token", self.auth_token())
            .json(body)
            .send()
            .await?;

        if response.status() == 429 {
            return Err(Error::rate_limited(None));
        }

        if response.status().is_success() {
            Ok(response.json().await?)
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    async fn delete(&self, path: &str) -> Result<()> {
        let url = format!("{NOTIFY_BASE_URL}{path}");
        let response = self
            .client
            .http()
            .delete(&url)
            .header("X-Alchemy-Token", self.auth_token())
            .send()
            .await?;

        if response.status() == 429 {
            return Err(Error::rate_limited(None));
        }

        if response.status().is_success() {
            Ok(())
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    // ========== Webhook Methods ==========

    /// List all webhooks for the team
    pub async fn list_webhooks(&self) -> Result<ListWebhooksResponse> {
        self.get("/team-webhooks").await
    }

    /// Create a new webhook
    pub async fn create_webhook(&self, request: &CreateWebhookRequest) -> Result<Webhook> {
        self.post("/create-webhook", request).await
    }

    /// Update a webhook
    pub async fn update_webhook(&self, request: &UpdateWebhookRequest) -> Result<Webhook> {
        self.put("/update-webhook", request).await
    }

    /// Delete a webhook
    pub async fn delete_webhook(&self, webhook_id: &str) -> Result<()> {
        let body = serde_json::json!({ "webhook_id": webhook_id });
        let url = format!("{NOTIFY_BASE_URL}/delete-webhook");
        let response = self
            .client
            .http()
            .delete(&url)
            .header("X-Alchemy-Token", self.auth_token())
            .json(&body)
            .send()
            .await?;

        if response.status().is_success() {
            Ok(())
        } else {
            let status = response.status().as_u16();
            let message = response.text().await.unwrap_or_default();
            Err(Error::api(status, message))
        }
    }

    // ========== Address Methods ==========

    /// List addresses tracked by a webhook
    pub async fn list_webhook_addresses(&self, webhook_id: &str) -> Result<ListAddressesResponse> {
        self.get(&format!("/webhook-addresses?webhook_id={webhook_id}"))
            .await
    }

    /// Add or remove addresses from a webhook (PATCH - idempotent)
    pub async fn update_webhook_addresses(
        &self,
        request: &UpdateWebhookAddressesRequest,
    ) -> Result<()> {
        let _: serde_json::Value = self.patch("/update-webhook-addresses", request).await?;
        Ok(())
    }

    /// Replace all addresses for a webhook (PUT)
    pub async fn replace_webhook_addresses(
        &self,
        request: &ReplaceWebhookAddressesRequest,
    ) -> Result<()> {
        let _: serde_json::Value = self.put("/update-webhook-addresses", request).await?;
        Ok(())
    }

    // ========== NFT Filter Methods ==========

    /// List NFT filters for a webhook
    pub async fn list_nft_filters(&self, webhook_id: &str) -> Result<ListNftFiltersResponse> {
        self.get(&format!("/webhook-nft-filters?webhook_id={webhook_id}"))
            .await
    }

    /// Update NFT filters for a webhook
    pub async fn update_nft_filters(&self, request: &UpdateNftFiltersRequest) -> Result<()> {
        let _: serde_json::Value = self.patch("/update-webhook-nft-filters", request).await?;
        Ok(())
    }

    // ========== GraphQL Variable Methods ==========

    /// Get a GraphQL variable
    pub async fn get_graphql_variable(&self, variable: &str) -> Result<GraphqlVariable> {
        self.get(&format!("/graphql/variables/{variable}")).await
    }

    /// Create a GraphQL variable
    pub async fn create_graphql_variable(
        &self,
        variable: &str,
        values: Vec<String>,
    ) -> Result<GraphqlVariable> {
        let body = serde_json::json!({ "values": values });
        self.post(&format!("/graphql/variables/{variable}"), &body)
            .await
    }

    /// Update a GraphQL variable (add/remove values)
    pub async fn patch_graphql_variable(
        &self,
        variable: &str,
        request: &PatchGraphqlVariableRequest,
    ) -> Result<GraphqlVariable> {
        self.patch(&format!("/graphql/variables/{variable}"), request)
            .await
    }

    /// Delete a GraphQL variable
    pub async fn delete_graphql_variable(&self, variable: &str) -> Result<()> {
        self.delete(&format!("/graphql/variables/{variable}")).await
    }
}