rename CreateReceipt,UpdateReceipt... to Receipt to CreaeteEvent, UpdateEvent, ...

Author: matthiaszimmermann

src/arkiv/__init__.py

@@ -1,7 +1,24 @@
 """Python SDK for Arkiv networks."""
 
+from .account import NamedAccount
 from .client import Arkiv
 from .node import ArkivNode
+from .types import (
+    CreateEvent,
+    DeleteEvent,
+    ExtendEvent,
+    TransactionReceipt,
+    UpdateEvent,
+)
 
 __version__ = "0.1.0"
-__all__ = ["Arkiv", "ArkivNode"]
+__all__ = [
+    "Arkiv",
+    "ArkivNode",
+    "CreateEvent",
+    "DeleteEvent",
+    "ExtendEvent",
+    "NamedAccount",
+    "TransactionReceipt",
+    "UpdateEvent",
+]

src/arkiv/types.py

@@ -139,46 +139,46 @@ def __init__(
 
 
 @dataclass(frozen=True)
-class CreateReceipt:
-    """The return type of a create operation."""
+class CreateEvent:
+    """Event emitted when an entity is created."""
 
     entity_key: EntityKey
     expiration_block: int
 
 
 @dataclass(frozen=True)
-class UpdateReceipt:
-    """The return type of an update operation."""
+class UpdateEvent:
+    """Event emitted when an entity is updated."""
 
     entity_key: EntityKey
     expiration_block: int
 
 
 @dataclass(frozen=True)
-class ExtendReceipt:
-    """The return type of an extend operation."""
+class ExtendEvent:
+    """Event emitted when an entity's lifetime is extended."""
 
     entity_key: EntityKey
     old_expiration_block: int
     new_expiration_block: int
 
 
 @dataclass(frozen=True)
-class DeleteReceipt:
-    """The return type of a delete operation."""
+class DeleteEvent:
+    """Event emitted when an entity is deleted."""
 
     entity_key: EntityKey
 
 
 @dataclass(frozen=True)
 class TransactionReceipt:
-    """The return type of a transaction."""
+    """Receipt of a transaction containing all emitted events."""
 
     tx_hash: TxHash
-    creates: Sequence[CreateReceipt]
-    updates: Sequence[UpdateReceipt]
-    extensions: Sequence[ExtendReceipt]
-    deletes: Sequence[DeleteReceipt]
+    creates: Sequence[CreateEvent]
+    updates: Sequence[UpdateEvent]
+    extensions: Sequence[ExtendEvent]
+    deletes: Sequence[DeleteEvent]
 
 
 # Low level annotations for RLP encoding

src/arkiv/utils.py

@@ -16,18 +16,18 @@
 from .exceptions import AnnotationException, EntityKeyException
 from .types import (
     Annotations,
-    CreateReceipt,
-    DeleteReceipt,
+    CreateEvent,
+    DeleteEvent,
     EntityKey,
-    ExtendReceipt,
+    ExtendEvent,
     NumericAnnotations,
     NumericAnnotationsRlp,
     Operations,
     StringAnnotations,
     StringAnnotationsRlp,
     TransactionReceipt,
     TxHash,
-    UpdateReceipt,
+    UpdateEvent,
 )
 
 logger = logging.getLogger(__name__)
@@ -147,11 +147,11 @@ def to_receipt(
         else TxHash(HexStr(HexBytes(tx_hash_).to_0x_hex()))
     )
 
-    # Initialize receipt with tx hash and empty receipt collections
-    creates: list[CreateReceipt] = []
-    updates: list[UpdateReceipt] = []
-    extensions: list[ExtendReceipt] = []
-    deletes: list[DeleteReceipt] = []
+    # Initialize receipt with tx hash and empty event collections
+    creates: list[CreateEvent] = []
+    updates: list[UpdateEvent] = []
+    extensions: list[ExtendEvent] = []
+    deletes: list[DeleteEvent] = []
 
     receipt = TransactionReceipt(
         tx_hash=tx_hash,
@@ -174,28 +174,28 @@ def to_receipt(
                 case contract.CREATED_EVENT:
                     expiration_block: int = event_args["expirationBlock"]
                     creates.append(
-                        CreateReceipt(
+                        CreateEvent(
                             entity_key=entity_key,
                             expiration_block=expiration_block,
                         )
                     )
                 case contract.UPDATED_EVENT:
                     expiration_block = event_args["expirationBlock"]
                     updates.append(
-                        UpdateReceipt(
+                        UpdateEvent(
                             entity_key=entity_key,
                             expiration_block=expiration_block,
                         )
                     )
                 case contract.DELETED_EVENT:
                     deletes.append(
-                        DeleteReceipt(
+                        DeleteEvent(
                             entity_key=entity_key,
                         )
                     )
                 case contract.EXTENDED_EVENT:
                     extensions.append(
-                        ExtendReceipt(
+                        ExtendEvent(
                             entity_key=entity_key,
                             old_expiration_block=event_args["oldExpirationBlock"],
                             new_expiration_block=event_args["newExpirationBlock"],