From f2bbea4449044c56b2359bc8f597410b9cf71a27 Mon Sep 17 00:00:00 2001 From: Ivan FB Date: Mon, 29 Jun 2026 10:51:34 +0200 Subject: [PATCH] use explicit name params in concepts --- logos_delivery/api/kernel_api.nim | 61 +++++++++++-------- logos_delivery/api/messaging_client_api.nim | 6 +- .../api/reliable_channel_manager_api.nim | 10 +-- 3 files changed, 46 insertions(+), 31 deletions(-) diff --git a/logos_delivery/api/kernel_api.nim b/logos_delivery/api/kernel_api.nim index 75d73144d..f1842d50a 100644 --- a/logos_delivery/api/kernel_api.nim +++ b/logos_delivery/api/kernel_api.nim @@ -20,51 +20,64 @@ EventBroker: # (ops in `waku/api/*`). type KernelApi* = concept w # --- topic construction --- - buildContentTopic(w, string, uint32, string, string) is - Future[Result[ContentTopic, string]] - buildPubsubTopic(w, string) is Future[Result[PubsubTopic, string]] + buildContentTopic( + w, appName = string, appVersion = uint32, name = string, encoding = string + ) is Future[Result[ContentTopic, string]] + buildPubsubTopic(w, topicName = string) is Future[Result[PubsubTopic, string]] defaultPubsubTopic(w) is Future[Result[PubsubTopic, string]] # --- relay --- - relayPublish(w, PubsubTopic, WakuMessage, uint32) is Future[Result[string, string]] - relaySubscribe(w, PubsubTopic) is Future[Result[bool, string]] - relayUnsubscribe(w, PubsubTopic) is Future[Result[bool, string]] - relayAddProtectedShard(w, uint16, uint16, string) is Future[Result[bool, string]] - relayConnectedPeers(w, PubsubTopic) is Future[Result[seq[string], string]] - relayPeersInMesh(w, PubsubTopic) is Future[Result[seq[string], string]] - relayNumPeersInMesh(w, PubsubTopic) is Future[Result[int, string]] - relayNumConnectedPeers(w, PubsubTopic) is Future[Result[int, string]] + relayPublish(w, pubsubTopic = PubsubTopic, message = WakuMessage, timeoutMs = uint32) is + Future[Result[string, string]] + relaySubscribe(w, pubsubTopic = PubsubTopic) is Future[Result[bool, string]] + relayUnsubscribe(w, pubsubTopic = PubsubTopic) is Future[Result[bool, string]] + relayAddProtectedShard(w, clusterId = uint16, shardId = uint16, publicKey = string) is + Future[Result[bool, string]] + relayConnectedPeers(w, pubsubTopic = PubsubTopic) is + Future[Result[seq[string], string]] + relayPeersInMesh(w, pubsubTopic = PubsubTopic) is Future[Result[seq[string], string]] + relayNumPeersInMesh(w, pubsubTopic = PubsubTopic) is Future[Result[int, string]] + relayNumConnectedPeers(w, pubsubTopic = PubsubTopic) is Future[Result[int, string]] # --- filter --- - filterSubscribe(w, PubsubTopic, seq[ContentTopic], FilterPushHandler) is + filterSubscribe( + w, + pubsubTopic = PubsubTopic, + contentTopics = seq[ContentTopic], + pushHandler = FilterPushHandler, + ) is Future[Result[bool, string]] + filterUnsubscribe(w, pubsubTopic = PubsubTopic, contentTopics = seq[ContentTopic]) is Future[Result[bool, string]] - filterUnsubscribe(w, PubsubTopic, seq[ContentTopic]) is Future[Result[bool, string]] filterUnsubscribeAll(w) is Future[Result[bool, string]] # --- lightpush --- - lightpushPublish(w, PubsubTopic, WakuMessage) is Future[Result[string, string]] + lightpushPublish(w, pubsubTopic = PubsubTopic, message = WakuMessage) is + Future[Result[string, string]] # --- store --- - storeQuery(w, StoreQueryRequest, string, int) is + storeQuery(w, request = StoreQueryRequest, peer = string, timeoutMs = int) is Future[Result[StoreQueryResponse, string]] # --- peer management --- - connect(w, seq[string], uint32) is Future[Result[bool, string]] - disconnectPeerById(w, string) is Future[Result[bool, string]] + connect(w, peers = seq[string], timeoutMs = uint32) is Future[Result[bool, string]] + disconnectPeerById(w, peerId = string) is Future[Result[bool, string]] disconnectAllPeers(w) is Future[Result[bool, string]] - dialPeer(w, string, string, int) is Future[Result[bool, string]] - dialPeerById(w, string, string, int) is Future[Result[bool, string]] + dialPeer(w, peerAddr = string, protocol = string, timeoutMs = int) is + Future[Result[bool, string]] + dialPeerById(w, peerId = string, protocol = string, timeoutMs = int) is + Future[Result[bool, string]] peerIdsFromPeerstore(w) is Future[Result[seq[string], string]] connectedPeersInfo(w) is Future[Result[seq[PeerConnInfo], string]] connectedPeers(w) is Future[Result[seq[string], string]] - peerIdsByProtocol(w, string) is Future[Result[seq[string], string]] + peerIdsByProtocol(w, protocol = string) is Future[Result[seq[string], string]] # --- discovery --- - dnsDiscovery(w, string, string, int) is Future[Result[seq[string], string]] - discv5UpdateBootnodes(w, string) is Future[Result[bool, string]] + dnsDiscovery(w, enrTreeUrl = string, nameServer = string, timeoutMs = int) is + Future[Result[seq[string], string]] + discv5UpdateBootnodes(w, bootnodes = string) is Future[Result[bool, string]] startDiscv5(w) is Future[Result[bool, string]] stopDiscv5(w) is Future[Result[bool, string]] - peerExchangeRequest(w, uint64) is Future[Result[int, string]] + peerExchangeRequest(w, numPeers = uint64) is Future[Result[int, string]] # --- debug / info --- version(w) is Future[Result[string, string]] @@ -73,4 +86,4 @@ type KernelApi* = concept w myPeerId(w) is Future[Result[string, string]] metrics(w) is Future[Result[string, string]] isOnline(w) is Future[Result[bool, string]] - pingPeer(w, string, int) is Future[Result[int64, string]] + pingPeer(w, peerAddr = string, timeoutMs = int) is Future[Result[int64, string]] diff --git a/logos_delivery/api/messaging_client_api.nim b/logos_delivery/api/messaging_client_api.nim index 4e71a9e98..f7aca1163 100644 --- a/logos_delivery/api/messaging_client_api.nim +++ b/logos_delivery/api/messaging_client_api.nim @@ -33,6 +33,6 @@ EventBroker: # Structural API contract for a messaging client (ops in `messaging/api/*`). type MessagingApi* = concept c - subscribe(c, ContentTopic) is Future[Result[void, string]] - unsubscribe(c, ContentTopic) is Result[void, string] - send(c, MessageEnvelope) is Future[Result[RequestId, string]] + subscribe(c, contentTopic = ContentTopic) is Future[Result[void, string]] + unsubscribe(c, contentTopic = ContentTopic) is Result[void, string] + send(c, envelope = MessageEnvelope) is Future[Result[RequestId, string]] diff --git a/logos_delivery/api/reliable_channel_manager_api.nim b/logos_delivery/api/reliable_channel_manager_api.nim index 8595f2f86..d4b06c470 100644 --- a/logos_delivery/api/reliable_channel_manager_api.nim +++ b/logos_delivery/api/reliable_channel_manager_api.nim @@ -46,7 +46,9 @@ EventBroker: # Structural API contract for the reliable-channel surface (ops in `channels/api/*`). type ReliableChannelApi* = concept c - createReliableChannel(c, ChannelId, ContentTopic, SdsParticipantID) is - Result[ChannelId, string] - closeChannel(c, ChannelId) is Future[Result[void, string]] - send(c, ChannelId, seq[byte]) is Future[Result[RequestId, string]] + createReliableChannel( + c, channelId = ChannelId, contentTopic = ContentTopic, senderId = SdsParticipantID + ) is Result[ChannelId, string] + closeChannel(c, channelId = ChannelId) is Future[Result[void, string]] + send(c, channelId = ChannelId, appPayload = seq[byte]) is + Future[Result[RequestId, string]]