astreum 0.1.13__tar.gz → 0.3.34__tar.gz

astreum-0.3.34/PKG-INFO

@@ -0,0 +1,188 @@
+Metadata-Version: 2.4
+Name: astreum
+Version: 0.3.34
+Summary: Python library to interact with the Astreum blockchain and its virtual machine.
+Author-email: "Roy R. O. Okello" <roy@stelar.xyz>
+Project-URL: Homepage, https://github.com/astreum/lib-py
+Project-URL: Issues, https://github.com/astreum/lib-py/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pycryptodomex==3.21.0
+Requires-Dist: cryptography==44.0.2
+Requires-Dist: blake3==1.0.4
+Dynamic: license-file
+
+# lib
+
+Python library to interact with the Astreum blockchain and its virtual machine.
+
+[View on PyPI](https://pypi.org/project/astreum/)
+
+## Configuration
+
+When initializing an `astreum.Node`, pass a dictionary with any of the options below. Only the parameters you want to override need to be present – everything else falls back to its default.
+
+### Core Configuration
+
+| Parameter                   | Type       | Default        | Description                                                                                                                                                                      |
+| --------------------------- | ---------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `hot_storage_limit`         | int        | `1073741824`   | Maximum bytes kept in the hot cache before new atoms are skipped (1 GiB).                                                                                                         |
+| `cold_storage_limit`        | int        | `10737418240`  | Cold storage write threshold (10 GiB by default); set to `0` to skip the limit.                                                                                                   |
+| `cold_storage_path`         | string     | `None`         | Directory where persisted atoms live; Astreum creates it on startup and skips cold storage when unset.                                                                            |
+| `logging_retention_days`    | int        | `90`           | Number of days to keep rotated log files (daily gzip).                                                                                                                           |
+| `chain_id`                  | int        | `0`            | Chain identifier used for validation (0 = test, 1 = main).                                                                                                                        |
+| `verbose`                   | bool       | `False`        | When **True**, also mirror JSON logs to stdout with a human-readable format.                                                                                                     |
+
+### Communication
+
+| Parameter                | Type        | Default               | Description                                                                                             |
+| ------------------------ | ----------- | --------------------- | ------------------------------------------------------------------------------------------------------- |
+| `relay_secret_key`       | hex string  | Auto-generated        | X25519 private key used for the relay route; a new keypair is created when this field is omitted.        |
+| `validation_secret_key`  | hex string  | `None`                | Optional Ed25519 key that lets the node join the validation route; leave blank to opt out of validation. |
+| `use_ipv6`               | bool        | `False`               | Bind the incoming/outgoing sockets on IPv6 (the OS still listens on IPv4 if a peer speaks both).         |
+| `incoming_port`          | int         | `52780`                | UDP port the relay binds to; pass `0` or omit to let the OS pick an ephemeral port.                       |
+| `default_seed`           | string     | `"bootstrap.astreum.org:52780"` | Default address to ping before joining; set to `None` to disable the built-in default.          |
+| `additional_seeds`       | list\[str\] | `[]`                  | Extra addresses appended to the bootstrap list; each must look like `host:port` or `[ipv6]:port`.        |
+| `peer_timeout`           | int         | `900`                 | Evict peers that have not been seen within this many seconds (15 minutes).                               |
+| `peer_timeout_interval`  | int         | `10`                  | How often (seconds) the peer manager checks for stale peers.                                             |
+| `bootstrap_retry_interval` | int       | `30`                  | How often (seconds) to retry bootstrapping when the peer list is empty.                                  |
+| `storage_index_interval` | int         | `600`                 | How often (seconds) to re-advertise cold storage atoms to the closest known peer.                        |
+| `outgoing_queue_size_limit` | int     | `67108864`            | Soft cap (bytes) for `enqueue_outgoing`-tracked outgoing queue usage; set to `0` to disable.            |
+
+> **Note**
+> The peer‑to‑peer *route* used for object discovery is always enabled.
+> If `validation_secret_key` is provided the node automatically joins the validation route too.
+
+### Example
+
+```python
+from astreum.node import Node
+
+config = {
+    "relay_secret_key": "ab…cd",             # optional – hex encoded
+    "validation_secret_key": "12…34",        # optional – validator
+    "hot_storage_limit": 1073741824,         # cap hot cache at 1 GiB
+    "cold_storage_limit": 10737418240,       # cap cold storage at 10 GiB
+    "cold_storage_path": "./data/node1",
+    "incoming_port": 52780,
+    "use_ipv6": False,
+    "default_seed": None,
+    "additional_seeds": [
+        "127.0.0.1:7374"
+    ]
+}
+
+node = Node(config)
+# … your code …
+```
+
+
+## Astreum Machine Quickstart
+
+The Astreum virtual machine (VM) is embedded inside `astreum.Node`. You feed it Astreum script, and the node tokenizes, parses, and evaluates.
+
+```python
+# Define a named function int.add (stack body) and call it with bytes 1 and 2
+
+import uuid
+from astreum import Node, Env, Expr
+
+# 1) Spin‑up a stand‑alone VM
+node = Node()
+
+# 2) Create an environment (simple manual setup)
+env_id = uuid.uuid4()
+node.environments[env_id] = Env()
+
+# 3) Build a function value using a low‑level stack body via `sk`.
+# Body does: $0 $1 add   (i.e., a + b)
+low_body = Expr.ListExpr([
+    Expr.Symbol("$0"),  # a (first arg)
+    Expr.Symbol("$1"),  # b (second arg)
+    Expr.Symbol("add"),
+])
+
+fn_body = Expr.ListExpr([
+    Expr.Symbol("a"),
+    Expr.Symbol("b"),
+    Expr.ListExpr([low_body, Expr.Symbol("sk")]),
+])
+
+params = Expr.ListExpr([Expr.Symbol("a"), Expr.Symbol("b")])
+int_add_fn = Expr.ListExpr([fn_body, params, Expr.Symbol("fn")])
+
+# 4) Store under the name "int.add"
+node.env_set(env_id, "int.add", int_add_fn)
+
+# 5) Retrieve the function and call it with bytes 1 and 2
+bound = node.env_get(env_id, "int.add")
+call = Expr.ListExpr([Expr.Bytes(b"\x01"), Expr.Bytes(b"\x02"), bound])
+res  = node.high_eval(env_id, call)
+
+# sk returns a list of bytes; for 1+2 expect a single byte with value 3
+print([int.from_bytes(b.value, 'big', signed=True) for b in res.elements])  # [3]
+```
+
+### Handling errors
+
+Both helpers raise `ParseError` (from `astreum.machine.error`) when something goes wrong:
+
+* Unterminated string literals are caught by `tokenize`.
+* Unexpected or missing parentheses are caught by `parse`.
+
+Catch the exception to provide developer‑friendly diagnostics:
+
+```python
+try:
+    tokens = tokenize(bad_source)
+    expr, _ = parse(tokens)
+except ParseError as e:
+    print("Parse failed:", e)
+```
+
+---
+
+
+## Logging
+
+Every `Node` instance wires up structured logging automatically:
+
+- Logs land in per-instance files named `node.log` under `%LOCALAPPDATA%\Astreum\lib-py\logs/<instance_id>` on Windows and `$XDG_STATE_HOME` (or `~/.local/state`)/`Astreum/lib-py/logs/<instance_id>` on other platforms. The `<instance_id>` is the first 16 hex characters of a BLAKE3 hash of the caller's file path, so running the node from different entry points keeps their logs isolated.
+- Files rotate at midnight UTC with gzip compression (`node-YYYY-MM-DD.log.gz`) and retain 90 days by default. Override via `config["logging_retention_days"]`.
+- Each event is a single JSON line containing timestamp, level, logger, message, process/thread info, module/function, and the derived `instance_id`.
+- Set `config["verbose"] = True` to mirror logs to stdout in a human-friendly format like `[2025-04-13-42-59] [info] Starting Astreum Node`.
+- The very first entry emitted is the banner `Starting Astreum Node`, signalling that the logging pipeline is live before other subsystems spin up.
+
+## Testing
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e .
+```
+
+for all tests
+```
+python3 -m unittest discover -s tests
+```
+
+for individual tests
+```
+python3 -m unittest tests.node.test_atom_get
+python3 -m unittest tests.node.test_current_validator
+python3 -m unittest tests.node.test_node_connection
+python3 -m unittest tests.node.test_node_init
+python3 -m unittest tests.node.test_node_validation
+python3 -m unittest tests.node.tokenize
+python3 -m unittest tests.node.parse
+python3 -m unittest tests.node.function
+python3 -m unittest tests.node.stack
+python3 -m unittest tests.models.test_merkle
+python3 -m unittest tests.models.test_patricia
+python3 -m unittest tests.block.atom
+python3 -m unittest tests.block.nonce
+```

astreum-0.3.34/README.md

@@ -0,0 +1,170 @@
+# lib
+
+Python library to interact with the Astreum blockchain and its virtual machine.
+
+[View on PyPI](https://pypi.org/project/astreum/)
+
+## Configuration
+
+When initializing an `astreum.Node`, pass a dictionary with any of the options below. Only the parameters you want to override need to be present – everything else falls back to its default.
+
+### Core Configuration
+
+| Parameter                   | Type       | Default        | Description                                                                                                                                                                      |
+| --------------------------- | ---------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `hot_storage_limit`         | int        | `1073741824`   | Maximum bytes kept in the hot cache before new atoms are skipped (1 GiB).                                                                                                         |
+| `cold_storage_limit`        | int        | `10737418240`  | Cold storage write threshold (10 GiB by default); set to `0` to skip the limit.                                                                                                   |
+| `cold_storage_path`         | string     | `None`         | Directory where persisted atoms live; Astreum creates it on startup and skips cold storage when unset.                                                                            |
+| `logging_retention_days`    | int        | `90`           | Number of days to keep rotated log files (daily gzip).                                                                                                                           |
+| `chain_id`                  | int        | `0`            | Chain identifier used for validation (0 = test, 1 = main).                                                                                                                        |
+| `verbose`                   | bool       | `False`        | When **True**, also mirror JSON logs to stdout with a human-readable format.                                                                                                     |
+
+### Communication
+
+| Parameter                | Type        | Default               | Description                                                                                             |
+| ------------------------ | ----------- | --------------------- | ------------------------------------------------------------------------------------------------------- |
+| `relay_secret_key`       | hex string  | Auto-generated        | X25519 private key used for the relay route; a new keypair is created when this field is omitted.        |
+| `validation_secret_key`  | hex string  | `None`                | Optional Ed25519 key that lets the node join the validation route; leave blank to opt out of validation. |
+| `use_ipv6`               | bool        | `False`               | Bind the incoming/outgoing sockets on IPv6 (the OS still listens on IPv4 if a peer speaks both).         |
+| `incoming_port`          | int         | `52780`                | UDP port the relay binds to; pass `0` or omit to let the OS pick an ephemeral port.                       |
+| `default_seed`           | string     | `"bootstrap.astreum.org:52780"` | Default address to ping before joining; set to `None` to disable the built-in default.          |
+| `additional_seeds`       | list\[str\] | `[]`                  | Extra addresses appended to the bootstrap list; each must look like `host:port` or `[ipv6]:port`.        |
+| `peer_timeout`           | int         | `900`                 | Evict peers that have not been seen within this many seconds (15 minutes).                               |
+| `peer_timeout_interval`  | int         | `10`                  | How often (seconds) the peer manager checks for stale peers.                                             |
+| `bootstrap_retry_interval` | int       | `30`                  | How often (seconds) to retry bootstrapping when the peer list is empty.                                  |
+| `storage_index_interval` | int         | `600`                 | How often (seconds) to re-advertise cold storage atoms to the closest known peer.                        |
+| `outgoing_queue_size_limit` | int     | `67108864`            | Soft cap (bytes) for `enqueue_outgoing`-tracked outgoing queue usage; set to `0` to disable.            |
+
+> **Note**
+> The peer‑to‑peer *route* used for object discovery is always enabled.
+> If `validation_secret_key` is provided the node automatically joins the validation route too.
+
+### Example
+
+```python
+from astreum.node import Node
+
+config = {
+    "relay_secret_key": "ab…cd",             # optional – hex encoded
+    "validation_secret_key": "12…34",        # optional – validator
+    "hot_storage_limit": 1073741824,         # cap hot cache at 1 GiB
+    "cold_storage_limit": 10737418240,       # cap cold storage at 10 GiB
+    "cold_storage_path": "./data/node1",
+    "incoming_port": 52780,
+    "use_ipv6": False,
+    "default_seed": None,
+    "additional_seeds": [
+        "127.0.0.1:7374"
+    ]
+}
+
+node = Node(config)
+# … your code …
+```
+
+
+## Astreum Machine Quickstart
+
+The Astreum virtual machine (VM) is embedded inside `astreum.Node`. You feed it Astreum script, and the node tokenizes, parses, and evaluates.
+
+```python
+# Define a named function int.add (stack body) and call it with bytes 1 and 2
+
+import uuid
+from astreum import Node, Env, Expr
+
+# 1) Spin‑up a stand‑alone VM
+node = Node()
+
+# 2) Create an environment (simple manual setup)
+env_id = uuid.uuid4()
+node.environments[env_id] = Env()
+
+# 3) Build a function value using a low‑level stack body via `sk`.
+# Body does: $0 $1 add   (i.e., a + b)
+low_body = Expr.ListExpr([
+    Expr.Symbol("$0"),  # a (first arg)
+    Expr.Symbol("$1"),  # b (second arg)
+    Expr.Symbol("add"),
+])
+
+fn_body = Expr.ListExpr([
+    Expr.Symbol("a"),
+    Expr.Symbol("b"),
+    Expr.ListExpr([low_body, Expr.Symbol("sk")]),
+])
+
+params = Expr.ListExpr([Expr.Symbol("a"), Expr.Symbol("b")])
+int_add_fn = Expr.ListExpr([fn_body, params, Expr.Symbol("fn")])
+
+# 4) Store under the name "int.add"
+node.env_set(env_id, "int.add", int_add_fn)
+
+# 5) Retrieve the function and call it with bytes 1 and 2
+bound = node.env_get(env_id, "int.add")
+call = Expr.ListExpr([Expr.Bytes(b"\x01"), Expr.Bytes(b"\x02"), bound])
+res  = node.high_eval(env_id, call)
+
+# sk returns a list of bytes; for 1+2 expect a single byte with value 3
+print([int.from_bytes(b.value, 'big', signed=True) for b in res.elements])  # [3]
+```
+
+### Handling errors
+
+Both helpers raise `ParseError` (from `astreum.machine.error`) when something goes wrong:
+
+* Unterminated string literals are caught by `tokenize`.
+* Unexpected or missing parentheses are caught by `parse`.
+
+Catch the exception to provide developer‑friendly diagnostics:
+
+```python
+try:
+    tokens = tokenize(bad_source)
+    expr, _ = parse(tokens)
+except ParseError as e:
+    print("Parse failed:", e)
+```
+
+---
+
+
+## Logging
+
+Every `Node` instance wires up structured logging automatically:
+
+- Logs land in per-instance files named `node.log` under `%LOCALAPPDATA%\Astreum\lib-py\logs/<instance_id>` on Windows and `$XDG_STATE_HOME` (or `~/.local/state`)/`Astreum/lib-py/logs/<instance_id>` on other platforms. The `<instance_id>` is the first 16 hex characters of a BLAKE3 hash of the caller's file path, so running the node from different entry points keeps their logs isolated.
+- Files rotate at midnight UTC with gzip compression (`node-YYYY-MM-DD.log.gz`) and retain 90 days by default. Override via `config["logging_retention_days"]`.
+- Each event is a single JSON line containing timestamp, level, logger, message, process/thread info, module/function, and the derived `instance_id`.
+- Set `config["verbose"] = True` to mirror logs to stdout in a human-friendly format like `[2025-04-13-42-59] [info] Starting Astreum Node`.
+- The very first entry emitted is the banner `Starting Astreum Node`, signalling that the logging pipeline is live before other subsystems spin up.
+
+## Testing
+
+```bash
+python3 -m venv venv
+source venv/bin/activate
+pip install -e .
+```
+
+for all tests
+```
+python3 -m unittest discover -s tests
+```
+
+for individual tests
+```
+python3 -m unittest tests.node.test_atom_get
+python3 -m unittest tests.node.test_current_validator
+python3 -m unittest tests.node.test_node_connection
+python3 -m unittest tests.node.test_node_init
+python3 -m unittest tests.node.test_node_validation
+python3 -m unittest tests.node.tokenize
+python3 -m unittest tests.node.parse
+python3 -m unittest tests.node.function
+python3 -m unittest tests.node.stack
+python3 -m unittest tests.models.test_merkle
+python3 -m unittest tests.models.test_patricia
+python3 -m unittest tests.block.atom
+python3 -m unittest tests.block.nonce
+```

{astreum-0.1.13 → astreum-0.3.34}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "astreum"
-version = "0.1.13"
+version = "0.3.34"
 authors = [
   { name="Roy R. O. Okello", email="roy@stelar.xyz" },
 ]
-description = "Python library to interact with the Astreum blockchain and its Lispeum virtual machine."
+description = "Python library to interact with the Astreum blockchain and its virtual machine."
 readme = "README.md"
 requires-python = ">=3.8"
 classifiers = [
@@ -15,8 +15,9 @@ classifiers = [
 dependencies = [
     "pycryptodomex==3.21.0",
     "cryptography==44.0.2",
+    "blake3==1.0.4"
 ]
 
 [project.urls]
-Homepage = "https://github.com/astreum/lib"
-Issues = "https://github.com/astreum/lib/issues"
+Homepage = "https://github.com/astreum/lib-py"
+Issues = "https://github.com/astreum/lib-py/issues"

astreum-0.3.34/src/astreum/__init__.py

@@ -0,0 +1,19 @@
+
+from astreum.validation import Account, Accounts, Block, Fork, Receipt, Transaction
+from astreum.machine import Env, Expr, parse, tokenize
+from astreum.node import Node
+
+
+__all__: list[str] = [
+    "Node",
+    "Env",
+    "Expr",
+    "Block",
+    "Fork",
+    "Receipt",
+    "Transaction",
+    "Account",
+    "Accounts",
+    "parse",
+    "tokenize",
+]

astreum-0.3.34/src/astreum/communication/__init__.py

@@ -0,0 +1,13 @@
+from .models.message import Message
+from .models.peer import Peer
+from .models.route import Route
+from .outgoing_queue import enqueue_outgoing
+from .setup import communication_setup
+
+__all__ = [
+    "Message",
+    "Peer",
+    "Route",
+    "enqueue_outgoing",
+    "communication_setup",
+]

astreum-0.3.34/src/astreum/communication/disconnect.py

@@ -0,0 +1,57 @@
+"""Helpers related to disconnecting communication components."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from astreum.node import Node
+
+
+_SOCKET_ATTRS: tuple[str, ...] = ("incoming_socket", "outgoing_socket")
+_THREAD_ATTRS: tuple[str, ...] = (
+    "incoming_populate_thread",
+    "incoming_process_thread",
+    "outgoing_thread",
+    "peer_manager_thread",
+    "latest_block_discovery_thread",
+    "verify_thread",
+    "consensus_validation_thread",
+)
+
+
+def _set_event(node: "Node", attr_name: str) -> None:
+    event = getattr(node, attr_name, None)
+    if event is not None:
+        event.set()
+
+
+def _close_socket(node: "Node", attr_name: str) -> None:
+    sock = getattr(node, attr_name, None)
+    if sock is None:
+        return
+    try:
+        sock.close()
+    except Exception as exc:  # pragma: no cover - defensive logging path
+        node.logger.warning("Error closing %s: %s", attr_name, exc)
+
+
+def disconnect_node(node: "Node") -> None:
+    """Gracefully stop worker threads and close communication sockets."""
+    node.logger.info("Disconnecting Astreum Node")
+
+    _set_event(node, "communication_stop_event")
+    _set_event(node, "_validation_stop_event")
+    _set_event(node, "_verify_stop_event")
+
+    for sock_name in _SOCKET_ATTRS:
+        _close_socket(node, sock_name)
+
+    for thread_name in _THREAD_ATTRS:
+        thread = getattr(node, thread_name, None)
+        if thread is None or not thread.is_alive():
+            continue
+        thread.join(timeout=1.0)
+
+    node.is_connected = False
+    node.logger.info("Node disconnected")

astreum-0.3.34/src/astreum/communication/handlers/handshake.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Sequence
+
+from cryptography.hazmat.primitives import serialization
+from cryptography.hazmat.primitives.asymmetric.x25519 import X25519PublicKey
+
+from ..models.peer import Peer
+from ..models.message import Message, MessageTopic
+from ..models.ping import Ping
+
+if TYPE_CHECKING:
+    from .... import Node
+
+
+def handle_handshake(node: "Node", addr: Sequence[object], message: Message) -> bool:
+    """Handle incoming handshake messages.
+
+    Returns True if the outer loop should `continue`, False otherwise.
+    """
+    def _queue_handshake_ping(peer: Peer, peer_address: tuple[str, int]) -> None:
+        latest_block = getattr(node, "latest_block_hash", None)
+        if not isinstance(latest_block, (bytes, bytearray)) or len(latest_block) != 32:
+            latest_block = None
+        try:
+            ping_payload = Ping(
+                is_validator=bool(getattr(node, "validation_public_key", None)),
+                latest_block=latest_block,
+            ).to_bytes()
+            ping_msg = Message(
+                topic=MessageTopic.PING,
+                content=ping_payload,
+                sender=node.relay_public_key,
+            )
+            ping_msg.encrypt(peer.shared_key_bytes)
+            node.outgoing_queue.put((ping_msg.to_bytes(), peer_address))
+        except Exception as exc:
+            node.logger.debug(
+                "Failed sending handshake ping to %s:%s: %s",
+                peer_address[0],
+                peer_address[1],
+                exc,
+            )
+    sender_public_key_bytes = message.sender_bytes
+    try:
+        sender_key = X25519PublicKey.from_public_bytes(sender_public_key_bytes)
+    except Exception as exc:
+        node.logger.warning("Error extracting sender key bytes: %s", exc)
+        return True
+
+    try:
+        host = addr[0]
+        port = int.from_bytes(message.content[:2], "big", signed=False)
+    except Exception:
+        return True
+    peer_address = (host, port)
+    default_seed_ips = getattr(node, "default_seed_ips", None)
+    is_default_seed = bool(default_seed_ips) and host in default_seed_ips
+
+    existing_peer = node.get_peer(sender_public_key_bytes)
+    if existing_peer is not None:
+        existing_peer.address = peer_address
+        existing_peer.is_default_seed = is_default_seed
+        _queue_handshake_ping(existing_peer, peer_address)
+        return False
+
+    try:
+        peer = Peer(
+            node_secret_key=node.relay_secret_key,
+            peer_public_key=sender_key,
+            address=peer_address,
+            is_default_seed=is_default_seed,
+        )
+    except Exception:
+        return True
+
+    node.add_peer(sender_public_key_bytes, peer)
+    node.peer_route.add_peer(sender_public_key_bytes, peer)
+
+    node.logger.info(
+        "Handshake accepted from %s:%s; peer added",
+        peer_address[0],
+        peer_address[1],
+    )
+    response = Message(
+        handshake=True,
+        sender=node.relay_public_key,
+        content=int(node.config["incoming_port"]).to_bytes(2, "big", signed=False),
+    )
+    node.outgoing_queue.put((response.to_bytes(), peer_address))
+    _queue_handshake_ping(peer, peer_address)
+    return True