{.pragma: exported, exportc, cdecl, raises: [].} {.pragma: callback, cdecl, raises: [], gcsafe.} {.passc: "-fPIC".} when defined(linux): {.passl: "-Wl,-soname,libwaku.so".} import std/[json, atomics, strformat, options, atomics] import chronicles, chronos, chronos/threadsync import waku/common/base64, waku/waku_core/message/message, waku/node/waku_node, waku/waku_core/topics/pubsub_topic, waku/waku_core/subscription/push_handler, waku/waku_relay/protocol, ./events/json_message_event, ./waku_thread/waku_thread, ./waku_thread/inter_thread_communication/requests/node_lifecycle_request, ./waku_thread/inter_thread_communication/requests/peer_manager_request, ./waku_thread/inter_thread_communication/requests/protocols/relay_request, ./waku_thread/inter_thread_communication/requests/protocols/store_request, ./waku_thread/inter_thread_communication/requests/protocols/lightpush_request, ./waku_thread/inter_thread_communication/requests/protocols/filter_request, ./waku_thread/inter_thread_communication/requests/debug_node_request, ./waku_thread/inter_thread_communication/requests/discovery_request, ./waku_thread/inter_thread_communication/requests/ping_request, ./waku_thread/inter_thread_communication/waku_thread_request, ./alloc, ./ffi_types ################################################################################ ### Wrapper around the waku node ################################################################################ ################################################################################ ### Not-exported components template checkLibwakuParams*( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ) = ctx[].userData = userData if isNil(callback): return RET_MISSING_CALLBACK proc handleRequest( ctx: ptr WakuContext, requestType: RequestType, content: pointer, callback: WakuCallBack, userData: pointer, ): cint = waku_thread.sendRequestToWakuThread(ctx, requestType, content, callback, userData).isOkOr: let msg = "libwaku error: " & $error callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR return RET_OK proc onReceivedMessage(ctx: ptr WakuContext): WakuRelayHandler = return proc( pubsubTopic: PubsubTopic, msg: WakuMessage ): Future[system.void] {.async.} = # Callback that hadles the Waku Relay events. i.e. messages or errors. if isNil(ctx[].eventCallback): error "eventCallback is nil" return if isNil(ctx[].eventUserData): error "eventUserData is nil" return foreignThreadGc: try: let event = $JsonMessageEvent.new(pubsubTopic, msg) cast[WakuCallBack](ctx[].eventCallback)( RET_OK, unsafeAddr event[0], cast[csize_t](len(event)), ctx[].eventUserData ) except Exception, CatchableError: let msg = "Exception when calling 'eventCallBack': " & getCurrentExceptionMsg() cast[WakuCallBack](ctx[].eventCallback)( RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), ctx[].eventUserData ) ### End of not-exported components ################################################################################ ################################################################################ ### Library setup # Every Nim library must have this function called - the name is derived from # the `--nimMainPrefix` command line option proc NimMain() {.importc.} # To control when the library has been initialized var initialized: Atomic[bool] if defined(android): # Redirect chronicles to Android System logs when compiles(defaultChroniclesStream.outputs[0].writer): defaultChroniclesStream.outputs[0].writer = proc( logLevel: LogLevel, msg: LogOutputStr ) {.raises: [].} = echo logLevel, msg proc initializeLibrary() {.exported.} = if not initialized.exchange(true): NimMain() # Every Nim library needs to call `NimMain` once exactly when declared(setupForeignThreadGc): setupForeignThreadGc() when declared(nimGC_setStackBottom): var locals {.volatile, noinit.}: pointer locals = addr(locals) nimGC_setStackBottom(locals) ### End of library setup ################################################################################ ################################################################################ ### Exported procs proc waku_new( configJson: cstring, callback: WakuCallback, userData: pointer ): pointer {.dynlib, exportc, cdecl.} = initializeLibrary() ## Creates a new instance of the WakuNode. if isNil(callback): echo "error: missing callback in waku_new" return nil ## Create the Waku thread that will keep waiting for req from the main thread. var ctx = waku_thread.createWakuThread().valueOr: let msg = "Error in createWakuThread: " & $error callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return nil ctx.userData = userData let retCode = handleRequest( ctx, RequestType.LIFECYCLE, NodeLifecycleRequest.createShared(NodeLifecycleMsgType.CREATE_NODE, configJson), callback, userData, ) if retCode == RET_ERR: return nil return ctx proc waku_destroy( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) waku_thread.destroyWakuThread(ctx).isOkOr: let msg = "libwaku error: " & $error callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR return RET_OK proc waku_version( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) callback( RET_OK, cast[ptr cchar](WakuNodeVersionString), cast[csize_t](len(WakuNodeVersionString)), userData, ) return RET_OK proc waku_set_event_callback( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ) {.dynlib, exportc.} = initializeLibrary() ctx[].eventCallback = cast[pointer](callback) ctx[].eventUserData = userData proc waku_content_topic( ctx: ptr WakuContext, appName: cstring, appVersion: cuint, contentTopicName: cstring, encoding: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = # https://rfc.vac.dev/spec/36/#extern-char-waku_content_topicchar-applicationname-unsigned-int-applicationversion-char-contenttopicname-char-encoding initializeLibrary() checkLibwakuParams(ctx, callback, userData) let appStr = appName.alloc() let ctnStr = contentTopicName.alloc() let encodingStr = encoding.alloc() let contentTopic = fmt"/{$appStr}/{appVersion}/{$ctnStr}/{$encodingStr}" callback( RET_OK, unsafeAddr contentTopic[0], cast[csize_t](len(contentTopic)), userData ) deallocShared(appStr) deallocShared(ctnStr) deallocShared(encodingStr) return RET_OK proc waku_pubsub_topic( ctx: ptr WakuContext, topicName: cstring, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc, cdecl.} = # https://rfc.vac.dev/spec/36/#extern-char-waku_pubsub_topicchar-name-char-encoding initializeLibrary() checkLibwakuParams(ctx, callback, userData) let topicNameStr = topicName.alloc() let outPubsubTopic = fmt"/waku/2/{$topicNameStr}" callback( RET_OK, unsafeAddr outPubsubTopic[0], cast[csize_t](len(outPubsubTopic)), userData ) deallocShared(topicNameStr) return RET_OK proc waku_default_pubsub_topic( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = # https://rfc.vac.dev/spec/36/#extern-char-waku_default_pubsub_topic initializeLibrary() checkLibwakuParams(ctx, callback, userData) callback( RET_OK, cast[ptr cchar](DefaultPubsubTopic), cast[csize_t](len(DefaultPubsubTopic)), userData, ) return RET_OK proc waku_relay_publish( ctx: ptr WakuContext, pubSubTopic: cstring, jsonWakuMessage: cstring, timeoutMs: cuint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc, cdecl.} = # https://rfc.vac.dev/spec/36/#extern-char-waku_relay_publishchar-messagejson-char-pubsubtopic-int-timeoutms initializeLibrary() checkLibwakuParams(ctx, callback, userData) let jwm = jsonWakuMessage.alloc() var jsonMessage: JsonMessage try: let jsonContent = parseJson($jwm) jsonMessage = JsonMessage.fromJsonNode(jsonContent).valueOr: raise newException(JsonParsingError, $error) except JsonParsingError: deallocShared(jwm) let msg = fmt"Error parsing json message: {getCurrentExceptionMsg()}" callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR finally: deallocShared(jwm) let wakuMessage = jsonMessage.toWakuMessage().valueOr: let msg = "Problem building the WakuMessage: " & $error callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR let pst = pubSubTopic.alloc() defer: deallocShared(pst) let targetPubSubTopic = if len(pst) == 0: DefaultPubsubTopic else: $pst handleRequest( ctx, RequestType.RELAY, RelayRequest.createShared( RelayMsgType.PUBLISH, PubsubTopic($pst), WakuRelayHandler(onReceivedMessage(ctx)), wakuMessage, ), callback, userData, ) proc waku_start( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.LIFECYCLE, NodeLifecycleRequest.createShared(NodeLifecycleMsgType.START_NODE), callback, userData, ) proc waku_stop( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.LIFECYCLE, NodeLifecycleRequest.createShared(NodeLifecycleMsgType.STOP_NODE), callback, userData, ) proc waku_relay_subscribe( ctx: ptr WakuContext, pubSubTopic: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) let pst = pubSubTopic.alloc() defer: deallocShared(pst) var cb = onReceivedMessage(ctx) handleRequest( ctx, RequestType.RELAY, RelayRequest.createShared( RelayMsgType.SUBSCRIBE, PubsubTopic($pst), WakuRelayHandler(cb) ), callback, userData, ) proc waku_relay_unsubscribe( ctx: ptr WakuContext, pubSubTopic: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) let pst = pubSubTopic.alloc() defer: deallocShared(pst) handleRequest( ctx, RequestType.RELAY, RelayRequest.createShared( RelayMsgType.UNSUBSCRIBE, PubsubTopic($pst), WakuRelayHandler(onReceivedMessage(ctx)), ), callback, userData, ) proc waku_relay_get_num_connected_peers( ctx: ptr WakuContext, pubSubTopic: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) let pst = pubSubTopic.alloc() defer: deallocShared(pst) handleRequest( ctx, RequestType.RELAY, RelayRequest.createShared(RelayMsgType.LIST_CONNECTED_PEERS, PubsubTopic($pst)), callback, userData, ) proc waku_relay_get_num_peers_in_mesh( ctx: ptr WakuContext, pubSubTopic: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) let pst = pubSubTopic.alloc() defer: deallocShared(pst) handleRequest( ctx, RequestType.RELAY, RelayRequest.createShared(RelayMsgType.LIST_MESH_PEERS, PubsubTopic($pst)), callback, userData, ) proc waku_filter_subscribe( ctx: ptr WakuContext, pubSubTopic: cstring, contentTopics: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.FILTER, FilterRequest.createShared( FilterMsgType.SUBSCRIBE, pubSubTopic, contentTopics, FilterPushHandler(onReceivedMessage(ctx)), ), callback, userData, ) proc waku_filter_unsubscribe( ctx: ptr WakuContext, pubSubTopic: cstring, contentTopics: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.FILTER, FilterRequest.createShared(FilterMsgType.UNSUBSCRIBE, pubSubTopic, contentTopics), callback, userData, ) proc waku_filter_unsubscribe_all( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.FILTER, FilterRequest.createShared(FilterMsgType.UNSUBSCRIBE_ALL), callback, userData, ) proc waku_lightpush_publish( ctx: ptr WakuContext, pubSubTopic: cstring, jsonWakuMessage: cstring, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc, cdecl.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) let jwm = jsonWakuMessage.alloc() let pst = pubSubTopic.alloc() defer: deallocShared(jwm) deallocShared(pst) var jsonMessage: JsonMessage try: let jsonContent = parseJson($jwm) jsonMessage = JsonMessage.fromJsonNode(jsonContent).valueOr: raise newException(JsonParsingError, $error) except JsonParsingError: let msg = fmt"Error parsing json message: {getCurrentExceptionMsg()}" callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR let wakuMessage = jsonMessage.toWakuMessage().valueOr: let msg = "Problem building the WakuMessage: " & $error callback(RET_ERR, unsafeAddr msg[0], cast[csize_t](len(msg)), userData) return RET_ERR let targetPubSubTopic = if len(pst) == 0: DefaultPubsubTopic else: $pst handleRequest( ctx, RequestType.LIGHTPUSH, LightpushRequest.createShared( LightpushMsgType.PUBLISH, PubsubTopic($pst), wakuMessage ), callback, userData, ) proc waku_connect( ctx: ptr WakuContext, peerMultiAddr: cstring, timeoutMs: cuint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared( PeerManagementMsgType.CONNECT_TO, $peerMultiAddr, chronos.milliseconds(timeoutMs) ), callback, userData, ) proc waku_disconnect_peer_by_id( ctx: ptr WakuContext, peerId: cstring, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared( op = PeerManagementMsgType.DISCONNECT_PEER_BY_ID, peerId = $peerId ), callback, userData, ) proc waku_dial_peer( ctx: ptr WakuContext, peerMultiAddr: cstring, protocol: cstring, timeoutMs: cuint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared( op = PeerManagementMsgType.DIAL_PEER, peerMultiAddr = $peerMultiAddr, protocol = $protocol, ), callback, userData, ) proc waku_dial_peer_by_id( ctx: ptr WakuContext, peerId: cstring, protocol: cstring, timeoutMs: cuint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared( op = PeerManagementMsgType.DIAL_PEER_BY_ID, peerId = $peerId, protocol = $protocol ), callback, userData, ) proc waku_get_peerids_from_peerstore( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared(PeerManagementMsgType.GET_ALL_PEER_IDS), callback, userData, ) proc waku_get_connected_peers( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared(PeerManagementMsgType.GET_CONNECTED_PEERS), callback, userData, ) proc waku_get_peerids_by_protocol( ctx: ptr WakuContext, protocol: cstring, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PEER_MANAGER, PeerManagementRequest.createShared( op = PeerManagementMsgType.GET_PEER_IDS_BY_PROTOCOL, protocol = $protocol ), callback, userData, ) proc waku_store_query( ctx: ptr WakuContext, jsonQuery: cstring, peerAddr: cstring, timeoutMs: cint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.STORE, JsonStoreQueryRequest.createShared(jsonQuery, peerAddr, timeoutMs), callback, userData, ) proc waku_listen_addresses( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DEBUG, DebugNodeRequest.createShared(DebugNodeMsgType.RETRIEVE_LISTENING_ADDRESSES), callback, userData, ) proc waku_dns_discovery( ctx: ptr WakuContext, entTreeUrl: cstring, nameDnsServer: cstring, timeoutMs: cint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DISCOVERY, DiscoveryRequest.createRetrieveBootstrapNodesRequest( DiscoveryMsgType.GET_BOOTSTRAP_NODES, entTreeUrl, nameDnsServer, timeoutMs ), callback, userData, ) proc waku_discv5_update_bootnodes( ctx: ptr WakuContext, bootnodes: cstring, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = ## Updates the bootnode list used for discovering new peers via DiscoveryV5 ## bootnodes - JSON array containing the bootnode ENRs i.e. `["enr:...", "enr:..."]` initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DISCOVERY, DiscoveryRequest.createUpdateBootstrapNodesRequest( DiscoveryMsgType.UPDATE_DISCV5_BOOTSTRAP_NODES, bootnodes ), callback, userData, ) proc waku_get_my_enr( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DEBUG, DebugNodeRequest.createShared(DebugNodeMsgType.RETRIEVE_MY_ENR), callback, userData, ) proc waku_get_my_peerid( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DEBUG, DebugNodeRequest.createShared(DebugNodeMsgType.RETRIEVE_MY_PEER_ID), callback, userData, ) proc waku_start_discv5( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DISCOVERY, DiscoveryRequest.createDiscV5StartRequest(), callback, userData, ) proc waku_stop_discv5( ctx: ptr WakuContext, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DISCOVERY, DiscoveryRequest.createDiscV5StopRequest(), callback, userData, ) proc waku_peer_exchange_request( ctx: ptr WakuContext, numPeers: uint64, callback: WakuCallBack, userData: pointer ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.DISCOVERY, DiscoveryRequest.createPeerExchangeRequest(numPeers), callback, userData, ) proc waku_ping_peer( ctx: ptr WakuContext, peerAddr: cstring, timeoutMs: cuint, callback: WakuCallBack, userData: pointer, ): cint {.dynlib, exportc.} = initializeLibrary() checkLibwakuParams(ctx, callback, userData) handleRequest( ctx, RequestType.PING, PingRequest.createShared(peerAddr, chronos.milliseconds(timeoutMs)), callback, userData, ) ### End of exported procs ################################################################################