koi-net 1.1.0b1__py3-none-any.whl → 1.1.0b2__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of koi-net might be problematic. Click here for more details.

koi_net/config.py CHANGED
@@ -29,6 +29,7 @@ class KoiNetConfig(BaseModel):
29
29
  cache_directory_path: str = ".rid_cache"
30
30
  event_queues_path: str = "event_queues.json"
31
31
  private_key_pem_path: str = "priv_key.pem"
32
+ polling_interval: int = 5
32
33
 
33
34
  first_contact: NodeContact = Field(default_factory=NodeContact)
34
35
 
koi_net/core.py CHANGED
@@ -1,5 +1,5 @@
1
1
  import logging
2
- import httpx
2
+ from koi_net.protocol.node import NodeType
3
3
  from rid_lib.ext import Cache
4
4
  from .network.resolver import NetworkResolver
5
5
  from .network.event_queue import NetworkEventQueue
@@ -17,6 +17,9 @@ from .secure import Secure
17
17
  from .config import NodeConfig
18
18
  from .context import HandlerContext, ActionContext
19
19
  from .effector import Effector
20
+ from .server import NodeServer
21
+ from .lifecycle import NodeLifecycle
22
+ from .poller import NodePoller
20
23
  from . import default_actions
21
24
 
22
25
  logger = logging.getLogger(__name__)
@@ -32,16 +35,15 @@ class NodeInterface:
32
35
  graph: NetworkGraph
33
36
  processor: ProcessorInterface
34
37
  secure: Secure
38
+ server: NodeServer
35
39
 
36
40
  use_kobj_processor_thread: bool
37
41
 
38
42
  def __init__(
39
- self,
43
+ self,
40
44
  config: NodeConfig,
41
45
  use_kobj_processor_thread: bool = False,
42
-
43
46
  handlers: list[KnowledgeHandler] | None = None,
44
-
45
47
  cache: Cache | None = None,
46
48
  processor: ProcessorInterface | None = None
47
49
  ):
@@ -49,9 +51,8 @@ class NodeInterface:
49
51
  self.cache = cache or Cache(
50
52
  directory_path=self.config.koi_net.cache_directory_path
51
53
  )
52
-
54
+
53
55
  self.identity = NodeIdentity(config=self.config)
54
-
55
56
  self.effector = Effector(cache=self.cache)
56
57
 
57
58
  self.graph = NetworkGraph(
@@ -146,47 +147,30 @@ class NodeInterface:
146
147
  self.effector.set_processor(self.processor)
147
148
  self.effector.set_resolver(self.resolver)
148
149
  self.effector.set_action_context(self.action_context)
149
-
150
-
151
- def start(self) -> None:
152
- """Starts a node, call this method first.
153
-
154
- Starts the processor thread (if enabled). Loads event queues into memory. Generates network graph from nodes and edges in cache. Processes any state changes of node bundle. Initiates handshake with first contact (if provided) if node doesn't have any neighbors.
155
- """
156
- if self.use_kobj_processor_thread:
157
- logger.info("Starting processor worker thread")
158
- self.processor.worker_thread.start()
159
-
160
- # self.network._load_event_queues()
161
- self.graph.generate()
162
-
163
- # refresh to reflect changes (if any) in config.yaml
164
- self.effector.deref(self.identity.rid, refresh_cache=True)
165
-
166
- logger.debug("Waiting for kobj queue to empty")
167
- if self.use_kobj_processor_thread:
168
- self.processor.kobj_queue.join()
169
- else:
170
- self.processor.flush_kobj_queue()
171
- logger.debug("Done")
172
-
173
- if not self.graph.get_neighbors() and self.config.koi_net.first_contact.rid:
174
- logger.debug(f"I don't have any neighbors, reaching out to first contact {self.config.koi_net.first_contact.rid!r}")
175
-
176
- self.actor.handshake_with(self.config.koi_net.first_contact.rid)
177
-
178
-
179
- def stop(self):
180
- """Stops a node, call this method last.
181
-
182
- Finishes processing knowledge object queue. Saves event queues to storage.
183
- """
184
- logger.info("Stopping node...")
185
-
186
- if self.use_kobj_processor_thread:
187
- logger.info(f"Waiting for kobj queue to empty ({self.processor.kobj_queue.unfinished_tasks} tasks remaining)")
188
- self.processor.kobj_queue.join()
189
- else:
190
- self.processor.flush_kobj_queue()
191
-
192
- # self.network._save_event_queues()
150
+
151
+ self.lifecycle = NodeLifecycle(
152
+ config=self.config,
153
+ identity=self.identity,
154
+ graph=self.graph,
155
+ processor=self.processor,
156
+ effector=self.effector,
157
+ actor=self.actor,
158
+ use_kobj_processor_thread=use_kobj_processor_thread
159
+ )
160
+
161
+ # if self.config.koi_net.node_profile.node_type == NodeType.FULL:
162
+ self.server = NodeServer(
163
+ config=self.config,
164
+ lifecycle=self.lifecycle,
165
+ secure=self.secure,
166
+ processor=self.processor,
167
+ event_queue=self.event_queue,
168
+ response_handler=self.response_handler
169
+ )
170
+
171
+ self.poller = NodePoller(
172
+ processor=self.processor,
173
+ lifecycle=self.lifecycle,
174
+ resolver=self.resolver,
175
+ config=self.config
176
+ )
koi_net/lifecycle.py ADDED
@@ -0,0 +1,76 @@
1
+ import logging
2
+
3
+ from .network.behavior import Actor
4
+ from .effector import Effector
5
+ from .config import NodeConfig
6
+ from .processor.interface import ProcessorInterface
7
+ from .network.graph import NetworkGraph
8
+ from .identity import NodeIdentity
9
+
10
+ logger = logging.getLogger(__name__)
11
+
12
+
13
+ class NodeLifecycle:
14
+ config: NodeConfig
15
+ graph: NetworkGraph
16
+ processor: ProcessorInterface
17
+ effector: Effector
18
+ actor: Actor
19
+
20
+ def __init__(
21
+ self,
22
+ config: NodeConfig,
23
+ identity: NodeIdentity,
24
+ graph: NetworkGraph,
25
+ processor: ProcessorInterface,
26
+ effector: Effector,
27
+ actor: Actor,
28
+ use_kobj_processor_thread: bool
29
+ ):
30
+ self.config = config
31
+ self.identity = identity
32
+ self.graph = graph
33
+ self.processor = processor
34
+ self.effector = effector
35
+ self.actor = actor
36
+ self.use_kobj_processor_thread = use_kobj_processor_thread
37
+
38
+ def start(self) -> None:
39
+ """Starts a node, call this method first.
40
+
41
+ Starts the processor thread (if enabled). Loads event queues into memory. Generates network graph from nodes and edges in cache. Processes any state changes of node bundle. Initiates handshake with first contact (if provided) if node doesn't have any neighbors.
42
+ """
43
+ if self.use_kobj_processor_thread:
44
+ logger.info("Starting processor worker thread")
45
+ self.processor.worker_thread.start()
46
+
47
+ self.graph.generate()
48
+
49
+ # refresh to reflect changes (if any) in config.yaml
50
+ self.effector.deref(self.identity.rid, refresh_cache=True)
51
+
52
+ logger.debug("Waiting for kobj queue to empty")
53
+ if self.use_kobj_processor_thread:
54
+ self.processor.kobj_queue.join()
55
+ else:
56
+ self.processor.flush_kobj_queue()
57
+ logger.debug("Done")
58
+
59
+ if not self.graph.get_neighbors() and self.config.koi_net.first_contact.rid:
60
+ logger.debug(f"I don't have any neighbors, reaching out to first contact {self.config.koi_net.first_contact.rid!r}")
61
+
62
+ self.actor.handshake_with(self.config.koi_net.first_contact.rid)
63
+
64
+
65
+ def stop(self):
66
+ """Stops a node, call this method last.
67
+
68
+ Finishes processing knowledge object queue. Saves event queues to storage.
69
+ """
70
+ logger.info("Stopping node...")
71
+
72
+ if self.use_kobj_processor_thread:
73
+ logger.info(f"Waiting for kobj queue to empty ({self.processor.kobj_queue.unfinished_tasks} tasks remaining)")
74
+ self.processor.kobj_queue.join()
75
+ else:
76
+ self.processor.flush_kobj_queue()
koi_net/poller.py ADDED
@@ -0,0 +1,45 @@
1
+
2
+ import time
3
+ import logging
4
+ from .processor.interface import ProcessorInterface
5
+ from .lifecycle import NodeLifecycle
6
+ from .network.resolver import NetworkResolver
7
+ from .config import NodeConfig
8
+
9
+ logger = logging.getLogger(__name__)
10
+
11
+
12
+ class NodePoller:
13
+ def __init__(
14
+ self,
15
+ processor: ProcessorInterface,
16
+ lifecycle: NodeLifecycle,
17
+ resolver: NetworkResolver,
18
+ config: NodeConfig
19
+ ):
20
+ self.processor = processor
21
+ self.lifecycle = lifecycle
22
+ self.resolver = resolver
23
+ self.config = config
24
+
25
+ def run(self):
26
+ try:
27
+ self.lifecycle.start()
28
+ while True:
29
+ start_time = time.time()
30
+ neighbors = self.resolver.poll_neighbors()
31
+ for node_rid in neighbors:
32
+ for event in neighbors[node_rid]:
33
+ self.processor.handle(event=event, source=node_rid)
34
+ self.processor.flush_kobj_queue()
35
+
36
+ elapsed = time.time() - start_time
37
+ sleep_time = self.config.koi_net.polling_interval - elapsed
38
+ if sleep_time > 0:
39
+ time.sleep(sleep_time)
40
+
41
+ except KeyboardInterrupt:
42
+ logger.info("Polling interrupted by user.")
43
+
44
+ finally:
45
+ self.lifecycle.stop()
koi_net/server.py ADDED
@@ -0,0 +1,128 @@
1
+ import logging
2
+ import uvicorn
3
+ from contextlib import asynccontextmanager
4
+ from fastapi import FastAPI, APIRouter
5
+ from fastapi.responses import JSONResponse
6
+ from .network.event_queue import NetworkEventQueue
7
+ from .network.response_handler import ResponseHandler
8
+ from .processor.interface import ProcessorInterface
9
+ from .protocol.api_models import (
10
+ PollEvents,
11
+ FetchRids,
12
+ FetchManifests,
13
+ FetchBundles,
14
+ EventsPayload,
15
+ RidsPayload,
16
+ ManifestsPayload,
17
+ BundlesPayload,
18
+ ErrorResponse
19
+ )
20
+ from .protocol.errors import ProtocolError
21
+ from .protocol.envelope import SignedEnvelope
22
+ from .protocol.consts import (
23
+ BROADCAST_EVENTS_PATH,
24
+ POLL_EVENTS_PATH,
25
+ FETCH_RIDS_PATH,
26
+ FETCH_MANIFESTS_PATH,
27
+ FETCH_BUNDLES_PATH
28
+ )
29
+ from .secure import Secure
30
+ from .lifecycle import NodeLifecycle
31
+ from .config import NodeConfig
32
+
33
+ logger = logging.getLogger(__name__)
34
+
35
+
36
+ class NodeServer:
37
+ lifecycle: NodeLifecycle
38
+
39
+ def __init__(
40
+ self,
41
+ config: NodeConfig,
42
+ lifecycle: NodeLifecycle,
43
+ secure: Secure,
44
+ processor: ProcessorInterface,
45
+ event_queue: NetworkEventQueue,
46
+ response_handler: ResponseHandler
47
+ ):
48
+ self.config = config
49
+ self.lifecycle = lifecycle
50
+ self.secure = secure
51
+ self.processor = processor
52
+ self.event_queue = event_queue
53
+ self.response_handler = response_handler
54
+ self._build_app()
55
+
56
+ def _build_app(self):
57
+ self.app = FastAPI(
58
+ lifespan=self.lifespan,
59
+ title="KOI-net Protocol API",
60
+ version="1.0.0"
61
+ )
62
+
63
+ self.router = APIRouter(prefix="/koi-net")
64
+ self.app.add_exception_handler(ProtocolError, self.protocol_error_handler)
65
+
66
+ def _add_endpoint(path, func):
67
+ self.router.add_api_route(
68
+ path=path,
69
+ endpoint=self.secure.envelope_handler(func),
70
+ methods=["POST"]
71
+ )
72
+
73
+ _add_endpoint(BROADCAST_EVENTS_PATH, self.broadcast_events)
74
+ _add_endpoint(POLL_EVENTS_PATH, self.poll_events)
75
+ _add_endpoint(FETCH_RIDS_PATH, self.fetch_rids)
76
+ _add_endpoint(FETCH_MANIFESTS_PATH, self.fetch_manifests)
77
+ _add_endpoint(FETCH_BUNDLES_PATH, self.fetch_bundles)
78
+
79
+ self.app.include_router(self.router)
80
+
81
+ def run(self):
82
+ uvicorn.run(
83
+ app=self.app,
84
+ host=self.config.server.host,
85
+ port=self.config.server.port
86
+ )
87
+
88
+ @asynccontextmanager
89
+ async def lifespan(self, app: FastAPI):
90
+ self.lifecycle.start()
91
+ yield
92
+ self.lifecycle.stop()
93
+
94
+ def protocol_error_handler(self, request, exc: ProtocolError):
95
+ logger.info(f"caught protocol error: {exc}")
96
+ resp = ErrorResponse(error=exc.error_type)
97
+ logger.info(f"returning error response: {resp}")
98
+ return JSONResponse(
99
+ status_code=400,
100
+ content=resp.model_dump(mode="json")
101
+ )
102
+
103
+ async def broadcast_events(self, req: SignedEnvelope[EventsPayload]):
104
+ logger.info(f"Request to {BROADCAST_EVENTS_PATH}, received {len(req.payload.events)} event(s)")
105
+ for event in req.payload.events:
106
+ self.processor.handle(event=event, source=req.source_node)
107
+
108
+ async def poll_events(
109
+ self, req: SignedEnvelope[PollEvents]
110
+ ) -> SignedEnvelope[EventsPayload] | ErrorResponse:
111
+ logger.info(f"Request to {POLL_EVENTS_PATH}")
112
+ events = self.event_queue.flush_poll_queue(req.payload.rid)
113
+ return EventsPayload(events=events)
114
+
115
+ async def fetch_rids(
116
+ self, req: SignedEnvelope[FetchRids]
117
+ ) -> SignedEnvelope[RidsPayload] | ErrorResponse:
118
+ return self.response_handler.fetch_rids(req.payload)
119
+
120
+ async def fetch_manifests(
121
+ self, req: SignedEnvelope[FetchManifests]
122
+ ) -> SignedEnvelope[ManifestsPayload] | ErrorResponse:
123
+ return self.response_handler.fetch_manifests(req.payload)
124
+
125
+ async def fetch_bundles(
126
+ self, req: SignedEnvelope[FetchBundles]
127
+ ) -> SignedEnvelope[BundlesPayload] | ErrorResponse:
128
+ return self.response_handler.fetch_bundles(req.payload)
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: koi-net
3
- Version: 1.1.0b1
3
+ Version: 1.1.0b2
4
4
  Summary: Implementation of KOI-net protocol in Python
5
5
  Project-URL: Homepage, https://github.com/BlockScience/koi-net/
6
6
  Author-email: Luke Miller <luke@block.science>
@@ -28,19 +28,19 @@ License: MIT License
28
28
  License-File: LICENSE
29
29
  Requires-Python: >=3.10
30
30
  Requires-Dist: cryptography>=45.0.3
31
+ Requires-Dist: fastapi>=0.115.12
31
32
  Requires-Dist: httpx>=0.28.1
32
33
  Requires-Dist: networkx>=3.4.2
33
34
  Requires-Dist: pydantic>=2.10.6
34
35
  Requires-Dist: python-dotenv>=1.1.0
35
36
  Requires-Dist: rid-lib>=3.2.7
36
37
  Requires-Dist: ruamel-yaml>=0.18.10
38
+ Requires-Dist: uvicorn>=0.34.2
37
39
  Provides-Extra: dev
38
40
  Requires-Dist: build; extra == 'dev'
39
41
  Requires-Dist: twine>=6.0; extra == 'dev'
40
42
  Provides-Extra: examples
41
- Requires-Dist: fastapi; extra == 'examples'
42
43
  Requires-Dist: rich; extra == 'examples'
43
- Requires-Dist: uvicorn; extra == 'examples'
44
44
  Description-Content-Type: text/markdown
45
45
 
46
46
  # KOI-net
@@ -1,11 +1,14 @@
1
1
  koi_net/__init__.py,sha256=b0Ze0pZmJAuygpWUFHM6Kvqo3DkU_uzmkptv1EpAArw,31
2
- koi_net/config.py,sha256=Zu6iVPQ1yar9OMZQp-Ez0eYRIoCeDq69eTQyYplQqQc,4057
2
+ koi_net/config.py,sha256=47XbQ59GRYFi4rlsoWKlnzMQATcnK70i3qmKTZAGOQk,4087
3
3
  koi_net/context.py,sha256=JmbpCzusXFq_NCXiUp5Z56N6vpBdYMUK8eOs7ogO68A,1428
4
- koi_net/core.py,sha256=QIYRlvi5BFxaQKYrbI8CGs2yZxf-U6PeJlYBaG6HsLQ,6474
4
+ koi_net/core.py,sha256=wJjEaza-Q_QqTZL8xOWdlMkjOhCmX8Lj3uBy2GUGDF0,5565
5
5
  koi_net/default_actions.py,sha256=TkQR9oj9CpO37Gb5bZLmFNl-Q8n3OxGiX4dvxQR7SaA,421
6
6
  koi_net/effector.py,sha256=gSyZgRxQ91X04UL261e2pXWUfBHnQTGtjSHpc2JufxA,4097
7
7
  koi_net/identity.py,sha256=FvIWksGTqwM7HCevIwmo_6l-t-2tnYkaaR4CanZatL4,569
8
+ koi_net/lifecycle.py,sha256=-J5y4i0JdernatLTed8hQbkK26Cs6rm1kZqlx3aQzZA,2727
9
+ koi_net/poller.py,sha256=tlqbDMTdkU8vCbi95rOBeHUEWLkrECKW3gnF9MYhKQw,1369
8
10
  koi_net/secure.py,sha256=cGNF2assqCaYq0i0fhQBm7aREoAdpY-XVypDsE1ALaU,3970
11
+ koi_net/server.py,sha256=ONJMhC_9VNBTVTdHRMP66T9QIZ1UuSZY7C_KoRcVb9k,4199
9
12
  koi_net/network/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
10
13
  koi_net/network/behavior.py,sha256=NZLvWlrxR0uWriE3ZzCXmocUVccQthy7Xx8E_8KBwsg,1208
11
14
  koi_net/network/error_handler.py,sha256=CrmCpBY2oj4nl7uXrIYusUHDKxPZ1HDuQAtiBSZarRI,1623
@@ -29,7 +32,7 @@ koi_net/protocol/errors.py,sha256=A83QiYe_fJdxW2lsNsLCujWxDr5sk1UmYYd3TGbSNJA,60
29
32
  koi_net/protocol/event.py,sha256=eGgihEj1gliLoQRk8pVB2q_was0AGo-PbT3Hqnpn3oU,1379
30
33
  koi_net/protocol/node.py,sha256=7GQzHORFr9cP4BqJgir6EGSWCskL-yqmvJksIiLfcWU,409
31
34
  koi_net/protocol/secure.py,sha256=Reem9Z4le4uWXM9uczNOdmgVBg8p4YQav-7_c3pZ1CQ,3366
32
- koi_net-1.1.0b1.dist-info/METADATA,sha256=pHwaqM6wXoQpOUINUBlLlmCnSv3nEHF-EbL5x42jf3s,37142
33
- koi_net-1.1.0b1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
34
- koi_net-1.1.0b1.dist-info/licenses/LICENSE,sha256=03mgCL5qth2aD9C3F3qNVs4sFJSpK9kjtYCyOwdSp7s,1069
35
- koi_net-1.1.0b1.dist-info/RECORD,,
35
+ koi_net-1.1.0b2.dist-info/METADATA,sha256=k341N2GlyWwem7ojdmX1PH8tij0D4CQHfOjGnuv5XYQ,37118
36
+ koi_net-1.1.0b2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
37
+ koi_net-1.1.0b2.dist-info/licenses/LICENSE,sha256=03mgCL5qth2aD9C3F3qNVs4sFJSpK9kjtYCyOwdSp7s,1069
38
+ koi_net-1.1.0b2.dist-info/RECORD,,