cchecksum 0.0.11__tar.gz → 0.0.13__tar.gz

{cchecksum-0.0.11 → cchecksum-0.0.13}/.github/workflows/pytest.yaml

@@ -48,4 +48,4 @@ jobs:
           pip install -e .
       
       - name: Run test suite
-        run: pytest
+        run: pytest -s -v

{cchecksum-0.0.11 → cchecksum-0.0.13}/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: cchecksum
-Version: 0.0.11
-Summary: A ~2x faster drop-in replacement for eth_utils.to_checksum_address. Raises the exact same Exceptions. Implemented in C.
+Version: 0.0.13
+Summary: A ~4.5x faster drop-in replacement for eth_utils.to_checksum_address. Raises the exact same Exceptions. Implemented in C.
 Home-page: https://github.com/BobTheBuidler/cchecksum
 Author: BobTheBuidler
 Author-email: bobthebuidlerdefi@gmail.com

cchecksum-0.0.13/README.md

@@ -0,0 +1,9 @@
+## CChecksum
+
+CChecksum is a ~4.5x faster drop-in replacement for eth_utils.to_checksum_address, with the most cpu-intensive part implemented in c.
+
+It keeps the exact same API as the existing implementation, exceptions and all.
+
+Just `pip install cchecksum`, drop it in, and run your script with a substantial speed improvement.
+
+![image](https://github.com/user-attachments/assets/f2732c1f-f36e-486c-9258-cdeb09bb5eb5)

{cchecksum-0.0.11 → cchecksum-0.0.13}/cchecksum/_checksum.c

@@ -3148,7 +3148,7 @@ static const char __pyx_k_Step_may_not_be_zero_axis_d[] = "Step may not be zero
 static const char __pyx_k_itemsize_0_for_cython_array[] = "itemsize <= 0 for cython.array";
 static const char __pyx_k_unable_to_allocate_array_data[] = "unable to allocate array data.";
 static const char __pyx_k_strided_and_direct_or_indirect[] = "<strided and direct or indirect>";
-static const char __pyx_k_Computes_the_checksummed_versio[] = "\n    Computes the checksummed version of an Ethereum address.\n\n    This function takes a normalized Ethereum address (without the '0x' prefix) and its corresponding\n    hash (also without the '0x' prefix) and returns the checksummed address as per the Ethereum\n    Improvement Proposal 55 (EIP-55).\n\n    Args:\n        norm_address_no_0x (str): The normalized Ethereum address without the '0x' prefix.\n        address_hash_hex_no_0x (bytes): The hash of the address, also without the '0x' prefix.\n\n    Returns:\n        The checksummed Ethereum address with the '0x' prefix.\n\n    Examples:\n        >>> cchecksum(\"b47e3cd837ddf8e4c57f05d70ab865de6e193bbb\", \"abcdef1234567890abcdef1234567890abcdef12\")\n        '0xB47E3Cd837DdF8E4C57F05D70Ab865De6E193BbB'\n\n        >>> cchecksum(\"0000000000000000000000000000000000000000\", \"1234567890abcdef1234567890abcdef12345678\")\n        '0x0000000000000000000000000000000000000000'\n\n    See Also:\n        - :func:`eth_utils.to_checksum_address`: A utility function for converting addresses to their checksummed form.\n    ";
+static const char __pyx_k_Computes_the_checksummed_versio[] = "\n    Computes the checksummed version of an Ethereum address.\n\n    This function takes a normalized Ethereum address (without the '0x' prefix) and its corresponding\n    hash (also without the '0x' prefix) and returns the checksummed address as per the Ethereum\n    Improvement Proposal 55 (EIP-55).\n\n    Args:\n        norm_address_no_0x: The normalized Ethereum address without the '0x' prefix.\n        address_hash_hex_no_0x: The hash of the address, also without the '0x' prefix.\n\n    Returns:\n        The checksummed Ethereum address with the '0x' prefix.\n\n    Examples:\n        >>> cchecksum(\"b47e3cd837ddf8e4c57f05d70ab865de6e193bbb\", \"abcdef1234567890abcdef1234567890abcdef12\")\n        '0xB47E3Cd837DdF8E4C57F05D70Ab865De6E193BbB'\n\n        >>> cchecksum(\"0000000000000000000000000000000000000000\", \"1234567890abcdef1234567890abcdef12345678\")\n        '0x0000000000000000000000000000000000000000'\n\n    See Also:\n        - :func:`eth_utils.to_checksum_address`: A utility function for converting addresses to their checksummed form.\n    ";
 static const char __pyx_k_All_dimensions_preceding_dimensi[] = "All dimensions preceding dimension %d must be indexed and not sliced";
 static const char __pyx_k_Buffer_view_does_not_expose_stri[] = "Buffer view does not expose strides";
 static const char __pyx_k_Can_only_create_a_buffer_that_is[] = "Can only create a buffer that is contiguous in memory.";
@@ -17995,7 +17995,7 @@ PyObject *const *__pyx_args, Py_ssize_t __pyx_nargs, PyObject *__pyx_kwds
 PyObject *__pyx_args, PyObject *__pyx_kwds
 #endif
 ); /*proto*/
-PyDoc_STRVAR(__pyx_doc_9cchecksum_9_checksum_cchecksum, "cchecksum(unicode norm_address_no_0x, const unsigned char[::1] address_hash_hex_no_0x) -> str\n\n    Computes the checksummed version of an Ethereum address.\n\n    This function takes a normalized Ethereum address (without the '0x' prefix) and its corresponding\n    hash (also without the '0x' prefix) and returns the checksummed address as per the Ethereum\n    Improvement Proposal 55 (EIP-55).\n\n    Args:\n        norm_address_no_0x (str): The normalized Ethereum address without the '0x' prefix.\n        address_hash_hex_no_0x (bytes): The hash of the address, also without the '0x' prefix.\n\n    Returns:\n        The checksummed Ethereum address with the '0x' prefix.\n\n    Examples:\n        >>> cchecksum(\"b47e3cd837ddf8e4c57f05d70ab865de6e193bbb\", \"abcdef1234567890abcdef1234567890abcdef12\")\n        '0xB47E3Cd837DdF8E4C57F05D70Ab865De6E193BbB'\n\n        >>> cchecksum(\"0000000000000000000000000000000000000000\", \"1234567890abcdef1234567890abcdef12345678\")\n        '0x0000000000000000000000000000000000000000'\n\n    See Also:\n        - :func:`eth_utils.to_checksum_address`: A utility function for converting addresses to their checksummed form.\n    ");
+PyDoc_STRVAR(__pyx_doc_9cchecksum_9_checksum_cchecksum, "cchecksum(unicode norm_address_no_0x, const unsigned char[::1] address_hash_hex_no_0x) -> str\n\n    Computes the checksummed version of an Ethereum address.\n\n    This function takes a normalized Ethereum address (without the '0x' prefix) and its corresponding\n    hash (also without the '0x' prefix) and returns the checksummed address as per the Ethereum\n    Improvement Proposal 55 (EIP-55).\n\n    Args:\n        norm_address_no_0x: The normalized Ethereum address without the '0x' prefix.\n        address_hash_hex_no_0x: The hash of the address, also without the '0x' prefix.\n\n    Returns:\n        The checksummed Ethereum address with the '0x' prefix.\n\n    Examples:\n        >>> cchecksum(\"b47e3cd837ddf8e4c57f05d70ab865de6e193bbb\", \"abcdef1234567890abcdef1234567890abcdef12\")\n        '0xB47E3Cd837DdF8E4C57F05D70Ab865De6E193BbB'\n\n        >>> cchecksum(\"0000000000000000000000000000000000000000\", \"1234567890abcdef1234567890abcdef12345678\")\n        '0x0000000000000000000000000000000000000000'\n\n    See Also:\n        - :func:`eth_utils.to_checksum_address`: A utility function for converting addresses to their checksummed form.\n    ");
 static PyMethodDef __pyx_mdef_9cchecksum_9_checksum_1cchecksum = {"cchecksum", (PyCFunction)(void*)(__Pyx_PyCFunction_FastCallWithKeywords)__pyx_pw_9cchecksum_9_checksum_1cchecksum, __Pyx_METH_FASTCALL|METH_KEYWORDS, __pyx_doc_9cchecksum_9_checksum_cchecksum};
 static PyObject *__pyx_pw_9cchecksum_9_checksum_1cchecksum(PyObject *__pyx_self, 
 #if CYTHON_METH_FASTCALL
@@ -18227,7 +18227,7 @@ static PyObject *__pyx_pf_9cchecksum_9_checksum_cchecksum(CYTHON_UNUSED PyObject
  *             # the character is capitalized.
  *             buffer[i + 2] = address_char - 32 if 97 <= address_char <= 102 else address_char             # <<<<<<<<<<<<<<
  * 
- *     # NOTE: For some reason on some systems the buffer length is longer than 42 here, even though that should not be possible.
+ *     # It is faster to decode a buffer with a known size ie buffer[:42]
  */
       __Pyx_TraceLine(52,0,__PYX_ERR(0, 52, __pyx_L1_error))
       __pyx_t_7 = (97 <= __pyx_v_address_char);
@@ -18244,14 +18244,14 @@ static PyObject *__pyx_pf_9cchecksum_9_checksum_cchecksum(CYTHON_UNUSED PyObject
     __pyx_L5:;
   }
 
-  /* "cchecksum/_checksum.pyx":56
- *     # NOTE: For some reason on some systems the buffer length is longer than 42 here, even though that should not be possible.
- *     #       Lucky for us, the first 42 characters are always correct. One day maybe I'll debug this.
+  /* "cchecksum/_checksum.pyx":55
+ * 
+ *     # It is faster to decode a buffer with a known size ie buffer[:42]
  *     return buffer[:42].decode('ascii')             # <<<<<<<<<<<<<<
  */
-  __Pyx_TraceLine(56,0,__PYX_ERR(0, 56, __pyx_L1_error))
+  __Pyx_TraceLine(55,0,__PYX_ERR(0, 55, __pyx_L1_error))
   __Pyx_XDECREF(__pyx_r);
-  __pyx_t_3 = __Pyx_decode_c_string(((char const *)__pyx_v_buffer), 0, 42, NULL, NULL, PyUnicode_DecodeASCII); if (unlikely(!__pyx_t_3)) __PYX_ERR(0, 56, __pyx_L1_error)
+  __pyx_t_3 = __Pyx_decode_c_string(((char const *)__pyx_v_buffer), 0, 42, NULL, NULL, PyUnicode_DecodeASCII); if (unlikely(!__pyx_t_3)) __PYX_ERR(0, 55, __pyx_L1_error)
   __Pyx_GOTREF(__pyx_t_3);
   __pyx_r = ((PyObject*)__pyx_t_3);
   __pyx_t_3 = 0;

{cchecksum-0.0.11 → cchecksum-0.0.13}/cchecksum/_checksum.pyx

@@ -10,8 +10,8 @@ def cchecksum(str norm_address_no_0x, const unsigned char[::1] address_hash_hex_
     Improvement Proposal 55 (EIP-55).
 
     Args:
-        norm_address_no_0x (str): The normalized Ethereum address without the '0x' prefix.
-        address_hash_hex_no_0x (bytes): The hash of the address, also without the '0x' prefix.
+        norm_address_no_0x: The normalized Ethereum address without the '0x' prefix.
+        address_hash_hex_no_0x: The hash of the address, also without the '0x' prefix.
 
     Returns:
         The checksummed Ethereum address with the '0x' prefix.
@@ -51,6 +51,5 @@ def cchecksum(str norm_address_no_0x, const unsigned char[::1] address_hash_hex_
             # the character is capitalized.
             buffer[i + 2] = address_char - 32 if 97 <= address_char <= 102 else address_char
 
-    # NOTE: For some reason on some systems the buffer length is longer than 42 here, even though that should not be possible.
-    #       Lucky for us, the first 42 characters are always correct. One day maybe I'll debug this.
+    # It is faster to decode a buffer with a known size ie buffer[:42]
     return buffer[:42].decode('ascii')

{cchecksum-0.0.11 → cchecksum-0.0.13}/cchecksum/checksum.py

@@ -2,17 +2,14 @@ from binascii import hexlify
 from typing import Optional, Union
 
 from eth_hash.auto import keccak
-from eth_typing import AnyAddress, ChecksumAddress, HexAddress, HexStr, Primitives
-from eth_utils import encode_hex, hexstr_if_str
+from eth_typing import AnyAddress, ChecksumAddress, HexAddress, HexStr
+from eth_utils import encode_hex, is_hexstr, remove_0x_prefix
 from eth_utils.address import _HEX_ADDRESS_REGEXP
 from eth_utils.toolz import compose
 
 from cchecksum._checksum import cchecksum
 
 
-BytesLike = Union[Primitives, bytearray, memoryview]
-
-
 # force _hasher_first_run and _preimage_first_run to execute so we can cache the new hasher
 keccak(b"")
 
@@ -84,7 +81,7 @@ def to_normalized_address(value: Union[AnyAddress, str, bytes]) -> HexAddress:
         - :func:`is_address` for checking if a string is a valid address.
     """
     try:
-        hex_address = hexstr_if_str(to_hex, value).lower()
+        hex_address = hexstr_if_str(value).lower()
     except AttributeError as e:
         raise TypeError(
             f"Value must be any string, instead got type {type(value)}"
@@ -102,23 +99,28 @@ def to_normalized_address(value: Union[AnyAddress, str, bytes]) -> HexAddress:
 encode_memoryview = compose(encode_hex, bytes)
 
 
-def to_hex(
-    address_bytes: Optional[BytesLike] = None,
-    *,
-    hexstr: Optional[HexStr] = None,
-) -> HexStr:
+def hexstr_if_str(hexstr_or_primitive: Union[bytes, int, str]) -> HexStr:
     """
-    Auto converts any supported value into its hex representation.
-    Trims leading zeros, as defined in:
-    https://github.com/ethereum/wiki/wiki/JSON-RPC#hex-value-encoding
+    Convert to a type, assuming that strings can be only hexstr (not unicode text).
+
+    :param hexstr_or_primitive bytes, str, int: value to convert
     """
-    if hexstr is not None:
-        return hexstr if hexstr.startswith(("0x", "0X")) else f"0x{hexstr}"
+    if isinstance(hexstr_or_primitive, str):
+        if remove_0x_prefix(hexstr_or_primitive) and not is_hexstr(hexstr_or_primitive):
+            raise ValueError(
+                "when sending a str, it must be a hex string. " f"Got: {repr(hexstr_or_primitive)}"
+            )
+
+        return (
+            hexstr_or_primitive
+            if hexstr_or_primitive.startswith(("0x", "0X"))
+            else f"0x{hexstr_or_primitive}"
+        )
 
-    if isinstance(address_bytes, (bytes, bytearray)):
+    elif isinstance(address_bytes, (bytes, bytearray)):
         return encode_hex(address_bytes)
 
-    if isinstance(address_bytes, memoryview):
+    elif isinstance(address_bytes, memoryview):
         return encode_memoryview(address_bytes)
 
     raise TypeError(
@@ -128,6 +130,5 @@ def to_hex(
 
 del hexlify
 del Optional, Union
-del AnyAddress, ChecksumAddress, HexAddress, HexStr, Primitives
+del AnyAddress, ChecksumAddress, HexAddress, HexStr
 del _HEX_ADDRESS_REGEXP, compose, keccak
-del BytesLike

{cchecksum-0.0.11 → cchecksum-0.0.13}/cchecksum.egg-info/PKG-INFO

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: cchecksum
-Version: 0.0.11
-Summary: A ~2x faster drop-in replacement for eth_utils.to_checksum_address. Raises the exact same Exceptions. Implemented in C.
+Version: 0.0.13
+Summary: A ~4.5x faster drop-in replacement for eth_utils.to_checksum_address. Raises the exact same Exceptions. Implemented in C.
 Home-page: https://github.com/BobTheBuidler/cchecksum
 Author: BobTheBuidler
 Author-email: bobthebuidlerdefi@gmail.com

{cchecksum-0.0.11 → cchecksum-0.0.13}/setup.py

@@ -13,7 +13,7 @@ setup(
         "local_scheme": "no-local-version",
         "version_scheme": "python-simplified-semver",
     },
-    description="A ~2x faster drop-in replacement for eth_utils.to_checksum_address. Raises the exact same Exceptions. Implemented in C.",
+    description="A ~4.5x faster drop-in replacement for eth_utils.to_checksum_address. Raises the exact same Exceptions. Implemented in C.",
     author="BobTheBuidler",
     author_email="bobthebuidlerdefi@gmail.com",
     url="https://github.com/BobTheBuidler/cchecksum",

cchecksum-0.0.11/README.md

@@ -1,7 +0,0 @@
-## CChecksum
-
-CChecksum is a ~2x faster drop-in replacement for eth_utils.to_checksum_address, with the most cpu-intensive part implemented in c.
-
-Just `pip install cchecksum`, drop it in, and run your script with a substantial speed improvement.
-
-![image](https://github.com/user-attachments/assets/a2da6950-2759-42fa-8a56-7d7e095cd2ce)