Adds genesis hash methods and fields to `testnet::Parameters` and its builder

This commit is contained in:
Arya 2024-04-19 15:32:16 -04:00
parent b38dbfd252
commit a8b4e278b7
2 changed files with 42 additions and 10 deletions

View File

@ -4,7 +4,7 @@ use std::{collections::BTreeMap, fmt};
use zcash_primitives::constants as zp_constants; use zcash_primitives::constants as zp_constants;
use crate::{ use crate::{
block::Height, block::{self, Height},
parameters::{ parameters::{
network_upgrade::TESTNET_ACTIVATION_HEIGHTS, Network, NetworkUpgrade, network_upgrade::TESTNET_ACTIVATION_HEIGHTS, Network, NetworkUpgrade,
NETWORK_UPGRADES_IN_ORDER, NETWORK_UPGRADES_IN_ORDER,
@ -27,6 +27,14 @@ pub const MAX_NETWORK_NAME_LENGTH: usize = 30;
/// Maximum length for a configured human-readable prefix. /// Maximum length for a configured human-readable prefix.
pub const MAX_HRP_LENGTH: usize = 30; pub const MAX_HRP_LENGTH: usize = 30;
/// The block hash of the Testnet genesis block, `zcash-cli -regtest getblockhash 0`
const REGTEST_GENESIS_HASH: &str =
"029f11d80ef9765602235e1bc9727e3eb6ba20839319f761fee920d63401e327";
/// The block hash of the Testnet genesis block, `zcash-cli -testnet getblockhash 0`
const TESTNET_GENESIS_HASH: &str =
"05a60a92d99d85997cce3b87616c089f6124d7342af37106edc76126334a2c38";
/// Configurable activation heights for Regtest and configured Testnets. /// Configurable activation heights for Regtest and configured Testnets.
#[derive(Deserialize, Default)] #[derive(Deserialize, Default)]
#[serde(rename_all = "PascalCase")] #[serde(rename_all = "PascalCase")]
@ -53,6 +61,8 @@ pub struct ConfiguredActivationHeights {
pub struct ParametersBuilder { pub struct ParametersBuilder {
/// The name of this network to be used by the `Display` trait impl. /// The name of this network to be used by the `Display` trait impl.
network_name: String, network_name: String,
/// The genesis block hash
genesis_hash: block::Hash,
/// The network upgrade activation heights for this network, see [`Parameters::activation_heights`] for more details. /// The network upgrade activation heights for this network, see [`Parameters::activation_heights`] for more details.
activation_heights: BTreeMap<Height, NetworkUpgrade>, activation_heights: BTreeMap<Height, NetworkUpgrade>,
/// Sapling extended spending key human-readable prefix for this network /// Sapling extended spending key human-readable prefix for this network
@ -77,6 +87,9 @@ impl Default for ParametersBuilder {
zp_constants::testnet::HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY.to_string(), zp_constants::testnet::HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY.to_string(),
hrp_sapling_payment_address: zp_constants::testnet::HRP_SAPLING_PAYMENT_ADDRESS hrp_sapling_payment_address: zp_constants::testnet::HRP_SAPLING_PAYMENT_ADDRESS
.to_string(), .to_string(),
genesis_hash: TESTNET_GENESIS_HASH
.parse()
.expect("hard-coded hash parses"),
} }
} }
} }
@ -144,6 +157,15 @@ impl ParametersBuilder {
self self
} }
/// Parses a hex-encoded block hash and sets the genesis hash to be used in the [`Parameters`] being built.
pub fn with_genesis_hash(mut self, genesis_hash: impl fmt::Display) -> Self {
self.genesis_hash = genesis_hash
.to_string()
.parse()
.expect("configured genesis hash must parse");
self
}
/// Checks that the provided network upgrade activation heights are in the correct order, then /// Checks that the provided network upgrade activation heights are in the correct order, then
/// sets them as the new network upgrade activation heights. /// sets them as the new network upgrade activation heights.
pub fn with_activation_heights( pub fn with_activation_heights(
@ -212,6 +234,7 @@ impl ParametersBuilder {
pub fn finish(self) -> Parameters { pub fn finish(self) -> Parameters {
let Self { let Self {
network_name, network_name,
genesis_hash,
activation_heights, activation_heights,
hrp_sapling_extended_spending_key, hrp_sapling_extended_spending_key,
hrp_sapling_extended_full_viewing_key, hrp_sapling_extended_full_viewing_key,
@ -223,6 +246,7 @@ impl ParametersBuilder {
hrp_sapling_extended_spending_key, hrp_sapling_extended_spending_key,
hrp_sapling_extended_full_viewing_key, hrp_sapling_extended_full_viewing_key,
hrp_sapling_payment_address, hrp_sapling_payment_address,
genesis_hash,
} }
} }
@ -237,6 +261,8 @@ impl ParametersBuilder {
pub struct Parameters { pub struct Parameters {
/// The name of this network to be used by the `Display` trait impl. /// The name of this network to be used by the `Display` trait impl.
network_name: String, network_name: String,
/// The genesis block hash
genesis_hash: block::Hash,
/// The network upgrade activation heights for this network. /// The network upgrade activation heights for this network.
/// ///
/// Note: This value is ignored by `Network::activation_list()` when `zebra-chain` is /// Note: This value is ignored by `Network::activation_list()` when `zebra-chain` is
@ -274,6 +300,7 @@ impl Parameters {
Self { Self {
network_name: "Regtest".to_string(), network_name: "Regtest".to_string(),
..Self::build() ..Self::build()
.with_genesis_hash(REGTEST_GENESIS_HASH)
.with_sapling_hrps( .with_sapling_hrps(
zp_constants::regtest::HRP_SAPLING_EXTENDED_SPENDING_KEY, zp_constants::regtest::HRP_SAPLING_EXTENDED_SPENDING_KEY,
zp_constants::regtest::HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY, zp_constants::regtest::HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY,
@ -295,13 +322,16 @@ impl Parameters {
pub fn is_regtest(&self) -> bool { pub fn is_regtest(&self) -> bool {
let Self { let Self {
network_name, network_name,
genesis_hash,
// Activation heights are configurable on Regtest
activation_heights: _,
hrp_sapling_extended_spending_key, hrp_sapling_extended_spending_key,
hrp_sapling_extended_full_viewing_key, hrp_sapling_extended_full_viewing_key,
hrp_sapling_payment_address, hrp_sapling_payment_address,
..
} = Self::new_regtest(ConfiguredActivationHeights::default()); } = Self::new_regtest(ConfiguredActivationHeights::default());
self.network_name == network_name self.network_name == network_name
&& self.genesis_hash == genesis_hash
&& self.hrp_sapling_extended_spending_key == hrp_sapling_extended_spending_key && self.hrp_sapling_extended_spending_key == hrp_sapling_extended_spending_key
&& self.hrp_sapling_extended_full_viewing_key == hrp_sapling_extended_full_viewing_key && self.hrp_sapling_extended_full_viewing_key == hrp_sapling_extended_full_viewing_key
&& self.hrp_sapling_payment_address == hrp_sapling_payment_address && self.hrp_sapling_payment_address == hrp_sapling_payment_address
@ -312,6 +342,11 @@ impl Parameters {
&self.network_name &self.network_name
} }
/// Returns the genesis hash
pub fn genesis_hash(&self) -> block::Hash {
self.genesis_hash
}
/// Returns the network upgrade activation heights /// Returns the network upgrade activation heights
pub fn activation_heights(&self) -> &BTreeMap<Height, NetworkUpgrade> { pub fn activation_heights(&self) -> &BTreeMap<Height, NetworkUpgrade> {
&self.activation_heights &self.activation_heights

View File

@ -55,15 +55,12 @@ impl ParameterCheckpoint for Network {
fn genesis_hash(&self) -> zebra_chain::block::Hash { fn genesis_hash(&self) -> zebra_chain::block::Hash {
match self { match self {
// zcash-cli getblockhash 0 // zcash-cli getblockhash 0
Network::Mainnet => "00040fe8ec8471911baa1db1266ea15dd06b4a8a5c453883c000b031973dce08", Network::Mainnet => "00040fe8ec8471911baa1db1266ea15dd06b4a8a5c453883c000b031973dce08"
// zcash-cli -testnet getblockhash 0 .parse()
// TODO: Add a `genesis_hash` field to `testnet::Parameters` and return it here (#8366) .expect("hard-coded hash parses"),
Network::Testnet(_params) => { // See `zebra_chain::parameters::network::testnet` for more details.
"05a60a92d99d85997cce3b87616c089f6124d7342af37106edc76126334a2c38" Network::Testnet(params) => params.genesis_hash(),
}
} }
.parse()
.expect("hard-coded hash parses")
} }
fn checkpoint_list(&self) -> CheckpointList { fn checkpoint_list(&self) -> CheckpointList {