faster-eth-abi 5.2.10__tar.gz → 5.2.12__tar.gz

{faster_eth_abi-5.2.10 → faster_eth_abi-5.2.12}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.4
 Name: faster_eth_abi
-Version: 5.2.10
+Version: 5.2.12
 Summary: A faster fork of eth_abi: Python utilities for working with Ethereum ABI definitions, especially encoding and decoding. Implemented in C.
 Home-page: https://github.com/BobTheBuidler/faster-eth-abi
 Author: The Ethereum Foundation
@@ -22,11 +22,61 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Requires-Python: >=3.8, <4
 Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cchecksum<0.4,>=0.2.6
+Requires-Dist: faster-eth-utils>=2.0.0
+Requires-Dist: eth-abi<6,>=5.0.1
+Requires-Dist: eth-typing>=3.0.0
+Requires-Dist: mypy_extensions
+Requires-Dist: parsimonious<0.11.0,>=0.10.0
 Provides-Extra: dev
+Requires-Dist: build>=0.9.0; extra == "dev"
+Requires-Dist: bump_my_version>=0.19.0; extra == "dev"
+Requires-Dist: ipython; extra == "dev"
+Requires-Dist: mypy==1.18.2; extra == "dev"
+Requires-Dist: pre-commit>=3.4.0; extra == "dev"
+Requires-Dist: tox>=4.0.0; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Requires-Dist: wheel; extra == "dev"
+Requires-Dist: pytest-codspeed; extra == "dev"
+Requires-Dist: pytest-benchmark; extra == "dev"
+Requires-Dist: sphinx>=6.0.0; extra == "dev"
+Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "dev"
+Requires-Dist: sphinx_rtd_theme>=1.0.0; extra == "dev"
+Requires-Dist: towncrier<26,>=25; extra == "dev"
+Requires-Dist: pytest>=7.0.0; extra == "dev"
+Requires-Dist: pytest-timeout>=2.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=2.4.0; extra == "dev"
+Requires-Dist: pytest-pythonpath>=0.7.1; extra == "dev"
+Requires-Dist: eth-hash[pycryptodome]; extra == "dev"
+Requires-Dist: hypothesis<6.108.7,>=6.22.0; extra == "dev"
 Provides-Extra: docs
+Requires-Dist: sphinx>=6.0.0; extra == "docs"
+Requires-Dist: sphinx-autobuild>=2021.3.14; extra == "docs"
+Requires-Dist: sphinx_rtd_theme>=1.0.0; extra == "docs"
+Requires-Dist: towncrier<26,>=25; extra == "docs"
 Provides-Extra: test
+Requires-Dist: pytest>=7.0.0; extra == "test"
+Requires-Dist: pytest-timeout>=2.0.0; extra == "test"
+Requires-Dist: pytest-xdist>=2.4.0; extra == "test"
+Requires-Dist: pytest-pythonpath>=0.7.1; extra == "test"
+Requires-Dist: eth-hash[pycryptodome]; extra == "test"
+Requires-Dist: hypothesis<6.108.7,>=6.22.0; extra == "test"
 Provides-Extra: tools
-License-File: LICENSE
+Requires-Dist: hypothesis<6.108.7,>=6.22.0; extra == "tools"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
 
 ### I forked eth-abi and compiled it to C. It does the same stuff, now faster
 
@@ -36,10 +86,14 @@ License-File: LICENSE
 
 ##### This fork will be kept up-to-date with [eth-abi](https://github.com/ethereum/eth-abi). I will pull updates as they are released and push new [faster-eth-abi](https://github.com/BobTheBuidler/faster-eth-abi) releases to [PyPI](https://pypi.org/project/faster-eth-abi/).
 
-##### You can find the compiled C code on faster-eth-abi [master](https://github.com/BobTheBuidler/eth-abi/tree/master) branch.
+##### Starting in [v5.2.12](https://github.com/BobTheBuidler/faster-eth-abi/releases/tag/v5.2.12), all `faster-eth-abi` Exception classes inherit from the matching Exception class in `eth-abi`, so porting to `faster-eth-abi` does not require any change to your existing exception handlers. All existing exception handling in your codebase will continue to work as it did when originaly implemented.
 
 ##### We benchmark `faster-eth-abi` against the original `eth-abi` for your convenience. [See results](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/benchmarks/results).
 
+##### You can find the compiled C code and header files in the [build](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/build) directory.
+
+###### You may also be interested in: [faster-web3.py](https://github.com/BobTheBuidler/faster-web3.py/), [faster-hexbytes](https://github.com/BobTheBuidler/faster-hexbytes/), and [faster-eth-utils](https://github.com/BobTheBuidler/faster-eth-utils/)
+
 ##### The original eth-abi readme is below:
 
 # Ethereum Contract Interface (ABI) Utility

{faster_eth_abi-5.2.10 → faster_eth_abi-5.2.12}/README.md

@@ -6,10 +6,14 @@
 
 ##### This fork will be kept up-to-date with [eth-abi](https://github.com/ethereum/eth-abi). I will pull updates as they are released and push new [faster-eth-abi](https://github.com/BobTheBuidler/faster-eth-abi) releases to [PyPI](https://pypi.org/project/faster-eth-abi/).
 
-##### You can find the compiled C code on faster-eth-abi [master](https://github.com/BobTheBuidler/eth-abi/tree/master) branch.
+##### Starting in [v5.2.12](https://github.com/BobTheBuidler/faster-eth-abi/releases/tag/v5.2.12), all `faster-eth-abi` Exception classes inherit from the matching Exception class in `eth-abi`, so porting to `faster-eth-abi` does not require any change to your existing exception handlers. All existing exception handling in your codebase will continue to work as it did when originaly implemented.
 
 ##### We benchmark `faster-eth-abi` against the original `eth-abi` for your convenience. [See results](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/benchmarks/results).
 
+##### You can find the compiled C code and header files in the [build](https://github.com/BobTheBuidler/faster-eth-abi/tree/master/build) directory.
+
+###### You may also be interested in: [faster-web3.py](https://github.com/BobTheBuidler/faster-web3.py/), [faster-hexbytes](https://github.com/BobTheBuidler/faster-hexbytes/), and [faster-eth-utils](https://github.com/BobTheBuidler/faster-eth-utils/)
+
 ##### The original eth-abi readme is below:
 
 # Ethereum Contract Interface (ABI) Utility

{faster_eth_abi-5.2.10 → faster_eth_abi-5.2.12}/faster_eth_abi/_codec.py

@@ -39,8 +39,6 @@ def encode_c(
     :returns: The head-tail encoded binary representation of the python
         values in ``args`` as values of the ABI types in ``types``.
     """
-    # validate encode types and args
-    validate_list_like_param(types, "types")
     validate_list_like_param(args, "args")
 
     encoder = self._registry.get_tuple_encoder(*types)
@@ -71,8 +69,6 @@ def decode_c(
     :returns: A tuple of equivalent python values for the ABI values
         represented in ``data``.
     """
-    # validate decode types and data
-    validate_list_like_param(types, "types")
     validate_bytes_param(data, "data")
 
     decoder = self._registry.get_tuple_decoder(*types, strict=strict)

faster_eth_abi-5.2.10/faster_eth_abi/grammar.py → faster_eth_abi-5.2.12/faster_eth_abi/_grammar.py

@@ -1,22 +1,22 @@
-import functools
 import re
 from typing import (
     Any,
     Final,
+    NewType,
     NoReturn,
     Optional,
     Sequence,
     Tuple,
     TypeVar,
+    Union,
     final,
 )
 
-from eth_typing import (
+from eth_typing.abi import (
     TypeStr,
 )
-import parsimonious
-from parsimonious import (
-    expressions,
+from mypy_extensions import (
+    mypyc_attr,
 )
 from parsimonious.nodes import (
     Node,
@@ -27,136 +27,29 @@ from typing_extensions import (
 
 from faster_eth_abi.exceptions import (
     ABITypeError,
-    ParseError,
 )
 
-grammar: Final = parsimonious.Grammar(
-    r"""
-    type = tuple_type / basic_type
 
-    tuple_type = components arrlist?
-    components = non_zero_tuple
-
-    non_zero_tuple = "(" type next_type* ")"
-    next_type = "," type
-
-    basic_type = base sub? arrlist?
-
-    base = alphas
-
-    sub = two_size / digits
-    two_size = (digits "x" digits)
-
-    arrlist = (const_arr / dynam_arr)+
-    const_arr = "[" digits "]"
-    dynam_arr = "[]"
+TYPE_ALIASES: Final = {
+    "int": "int256",
+    "uint": "uint256",
+    "fixed": "fixed128x18",
+    "ufixed": "ufixed128x18",
+    "function": "bytes24",
+    "byte": "bytes1",
+}
 
-    alphas = ~"[A-Za-z]+"
-    digits = ~"[1-9][0-9]*"
-    """
+TYPE_ALIAS_RE: Final = re.compile(
+    rf"\b({'|'.join(map(re.escape, TYPE_ALIASES.keys()))})\b"
 )
 
 
-@final
-class NodeVisitor(parsimonious.NodeVisitor):  # type: ignore [misc]
-    """
-    Parsimonious node visitor which performs both parsing of type strings and
-    post-processing of parse trees.  Parsing operations are cached.
-    """
-
-    def __init__(self):
-        self.parse = functools.lru_cache(maxsize=None)(self._parse_uncached)
-
-    grammar = grammar
-
-    def visit_non_zero_tuple(self, node, visited_children):
-        # Ignore left and right parens
-        _, first, rest, _ = visited_children
-
-        return (first,) + rest
-
-    def visit_tuple_type(self, node, visited_children):
-        components, arrlist = visited_children
-
-        return TupleType(components, arrlist, node=node)
-
-    def visit_next_type(self, node, visited_children):
-        # Ignore comma
-        _, abi_type = visited_children
-
-        return abi_type
-
-    def visit_basic_type(self, node, visited_children):
-        base, sub, arrlist = visited_children
-
-        return BasicType(base, sub, arrlist, node=node)
-
-    def visit_two_size(self, node, visited_children):
-        # Ignore "x"
-        first, _, second = visited_children
-
-        return first, second
-
-    def visit_const_arr(self, node, visited_children):
-        # Ignore left and right brackets
-        _, int_value, _ = visited_children
-
-        return (int_value,)
-
-    def visit_dynam_arr(self, node, visited_children):
-        return ()
-
-    def visit_alphas(self, node, visited_children):
-        return node.text
-
-    def visit_digits(self, node, visited_children):
-        return int(node.text)
-
-    def generic_visit(self, node, visited_children):
-        expr = node.expr
-        if isinstance(expr, expressions.OneOf):
-            # Unwrap value chosen from alternatives
-            return visited_children[0]
-
-        if isinstance(expr, expressions.Quantifier) and expr.min == 0 and expr.max == 1:
-            # Unwrap optional value or return `None`
-            if len(visited_children) != 0:
-                return visited_children[0]
-
-            return None
-
-        return tuple(visited_children)
-
-    def _parse_uncached(self, type_str, **kwargs):
-        """
-        Parses a type string into an appropriate instance of
-        :class:`~faster_eth_abi.grammar.ABIType`.  If a type string cannot be parsed,
-        throws :class:`~faster_eth_abi.exceptions.ParseError`.
-
-        :param type_str: The type string to be parsed.
-        :returns: An instance of :class:`~faster_eth_abi.grammar.ABIType` containing
-            information about the parsed type string.
-        """
-        if not isinstance(type_str, str):
-            raise TypeError(f"Can only parse string values: got {type(type_str)}")
-
-        try:
-            return super().parse(type_str, **kwargs)
-        except parsimonious.ParseError as e:
-            # This is a good place to add some better messaging around the type string.
-            # If this logic grows any bigger, we should abstract it to its own function.
-            if "()" in type_str:
-                # validate against zero-sized tuple types
-                raise ValueError(
-                    'Zero-sized tuple types "()" are not supported.'
-                ) from None
-
-            raise ParseError(e.text, e.pos, e.expr) from e
-
-
-visitor: Final = NodeVisitor()
+IntSubtype = NewType("IntSubtype", int)
+FixedSubtype = NewType("FixedSubtype", Tuple[int, int])
+Subtype = Union[IntSubtype, FixedSubtype]
 
 
+@mypyc_attr(allow_interpreted_subclasses=True)
 class ABIType:
     """
     Base class for results of type string parsing operations.
@@ -165,7 +58,7 @@ class ABIType:
     __slots__ = ("arrlist", "node")
 
     def __init__(
-        self, arrlist: Optional[Sequence] = None, node: Optional[Node] = None
+        self, arrlist: Optional[Sequence[str]] = None, node: Optional[Node] = None
     ) -> None:
         self.arrlist: Final = arrlist
         """
@@ -211,6 +104,7 @@ class ABIType:
         """
         raise NotImplementedError("Must implement `validate`")
 
+    @final
     def invalidate(self, error_msg: str) -> NoReturn:
         # Invalidates an ABI type with the given error message.  Expects that a
         # parsimonious node was provided from the original parsing operation
@@ -222,6 +116,7 @@ class ABIType:
             f"in '{node.full_text}': {error_msg}"
         )
 
+    @final
     @property
     def is_array(self) -> bool:
         """
@@ -238,6 +133,7 @@ class ABIType:
         """
         raise NotImplementedError("Must implement `is_dynamic`")
 
+    @final
     @property
     def _has_dynamic_arrlist(self) -> bool:
         return self.is_array and any(len(dim) == 0 for dim in self.arrlist)
@@ -246,7 +142,7 @@ class ABIType:
 TComp = TypeVar("TComp", bound=ABIType)
 
 
-@final
+@mypyc_attr(allow_interpreted_subclasses=True)
 class TupleType(ABIType):
     """
     Represents the result of parsing a tuple type string e.g. "(int,bool)".
@@ -257,7 +153,7 @@ class TupleType(ABIType):
     def __init__(
         self,
         components: Tuple[TComp, ...],
-        arrlist: Optional[Sequence] = None,
+        arrlist: Optional[Sequence[str]] = None,
         *,
         node: Optional[Node] = None,
     ) -> None:
@@ -273,7 +169,7 @@ class TupleType(ABIType):
         arrlist = self.arrlist
 
         if isinstance(arrlist, tuple):
-            arrlist = "".join(repr(list(a)) for a in arrlist)
+            arrlist = "".join(map(repr, map(list, arrlist)))
         else:
             arrlist = ""
 
@@ -286,11 +182,12 @@ class TupleType(ABIType):
                 f"Cannot determine item type for non-array type '{self.to_type_str()}'"
             )
 
-        return type(self)(
-            self.components,
-            self.arrlist[:-1] or None,  # type: ignore [index]
-            node=self.node,
-        )
+        arrlist = self.arrlist[:-1] or None  # type: ignore [index]
+        cls = type(self)
+        if cls is TupleType:
+            return TupleType(self.components, arrlist, node=self.node)  # type: ignore [return-value]
+        else:
+            return cls(self.components, arrlist, node=self.node)
 
     def validate(self) -> None:
         for c in self.components:
@@ -304,7 +201,7 @@ class TupleType(ABIType):
         return any(c.is_dynamic for c in self.components)
 
 
-@final
+@mypyc_attr(allow_interpreted_subclasses=True)
 class BasicType(ABIType):
     """
     Represents the result of parsing a basic type string e.g. "uint", "address",
@@ -316,7 +213,7 @@ class BasicType(ABIType):
     def __init__(
         self,
         base: str,
-        sub: Any = None,
+        sub: Optional[Subtype] = None,
         arrlist: Optional[Sequence] = None,
         *,
         node: Optional[Node] = None,
@@ -339,12 +236,12 @@ class BasicType(ABIType):
         if isinstance(sub, int):
             substr = str(sub)
         elif isinstance(sub, tuple):
-            substr = "x".join(str(s) for s in sub)
+            substr = "x".join(map(str, sub))
         else:
             substr = ""
 
         if isinstance(arrlist, tuple):
-            return self.base + substr + "".join(repr(list(a)) for a in arrlist)
+            return self.base + substr + "".join(map(repr, map(list, arrlist)))
         else:
             return self.base + substr
 
@@ -355,22 +252,23 @@ class BasicType(ABIType):
                 f"Cannot determine item type for non-array type '{self.to_type_str()}'"
             )
 
-        return type(self)(
-            self.base,
-            self.sub,
-            self.arrlist[:-1] or None,  # type: ignore [index]
-            node=self.node,
-        )
+        cls = type(self)
+        arrlist = self.arrlist[:-1] or None  # type: ignore [index]
+        if cls is BasicType:
+            return BasicType(self.base, self.sub, arrlist, node=self.node)  # type: ignore [return-value]
+        else:
+            return cls(self.base, self.sub, arrlist, node=self.node)
 
     @property
     def is_dynamic(self) -> bool:
         if self._has_dynamic_arrlist:
             return True
 
-        if self.base == "string":
+        base = self.base
+        if base == "string":
             return True
 
-        if self.base == "bytes" and self.sub is None:
+        if base == "bytes" and self.sub is None:
             return True
 
         return False
@@ -436,20 +334,6 @@ class BasicType(ABIType):
                 self.invalidate("address cannot have suffix")
 
 
-TYPE_ALIASES: Final = {
-    "int": "int256",
-    "uint": "uint256",
-    "fixed": "fixed128x18",
-    "ufixed": "ufixed128x18",
-    "function": "bytes24",
-    "byte": "bytes1",
-}
-
-TYPE_ALIAS_RE: Final = re.compile(
-    rf"\b({'|'.join(re.escape(a) for a in TYPE_ALIASES.keys())})\b"
-)
-
-
 def normalize(type_str: TypeStr) -> TypeStr:
     """
     Normalizes a type string into its canonical version e.g. the type string
@@ -463,6 +347,3 @@ def normalize(type_str: TypeStr) -> TypeStr:
 
 def __normalize(match: "re.Match[str]") -> str:
     return TYPE_ALIASES[match.group(0)]
-
-
-parse: Final = visitor.parse

{faster_eth_abi-5.2.10 → faster_eth_abi-5.2.12}/faster_eth_abi/codec.py

@@ -18,6 +18,7 @@ from faster_eth_abi.decoding import (
 )
 from faster_eth_abi.exceptions import (
     EncodingError,
+    MultipleEntriesFound,
 )
 from faster_eth_abi.registry import (
     ABIRegistry,
@@ -74,20 +75,18 @@ class ABIEncoder(BaseABICoder):
         :returns: ``True`` if ``arg`` is encodable as a value of the ABI type
             ``typ``.  Otherwise, ``False``.
         """
-        if not self.is_encodable_type(typ):
+        try:
+            encoder = self._registry.get_encoder(typ)
+        except MultipleEntriesFound:
+            raise
+        except:
             return False
 
-        encoder = self._registry.get_encoder(typ)
-
+        validate = getattr(encoder, "validate_value", encoder)
         try:
-            encoder.validate_value(arg)
+            validate(arg)
         except EncodingError:
             return False
-        except AttributeError:
-            try:
-                encoder(arg)
-            except EncodingError:
-                return False
 
         return True
 

{faster_eth_abi-5.2.10 → faster_eth_abi-5.2.12}/faster_eth_abi/exceptions.py

@@ -1,20 +1,29 @@
+# mypy: disable-error-code="misc"
+# cannot subclass `Any`
+
+"""
+faster-eth-abi exceptions always inherit from eth-abi exceptions, so porting to faster-eth-abi
+does not require any change to your existing exception handlers. They will continue to work.
+"""
+
+import eth_abi.exceptions
 import parsimonious
 
 
-class EncodingError(Exception):
+class EncodingError(eth_abi.exceptions.EncodingError):
     """
     Base exception for any error that occurs during encoding.
     """
 
 
-class EncodingTypeError(EncodingError):
+class EncodingTypeError(EncodingError, eth_abi.exceptions.EncodingTypeError):
     """
     Raised when trying to encode a python value whose type is not supported for
     the output ABI type.
     """
 
 
-class IllegalValue(EncodingError):
+class IllegalValue(EncodingError, eth_abi.exceptions.IllegalValue):
     """
     Raised when trying to encode a python value with the correct type but with
     a value that is not considered legal for the output ABI type.
@@ -26,7 +35,7 @@ class IllegalValue(EncodingError):
     """
 
 
-class ValueOutOfBounds(IllegalValue):
+class ValueOutOfBounds(IllegalValue, eth_abi.exceptions.ValueOutOfBounds):
     """
     Raised when trying to encode a python value with the correct type but with
     a value that appears outside the range of valid values for the output ABI
@@ -39,31 +48,31 @@ class ValueOutOfBounds(IllegalValue):
     """
 
 
-class DecodingError(Exception):
+class DecodingError(eth_abi.exceptions.DecodingError):
     """
     Base exception for any error that occurs during decoding.
     """
 
 
-class InsufficientDataBytes(DecodingError):
+class InsufficientDataBytes(DecodingError, eth_abi.exceptions.InsufficientDataBytes):
     """
     Raised when there are insufficient data to decode a value for a given ABI type.
     """
 
 
-class NonEmptyPaddingBytes(DecodingError):
+class NonEmptyPaddingBytes(DecodingError, eth_abi.exceptions.NonEmptyPaddingBytes):
     """
     Raised when the padding bytes of an ABI value are malformed.
     """
 
 
-class InvalidPointer(DecodingError):
+class InvalidPointer(DecodingError, eth_abi.exceptions.InvalidPointer):
     """
     Raised when the pointer to a value in the ABI encoding is invalid.
     """
 
 
-class ParseError(parsimonious.ParseError):  # type: ignore[misc] # subclasses Any
+class ParseError(eth_abi.exceptions.ParseError):
     """
     Raised when an ABI type string cannot be parsed.
     """
@@ -75,7 +84,7 @@ class ParseError(parsimonious.ParseError):  # type: ignore[misc] # subclasses An
         )
 
 
-class ABITypeError(ValueError):
+class ABITypeError(eth_abi.exceptions.ABITypeError):
     """
     Raised when a parsed ABI type has inconsistent properties; for example,
     when trying to parse the type string ``'uint7'`` (which has a bit-width
@@ -83,13 +92,13 @@ class ABITypeError(ValueError):
     """
 
 
-class PredicateMappingError(Exception):
+class PredicateMappingError(eth_abi.exceptions.PredicateMappingError):
     """
     Raised when an error occurs in a registry's internal mapping.
     """
 
 
-class NoEntriesFound(ValueError, PredicateMappingError):
+class NoEntriesFound(PredicateMappingError, eth_abi.exceptions.NoEntriesFound):
     """
     Raised when no registration is found for a type string in a registry's
     internal mapping.
@@ -101,7 +110,7 @@ class NoEntriesFound(ValueError, PredicateMappingError):
     """
 
 
-class MultipleEntriesFound(ValueError, PredicateMappingError):
+class MultipleEntriesFound(PredicateMappingError, eth_abi.exceptions.MultipleEntriesFound):
     """
     Raised when multiple registrations are found for a type string in a
     registry's internal mapping.  This error is non-recoverable and indicates

{faster_eth_abi-5.2.10 → faster_eth_abi-5.2.12}/faster_eth_abi/from_type_str.py

@@ -12,11 +12,13 @@ from eth_typing import (
     TypeStr,
 )
 
-from .grammar import (
+from ._grammar import (
     ABIType,
     BasicType,
     TupleType,
     normalize,
+)
+from .grammar import (
     parse,
 )