bsv-rs 0.3.18

BSV blockchain SDK for Rust - primitives, script, transactions, and more
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
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
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
//! Compat module integration tests.
//!
//! Tests full workflows for BIP-32, BIP-39, BSM, and ECIES modules.

#![cfg(feature = "compat")]

use bsv_rs::compat::base58;
use bsv_rs::compat::bip32::{
    generate_hd_key_from_mnemonic, ExtendedKey, Network, HARDENED_KEY_START,
};
use bsv_rs::compat::bip39::{Language, Mnemonic, WordCount};
use bsv_rs::compat::bsm;
use bsv_rs::compat::ecies;
use bsv_rs::primitives::{from_hex, PrivateKey};

// =================
// BIP-39 + BIP-32 Integration Tests
// =================

#[test]
fn test_full_hd_wallet_generation_flow() {
    // Generate a mnemonic
    let mnemonic = Mnemonic::new(WordCount::Words12).expect("Failed to generate mnemonic");

    // Verify word count
    assert_eq!(mnemonic.words().len(), 12);

    // Convert to seed
    let seed = mnemonic.to_seed("");
    assert_eq!(seed.len(), 64);

    // Generate master key
    let master =
        ExtendedKey::new_master(&seed, Network::Mainnet).expect("Failed to create master key");

    // Verify it's a private key
    assert!(master.is_private());
    assert!(master.to_string().starts_with("xprv"));

    // Derive BIP-44 path for BSV: m/44'/236'/0'/0/0
    let derived = master
        .derive_path("m/44'/236'/0'/0/0")
        .expect("Failed to derive path");

    // Get address
    let address = derived.address(true).expect("Failed to get address");
    assert!(address.starts_with('1')); // Mainnet P2PKH address
}

#[test]
fn test_mnemonic_to_hd_key_helper() {
    let mnemonic = Mnemonic::new(WordCount::Words24).expect("Failed to generate mnemonic");

    // Use the helper function
    let master = generate_hd_key_from_mnemonic(&mnemonic, "", Network::Mainnet)
        .expect("Failed to generate HD key from mnemonic");

    assert!(master.is_private());

    // Derive public extended key
    let xpub = master.neuter().expect("Failed to neuter");
    assert!(!xpub.is_private());
    assert!(xpub.to_string().starts_with("xpub"));
}

#[test]
fn test_testnet_hd_key_derivation() {
    let seed = [0u8; 32];
    let master =
        ExtendedKey::new_master(&seed, Network::Testnet).expect("Failed to create testnet master");

    assert!(master.to_string().starts_with("tprv"));

    let xpub = master.neuter().expect("Failed to neuter");
    assert!(xpub.to_string().starts_with("tpub"));

    // Testnet address
    let address = master
        .address(false)
        .expect("Failed to get testnet address");
    assert!(address.starts_with('m') || address.starts_with('n'));
}

#[test]
fn test_hardened_derivation() {
    let seed = [0u8; 32];
    let master = ExtendedKey::new_master(&seed, Network::Mainnet).unwrap();

    // Hardened derivation using index
    let child_0h = master.derive_child(HARDENED_KEY_START).unwrap();

    // Hardened derivation using path notation
    let child_0h_path = master.derive_path("m/0'").unwrap();

    // Should produce the same keys
    assert_eq!(
        child_0h.to_string(),
        child_0h_path.to_string(),
        "Hardened derivation mismatch"
    );
}

#[test]
fn test_public_key_derivation_only() {
    let seed = [0u8; 32];
    let master = ExtendedKey::new_master(&seed, Network::Mainnet).unwrap();

    // Get public master
    let xpub = master.neuter().unwrap();

    // Derive non-hardened children from public key
    let pub_child_0 = xpub.derive_child(0).unwrap();
    let priv_child_0 = master.derive_child(0).unwrap().neuter().unwrap();

    assert_eq!(
        pub_child_0.to_string(),
        priv_child_0.to_string(),
        "Public derivation should match private derivation result"
    );

    // Hardened derivation from public key should fail
    let result = xpub.derive_child(HARDENED_KEY_START);
    assert!(result.is_err(), "Hardened from public should fail");
}

#[test]
fn test_extended_key_serialization_roundtrip() {
    let seed = [0x42u8; 32];
    let master = ExtendedKey::new_master(&seed, Network::Mainnet).unwrap();

    // Serialize to string
    let xprv_str = master.to_string();

    // Parse back
    let parsed = ExtendedKey::from_string(&xprv_str).unwrap();

    // Should be identical
    assert_eq!(master.to_string(), parsed.to_string());
    assert_eq!(master.depth(), parsed.depth());
    assert_eq!(master.child_number(), parsed.child_number());
    assert_eq!(master.chain_code(), parsed.chain_code());
}

// =================
// Bitcoin Signed Message Tests
// =================

#[test]
fn test_bsm_sign_verify_roundtrip() {
    let key = PrivateKey::random();
    let address = key.public_key().to_address();
    let message = b"Hello, Bitcoin!";

    // Sign
    let signature = bsm::sign_message(&key, message).expect("Failed to sign");
    assert_eq!(signature.len(), 65);

    // Verify
    let valid = bsm::verify_message(&address, &signature, message).expect("Verification failed");
    assert!(valid, "Signature should be valid");
}

#[test]
fn test_bsm_compressed_and_uncompressed() {
    let key = PrivateKey::random();
    let message = b"Test message";

    // Compressed signature (default)
    let sig_compressed = bsm::sign_message_with_compression(&key, message, true).unwrap();
    let recovered_comp = bsm::recover_public_key_from_signature(&sig_compressed, message).unwrap();
    assert!(recovered_comp.1, "Should be compressed");

    // Uncompressed signature
    let sig_uncompressed = bsm::sign_message_with_compression(&key, message, false).unwrap();
    let recovered_uncomp =
        bsm::recover_public_key_from_signature(&sig_uncompressed, message).unwrap();
    assert!(!recovered_uncomp.1, "Should be uncompressed");

    // Both should recover to the same public key
    assert_eq!(
        recovered_comp.0.to_compressed(),
        recovered_uncomp.0.to_compressed(),
        "Recovered public keys should match"
    );
}

#[test]
fn test_bsm_different_messages_different_signatures() {
    let key = PrivateKey::random();
    let address = key.public_key().to_address();

    let message1 = b"Message 1";
    let message2 = b"Message 2";

    let sig1 = bsm::sign_message(&key, message1).unwrap();
    let sig2 = bsm::sign_message(&key, message2).unwrap();

    // Signatures should be different
    assert_ne!(sig1, sig2);

    // Cross-verify should fail
    let cross1 = bsm::verify_message(&address, &sig1, message2).unwrap();
    let cross2 = bsm::verify_message(&address, &sig2, message1).unwrap();
    assert!(!cross1, "Signature 1 should not verify message 2");
    assert!(!cross2, "Signature 2 should not verify message 1");
}

#[test]
fn test_bsm_public_key_recovery() {
    let key = PrivateKey::random();
    let original_pubkey = key.public_key();
    let message = b"Recover me";

    let signature = bsm::sign_message(&key, message).unwrap();
    let (recovered, _compressed) =
        bsm::recover_public_key_from_signature(&signature, message).unwrap();

    assert_eq!(
        recovered.to_compressed(),
        original_pubkey.to_compressed(),
        "Recovered public key should match original"
    );
}

#[test]
fn test_bsm_empty_and_long_messages() {
    let key = PrivateKey::random();
    let address = key.public_key().to_address();

    // Empty message
    let empty_sig = bsm::sign_message(&key, b"").unwrap();
    assert!(bsm::verify_message(&address, &empty_sig, b"").unwrap());

    // Long message (1KB)
    let long_message = vec![0x42u8; 1024];
    let long_sig = bsm::sign_message(&key, &long_message).unwrap();
    assert!(bsm::verify_message(&address, &long_sig, &long_message).unwrap());
}

// =================
// ECIES Encryption Tests
// =================

#[test]
fn test_electrum_ecies_roundtrip() {
    let alice = PrivateKey::random();
    let bob = PrivateKey::random();
    let message = b"Secret message from Alice to Bob";

    // Alice encrypts for Bob
    let encrypted = ecies::electrum_encrypt(message, &bob.public_key(), &alice, false)
        .expect("Encryption failed");

    // Encrypted should be larger than plaintext (has header, IV, MAC)
    assert!(encrypted.len() > message.len());
    assert!(encrypted.starts_with(b"BIE1"));

    // Bob decrypts
    let decrypted = ecies::electrum_decrypt(&encrypted, &bob, Some(&alice.public_key()))
        .expect("Decryption failed");

    assert_eq!(decrypted, message);
}

#[test]
fn test_electrum_ecies_no_key_mode() {
    let alice = PrivateKey::random();
    let bob = PrivateKey::random();
    let message = b"Anonymous message";

    // Encrypt with no_key = true (omits ephemeral public key from output)
    let encrypted = ecies::electrum_encrypt(message, &bob.public_key(), &alice, true)
        .expect("Encryption failed");

    // When no_key=true, the sender's public key is not embedded,
    // so Bob must know Alice's public key to decrypt
    let decrypted = ecies::electrum_decrypt(&encrypted, &bob, Some(&alice.public_key()))
        .expect("Decryption failed");

    assert_eq!(decrypted, message);

    // Verify that trying to decrypt without sender's key fails (no embedded key to extract)
    let result = ecies::electrum_decrypt(&encrypted, &bob, None);
    assert!(
        result.is_err(),
        "Should fail without sender's public key when no_key=true"
    );
}

#[test]
fn test_bitcore_ecies_roundtrip() {
    let alice = PrivateKey::random();
    let bob = PrivateKey::random();
    let message = b"Bitcore-style encrypted message";

    // Encrypt
    let encrypted = ecies::bitcore_encrypt(message, &bob.public_key(), &alice, None)
        .expect("Encryption failed");

    // Decrypt
    let decrypted = ecies::bitcore_decrypt(&encrypted, &bob).expect("Decryption failed");

    assert_eq!(decrypted, message);
}

#[test]
fn test_bitcore_ecies_with_fixed_iv() {
    let alice = PrivateKey::random();
    let bob = PrivateKey::random();
    let message = b"Deterministic encryption test";

    // Fixed IV for deterministic output
    let iv = [0x42u8; 16];

    // Encrypt twice with same IV
    let encrypted1 = ecies::bitcore_encrypt(message, &bob.public_key(), &alice, Some(&iv)).unwrap();
    let encrypted2 = ecies::bitcore_encrypt(message, &bob.public_key(), &alice, Some(&iv)).unwrap();

    // Should be identical
    assert_eq!(encrypted1, encrypted2);

    // Decrypt
    let decrypted = ecies::bitcore_decrypt(&encrypted1, &bob).unwrap();
    assert_eq!(decrypted, message);
}

#[test]
fn test_ecies_self_encryption() {
    let key = PrivateKey::random();
    let message = b"Self-encrypted message";

    // Encrypt to self
    let encrypted = ecies::encrypt_single(message, &key).expect("Self-encryption failed");

    // Decrypt
    let decrypted = ecies::decrypt_single(&encrypted, &key).expect("Self-decryption failed");

    assert_eq!(decrypted, message);
}

#[test]
fn test_ecies_wrong_key_fails() {
    let alice = PrivateKey::random();
    let bob = PrivateKey::random();
    let charlie = PrivateKey::random(); // Wrong key
    let message = b"This should not be readable by Charlie";

    // Alice encrypts for Bob
    let encrypted = ecies::electrum_encrypt(message, &bob.public_key(), &alice, false).unwrap();

    // Charlie tries to decrypt (should fail)
    let result = ecies::electrum_decrypt(&encrypted, &charlie, Some(&alice.public_key()));
    assert!(result.is_err(), "Decryption with wrong key should fail");
}

#[test]
fn test_ecies_empty_and_large_messages() {
    let alice = PrivateKey::random();
    let bob = PrivateKey::random();

    // Empty message
    let empty_encrypted = ecies::electrum_encrypt(b"", &bob.public_key(), &alice, false).unwrap();
    let empty_decrypted =
        ecies::electrum_decrypt(&empty_encrypted, &bob, Some(&alice.public_key())).unwrap();
    assert_eq!(empty_decrypted, b"");

    // Large message (64KB)
    let large_message = vec![0xAB_u8; 65536];
    let large_encrypted =
        ecies::bitcore_encrypt(&large_message, &bob.public_key(), &alice, None).unwrap();
    let large_decrypted = ecies::bitcore_decrypt(&large_encrypted, &bob).unwrap();
    assert_eq!(large_decrypted, large_message);
}

// =================
// Base58 Tests
// =================

#[test]
fn test_base58_roundtrip() {
    let test_data = vec![
        vec![0x00],
        vec![0x00, 0x00, 0x01],
        vec![0x00, 0x00, 0x00, 0x28, 0x7f, 0xb4, 0xcd],
        vec![0xFF; 32],
        (0..100).collect::<Vec<u8>>(),
    ];

    for data in test_data {
        let encoded = base58::encode(&data);
        let decoded = base58::decode(&encoded).expect("Decode failed");
        assert_eq!(
            decoded,
            data,
            "Roundtrip failed for data of length {}",
            data.len()
        );
    }
}

#[test]
fn test_base58_leading_zeros() {
    // Leading zeros should become leading '1's
    let data = [0x00, 0x00, 0x00, 0x01];
    let encoded = base58::encode(&data);
    assert!(
        encoded.starts_with("111"),
        "Expected leading 1s for leading zeros"
    );

    let decoded = base58::decode(&encoded).unwrap();
    assert_eq!(decoded, data);
}

#[test]
fn test_base58_known_values() {
    // Bitcoin genesis block hash
    let genesis_hash =
        from_hex("000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f").unwrap();
    let encoded = base58::encode(&genesis_hash);
    let decoded = base58::decode(&encoded).unwrap();
    assert_eq!(decoded, genesis_hash);
}

// =================
// Cross-Module Integration Tests
// =================

#[test]
fn test_mnemonic_to_signed_message() {
    // Generate mnemonic
    let mnemonic = Mnemonic::new(WordCount::Words12).unwrap();

    // Derive key
    let master = generate_hd_key_from_mnemonic(&mnemonic, "", Network::Mainnet).unwrap();
    let derived = master.derive_path("m/44'/0'/0'/0/0").unwrap();

    // Get private key and address
    let private_key = derived.private_key().unwrap();
    let address = derived.address(true).unwrap();

    // Sign message
    let message = b"Signed with HD key";
    let signature = bsm::sign_message(&private_key, message).unwrap();

    // Verify
    assert!(bsm::verify_message(&address, &signature, message).unwrap());
}

#[test]
fn test_mnemonic_to_ecies_encryption() {
    // Generate two mnemonics (Alice and Bob)
    let mnemonic_alice = Mnemonic::new(WordCount::Words12).unwrap();
    let mnemonic_bob = Mnemonic::new(WordCount::Words12).unwrap();

    // Derive keys
    let alice_master =
        generate_hd_key_from_mnemonic(&mnemonic_alice, "", Network::Mainnet).unwrap();
    let bob_master = generate_hd_key_from_mnemonic(&mnemonic_bob, "", Network::Mainnet).unwrap();

    let alice_key = alice_master
        .derive_path("m/44'/0'/0'/0/0")
        .unwrap()
        .private_key()
        .unwrap();
    let bob_key = bob_master
        .derive_path("m/44'/0'/0'/0/0")
        .unwrap()
        .private_key()
        .unwrap();

    // Alice encrypts for Bob
    let message = b"Secret from Alice to Bob using HD keys";
    let encrypted =
        ecies::electrum_encrypt(message, &bob_key.public_key(), &alice_key, false).unwrap();

    // Bob decrypts
    let decrypted =
        ecies::electrum_decrypt(&encrypted, &bob_key, Some(&alice_key.public_key())).unwrap();
    assert_eq!(decrypted, message);
}

// =================
// Error Handling Tests
// =================

#[test]
fn test_invalid_mnemonic_phrase() {
    // Invalid word
    let result = Mnemonic::from_phrase("invalid word here abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon about");
    assert!(result.is_err());

    // Wrong word count
    let result = Mnemonic::from_phrase("abandon abandon");
    assert!(result.is_err());

    // Invalid checksum
    let result = Mnemonic::from_phrase("abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon abandon");
    assert!(result.is_err());
}

#[test]
fn test_invalid_extended_key_string() {
    // Invalid prefix
    let result = ExtendedKey::from_string("invalid_xprv_string");
    assert!(result.is_err());

    // Wrong length
    let result = ExtendedKey::from_string("xprv123");
    assert!(result.is_err());

    // Bad checksum (last char changed from 'i' to 'j' to corrupt checksum)
    let result = ExtendedKey::from_string("xprv9s21ZrQH143K3QTDL4LXw2F7HEK3wJUD2nW2nRk4stbPy6cq3jPPqjiChkVvvNKmPGJxWUtg6LnF5kejMRNNU3TGtRBeJgk33yuGBxrMPHj");
    assert!(result.is_err());
}

#[test]
fn test_invalid_derivation_path() {
    let seed = [0u8; 32];
    let master = ExtendedKey::new_master(&seed, Network::Mainnet).unwrap();

    // Invalid format
    let result = master.derive_path("not/a/path");
    assert!(result.is_err());

    // Negative index (not supported)
    let result = master.derive_path("m/-1");
    assert!(result.is_err());
}

#[test]
fn test_invalid_bsm_signature() {
    let key = PrivateKey::random();
    let address = key.public_key().to_address();

    // Too short
    let result = bsm::verify_message(&address, &[0u8; 64], b"test");
    assert!(result.is_err());

    // Too long
    let result = bsm::verify_message(&address, &[0u8; 66], b"test");
    assert!(result.is_err());
}

#[test]
fn test_invalid_ecies_ciphertext() {
    let key = PrivateKey::random();

    // Electrum: wrong magic
    let result = ecies::electrum_decrypt(&[0u8; 100], &key, None);
    assert!(result.is_err());

    // Bitcore: too short
    let result = ecies::bitcore_decrypt(&[0u8; 32], &key);
    assert!(result.is_err());
}

// =================
// Vector Count Test
// =================

#[test]
fn test_word_count_enum() {
    assert_eq!(WordCount::Words12.word_count(), 12);
    assert_eq!(WordCount::Words15.word_count(), 15);
    assert_eq!(WordCount::Words18.word_count(), 18);
    assert_eq!(WordCount::Words21.word_count(), 21);
    assert_eq!(WordCount::Words24.word_count(), 24);

    assert_eq!(WordCount::Words12.entropy_bytes(), 16);
    assert_eq!(WordCount::Words24.entropy_bytes(), 32);
}

#[test]
fn test_language_enum() {
    // Currently only English is supported
    let lang = Language::English;
    assert!(matches!(lang, Language::English));
}

#[test]
fn test_network_enum() {
    // Test network discrimination
    let mainnet = Network::Mainnet;
    let testnet = Network::Testnet;

    // These should be different networks
    assert!(matches!(mainnet, Network::Mainnet));
    assert!(matches!(testnet, Network::Testnet));
}