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
use crate::error::Result;
use crate::types::{CreateWebhookRequest, EditWebhookRequest, ToggleWebhookRequest, Webhook};
use crate::Helius;
use reqwest::{Method, Url};
impl Helius {
/// Creates a webhook given account addresses
///
/// # Arguments
/// * `request` - A `CreateWebhookRequest` containing the relevant webhook parameters for creation such as the webhook url and type
///
/// # Returns
/// A `Result` wrapping a `Webhook` if the webhook is successfully created, or a `HeliusError` if creation fails
pub async fn create_webhook(&self, request: CreateWebhookRequest) -> Result<Webhook> {
let api_key = self.config.require_api_key("webhook operations")?;
let url: String = format!("{}v0/webhooks?api-key={}", self.config.endpoints.api, api_key.as_str());
let parsed_url: Url = Url::parse(&url).expect("Failed to parse URL");
self.rpc_client
.handler
.send(Method::POST, parsed_url, Some(&request))
.await
}
/// Edits a Helius webhook programmatically
///
/// # Arguments
/// * `request` - An `EditWebhookRequest` containing the parameters to be updated for a given webhook
///
/// # Returns
/// A `Result` wrapping the updated `Webhook`, or a `HeliusError` if the edit request fails
pub async fn edit_webhook(&self, request: EditWebhookRequest) -> Result<Webhook> {
let api_key = self.config.require_api_key("webhook operations")?;
let url: String = format!(
"{}v0/webhooks/{}?api-key={}",
self.config.endpoints.api,
request.webhook_id,
api_key.as_str()
);
let parsed_url: Url = Url::parse(&url).expect("Failed to parse URL");
self.rpc_client
.handler
.send(Method::PUT, parsed_url, Some(&request))
.await
}
/// Appends a set of addresses to a given webhook
///
/// # Arguments
/// * `webhook_id` - The ID of the webhook to be updated
/// * `new_addresses` - A slice of strings representing the new account addresses to be added to the given webhook
///
/// # Returns
/// A `Result` containing the updated `Webhook` object
pub async fn append_addresses_to_webhook(&self, webhook_id: &str, new_addresses: &[String]) -> Result<Webhook> {
let mut webhook: Webhook = self.get_webhook_by_id(webhook_id).await?;
webhook.account_addresses.extend(new_addresses.to_vec());
let edit_request: EditWebhookRequest = EditWebhookRequest {
webhook_id: webhook_id.to_string(),
webhook_url: webhook.webhook_url,
transaction_types: webhook.transaction_types,
auth_header: webhook.auth_header,
txn_status: webhook.txn_status,
encoding: webhook.encoding,
account_addresses: webhook.account_addresses,
webhook_type: webhook.webhook_type,
};
self.edit_webhook(edit_request).await
}
/// Removes a list of addresses from an existing webhook by its ID
///
/// # Arguments
/// * `webhook_id` - The ID of the webhook to edit
/// * `addresses_to_remove` - The vector of addresses to be removed from the webhook provided
///
/// # Returns
/// A `Result` wrapping the edited `Webhook`, if successful
pub async fn remove_addresses_from_webhook(
&self,
webhook_id: &str,
addresses_to_remove: &[String],
) -> Result<Webhook> {
let mut webhook: Webhook = self.get_webhook_by_id(webhook_id).await?;
webhook
.account_addresses
.retain(|address| !addresses_to_remove.contains(address));
let edit_request: EditWebhookRequest = EditWebhookRequest {
webhook_id: webhook_id.to_string(),
webhook_url: webhook.webhook_url,
transaction_types: webhook.transaction_types,
auth_header: webhook.auth_header,
txn_status: webhook.txn_status,
encoding: webhook.encoding,
account_addresses: webhook.account_addresses,
webhook_type: webhook.webhook_type,
};
self.edit_webhook(edit_request).await
}
/// Gets a webhook config given a webhook ID
///
/// # Arguments
/// * `webhook_id` - The ID of the webhook to be updated
///
/// # Returns
/// A `Result` wrapping the `Webhook` queried, if it exists
pub async fn get_webhook_by_id(&self, webhook_id: &str) -> Result<Webhook> {
let api_key = self.config.require_api_key("webhook operations")?;
let url: String = format!(
"{}v0/webhooks/{}?api-key={}",
self.config.endpoints.api,
webhook_id,
api_key.as_str()
);
let parsed_url: Url = Url::parse(&url).expect("Failed to parse URL");
self.rpc_client.handler.send(Method::GET, parsed_url, None::<&()>).await
}
/// Retrieves all Helius webhooks programmatically
///
/// Due to response size limitations, we will truncate addresses returned to 100 per config
///
/// # Returns
/// A `Result` containing a vector of `Webhook` representing all configured webhooks for a given account
pub async fn get_all_webhooks(&self) -> Result<Vec<Webhook>> {
let api_key = self.config.require_api_key("webhook operations")?;
let url: String = format!("{}v0/webhooks?api-key={}", self.config.endpoints.api, api_key.as_str());
let parsed_url: Url = Url::parse(&url).expect("Failed to parse URL");
self.rpc_client.handler.send(Method::GET, parsed_url, None::<&()>).await
}
/// Toggles a webhook on or off without deleting it
///
/// Use this to re-enable a webhook that was automatically disabled due to a high endpoint
/// failure rate, or to temporarily pause deliveries. After re-enabling, the webhook enters
/// a 24-hour grace period during which it will not be automatically disabled again.
///
/// # Arguments
/// * `request` - A `ToggleWebhookRequest` containing the webhook ID and the desired `active` state
///
/// # Returns
/// A `Result` wrapping the updated `Webhook`, or a `HeliusError` if the request fails
pub async fn toggle_webhook(&self, request: ToggleWebhookRequest) -> Result<Webhook> {
let api_key = self.config.require_api_key("webhook operations")?;
let url: String = format!(
"{}v0/webhooks/{}?api-key={}",
self.config.endpoints.api,
request.webhook_id,
api_key.as_str()
);
let parsed_url: Url = Url::parse(&url).expect("Failed to parse URL");
self.rpc_client
.handler
.send(Method::PATCH, parsed_url, Some(&request))
.await
}
/// Deletes a given Helius webhook programmatically
///
/// # Arguments
/// * `webhook_id` - The ID of the webhook to be deleted
///
/// # Returns
/// A unit since there isn't any response
pub async fn delete_webhook(&self, webhook_id: &str) -> Result<()> {
let api_key = self.config.require_api_key("webhook operations")?;
let url: String = format!(
"{}v0/webhooks/{}?api-key={}",
self.config.endpoints.api,
webhook_id,
api_key.as_str()
);
let parsed_url: Url = Url::parse(&url).expect("Failed to parse URL");
self.rpc_client
.handler
.send(Method::DELETE, parsed_url, None::<&()>)
.await
}
}