Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 18 additions & 4 deletions src/validators/crypto_addresses/btc_address.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,20 @@ def _decode_base58(addr: str):

def _validate_old_btc_address(addr: str):
"""Validate P2PKH and P2SH type address."""
if len(addr) not in range(25, 35):
if not re.fullmatch(
r"1[1-9A-HJ-NP-Za-km-z]{24,33}"
r"|[3mn][1-9A-HJ-NP-Za-km-z]{33}"
r"|2[1-9A-HJ-NP-Za-km-z]{34}",
addr,
):
return False
try:
decoded_bytes = _decode_base58(addr).to_bytes(25, "big")
except OverflowError:
return False
decoded_bytes = _decode_base58(addr).to_bytes(25, "big")
header, checksum = decoded_bytes[:-4], decoded_bytes[-4:]
if header[0] not in {0x00, 0x05, 0x6F, 0xC4}:
return False
return checksum == sha256(sha256(header).digest()).digest()[:4]


Expand Down Expand Up @@ -49,8 +59,12 @@ def btc_address(value: str, /):
return False

return (
# segwit pattern
re.compile(r"^(bc|tb)[0-3][02-9ac-hj-np-z]{14,74}$").fullmatch(value)
# segwit pattern (BIP-173 / BIP-350)
re.fullmatch(
r"(bc|tb)1(?:q(?:[02-9ac-hj-np-z]{38}|[02-9ac-hj-np-z]{58})"
r"|[pzry9x8gf2tvdw0s][02-9ac-hj-np-z]{10,70})",
value,
)
if value[:2] in ("bc", "tb")
else _validate_old_btc_address(value)
)
38 changes: 36 additions & 2 deletions tests/crypto_addresses/test_btc_address.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,21 @@
"1BvBMSEYstWetqTFn5Au4m4GFg7xJaNVN2",
# P2SH (Pay to script hash) type
"3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy",
# Bech32/segwit type
# Testnet P2PKH and P2SH
"mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn",
"n4fajahJrAuKbN7uNsKjLjQkz9Qn5ewJXQ",
"2MzQwSSnBHWHqSAqtTVQ6v47XtaisrJa1Vc",
# Bech32/segwit v0 type
"bc1qar0srrr7xfkvy5l643lydnw9re59gtzzwf5mdq",
"bc1qc7slrfxkknqcq2jevvvkdgvrt8080852dfjewde450xdlk4ugp7szw5tk9",
# Bech32/segwit testnet (tb prefix)
# Bech32/segwit v0 testnet
"tb1qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
"tb1qrp33g0q5c5txsp9arysrx4k6zdkfs4nce4xj0gdcccefvpysxf3qccfmv3",
# Bech32m/segwit v1-16
"bc1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqzk5jj0",
"tb1pqqqqp399et2xygdj5xreqhjjvcmzhxw4aywxecjdzew6hylgvsesf3hn0c",
"bc1sw50qgdz25j",
"bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kt5nd6y",
],
)
def test_returns_true_on_valid_btc_address(value: str):
Expand All @@ -36,6 +45,31 @@ def test_returns_true_on_valid_btc_address(value: str):
"1BvBMsEYstWetqTFn5Au4m4GFg7xJaNVN2",
# incorrect checksum
"3J98t1WpEZ73CNmQviecrnyiWrnqRhWNLz",
# valid Base58Check addresses from other blockchains
"TLjfbTbpZYDQ4EoA4N5CLNgGjfbF8ZWz38", # TRON (0x41)
"LajyQBeZaBA1NkZDeY8YT5RYYVRkXMvb2T", # Litecoin P2PKH (0x30)
"DH5yaieqoZN36fDVciNyRueRGvGLR3mr7L", # Dogecoin P2PKH (0x1e)
# valid Base58Check with matching Bitcoin prefix/length but non-Bitcoin version byte
"3R2e7gNMbRpjEZu5DCiLWBH8siHBC8immQ", # version 0x06
"2NGarBRJPCtL5SMXctLLD88GQ64VLy8dGrv", # version 0xc5
# leading '1' prepended to valid 34-char P2SH address
"13J98t1WpEZ73CNmQviecrnyiWrnqRhWNLy",
# 35-char Base58 strings overflowing 25 bytes
"z" * 35,
"2" + "z" * 34,
# invalid Bech32 separator
"bc0qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4",
"bc2qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4",
"bc3qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4",
"tb0qw508d6qejxtdg4y5r3zarvary0c5xw7kxpjzsx",
# invalid witness version
"bc13w508d6qejxtdg4y5r3zarvary0c5xw7kn40wf2",
# invalid witness v0 program length
"bc1qr508d6qejxtdg4y5r3zarvaryv98gj9p",
"bc1qw508d6qejxtdg4y5r3zarvary0c5xw7kv8f3t4a",
# invalid witness v1-16 program length
"bc1rw5uspcuh",
"bc10w508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7kw5rljs90",
],
)
def test_returns_failed_validation_on_invalid_btc_address(value: str):
Expand Down