faster-eth-abi 5.2.24__cp311-cp311-win_amd64.whl

faster_eth_abi/__init__.py

@@ -0,0 +1,17 @@
+from importlib.metadata import (
+    version as __version,
+)
+from typing import (
+    Final,
+)
+
+from faster_eth_abi.abi import (
+    decode,
+    encode,
+    is_encodable,
+    is_encodable_type,
+)
+
+__all__ = ["decode", "encode", "is_encodable", "is_encodable_type"]
+
+__version__: Final = __version("faster-eth-abi")

faster_eth_abi/_codec.py

@@ -0,0 +1,83 @@
+"""Internal codec helpers for encoding and decoding sequences of values using the head-tail mechanism.
+
+Provides encode_c and decode_c functions for binary serialization and deserialization of values
+according to ABI type specifications.
+"""
+
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Iterable,
+    Tuple,
+)
+
+from eth_typing import (
+    Decodable,
+    TypeStr,
+)
+
+from faster_eth_abi.utils.validation import (
+    validate_bytes_param,
+    validate_list_like_param,
+)
+
+if TYPE_CHECKING:
+    from faster_eth_abi.codec import (
+        ABIDecoder,
+        ABIEncoder,
+    )
+
+
+def encode_c(
+    self: "ABIEncoder",
+    types: Iterable[TypeStr],
+    args: Iterable[Any],
+) -> bytes:
+    """
+    Encodes the python values in ``args`` as a sequence of binary values of
+    the ABI types in ``types`` via the head-tail mechanism.
+
+    :param types: A list or tuple of string representations of the ABI types
+        that will be used for encoding e.g.  ``('uint256', 'bytes[]',
+        '(int,int)')``
+    :param args: A list or tuple of python values to be encoded.
+
+    :returns: The head-tail encoded binary representation of the python
+        values in ``args`` as values of the ABI types in ``types``.
+    """
+    validate_list_like_param(args, "args")
+
+    encoder = self._registry.get_tuple_encoder(*types)
+
+    return encoder.encode(args)
+
+
+def decode_c(
+    self: "ABIDecoder",
+    types: Iterable[TypeStr],
+    data: Decodable,
+    strict: bool = True,
+) -> Tuple[Any, ...]:
+    """
+    Decodes the binary value ``data`` as a sequence of values of the ABI types
+    in ``types`` via the head-tail mechanism into a tuple of equivalent python
+    values.
+
+    :param types: A list or tuple of string representations of the ABI types that
+        will be used for decoding e.g. ``('uint256', 'bytes[]', '(int,int)')``
+    :param data: The binary value to be decoded.
+    :param strict: If ``False``, dynamic-type decoders will ignore validations such
+        as making sure the data is padded to a multiple of 32 bytes or checking that
+        padding bytes are zero / empty. ``False`` is how the Solidity ABI decoder
+        currently works. However, ``True`` is the default for the faster-eth-abi
+        library.
+
+    :returns: A tuple of equivalent python values for the ABI values
+        represented in ``data``.
+    """
+    validate_bytes_param(data, "data")
+
+    decoder = self._registry.get_tuple_decoder(*types, strict=strict)
+    stream = self.stream_class(data)
+
+    return decoder(stream)

faster_eth_abi/_decoding.py

@@ -0,0 +1,372 @@
+"""Private helpers for decoding logic, intended for C compilation.
+
+This file exists because the original decoding.py is not ready to be fully compiled to C.
+This module contains functions and logic that we wish to compile.
+"""
+import decimal
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Dict,
+    Final,
+    Tuple,
+)
+
+from faster_eth_utils import (
+    big_endian_to_int,
+)
+
+from faster_eth_abi.exceptions import (
+    InsufficientDataBytes,
+    InvalidPointer,
+    NonEmptyPaddingBytes,
+)
+from faster_eth_abi.io import (
+    BytesIO,
+    ContextFramesBytesIO,
+)
+from faster_eth_abi.typing import (
+    T,
+)
+from faster_eth_abi.utils.localcontext import (
+    DECIMAL_CONTEXT,
+)
+from faster_eth_abi.utils.numeric import (
+    ceil32,
+)
+
+if TYPE_CHECKING:
+    from .decoding import (
+        BaseArrayDecoder,
+        ByteStringDecoder,
+        DynamicArrayDecoder,
+        FixedByteSizeDecoder,
+        HeadTailDecoder,
+        SignedFixedDecoder,
+        SignedIntegerDecoder,
+        SizedArrayDecoder,
+        StringDecoder,
+        TupleDecoder,
+        UnsignedFixedDecoder,
+    )
+
+
+Decimal: Final = decimal.Decimal
+
+
+# Helpers
+def decode_uint_256(stream: ContextFramesBytesIO) -> int:
+    """
+    A faster version of :func:`~decoding.decode_uint_256` in decoding.py.
+
+    It recreates the logic from the UnsignedIntegerDecoder, but we can
+    skip a lot because we know the value of many vars.
+    """
+    # read data from stream
+    if len(data := stream.read(32)) == 32:
+        return big_endian_to_int(data)
+    raise InsufficientDataBytes(f"Tried to read 32 bytes, only got {len(data)} bytes.")
+
+
+def get_value_byte_size(decoder: "FixedByteSizeDecoder") -> int:
+    return decoder.value_bit_size // 8
+
+
+# HeadTailDecoder
+def decode_head_tail(self: "HeadTailDecoder[T]", stream: ContextFramesBytesIO) -> T:
+    # Decode the offset and move the stream cursor forward 32 bytes
+    start_pos = decode_uint_256(stream)
+    # Jump ahead to the start of the value
+    stream.push_frame(start_pos)
+
+    # assertion check for mypy
+    tail_decoder = self.tail_decoder
+    if tail_decoder is None:
+        raise AssertionError("`tail_decoder` is None")
+    # Decode the value
+    value: T = tail_decoder(stream)
+    # Return the cursor
+    stream.pop_frame()
+
+    return value
+
+
+# TupleDecoder
+def decode_tuple(
+    self: "TupleDecoder[T]", stream: ContextFramesBytesIO
+) -> Tuple[T, ...]:
+    # NOTE: the original implementation would do this but it's
+    # kinda wasteful, so we rebuilt the logic within this function
+    # validate_pointers_tuple(self, stream)
+
+    current_location = stream.tell()
+    if self._no_head_tail:
+        # TODO: if all(isinstance(d, TupleDecoder) for d in self._decoders)
+        #           return tuple(decode_tuple(stream) for _ in range(len(self.decoders))
+        #       and other types with compiled decode funcs
+        return tuple(decoder(stream) for decoder in self.decoders)
+
+    end_of_offsets = current_location + 32 * self.len_of_head
+    total_stream_length = len(stream.getbuffer())
+    items = []
+    for decoder, is_head_tail in zip(self.decoders, self._is_head_tail):
+        if is_head_tail:
+            # the next 32 bytes are a pointer that we should validate
+            # checkpoint the stream location so we can reset it after validation
+            step_location = stream.tell()
+
+            offset = decode_uint_256(stream)
+            indicated_idx = current_location + offset
+            if indicated_idx < end_of_offsets or indicated_idx >= total_stream_length:
+                # the pointer is indicating its data is located either within the
+                # offsets section of the stream or beyond the end of the stream,
+                # both of which are invalid
+                raise InvalidPointer(
+                    "Invalid pointer in tuple at location "
+                    f"{stream.tell() - 32} in payload"
+                )
+
+            # reset the stream so we can decode
+            stream.seek(step_location)
+
+        items.append(decoder(stream))
+
+    # return the stream to its original location for actual decoding
+    stream.seek(current_location)
+
+    return tuple(items)
+
+
+def validate_pointers_tuple(
+    self: "TupleDecoder",
+    stream: ContextFramesBytesIO,
+) -> None:
+    """
+    Verify that all pointers point to a valid location in the stream.
+    """
+    current_location = stream.tell()
+    if self._no_head_tail:
+        for decoder in self.decoders:
+            decoder(stream)
+    else:
+        end_of_offsets = current_location + 32 * self.len_of_head
+        total_stream_length = len(stream.getbuffer())
+        for decoder, is_head_tail in zip(self.decoders, self._is_head_tail):
+            if not is_head_tail:
+                # the next 32 bytes are not a pointer,
+                # so progress the stream per the decoder
+                decoder(stream)
+            else:
+                # the next 32 bytes are a pointer
+                offset = decode_uint_256(stream)
+                indicated_idx = current_location + offset
+                if (
+                    indicated_idx < end_of_offsets
+                    or indicated_idx >= total_stream_length
+                ):
+                    # the pointer is indicating its data is located either within the
+                    # offsets section of the stream or beyond the end of the stream,
+                    # both of which are invalid
+                    raise InvalidPointer(
+                        "Invalid pointer in tuple at location "
+                        f"{stream.tell() - 32} in payload"
+                    )
+    # return the stream to its original location for actual decoding
+    stream.seek(current_location)
+
+
+# BaseArrayDecoder
+def validate_pointers_array(
+    self: "BaseArrayDecoder", stream: ContextFramesBytesIO, array_size: int
+) -> None:
+    """
+    Verify that all pointers point to a valid location in the stream.
+    """
+    current_location = stream.tell()
+    end_of_offsets = current_location + 32 * array_size
+    total_stream_length = len(stream.getbuffer())
+    for _ in range(array_size):
+        offset = decode_uint_256(stream)
+        indicated_idx = current_location + offset
+        if indicated_idx < end_of_offsets or indicated_idx >= total_stream_length:
+            # the pointer is indicating its data is located either within the
+            # offsets section of the stream or beyond the end of the stream,
+            # both of which are invalid
+            raise InvalidPointer(
+                "Invalid pointer in array at location "
+                f"{stream.tell() - 32} in payload"
+            )
+    stream.seek(current_location)
+
+
+# SizedArrayDecoder
+def decode_sized_array(
+    self: "SizedArrayDecoder[T]", stream: ContextFramesBytesIO
+) -> Tuple[T, ...]:
+    item_decoder = self.item_decoder
+    if item_decoder is None:
+        raise AssertionError("`item_decoder` is None")
+
+    array_size = self.array_size
+    
+    if item_decoder.is_dynamic:
+        validate_pointers_array(self, stream, array_size)
+
+    return tuple(item_decoder(stream) for _ in range(array_size))
+
+
+# DynamicArrayDecoder
+def decode_dynamic_array(
+    self: "DynamicArrayDecoder[T]", stream: ContextFramesBytesIO
+) -> Tuple[T, ...]:
+    if self.item_decoder is None:
+        raise AssertionError("`item_decoder` is None")
+        
+    array_size = decode_uint_256(stream)
+    stream.push_frame(32)
+
+    item_decoder = self.item_decoder
+    if item_decoder is None:
+        raise AssertionError("`item_decoder` is None")
+
+    if item_decoder.is_dynamic:
+        validate_pointers_array(self, stream, array_size)
+        
+    try:
+        return tuple(item_decoder(stream) for _ in range(array_size))
+    finally:
+        stream.pop_frame()
+
+
+# FixedByteSizeDecoder
+def read_fixed_byte_size_data_from_stream(
+    self: "FixedByteSizeDecoder[Any]",
+    # NOTE: use BytesIO here so mypyc doesn't type-check
+    # `stream` once we compile ContextFramesBytesIO.
+    stream: BytesIO,
+) -> bytes:
+    data_byte_size = self.data_byte_size
+    if len(data := stream.read(data_byte_size)) == data_byte_size:
+        return data
+    raise InsufficientDataBytes(
+        f"Tried to read {data_byte_size} bytes, only got {len(data)} bytes."
+    )
+
+
+def split_data_and_padding_fixed_byte_size(
+    self: "FixedByteSizeDecoder[Any]",
+    raw_data: bytes,
+) -> Tuple[bytes, bytes]:
+    value_byte_size = get_value_byte_size(self)
+    padding_size = self.data_byte_size - value_byte_size
+
+    if self.is_big_endian:
+        if padding_size == 0:
+            return raw_data, b""
+        padding_bytes = raw_data[:padding_size]
+        data = raw_data[padding_size:]
+    else:
+        data = raw_data[:value_byte_size]
+        padding_bytes = raw_data[value_byte_size:]
+
+    return data, padding_bytes
+
+
+def validate_padding_bytes_fixed_byte_size(
+    self: "FixedByteSizeDecoder[T]",
+    value: T,
+    padding_bytes: bytes,
+) -> None:
+    if padding_bytes != get_expected_padding_bytes(self, b"\x00"):
+        raise NonEmptyPaddingBytes(f"Padding bytes were not empty: {padding_bytes!r}")
+
+
+_expected_padding_bytes_cache: Final[
+    Dict["FixedByteSizeDecoder[Any]", Dict[bytes, bytes]]
+] = {}
+
+
+def get_expected_padding_bytes(
+    self: "FixedByteSizeDecoder[Any]", chunk: bytes
+) -> bytes:
+    instance_cache = _expected_padding_bytes_cache.setdefault(self, {})
+    expected_padding_bytes = instance_cache.get(chunk)
+    if expected_padding_bytes is None:
+        value_byte_size = get_value_byte_size(self)
+        padding_size = self.data_byte_size - value_byte_size
+        expected_padding_bytes = chunk * padding_size
+        instance_cache[chunk] = expected_padding_bytes
+    return expected_padding_bytes
+
+
+def validate_padding_bytes_signed_integer(
+    self: "SignedIntegerDecoder",
+    value: int,
+    padding_bytes: bytes,
+) -> None:
+    if value >= 0:
+        expected_padding_bytes = get_expected_padding_bytes(self, b"\x00")
+    else:
+        expected_padding_bytes = get_expected_padding_bytes(self, b"\xff")
+
+    if padding_bytes != expected_padding_bytes:
+        raise NonEmptyPaddingBytes(f"Padding bytes were not empty: {padding_bytes!r}")
+
+
+# BooleanDecoder
+def decoder_fn_boolean(data: bytes) -> bool:
+    if data == b"\x00":
+        return False
+    elif data == b"\x01":
+        return True
+    raise NonEmptyPaddingBytes(f"Boolean must be either 0x0 or 0x1.  Got: {data!r}")
+
+
+# UnignedFixedDecoder
+def decode_unsigned_fixed(self: "UnsignedFixedDecoder", data: bytes) -> decimal.Decimal:
+    value = big_endian_to_int(data)
+
+    with DECIMAL_CONTEXT:
+        decimal_value = Decimal(value) / self.denominator
+
+    return decimal_value
+
+
+# SignedFixedDecoder
+def decode_signed_fixed(self: "SignedFixedDecoder", data: bytes) -> decimal.Decimal:
+    value = big_endian_to_int(data)
+    if value >= self.neg_threshold:
+        value -= self.neg_offset
+
+    with DECIMAL_CONTEXT:
+        decimal_value = Decimal(value) / self.denominator
+
+    return decimal_value
+
+
+# ByteStringDecoder
+def read_bytestring_from_stream(self: "ByteStringDecoder", stream: ContextFramesBytesIO) -> bytes:
+    data_length = decode_uint_256(stream)
+    padded_length = ceil32(data_length)
+
+    data = stream.read(padded_length)
+
+    if self.strict:
+        if len(data) < padded_length:
+            raise InsufficientDataBytes(
+                f"Tried to read {padded_length} bytes, only got {len(data)} bytes"
+            )
+
+        padding_bytes = data[data_length:]
+        if padding_bytes != b"\x00" * (padded_length - data_length):
+            raise NonEmptyPaddingBytes(
+                f"Padding bytes were not empty: {padding_bytes!r}"
+            )
+
+    return data[:data_length]
+
+
+# StringDecoder
+def decode_string(self: "StringDecoder", stream: ContextFramesBytesIO) -> str:
+    data = read_bytestring_from_stream(self, stream)
+    return self.decoder_fn(data, self.bytes_errors)