bech32: add new EncodeM and DecodeGeneric functions for bech32 #202
Conversation
|
Mentioning here so we don't forget - we should probably update the relevant Bitcoin wiki article: https://en.bitcoin.it/wiki/Bech32_adoption#Libraries |
|
Fixed typos, fixed linter error. |
| // Calculate the expected checksum, given the hrp and payload data. | ||
| // Calculate the expected checksum, given the hrp and payload | ||
| // data. We'll actually compute _both_ possibly valid checksum | ||
| // to further aide in debugging. |
There was a problem hiding this comment.
Cool, should be very useful to the user.
| {"an83characterlonghumanreadablepartthatcontainsthenumber1andtheexcludedcharactersbio1tt5tgs", Version0}, | ||
| {"abcdef1qpzry9x8gf2tvdw0s3jn54khce6mua7lmqqqxw", Version0}, | ||
| {"11qqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqqc8247j", Version0}, | ||
| {"split1checkupstagehandshakeupstreamerranterredcaperred2y9e3w", Version0}, |
There was a problem hiding this comment.
Should we throw a valid bech32 segwit v1 address in here just for completeness' sake? E.g. bc1puxkz8vpy900c7z4q4302lkc3jjr2s42mayfqzzgr5yqdk5mgma3s0kntlh
There was a problem hiding this comment.
Yeah, wouldn't hurt. I guess we'd recommend implementing all test vectors from the BIP. The last one in the "valid" section of the v0-v16 test vectors, bc1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqzk5jj0, also encodes a P2TR locking script.
Yeah exactly, the idea is that say in |
|
Looks like someone sent btc to the test vector mentioned above... most block explorers are unable to parse |
In this commit, we add an additional field to the ErrInvalidChecksum, the bech32m version of a checksum. When decoding, we don't now what version they actually _intended_ to use, so we'll opt to include both checksums to aide in debugging and error reporting.
In this commit, we add two new package level functions: `EncodeM`, and `DecodeGeneric`. The new encode method is intended to allow callers to specify that they want to use the new bech32m checksum. This should be used when encoding segwit addresses with version 1 and beyond. The new `DecodeGeneric` function allows a caller to decode a bech32 and bech32m string with a single function. A new return value is added which is the version of the returned bech32 string, which allows callers to perform additional segwit addr validation (v1+ should use bech32m etc). We opted to add new functions rather than modifying the existing functions to not cause a breaking API change, as most uses in the wild can just use the existing functions, and only taproot related logic/code needs to worry about the new methods. A series of tests have been added to ensure that `DecodeGeneric` extracts the proper bech version, and we've also adopted the bech32m tests from BIP 350.
|
I've added all the additional test vectors. Note that this PR doesn't implement new versions of |
In this commit, we add two new package level functions:
EncodeM, andDecodeGeneric. The new encode method is intended to allow callers tospecify that they want to use the new bech32m checksum. This should be
used when encoding segwit addresses with version 1 and beyond. The new
DecodeGenericfunction allows a caller to decode a bech32 and bech32mstring with a single function. A new return value is added which is the
version of the returned bech32 string, which allows callers to perform
additional segwit addr validation (v1+ should use bech32m etc).
We opted to add new functions rather than modifying the existing
functions to not cause a breaking API change, as most uses in the wild
can just use the existing functions, and only taproot related logic/code
needs to worry about the new methods.
A series of tests have been added to ensure that
DecodeGenericextracts the proper bech version, and we've also adopted the bech32m
tests from BIP 350.
Fixes part of btcsuite/btcd#1735.
Fixes #195