Skip to content

Conversation

harding
Copy link
Contributor

@harding harding commented Aug 23, 2019

Merges in detached release notes, edits each change down to a single paragraph bullet point (or, in a couple cases, two individual bullet points in separate sections each with a single paragraph). Adds notes for some undocumented changes I found reviewing git log --merges. Also tries something new: adds the PR number(s) after each entry to make it easier for both reviewers and end-user readers to look up the details behind each change. (If the PR numbers are unwanted, they're easy to remove either in this PR or later in the release process.)

I also checked the 0.18 branch but I didn't find anything in the current release notes that had been backported.

A particular focus in my editing was trying to keep things concise, particularly by pointing to RPC documentation when available (or upcoming, as in #16629). I do suspect that one downside of detached notes is that people write longer summaries than they would if they knew there were already 300 other lines of release notes. :-)

The first commit only moves notes, puts them in bullet form, adjusts indentation appropriately, and drops unneeded headers. It can be reviewed with git diff --color-moved=dimmed-zebra for a little bit of a speedup, but unfortunately I wasn't smart enough to split my copy/pasting and line wrapping into separate commits, so it's not a transparently move-only change.

@fanquake fanquake added the Docs label Aug 23, 2019
@fanquake fanquake added this to the 0.19.0 milestone Aug 23, 2019
@DrahtBot
Copy link
Contributor

The following sections might be updated with supplementary metadata relevant to reviewers and maintainers.

Conflicts

Reviewers, this pull request conflicts with the following ones:

  • #16539 (wallet: lower -txmaxfee default from 0.1 to 0.01 BTC by Sjors)
  • #16492 (rpc: Add feeRate argument to bumpFee RPC by ezegom)

If you consider this pull request important, please also help to review the conflicting pull requests. Ideally, start with the one that should be merged first.

connect to older versions of Bitcoin Core and users who have manually
enabled NODE_BLOOM support for the near future, but developers of such
software should consider migrating to an alternative over the coming
years. (#16152)
Copy link
Contributor

Choose a reason for hiding this comment

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

I think this is not good advise.
BIP37, when connected to your own node, is the most efficient way to get a light wallet without the need of installing middlewares or the need of separate index incompatible with pruning.

For this reason, whitebind and whitelist now support the bloomfilter permission, so whitelisted peer can still enjoy BIP37.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'll add a mention of the bloomfilter permission (the ability to specify per-peer/network/interface options via white* is already mentioned in the document).

That said, I'm skeptical of your argument. For privacy, BIP37 needs to be over a secure private link (e.g. authenticated and encrypted), and if you have that, you can just run the wallet RPCs for even higher efficiency than BIP37 with minimal false positives. Your pruning argument doesn't make sense to me (BIP37 needs full blocks, so it has problems with pruning that BIP158 doesn't---with BIP158, you can create the block filter and then throw away the full block and undo data); if you're thinking about Electrum-style indexes or Electrum Personal Server rescanning, BIP37 seems equivalent in problems related to pruning). This is probably off-topic for release notes discussion, though, so DM me on IRC or poke me in #bitcoin if you're bored and want to debate it. :-)

Copy link
Contributor

Choose a reason for hiding this comment

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

DMed on twitter :)

Copy link
Member

@fanquake fanquake left a comment

Choose a reason for hiding this comment

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

Thanks for following up with this, looks pretty good. I've been through and checked PR numbers, links, RPC behavior changes etc. Left a few comments inline.

New RPCs
--------

- `getbalances` returns an object with all balances (`mine`,
`untrusted_pending` and `immature`). Please refer to the RPC help of
`getbalances` for details. The new RPC is intended to replace
`getunconfirmedbalance` and the balance fields in `getwalletinfo`, as well as
`getbalance`. The old calls may be removed in a future version.
`getbalance`, `getunconfirmedbalance`, and the balance fields in
Copy link
Member

@hebasto hebasto Aug 23, 2019

Choose a reason for hiding this comment

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

Is the second comma redundant?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Among writers, whether or not to always use the serial comma is our version of vi versus emacs. Here's the first search result for the issue, which seems reasonably descriptive and even-handed. I fall into the camp of people who always use the serial comma, but I willing to do lazy commas if necessary with only a few sotto voce grumblings as if you had also asked me to work in emacs. :-)

@harding harding force-pushed the 2019-08-0.19-notes branch from 6bc4c75 to 74e3876 Compare August 23, 2019 19:15
@harding
Copy link
Contributor Author

harding commented Aug 23, 2019

Forced pushed with updates for the provided feedback. Thanks for the reviews @NicolasDorier, @fanquake, and @hebasto!

Copy link
Member

@fanquake fanquake left a comment

Choose a reason for hiding this comment

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

ACK 74e3876 - Thanks for doing this. It's nice to have a gauge of what's going to be in the 0.19.0 release.

Copy link
Contributor

@meshcollider meshcollider left a comment

Choose a reason for hiding this comment

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

Overall looks great, thanks @harding !

ACK 74e3876

Just a couple of small comments that can be done in followups if needed (since this file will still undergo modifications right up until release)

RPC changes
-----------

RPCs which have an `include_watchonly` argument or `includeWatching`
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this detached release note was lost?

Copy link
Member

Choose a reason for hiding this comment

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

Jup, this is missing now.

Copy link
Contributor

Choose a reason for hiding this comment

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

this was never fixed right? I don't see it :(


See the RPC help text for full details.

- The -maxtxfee setting no longer has any effect on non-wallet RPCs.
Copy link
Contributor

Choose a reason for hiding this comment

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

note: this was also dropped (seems ok though)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This was just substantially rewritten. Original was:

- The -maxtxfee setting no longer has any effect on non-wallet RPCs.

  The `sendrawtransaction` and `testmempoolaccept` RPC methods previously
  accepted an `allowhighfees` parameter to fail the mempool acceptance in case
  the transaction's fee would exceed the value of the command line argument
  `-maxtxfee`. To uncouple the RPCs from the global option, they now have a
  hardcoded default for the maximum transaction fee, that can be changed for
  both RPCs on a per-call basis with the `maxfeerate` parameter. The
  `allowhighfees` boolean option has been removed and replaced by the
  `maxfeerate` numeric option.

Revised is:

- `sendrawtransaction` and `testmempoolaccept` no longer accept a
  `allowhighfees` parameter to fail mempool acceptance if the
  transaction fee exceedes the value of the configuration option
  `-maxtxfee`.  Now there is a hardcoded default maximum feerate that
  can be changed when calling either RPC using a `maxfeerate` parameter.
  (#15620)

The other note you identified as lost does seem to be so. I'll create a followup PR for that and the formatting change. Thanks!

Updated settings
----------------

- `whitebind` and `whitelist` now accept a list of permissions to
Copy link
Contributor

Choose a reason for hiding this comment

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

-whitebind and -whitelist

meshcollider added a commit that referenced this pull request Aug 24, 2019
74e3876 Release notes: add previously undocumented changes (David A. Harding)
7e1634a Release notes: edit previously-detached notes (David A. Harding)
e7415a5 Doc: move detached release notes into release-notes.md (David A. Harding)

Pull request description:

  Merges in detached release notes, edits each change down to a single paragraph bullet point (or, in a couple cases, two individual bullet points in separate sections each with a single paragraph).  Adds notes for some undocumented changes I found reviewing `git log --merges`.  Also tries something new: adds the PR number(s) after each entry to make it easier for both reviewers and end-user readers to look up the details behind each change.  (If the PR numbers are unwanted, they're easy to remove either in this PR or later in the release process.)

  I also checked the 0.18 branch but I didn't find anything in the current release notes that had been backported.

  A particular focus in my editing was trying to keep things concise, particularly by pointing to RPC documentation when available (or upcoming, as in #16629).  I do suspect that one downside of detached notes is that people write longer summaries than they would if they knew there were already 300 other lines of release notes.  :-)

  The first commit only moves notes, puts them in bullet form, adjusts indentation appropriately, and drops unneeded headers.  It can be reviewed with `git diff --color-moved=dimmed-zebra` for a little bit of a speedup, but unfortunately I wasn't smart enough to split my copy/pasting and line wrapping into separate commits, so it's not a transparently move-only change.

ACKs for top commit:
  fanquake:
    ACK 74e3876 - Thanks for doing this. It's nice to have a gauge of what's going to be in the `0.19.0` release.
  meshcollider:
    ACK 74e3876

Tree-SHA512: 676668765849d5a67520dd8ac49de85ac1bfb5ba2dc09504e75db77d79c7e2c58b5cee16c58591ec575cb3682e630231baba7fd07565d19f8d02243e06fcb9ab
@meshcollider meshcollider merged commit 74e3876 into bitcoin:master Aug 24, 2019
sidhujag pushed a commit to syscoin/syscoin that referenced this pull request Aug 25, 2019
74e3876 Release notes: add previously undocumented changes (David A. Harding)
7e1634a Release notes: edit previously-detached notes (David A. Harding)
e7415a5 Doc: move detached release notes into release-notes.md (David A. Harding)

Pull request description:

  Merges in detached release notes, edits each change down to a single paragraph bullet point (or, in a couple cases, two individual bullet points in separate sections each with a single paragraph).  Adds notes for some undocumented changes I found reviewing `git log --merges`.  Also tries something new: adds the PR number(s) after each entry to make it easier for both reviewers and end-user readers to look up the details behind each change.  (If the PR numbers are unwanted, they're easy to remove either in this PR or later in the release process.)

  I also checked the 0.18 branch but I didn't find anything in the current release notes that had been backported.

  A particular focus in my editing was trying to keep things concise, particularly by pointing to RPC documentation when available (or upcoming, as in bitcoin#16629).  I do suspect that one downside of detached notes is that people write longer summaries than they would if they knew there were already 300 other lines of release notes.  :-)

  The first commit only moves notes, puts them in bullet form, adjusts indentation appropriately, and drops unneeded headers.  It can be reviewed with `git diff --color-moved=dimmed-zebra` for a little bit of a speedup, but unfortunately I wasn't smart enough to split my copy/pasting and line wrapping into separate commits, so it's not a transparently move-only change.

ACKs for top commit:
  fanquake:
    ACK 74e3876 - Thanks for doing this. It's nice to have a gauge of what's going to be in the `0.19.0` release.
  meshcollider:
    ACK 74e3876

Tree-SHA512: 676668765849d5a67520dd8ac49de85ac1bfb5ba2dc09504e75db77d79c7e2c58b5cee16c58591ec575cb3682e630231baba7fd07565d19f8d02243e06fcb9ab
the selected network. This change takes only effect if the selected network
is not mainnet.
- A setting specified in the default section but not also specified in a
network-specific section (e.g. testnet) will now produce a error
Copy link
Member

Choose a reason for hiding this comment

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

s/a error/an error/

?

`descriptor` field). (#15986)

- `walletcreatefundedpsbt` now signals BIP125 Replace-by-Fee if the
`-walletrbf` configuration option is set to true. (#15911)
Copy link
Member

Choose a reason for hiding this comment

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

This will be release in 0.18.2, so I'd rather mention it in those release notes.

@maflcko
Copy link
Member

maflcko commented Aug 26, 2019

ACK

@fanquake fanquake mentioned this pull request Oct 1, 2019
19 tasks
@bitcoin bitcoin locked as resolved and limited conversation to collaborators Dec 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants