unc-primitives 0.12.2

This crate provides the base set of primitives used by other unc-infra.crates
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

use crate::types::Balance;
use once_cell::sync::Lazy;

/// Data structure for semver version and github tag or commit.
#[derive(serde::Serialize, serde::Deserialize, Clone, Debug, Default)]
pub struct Version {
    pub version: String,
    pub build: String,
    #[serde(default)]
    pub rustc_version: String,
}

use crate::upgrade_schedule::{get_protocol_version_internal, ProtocolUpgradeVotingSchedule};

/// unc_primitives_core re-exports
pub use unc_primitives_core::checked_feature;
pub use unc_primitives_core::types::ProtocolVersion;
pub use unc_primitives_core::version::ProtocolFeature;
pub use unc_primitives_core::version::PEER_MIN_ALLOWED_PROTOCOL_VERSION;
pub use unc_primitives_core::version::PROTOCOL_VERSION;

/// Minimum gas price proposed in UIP 92 and the associated protocol version
pub const MIN_GAS_PRICE_UIP_92: Balance = 1_000_000_000;
pub const MIN_PROTOCOL_VERSION_UIP_92: ProtocolVersion = 31;

/// Minimum gas price proposed in UIP 92 (fixed) and the associated protocol version
pub const MIN_GAS_PRICE_UIP_92_FIX: Balance = 100_000_000;
pub const MIN_PROTOCOL_VERSION_UIP_92_FIX: ProtocolVersion = 32;

pub const CORRECT_RANDOM_VALUE_PROTOCOL_VERSION: ProtocolVersion = 33;

/// The protocol version that enables reward on mainnet.
pub const ENABLE_INFLATION_PROTOCOL_VERSION: ProtocolVersion = 36;

/// Fix upgrade to use the latest voted protocol version instead of the current epoch protocol
/// version when there is no new change in protocol version.
pub const UPGRADABILITY_FIX_PROTOCOL_VERSION: ProtocolVersion = 37;

/// Updates the way receipt ID, data ID and random seeds are constructed.
pub const CREATE_HASH_PROTOCOL_VERSION: ProtocolVersion = 38;

/// Fix the storage usage of the delete key action.
pub const DELETE_KEY_STORAGE_USAGE_PROTOCOL_VERSION: ProtocolVersion = 40;

pub const SHARD_CHUNK_HEADER_UPGRADE_VERSION: ProtocolVersion = 41;

/// Updates the way receipt ID is constructed to use current block hash instead of last block hash
pub const CREATE_RECEIPT_ID_SWITCH_TO_CURRENT_BLOCK_VERSION: ProtocolVersion = 42;

/// The points in time after which the voting for the latest protocol version
/// should start.
///
/// In non-release builds this is typically a date in the far past (meaning that
/// nightly builds will vote for new protocols immediately).  On release builds
/// it’s set according to the schedule for that protocol upgrade.  Release
/// candidates usually have separate schedule to final releases.
pub const PROTOCOL_UPGRADE_SCHEDULE: Lazy<ProtocolUpgradeVotingSchedule> = Lazy::new(|| {
    // Update to according to schedule when making a release.
    // Keep in mind that the protocol upgrade will happen 1-2 epochs (15h-30h)
    // after the set date. Ideally that should be during working hours.
    // e.g. ProtocolUpgradeVotingSchedule::from_env_or_str("2000-01-01 15:00:00").unwrap());

    ProtocolUpgradeVotingSchedule::default()
});

/// Gives new clients an option to upgrade without announcing that they support
/// the new version.  This gives non-validator nodes time to upgrade.  See
/// <https://github.com/Utility/UEPs/issues/205>
pub fn get_protocol_version(next_epoch_protocol_version: ProtocolVersion) -> ProtocolVersion {
    get_protocol_version_internal(
        next_epoch_protocol_version,
        PROTOCOL_VERSION,
        *PROTOCOL_UPGRADE_SCHEDULE,
    )
}