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
use super::register::EntryHash;
use crate::safeurl::{ContentType, SafeUrl, XorUrl};
use crate::{Error, Result, Safe};
use sn_interface::types::DataAddress;
use rand::Rng;
use std::collections::BTreeSet;
use tracing::debug;
use xor_name::XorName;
pub type MultimapKey = Vec<u8>;
pub type MultimapValue = Vec<u8>;
pub type MultimapKeyValue = (MultimapKey, MultimapValue);
pub type Multimap = BTreeSet<(EntryHash, MultimapKeyValue)>;
const MULTIMAP_REMOVED_MARK: &[u8] = b"";
impl Safe {
pub async fn multimap_create(&self, name: Option<XorName>, type_tag: u64) -> Result<XorUrl> {
debug!("Creating a Multimap");
self.register_create(name, type_tag, ContentType::Multimap)
.await
}
pub async fn multimap_get_by_key(&self, url: &str, key: &[u8]) -> Result<Multimap> {
debug!("Getting value by key from Multimap at: {}", url);
let safeurl = self.parse_and_resolve_url(url).await?;
self.fetch_multimap_values_by_key(&safeurl, key).await
}
pub async fn multimap_get_by_hash(
&self,
url: &str,
hash: EntryHash,
) -> Result<MultimapKeyValue> {
debug!("Getting value by hash from Multimap at: {}", url);
let safeurl = self.parse_and_resolve_url(url).await?;
self.fetch_multimap_value_by_hash(&safeurl, hash).await
}
pub(crate) async fn fetch_multimap_values_by_key(
&self,
safeurl: &SafeUrl,
key: &[u8],
) -> Result<Multimap> {
let entries = self.fetch_multimap(safeurl).await?;
Ok(entries
.into_iter()
.filter(|(_, (entry_key, _))| entry_key == key)
.collect())
}
pub async fn multimap_insert(
&self,
multimap_url: &str,
entry: MultimapKeyValue,
replace: BTreeSet<EntryHash>,
) -> Result<EntryHash> {
debug!("Inserting '{:?}' into Multimap at {}", entry, multimap_url);
let serialised_entry = rmp_serde::to_vec_named(&entry).map_err(|err| {
Error::Serialisation(format!(
"Couldn't serialise the Multimap entry '{entry:?}': {err:?}",
))
})?;
let data = serialised_entry.clone();
let safeurl = SafeUrl::from_url(multimap_url)?;
let address = match safeurl.address() {
DataAddress::Register(reg_address) => reg_address,
other => {
return Err(Error::InvalidXorUrl(format!(
"The Multimap Url {multimap_url} has an {other:?} address.\
To insert an entry into a multimap, the address must be a register address.",
)))
}
};
if self.dry_run_mode {
return Ok(EntryHash(rand::thread_rng().gen::<[u8; 32]>()));
}
let client = self.get_safe_client()?;
let (entry_hash, op_batch) = client
.write_to_local_register(address, data, replace)
.await?;
client.publish_register_ops(op_batch).await?;
Ok(entry_hash)
}
pub async fn multimap_remove(
&self,
url: &str,
to_remove: BTreeSet<EntryHash>,
) -> Result<EntryHash> {
debug!("Removing from Multimap at {}: {:?}", url, to_remove);
let safeurl = SafeUrl::from_url(url)?;
let address = match safeurl.address() {
DataAddress::Register(reg_address) => reg_address,
other => {
return Err(Error::InvalidXorUrl(format!(
"The multimap url {url} has an {other:?} address.\
To remove an entry from a multimap, the address must be a register address.",
)))
}
};
if self.dry_run_mode {
return Ok(EntryHash(rand::thread_rng().gen::<[u8; 32]>()));
}
let client = self.get_safe_client()?;
let (entry_hash, op_batch) = client
.write_to_local_register(address, MULTIMAP_REMOVED_MARK.to_vec(), to_remove)
.await?;
client.publish_register_ops(op_batch).await?;
Ok(entry_hash)
}
pub(crate) async fn fetch_multimap(&self, safeurl: &SafeUrl) -> Result<Multimap> {
let entries = match self.register_fetch_entries(safeurl).await {
Ok(data) => {
debug!("Multimap retrieved with {} entries...", data.len());
Ok(data)
}
Err(Error::EmptyContent(_)) => Err(Error::EmptyContent(format!(
"Multimap found at \"{safeurl}\" was empty"
))),
Err(Error::ContentNotFound(_)) => Err(Error::ContentNotFound(format!(
"No Multimap found at \"{safeurl}\""
))),
Err(Error::AccessDenied(_)) => {
return Err(Error::AccessDenied(format!(
"Couldn't read Multimap found at \"{safeurl}\""
)))
}
other => other,
}?;
let mut multimap = Multimap::new();
for (hash, entry) in &entries {
if entry == MULTIMAP_REMOVED_MARK {
continue;
}
let key_val = Self::decode_multimap_entry(entry)?;
multimap.insert((*hash, key_val));
}
Ok(multimap)
}
pub(crate) async fn fetch_multimap_value_by_hash(
&self,
safeurl: &SafeUrl,
hash: EntryHash,
) -> Result<MultimapKeyValue> {
let entry = match self.register_fetch_entry(safeurl, hash).await {
Ok(data) => {
debug!("Multimap retrieved...");
Ok(data)
}
Err(Error::EmptyContent(_)) => Err(Error::EmptyContent(format!(
"Multimap found at \"{safeurl}\" was empty"
))),
Err(Error::ContentNotFound(_)) => Err(Error::ContentNotFound(
"No Multimap found at this address".to_string(),
)),
Err(other) => Err(other),
}?;
if entry == MULTIMAP_REMOVED_MARK {
Err(Error::EmptyContent(format!(
"Entry found at \"{safeurl}\" is a tombstone (deletion marker)",
)))
} else {
let key_val = Self::decode_multimap_entry(&entry)?;
Ok(key_val)
}
}
fn decode_multimap_entry(entry: &[u8]) -> Result<MultimapKeyValue> {
rmp_serde::from_slice(entry)
.map_err(|err| Error::ContentError(format!("Couldn't parse Multimap entry: {err:?}")))
}
}
#[cfg(test)]
mod tests {
use crate::app::test_helpers::new_safe_instance;
use anyhow::Result;
use std::collections::BTreeSet;
#[tokio::test]
async fn test_multimap_create() -> Result<()> {
let safe = new_safe_instance().await?;
let xorurl = safe.multimap_create(None, 25_000).await?;
let key = b"".to_vec();
let received_data = safe.multimap_get_by_key(&xorurl, &key).await?;
assert_eq!(received_data, Default::default());
Ok(())
}
#[tokio::test]
async fn test_multimap_insert() -> Result<()> {
let safe = new_safe_instance().await?;
let key = b"key".to_vec();
let val = b"value".to_vec();
let key_val = (key.clone(), val.clone());
let val2 = b"value2".to_vec();
let key_val2 = (key.clone(), val2.clone());
let xorurl = safe.multimap_create(None, 25_000).await?;
let _ = safe.multimap_get_by_key(&xorurl, &key).await?;
let hash = safe
.multimap_insert(&xorurl, key_val.clone(), BTreeSet::new())
.await?;
let received_data = safe.multimap_get_by_key(&xorurl, &key).await?;
assert_eq!(
received_data,
vec![(hash, key_val.clone())].into_iter().collect()
);
let hashes_to_replace = vec![hash].into_iter().collect();
let hash2 = safe
.multimap_insert(&xorurl, key_val2.clone(), hashes_to_replace)
.await?;
let received_data = safe.multimap_get_by_key(&xorurl, &key).await?;
assert_eq!(
received_data,
vec![(hash2, key_val2.clone())].into_iter().collect()
);
Ok(())
}
#[tokio::test]
async fn test_multimap_get_by_hash() -> Result<()> {
let safe = new_safe_instance().await?;
let key = b"key".to_vec();
let val = b"value".to_vec();
let key_val = (key.clone(), val.clone());
let key2 = b"key2".to_vec();
let val2 = b"value2".to_vec();
let key_val2 = (key2.clone(), val2.clone());
let xorurl = safe.multimap_create(None, 25_000).await?;
let _ = safe.multimap_get_by_key(&xorurl, &key).await?;
let hash = safe
.multimap_insert(&xorurl, key_val.clone(), BTreeSet::new())
.await?;
let hash2 = safe
.multimap_insert(&xorurl, key_val2.clone(), BTreeSet::new())
.await?;
let received_data = safe.multimap_get_by_hash(&xorurl, hash).await?;
assert_eq!(received_data, key_val.clone());
let received_data = safe.multimap_get_by_hash(&xorurl, hash2).await?;
assert_eq!(received_data, key_val2.clone());
Ok(())
}
}