mirror of
https://github.com/logos-messaging/nim-chat-poc.git
synced 2026-02-18 04:53:41 +00:00
Rename Prep (#63)
* Remove Nim-Chat-POC references * Update nimble file. * Remove references to ChatSDK as a product
This commit is contained in:
parent
9e2df8feef
commit
504e433c00
4
.gitignore
vendored
4
.gitignore
vendored
@ -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
|
||||
|
||||
@ -5,9 +5,9 @@
|
||||
```mermaid
|
||||
flowchart TD
|
||||
|
||||
NIM("<a href="https://github.com/logos-messaging/nim-chat-poc"><b>nim-chat-poc</b><br>c-bingings, process control, networking</a>")
|
||||
NIM("<a href="https://github.com/logos-messaging/logos-chat"><b>Logos-Chat</b><br>c-bingings, process control, networking</a>")
|
||||
LIB("<a href="https://github.com/logos-messaging/libchat"><b>libchat</b><br>encryption, encoding</a>")
|
||||
PROTO("<a href="https://github.com/logos-messaging/chat_proto"><b>chat_proto</b><br>protobufs, language specific types</a>")
|
||||
PROTO("<a href="https://github.com/logos-messaging/chat-proto"><b>chat-proto</b><br>protobufs, language specific types</a>")
|
||||
LMN("<a href="https://github.com/logos-messaging/logos-messaging-nim"><b>logos-messaging-nim</b><br>p2p networking</a>")
|
||||
|
||||
|
||||
@ -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.
|
||||
14
Makefile
14
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
|
||||
@ -97,7 +97,7 @@ build-libchat:
|
||||
.PHONY: tests
|
||||
tests: | build-waku-librln build-waku-nat build-libchat nim_chat_poc.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
|
||||
|
||||
|
||||
##########
|
||||
@ -107,7 +107,7 @@ tests: | build-waku-librln build-waku-nat build-libchat 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 build-libchat nim_chat_poc.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 ##
|
||||
@ -127,7 +127,7 @@ LIBLOGOSCHAT := build/liblogoschat.$(LIBLOGOSCHAT_EXT)
|
||||
.PHONY: liblogoschat
|
||||
liblogoschat: | build-waku-librln build-waku-nat build-libchat nim_chat_poc.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)"
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Nim Chat POC
|
||||
# Logos Chat
|
||||
|
||||
This is the technical proof of a modular e2ee chat protocol using Waku. You can find discussion and details [here](https://github.com/waku-org/specs/pull/73)
|
||||
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
## liblogoschat - C bindings for the Chat SDK
|
||||
## liblogoschat - C bindings for Logos-Chat
|
||||
## Main entry point for the shared library
|
||||
##
|
||||
## This library exposes the Chat SDK functionality through a C-compatible FFI interface.
|
||||
## This library exposes the chat functionality through a C-compatible FFI interface.
|
||||
## It uses nim-ffi for thread-safe async request handling.
|
||||
|
||||
import std/[json, options]
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
# Package
|
||||
|
||||
version = "0.1.0"
|
||||
author = "jazzz"
|
||||
description = "An example of the chat sdk in Nim"
|
||||
author = "Logos.co"
|
||||
description = "LogosChat is a decentralized permissionless messaging protocol."
|
||||
license = "MIT"
|
||||
srcDir = "src"
|
||||
bin = @["nim_chat_poc"]
|
||||
bin = @["logos_chat"]
|
||||
|
||||
# Dependencies
|
||||
|
||||
@ -76,8 +76,8 @@ 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/",
|
||||
task liblogoschat, "Build the Logos-Chat shared library (C bindings)":
|
||||
buildLibrary "logoschat", "library/",
|
||||
"-d:chronicles_log_level='INFO' -d:chronicles_enabled=on --path:src --path:vendor/nim-ffi"
|
||||
Loading…
x
Reference in New Issue
Block a user