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

Release tracking PR: v0.6.0 #49

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from

Conversation

tcharding
Copy link
Member

Draft because on top of #45, #46, and #48.

This release is mainly because I want to introduce @jamillambert to this repository. Before doing so I want the everything in a state that he has some chance of understanding whats going on.

  • Fix up the docs
  • Explain the repo and the tooling
  • Fix the bugs (the ones I know about anyways)

Currently the `node` crate cannot run multiple instances of Bitcoin Core
v28 because of changes to bind logic in that release.

The solution is to use `-bind` instead of `-port`.

For more information on the relevant changes in Core v28 see:

https://github.com/bitcoin/bitcoin/blob/master/doc/release-notes/release-notes-28.0.md#p2p-and-network-changes

This patch was created with help of @MaxFangX - mad props.

Fix: rust-bitcoin#41
Every single use statement in `client_versions` has an `allow`
attribute; this is too noisy.
If no features are enabled then a few things happen:

- `bitcoind` from `$PATH` is used.
- We assume Core version 28

This means that in order to make `--no-default-features` build (which is
a reasonable expectation) there are implicit requirements on the
environment - this is bad but I see no other solution ATM.

Improve the code comments, make the attributes uniform, and add missing
version to the no-feature-enabled logic.

Document the `bitcoind` version requirements in the README.
The `default` feature is problematic because it overrides
`--features=xyz` if `--no-default-features` is used.

Remove it.
We moved the `jsonrpc` crate here a while ago but forgot to mention it
in the crate list in the repo README - do so.
The problems this crate solves and does not solve is not immediately
obvious. Make an effort to explain them.
We have a bunch of stale MSRV docs. Update them all and make the form
uniform.
The `types` crate is currently under documented. Improve the
documentation in the crate's readme.
In preparation for release bump the version numbers of `types`,
`client`, and `node` to `0.6.0`.

Add changelog entries to each and update the lock files.
@tcharding tcharding marked this pull request as draft January 23, 2025 01:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant