Add nim-ffi suggestion by Ivansete-status · Pull Request #325 · logos-messaging/pm

Ivansete-status · 2025-07-14T12:37:32Z

This PR adds a new deliverable: Create nim-ffi

The main purpose of this deliverable is to have a single source of truth for ffi-nim-based work and we aim to create a general-purpose repository that will help other Nim developers to expose their projects to other environments

gabrielmer

Looks good :)

NagyZoltanPeter

I have the feeling that Streamline FFI API... belongs to this new point nim-ffi.
WDYT?
Why No FURPS? Yet? Shall we add?

NagyZoltanPeter · 2025-07-15T22:02:17Z

draft-roadmap/nim_usage_improvements.md

+- [ ] Docs: links to README.md or docs.waku.org (TBD)
+
+
+### Create new nim-ffi repository that will allow exposing any Nim library in an easy way


Can't we merge the previous point ### Streamline FFI API Creation by using Protobuf types instead of JSON PoC with this nim-ffi?

I'll leave it to you. Wouldhte first version of nim-ffi be a copy paste of json usage? or do you want to go directly for protobuf?

btw, I have noticed that JSON generator is not used because we used default of WakuNodeConf. I intend to correct that,see logos-messaging/logos-delivery#3490

I think fine to keep it separate for now. even if both end up in same code base.

fryorcraken · 2025-07-16T05:15:17Z

Why No FURPS? Yet? Shall we add?

Yes FURPS please.

fryorcraken · 2025-07-16T05:39:06Z

draft-roadmap/nim_usage_improvements.md

+- [ ] Docs: links to README.md or docs.waku.org (TBD)
+
+
+### Create new nim-ffi repository that will allow exposing any Nim library in an easy way


I'll leave it to you. Wouldhte first version of nim-ffi be a copy paste of json usage? or do you want to go directly for protobuf?

fryorcraken · 2025-07-16T05:40:36Z

draft-roadmap/nim_usage_improvements.md

+- [ ] Docs: links to README.md or docs.waku.org (TBD)
+
+
+### Create new nim-ffi repository that will allow exposing any Nim library in an easy way


btw, I have noticed that JSON generator is not used because we used default of WakuNodeConf. I intend to correct that,see logos-messaging/logos-delivery#3490

fryorcraken · 2025-07-16T05:41:31Z

draft-roadmap/nim_usage_improvements.md

+- [Waku SDK](/FURPS/core/waku_sdk.md)
+- [RLN SDK](/FURPS/core/rln_sdk.md)
+- [Chat SDK](/FURPS/application/chat_sdk.md)
+- [SDS](/FURPS/application/sds.md)


You need to create a new feature here which would be Nim FFI and write FURPS for it.

In the + section of the FURPS, you can add that it is used by Chat, RLN, etc.

fryorcraken · 2025-07-16T05:41:39Z

draft-roadmap/nim_usage_improvements.md

+- [Chat SDK](/FURPS/application/chat_sdk.md)
+- [SDS](/FURPS/application/sds.md)
+
+**No FURPS**:


Ivansete-status · 2025-07-16T12:49:37Z

Answering this comment #325 (comment)
Yes, the initial idea is to extract the current libwaku strategy to a more generic repo and from there, in upcoming iterations we can add protobuf support

fryorcraken

@Ivansete-status I cleaned up the FURPS. looks good?

fryorcraken · 2025-07-22T05:28:50Z

draft-roadmap/nim_usage_improvements.md

+- [ ] Docs: links to README.md or docs.waku.org (TBD)
+
+
+### Create new nim-ffi repository that will allow exposing any Nim library in an easy way


I think fine to keep it separate for now. even if both end up in same code base.

fryorcraken · 2025-07-22T05:29:48Z

@Ivansete-status would that impact any of our other commitments?

Ivansete-status · 2025-07-24T20:41:18Z

@Ivansete-status would that impact any of our other commitments?

@fryorcraken - this deliverable represents a big effort but it will be very profitable in the future because all the ffi maintenance will happen in one single repository.

I'll double-check the furps tomorrow

Ivansete-status · 2025-07-25T09:07:35Z

@Ivansete-status I cleaned up the FURPS. looks good?

Thanks for it!
I just pushed some changes now

fryorcraken · 2025-07-29T07:10:51Z

FURPS/application/nim_ffi.md

+2. The exposed C library can be used in Golang.
+3. The exposed C library can be used in Rust.
+4. The exposed C library can be used in Python.


These are Supportability items

Thanks! Addressed in 3005c54

fryorcraken · 2025-07-29T07:11:22Z

FURPS/application/nim_ffi.md

+
+## Reliability
+
+1. The exposed C library does not leak memory.


Is this really under nim-ffi control of hte underneath nim library leaks memory?

Good question! The underneath library may eventually leak memory but we need to make sure the nim-ffi doesn't leak either because in there, we will handle memory manually, i.e., we cannot use GC'ed types when interfacing between two threads and due to that there's a risk of leaking memory in that process.

fryorcraken · 2025-07-29T07:12:07Z

FURPS/application/nim_ffi.md

+2. The interaction with the exposed C library is through JSON.
+3. The interaction with the exposed C library is through protobuf.


I think these are Usability, because it allows the dev to use Json or proto serializer libs

Thanks! Addressed in 3005c54

fryorcraken · 2025-07-29T07:12:33Z

FURPS/application/nim_ffi.md

+
+## Supportability
+
+1. Any Nim project can use it and can be installed using Nimble,


Here I would put th egolang/rust support.
The nimble support is more of a usability

Thanks! Addressed in 3005c54

fryorcraken · 2025-08-04T05:54:07Z

New deliverable, please create it cc @chair28980

Add nim-ffi suggestion

f0010c9

Ivansete-status requested review from NagyZoltanPeter, darshankabariya, fryorcraken and gabrielmer July 14, 2025 12:38

gabrielmer approved these changes Jul 14, 2025

View reviewed changes

NagyZoltanPeter reviewed Jul 15, 2025

View reviewed changes

fryorcraken reviewed Jul 16, 2025

View reviewed changes

clean furps

3a91c18

fryorcraken reviewed Jul 22, 2025

View reviewed changes

add some more FURPS to nim-ffi deliverable

ebdaa0d

fryorcraken reviewed Jul 29, 2025

View reviewed changes

Ivansete-status and others added 2 commits July 29, 2025 09:28

adjust as per Franck's comments

3005c54

tidy up

38637dc

fryorcraken merged commit 2fcbc2a into master Aug 4, 2025

emizzle mentioned this pull request Aug 27, 2025

Implement a Codex library so that clients can use Codex directly from their apps logos-storage/logos-storage-nim#1220

Closed

		- [ ] Docs: links to README.md or docs.waku.org (TBD)


		### Create new nim-ffi repository that will allow exposing any Nim library in an easy way


		## Reliability

		1. The exposed C library does not leak memory.

		2. The interaction with the exposed C library is through JSON.
		3. The interaction with the exposed C library is through protobuf.


		## Supportability

		1. Any Nim project can use it and can be installed using Nimble,

Conversation

Ivansete-status commented Jul 14, 2025

Uh oh!

gabrielmer left a comment

Choose a reason for hiding this comment

Uh oh!

NagyZoltanPeter left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fryorcraken commented Jul 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Ivansete-status commented Jul 16, 2025

Uh oh!

fryorcraken left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fryorcraken commented Jul 22, 2025

Uh oh!

Ivansete-status commented Jul 24, 2025

Uh oh!

Ivansete-status commented Jul 25, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fryorcraken commented Aug 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants