rialo-types 0.5.0-alpha.0

Rialo Types
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

// Copyright (c) Subzero Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

//! Test helpers for admin types (`test_keys`, `test_records`).
//!
//! Submodules use `#[cfg(any(test, feature = "testing"))]`, matching [`crate::admin`]. Dependent
//! crates enable `rialo-types`'s `testing` feature (see `Cargo.toml`); this crate's lib tests rely
//! on `cfg(test)` only.

use crate::consensus_crypto::{AuthorityPublicKey, NetworkPublicKey, ProtocolPublicKey};

#[cfg(any(test, feature = "testing"))]
pub mod test_keys {
    use fastcrypto::{ed25519, traits::KeyPair};
    use rand::SeedableRng;

    use super::*;

    /// Helper to create test keys with a given seed for deterministic tests.
    pub fn create_test_keys(
        seed: u64,
    ) -> (AuthorityPublicKey, ProtocolPublicKey, NetworkPublicKey) {
        let mut rng = rand::rngs::StdRng::seed_from_u64(seed);
        let authority_key = AuthorityPublicKey::new(
            fastcrypto::bls12381::min_sig::BLS12381KeyPair::generate(&mut rng)
                .public()
                .clone(),
        );
        let protocol_key =
            ProtocolPublicKey::new(ed25519::Ed25519KeyPair::generate(&mut rng).public().clone());
        let network_key =
            NetworkPublicKey::new(ed25519::Ed25519KeyPair::generate(&mut rng).public().clone());
        (authority_key, protocol_key, network_key)
    }

    pub fn create_test_keys_with_keypair(
        seed: u64,
    ) -> (AuthorityPublicKey, crate::ProtocolKeyPair, NetworkPublicKey) {
        let mut rng = rand::rngs::StdRng::seed_from_u64(seed);
        let authority_key = AuthorityPublicKey::new(
            fastcrypto::bls12381::min_sig::BLS12381KeyPair::generate(&mut rng)
                .public()
                .clone(),
        );
        let protocol_keypair =
            crate::ProtocolKeyPair::new(ed25519::Ed25519KeyPair::generate(&mut rng));
        let network_key =
            NetworkPublicKey::new(ed25519::Ed25519KeyPair::generate(&mut rng).public().clone());
        (authority_key, protocol_keypair, network_key)
    }
}

#[cfg(any(test, feature = "testing"))]
pub mod test_records {
    use crate::admin::{
        epoch::{EpochChangeConfig, EpochIdentifier},
        handover::HandoverRecord,
        snapshot::SnapshotRecord,
        BLAKE3_HASH_SIZE,
    };

    pub fn create_test_handover_record(
        block_index: u64,
        source: u64,
        dest: u64,
        previous_hash: crate::admin::Blake3Hash,
    ) -> HandoverRecord {
        HandoverRecord::new(
            block_index,
            EpochIdentifier::new(source),
            EpochIdentifier::new(dest),
            EpochChangeConfig {
                current_epoch: EpochIdentifier::new(source),
                new_epoch: EpochIdentifier::new(dest),
                validators: vec![],
                consensus_config: None,
            },
            previous_hash,
        )
    }

    pub fn create_test_snapshot_record(block_height: u64, epoch: u64) -> SnapshotRecord {
        SnapshotRecord::new(
            block_height,
            EpochIdentifier::new(epoch),
            [0xABu8; BLAKE3_HASH_SIZE],
        )
    }
}