add(consensus/network): Adds `new_regtest()` constructors to `testnet::Parameters` and `Network` #8413

arya2 · 2024-04-18T19:06:46Z

Motivation

We want to support Regtest in Zebra.

This PR adds methods for creating a new Network or testnet::Parameters with the Regtest parameters as the values of fields that exist on testnet::Parameters so far.

We'll need to add at least a few more fields (see 'Follow Up Work') that are needed for Regtest to testnet::Parameters and set them as their Regtest values in these methods for Zebra to support a minimal version of Regtest. Creating the genesis block may also rely on adding more parameters.

Closes #7839.

Depends-On: #8411.

PR Author Checklist

Check before marking the PR as ready for review:

Will the PR name make sense to users?
Does the PR have a priority label?
Have you added or updated tests?
Is the documentation up to date?

For significant changes:

Is there a summary in the CHANGELOG?
Can these changes be split into multiple PRs?

If a checkbox isn't relevant to the PR, mark it as done.

Solution

Adds new_regtest() constructor methods to testnet::Parameters and zebra_chain::Network
Calls Network::new_regtest() instead of unimplemented!() in the zebra_network::Config deserialization
Adds with_sapling_hrps() method on ParametersBuilder and uses it to set the Regtest HRPs in new_regtest()

Related Cleanups:

Returns an error when deserializing the config if it uses any default initial peers for a configured testnet
Allows for defining testnet_parameters in the config on Mainnet and Regtest (and the Regtest activation heights on other networks)
Refactors Testnet parameters and Regtest activation heights part of zebra_network::Config deserialization
Uses default Testnet activation heights as the default configured Testnet activation heights
Uses the activation heights from ParametersBuilder in testnet::Parameters::default()

Testing

Updates the latest stored config
Checks the default Regtest activation heights in activates_network_upgrades_correctly()
Adds a test for checking that ParametersBuilder validates configured Sapling HRPs as expected

Review

Anyone can review.

Reviewer Checklist

Check before approving the PR:

Does the PR scope match the ticket?
Are there enough tests to make sure it works? Do the tests cover the PR motivation?
Are all the PR blockers dealt with?
PR blockers can be dealt with in new tickets or PRs.

And check the PR Author checklist is complete.

Follow Up Work

…pdates production code.

…rts` and `transparent::Address`

…orkKind` as zebra_network::Config::network field type, and converts 'Network' to `NetworkKind` before serializing

…l for zcash_primitives::consensus::Network

…ey're used.

Co-authored-by: Marek <mail@marek.onl>

…network_kind`

…` module

…red configs can be parsed, adds an intermediate representation of activation heights

…rk where there were conversions

…ion)

…serde(default)] - Panics if a non-zero activation height is provided for the `Genesis` network upgrade - Always sets the `Genesis` and `BeforeOverwinter` network upgrade activation heights to 0 and 1, `BeforeOverwinter` could be overwritten by a later network upgrade - Makes the `activation_heights` field on `Parameters` private, adds/uses an accessor method instead, and adds a builder struct and `build()` method

… the next NetworkUpgrade if it doesn't find the activation height of `&self`

… assertion message

…r how activation heights can be configured

…s test, moves struct with activation heights outside deserialization impl and accepts it in `ParametersBuilder::activation_heights()` instead of a Vec

… in `new_regtest()`. Adds a test for Sapling HRP validation

…ion in `with_sapling_hrps()`

upbqdn · 2024-04-24T11:23:58Z

@arya2, this PR needs a manual merge conflict resolution.

zebra-chain/src/parameters/network/tests/vectors.rs

arya2 · 2024-04-25T02:36:27Z

@Mergifyio refresh

mergify · 2024-04-25T02:36:29Z

refresh

✅ Pull request refreshed

arya2 and others added 30 commits April 1, 2024 21:45

minor cleanup and rename

9db4762

Adds an empty NetworkParameters struct to Network::Testnet variant, u…

4b86bd6

…pdates production code.

Updates tests

7533e2f

Adds NetworkKind and uses it instead of Network in `HistoryTreePa…

06cf947

…rts` and `transparent::Address`

Adds a [network.testnet_parameters] section to the config, uses `Netw…

4900a20

…orkKind` as zebra_network::Config::network field type, and converts 'Network' to `NetworkKind` before serializing

Applies some suggestions from code review

cb8726b

Applies suggestions from code review

d5a807a

returns b58 prefix constants directly to remove From<NetworkKind> imp…

d108ec6

…l for zcash_primitives::consensus::Network

Applies more suggestions from code review.

574b1f9

moves conversions to zcash_primitives::consensus::Network to where th…

05e41a2

…ey're used.

Apply suggestions from code review

fd3d505

Co-authored-by: Marek <mail@marek.onl>

rename network variables and method names typed as NetworkKind to `…

f04b94b

…network_kind`

use only test block heights for the network associated with them

ea2d001

Applies more suggestions from code review.

86cd919

Rename NetworkParameters to Parameters and move it a new `testnet…

365b58e

…` module

Merge branch 'main' into network-params

eca7f6b

adds activation heights field

60248e3

updates stored test config, adds a quicker test for checking that sto…

b9bdf05

…red configs can be parsed, adds an intermediate representation of activation heights

implement Parameters for Network

ad4e7dc

Passes &Network directly instead of converting to zp_consensus::Netwo…

4347a80

…rk where there were conversions

fixes a bad merge (removes a network conversion in zcash_note_encrypt…

080affd

…ion)

Adds a test for the Parameters impl for zebra_chain::Network

2493e7e

fixes doc links

997e265

small refactor of activation_heights() method

0fd4158

check that activation heights are in the right order

3952caa

Updates NetworkUpgrade::activation_height() to return the height of…

e697d36

… the next NetworkUpgrade if it doesn't find the activation height of `&self`

checks that the miner address is of TestnetKind on Regtest and update…

325a6c6

… assertion message

Adds a DNetworkUpgradeActivationHeights struct for better control ove…

f724c01

…r how activation heights can be configured

moves all ordered network upgrades to a constant, adds a no_duplicate…

a37510a

…s test, moves struct with activation heights outside deserialization impl and accepts it in `ParametersBuilder::activation_heights()` instead of a Vec

arya2 added 6 commits April 19, 2024 15:43

Removes outdated TODO

32e4fbb

Restores testnet_parameters section of the latest stored config.

63623ae

Adds with_sapling_hrps() method and uses it to set the Regtest HRPs…

d871590

… in `new_regtest()`. Adds a test for Sapling HRP validation

Checks that default Mainnet/Testnet/Regtest Sapling HRPs pass validat…

4671efe

…ion in `with_sapling_hrps()`

Uses the correct constant in test

9b41cba

Adds is_regtest() methods

b38dbfd

arya2 force-pushed the params-new-regtest branch from 741c158 to b38dbfd Compare April 19, 2024 19:44

arya2 mentioned this pull request Apr 23, 2024

add(consensus): Adds disable_pow and genesis_hash fields, converts equihash::Solution to an enum #8421

Merged

9 tasks

Base automatically changed from params-network-name to main April 24, 2024 11:03

upbqdn previously approved these changes Apr 24, 2024

View reviewed changes

zebra-chain/src/parameters/network/tests/vectors.rs Show resolved Hide resolved

arya2 added 2 commits April 24, 2024 11:07

Merge remote-tracking branch 'origin/main' into params-new-regtest

b7957e9

Updates test docs

13d59ad

arya2 dismissed upbqdn’s stale review via 13d59ad April 24, 2024 15:25

upbqdn previously approved these changes Apr 24, 2024

View reviewed changes

drop custom panic hooks after expected panics

3b5a7f5

arya2 dismissed upbqdn’s stale review via 3b5a7f5 April 24, 2024 16:28

Merge branch 'main' into params-new-regtest

ace7f19

arya2 requested a review from upbqdn April 24, 2024 17:37

upbqdn reviewed Apr 24, 2024

View reviewed changes

zebra-chain/src/parameters/network/tests/vectors.rs Show resolved Hide resolved

arya2 requested a review from upbqdn April 24, 2024 20:35

upbqdn approved these changes Apr 24, 2024

View reviewed changes

mergify bot added a commit that referenced this pull request Apr 25, 2024

Merge of #8413

6d23c9a

mergify bot mentioned this pull request Apr 25, 2024

merge queue: embarking main (e95a70d) and #8413 together #8466

Closed

mergify bot added a commit that referenced this pull request Apr 25, 2024

Merge of #8413

07a4f89

mergify bot mentioned this pull request Apr 25, 2024

merge queue: embarking main (e95a70d) and #8413 together #8467

Closed

mergify bot merged commit e5d4d73 into main Apr 25, 2024
191 checks passed

mergify bot deleted the params-new-regtest branch April 25, 2024 04:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add(consensus/network): Adds `new_regtest()` constructors to `testnet::Parameters` and `Network` #8413

add(consensus/network): Adds `new_regtest()` constructors to `testnet::Parameters` and `Network` #8413

arya2 commented Apr 18, 2024 •

edited

Loading

upbqdn commented Apr 24, 2024

arya2 commented Apr 25, 2024

mergify bot commented Apr 25, 2024

add(consensus/network): Adds new_regtest() constructors to testnet::Parameters and Network #8413

add(consensus/network): Adds new_regtest() constructors to testnet::Parameters and Network #8413

Conversation

arya2 commented Apr 18, 2024 • edited Loading

Motivation

PR Author Checklist

Check before marking the PR as ready for review:

For significant changes:

Solution

Testing

Review

Reviewer Checklist

Follow Up Work

upbqdn commented Apr 24, 2024

arya2 commented Apr 25, 2024

mergify bot commented Apr 25, 2024

✅ Pull request refreshed

add(consensus/network): Adds `new_regtest()` constructors to `testnet::Parameters` and `Network` #8413

add(consensus/network): Adds `new_regtest()` constructors to `testnet::Parameters` and `Network` #8413

arya2 commented Apr 18, 2024 •

edited

Loading