Franck Royer 5124a232e6
Fix syntax and propose terminology change (#371)
* Add proto version and fix syntax

* Add GH action to automatically add issues to the project board
2021-05-19 09:56:26 +08:00
..

slug title name status editor contributors
19 19/WAKU2-LIGHTPUSH Waku v2 Light Push raw Oskar Thorén <oskar@status.im>

Protocol identifier: /vac/waku/lightpush/2.0.0-alpha1

Motivation and goals

Light nodes with short connection windows and limited bandwidth wish to publish messages into the Waku network. Additionally, there sometimes is a need for confirmation that a message has been received "by the network".

19/LIGHTPUSH is a request/reply protocol for this.

Payloads

syntax = "proto3";

message PushRequest {
    string pubsub_topic = 1;
    WakuMessage message = 2;
}

message PushResponse {
    bool is_success = 1;
    // Error messages, etc
    string info = 2;
}

message PushRPC {
    string request_id = 1;
    PushRequest request = 2;
    PushResponse response = 3;
}

Message relaying

Nodes that respond to PushRequests MUST relay this via RELAY protocol on the specified pubsub_topic. If they are unable to do so for some reason, they SHOULD return an error code in PushResponse.

Notes

Copyright

Copyright and related rights waived via CC0.