Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add(book): Describes custom Testnets in the Zebra book #8636

Merged
merged 7 commits into from
Jun 28, 2024

Conversation

arya2
Copy link
Contributor

@arya2 arya2 commented Jun 21, 2024

Motivation

We want to document Zebra's custom Testnets in the Zebra book.

Closes #8588.

Solution

  • Adds a page to the Zebra book about custom Testnets and how they compare to Mainnet, the default Testnet, or Regtest.

Related changes:

  • Adds the expected genesis_hash to Zebra's configuration.
  • Uses the default Testnet if a testnet_parameters section is included in the config with default testnet values and no network name.

Tests

Updates the latest stored config with a configured genesis hash.

PR Author's Checklist

  • The PR name will make sense to users.
  • The PR provides a CHANGELOG summary.
  • The solution is tested.
  • The documentation is up to date.
  • The PR has a priority label.

PR Reviewer's Checklist

  • The PR Author's checklist is complete.
  • The PR resolves the issue.

…configuring custom Testnet genesis hashes, refactors check for compatible custom Testnets, adds a TODO, and uses the default testnet when there's an empty or default `testnet_parameters` field in Zebra's network config.
@arya2 arya2 added A-docs Area: Documentation P-Low ❄️ labels Jun 21, 2024
@arya2 arya2 self-assigned this Jun 21, 2024
@arya2 arya2 requested review from a team as code owners June 21, 2024 19:17
@arya2 arya2 requested review from upbqdn and removed request for a team June 21, 2024 19:17
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label Jun 21, 2024
upbqdn
upbqdn previously approved these changes Jun 27, 2024
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
book/src/user/custom-testnets.md Show resolved Hide resolved
book/src/user/custom-testnets.md Show resolved Hide resolved
book/src/user/custom-testnets.md Show resolved Hide resolved
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
mergify bot added a commit that referenced this pull request Jun 27, 2024
Co-authored-by: Marek <mail@marek.onl>
@arya2 arya2 requested a review from upbqdn June 27, 2024 18:09
Co-authored-by: Arya <aryasolhi@gmail.com>
upbqdn
upbqdn previously approved these changes Jun 27, 2024
book/src/user/custom-testnets.md Outdated Show resolved Hide resolved
mergify bot added a commit that referenced this pull request Jun 27, 2024
mergify bot added a commit that referenced this pull request Jun 28, 2024
@mergify mergify bot merged commit 979ed0d into main Jun 28, 2024
188 of 189 checks passed
@mergify mergify bot deleted the custom-testnet-docs branch June 28, 2024 00:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: Documentation C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG P-Low ❄️
Projects
None yet
Development

Successfully merging this pull request may close these issues.

add(docs): Describe custom testnets and their difference from Regtest
2 participants