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
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
use feed_builder::FeedBuilder;
use replicate::{Message, Peer};
pub use storage::{Node, NodeTrait, Storage, Store};
use bitfield::Bitfield;
use crypto::{generate_keypair, sign, verify, Hash, Merkle};
use ed25519_dalek::{PublicKey, SecretKey, Signature};
use flat_tree as flat;
use pretty_hash::fmt as pretty_fmt;
use proof::Proof;
use random_access_disk::RandomAccessDiskMethods;
use random_access_memory::RandomAccessMemoryMethods;
use random_access_storage::RandomAccessMethods;
use tree_index::TreeIndex;
use Result;
use std::borrow::Borrow;
use std::cmp;
use std::fmt::{self, Debug, Display};
use std::ops::Range;
use std::path::PathBuf;
use std::rc::Rc;
#[derive(Debug)]
pub struct Feed<T>
where
T: RandomAccessMethods + Debug,
{
pub(crate) merkle: Merkle,
pub(crate) public_key: PublicKey,
pub(crate) secret_key: Option<SecretKey>,
pub(crate) storage: Storage<T>,
pub(crate) byte_length: usize,
pub(crate) length: usize,
pub(crate) bitfield: Bitfield,
pub(crate) tree: TreeIndex,
pub(crate) peers: Vec<Peer>,
}
impl<T> Feed<T>
where
T: RandomAccessMethods + Debug,
{
pub fn with_storage(storage: ::storage::Storage<T>) -> Result<Self> {
let keypair = generate_keypair();
let feed = FeedBuilder::new(keypair.public, storage)
.secret_key(keypair.secret)
.build()?;
Ok(feed)
}
pub fn builder(public_key: PublicKey, storage: Storage<T>) -> FeedBuilder<T> {
FeedBuilder::new(public_key, storage)
}
#[inline]
pub fn len(&self) -> usize {
self.length
}
#[inline]
pub fn is_empty(&self) -> bool {
self.len() == 0
}
#[inline]
pub fn byte_len(&self) -> usize {
self.byte_length
}
#[inline]
pub fn append(&mut self, data: &[u8]) -> Result<()> {
let key = match &self.secret_key {
Some(key) => key,
None => bail!("no secret key, cannot append."),
};
self.merkle.next(data);
let mut offset = 0;
self.storage.write_data(self.byte_length + offset, &data)?;
offset += data.len();
let hash = Hash::from_roots(self.merkle.roots());
let index = self.length;
let signature = sign(&self.public_key, key, hash.as_bytes());
self.storage.put_signature(index, signature)?;
for node in self.merkle.nodes() {
self.storage.put_node(node)?;
}
self.byte_length += offset;
self.bitfield.set(self.length, true);
self.tree.set(2 * self.length);
self.length += 1;
Ok(())
}
#[inline]
pub fn head(&mut self) -> Result<Option<Vec<u8>>> {
match self.len() {
0 => Ok(None),
len => self.get(len - 1),
}
}
#[inline]
pub fn has(&mut self, index: usize) -> bool {
self.bitfield.get(index)
}
#[inline]
pub fn has_all(&mut self, range: ::std::ops::Range<usize>) -> bool {
let total = range.len();
total == self.bitfield.total_with_range(range) as usize
}
#[inline]
pub fn downloaded(&mut self, range: ::std::ops::Range<usize>) -> u8 {
self.bitfield.total_with_range(range)
}
#[inline]
pub fn get(&mut self, index: usize) -> Result<Option<Vec<u8>>> {
if !self.bitfield.get(index) {
return Ok(None);
}
Ok(Some(self.storage.get_data(index)?))
}
#[inline]
pub fn proof(&mut self, index: usize, include_hash: bool) -> Result<Proof> {
self.proof_with_digest(index, 0, include_hash)
}
pub fn proof_with_digest(
&mut self,
index: usize,
digest: usize,
include_hash: bool,
) -> Result<Proof> {
let mut remote_tree = TreeIndex::default();
let mut nodes = vec![];
let proof = self.tree.proof_with_digest(
2 * index,
digest,
include_hash,
&mut nodes,
&mut remote_tree,
);
let proof = match proof {
Some(proof) => proof,
None => bail!("No proof available for index {}", index),
};
let tmp_num = proof.verified_by() / 2;
let (sig_index, has_underflow) = tmp_num.overflowing_sub(1);
let signature = if has_underflow {
None
} else {
match self.storage.get_signature(sig_index) {
Ok(sig) => Some(sig),
Err(_) => None,
}
};
let mut nodes = Vec::with_capacity(proof.nodes().len());
for index in proof.nodes() {
let node = self.storage.get_node(*index)?;
nodes.push(node);
}
Ok(Proof {
nodes,
signature,
index,
})
}
pub fn digest(&mut self, index: usize) -> usize {
self.tree.digest(2 * index)
}
pub fn put(
&mut self,
index: usize,
data: Option<&[u8]>,
mut proof: Proof,
) -> Result<()> {
let mut next = 2 * index;
let mut trusted: Option<usize> = None;
let mut missing = vec![];
let mut i = match data {
Some(_) => 0,
None => 1,
};
loop {
if self.tree.get(next) {
trusted = Some(next);
break;
}
let sibling = flat::sibling(next);
next = flat::parent(next);
if i < proof.nodes.len() && proof.nodes[i].index == sibling {
i += 1;
continue;
}
if !self.tree.get(sibling) {
break;
}
missing.push(sibling);
}
if trusted.is_none() && self.tree.get(next) {
trusted = Some(next);
}
let mut missing_nodes = vec![];
for index in missing {
let node = self.storage.get_node(index)?;
missing_nodes.push(node);
}
let mut trusted_node = None;
if let Some(index) = trusted {
let node = self.storage.get_node(index)?;
trusted_node = Some(node);
}
let mut visited = vec![];
let mut top = match data {
Some(data) => Node::new(
2 * index,
Hash::from_leaf(&data).as_bytes().to_owned(),
data.len(),
),
None => proof.nodes.remove(0),
};
if verify_node(&trusted_node, &top) {
self.write(index, data, &visited, None)?;
return Ok(());
}
loop {
let node;
let next = flat::sibling(top.index);
if !proof.nodes.is_empty() && proof.nodes[0].index == next {
node = proof.nodes.remove(0);
visited.push(node.clone());
} else if !missing_nodes.is_empty() && missing_nodes[0].index == next {
node = missing_nodes.remove(0);
} else {
let nodes = self.verify_roots(&top, &mut proof)?;
visited.extend_from_slice(&nodes);
self.write(index, data, &visited, proof.signature)?;
return Ok(());
}
visited.push(top.clone());
let hash = Hash::from_hashes(&top, &node);
let len = top.len() + node.len();
top = Node::new(flat::parent(top.index), hash.as_bytes().into(), len);
if verify_node(&trusted_node, &top) {
self.write(index, data, &visited, None)?;
return Ok(());
}
}
fn verify_node(trusted: &Option<Node>, node: &Node) -> bool {
match trusted {
None => false,
Some(trusted) => {
trusted.index == node.index && trusted.hash == node.hash
}
}
}
}
fn write(
&mut self,
index: usize,
data: Option<&[u8]>,
nodes: &[Node],
sig: Option<Signature>,
) -> Result<()> {
for node in nodes {
self.storage.put_node(node)?;
}
if let Some(data) = data {
self.storage.put_data(index, data, &nodes)?;
}
if let Some(sig) = sig {
let sig = sig.borrow();
self.storage.put_signature(index, sig)?;
}
for node in nodes {
self.tree.set(node.index);
}
self.tree.set(2 * index);
if let Some(_data) = data {
if self.bitfield.set(index, true).is_changed() {
}
}
Ok(())
}
pub fn signature(&mut self, index: usize) -> Result<Signature> {
ensure!(
index < self.length,
format!("No signature found for index {}", index)
);
Ok(self.storage.next_signature(index)?)
}
pub fn verify(&mut self, index: usize, signature: &Signature) -> Result<()> {
let roots = self.root_hashes(index)?;
let roots: Vec<_> = roots.into_iter().map(Rc::new).collect();
let message = Hash::from_roots(&roots);
let message = message.as_bytes();
verify(&self.public_key, message, Some(signature))?;
Ok(())
}
pub fn announce(&mut self, message: &Message, from: &Peer) {
for peer in &mut self.peers {
if peer != from {
peer.have(message)
}
}
}
pub fn unannounce(&mut self, message: &Message) {
for peer in &mut self.peers {
peer.unhave(message)
}
}
pub fn root_hashes(&mut self, index: usize) -> Result<Vec<Node>> {
ensure!(
index <= self.length,
format!("Root index bounds exceeded {} > {}", index, self.length)
);
let roots_index = index * 2 + 2;
let mut indexes = vec![];
flat::full_roots(roots_index, &mut indexes);
let mut roots = Vec::with_capacity(indexes.len());
for index in indexes {
let node = self.storage.get_node(index)?;
roots.push(node);
}
Ok(roots)
}
pub fn public_key(&self) -> &PublicKey {
&self.public_key
}
pub fn secret_key(&self) -> &Option<SecretKey> {
&self.secret_key
}
fn verify_roots(
&mut self,
top: &Node,
proof: &mut Proof,
) -> Result<Vec<Node>> {
let last_node = if !proof.nodes.is_empty() {
proof.nodes[proof.nodes.len() - 1].index
} else {
top.index
};
let verified_by =
cmp::max(flat::right_span(top.index), flat::right_span(last_node)) + 2;
let mut indexes = vec![];
flat::full_roots(verified_by, &mut indexes);
let mut roots = Vec::with_capacity(indexes.len());
let mut extra_nodes = vec![];
for index in indexes {
if index == top.index {
extra_nodes.push(top.clone());
roots.push(top.clone());
} else if !proof.nodes.is_empty() && index == proof.nodes[0].index {
extra_nodes.push(proof.nodes[0].clone());
roots.push(proof.nodes.remove(0));
} else if self.tree.get(index) {
let node = self.storage.get_node(index)?;
roots.push(node);
} else {
bail!("<hypercore>: Missing tree roots needed for verify");
}
}
let checksum = Hash::from_roots(&roots);
verify(&self.public_key, checksum.as_bytes(), proof.signature())?;
let len = verified_by / 2;
if len > self.len() {
self.length = len;
self.byte_length = roots.iter().fold(0, |acc, root| acc + root.index)
}
Ok(extra_nodes)
}
pub fn download(&mut self, _range: Range<usize>) -> Result<()> {
unimplemented!();
}
pub fn undownload(&mut self, _range: Range<usize>) -> Result<()> {
unimplemented!();
}
pub fn finalize(&mut self) -> Result<()> {
unimplemented!();
}
pub fn update_peers(&mut self) {
for peer in &mut self.peers {
peer.update();
}
}
}
impl Feed<RandomAccessDiskMethods> {
pub fn new(dir: &PathBuf) -> Result<Self> {
let storage = Storage::new_disk(&dir)?;
let keypair = generate_keypair();
let feed = FeedBuilder::new(keypair.public, storage)
.secret_key(keypair.secret)
.build()?;
Ok(feed)
}
}
impl Default for Feed<RandomAccessMemoryMethods> {
fn default() -> Self {
let storage = Storage::new_memory().unwrap();
Self::with_storage(storage).unwrap()
}
}
impl<T: RandomAccessMethods + Debug> Display for Feed<T> {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
let key = pretty_fmt(&self.public_key.to_bytes()).unwrap();
let byte_len = self.byte_len();
let len = self.len();
let peers = 0;
write!(
f,
"Hypercore(key=[{}], length={}, byte_length={}, peers={})",
key, len, byte_len, peers
)
}
}