BIP 350: Implement Bech32m and use it for v1+ segwit addresses (0.21 backport) #21469

sipa commented at 8:54 PM on March 18, 2021: member

Backport of #20861. Also includes #21471.

fanquake added the label Backport on Mar 18, 2021

sipa force-pushed on Mar 18, 2021

sipa renamed this:
~~Implement Bech32m encoding/decoding (0.21 backport)~~
BIP 350: Implement Bech32m and use it for v1+ segwit addresses (0.21 backport)
on Mar 18, 2021

jnewbery commented at 9:58 AM on March 19, 2021: member

utACK 28b3a32060

I repeated the backport myself and got the same result.

You could also pick the rpc_invalid_address_message.py functional test, removing the precise error messages (which aren't returned in v0.21):

<details> <summary>rpc_invalid_address_message.py</summary>

#!/usr/bin/env python3
# Copyright (c) 2020 The Bitcoin Core developers
# Distributed under the MIT software license, see the accompanying
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
"""Test error messages for 'getaddressinfo' and 'validateaddress' RPC commands."""

from test_framework.test_framework import BitcoinTestFramework

from test_framework.util import (
    assert_equal,
    assert_raises_rpc_error,
)

BECH32_VALID = 'bcrt1qtmp74ayg7p24uslctssvjm06q5phz4yrxucgnv'
BECH32_INVALID_BECH32 = 'bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqdmchcc'
BECH32_INVALID_BECH32M = 'bcrt1qw508d6qejxtdg4y5r3zarvary0c5xw7k35mrzd'
BECH32_INVALID_VERSION = 'bcrt130xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqynjegk'
BECH32_INVALID_SIZE = 'bcrt1s0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7v8n0nx0muaewav25430mtr'
BECH32_INVALID_V0_SIZE = 'bcrt1qw508d6qejxtdg4y5r3zarvary0c5xw7kqqq5k3my'
BECH32_INVALID_PREFIX = 'bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7k7grplx'

BASE58_VALID = 'mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn'
BASE58_INVALID_PREFIX = '17VZNX1SN5NtKa8UQFxwQbFeFc3iqRYhem'

INVALID_ADDRESS = 'asfah14i8fajz0123f'

class InvalidAddressErrorMessageTest(BitcoinTestFramework):
    def set_test_params(self):
        self.setup_clean_chain = True
        self.num_nodes = 1

    def skip_test_if_missing_module(self):
        self.skip_if_no_wallet()

    def test_validateaddress(self):
        node = self.nodes[0]

        # Bech32
        info = node.validateaddress(BECH32_INVALID_SIZE)
        assert not info['isvalid']

        info = node.validateaddress(BECH32_INVALID_PREFIX)
        assert not info['isvalid']

        info = node.validateaddress(BECH32_INVALID_BECH32)
        assert not info['isvalid']

        info = node.validateaddress(BECH32_INVALID_BECH32M)
        assert not info['isvalid']

        info = node.validateaddress(BECH32_INVALID_V0_SIZE)
        assert not info['isvalid']

        info = node.validateaddress(BECH32_VALID)
        assert info['isvalid']
        assert 'error' not in info

        # Base58
        info = node.validateaddress(BASE58_INVALID_PREFIX)
        assert not info['isvalid']

        info = node.validateaddress(BASE58_VALID)
        assert info['isvalid']
        assert 'error' not in info

        # Invalid address format
        info = node.validateaddress(INVALID_ADDRESS)
        assert not info['isvalid']

    def test_getaddressinfo(self):
        node = self.nodes[0]

        assert_raises_rpc_error(-5, "Invalid address", node.getaddressinfo, BECH32_INVALID_SIZE)

        assert_raises_rpc_error(-5, "Invalid address", node.getaddressinfo, BECH32_INVALID_PREFIX)

        assert_raises_rpc_error(-5, "Invalid address", node.getaddressinfo, BASE58_INVALID_PREFIX)

        assert_raises_rpc_error(-5, "Invalid address", node.getaddressinfo, INVALID_ADDRESS)

    def run_test(self):
        self.test_validateaddress()
        self.test_getaddressinfo()


if __name__ == '__main__':
    InvalidAddressErrorMessageTest().main()

</details>

gruve-p commented at 9:46 AM on March 21, 2021: contributor

ACK https://github.com/bitcoin/bitcoin/pull/21469/commits/28b3a3206097b89c7cf5f510e83f6027324b51c8

MarcoFalke commented at 7:24 AM on March 22, 2021: member

cherry-pick-only ACK 28b3a3206097b89c7cf5f510e83f6027324b51c8 did not review code nor test 👓

<details><summary>Show signature and timestamp</summary>

Signature:

Timestamp of file with hash f15d8f2dd34efe4f3f1fb17b1645f6fb3541a505d0c1a3d25a6c888cd487a5f9 -

</details>

sipa commented at 8:45 AM on March 24, 2021: member

@jnewbery Added a commit that does that.

laanwj added this to the milestone 0.21.1 on Mar 24, 2021

jnewbery commented at 7:46 PM on March 25, 2021: member

Oops. Sorry. I think the linter is failing because of an unused import:

diff --git a/test/functional/rpc_invalid_address_message.py b/test/functional/rpc_invalid_address_message.py
index 4626f62b0f..814f50c9e6 100755
--- a/test/functional/rpc_invalid_address_message.py
+++ b/test/functional/rpc_invalid_address_message.py
@@ -6,10 +6,7 @@
 
 from test_framework.test_framework import BitcoinTestFramework
 
-from test_framework.util import (
-    assert_equal,
-    assert_raises_rpc_error,
-)
+from test_framework.util import assert_raises_rpc_error
 
 BECH32_VALID = 'bcrt1qtmp74ayg7p24uslctssvjm06q5phz4yrxucgnv'
 BECH32_INVALID_BECH32 = 'bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqdmchcc'

sipa force-pushed on Mar 27, 2021

sipa commented at 7:06 PM on March 27, 2021: member

@jnewbery Thanks, fixed!

Implement Bech32m encoding/decoding

Github-Pull: #20861
Rebased-From: da2bb6976dadeec682d163c258c9afecc87d6428

1485533092

Add Bech32m test vectors

Github-Pull: #20861
Rebased-From: 25b1c6e13ddf1626210d5e3d37298d1f3a78a94f

8944aaa6d6

Use Bech32m encoding for v1+ segwit addresses

This also includes updates to the Python test framework implementation,
test vectors, and release notes.

Github-Pull: #20861
Rebased-From: fe5e495c31de47b0ec732b943db11fe345d874af

593e206627

Add signet support to gen_key_io_test_vectors.py

Github-Pull: #20861
Rebased-From: 2e7c80fb5be82ad4a3f737cab65b31f70a772a23

7dfe406e20

naming nits

Github-Pull: #20861
Rebased-From: 03346022d611871f2cc185440b19d928b9264d9d

1e9671116f

Backport invalid address tests

Reduced version of the test from master/#20861 by John Newbery.

Github-Pull: #20861
Rebased-From: fe5e495c31de47b0ec732b943db11fe345d874af

f2195d7c4a

sipa force-pushed on Mar 27, 2021

sipa commented at 7:10 PM on March 27, 2021: member

Updated to mention v0.21.1 in bips.md.

jnewbery commented at 12:48 PM on March 28, 2021: member

utACK f2195d7c4aa45f5168ec55b14406aeaf970adcb1

Verified the range-diff. Only difference is the versions in bips.md and removing the unnecessary import in rpc_invalid_address_message.py.

fanquake approved

fanquake commented at 7:47 AM on March 31, 2021: member

ACK f2195d7c4aa45f5168ec55b14406aeaf970adcb1 - performed the backport, changes look sane. Have not tested extensively.

MarcoFalke commented at 10:33 AM on April 1, 2021: member

cherry-pick re-ACK f2195d7c4aa45f5168ec55b14406aeaf970adcb1 , only change is version number in doc/bips and new test commit 🍝

<details><summary>Show signature and timestamp</summary>

Signature:

Timestamp of file with hash ba4c4b4eae9f449f1acbdb456b67bb75fc44f409fb63b3ab5b9c63aa98bb8190 -

</details>

MarcoFalke merged this on Apr 1, 2021

MarcoFalke closed this on Apr 1, 2021

DrahtBot locked this on Aug 16, 2022