zebra-chain 14.0.0

Core Zcash data structures
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

//! Error types for `ParametersBuilder`.

use std::path::PathBuf;

use thiserror::Error;

/// An error that can occur when building `Parameters` using `ParametersBuilder`.
#[derive(Debug, Error, Clone, PartialEq, Eq)]
pub enum ParametersBuilderError {
    #[error("cannot use reserved network name '{network_name}' as configured Testnet name, reserved names: {reserved_names:?}")]
    #[non_exhaustive]
    ReservedNetworkName {
        network_name: String,
        reserved_names: Vec<&'static str>,
    },

    #[error("network name {network_name} is too long, must be {max_length} characters or less")]
    #[non_exhaustive]
    NetworkNameTooLong {
        network_name: String,
        max_length: usize,
    },

    #[error("network name must include only alphanumeric characters or '_'")]
    #[non_exhaustive]
    InvalidCharacter,

    #[error("network magic should be distinct from reserved network magics")]
    #[non_exhaustive]
    ReservedNetworkMagic,

    #[error("configured genesis hash must parse")]
    #[non_exhaustive]
    InvalidGenesisHash,

    #[error(
        "activation heights on ParametersBuilder must not be set after setting funding streams"
    )]
    #[non_exhaustive]
    LockFundingStreams,

    #[error("activation height must be valid")]
    #[non_exhaustive]
    InvalidActivationHeight,

    #[error("Height(0) is reserved for the `Genesis` upgrade")]
    #[non_exhaustive]
    InvalidHeightZero,

    #[error("halving interval must be in 1..=Height::MAX and produce supported halving indices and heights; configured funding streams require a nonzero address period, and reissuance requires a positive NSM coefficient")]
    #[non_exhaustive]
    InvalidHalvingInterval,

    #[error("scheduled issuance through the maximum supported height, excluding unspendable genesis issuance, must not exceed MAX_MONEY; early spacing upgrades may require slow_start_interval = 0")]
    #[non_exhaustive]
    InvalidSubsidySchedule,

    #[error("network upgrades must be activated in order specified by the protocol")]
    #[non_exhaustive]
    OutOfOrderUpgrades,

    #[error("difficulty limits are valid expanded values")]
    #[non_exhaustive]
    InvaildDifficultyLimits,

    #[error("halving interval on ParametersBuilder must not be set after setting funding streams")]
    #[non_exhaustive]
    HalvingIntervalAfterFundingStreams,

    /// A funding stream recipient does not cover the configured address periods.
    #[error("funding stream recipient {receiver:?} requires {required} addresses, but only {provided} were provided")]
    #[non_exhaustive]
    InsufficientFundingStreamAddresses {
        /// The recipient whose address list is too short.
        receiver: super::subsidy::FundingStreamReceiver,
        /// The minimum number of addresses needed for the configured height range.
        required: usize,
        /// The number of configured addresses.
        provided: usize,
    },

    /// Two nonempty funding stream height ranges overlap after applying inherited defaults.
    #[error("funding stream height ranges {first:?} and {second:?} overlap")]
    #[non_exhaustive]
    OverlappingFundingStreamRanges {
        /// The earlier configured range in the overlapping pair.
        first: std::ops::Range<crate::block::Height>,
        /// The later configured range in the overlapping pair.
        second: std::ops::Range<crate::block::Height>,
    },

    /// A non-deferred funding stream recipient uses an address without a supported payment script.
    #[error("funding stream recipient {receiver:?} uses unsupported address {address}; only P2SH and P2PKH addresses are supported")]
    #[non_exhaustive]
    UnsupportedFundingStreamAddress {
        /// The receiver whose payment cannot be represented by a supported funding stream script.
        receiver: super::subsidy::FundingStreamReceiver,
        /// The unsupported address.
        address: crate::transparent::Address,
    },

    #[error("checkpoints file format must be valid")]
    #[non_exhaustive]
    InvalidCheckpointsFormat,

    #[error("must parse checkpoints")]
    #[non_exhaustive]
    FailedToParseDefaultCheckpoint,

    #[error("could not read file at configured checkpoints file path: {path_buf:?}")]
    #[non_exhaustive]
    FailedToReadCheckpointFile { path_buf: PathBuf },

    #[error("could not parse checkpoints at the provided path: {path_buf:?}, err: {err}")]
    #[non_exhaustive]
    FailedToParseCheckpointFile { path_buf: PathBuf, err: String },

    #[error("configured checkpoints must be valid")]
    #[non_exhaustive]
    InvalidCustomCheckpoints,

    #[error("first checkpoint hash must match genesis hash")]
    #[non_exhaustive]
    CheckpointGenesisMismatch,

    #[error(
        "checkpoints must be provided for block heights below the mandatory checkpoint height"
    )]
    #[non_exhaustive]
    InsufficientCheckpointCoverage,

    #[error("the NSM reissuance height must be at or after the NU7 activation height")]
    #[non_exhaustive]
    NsmReissuanceHeightBeforeNu7,
}