chore(cbindings): Adding cpp example that integrates the 'libwaku' #2079

Ivansete-status · 2023-09-26T12:51:17Z

Description

In this example, we can see how to integrate a nwaku node from within a cpp code. The code is very similar to the C version. The interesting point is the usage of cpp-lambdas and how they can seamlessly integrate with the execution context.

e.g.

    std::string defautPubsubTopic;
    WAKU_CALL(waku_default_pubsub_topic(cify([&](const char* msg, size_t len) {
        defautPubsubTopic = msg;
    })));

Changes

Adding cpp-nwaku example.

github-actions · 2023-09-26T12:58:35Z

You can find the image built from this PR at

quay.io/wakuorg/nwaku-pr:2079

Built from a11a0ba

SionoiS

I think I understand what's happening (unfamiliar with C++). Having another example is great.

Thank you!

NagyZoltanPeter · 2023-09-26T19:33:13Z

Before leaving review comments, I would have some questions or maybe open a little discussion on it due I'm embarrassed a bit about it.

What is the exact aim of such example over the current ansi C example?
What is the minimum C++ standard we targeting (of coz its ok to still use C++98, though a bit uncommon)?

Lets put in other way around. If I would like to show some c++ example, maybe I would like to provide a c++ wrapper on the c-bindings first. Also maybe include base64 encode/decode into the library (just to be confirm fully our requirements).

You know I'm quite ok with such usage, but I would like to give a mean or value over the C version.
I hope you, @Ivansete-status will get the point, I would not like to be destructive on it surely and I know it's just a helper for the crowd, whom may use it differently as their taste.

gabrielmer · 2023-09-27T08:46:32Z

Really like the use of lambdas for the callbacks!

To use them we need at least C++11. Even though they are not strictly necessary I think C++11 is a good minimum standard to target - even if we didn't use lambdas, it's one of the most widely used standards, and the ones before it are now pretty rarely used.

I do agree that we should either add the base64 encode/decode functions to the library or at least import those functions in the example from some existing external library.

I think that implementing the functions in the example may add noise and take attention from more important parts, and I don't know if we should encourage users to implement their own encoding/decoding functions instead of taking one from a library

Ivansete-status · 2023-09-27T09:23:52Z

Thanks for the comments @NagyZoltanPeter @gabrielmer 🔥 !
This is a simple example of how to use nwaku from cpp. Of course, it can be optimized. Nevertheless, cpp is not our priority right now and this is just a simple example.

Re the base64 stuff, I think we have it separated in the C example.
Re the C++ I think C++11 is good as a minimum.

I wouldn't worry very much about this cpp example for now.

This is the roadmap I'd like to follow:

Make the libwaku implementation more solid and work properly in Rust, NodeJs, Python. For that, a simple relay example is enough.
Once we have libwaku super solid and thread-safe, create separate waku repos for each language, and from there, make each of them use the nwaku as a submodule and therefore compile and link the libwaku library. In those repos we will be able to invest our efforts to have better performance, test, etc.

Thanks again for the comments :)

gabrielmer

Sounds great! Thanks so much!

NagyZoltanPeter

Found some tiny stuff but all OK, main target is already discussed!
Thanks for this nice work!

NagyZoltanPeter · 2023-09-27T10:13:49Z

examples/cpp/waku.cpp

+
+#include "../../library/libwaku.h"
+
+#define WAKU_CALL(call)                                                        \


If it can be done to outcast the return value to the caller would be nice.
I'm thinking of a templatized function wrapper, but definitely that is more complicated.

NagyZoltanPeter · 2023-09-27T10:15:01Z

examples/cpp/waku.cpp

+
+const char b64chars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+
+void b64_encode(char* in, size_t len, std::vector<char>& out)


If C++11 we should simple return with std::vector. Move semantics and RVO will solve it for free.

NagyZoltanPeter · 2023-09-27T10:16:30Z

examples/cpp/waku.cpp

+        std::vector<char> msgPayload;
+        b64_encode(msg, strlen(msg), msgPayload);
+
+        // waku_content_topic("appName",


Is it something intentionally left commented our not working?

Good catch! I leave those comments to indicate which libwaku should be invoked. If we uncomment they might not work because the signatures are changing due to making the libwaku thread-safe. We should revisit that once we have time to tackle it.

NagyZoltanPeter · 2023-09-27T10:17:29Z

examples/cpp/waku.cpp

+}
+
+template <class F>
+auto cify(F&& f) {


I'm not pretty sure that wrapping around lambdas is necessary. Maybe enough to simple give lamba in place to the call of C function.

Good point! Afaik, this is needed. We'll revisit that point in the future.

examples/cpp/waku.cpp

jm-clius

Great to have this too!

Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

Ivansete-status · 2023-09-28T09:09:56Z

Thanks for the comments!
I'll merge it now and leave it for the future to apply all the recommendations needed to have a proper cpp example.

…2079) * Adding cpp example that integrates the `libwaku` --------- Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

* chore: add retention policy with GB or MB limitation #1885 * chore: add retention policy with GB or MB limitation * chore: updated code post review- retention policy * ci: extract discordNotify to separate file Signed-off-by: Jakub Sokołowski <jakub@status.im> * ci: push images to new wakuorg/nwaku repo Signed-off-by: Jakub Sokołowski <jakub@status.im> * ci: enforce default Docker image tags strictly Signed-off-by: Jakub Sokołowski <jakub@status.im> * ci: push GIT_REF if it looks like a version Signed-off-by: Jakub Sokołowski <jakub@status.im> * fix: update wakuv2 fleet DNS discovery enrtree https://github.com/status-im/infra-misc/issues/171 * chore: resolving DNS IP and publishing it when no extIp is provided (#2030) * feat(coverage): Add simple coverage (#2067) * Add test aggregator to all directories. * Implement coverage script. * fix(ci): fix name of discord notify method Also use absolute path to load Groovy script. Signed-off-by: Jakub Sokołowski <jakub@status.im> * chore(networkmonitor): refactor setConnectedPeersMetrics, make it partially concurrent, add version (#2080) * chore(networkmonitor): refactor setConnectedPeersMetrics, make it partially concurrent, add version * add more metrics, refactor how most metrics are calculated * rework metrics table fillup * reset connErr to make sure we honour successful reconnection * chore(cbindings): Adding cpp example that integrates the 'libwaku' (#2079) * Adding cpp example that integrates the `libwaku` --------- Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com> * fix(ci): update the dependency list in pre-release WF (#2088) * chore: adding NetConfig test suite (#2091) --------- Signed-off-by: Jakub Sokołowski <jakub@status.im> Co-authored-by: Jakub Sokołowski <jakub@status.im> Co-authored-by: Anton Iakimov <yakimant@gmail.com> Co-authored-by: gabrielmer <101006718+gabrielmer@users.noreply.github.com> Co-authored-by: Álex Cabeza Romero <alex93cabeza@gmail.com> Co-authored-by: Vaclav Pavlin <vaclav@status.im> Co-authored-by: Ivan Folgueira Bande <128452529+Ivansete-status@users.noreply.github.com> Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

Ivansete-status changed the title ~~chore(cbindings): Adding cpp example that integrates the libwaku~~ chore(cbindings): Adding cpp example that integrates the 'libwaku' Sep 26, 2023

Adding cpp example that integrates the libwaku

01c3ac8

Ivansete-status force-pushed the cbindings-cpp-ok branch from aff0dc7 to 01c3ac8 Compare September 26, 2023 16:19

Ivansete-status marked this pull request as ready for review September 26, 2023 16:50

Ivansete-status requested review from jm-clius, NagyZoltanPeter, gabrielmer and SionoiS September 26, 2023 16:50

SionoiS approved these changes Sep 26, 2023

View reviewed changes

Ivansete-status self-assigned this Sep 27, 2023

gabrielmer approved these changes Sep 27, 2023

View reviewed changes

NagyZoltanPeter approved these changes Sep 27, 2023

View reviewed changes

jm-clius approved these changes Sep 27, 2023

View reviewed changes

Ivansete-status and others added 6 commits September 28, 2023 11:02

capture only the data needed in lambda

abbb35a

Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

typo

7e5e5d7

Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

typo

bb5f263

Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

typo

3eb602d

Co-authored-by: NagyZoltanPeter <113987313+NagyZoltanPeter@users.noreply.github.com>

libwaku-cpp-example: move base64 funcs to a separate file

0dd4b82

waku.cpp: removing unneeded functions and fix typo

8295a6d

Ivansete-status merged commit 8455b8d into master Sep 28, 2023
8 checks passed

Ivansete-status deleted the cbindings-cpp-ok branch September 28, 2023 09:10

Ivansete-status mentioned this pull request Sep 29, 2023

nwaku c-bindings (NodeJS + Python) #1332

Closed

9 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore(cbindings): Adding cpp example that integrates the 'libwaku' #2079

chore(cbindings): Adding cpp example that integrates the 'libwaku' #2079

Ivansete-status commented Sep 26, 2023

github-actions bot commented Sep 26, 2023 •

edited

SionoiS left a comment •

edited

NagyZoltanPeter commented Sep 26, 2023

gabrielmer commented Sep 27, 2023

Ivansete-status commented Sep 27, 2023

gabrielmer left a comment

NagyZoltanPeter left a comment

NagyZoltanPeter Sep 27, 2023

NagyZoltanPeter Sep 27, 2023 •

edited

NagyZoltanPeter Sep 27, 2023

Ivansete-status Sep 28, 2023

NagyZoltanPeter Sep 27, 2023

Ivansete-status Sep 28, 2023

jm-clius left a comment

Ivansete-status commented Sep 28, 2023


		const char b64chars[] = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

		void b64_encode(char* in, size_t len, std::vector<char>& out)


		#include "../../library/libwaku.h"

		#define WAKU_CALL(call) \

chore(cbindings): Adding cpp example that integrates the 'libwaku' #2079

chore(cbindings): Adding cpp example that integrates the 'libwaku' #2079

Conversation

Ivansete-status commented Sep 26, 2023

Description

Changes

github-actions bot commented Sep 26, 2023 • edited

SionoiS left a comment • edited

Choose a reason for hiding this comment

NagyZoltanPeter commented Sep 26, 2023

gabrielmer commented Sep 27, 2023

Ivansete-status commented Sep 27, 2023

gabrielmer left a comment

Choose a reason for hiding this comment

NagyZoltanPeter left a comment

Choose a reason for hiding this comment

NagyZoltanPeter Sep 27, 2023

Choose a reason for hiding this comment

NagyZoltanPeter Sep 27, 2023 • edited

Choose a reason for hiding this comment

NagyZoltanPeter Sep 27, 2023

Choose a reason for hiding this comment

Ivansete-status Sep 28, 2023

Choose a reason for hiding this comment

NagyZoltanPeter Sep 27, 2023

Choose a reason for hiding this comment

Ivansete-status Sep 28, 2023

Choose a reason for hiding this comment

jm-clius left a comment

Choose a reason for hiding this comment

Ivansete-status commented Sep 28, 2023

github-actions bot commented Sep 26, 2023 •

edited

SionoiS left a comment •

edited

NagyZoltanPeter Sep 27, 2023 •

edited