v1.2.0

.gitignore

@@ -1,12 +1,14 @@
 rid-lib
 __pycache__
-*.json
 *.pem
 *.yaml
+*.ndjson*
 venv
 .env
 prototypes
 .vscode
 dist/
 docs/
-*.ndjson
+tests/
+.rid_cache/
+*.ndjson

examples/coordinator.py

@@ -1,65 +1,53 @@
-import logging
-from rich.logging import RichHandler
-from pydantic import Field
 from rid_lib.types import KoiNetNode, KoiNetEdge
-from koi_net.config import NodeConfig, KoiNetConfig
-from koi_net.protocol.node import NodeProfile, NodeProvides, NodeType
-from koi_net import NodeInterface
-from koi_net.context import HandlerContext
-from koi_net.processor.handler import HandlerType
+import structlog
+from koi_net.config.full_node import (
+    FullNodeConfig, 
+    ServerConfig, 
+    KoiNetConfig, 
+    NodeProfile, 
+    NodeProvides
+)
+from koi_net.core import FullNode
+from koi_net.processor.context import HandlerContext
+from koi_net.processor.handler import HandlerType, KnowledgeHandler
 from koi_net.processor.knowledge_object import KnowledgeObject
 from koi_net.protocol.event import Event, EventType
 from koi_net.protocol.edge import EdgeType, generate_edge_bundle
 
-logging.basicConfig(
-    level=logging.INFO,
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-    datefmt="%Y-%m-%d %H:%M:%S",
-    handlers=[RichHandler()]
-)
+log = structlog.stdlib.get_logger()
 
-logging.getLogger("koi_net").setLevel(logging.DEBUG)
-logger = logging.getLogger(__name__)
 
-class CoordinatorConfig(NodeConfig):
-    koi_net: KoiNetConfig = Field(default_factory = lambda:
-        KoiNetConfig(
-            node_name="coordinator",
-            node_profile=NodeProfile(
-                node_type=NodeType.FULL,
-                provides=NodeProvides(
-                    event=[KoiNetNode, KoiNetEdge],
-                    state=[KoiNetNode, KoiNetEdge]
-                )
-            ),
-            cache_directory_path=".coordinator_rid_cache",
-            event_queues_path="coordinator_event_queues.json",
-            private_key_pem_path="coordinator_priv_key.pem"
-        )
+class CoordinatorConfig(FullNodeConfig):
+    server: ServerConfig = ServerConfig(port=8080)
+    koi_net: KoiNetConfig = KoiNetConfig(
+        node_name="coordinator",
+        node_profile=NodeProfile(
+            provides=NodeProvides(
+                event=[KoiNetNode, KoiNetEdge],
+                state=[KoiNetNode, KoiNetEdge]
+            )
+        ),
+        rid_types_of_interest=[KoiNetNode, KoiNetEdge]
     )
-
-node = NodeInterface(
-    config=CoordinatorConfig.load_from_yaml("coordinator_config.yaml"),
-    use_kobj_processor_thread=True
-)
 
-@node.processor.pipeline.register_handler(HandlerType.Network, rid_types=[KoiNetNode])
+@KnowledgeHandler.create(
+    HandlerType.Network, 
+    rid_types=[KoiNetNode])
 def handshake_handler(ctx: HandlerContext, kobj: KnowledgeObject):
-    logger.info("Handling node handshake")
+    log.info("Handling node handshake")
 
     # only respond if node declares itself as NEW
     if kobj.event_type != EventType.NEW:
         return
 
-    logger.info("Sharing this node's bundle with peer")
-    identity_bundle = ctx.effector.deref(ctx.identity.rid)
-    ctx.event_queue.push_event_to(
+    log.info("Sharing this node's bundle with peer")
+    identity_bundle = ctx.cache.read(ctx.identity.rid)
+    ctx.event_queue.push(
         event=Event.from_bundle(EventType.NEW, identity_bundle),
-        node=kobj.rid,
-        flush=True
+        target=kobj.rid
     )
 
-    logger.info("Proposing new edge")    
+    log.info("Proposing new edge")    
     # defer handling of proposed edge
 
     edge_bundle = generate_edge_bundle(
@@ -69,8 +57,12 @@ def handshake_handler(ctx: HandlerContext, kobj: KnowledgeObject):
         rid_types=[KoiNetNode, KoiNetEdge]
     )
 
-    ctx.handle(rid=edge_bundle.rid, event_type=EventType.FORGET)
-    ctx.handle(bundle=edge_bundle)
-
+    ctx.kobj_queue.push(rid=edge_bundle.rid, event_type=EventType.FORGET)
+    ctx.kobj_queue.push(bundle=edge_bundle)
+
+class CoordinatorNode(FullNode):
+    config_schema = CoordinatorConfig
+    knowledge_handlers = FullNode.knowledge_handlers + [handshake_handler]
+
 if __name__ == "__main__":
-    node.server.run()
+    CoordinatorNode().run()

examples/partial.py

@@ -1,37 +1,15 @@
-import logging
-from pydantic import Field
-from rich.logging import RichHandler
-from koi_net import NodeInterface
-from koi_net.protocol.node import NodeProfile, NodeType
-from koi_net.config import NodeConfig, KoiNetConfig
+from koi_net.config.partial_node import PartialNodeConfig, KoiNetConfig, NodeProfile
+from koi_net.core import PartialNode
 
-logging.basicConfig(
-    level=logging.INFO,
-    format="%(asctime)s - %(name)s - %(levelname)s - %(message)s",
-    datefmt="%Y-%m-%d %H:%M:%S",
-    handlers=[RichHandler()]
-)
 
-logging.getLogger("koi_net").setLevel(logging.DEBUG)
-logger = logging.getLogger(__name__)
-
-
-class PartialNodeConfig(NodeConfig):
-    koi_net: KoiNetConfig = Field(default_factory = lambda:
-        KoiNetConfig(
-            node_name="partial",
-            node_profile=NodeProfile(
-                node_type=NodeType.PARTIAL
-            ),
-            cache_directory_path=".partial_rid_cache",
-            event_queues_path="partial_event_queues.json",
-            private_key_pem_path="partial_priv_key.pem"
-        )
+class MyPartialNodeConfig(PartialNodeConfig):
+    koi_net: KoiNetConfig = KoiNetConfig(
+        node_name="partial",
+        node_profile=NodeProfile()
     )
 
-node = NodeInterface(
-    config=PartialNodeConfig.load_from_yaml("partial_config.yaml")
-)
+class MyPartialNode(PartialNode):
+    config_schema = MyPartialNodeConfig
 
 if __name__ == "__main__":
-    node.poller.run()
+    MyPartialNode().run()

koi-net.config.json

@@ -0,0 +1,79 @@
+{
+    "$schema": "https://lnav.org/schemas/format-v1.schema.json",
+    "koi_net_json_log": {
+        "title": "KOI-net node logs",
+        "description": "Detailed logs of node and network behavior",
+        "file-type": "json",
+        "body-field": "event",
+        "level-field": "",
+        "timestamp-field": "timestamp",
+        "hide-extra": true,
+        "line-format": [
+            {
+                "field": "timestamp",
+                "auto-width": true,
+                "timestamp-format": "%Y-%m-%d %H:%M:%S"
+            },
+            " ",
+            {
+                "field": "level",
+                "auto-width": true,
+                "prefix": "[",
+                "suffix": "]"
+            },
+            " ",
+            {
+                "field": "module",
+                "min-width": 15,
+                "max-width": 15,
+                "overflow": "dot-dot",
+                "align": "right"
+            },
+            " - ",
+            {
+                "field": "event"
+            }
+        ],
+        "value": {
+            "level": {
+                "kind": "string"
+            },
+            "event": {
+                "kind": "string"
+            },
+            "module": {
+                "kind": "string"
+            }
+        },
+        "highlights": {
+            "debug": {
+                "pattern": "\\[(debug) *\\]",
+                "color": "Blue"
+            },
+            "info": {
+                "pattern": "\\[(info) *\\]",
+                "color": "Green"
+            },
+            "warning": {
+                "pattern": "\\[(warning) *\\]",
+                "color": "Yellow"
+            },
+            "error": {
+                "pattern": "\\[(error|critical) *\\]",
+                "color": "Red"
+            },
+            "timestamp": {
+                "pattern": "(\\d{4}-\\d{2}-\\d{2} \\d{2}:\\d{2}:\\d{2})",
+                "color": "Grey"
+            },
+            "obj_name": {
+                "pattern": "<([a-zA-Z.]+)",
+                "color": "Purple"
+            },
+            "quotations": {
+                "pattern": "(['\"][^']*['\"])",
+                "color": "Green"
+            }
+        }
+    }
+}

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "koi-net"
-version = "1.1.0"
+version = "1.2.0"
 description = "Implementation of KOI-net protocol in Python"
 authors = [
     {name = "Luke Miller", email = "luke@block.science"}
@@ -23,6 +23,7 @@ dependencies = [
     "fastapi>=0.115.12",
     "uvicorn>=0.34.2",
     "rich>=14.1.0",
+    "structlog>=25.4.0",
 ]
 
 [project.optional-dependencies]

schemas/bundle.schema.json

@@ -0,0 +1,16 @@
+{
+  "title": "Bundle",
+  "type": "object",
+  "properties": {
+    "manifest": {
+      "$ref": "./manifest.schema.json"
+    },
+    "contents": {
+      "type": "object"
+    }
+  },
+  "required": [
+    "manifest",
+    "contents"
+  ]
+}

schemas/bundles_payload.schema.json

@@ -0,0 +1,32 @@
+{
+    "title": "Bundles Payload",
+    "type": "object",
+    "properties": {
+        "type": {
+            "type": "string",
+            "const": "bundles_payload"
+        },
+        "bundles": {
+            "type": "array",
+            "items": {
+                "$ref": "./bundle.schema.json"
+            }
+        },
+        "not_found": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        },
+        "deferred": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        }
+    },
+    "required": [
+        "type",
+        "bundles"
+    ]
+}

schemas/edge_profile.schema.json

@@ -0,0 +1,49 @@
+{
+    "$defs": {
+        "EdgeStatus": {
+            "title": "Edge Status",
+            "type": "string",
+            "enum": [
+                "PROPOSED",
+                "APPROVED"
+            ]
+        },
+        "EdgeType": {
+            "title": "Edge Type",
+            "type": "string",
+            "enum": [
+                "WEBHOOK",
+                "POLL"
+            ]
+        }
+    },
+    "title": "Edge Profile",
+    "type": "object",
+    "properties": {
+        "source": {
+            "type": "string"
+        },
+        "target": {
+            "type": "string"
+        },
+        "edge_type": {
+            "$ref": "#/$defs/EdgeType"
+        },
+        "status": {
+            "$ref": "#/$defs/EdgeStatus"
+        },
+        "rid_types": {
+            "type": "array",
+            "items": {
+                "type": "string"
+            }
+        }
+    },
+    "required": [
+        "source",
+        "target",
+        "edge_type",
+        "status",
+        "rid_types"
+    ]
+}