Merge remote-tracking branch 'origin/main' into bump-some_prod-deps

This commit is contained in:
Alfredo Garcia 2024-04-24 08:43:47 -03:00
commit 648d22de03
14 changed files with 160 additions and 46 deletions

View File

@ -78,8 +78,7 @@ jobs:
strategy: strategy:
fail-fast: false fail-fast: false
matrix: matrix:
# TODO: Windows was removed for now, see https://github.com/ZcashFoundation/zebra/issues/3801 os: [ubuntu-latest, macos-latest, windows-latest]
os: [ubuntu-latest, macos-latest]
rust: [stable, beta] rust: [stable, beta]
# TODO: When vars.EXPERIMENTAL_FEATURES has features in it, add it here. # TODO: When vars.EXPERIMENTAL_FEATURES has features in it, add it here.
# Or work out a way to trim the space from the variable: GitHub doesn't allow empty variables. # Or work out a way to trim the space from the variable: GitHub doesn't allow empty variables.

View File

@ -1077,9 +1077,9 @@ dependencies = [
[[package]] [[package]]
name = "cxx" name = "cxx"
version = "1.0.107" version = "1.0.113"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "bbe98ba1789d56fb3db3bee5e032774d4f421b685de7ba703643584ba24effbe" checksum = "048948e14bc2c2652ec606c8e3bb913407f0187288fb351a0b2d972beaf12070"
dependencies = [ dependencies = [
"cc", "cc",
"cxxbridge-flags", "cxxbridge-flags",
@ -1089,9 +1089,9 @@ dependencies = [
[[package]] [[package]]
name = "cxx-gen" name = "cxx-gen"
version = "0.7.117" version = "0.7.121"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "54b629c0d006c7e44c1444dd17d18a458c9390d32276b758ac7abd21a75c99b0" checksum = "383ecb9f96a536a1c7a2a61c5786f583da84f9240da149d78d005a4413c9a71e"
dependencies = [ dependencies = [
"codespan-reporting", "codespan-reporting",
"proc-macro2", "proc-macro2",
@ -1101,15 +1101,15 @@ dependencies = [
[[package]] [[package]]
name = "cxxbridge-flags" name = "cxxbridge-flags"
version = "1.0.107" version = "1.0.113"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "20888d9e1d2298e2ff473cee30efe7d5036e437857ab68bbfea84c74dba91da2" checksum = "af40b0467c68d3d9fb7550ef984edc8ad47252f703ef0f1f2d1052e0e4af8793"
[[package]] [[package]]
name = "cxxbridge-macro" name = "cxxbridge-macro"
version = "1.0.107" version = "1.0.113"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "2fa16a70dd58129e4dfffdff535fb1bce66673f7bbeec4a5a1765a504e1ccd84" checksum = "7743446286141c9f6d4497c493c01234eb848e14d2e20866ae9811eae0630cb9"
dependencies = [ dependencies = [
"proc-macro2", "proc-macro2",
"quote", "quote",
@ -3809,9 +3809,9 @@ dependencies = [
[[package]] [[package]]
name = "rustls" name = "rustls"
version = "0.21.10" version = "0.21.11"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "f9d5a6813c0759e4609cd494e8e725babae6a2ca7b62a5536a13daaec6fcb7ba" checksum = "7fecbfb7b1444f477b345853b1fce097a2c6fb637b2bfb87e6bc5db0f043fae4"
dependencies = [ dependencies = [
"log", "log",
"ring 0.17.8", "ring 0.17.8",
@ -5670,9 +5670,9 @@ dependencies = [
[[package]] [[package]]
name = "zcash_client_backend" name = "zcash_client_backend"
version = "0.10.0-rc.4" version = "0.10.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "ecc33f71747a93d509f7e1c047961e359a271bdf4869cc07f7f65ee1ba7df8c2" checksum = "d6a382af39be9ee5a3788157145c404b7cd19acc440903f6c34b09fb44f0e991"
dependencies = [ dependencies = [
"base64 0.21.7", "base64 0.21.7",
"bech32", "bech32",
@ -5737,9 +5737,9 @@ dependencies = [
[[package]] [[package]]
name = "zcash_primitives" name = "zcash_primitives"
version = "0.13.0-rc.1" version = "0.13.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "0cc4391d9325e0a51a7cbff02b5c4b5472d66087bd9c903ddb12dea7ec22f3e0" checksum = "d17e4c94ca8d69d2fcf2be97522da5732a580eb2125cda3b150761952f8df8e6"
dependencies = [ dependencies = [
"aes", "aes",
"bip0039", "bip0039",
@ -5773,9 +5773,9 @@ dependencies = [
[[package]] [[package]]
name = "zcash_proofs" name = "zcash_proofs"
version = "0.13.0-rc.1" version = "0.13.0"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "48f22eff3bdc382327ef28f809024ddc89ec6d903ba71be629b2cbea34afdda2" checksum = "df0c99f65a840ff256c106b28d67d702d9759d206112473d4982c92003262406"
dependencies = [ dependencies = [
"bellman", "bellman",
"blake2b_simd", "blake2b_simd",
@ -5804,9 +5804,9 @@ dependencies = [
[[package]] [[package]]
name = "zcash_script" name = "zcash_script"
version = "0.1.14" version = "0.1.15"
source = "registry+https://github.com/rust-lang/crates.io-index" source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "8deff8ea47cbe2a008abefedc1a2d9c0e48a87844379759ace270a0b53353c71" checksum = "9e3de6aece21108f502f724183955d244e02338613eaa4f9010386c63618a3a8"
dependencies = [ dependencies = [
"bellman", "bellman",
"bindgen", "bindgen",

View File

@ -97,7 +97,7 @@ orchard = "0.6.0"
zcash_encoding = "0.2.0" zcash_encoding = "0.2.0"
zcash_history = "0.4.0" zcash_history = "0.4.0"
zcash_note_encryption = "0.4.0" zcash_note_encryption = "0.4.0"
zcash_primitives = { version = "0.13.0-rc.1", features = ["transparent-inputs"] } zcash_primitives = { version = "0.13.0", features = ["transparent-inputs"] }
# Time # Time
chrono = { version = "0.4.38", default-features = false, features = ["clock", "std", "serde"] } chrono = { version = "0.4.38", default-features = false, features = ["clock", "std", "serde"] }

View File

@ -138,15 +138,13 @@ impl fmt::Display for NetworkKind {
} }
} }
impl From<&Network> for &'static str { impl<'a> From<&'a Network> for &'a str {
fn from(network: &Network) -> &'static str { fn from(network: &'a Network) -> &'a str {
match network { match network {
Network::Mainnet => "Mainnet", Network::Mainnet => "Mainnet",
// TODO: // TODO:
// - Add a `name` field to use here instead of checking `is_default_testnet()`
// - zcashd calls the Regtest cache dir 'regtest' (#8327). // - zcashd calls the Regtest cache dir 'regtest' (#8327).
Network::Testnet(params) if params.is_default_testnet() => "Testnet", Network::Testnet(params) => params.network_name(),
Network::Testnet(_params) => "UnknownTestnet",
} }
} }
} }

View File

@ -1,5 +1,5 @@
//! Types and implementation for Testnet consensus parameters //! Types and implementation for Testnet consensus parameters
use std::collections::BTreeMap; use std::{collections::BTreeMap, fmt};
use zcash_primitives::constants as zp_constants; use zcash_primitives::constants as zp_constants;
@ -11,6 +11,19 @@ use crate::{
}, },
}; };
/// Reserved network names that should not be allowed for configured Testnets.
pub const RESERVED_NETWORK_NAMES: [&str; 6] = [
"Mainnet",
"Testnet",
"Regtest",
"MainnetKind",
"TestnetKind",
"RegtestKind",
];
/// Maximum length for a configured network name.
pub const MAX_NETWORK_NAME_LENGTH: usize = 30;
/// 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")]
@ -35,6 +48,8 @@ pub struct ConfiguredActivationHeights {
/// Builder for the [`Parameters`] struct. /// Builder for the [`Parameters`] struct.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)] #[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
pub struct ParametersBuilder { pub struct ParametersBuilder {
/// The name of this network to be used by the `Display` trait impl.
network_name: String,
/// 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
@ -48,6 +63,7 @@ pub struct ParametersBuilder {
impl Default for ParametersBuilder { impl Default for ParametersBuilder {
fn default() -> Self { fn default() -> Self {
Self { Self {
network_name: "UnknownTestnet".to_string(),
// # Correctness // # Correctness
// //
// `Genesis` network upgrade activation height must always be 0 // `Genesis` network upgrade activation height must always be 0
@ -69,9 +85,33 @@ impl Default for ParametersBuilder {
} }
impl ParametersBuilder { impl ParametersBuilder {
/// Sets the network name to be used in the [`Parameters`] being built.
pub fn with_network_name(mut self, network_name: impl fmt::Display) -> Self {
self.network_name = network_name.to_string();
assert!(
!RESERVED_NETWORK_NAMES.contains(&self.network_name.as_str()),
"cannot use reserved network name '{network_name}' as configured Testnet name, reserved names: {RESERVED_NETWORK_NAMES:?}"
);
assert!(
self.network_name.len() <= MAX_NETWORK_NAME_LENGTH,
"network name {network_name} is too long, must be {MAX_NETWORK_NAME_LENGTH} characters or less"
);
assert!(
self.network_name
.chars()
.all(|x| x.is_alphanumeric() || x == '_'),
"network name must include only alphanumeric characters or '_'"
);
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 activation_heights( pub fn with_activation_heights(
mut self, mut self,
ConfiguredActivationHeights { ConfiguredActivationHeights {
// TODO: Find out if `BeforeOverwinter` is required at Height(1), allow for // TODO: Find out if `BeforeOverwinter` is required at Height(1), allow for
@ -99,7 +139,6 @@ impl ParametersBuilder {
.chain(heartwood.into_iter().map(|h| (h, Heartwood))) .chain(heartwood.into_iter().map(|h| (h, Heartwood)))
.chain(canopy.into_iter().map(|h| (h, Canopy))) .chain(canopy.into_iter().map(|h| (h, Canopy)))
.chain(nu5.into_iter().map(|h| (h, Nu5))) .chain(nu5.into_iter().map(|h| (h, Nu5)))
.filter(|&(_, nu)| nu != NetworkUpgrade::BeforeOverwinter)
.map(|(h, nu)| (h.try_into().expect("activation height must be valid"), nu)) .map(|(h, nu)| (h.try_into().expect("activation height must be valid"), nu))
.collect(); .collect();
@ -136,12 +175,14 @@ impl ParametersBuilder {
/// Converts the builder to a [`Parameters`] struct /// Converts the builder to a [`Parameters`] struct
pub fn finish(self) -> Parameters { pub fn finish(self) -> Parameters {
let Self { let Self {
network_name,
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,
hrp_sapling_payment_address, hrp_sapling_payment_address,
} = self; } = self;
Parameters { Parameters {
network_name,
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,
@ -158,6 +199,8 @@ impl ParametersBuilder {
/// Network consensus parameters for test networks such as Regtest and the default Testnet. /// Network consensus parameters for test networks such as Regtest and the default Testnet.
#[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)] #[derive(Clone, Debug, Eq, PartialEq, Hash, Serialize, Deserialize)]
pub struct Parameters { pub struct Parameters {
/// The name of this network to be used by the `Display` trait impl.
network_name: String,
/// 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
@ -176,13 +219,9 @@ impl Default for Parameters {
/// Returns an instance of the default public testnet [`Parameters`]. /// Returns an instance of the default public testnet [`Parameters`].
fn default() -> Self { fn default() -> Self {
Self { Self {
network_name: "Testnet".to_string(),
activation_heights: TESTNET_ACTIVATION_HEIGHTS.iter().cloned().collect(), activation_heights: TESTNET_ACTIVATION_HEIGHTS.iter().cloned().collect(),
hrp_sapling_extended_spending_key: ..Self::build().finish()
zp_constants::testnet::HRP_SAPLING_EXTENDED_SPENDING_KEY.to_string(),
hrp_sapling_extended_full_viewing_key:
zp_constants::testnet::HRP_SAPLING_EXTENDED_FULL_VIEWING_KEY.to_string(),
hrp_sapling_payment_address: zp_constants::testnet::HRP_SAPLING_PAYMENT_ADDRESS
.to_string(),
} }
} }
} }
@ -198,6 +237,11 @@ impl Parameters {
self == &Self::default() self == &Self::default()
} }
/// Returns the network name
pub fn network_name(&self) -> &str {
&self.network_name
}
/// 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

@ -5,7 +5,9 @@ use zcash_primitives::consensus::{self as zp_consensus, Parameters};
use crate::{ use crate::{
block::Height, block::Height,
parameters::{ parameters::{
testnet::{self, ConfiguredActivationHeights}, testnet::{
self, ConfiguredActivationHeights, MAX_NETWORK_NAME_LENGTH, RESERVED_NETWORK_NAMES,
},
Network, NetworkUpgrade, NETWORK_UPGRADES_IN_ORDER, Network, NetworkUpgrade, NETWORK_UPGRADES_IN_ORDER,
}, },
}; };
@ -97,7 +99,7 @@ fn check_parameters_impl() {
fn activates_network_upgrades_correctly() { fn activates_network_upgrades_correctly() {
let expected_activation_height = 1; let expected_activation_height = 1;
let network = testnet::Parameters::build() let network = testnet::Parameters::build()
.activation_heights(ConfiguredActivationHeights { .with_activation_heights(ConfiguredActivationHeights {
nu5: Some(expected_activation_height), nu5: Some(expected_activation_height),
..Default::default() ..Default::default()
}) })
@ -125,3 +127,58 @@ fn activates_network_upgrades_correctly() {
); );
} }
} }
/// Checks that configured testnet names are validated and used correctly.
#[test]
fn check_network_name() {
// Sets a no-op panic hook to avoid long output.
std::panic::set_hook(Box::new(|_| {}));
// Checks that reserved network names cannot be used for configured testnets.
for reserved_network_name in RESERVED_NETWORK_NAMES {
std::panic::catch_unwind(|| {
testnet::Parameters::build().with_network_name(reserved_network_name)
})
.expect_err("should panic when attempting to set network name as a reserved name");
}
// Check that max length is enforced, and that network names may only contain alphanumeric characters and '_'.
for invalid_network_name in [
"a".repeat(MAX_NETWORK_NAME_LENGTH + 1),
"!!!!non-alphanumeric-name".to_string(),
] {
std::panic::catch_unwind(|| {
testnet::Parameters::build().with_network_name(invalid_network_name)
})
.expect_err("should panic when setting network name that's too long or contains non-alphanumeric characters (except '_')");
}
// Checks that network names are displayed correctly
assert_eq!(
Network::new_default_testnet().to_string(),
"Testnet",
"default testnet should be displayed as 'Testnet'"
);
assert_eq!(
Network::Mainnet.to_string(),
"Mainnet",
"Mainnet should be displayed as 'Mainnet'"
);
// TODO: Check Regtest
// Check that network name can contain alphanumeric characters and '_'.
let expected_name = "ConfiguredTestnet_1";
let network = testnet::Parameters::build()
// Check that network name can contain `MAX_NETWORK_NAME_LENGTH` characters
.with_network_name("a".repeat(MAX_NETWORK_NAME_LENGTH))
.with_network_name(expected_name)
.to_network();
// Check that configured network name is displayed
assert_eq!(
network.to_string(),
expected_name,
"network must be displayed as configured network name"
);
}

View File

@ -26,7 +26,7 @@ tokio-stream = "0.1.15"
tower = { version = "0.4.13", features = ["util", "buffer"] } tower = { version = "0.4.13", features = ["util", "buffer"] }
color-eyre = "0.6.3" color-eyre = "0.6.3"
zcash_primitives = { version = "0.13.0-rc.1" } zcash_primitives = { version = "0.13.0" }
zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.36", features = ["shielded-scan"] } zebra-node-services = { path = "../zebra-node-services", version = "1.0.0-beta.36", features = ["shielded-scan"] }
zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.36" } zebra-chain = { path = "../zebra-chain" , version = "1.0.0-beta.36" }

View File

@ -629,8 +629,9 @@ impl<'de> Deserialize<'de> for Config {
{ {
#[derive(Deserialize)] #[derive(Deserialize)]
struct DTestnetParameters { struct DTestnetParameters {
network_name: Option<String>,
#[serde(default)] #[serde(default)]
pub(super) activation_heights: ConfiguredActivationHeights, activation_heights: ConfiguredActivationHeights,
} }
#[derive(Deserialize)] #[derive(Deserialize)]
@ -678,15 +679,25 @@ impl<'de> Deserialize<'de> for Config {
} = DConfig::deserialize(deserializer)?; } = DConfig::deserialize(deserializer)?;
// TODO: Panic here if the initial testnet peers are the default initial testnet peers. // TODO: Panic here if the initial testnet peers are the default initial testnet peers.
let network = if let Some(DTestnetParameters { activation_heights }) = testnet_parameters { let network = if let Some(DTestnetParameters {
network_name,
activation_heights,
}) = testnet_parameters
{
assert_eq!( assert_eq!(
network_kind, network_kind,
NetworkKind::Testnet, NetworkKind::Testnet,
"set network to 'Testnet' to use configured testnet parameters" "set network to 'Testnet' to use configured testnet parameters"
); );
testnet::Parameters::build() let mut params_builder = testnet::Parameters::build();
.activation_heights(activation_heights)
if let Some(network_name) = network_name {
params_builder = params_builder.with_network_name(network_name)
}
params_builder
.with_activation_heights(activation_heights)
.to_network() .to_network()
} else { } else {
// Convert to default `Network` for a `NetworkKind` if there are no testnet parameters. // Convert to default `Network` for a `NetworkKind` if there are no testnet parameters.

View File

@ -23,13 +23,14 @@ use super::super::*;
/// Test that the JSON-RPC server spawns when configured with a single thread. /// Test that the JSON-RPC server spawns when configured with a single thread.
#[test] #[test]
#[cfg(not(target_os = "windows"))]
fn rpc_server_spawn_single_thread() { fn rpc_server_spawn_single_thread() {
rpc_server_spawn(false) rpc_server_spawn(false)
} }
/// Test that the JSON-RPC server spawns when configured with multiple threads. /// Test that the JSON-RPC server spawns when configured with multiple threads.
#[test] #[test]
fn rpc_sever_spawn_parallel_threads() { fn rpc_server_spawn_parallel_threads() {
rpc_server_spawn(true) rpc_server_spawn(true)
} }

View File

@ -52,7 +52,7 @@ tracing = "0.1.39"
futures = "0.3.30" futures = "0.3.30"
zcash_client_backend = "0.10.0-rc.1" zcash_client_backend = "0.10.0-rc.1"
zcash_primitives = "0.13.0-rc.1" zcash_primitives = "0.13.0"
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36", features = ["shielded-scan"] } zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36", features = ["shielded-scan"] }
zebra-state = { path = "../zebra-state", version = "1.0.0-beta.36", features = ["shielded-scan"] } zebra-state = { path = "../zebra-state", version = "1.0.0-beta.36", features = ["shielded-scan"] }

View File

@ -15,7 +15,7 @@ keywords = ["zebra", "zcash"]
categories = ["api-bindings", "cryptography::cryptocurrencies"] categories = ["api-bindings", "cryptography::cryptocurrencies"]
[dependencies] [dependencies]
zcash_script = "0.1.14" zcash_script = "0.1.15"
zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36" } zebra-chain = { path = "../zebra-chain", version = "1.0.0-beta.36" }

View File

@ -120,7 +120,7 @@ tokio = { version = "1.37.0", features = ["full"], optional = true }
jsonrpc = { version = "0.18.0", optional = true } jsonrpc = { version = "0.18.0", optional = true }
zcash_primitives = { version = "0.13.0-rc.1", optional = true } zcash_primitives = { version = "0.13.0", optional = true }
zcash_client_backend = {version = "0.10.0-rc.1", optional = true} zcash_client_backend = {version = "0.10.0-rc.1", optional = true}
# For the openapi generator # For the openapi generator

View File

@ -622,6 +622,7 @@ fn config_tests() -> Result<()> {
invalid_generated_config()?; invalid_generated_config()?;
// Check that we have a current version of the config stored // Check that we have a current version of the config stored
#[cfg(not(target_os = "windows"))]
last_config_is_stored()?; last_config_is_stored()?;
// Check that Zebra's previous configurations still work // Check that Zebra's previous configurations still work

View File

@ -60,6 +60,9 @@ max_connections_per_ip = 1
network = "Testnet" network = "Testnet"
peerset_initial_target_size = 25 peerset_initial_target_size = 25
[network.testnet_parameters]
network_name = "ConfiguredTestnet_1"
[network.testnet_parameters.activation_heights] [network.testnet_parameters.activation_heights]
BeforeOverwinter = 1 BeforeOverwinter = 1
Overwinter = 207_500 Overwinter = 207_500