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
use bee_rest_api::types::dtos::LedgerInclusionStateDto;
use futures::stream::FuturesUnordered;
use futures::stream::TryStreamExt;
use identity_core::convert::ToJson;
use identity_iota_core::did::IotaDID;
use identity_iota_core::diff::DiffMessage;
use identity_iota_core::document::IotaDocument;
use identity_iota_core::tangle::Message;
use identity_iota_core::tangle::MessageId;
use identity_iota_core::tangle::Network;
use iota_client::Client as IotaClient;
use iota_client::Error as IotaClientError;
use crate::chain::ChainHistory;
use crate::chain::DiffChain;
use crate::chain::DocumentChain;
use crate::chain::DocumentHistory;
use crate::chain::IntegrationChain;
use crate::document::ResolvedIotaDocument;
use crate::error::Error;
use crate::error::Result;
use crate::tangle::ClientBuilder;
use crate::tangle::DIDMessageEncoding;
use crate::tangle::Receipt;
use crate::tangle::TangleRef;
use crate::tangle::TangleResolve;
#[derive(Debug)]
pub struct Client {
pub(crate) client: IotaClient,
pub(crate) network: Network,
pub(crate) encoding: DIDMessageEncoding,
pub(crate) retry_until_included: bool,
}
impl Client {
pub async fn new() -> Result<Self> {
Self::builder().build().await
}
pub fn builder() -> ClientBuilder {
ClientBuilder::new()
}
pub async fn from_builder(builder: ClientBuilder) -> Result<Self> {
let mut client: iota_client::ClientBuilder = builder.builder;
if !builder.nodeset {
if let Some(network_url) = builder.network.default_node_url() {
client = client.with_node(network_url.as_str())?;
} else {
return Err(Error::NoClientNodesProvided);
}
}
Ok(Self {
client: client.finish().await?,
network: builder.network,
encoding: builder.encoding,
retry_until_included: builder.retry_until_included,
})
}
pub fn network(&self) -> Network {
self.network.clone()
}
pub async fn publish_document(&self, document: &IotaDocument) -> Result<Receipt> {
if document.id().network_str() != self.network.name_str() {
return Err(Error::IncompatibleNetwork(format!(
"DID network '{}' does not match client network '{}'",
document.id().network_str(),
self.network.name_str()
)));
}
if self.retry_until_included {
self
.publish_json_with_retry(document.integration_index(), document, None, None)
.await
} else {
self.publish_json(document.integration_index(), document).await
}
}
#[deprecated(since = "0.5.0", note = "diff chain features are slated for removal")]
pub async fn publish_diff(&self, message_id: &MessageId, diff: &DiffMessage) -> Result<Receipt> {
if diff.id().network_str() != self.network.name_str() {
return Err(Error::IncompatibleNetwork(format!(
"DID network '{}' does not match client network '{}'",
diff.id().network_str(),
self.network.name_str()
)));
}
let diff_index = &IotaDocument::diff_index(message_id)?;
if self.retry_until_included {
self.publish_json_with_retry(diff_index, diff, None, None).await
} else {
self.publish_json(diff_index, diff).await
}
}
pub async fn publish_json<T: ToJson>(&self, index: &str, data: &T) -> Result<Receipt> {
let message_data: Vec<u8> = crate::tangle::pack_did_message(data, self.encoding)?;
self
.client
.message()
.with_index(index)
.with_data(message_data)
.finish()
.await
.map_err(Into::into)
.map(|message| Receipt::new(self.network.clone(), message))
}
pub async fn publish_json_with_retry<T: ToJson>(
&self,
index: &str,
data: &T,
interval: Option<u64>,
max_attempts: Option<u64>,
) -> Result<Receipt> {
let receipt: Receipt = self.publish_json(index, data).await?;
let retry_result: Result<Vec<(MessageId, Message)>, IotaClientError> = self
.client
.retry_until_included(receipt.message_id(), interval, max_attempts)
.await;
let reattached_messages: Vec<(MessageId, Message)> = match retry_result {
Ok(reattached_messages) => reattached_messages,
Err(inclusion_error @ IotaClientError::TangleInclusionError(_)) => {
if self.is_message_included(receipt.message_id()).await? {
return Ok(receipt);
} else {
return Err(Error::from(inclusion_error));
}
}
Err(error) => {
return Err(Error::from(error));
}
};
match reattached_messages.into_iter().next() {
Some((_, message)) => Ok(Receipt::new(self.network.clone(), message)),
None => Err(Error::from(IotaClientError::TangleInclusionError(
receipt.message_id().to_string(),
))),
}
}
pub async fn read_document(&self, did: &IotaDID) -> Result<ResolvedIotaDocument> {
self.read_document_chain(did).await.and_then(DocumentChain::fold)
}
pub async fn read_document_chain(&self, did: &IotaDID) -> Result<DocumentChain> {
log::trace!("Read Document Chain: {}", did);
if did.network_str() != self.network.name_str() {
return Err(Error::DIDNotFound(format!(
"DID network '{}' does not match client network '{}'",
did.network_str(),
self.network.name_str()
)));
}
log::trace!("Integration Chain Address: {}", did.tag());
let messages: Vec<Message> = self.read_messages(did.tag()).await?;
let integration_chain: IntegrationChain = IntegrationChain::try_from_messages(did, &messages, self).await?;
let diff_chain: DiffChain = {
let index: String = IotaDocument::diff_index(integration_chain.current_message_id())?;
let messages: Vec<Message> = self.read_messages(&index).await?;
log::trace!("Diff Messages: {:#?}", messages);
DiffChain::try_from_messages(&integration_chain, &messages, self).await?
};
DocumentChain::new_with_diff_chain(integration_chain, diff_chain)
}
pub async fn resolve_history(&self, did: &IotaDID) -> Result<DocumentHistory> {
DocumentHistory::read(self, did).await
}
#[deprecated(since = "0.5.0", note = "diff chain features are slated for removal")]
pub async fn resolve_diff_history(&self, document: &ResolvedIotaDocument) -> Result<ChainHistory<DiffMessage>> {
let diff_index: String = IotaDocument::diff_index(document.message_id())?;
let diff_messages: Vec<Message> = self.read_messages(&diff_index).await?;
ChainHistory::try_from_raw_messages(document, &diff_messages, self).await
}
pub(crate) async fn read_messages(&self, index: &str) -> Result<Vec<Message>> {
let message_ids: Box<[MessageId]> = Self::read_message_index(&self.client, index).await?;
let messages: Vec<Message> = Self::read_message_data(&self.client, &message_ids).await?;
Ok(messages)
}
async fn read_message_index(client: &IotaClient, index: &str) -> Result<Box<[MessageId]>> {
client.get_message().index(index).await.map_err(Into::into)
}
async fn read_message_data(client: &IotaClient, messages: &[MessageId]) -> Result<Vec<Message>> {
messages
.iter()
.map(|message_id| client.get_message().data(message_id))
.collect::<FuturesUnordered<_>>()
.try_collect()
.await
.map_err(Into::into)
}
pub async fn is_message_included(&self, message_id: &MessageId) -> Result<bool> {
match self
.client
.get_message()
.metadata(message_id)
.await?
.ledger_inclusion_state
{
Some(ledger_inclusion_state) => match ledger_inclusion_state {
LedgerInclusionStateDto::Included | LedgerInclusionStateDto::NoTransaction => Ok(true),
LedgerInclusionStateDto::Conflicting => Ok(false),
},
None => Ok(false),
}
}
}
#[async_trait::async_trait(?Send)]
impl TangleResolve for Client {
async fn resolve(&self, did: &IotaDID) -> Result<ResolvedIotaDocument> {
self.read_document(did).await
}
}