diff --git a/.gitignore b/.gitignore index 7fe05ef..d81d275 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,6 @@ /waku_vibe_template /waku_vibe_template.dSYM -/nim_chat_poc +/logos_chat *.dSYM nimble.develop nimble.paths @@ -21,7 +21,7 @@ nimble.paths /tags # a symlink that can't be added to the repo because of Windows -/nim_chat_poc.nims +/logos_chat.nims # Ignore dynamic, static libs and libtool archive files *.so diff --git a/DEVELOPING.md b/DEVELOPING.md index 32fe621..e707d70 100644 --- a/DEVELOPING.md +++ b/DEVELOPING.md @@ -5,9 +5,9 @@ ```mermaid flowchart TD - NIM("nim-chat-poc
c-bingings, process control, networking
") + NIM("Logos-Chat
c-bingings, process control, networking
") LIB("libchat
encryption, encoding
") - PROTO("chat_proto
protobufs, language specific types
") + PROTO("chat-proto
protobufs, language specific types
") LMN("logos-messaging-nim
p2p networking
") @@ -22,13 +22,13 @@ style LMN fill:#fff ## Repositories -### nim-chat-poc +### logos-chat Root of the Logos chat SDK, written in Nim. Handles async operations and bridges network operations with the cryptographic backend. **Responsibilities:** -- C bindings to libchat +- C bindings to Libchat - Async execution (Chronos) - Network integration @@ -42,12 +42,12 @@ Operates as a pipeline: accepts either encrypted payloads or plaintext content, - Encoding/decoding -### logos-messaging-nim +### logos-message-delivery P2P networking layer using logos-messaging protocol. Provides decentralized message transport. This is an external dependency. -### chat_proto +### chat-proto Protobuf definitions. Defines the protobufs used in the logos-chat protocol and provides generated types for various languages. \ No newline at end of file diff --git a/Makefile b/Makefile index d243276..5fd6c03 100644 --- a/Makefile +++ b/Makefile @@ -41,12 +41,12 @@ define test_name $(shell echo '$(MAKECMDGOALS)' | cut -d' ' -f3-) endef -nim_chat_poc.nims: - ln -s nim_chat_poc.nimble $@ +logos_chat.nims: + ln -s logos_chat.nimble $@ update: | update-common - rm -rf nim_chat_poc.nims && \ - $(MAKE) nim_chat_poc.nims $(HANDLE_OUTPUT) + rm -rf logos_chat.nims && \ + $(MAKE) logos_chat.nims $(HANDLE_OUTPUT) clean: rm -rf build @@ -88,9 +88,9 @@ build-waku-nat: @echo "Completed building nat-libs" .PHONY: tests -tests: | build-waku-librln build-waku-nat nim_chat_poc.nims +tests: | build-waku-librln build-waku-nat logos_chat.nims echo -e $(BUILD_MSG) "build/$@" && \ - $(ENV_SCRIPT) nim tests $(NIM_PARAMS) nim_chat_poc.nims + $(ENV_SCRIPT) nim tests $(NIM_PARAMS) logos_chat.nims ########## @@ -98,9 +98,9 @@ tests: | build-waku-librln build-waku-nat nim_chat_poc.nims ########## # Ensure there is a nimble task with a name that matches the target -tui bot_echo pingpong: | build-waku-librln build-waku-nat nim_chat_poc.nims +tui bot_echo pingpong: | build-waku-librln build-waku-nat logos_chat.nims echo -e $(BUILD_MSG) "build/$@" && \ - $(ENV_SCRIPT) nim $@ $(NIM_PARAMS) --path:src nim_chat_poc.nims + $(ENV_SCRIPT) nim $@ $(NIM_PARAMS) --path:src logos_chat.nims ########### ## Library ## @@ -118,9 +118,9 @@ endif LIBLOGOSCHAT := build/liblogoschat.$(LIBLOGOSCHAT_EXT) .PHONY: liblogoschat -liblogoschat: | build-waku-librln build-waku-nat nim_chat_poc.nims +liblogoschat: | build-waku-librln build-waku-nat logos_chat.nims echo -e $(BUILD_MSG) "$(LIBLOGOSCHAT)" && \ - $(ENV_SCRIPT) nim liblogoschat $(NIM_PARAMS) --path:src nim_chat_poc.nims && \ + $(ENV_SCRIPT) nim liblogoschat $(NIM_PARAMS) --path:src logos_chat.nims && \ echo -e "\n\x1B[92mLibrary built successfully:\x1B[39m" && \ echo " $(shell pwd)/$(LIBLOGOSCHAT)" diff --git a/nim_chat_poc.nimble b/logos_chat.nimble similarity index 95% rename from nim_chat_poc.nimble rename to logos_chat.nimble index 04eaf01..7099837 100644 --- a/nim_chat_poc.nimble +++ b/logos_chat.nimble @@ -5,7 +5,7 @@ author = "jazzz" description = "An example of the chat sdk in Nim" license = "MIT" srcDir = "src" -bin = @["nim_chat_poc"] +bin = @["logos_chat"] # Dependencies @@ -75,7 +75,7 @@ task bot_echo, "Build the EchoBot example": task pingpong, "Build the Pingpong example": let name = "pingpong" - buildBinary name, "examples/", "-d:chronicles_log_level='INFO' -d:chronicles_disabled_topics='waku node' " + buildBinary name, "./", "-d:chronicles_log_level='INFO' -d:chronicles_disabled_topics='waku node' " task liblogoschat, "Build the Chat SDK shared library (C bindings)": buildLibrary "logoschat", "library/",