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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
use std::{
sync::{Arc, RwLock},
time::Duration,
};
use bee_api_types::responses::RentStructureResponse;
#[cfg(not(target_family = "wasm"))]
use {
std::collections::HashSet,
tokio::{runtime::Runtime, sync::broadcast::channel},
};
#[cfg(feature = "mqtt")]
use crate::node_api::mqtt::{BrokerOptions, MqttEvent};
use crate::{
client::Client,
constants::{DEFAULT_API_TIMEOUT, DEFAULT_REMOTE_POW_API_TIMEOUT, DEFAULT_TIPS_INTERVAL},
error::{Error, Result},
node_manager::{
builder::validate_url,
node::{Node, NodeAuth},
},
};
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
pub struct NetworkInfo {
pub network: Option<String>,
#[serde(rename = "networkId")]
pub network_id: Option<u64>,
#[serde(rename = "bech32Hrp", default)]
pub bech32_hrp: Option<String>,
#[serde(rename = "minPowScore", default)]
pub min_pow_score: Option<f64>,
#[serde(rename = "localPow", default = "default_local_pow")]
pub local_pow: bool,
#[serde(rename = "fallbackToLocalPow", default = "default_fallback_to_local_pow")]
pub fallback_to_local_pow: bool,
#[serde(rename = "tipsInterval", default = "default_tips_interval")]
pub tips_interval: u64,
#[serde(rename = "rentStructure", default)]
pub rent_structure: Option<RentStructureResponse>,
}
fn default_local_pow() -> bool {
#[cfg(not(target_family = "wasm"))]
{
true
}
#[cfg(target_family = "wasm")]
{
false
}
}
fn default_fallback_to_local_pow() -> bool {
true
}
fn default_tips_interval() -> u64 {
DEFAULT_TIPS_INTERVAL
}
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
#[serde(deny_unknown_fields)]
#[must_use]
pub struct ClientBuilder {
#[serde(flatten, rename = "nodeManagerBuilder")]
pub node_manager_builder: crate::node_manager::builder::NodeManagerBuilder,
#[cfg(feature = "mqtt")]
#[serde(flatten, rename = "brokerOptions")]
pub broker_options: BrokerOptions,
#[serde(flatten, rename = "networkInfo", default)]
pub network_info: NetworkInfo,
#[serde(rename = "apiTimeout", default = "default_api_timeout")]
pub api_timeout: Duration,
#[serde(rename = "remotePowTimeout", default = "default_remote_pow_timeout")]
pub remote_pow_timeout: Duration,
#[serde(default)]
pub offline: bool,
#[serde(rename = "powWorkerCount", default)]
pub pow_worker_count: Option<usize>,
}
fn default_api_timeout() -> Duration {
DEFAULT_API_TIMEOUT
}
fn default_remote_pow_timeout() -> Duration {
DEFAULT_REMOTE_POW_API_TIMEOUT
}
impl Default for NetworkInfo {
fn default() -> Self {
Self {
network: None,
network_id: None,
min_pow_score: None,
local_pow: default_local_pow(),
fallback_to_local_pow: true,
bech32_hrp: None,
tips_interval: DEFAULT_TIPS_INTERVAL,
rent_structure: None,
}
}
}
impl Default for ClientBuilder {
fn default() -> Self {
Self {
node_manager_builder: crate::node_manager::NodeManager::builder(),
#[cfg(feature = "mqtt")]
broker_options: Default::default(),
network_info: NetworkInfo::default(),
api_timeout: DEFAULT_API_TIMEOUT,
remote_pow_timeout: DEFAULT_REMOTE_POW_API_TIMEOUT,
offline: false,
pow_worker_count: None,
}
}
}
impl ClientBuilder {
pub fn new() -> Self {
Default::default()
}
#[allow(unused_assignments)]
pub fn from_json(mut self, client_config: &str) -> Result<Self> {
self = serde_json::from_str(client_config)?;
if let Some(node_dto) = &self.node_manager_builder.primary_node {
let node: Node = node_dto.into();
validate_url(node.url)?;
}
if let Some(node_dto) = &self.node_manager_builder.primary_pow_node {
let node: Node = node_dto.into();
validate_url(node.url)?;
}
for node_dto in &self.node_manager_builder.nodes {
let node: Node = node_dto.into();
validate_url(node.url)?;
}
if let Some(permanodes) = &self.node_manager_builder.permanodes {
for node_dto in permanodes {
let node: Node = node_dto.into();
validate_url(node.url)?;
}
}
Ok(self)
}
pub fn to_json(&self) -> Result<String> {
Ok(serde_json::to_string(&self)?)
}
pub fn with_node(mut self, url: &str) -> Result<Self> {
self.node_manager_builder = self.node_manager_builder.with_node(url)?;
Ok(self)
}
pub fn with_primary_node(mut self, url: &str, auth: Option<NodeAuth>) -> Result<Self> {
self.node_manager_builder = self.node_manager_builder.with_primary_node(url, auth)?;
Ok(self)
}
pub fn with_primary_pow_node(mut self, url: &str, auth: Option<NodeAuth>) -> Result<Self> {
self.node_manager_builder = self.node_manager_builder.with_primary_pow_node(url, auth)?;
Ok(self)
}
pub fn with_permanode(mut self, url: &str, auth: Option<NodeAuth>) -> Result<Self> {
self.node_manager_builder = self.node_manager_builder.with_permanode(url, auth)?;
Ok(self)
}
pub fn with_node_auth(mut self, url: &str, auth: Option<NodeAuth>) -> Result<Self> {
self.node_manager_builder = self.node_manager_builder.with_node_auth(url, auth)?;
Ok(self)
}
pub fn with_nodes(mut self, urls: &[&str]) -> Result<Self> {
self.node_manager_builder = self.node_manager_builder.with_nodes(urls)?;
Ok(self)
}
pub fn with_node_sync_interval(mut self, node_sync_interval: Duration) -> Self {
self.node_manager_builder = self.node_manager_builder.with_node_sync_interval(node_sync_interval);
self
}
pub fn with_node_sync_disabled(mut self) -> Self {
self.node_manager_builder = self.node_manager_builder.with_node_sync_disabled();
self
}
pub fn with_offline_mode(mut self) -> Self {
self.offline = true;
self
}
pub fn with_quorum(mut self, quorum: bool) -> Self {
self.node_manager_builder = self.node_manager_builder.with_quorum(quorum);
self
}
pub fn with_min_quorum_size(mut self, min_quorum_size: usize) -> Self {
self.node_manager_builder = self.node_manager_builder.with_min_quorum_size(min_quorum_size);
self
}
pub fn with_quorum_threshold(mut self, threshold: usize) -> Self {
let threshold = if threshold > 100 { 100 } else { threshold };
self.node_manager_builder = self.node_manager_builder.with_quorum_threshold(threshold);
self
}
pub fn with_network(mut self, network: &str) -> Self {
self.network_info.network.replace(network.into());
self
}
#[cfg(feature = "mqtt")]
pub fn with_mqtt_broker_options(mut self, options: BrokerOptions) -> Self {
self.broker_options = options;
self
}
pub fn with_local_pow(mut self, local: bool) -> Self {
self.network_info.local_pow = local;
self
}
pub fn with_pow_worker_count(mut self, worker_count: usize) -> Self {
self.pow_worker_count.replace(worker_count);
self
}
pub fn with_fallback_to_local_pow(mut self, fallback_to_local_pow: bool) -> Self {
self.network_info.fallback_to_local_pow = fallback_to_local_pow;
self
}
pub fn with_tips_interval(mut self, tips_interval: u64) -> Self {
self.network_info.tips_interval = tips_interval;
self
}
pub fn with_api_timeout(mut self, timeout: Duration) -> Self {
self.api_timeout = timeout;
self
}
pub fn with_remote_pow_timeout(mut self, timeout: Duration) -> Self {
self.remote_pow_timeout = timeout;
self
}
pub fn finish(mut self) -> Result<Client> {
if !self.offline {
self.node_manager_builder = self.node_manager_builder.add_default_nodes(&self.network_info)?;
if self.node_manager_builder.nodes.is_empty() && self.node_manager_builder.primary_node.is_none() {
return Err(Error::MissingParameter("Node"));
}
}
let network_info = Arc::new(RwLock::new(self.network_info));
let nodes = self
.node_manager_builder
.nodes
.iter()
.map(|node| node.clone().into())
.collect();
#[cfg(target_family = "wasm")]
let (sync, network_info) = (Arc::new(RwLock::new(nodes)), network_info);
#[cfg(not(target_family = "wasm"))]
let (runtime, sync, sync_kill_sender, network_info) = if self.node_manager_builder.node_sync_enabled {
let sync = Arc::new(RwLock::new(HashSet::new()));
let sync_ = sync.clone();
let network_info_ = network_info.clone();
let (sync_kill_sender, sync_kill_receiver) = channel(1);
let runtime = std::thread::spawn(move || {
let runtime = Runtime::new().expect("Failed to create Tokio runtime");
runtime.block_on(Client::sync_nodes(&sync_, &nodes, &network_info_));
Client::start_sync_process(
&runtime,
sync_,
nodes,
self.node_manager_builder.node_sync_interval,
network_info_,
sync_kill_receiver,
);
runtime
})
.join()
.expect("failed to init node syncing process");
(Some(Arc::new(runtime)), sync, Some(sync_kill_sender), network_info)
} else {
(None, Arc::new(RwLock::new(nodes)), None, network_info)
};
#[cfg(feature = "mqtt")]
let (mqtt_event_tx, mqtt_event_rx) = tokio::sync::watch::channel(MqttEvent::Connected);
let client = Client {
node_manager: self.node_manager_builder.build(sync),
#[cfg(not(target_family = "wasm"))]
runtime,
#[cfg(not(target_family = "wasm"))]
sync_kill_sender: sync_kill_sender.map(Arc::new),
#[cfg(feature = "mqtt")]
mqtt_client: None,
#[cfg(feature = "mqtt")]
mqtt_topic_handlers: Default::default(),
#[cfg(feature = "mqtt")]
broker_options: self.broker_options,
#[cfg(feature = "mqtt")]
mqtt_event_channel: (Arc::new(mqtt_event_tx), mqtt_event_rx),
network_info,
api_timeout: self.api_timeout,
remote_pow_timeout: self.remote_pow_timeout,
pow_worker_count: self.pow_worker_count,
};
Ok(client)
}
}