veilid-core 0.5.3

Core library used to create a Veilid node and operate it as part of an application
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
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
use crate::tests_crypto::*;

use super::*;

use lazy_static::*;

lazy_static! {
    static ref BOGUS_KEY: RecordKey = RecordKey::new(
        TEST_CRYPTO_KIND,
        BareRecordKey::new(
            BareOpaqueRecordKey::new(&[0u8; 32]),
            Some(BareSharedSecret::new(&[1u8; 32]))
        )
    );
}

async fn test_get_dht_value_unopened(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let result = rc.get_dht_value(BOGUS_KEY.clone(), 0, false).await;
    assert_err!(result);
}

async fn test_open_dht_record_nonexistent_no_writer(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let result = rc.get_dht_value(BOGUS_KEY.clone(), 0, false).await;
    assert_err!(result);
}

async fn test_close_dht_record_nonexistent(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let result = rc.close_dht_record(BOGUS_KEY.clone()).await;
    assert_err!(result);
}

async fn test_delete_dht_record_nonexistent(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let result = rc.delete_dht_record(BOGUS_KEY.clone()).await;
    assert_err!(result);
}

async fn test_create_delete_dht_record_simple(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let rec = rc
        .create_dht_record(TEST_CRYPTO_KIND, DHTSchema::dflt(1).unwrap(), None)
        .await
        .unwrap();

    let dht_key = rec.key();
    rc.close_dht_record(dht_key.clone()).await.unwrap();
    rc.delete_dht_record(dht_key).await.unwrap();
}

async fn test_create_dht_record_with_owner(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let crypto = api.crypto().unwrap();
    let cs = crypto.get(TEST_CRYPTO_KIND).unwrap();
    let owner_keypair = cs.generate_keypair();

    let rec = rc
        .create_dht_record(
            TEST_CRYPTO_KIND,
            DHTSchema::dflt(1).unwrap(),
            Some(owner_keypair.clone()),
        )
        .await
        .unwrap();

    assert_eq!(rec.ref_owner(), &owner_keypair.key());

    let dht_key = rec.key();
    rc.close_dht_record(dht_key.clone()).await.unwrap();
    rc.delete_dht_record(dht_key.clone()).await.unwrap();
}

async fn test_get_dht_record_key(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let crypto = api.crypto().unwrap();
    let cs = crypto.get(TEST_CRYPTO_KIND).unwrap();
    let owner_keypair = cs.generate_keypair();
    let schema = DHTSchema::dflt(1).unwrap();

    // create the record normally
    let rec = rc
        .create_dht_record(
            TEST_CRYPTO_KIND,
            schema.clone(),
            Some(owner_keypair.clone()),
        )
        .await
        .unwrap();

    // recreate the record key from the metadata alone
    let key = api
        .get_dht_record_key(
            schema.clone(),
            owner_keypair.key(),
            rec.key().encryption_key(),
        )
        .await
        .unwrap();

    // keys should be the same
    assert_eq!(key, rec.key());

    let dht_key = rec.key();
    rc.close_dht_record(dht_key.clone()).await.unwrap();
    rc.delete_dht_record(dht_key).await.unwrap();
}

async fn test_get_dht_value_nonexistent(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let rec = rc
        .create_dht_record(TEST_CRYPTO_KIND, DHTSchema::dflt(1).unwrap(), None)
        .await
        .unwrap();
    let dht_key = rec.key();
    let result = rc.get_dht_value(dht_key.clone(), 0, false).await;
    assert_eq!(result.expect("should not be error"), None);

    rc.close_dht_record(dht_key.clone()).await.unwrap();
    rc.delete_dht_record(dht_key).await.unwrap();
}

async fn test_set_get_dht_value(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let rec = rc
        .create_dht_record(TEST_CRYPTO_KIND, DHTSchema::dflt(2).unwrap(), None)
        .await
        .unwrap();
    let dht_key = rec.key();

    let test_value = String::from("BLAH BLAH BLAH").as_bytes().to_vec();
    // convert string to byte array
    let set_dht_value_result = rc
        .set_dht_value(dht_key.clone(), 0, test_value.clone(), None)
        .await;
    assert_eq!(set_dht_value_result.expect("should be Ok(None)"), None);

    let get_dht_value_result_0_non_force = rc.get_dht_value(dht_key.clone(), 0, false).await;
    assert_eq!(
        get_dht_value_result_0_non_force
            .expect("should not be error")
            .expect("should hold a value")
            .data(),
        test_value.clone()
    );

    // works in python, fails in rust
    let get_dht_value_result_0_force = rc.get_dht_value(dht_key.clone(), 0, true).await;
    assert_eq!(
        get_dht_value_result_0_force
            .expect("should not be error")
            .expect("should hold a value")
            .data(),
        test_value.clone()
    );

    let get_dht_value_result_1_non_force = rc.get_dht_value(dht_key.clone(), 1, false).await;
    assert_eq!(
        get_dht_value_result_1_non_force.expect("should not be error"),
        None
    );

    // assert_eq!(
    //     get_dht_value_result_0_non_force.expect("should hold value"),
    //     get_dht_value_result_1_non_force.expect("should hold value")
    // );

    rc.close_dht_record(dht_key.clone()).await.unwrap();
    rc.delete_dht_record(dht_key).await.unwrap();
}

async fn test_open_writer_dht_value(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    let rec = rc
        .create_dht_record(TEST_CRYPTO_KIND, DHTSchema::dflt(2).unwrap(), None)
        .await
        .unwrap();
    let key = rec.key();
    let owner = rec.owner();
    let secret = rec.owner_secret().unwrap();
    let keypair = KeyPair::new_from_parts(owner.clone(), secret.value());

    let test_value_1 = String::from("Qwertyuiop Asdfghjkl Zxcvbnm")
        .as_bytes()
        .to_vec();
    let test_data_2 = String::from("1234567890").as_bytes().to_vec();
    let test_data_3 = String::from("!@#$%^&*()").as_bytes().to_vec();

    // Scenario 1
    // 1. Write test data 1 to subkey 1,
    // 2. Read data from subkey 1, without force_refresh, check data, sequence and owner
    // 3. Read data from subkey 0, should return an error
    // 4. Write test data to subkey 0
    // 5. Read data from subkey 0 with force_refresh, check data
    // 6. Read data from subkey 1 with force_refresh, check data
    // 7. Overwrite value 1 twice, check that there's no errors
    let set_dht_test_value_1_result = rc
        .set_dht_value(key.clone(), 1, test_value_1.clone(), None)
        .await;
    assert!(set_dht_test_value_1_result.is_ok());

    let get_dht_value_result_1_non_force = rc.get_dht_value(key.clone(), 1, false).await;
    assert!(get_dht_value_result_1_non_force.is_ok());
    let get_dht_value_result_1_non_force = get_dht_value_result_1_non_force
        .unwrap()
        .expect("should hold value");
    assert_eq!(get_dht_value_result_1_non_force.data(), test_value_1);
    assert_eq!(get_dht_value_result_1_non_force.seq(), 0.into());
    assert_eq!(get_dht_value_result_1_non_force.writer(), owner);

    let get_dht_value_result_0_non_force = rc.get_dht_value(key.clone(), 0, false).await;
    assert_eq!(
        get_dht_value_result_0_non_force.expect("should not be error"),
        None
    );

    let set_dht_test_value_0_result = rc
        .set_dht_value(key.clone(), 0, test_data_2.clone(), None)
        .await;
    assert!(set_dht_test_value_0_result.is_ok());

    let get_dht_value_result_0_force = rc.get_dht_value(key.clone(), 0, true).await;
    assert_eq!(
        get_dht_value_result_0_force
            .expect("should be OK(result)")
            .expect("should hold value")
            .data(),
        test_data_2
    );

    let get_dht_value_result_1_force = rc.get_dht_value(key.clone(), 1, true).await;
    assert_eq!(
        get_dht_value_result_1_force
            .expect("should be OK(result)")
            .expect("should hold value")
            .data(),
        test_value_1
    );

    let overwrite_value_1_result_1 = rc
        .set_dht_value(key.clone(), 1, test_value_1.clone(), None)
        .await;
    assert!(overwrite_value_1_result_1.is_ok());

    let overwrite_value_1_result_2 = rc
        .set_dht_value(key.clone(), 1, test_data_2.clone(), None)
        .await;
    assert!(overwrite_value_1_result_2.is_ok());

    // Now that we initialized some subkeys
    // and verified they stored correctly
    // Delete things locally and reopen and see if we can write
    // with the same writer key

    rc.close_dht_record(key.clone()).await.unwrap();
    rc.delete_dht_record(key.clone()).await.unwrap();

    // Scenario 2
    // 1. Open DHT record with existing keys
    // 2. Check record key, owner, record secret and schema against original values
    // 3. Write test data 3 to subkey 1, without updating a value check that it still
    //    holds test data 2, but sequence has incremented, check owner
    // 4. Check that subkey 1 can be overwritten
    // 5. Read data from subkey 1 with force_refresh, check data

    let rec = rc.open_dht_record(key.clone(), Some(keypair.clone())).await;
    assert!(rec.is_ok());
    let rec = rec.unwrap();
    assert_eq!(rec.ref_key().value(), key.value());
    assert_eq!(rec.ref_key().kind(), key.kind());
    assert_eq!(rec.owner(), owner);
    assert_eq!(rec.owner_secret().unwrap(), secret);
    assert_eq!(rec.ref_schema(), &DHTSchema::dflt(2).unwrap());

    //Verify subkey 1 can be set before it is get but newer is available online
    let set_dht_test_value_1_result = rc
        .set_dht_value(key.clone(), 1, test_data_3.clone(), None)
        .await;
    assert!(set_dht_test_value_1_result.is_ok());
    let vdtemp = set_dht_test_value_1_result.unwrap().unwrap();
    assert_eq!(vdtemp.data(), test_data_2);
    assert_eq!(vdtemp.seq(), 1.into());
    assert_eq!(vdtemp.writer(), owner);

    // Verify subkey 1 can be set a second time and it updates because seq is newer
    let set_dht_test_value_1_result = rc
        .set_dht_value(key.clone(), 1, test_data_3.clone(), None)
        .await;
    assert!(set_dht_test_value_1_result.is_ok());

    // Verify the network got the subkey update with a refresh check
    let get_dht_value_result_1_force = rc.get_dht_value(key.clone(), 1, true).await;
    assert!(get_dht_value_result_1_force.is_ok());
    let get_dht_value_result_1_force = get_dht_value_result_1_force
        .expect("should be OK(result)")
        .expect("should hold value");
    assert_eq!(get_dht_value_result_1_force.data(), test_data_3);
    assert_eq!(get_dht_value_result_1_force.seq(), 2.into());
    assert_eq!(get_dht_value_result_1_force.writer(), owner);

    // Delete things locally and reopen and see if we can write
    // with a different writer key (should fail)
    rc.close_dht_record(key.clone()).await.unwrap();
    rc.delete_dht_record(key.clone()).await.unwrap();

    // Scenario 3
    // 1. Open DHT record with new keypair
    // 2. Check record key, owner, record secret and schema against original values
    // 3. Try writing to subkey 1, expect error
    // 4. Try writing to subkey 0, expect error

    let crypto = api.crypto().unwrap();
    let cs = crypto.get(key.kind()).unwrap();
    assert!(cs
        .validate_keypair(&owner, &secret)
        .expect("should succeed"));
    let other_keypair = cs.generate_keypair();

    let rec = rc.open_dht_record(key.clone(), Some(other_keypair)).await;
    assert!(rec.is_ok());
    let rec = rec.unwrap();
    assert_eq!(rec.ref_key().value(), key.value());
    assert_eq!(rec.ref_key().kind(), key.kind());
    assert_eq!(rec.owner(), owner);
    assert_eq!(rec.owner_secret(), None);
    assert_eq!(rec.ref_schema(), &DHTSchema::dflt(2).unwrap());

    // Verify subkey 1 can NOT be set because we have the wrong writer
    let set_dht_test_value_0_result = rc
        .set_dht_value(key.clone(), 1, test_value_1.clone(), None)
        .await;
    assert_err!(set_dht_test_value_0_result);

    // Verify subkey 0 can NOT be set because we have the wrong writer
    let set_dht_test_value_0_result = rc
        .set_dht_value(key.clone(), 0, test_value_1.clone(), None)
        .await;
    assert_err!(set_dht_test_value_0_result);

    // Verify subkey 0 can be set because we have overridden with the correct writer
    let set_dht_test_value_0_result = rc
        .set_dht_value(
            key.clone(),
            0,
            test_value_1.clone(),
            Some(SetDHTValueOptions {
                writer: Some(keypair),
                allow_offline: None,
            }),
        )
        .await;
    assert!(set_dht_test_value_0_result.is_ok());

    rc.close_dht_record(key.clone()).await.unwrap();
    rc.delete_dht_record(key).await.unwrap();
}

pub async fn test_set_dht_value_allow_offline(api: VeilidAPI) {
    let rc = api.routing_context().unwrap();

    // Create a DHT record
    let rec = rc
        .create_dht_record(CRYPTO_KIND_VLD0, DHTSchema::dflt(1).unwrap(), None)
        .await
        .unwrap();
    let dht_key = rec.key();

    let test_value = String::from("Test offline value").as_bytes().to_vec();

    // Test 1: Default behavior (options = None) should allow offline writes
    let set_result = rc
        .set_dht_value(dht_key.clone(), 0, test_value.clone(), None)
        .await;
    assert!(set_result.is_ok());

    // Test 2: Default behavior (allow_offline = None) should allow offline writes
    let set_result = rc
        .set_dht_value(
            dht_key.clone(),
            0,
            test_value.clone(),
            Some(SetDHTValueOptions {
                writer: None,
                allow_offline: None,
            }),
        )
        .await;
    assert!(set_result.is_ok());

    // Test 3: Explicitly allow offline writes
    let set_result = rc
        .set_dht_value(
            dht_key.clone(),
            1,
            test_value.clone(),
            Some(SetDHTValueOptions {
                writer: None,
                allow_offline: Some(AllowOffline(true)),
            }),
        )
        .await;
    assert!(set_result.is_ok());

    // Test 4: Disallow offline writes
    let set_result = rc
        .set_dht_value(
            dht_key.clone(),
            2,
            test_value.clone(),
            Some(SetDHTValueOptions {
                writer: None,
                allow_offline: Some(AllowOffline(false)),
            }),
        )
        .await;
    assert!(set_result.is_err());
    assert!(set_result.unwrap_err().to_string().contains("offline"));

    rc.close_dht_record(dht_key.clone()).await.unwrap();
    rc.delete_dht_record(dht_key).await.unwrap();
}

pub async fn test_all() {
    let (update_callback, config) = fixture_veilid_core();
    let api = api_startup(update_callback, config)
        .await
        .expect("startup failed");

    let _ = api.attach().await;
    fixture_wait_for_public_internet_ready(&api).await;

    test_get_dht_value_unopened(api.clone()).await;
    test_open_dht_record_nonexistent_no_writer(api.clone()).await;
    test_close_dht_record_nonexistent(api.clone()).await;
    test_delete_dht_record_nonexistent(api.clone()).await;
    test_get_dht_value_nonexistent(api.clone()).await;
    test_create_delete_dht_record_simple(api.clone()).await;
    test_create_dht_record_with_owner(api.clone()).await;
    test_get_dht_record_key(api.clone()).await;
    test_set_get_dht_value(api.clone()).await;
    test_open_writer_dht_value(api.clone()).await;
    test_set_dht_value_allow_offline(api.clone()).await;

    api.shutdown().await;
}