gadget-sdk 0.6.2

SDK for building Blueprints and gadget on Tangle Network
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
#![allow(dead_code, unused_imports)]
use crate::keystore::backend::fs::FilesystemKeystore;
use crate::keystore::backend::mem::InMemoryKeystore;
use crate::keystore::Backend;
use crate::keystore::KeystoreUriSanitizer;
use parking_lot::RawRwLock;
use std::path::PathBuf;

const KEYSTORE_PATH: &str = "./test_keys";

fn setup_mem_test_keystore() -> InMemoryKeystore<RawRwLock> {
    InMemoryKeystore::new()
}

fn setup_fs_test_keystore(key_type: &str) -> (FilesystemKeystore, String) {
    let key_path = format!("{KEYSTORE_PATH}-{key_type}");
    (
        FilesystemKeystore::open(key_path.clone()).unwrap(),
        key_path,
    )
}

#[test]
fn test_sanitize_file_paths() {
    let path = "file:///tmp/keystore";
    let sanitized_path = path.sanitize_file_path();
    assert_eq!(sanitized_path, PathBuf::from("/tmp/keystore"));
}

#[test]
fn test_sanitize_file_paths_with_single_slash() {
    let path = "file:/tmp/keystore";
    let sanitized_path = path.sanitize_file_path();
    assert_eq!(sanitized_path, PathBuf::from("/tmp/keystore"));
}

#[test]
fn test_sanitize_file_paths_with_double_slash() {
    let path = "file://tmp/keystore";
    let sanitized_path = path.sanitize_file_path();
    assert_eq!(sanitized_path, PathBuf::from("/tmp/keystore"));
}

#[test]
fn test_sanitize_file_paths_with_no_scheme() {
    let path = "/tmp/keystore";
    let sanitized_path = path.sanitize_file_path();
    assert_eq!(sanitized_path, PathBuf::from("/tmp/keystore"));
}

mod sr25519 {
    use super::*;
    use crate::keystore::sr25519::SIGNING_CTX;
    use crate::keystore::BackendExt;
    use schnorrkel::Keypair;
    use sp_core::Pair;

    #[test]
    #[cfg(all(feature = "getrandom", feature = "std"))]
    fn keys() {
        // In-Memory
        let mem_keystore = setup_mem_test_keystore();
        let mem_public = mem_keystore
            .sr25519_generate_new(None)
            .expect("Should generate key");
        // Read back the key from in-memory storage
        let mem_read = mem_keystore.sr25519_key().expect("Should read keys");
        assert_eq!(
            mem_public.to_bytes(),
            mem_read.public().0,
            "In-memory key should not be mutated in storage"
        );

        // Filesystem
        let (fs_keystore, path) = setup_fs_test_keystore("sr25519");
        let fs_public = fs_keystore
            .sr25519_generate_new(None)
            .expect("Should generate key");
        // Read back the key from filesystem storage
        let fs_read = fs_keystore.sr25519_key().expect("Should read keys");
        assert_eq!(
            fs_public.to_bytes(),
            fs_read.public().0,
            "Filesystem key should not be mutated in storage"
        );

        // Clean up filesystem keystore
        std::fs::remove_dir_all(path).expect("Failed to clean up test directory");
    }

    #[test]
    #[cfg(feature = "getrandom")]
    fn signature() {
        let keystore = setup_mem_test_keystore();
        let public = keystore
            .sr25519_generate_new(None)
            .expect("Should generate key");
        let secret = keystore.expose_sr25519_secret(&public).unwrap().unwrap();
        let pair = Keypair { secret, public };
        let msg = b"test message";
        let sig = keystore
            .sr25519_sign(&public, msg)
            .expect("Should sign")
            .expect("Should have signature");
        let ctx = schnorrkel::signing_context(SIGNING_CTX);

        // Verify with correct message
        assert!(pair.public.verify(ctx.bytes(msg), &sig).is_ok());
        // Try to verify with wrong message
        let wrong_msg = b"wrong message";
        assert!(pair.public.verify(ctx.bytes(wrong_msg), &sig).is_err());
    }
}

mod ed25519 {
    use super::*;
    use crate::keystore::ed25519::Public;
    use crate::keystore::BackendExt;
    use sp_core::Pair;

    #[test]
    #[cfg(all(feature = "getrandom", feature = "std"))]
    fn keys() {
        // In-Memory
        let mem_keystore = setup_mem_test_keystore();
        let mem_public = mem_keystore
            .ed25519_generate_new(None)
            .expect("Should generate key");
        // Read back the key from in-memory storage
        let mem_read = mem_keystore.ed25519_key().expect("Should read keys");
        assert_eq!(
            mem_public.as_ref(),
            mem_read.public().0.as_ref(),
            "In-memory key should not be mutated in storage"
        );

        // Filesystem
        let (fs_keystore, path) = setup_fs_test_keystore("ed25519");
        let fs_public = fs_keystore
            .ed25519_generate_new(None)
            .expect("Should generate key");
        // Read back the key from filesystem storage
        let fs_read = fs_keystore.ed25519_key().expect("Should read keys");
        assert_eq!(
            fs_public.as_ref(),
            fs_read.public().0.as_ref(),
            "Filesystem key should not be mutated in storage"
        );

        // Clean up filesystem keystore
        std::fs::remove_dir_all(path).expect("Failed to clean up test directory");
    }

    #[test]
    #[cfg(feature = "getrandom")]
    fn signature() {
        let keystore = setup_mem_test_keystore();
        let public = keystore
            .ed25519_generate_new(None)
            .expect("Should generate key");
        let secret = keystore.expose_ed25519_secret(&public).unwrap().unwrap();
        let verification_key = Public::from(&secret);
        let msg = b"test message";
        let sig = keystore
            .ed25519_sign(&public, msg)
            .expect("Should sign")
            .expect("Should have signature");

        // Verify with correct message
        assert!(verification_key.verify(&sig, msg).is_ok());

        // Try to verify with wrong message
        let wrong_msg = b"wrong message";
        assert!(verification_key.verify(&sig, wrong_msg).is_err());
    }
}

mod ecdsa {
    use super::*;
    use crate::keystore::BackendExt;
    use k256::ecdsa::signature::Verifier;
    use sp_core::Pair;

    #[test]
    #[cfg(all(feature = "getrandom", feature = "std"))]
    fn alloy_key() {
        let private_key = "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80";
        // In-Memory
        let mem_keystore = setup_mem_test_keystore();
        let mem_public = mem_keystore
            .ecdsa_generate_from_string(private_key)
            .expect("Should generate key");
        let read_secret = mem_keystore.get_ecdsa_signer_string(&mem_public).unwrap();
        assert_eq!(
            private_key, read_secret,
            "Private Key string should not be mutated in storage"
        );

        // Read back the key from in-memory storage
        let mem_read = mem_keystore.ecdsa_key().expect("Should read keys");
        assert_eq!(
            mem_public.to_sec1_bytes().as_ref(),
            mem_read.public().0,
            "In-memory key should not be mutated in storage"
        );

        // Filesystem
        let (fs_keystore, path) = setup_fs_test_keystore("ecdsa");
        let fs_public = fs_keystore
            .ecdsa_generate_from_string(private_key)
            .expect("Should generate key");
        let read_secret = fs_keystore.get_ecdsa_signer_string(&fs_public).unwrap();
        assert_eq!(
            private_key, read_secret,
            "Private Key string should not be mutated in storage"
        );

        // Read back the key from filesystem storage
        let fs_read = fs_keystore.ecdsa_key().expect("Should read keys");
        assert_eq!(
            fs_public.to_sec1_bytes().as_ref(),
            fs_read.public().0,
            "Filesystem key should not be mutated in storage"
        );

        // Clean up filesystem keystore
        std::fs::remove_dir_all(path).expect("Failed to clean up test directory");
    }

    #[test]
    #[cfg(all(feature = "getrandom", feature = "std"))]
    fn keys() {
        // In-Memory
        let mem_keystore = setup_mem_test_keystore();
        let mem_public = mem_keystore
            .ecdsa_generate_new(None)
            .expect("Should generate key");
        // Read back the key from in-memory storage
        let mem_read = mem_keystore.ecdsa_key().expect("Should read keys");
        assert_eq!(
            mem_public.to_sec1_bytes().as_ref(),
            mem_read.public().0,
            "In-memory key should not be mutated in storage"
        );

        // Filesystem
        let (fs_keystore, path) = setup_fs_test_keystore("ecdsa");
        let fs_public = fs_keystore
            .ecdsa_generate_new(None)
            .expect("Should generate key");
        // Read back the key from filesystem storage
        let fs_read = fs_keystore.ecdsa_key().expect("Should read keys");
        assert_eq!(
            fs_public.to_sec1_bytes().as_ref(),
            fs_read.public().0,
            "Filesystem key should not be mutated in storage"
        );

        // Clean up filesystem keystore
        std::fs::remove_dir_all(path).expect("Failed to clean up test directory");
    }

    #[test]
    #[cfg(feature = "getrandom")]
    fn signature() {
        let keystore = setup_mem_test_keystore();
        let public = keystore
            .ecdsa_generate_new(None)
            .expect("Should generate key");
        let msg = b"test message";
        let sig = keystore
            .ecdsa_sign(&public, msg)
            .expect("Should sign")
            .expect("Should have signature");

        // Convert public key to k256::ecdsa::VerifyingKey
        let verifying_key =
            k256::ecdsa::VerifyingKey::from_sec1_bytes(public.to_sec1_bytes().as_ref())
                .expect("Should create verifying key");

        // Verify with correct message
        assert!(
            verifying_key.verify(msg, &sig).is_ok(),
            "Signature verification failed"
        );

        // Try to verify with wrong message
        let wrong_msg = b"wrong message";
        assert!(
            verifying_key.verify(wrong_msg, &sig).is_err(),
            "Signature should not verify with wrong message"
        );

        // Try to verify with wrong public key
        let wrong_public = keystore
            .ecdsa_generate_new(None)
            .expect("Should generate key");
        let wrong_verifying_key =
            k256::ecdsa::VerifyingKey::from_sec1_bytes(wrong_public.to_sec1_bytes().as_ref())
                .expect("Should create wrong verifying key");
        assert!(
            wrong_verifying_key.verify(msg, &sig).is_err(),
            "Signature should not verify with wrong public key"
        );
    }
}

mod bls381 {
    use super::*;

    #[test]
    #[cfg(all(feature = "getrandom", feature = "std"))]
    fn keys() {
        // In-Memory
        let mem_keystore = setup_mem_test_keystore();
        let mem_public = mem_keystore
            .bls381_generate_new(None)
            .expect("Should generate key");
        // Read back the key from in-memory storage
        let mem_read = mem_keystore.iter_bls381().next().unwrap();
        assert_eq!(
            mem_public.0, mem_read.0,
            "In-memory key should not be mutated in storage"
        );

        // Filesystem
        let (fs_keystore, path) = setup_fs_test_keystore("bls381");
        let fs_public = fs_keystore
            .bls381_generate_new(None)
            .expect("Should generate key");
        // Read back the key from filesystem storage
        let fs_read = fs_keystore.iter_bls381().next().unwrap();
        assert_eq!(
            fs_public.0, fs_read.0,
            "Filesystem key should not be mutated in storage"
        );

        // Clean up filesystem keystore
        std::fs::remove_dir_all(path).expect("Failed to clean up test directory");
    }

    #[test]
    #[cfg(feature = "getrandom")]
    fn signature() {
        let keystore = setup_mem_test_keystore();
        let public = keystore
            .bls381_generate_new(None)
            .expect("Should generate key");
        let msg = b"test message";
        let sig = keystore
            .bls381_sign(&public, msg)
            .expect("Should sign")
            .expect("Should have signature");

        // Verify with correct message
        assert!(
            sig.verify(&w3f_bls::Message::from(msg.as_slice()), &public),
            "Signature verification failed"
        );

        // Try to verify with wrong message
        let wrong_msg = b"wrong message";
        assert!(
            !sig.verify(&w3f_bls::Message::from(wrong_msg.as_slice()), &public),
            "Signature should not verify with wrong message"
        );

        // Try to verify with wrong public key
        let wrong_public = keystore
            .bls381_generate_new(None)
            .expect("Should generate key");
        assert!(
            !sig.verify(&w3f_bls::Message::from(msg.as_slice()), &wrong_public),
            "Signature should not verify with wrong public key"
        );
    }
}

mod bn254 {
    use super::*;
    use crate::keystore::BackendExt;
    use eigensdk::crypto_bn254::utils::verify_message;

    #[test]
    #[cfg(all(feature = "getrandom", feature = "std"))]
    fn keys() {
        // In-Memory
        let mem_keystore = setup_mem_test_keystore();
        let mem_public = mem_keystore
            .bls_bn254_generate_new(None)
            .expect("Should generate key");
        // Read back the key from in-memory storage
        let mem_read = mem_keystore.bls_bn254_key().expect("Should read keys");
        assert_eq!(
            mem_public,
            mem_read.public_key(),
            "In-memory key should not be mutated in storage"
        );

        // Filesystem
        let (fs_keystore, path) = setup_fs_test_keystore("bn254");
        let fs_public = fs_keystore
            .bls_bn254_generate_new(None)
            .expect("Should generate key");
        // Read back the key from filesystem storage
        let fs_read = fs_keystore.bls_bn254_key().expect("Should read keys");
        assert_eq!(
            fs_public,
            fs_read.public_key(),
            "Filesystem key should not be mutated in storage"
        );

        // Clean up filesystem keystore
        std::fs::remove_dir_all(path).expect("Failed to clean up test directory");
    }

    #[test]
    #[cfg(feature = "getrandom")]
    fn signature() {
        let keystore = setup_mem_test_keystore();
        let public = keystore
            .bls_bn254_generate_new(None)
            .expect("Should generate key");
        let msg: &[u8; 32] = b"testing messages testing message";
        let sig = keystore
            .bls_bn254_sign(&public, msg)
            .expect("Should sign")
            .expect("Should have signature");
        let pair = keystore.bls_bn254_key().unwrap();

        assert_eq!(public.g1(), pair.public_key().g1());

        // Verify with correct message
        assert!(
            verify_message(pair.public_key_g2().g2(), msg, sig),
            "Signature verification failed"
        );

        // Try to verify with wrong message
        let wrong_msg = b"wrong message";
        assert!(
            !verify_message(pair.public_key_g2().g2(), wrong_msg, sig),
            "Signature should not verify with wrong message"
        );
    }
}