astreum 0.2.53__tar.gz → 0.3.10__tar.gz

{astreum-0.2.53/src/astreum.egg-info → astreum-0.3.10}/PKG-INFO

@@ -1,10 +1,10 @@
 Metadata-Version: 2.4
 Name: astreum
-Version: 0.2.53
-Summary: Python library to interact with the Astreum blockchain and its Lispeum virtual machine.
+Version: 0.3.10
+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
-Project-URL: Issues, https://github.com/astreum/lib/issues
+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
@@ -18,7 +18,7 @@ Dynamic: license-file
 
 # lib
 
-Python library to interact with the Astreum blockchain and its Lispeum virtual machine.
+Python library to interact with the Astreum blockchain and its virtual machine.
 
 [View on PyPI](https://pypi.org/project/astreum/)
 
@@ -30,21 +30,21 @@ When initializing an `astreum.Node`, pass a dictionary with any of the options b
 
 | Parameter                   | Type       | Default        | Description                                                                                                                                                                      |
 | --------------------------- | ---------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `machine-only`              | bool       | `True`         | When **True** the node starts in *machine‑only* mode: no storage subsystem and no relay networking – only the Lispeum VM. Set to **False** to enable storage and relay features. |
-| `relay_secret_key`          | hex string | Auto‑generated | Ed25519 private key that identifies the node on the network. If omitted, a fresh keypair is generated and kept in‑memory.                                                        |
-| `validation_secret_key`     | hex string | `None`         | X25519 private key that lets the node participate in the validation route. Leave unset for a non‑validator node.                                                                 |
-| `storage_path`              | string     | `None`         | Directory where objects are persisted. If *None*, the node uses an in‑memory store.                                                                                              |
-| `storage_get_relay_timeout` | float      | `5`            | Seconds to wait for an object requested from peers before timing‑out.                                                                                                            |
+| `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`         | int        | `90`           | Number of days to keep rotated log files (daily gzip).                                                                                                                           |
 | `verbose`                   | bool       | `False`        | When **True**, also mirror JSON logs to stdout with a human-readable format.                                                                                                     |
 
 ### Networking
 
-| Parameter       | Type                    | Default | Description                                                                         |
-| --------------- | ----------------------- | ------- | ----------------------------------------------------------------------------------- |
-| `use_ipv6`      | bool                    | `False` | Listen on IPv6 as well as IPv4.                                                     |
-| `incoming_port` | int                     | `7373`  | UDP port the relay binds to.                                                        |
-| `bootstrap`     | list\[tuple\[str, int]] | `[]`    | Initial peers used to join the network, e.g. `[ ("bootstrap.astreum.org", 7373) ]`. |
+| 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         | `7373`                | UDP port the relay binds to; pass `0` or omit to let the OS pick an ephemeral port.                       |
+| `bootstrap`              | list\[str\] | `[]`                  | Addresses to ping with a handshake before joining; each must look like `host:port` or `[ipv6]:port`.     |
 
 > **Note**
 > The peer‑to‑peer *route* used for object discovery is always enabled.
@@ -56,16 +56,16 @@ When initializing an `astreum.Node`, pass a dictionary with any of the options b
 from astreum.node import Node
 
 config = {
-    "machine-only": False,                   # run full node
     "relay_secret_key": "ab…cd",             # optional – hex encoded
     "validation_secret_key": "12…34",        # optional – validator
-    "storage_path": "./data/node1",
-    "storage_get_relay_timeout": 5,
+    "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": 7373,
     "use_ipv6": False,
     "bootstrap": [
-        ("bootstrap.astreum.org", 7373),
-        ("127.0.0.1", 7374)
+        "bootstrap.astreum.org:7373",
+        "127.0.0.1:7374"
     ]
 }
 
@@ -73,9 +73,10 @@ node = Node(config)
 # … your code …
 ```
 
-## Lispeum Machine Quickstart
 
-The Lispeum virtual machine (VM) is embedded inside `astreum.Node`. You feed it Lispeum source text, and the node tokenizes, parses, and **evaluates** the resulting AST inside an isolated environment.
+## 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
@@ -108,15 +109,15 @@ 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, b"int.add", int_add_fn)
+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, b"int.add")
-call = Expr.ListExpr([Expr.Byte(1), Expr.Byte(2), bound])
+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([b.value for b in res.elements])  # [3]
+print([int.from_bytes(b.value, 'big', signed=True) for b in res.elements])  # [3]
 ```
 
 ### Handling errors

{astreum-0.2.53 → astreum-0.3.10}/README.md

@@ -1,141 +1,142 @@
-# lib
-
-Python library to interact with the Astreum blockchain and its Lispeum 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                                                                                                                                                                      |
-| --------------------------- | ---------- | -------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `machine-only`              | bool       | `True`         | When **True** the node starts in *machine‑only* mode: no storage subsystem and no relay networking – only the Lispeum VM. Set to **False** to enable storage and relay features. |
-| `relay_secret_key`          | hex string | Auto‑generated | Ed25519 private key that identifies the node on the network. If omitted, a fresh keypair is generated and kept in‑memory.                                                        |
-| `validation_secret_key`     | hex string | `None`         | X25519 private key that lets the node participate in the validation route. Leave unset for a non‑validator node.                                                                 |
-| `storage_path`              | string     | `None`         | Directory where objects are persisted. If *None*, the node uses an in‑memory store.                                                                                              |
-| `storage_get_relay_timeout` | float      | `5`            | Seconds to wait for an object requested from peers before timing‑out.                                                                                                            |
-| `logging_retention`         | int        | `90`           | Number of days to keep rotated log files (daily gzip).                                                                                                                           |
-| `verbose`                   | bool       | `False`        | When **True**, also mirror JSON logs to stdout with a human-readable format.                                                                                                     |
-
-### Networking
-
-| Parameter       | Type                    | Default | Description                                                                         |
-| --------------- | ----------------------- | ------- | ----------------------------------------------------------------------------------- |
-| `use_ipv6`      | bool                    | `False` | Listen on IPv6 as well as IPv4.                                                     |
-| `incoming_port` | int                     | `7373`  | UDP port the relay binds to.                                                        |
-| `bootstrap`     | list\[tuple\[str, int]] | `[]`    | Initial peers used to join the network, e.g. `[ ("bootstrap.astreum.org", 7373) ]`. |
-
-> **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 = {
-    "machine-only": False,                   # run full node
-    "relay_secret_key": "ab…cd",             # optional – hex encoded
-    "validation_secret_key": "12…34",        # optional – validator
-    "storage_path": "./data/node1",
-    "storage_get_relay_timeout": 5,
-    "incoming_port": 7373,
-    "use_ipv6": False,
-    "bootstrap": [
-        ("bootstrap.astreum.org", 7373),
-        ("127.0.0.1", 7374)
-    ]
-}
-
-node = Node(config)
-# … your code …
-```
-
-## Lispeum Machine Quickstart
-
-The Lispeum virtual machine (VM) is embedded inside `astreum.Node`. You feed it Lispeum source text, and the node tokenizes, parses, and **evaluates** the resulting AST inside an isolated environment.
-
-```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, b"int.add", int_add_fn)
-
-# 5) Retrieve the function and call it with bytes 1 and 2
-bound = node.env_get(env_id, b"int.add")
-call = Expr.ListExpr([Expr.Byte(1), Expr.Byte(2), 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([b.value 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"]`.
-- 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 .
-python3 -m unittest discover -s tests
-```
+# 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`         | int        | `90`           | Number of days to keep rotated log files (daily gzip).                                                                                                                           |
+| `verbose`                   | bool       | `False`        | When **True**, also mirror JSON logs to stdout with a human-readable format.                                                                                                     |
+
+### Networking
+
+| 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         | `7373`                | UDP port the relay binds to; pass `0` or omit to let the OS pick an ephemeral port.                       |
+| `bootstrap`              | list\[str\] | `[]`                  | Addresses to ping with a handshake before joining; each must look like `host:port` or `[ipv6]:port`.     |
+
+> **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": 7373,
+    "use_ipv6": False,
+    "bootstrap": [
+        "bootstrap.astreum.org:7373",
+        "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"]`.
+- 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 .
+python3 -m unittest discover -s tests
+```

{astreum-0.2.53 → astreum-0.3.10}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "astreum"
-version = "0.2.53"
+version = "0.3.10"
 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 = [
@@ -19,5 +19,5 @@ dependencies = [
 ]
 
 [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.10/src/astreum/__init__.py

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

{astreum-0.2.53/src/astreum/_communication → astreum-0.3.10/src/astreum/communication}/__init__.py

@@ -1,6 +1,6 @@
-from .message import Message
-from .peer import Peer
-from .route import Route
+from .models.message import Message
+from .models.peer import Peer
+from .models.route import Route
 from .setup import communication_setup
 
 __all__ = [

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

@@ -0,0 +1,89 @@
+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
+
+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.
+    """
+    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)
+
+    old_key_bytes = node.addresses.get(peer_address)
+    node.addresses[peer_address] = sender_public_key_bytes
+
+    if old_key_bytes is None:
+        try:
+            peer = Peer(
+                node_secret_key=node.relay_secret_key,
+                peer_public_key=sender_key,
+                address=peer_address,
+            )
+        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))
+        return True
+
+    if old_key_bytes == sender_public_key_bytes:
+        peer = node.get_peer(sender_public_key_bytes)
+        if peer is not None:
+            peer.address = peer_address
+        return False
+
+    try:
+        node.peer_route.remove_peer(old_key_bytes)
+    except Exception:
+        pass
+    try:
+        peer = Peer(
+            node_secret_key=node.relay_secret_key,
+            peer_public_key=sender_key,
+            address=peer_address,
+        )
+    except Exception:
+        return True
+
+    node.replace_peer(old_key_bytes, sender_public_key_bytes, peer)
+    node.peer_route.add_peer(sender_public_key_bytes, peer)
+    node.logger.info(
+        "Peer at %s:%s replaced due to key change",
+        peer_address[0],
+        peer_address[1],
+    )
+    return False