astreum 0.1.7__py3-none-any.whl → 0.1.8__py3-none-any.whl

astreum-0.1.8.dist-info/METADATA

@@ -0,0 +1,84 @@
+Metadata-Version: 2.2
+Name: astreum
+Version: 0.1.8
+Summary: Python library to interact with the Astreum blockchain and its Lispeum 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
+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
+
+# 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, you need to provide a configuration dictionary. Below are the available configuration parameters:
+
+### Node Configuration
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `node_id` | bytes | Random 32 bytes | Unique identifier for the node |
+| `followed_chain_id` | bytes | None | ID of the blockchain that this node follows |
+| `storage_path` | str | "./storage" | Directory path where node data will be stored |
+
+### Network Configuration
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `use_ipv6` | bool | False | Whether to use IPv6 (True) or IPv4 (False) |
+| `incoming_port` | int | 7373 | Port to listen for incoming messages |
+| `max_message_size` | int | 65536 | Maximum size of UDP datagrams in bytes |
+| `num_workers` | int | 4 | Number of worker threads for message processing |
+
+### Route Configuration
+
+| Parameter | Type | Default | Description |
+|-----------|------|---------|-------------|
+| `peer_route` | bool | False | Whether to participate in the peer discovery route |
+| `validation_route` | bool | False | Whether to participate in the block validation route |
+| `bootstrap_peers` | list | [] | List of bootstrap peers in the format `[("hostname", port), ...]` |
+
+### Example Usage
+
+```python
+from astreum.node import Node
+
+# Configuration dictionary
+config = {
+    "node_id": b"my-unique-node-id-goes-here-exactly-32",  # 32 bytes
+    "followed_chain_id": b"main-chain-id-goes-here",
+    "storage_path": "./data/node1",
+    "incoming_port": 7373,
+    "use_ipv6": False,
+    "peer_route": True,
+    "validation_route": True,
+    "bootstrap_peers": [
+        ("bootstrap.astreum.org", 7373),
+        ("127.0.0.1", 7374)
+    ]
+}
+
+# Initialize the node with config
+node = Node(config)
+
+# Start the node
+node.start()
+
+# ... use the node ...
+
+# Stop the node when done
+node.stop()
+```
+
+## Testing
+
+python3 -m unittest discover -s tests

{astreum-0.1.7.dist-info → astreum-0.1.8.dist-info}/RECORD

@@ -30,8 +30,8 @@ astreum/node/relay/peer.py,sha256=eOml9G4xMoQeR_BuONVgJvpvCwhQo-QXCpRhShAxz4Q,57
 astreum/node/relay/route.py,sha256=ZyWoTC2EXX-SU_80fFS0TP-lITH6e9mDeS-irsfcMp4,4303
 astreum/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 astreum/utils/bytes_format.py,sha256=X4tG5GGPweNCE54bHYkLFiuLTbmpy5upO_s1Cef-MGA,2711
-astreum-0.1.7.dist-info/LICENSE,sha256=gYBvRDP-cPLmTyJhvZ346QkrYW_eleke4Z2Yyyu43eQ,1089
-astreum-0.1.7.dist-info/METADATA,sha256=nsh5rxiEoKuPh8ijGyydcsmYKtHp_4cnkc0b90KH-ZI,741
-astreum-0.1.7.dist-info/WHEEL,sha256=EaM1zKIUYa7rQnxGiOCGhzJABRwy4WO57rWMR3_tj4I,91
-astreum-0.1.7.dist-info/top_level.txt,sha256=1EG1GmkOk3NPmUA98FZNdKouhRyget-KiFiMk0i2Uz0,8
-astreum-0.1.7.dist-info/RECORD,,
+astreum-0.1.8.dist-info/LICENSE,sha256=gYBvRDP-cPLmTyJhvZ346QkrYW_eleke4Z2Yyyu43eQ,1089
+astreum-0.1.8.dist-info/METADATA,sha256=Uu8SnsLZ2vdk5fhicfnsqB3jCQN08u4hMB3_KZYMxOQ,2686
+astreum-0.1.8.dist-info/WHEEL,sha256=EaM1zKIUYa7rQnxGiOCGhzJABRwy4WO57rWMR3_tj4I,91
+astreum-0.1.8.dist-info/top_level.txt,sha256=1EG1GmkOk3NPmUA98FZNdKouhRyget-KiFiMk0i2Uz0,8
+astreum-0.1.8.dist-info/RECORD,,

astreum-0.1.7.dist-info/METADATA

@@ -1,24 +0,0 @@
-Metadata-Version: 2.2
-Name: astreum
-Version: 0.1.7
-Summary: Python library to interact with the Astreum blockchain and its Lispeum 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
-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
-
-# lib
-
-Python library to interact with the Astreum blockchain and its Lispeum virtual machine.
-
-[View on PyPI](https://pypi.org/project/astreum/)
-
-## Testing
-
-python3 -m unittest discover -s tests
-