waku-org
/
nwaku
mirror of https://github.com/waku-org/nwaku.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Simplify Node API (#77) 

* Waku v2 Node API: Split into implemented and NYI

- Init is now separated into Create and Start node

* Simplify Node API

* Node API: proc->method and add WakuNode as first argument

* Fix indent to make compile

* Stub out all API methods
This commit is contained in:
Oskar Thorén 2020-07-27 17:01:06 +08:00 committed by GitHub
parent bede5a9358
commit 3c11734bbf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 144 additions and 83 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

141
docs/api/v2/node.md
View File

@ -2,101 +2,76 @@
## Nim API ## Nim API
### WakuSub API The Nim Waku API consist of five methods. Some of them have different arity
depending on what privacy/bandwidth trade-off the consumer wants to make. These
five method are:
This is an internal API to be used by the Waku API. It is practically a small 1. **Init** - create and start a node.
layer above GossipSub. And possibly a request/response libp2p protocol. 2. **Subscribe** - to a topic or a specific content filter.
3. **Unsubscribe** - to a topic or a specific content filter.
4. **Publish** - to a topic, or a topic and a specific content filter.
5. **Query** - for historical messages.
```Nim ```Nim
# TODO: Some init call to set things up? proc init*(conf: WakuNodeConf): Future[WakuNode]
method publish*(w: WakuSub, topic: string, data: seq[byte]) {.async.} ## Creates and starts a Waku node.
method subscribe*(w: WakuSub, topic: string, handler: TopicHandler) {.async.} ##
method unsubscribe*(w: WakuSub, topics: seq[TopicPair]) {.async.} ## Status: Partially implemented.
## TODO Take conf as a parameter and return a started WakuNode
# TODO: Calls for non GossipSub communication. method subscribe*(w: WakuNode, topic: Topic, handler: TopicHandler)
``` ## Subscribes to a PubSub topic. Triggers handler when receiving messages on
## this topic. TopicHandler is a method that takes a topic and a `Message`.
##
## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol`, and ensure Message is
## passed, not `data` field.
### Waku API method subscribe*(w: WakuNode, contentFilter: ContentFilter, handler: ContentFilterHandler)
## Subscribes to a ContentFilter. Triggers handler when receiving messages on
## this content filter. ContentFilter is a method that takes some content
## filter, specifically with `ContentTopic`, and a `Message`. The `Message`
## has to match the `ContentTopic`.
This API is very dependend on how the protocol should work for functionality ## Status: Not yet implemented.
such as light nodes (no relaying) and nodes that do not want to get messages ## TODO Implement as wrapper around `waku_protocol` and `subscribe` above, and
from all `WakuTopic`s. ## ensure Message is passed, not `data` field.
See also issue: method unsubscribe*(w: WakuNode, topic: Topic)
https://github.com/vacp2p/specs/issues/156 ## Unsubscribe from a topic.
##
## Status: Not yet implemented.
## TODO Implement.
For now it is assumed that we will require a seperate request-response protocol method unsubscribe*(w: WakuNode, contentFilter: ContentFilter)
for this, next to the GossipSub domain. ## Unsubscribe from a content filter.
##
## Status: Not yet implemented.
## TODO Implement.
```Nim method publish*(w: WakuNode, topic: Topic, message: Message)
type ## Publish a `Message` to a PubSub topic.
WakuOptions = object ##
# If there are more capabilities than just light node, we can create a ## Status: Not yet implemented.
# capabilities field. ## TODO Implement as wrapper around `waku_protocol`, and ensure Message is
lightNode: bool ## passed, not `data` field.
topics: seq[WakuTopic]
bloomfilter: Bloom # TODO: No longer needed with Gossip?
limits: Limits
proc init(w: WakuNode, conf: WakuConfig) method publish*(w: WakuNode, topic: Topic, contentFilter: ContentFilter, message: Message)
## Initialize the WakuNode. ## Publish a `Message` to a PubSub topic with a specific content filter.
## ## Currently this means a `contentTopic`.
## When not a light node, this will set up the node to be part of the gossipsub ##
## network with a subscription to the general Waku Topic. ## Status: Not yet implemented.
## When a light node, this will connect to full node peer(s) with provided ## TODO Implement as wrapper around `waku_protocol` and `publish`, and ensure
## `topics` or `bloomfilter` for the full node to filter messages on. ## Message is passed, not `data` field. Also ensure content filter is in
## Message.
proc publish(w: WakuNode, topic: WakuTopic, data: seq[byte]): bool method query*(w: WakuNode, query: HistoryQuery): HistoryResponse
## Publish a message with specified `WakuTopic`. ## Queries for historical messages.
## ##
## Both full node and light node can use the GossipSub network to publish. ## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol` and send `RPCMsg`.
proc subscribe(w: WakuNode, topics: seq[WakuTopic], handler: WakuHandler): Identifier
## Subscribe to the provided `topics`, handler will be called on receival of
## messages on those topics.
##
## In case of a full node, this will be through the GossipSub network (see,
## subscription in `init`)
## In case of the light node, this will likely be through a separate request
## response network where the full node filters out the messages.
proc unsubscribe(id: Identifier): bool
## Unsubscribe handler for topics.
# Can get rid of the identifiers in subscribe and unsubscribe and track topics +
# handler like in WakuSub, if that is more convenient.
proc setLightNode(isLightNode: bool)
## Change light node setting. This might trigger change in subscriptions from
## the gossip domain to the request response domain and vice versa.
proc setTopicInterest(topics: seq[string])
## Change the topic interests.
# TODO: Only valid if light node?
proc setBloomFilter(topics: seq[string])
## Change the topic interests.
# TODO: Still required if we have gossip?
``` ```
## JSON RPC ## JSON RPC
**TODO: Data should be RPC Messages / bytes** ### TODO To specify
**TODO: Enable topic handler**
Call signatures:
```Nim
proc waku_version(): string
proc waku_info(): WakuInfo
proc waku_publish(topic: string, message: string): bool
proc waku_subscribe(topics: seq[string]): Identifier
proc waku_unsubscribe(id: Identifier): bool
# TODO: Do we still want to be able to pull for data also?
# E.g. a getTopicsMessages(topics: seq[string])?
proc waku_setLightNode(isLightNode: bool)
proc waku_setTopicInterest(topics: seq[string])
proc waku_setBloomFilter(topics: seq[string])
```

86
waku/node/v2/wakunode2.nim
View File

@ -223,11 +223,97 @@ proc start*(node: WakuNode, conf: WakuNodeConf) {.async.} =
#proc run(conf: WakuNodeConf) {.async, gcsafe.} = #proc run(conf: WakuNodeConf) {.async, gcsafe.} =
## Public API
##
# TODO Take conf as a parameter and return a started WakuNode
proc init*() {.async.} = proc init*() {.async.} =
let conf = WakuNodeConf.load() let conf = WakuNodeConf.load()
let network = await createWakuNode(conf) let network = await createWakuNode(conf)
waitFor network.start(conf) waitFor network.start(conf)
runForever() runForever()
# TODO Replace init above
method init2*(conf: WakuNodeConf): Future[WakuNode] {.async.} =
## Creates and starts a Waku node.
##
## Status: Partially implemented.
## TODO Take conf as a parameter and return a started WakuNode
let node = await createWakuNode(conf)
await node.start(conf)
return node
type Topic* = string
type Message* = seq[byte]
type ContentFilter* = object
contentTopic*: string
type TopicHandler* = proc(topic: Topic, message: Message)
type ContentFilterHandler* = proc(contentFilter: ContentFilter, message: Message)
type HistoryQuery = object
xxx*: seq[byte]
type HistoryResponse = object
xxx*: seq[byte]
method subscribe*(w: WakuNode, topic: Topic, handler: TopicHandler) =
echo "NYI"
## Subscribes to a PubSub topic. Triggers handler when receiving messages on
## this topic. TopicHandler is a method that takes a topic and a `Message`.
##
## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol`, and ensure Message is
## passed, not `data` field.
method subscribe*(w: WakuNode, contentFilter: ContentFilter, handler: ContentFilterHandler) =
echo "NYI"
## Subscribes to a ContentFilter. Triggers handler when receiving messages on
## this content filter. ContentFilter is a method that takes some content
## filter, specifically with `ContentTopic`, and a `Message`. The `Message`
## has to match the `ContentTopic`.
## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol` and `subscribe` above, and
## ensure Message is passed, not `data` field.
method unsubscribe*(w: WakuNode, topic: Topic) =
echo "NYI"
## Unsubscribe from a topic.
##
## Status: Not yet implemented.
## TODO Implement.
method unsubscribe*(w: WakuNode, contentFilter: ContentFilter) =
echo "NYI"
## Unsubscribe from a content filter.
##
## Status: Not yet implemented.
## TODO Implement.
method publish*(w: WakuNode, topic: Topic, message: Message) =
echo "NYI"
## Publish a `Message` to a PubSub topic.
##
## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol`, and ensure Message is
## passed, not `data` field.
method publish*(w: WakuNode, topic: Topic, contentFilter: ContentFilter, message: Message) =
echo "NYI"
## Publish a `Message` to a PubSub topic with a specific content filter.
## Currently this means a `contentTopic`.
##
## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol` and `publish`, and ensure
## Message is passed, not `data` field. Also ensure content filter is in
## Message.
method query*(w: WakuNode, query: HistoryQuery): HistoryResponse =
echo "NYI"
## Queries for historical messages.
##
## Status: Not yet implemented.
## TODO Implement as wrapper around `waku_protocol` and send `RPCMsg`.
when isMainModule: when isMainModule:
discard init() discard init()