From 11bbc255cb321201bfba4bd417cde1cfa815380f Mon Sep 17 00:00:00 2001 From: Arnaud Date: Tue, 23 Sep 2025 14:23:23 +0200 Subject: [PATCH] Provide better comments --- .../codex_thread_requests/requests/node_debug_request.nim | 6 +++++- .../requests/node_lifecycle_request.nim | 6 +++++- library/codex_thread_requests/requests/node_p2p_request.nim | 5 ++++- 3 files changed, 14 insertions(+), 3 deletions(-) diff --git a/library/codex_thread_requests/requests/node_debug_request.nim b/library/codex_thread_requests/requests/node_debug_request.nim index f58c022c..515aab83 100644 --- a/library/codex_thread_requests/requests/node_debug_request.nim +++ b/library/codex_thread_requests/requests/node_debug_request.nim @@ -1,4 +1,8 @@ -## This file contains the lifecycle request type that will be handled. +{.push raises: [].} + +## This file contains the debug info available with Codex. +## The DEBUG type will return info about the P2P node. +## The PEER type will return info about a specific peer if available. import std/[options] import chronos diff --git a/library/codex_thread_requests/requests/node_lifecycle_request.nim b/library/codex_thread_requests/requests/node_lifecycle_request.nim index 19bcb37c..d5431867 100644 --- a/library/codex_thread_requests/requests/node_lifecycle_request.nim +++ b/library/codex_thread_requests/requests/node_lifecycle_request.nim @@ -1,7 +1,9 @@ ## This file contains the lifecycle request type that will be handled. +## CREATE_NODE: create a new Codex node with the provided config.json. +## START_NODE: start the provided Codex node. +## STOP_NODE: stop the provided Codex node. import std/[options, json, strutils, net, os] -import confutils/defs import codexdht/discv5/spr import stew/shims/parseutils import contractabi/address @@ -10,6 +12,7 @@ import chronicles import results import confutils import confutils/std/net +import confutils/defs import libp2p import json_serialization import json_serialization/std/[options, net] @@ -17,6 +20,7 @@ import ../../alloc import ../../../codex/conf import ../../../codex/utils import ../../../codex/utils/[keyutils, fileutils] +import ../../../codex/units from ../../../codex/codex import CodexServer, new, start, stop diff --git a/library/codex_thread_requests/requests/node_p2p_request.nim b/library/codex_thread_requests/requests/node_p2p_request.nim index eebe874b..3b840702 100644 --- a/library/codex_thread_requests/requests/node_p2p_request.nim +++ b/library/codex_thread_requests/requests/node_p2p_request.nim @@ -1,4 +1,7 @@ -## This file contains the lifecycle request type that will be handled. +{.push raises: [].} + +## This file contains the P2p request type that will be handled. +## CONNECT: connect to a peer with the provided peer ID and optional addresses. import std/[options] import chronos