tr(KEY) in doc/descriptors.md
#30279
Bitcoin Core uses BIP-386 for tr(...) descriptors, and in the case of tr(KEY), the produced key is tweaked according to BIP-341:
In the current descriptors.md, it is documented that tr(KEY) uses KEY as the internal key, with no further comment:
By looking only at descriptors.md without knowledge or reference to BIP-386, one can interpret tr(KEY) to use KEY directly without tweaking.
Ideally the docs should be expanded to reference BIP-386.
I thought the phrase “internal key” is unambiguous to mean that the key will need tweaking, as that is how BIP 341 defines that phrase.
It might make sense to remove descriptors.md since it’s ostensibly superseded by the BIPs too.
I for one was confused. Imo being explicit is better than being implicit. “internal key” is ambiguous to me, as it means it is untweaked, but it does not mean it must be tweaked. BIP-341 merely says “should”.
Removing the descriptors.md in in favor of BIPs is not optimal, because:
I think the best would be to complete the docs and link to the relevant BIPs. In this particular issue, linking to BIP-386 for tr(...) descriptors and mentioning that tr(KEY) uses the tweak described in BIP-341 would make the docs here much more useful.
Other parts are also not up to date, like the support for miniscript expressions for SCRIPT. There it would also be great to expand the docs and link to https://bitcoin.sipa.be/miniscript/ (afaik there is no BIP for that).
There it would also be great to expand the docs and link to https://bitcoin.sipa.be/miniscript/ (afaik there is no BIP for that).
There is re recent PR in BIP repo.
Labels
Docs
Descriptors