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.

Sign up for GitHub

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

Jump to bottom

add(book): Adds a section on Regtest usage to the Zebra book #8526

Merged
merged 12 commits into from
May 22, 2024
Merged

add(book): Adds a section on Regtest usage to the Zebra book #8526

merged 12 commits into from
May 22, 2024

Conversation

arya2
Copy link
Contributor

@arya2 arya2 commented May 14, 2024 •
edited

Motivation

We want to provide guidance on how to use Regtest with Zebra.

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

  • Sets config.mempool.debug_enable_at_height to 0 when network is Regtest to simplify configuration requirements
  • Uses full network name in logs for Regtest and custom testnets
  • Adds a section to the Zebra book on how to use Regtest

Testing

Manually tested that the section's been added to the book with mdbook serve -o ./book

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.

@arya2 arya2 added A-docs Area: Documentation P-Medium ⚡ labels May 14, 2024
@arya2 arya2 added this to the Regtest Network support milestone May 14, 2024
@arya2 arya2 self-assigned this May 14, 2024
@arya2 arya2 requested a review from a team as a code owner May 14, 2024 20:10
@arya2 arya2 requested review from oxarbitrage and removed request for a team May 14, 2024 20:10
@github-actions github-actions bot added the C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG label May 14, 2024
mergify bot added a commit that referenced this pull request May 15, 2024
@mergify
Merge of #8526
3f34055
oxarbitrage
oxarbitrage reviewed May 15, 2024
View reviewed changes
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we need a bit more of information. I tried to follow the tutorial and start to got stuck on what to do next. I planned figuring out myself and add to the document but probably @arya2 has these info already.

book/src/user/regtest.md Outdated Show resolved Hide resolved
book/src/user/regtest.md Show resolved Hide resolved
book/src/user/regtest.md Show resolved Hide resolved
arya2
arya2 commented May 15, 2024
View reviewed changes
book/src/user/regtest.md Outdated Show resolved Hide resolved
arya2
arya2 commented May 15, 2024
View reviewed changes
book/src/user/regtest.md Outdated Show resolved Hide resolved
@arya2 arya2 added the I-usability Zebra is hard to understand or use label May 15, 2024
mergify bot added a commit that referenced this pull request May 15, 2024
@mergify
Merge of #8526
b59e61b
@mergify mergify bot mentioned this pull request May 15, 2024
Closed
1 task
@arya2 arya2 requested a review from oxarbitrage May 16, 2024 00:55
@oxarbitrage @arya2
apply some extra information
285d782 
Co-authored-by: Arya <aryasolhi@gmail.com>
mergify bot added a commit that referenced this pull request May 16, 2024
@mergify
Merge of #8526
e79c511
@mergify mergify bot mentioned this pull request May 16, 2024
Closed
1 task
oxarbitrage
oxarbitrage previously approved these changes May 16, 2024
View reviewed changes
Copy link
Contributor

@oxarbitrage oxarbitrage left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me, thanks for the changes. I had not tested the RPC way but looks ok, tested using the internal miner way, works as described in the tutorial.

@arya2
Copy link
Contributor Author

arya2 commented May 17, 2024

@Mergifyio refresh

@mergify Mergify
Copy link
Contributor

mergify bot commented May 17, 2024

refresh

✅ Pull request refreshed

mergify bot added a commit that referenced this pull request May 17, 2024
@mergify
Merge of #8526
87ef61c
@mergify mergify bot mentioned this pull request May 17, 2024
Closed
5 tasks
@arya2
Copy link
Contributor Author

arya2 commented May 17, 2024

@Mergifyio refresh

@mergify Mergify
Copy link
Contributor

mergify bot commented May 17, 2024

refresh

✅ Pull request refreshed

mergify bot added a commit that referenced this pull request May 17, 2024
@mergify
Merge of #8526
74a35dc
@mergify mergify bot mentioned this pull request May 17, 2024
Closed
5 tasks
mergify bot added a commit that referenced this pull request May 18, 2024
@mergify
Merge of #8526
b9b9f84
@mergify mergify bot mentioned this pull request May 18, 2024
Closed
9 tasks
@oxarbitrage
Copy link
Contributor

Need approval from someone else:

New changes require approval from someone other than oxarbitrage because they were the last pusher.

https://github.com/ZcashFoundation/zebra/pull/8526/checks?check_run_id=25136136941

upbqdn
upbqdn previously approved these changes May 21, 2024
View reviewed changes
book/src/user/regtest.md Outdated Show resolved Hide resolved
book/src/user/regtest.md Outdated Show resolved Hide resolved
book/src/user/regtest.md Outdated Show resolved Hide resolved
book/src/user/regtest.md Outdated Show resolved Hide resolved
book/src/user/regtest.md Outdated Show resolved Hide resolved
@arya2 arya2 dismissed stale reviews from upbqdn and oxarbitrage via 4baf595 May 21, 2024 13:44
@arya2 @upbqdn
Apply suggestions from code review
4baf595 
Co-authored-by: Marek <mail@marek.onl>
@arya2 arya2 requested review from upbqdn and oxarbitrage May 21, 2024 13:44
mergify bot added a commit that referenced this pull request May 21, 2024
@mergify
Merge of #8526
04f39f9
@mergify mergify bot mentioned this pull request May 21, 2024
Closed
5 tasks
@upbqdn
Copy link
Member

upbqdn commented May 21, 2024

I merged main into this PR, which restarted CI. Let's see if it merges.

@upbqdn
Copy link
Member

upbqdn commented May 21, 2024 •
edited

@gustavovalverde, it looks like this PR has troubles with the embarking.

@gustavovalverde
Copy link
Member

@Mergifyio requeue

@mergify Mergify
Copy link
Contributor

mergify bot commented May 22, 2024

requeue

✅ The queue state of this pull request has been cleaned. It can be re-embarked automatically

@mergify mergify bot merged commit 3147d20 into main May 22, 2024
190 checks passed
@mergify mergify bot deleted the regtest-docs branch May 22, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@upbqdn upbqdn upbqdn approved these changes

@oxarbitrage oxarbitrage oxarbitrage approved these changes

Assignees

@arya2 arya2

Labels
A-docs Area: Documentation C-trivial Category: A trivial change that is not worth mentioning in the CHANGELOG I-usability Zebra is hard to understand or use P-Medium ⚡
Projects
Zebra
Status: Done
Milestone
Regtest Network support
Development

Successfully merging this pull request may close these issues.

None yet
5 participants
@arya2 @oxarbitrage @upbqdn @gustavovalverde @mpguerra