address-encoder 1.0.2__tar.gz → 1.0.3__tar.gz

{address_encoder-1.0.2 → address_encoder-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: address-encoder
-Version: 1.0.2
+Version: 1.0.3
 Summary: Encodes and decodes address formats for various cryptocurrencies
 Project-URL: Homepage, https://github.com/ensdomains/address-encoder-py
 Project-URL: Repository, https://github.com/ensdomains/address-encoder-py
@@ -31,9 +31,11 @@ Description-Content-Type: text/markdown
 
 # address-encoder
 
-Encodes and decodes address formats for various cryptocurrencies. Converts addresses between human-readable text and their native binary representations for use with [EIP-2304](https://eips.ethereum.org/EIPS/eip-2304) and ENS multichain resolution.
+[![CI](https://github.com/ensdomains/address-encoder-py/actions/workflows/test.yml/badge.svg)](https://github.com/ensdomains/address-encoder-py/actions/workflows/test.yml)
 
-Source: [github.com/ensdomains/address-encoder-py](https://github.com/ensdomains/address-encoder-py)
+Encodes and decodes address formats for various cryptocurrencies.
+
+Converts addresses between human-readable text and their native binary representations for use with [EIP-2304](https://eips.ethereum.org/EIPS/eip-2304) and ENS multichain resolution.
 
 EVM compatible chains are either specified using SLIP-44 coin type or `0x80000000 | chainId` where `0x80000000` is the MSB (most significant bit) reserved at SLIP-44 and no coin types exist in that range. This is to avoid number collision with the existing coin types.
 

{address_encoder-1.0.2 → address_encoder-1.0.3}/README.md

@@ -1,8 +1,10 @@
 # address-encoder
 
-Encodes and decodes address formats for various cryptocurrencies. Converts addresses between human-readable text and their native binary representations for use with [EIP-2304](https://eips.ethereum.org/EIPS/eip-2304) and ENS multichain resolution.
+[![CI](https://github.com/ensdomains/address-encoder-py/actions/workflows/test.yml/badge.svg)](https://github.com/ensdomains/address-encoder-py/actions/workflows/test.yml)
 
-Source: [github.com/ensdomains/address-encoder-py](https://github.com/ensdomains/address-encoder-py)
+Encodes and decodes address formats for various cryptocurrencies.
+
+Converts addresses between human-readable text and their native binary representations for use with [EIP-2304](https://eips.ethereum.org/EIPS/eip-2304) and ENS multichain resolution.
 
 EVM compatible chains are either specified using SLIP-44 coin type or `0x80000000 | chainId` where `0x80000000` is the MSB (most significant bit) reserved at SLIP-44 and no coin types exist in that range. This is to avoid number collision with the existing coin types.
 

{address_encoder-1.0.2 → address_encoder-1.0.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "address-encoder"
-version = "1.0.2"
+version = "1.0.3"
 description = "Encodes and decodes address formats for various cryptocurrencies"
 readme = "README.md"
 license = "MIT"

address_encoder-1.0.3/src/address_encoder/utils/byron.py

@@ -0,0 +1,48 @@
+from __future__ import annotations
+
+from io import BytesIO
+
+import cbor2
+
+from address_encoder.utils.base58_ import base58_unchecked_decode, base58_unchecked_encode
+from address_encoder.utils.crc32 import crc32
+
+# Byron addresses are CBOR `[#6.24(address bytes), crc32(address bytes)]`
+_ADDRESS_TAG = 24
+
+
+def byron_encode(source: bytes) -> str:
+    checksum = crc32(source)
+    cbor_encoded = cbor2.dumps([cbor2.CBORTag(_ADDRESS_TAG, source), checksum])
+    address = base58_unchecked_encode(cbor_encoded)
+    if not address.startswith(("Ae2", "Ddz")):
+        raise ValueError("Unrecognised address format")
+    return address
+
+
+def byron_decode(source: str) -> bytes:
+    data = base58_unchecked_decode(source)
+    stream = BytesIO(data)
+    try:
+        decoded = cbor2.CBORDecoder(stream).decode()
+    except Exception as exc:
+        raise ValueError("Unrecognised address format") from exc
+    # Reject trailing bytes after the CBOR item
+    if stream.tell() != len(data):
+        raise ValueError("Unrecognised address format")
+
+    if not isinstance(decoded, list) or len(decoded) != 2:
+        raise ValueError("Unrecognised address format")
+
+    tagged_address, checksum = decoded
+    if (
+        not isinstance(tagged_address, cbor2.CBORTag)
+        or tagged_address.tag != _ADDRESS_TAG
+        or not isinstance(tagged_address.value, bytes)
+    ):
+        raise ValueError("Unrecognised address format")
+    value: bytes = tagged_address.value
+
+    if type(checksum) is not int or crc32(value) != checksum:
+        raise ValueError("Unrecognised address format")
+    return value

{address_encoder-1.0.2 → address_encoder-1.0.3}/src/address_encoder/utils/bytes_.py

@@ -1,5 +1,8 @@
 from __future__ import annotations
 
+import re
+
+_HEX_REGEX = re.compile(r"[0-9a-fA-F]*")
 
 def hex_to_bytes(hex_value: str) -> bytes:
     hex_string = hex_value[2:] if hex_value.startswith("0x") else hex_value
@@ -39,5 +42,11 @@ def base10_to_bytes(value: str) -> bytes:
     return number.to_bytes(length, "big")
 
 
+def hex_without_prefix_to_bytes(hex_value: str) -> bytes:
+    # Strict, like @noble/hashes hexToBytes: no 0x prefix, even length, hex digits only
+    if len(hex_value) % 2 or not _HEX_REGEX.fullmatch(hex_value):
+        raise ValueError(f'Invalid hex sequence in "{hex_value}".')
+    return bytes.fromhex(hex_value)
+
+
 bytes_to_hex_without_prefix = lambda data: data.hex()
-hex_without_prefix_to_bytes = hex_to_bytes

{address_encoder-1.0.2 → address_encoder-1.0.3}/tests/test_icx.py

@@ -18,3 +18,13 @@ def test_icx_decode(text: str, hex_value: str) -> None:
 def test_icx_encode(expected_text: str, hex_value: str) -> None:
     assert encode_icx_address(bytes.fromhex(hex_value)) == expected_text
 
+
+@pytest.mark.parametrize('text', [
+        'hx' + '1' * 39,
+        'hx' + '12 ' * 20,
+        'hx0x' + '12' * 20,
+        'hx' + 'zz' * 20,
+])
+def test_icx_decode_rejects_malformed_hex(text: str) -> None:
+    with pytest.raises(ValueError):
+        decode_icx_address(text)

address_encoder-1.0.3/tests/test_utils_byron.py

@@ -0,0 +1,77 @@
+from __future__ import annotations
+
+import cbor2
+import pytest
+
+from address_encoder.utils.base58_ import base58_unchecked_encode
+from address_encoder.utils.byron import byron_decode, byron_encode
+from address_encoder.utils.crc32 import crc32
+
+ADDRESS = bytes.fromhex("83581cba970ad36654d8dd8f74274b733452ddeab9a62a397746be3c42ccdda000")
+TEXT = "Ae2tdPwUPEZFRbyhz3cpfC2CumGzNkFBN2L42rcUc2yjQpEkxDbkPodpMAi"
+
+
+def _encode_cbor(value: object) -> str:
+    return base58_unchecked_encode(cbor2.dumps(value))
+
+
+def test_byron_round_trip() -> None:
+    assert byron_encode(ADDRESS) == TEXT
+    assert byron_decode(TEXT) == ADDRESS
+
+
+# Truncated inputs from the upstream cborDecode() regression tests
+@pytest.mark.parametrize(
+    "data",
+    [
+        [],
+        [0xBF],
+        [0x9F],
+        [0x5F],
+        [0x7F],
+        [0xBF, 0x01],
+        [0xA1, 0x01],
+        [0x81],
+        [0x18],
+        [0x19, 0x00],
+        [0x1A, 0x00],
+        [0x1B, 0x00],
+        [0xFA, 0x00],
+        [0xFB, 0x00],
+        [0x41],
+        [0x61],
+        [0x61, 0xC2, 0xA2],
+        [0x7F, 0x61, 0xC2, 0xA2, 0xFF],
+        [0x9B, 0x00, 0x20, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00],
+    ],
+)
+def test_byron_rejects_truncated_cbor(data: list[int]) -> None:
+    with pytest.raises(ValueError, match="Unrecognised address format"):
+        byron_decode(base58_unchecked_encode(bytes(data)))
+
+
+@pytest.mark.parametrize(
+    "value",
+    [
+        5,
+        {0: 1, 1: 2},
+        [],
+        [cbor2.CBORTag(24, ADDRESS)],
+        [ADDRESS, crc32(ADDRESS)],
+        [cbor2.CBORTag(24, ADDRESS), crc32(ADDRESS), 0],
+        [cbor2.CBORTag(100, ADDRESS), crc32(ADDRESS)],
+        [cbor2.CBORTag(24, 5), 0],
+        [cbor2.CBORTag(24, "text"), 0],
+        [cbor2.CBORTag(24, ADDRESS), crc32(ADDRESS) + 1],
+        [cbor2.CBORTag(24, ADDRESS), str(crc32(ADDRESS))],
+    ],
+)
+def test_byron_rejects_malformed_structure(value: object) -> None:
+    with pytest.raises(ValueError, match="Unrecognised address format"):
+        byron_decode(_encode_cbor(value))
+
+
+def test_byron_rejects_trailing_bytes() -> None:
+    data = cbor2.dumps([cbor2.CBORTag(24, ADDRESS), crc32(ADDRESS)]) + b"\x00"
+    with pytest.raises(ValueError, match="Unrecognised address format"):
+        byron_decode(base58_unchecked_encode(data))

address_encoder-1.0.3/tests/test_utils_bytes.py

@@ -0,0 +1,40 @@
+from __future__ import annotations
+
+import pytest
+
+from address_encoder.utils.bytes_ import hex_to_bytes, hex_without_prefix_to_bytes
+
+
+@pytest.mark.parametrize(
+    ("text", "expected"),
+    [
+        ("", b""),
+        ("00", b"\x00"),
+        ("beef", b"\xbe\xef"),
+        ("DeAdBeEf", b"\xde\xad\xbe\xef"),
+    ],
+)
+def test_hex_without_prefix_to_bytes(text: str, expected: bytes) -> None:
+    assert hex_without_prefix_to_bytes(text) == expected
+
+
+@pytest.mark.parametrize(
+    "text",
+    [
+        "0xbeef",
+        "abc",
+        "zz",
+        "be ef",
+        " beef",
+        "beef\n",
+        "be_ef",
+    ],
+)
+def test_hex_without_prefix_to_bytes_rejects_invalid(text: str) -> None:
+    with pytest.raises(ValueError):
+        hex_without_prefix_to_bytes(text)
+
+
+def test_hex_to_bytes_is_unchanged() -> None:
+    assert hex_to_bytes("0xbeef") == b"\xbe\xef"
+    assert hex_to_bytes("0xabc") == b"\x0a\xbc"

address_encoder-1.0.2/src/address_encoder/utils/byron.py

@@ -1,24 +0,0 @@
-from __future__ import annotations
-
-import cbor2
-
-from address_encoder.utils.base58_ import base58_unchecked_decode, base58_unchecked_encode
-from address_encoder.utils.crc32 import crc32
-
-
-def byron_encode(source: bytes) -> str:
-    checksum = crc32(source)
-    cbor_encoded = cbor2.dumps([cbor2.CBORTag(24, source), checksum])
-    address = base58_unchecked_encode(cbor_encoded)
-    if not address.startswith(("Ae2", "Ddz")):
-        raise ValueError("Unrecognised address format")
-    return address
-
-
-def byron_decode(source: str) -> bytes:
-    decoded = cbor2.loads(base58_unchecked_decode(source))
-    tagged_address, checksum = decoded[0], decoded[1]
-    value = tagged_address.value if isinstance(tagged_address, cbor2.CBORTag) else tagged_address
-    if crc32(value) != checksum:
-        raise ValueError("Unrecognised address format")
-    return value