hypercore 0.8.1

Secure, distributed, append-only log
Documentation 
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

extern crate failure;
extern crate hypercore;
extern crate random_access_memory as ram;
extern crate random_access_storage;

mod common;

use self::failure::Error;
use self::random_access_storage::RandomAccess;
use common::create_feed;
use hypercore::{
  generate_keypair, Feed, NodeTrait, PublicKey, SecretKey, Storage,
};
use std::fmt::Debug;

#[test]
fn create_with_key() {
  let keypair = generate_keypair();
  let storage = Storage::new_memory().unwrap();
  let _feed = Feed::builder(keypair.public, storage)
    .secret_key(keypair.secret)
    .build()
    .unwrap();
}

#[test]
fn display() {
  let feed = create_feed(50).unwrap();
  let output = format!("{}", feed);
  assert_eq!(output.len(), 61);
}

#[test]
/// Verify `.append()` and `.get()` work.
fn set_get() {
  let mut feed = create_feed(50).unwrap();
  feed.append(b"hello").unwrap();
  feed.append(b"world").unwrap();

  assert_eq!(feed.get(0).unwrap(), Some(b"hello".to_vec()));
  assert_eq!(feed.get(1).unwrap(), Some(b"world".to_vec()));
}

#[test]
fn append() {
  let mut feed = create_feed(50).unwrap();
  feed.append(br#"{"hello":"world"}"#).unwrap();
  feed.append(br#"{"hello":"mundo"}"#).unwrap();
  feed.append(br#"{"hello":"welt"}"#).unwrap();

  assert_eq!(feed.len(), 3);
  assert_eq!(feed.byte_len(), 50);

  assert_eq!(feed.get(0).unwrap(), Some(br#"{"hello":"world"}"#.to_vec()));
  assert_eq!(feed.get(1).unwrap(), Some(br#"{"hello":"mundo"}"#.to_vec()));
  assert_eq!(feed.get(2).unwrap(), Some(br#"{"hello":"welt"}"#.to_vec()));
}

#[test]
/// Verify the `.root_hashes()` method returns the right nodes.
fn root_hashes() {
  // If no roots exist we should get an error.
  let mut feed = create_feed(50).unwrap();
  let res = feed.root_hashes(0);
  assert!(res.is_err());

  // If 1 entry exists, [0] should be the root.
  feed.append(b"data").unwrap();
  let roots = feed.root_hashes(0).unwrap();
  assert_eq!(roots.len(), 1);
  assert_eq!(roots[0].index(), 0);

  // If we query out of bounds, we should get an error.
  let res = feed.root_hashes(6);
  assert!(res.is_err());

  // If 3 entries exist, [2,4] should be the roots.
  feed.append(b"data").unwrap();
  feed.append(b"data").unwrap();
  let roots = feed.root_hashes(2).unwrap();
  assert_eq!(roots.len(), 2);
  assert_eq!(roots[0].index(), 1);
  assert_eq!(roots[1].index(), 4);
}

#[test]
fn verify() {
  let mut feed = create_feed(50).unwrap();
  let (public, secret) = copy_keys(&feed);
  let feed_bytes = secret.to_bytes().to_vec();
  let storage = Storage::new(|_| Ok(ram::RandomAccessMemory::new(50))).unwrap();
  let mut evil_feed = Feed::builder(public, storage)
    .secret_key(secret)
    .build()
    .unwrap();

  let evil_bytes = match &feed.secret_key() {
    Some(key) => key.to_bytes(),
    None => panic!("no secret key found"),
  };

  // Verify the keys are the same.
  assert_eq!(&feed_bytes, &evil_bytes.to_vec());

  // Verify that the signature on a single feed is correct.
  feed.append(b"test").unwrap();
  let sig = feed.signature(0).unwrap();
  feed.verify(0, &sig).unwrap();

  // Verify that the signature between two different feeds is different.
  evil_feed.append(b"t0st").unwrap();
  let res = evil_feed.verify(0, &sig);
  assert!(res.is_err());
}

#[test]
fn put() {
  let mut a = create_feed(50).unwrap();
  let (public, secret) = copy_keys(&a);
  let storage = Storage::new(|_| Ok(ram::RandomAccessMemory::new(50))).unwrap();
  let mut b = Feed::builder(public, storage)
    .secret_key(secret)
    .build()
    .unwrap();

  for _ in 0..10 {
    a.append(b"foo").unwrap();
  }

  let proof = a.proof(0, true).unwrap();
  b.put(0, None, proof).expect("no error");
  let proof = a
    .proof_with_digest(4, b.digest(4), true)
    .expect(".proof() index 4, digest 4");
  b.put(4, None, proof).unwrap();
}

#[test]
fn create_with_storage() {
  let storage = Storage::new_memory().unwrap();
  assert!(
    Feed::with_storage(storage).is_ok(),
    "Could not create a feed with a storage."
  );
}

#[test]
fn create_with_stored_public_key() {
  let mut storage = Storage::new_memory().unwrap();
  let keypair = generate_keypair();
  storage.write_public_key(&keypair.public).unwrap();
  assert!(
    Feed::with_storage(storage).is_ok(),
    "Could not create a feed with a stored public key."
  );
}

#[test]
fn create_with_stored_keys() {
  let mut storage = Storage::new_memory().unwrap();
  let keypair = generate_keypair();
  storage.write_public_key(&keypair.public).unwrap();
  storage.write_secret_key(&keypair.secret).unwrap();
  assert!(
    Feed::with_storage(storage).is_ok(),
    "Could not create a feed with a stored keypair."
  );
}

fn copy_keys(
  feed: &Feed<impl RandomAccess<Error = Error> + Debug>,
) -> (PublicKey, SecretKey) {
  match &feed.secret_key() {
    Some(secret) => {
      let secret = secret.to_bytes();
      let public = &feed.public_key().to_bytes();

      let public = PublicKey::from_bytes(public).unwrap();
      let secret = SecretKey::from_bytes(&secret).unwrap();

      return (public, secret);
    }
    _ => panic!("<tests/common>: Could not access secret key"),
  }
}