2022-12-01 07:58:41 +00:00
<!DOCTYPE html>
< html lang = "en" dir = "ltr" >
< head >
2022-12-01 08:37:15 +00:00
< meta name = "generator" content = "Hugo 0.106.0" >
2022-12-01 07:58:41 +00:00
< meta charset = "UTF-8" >
< meta name = "viewport" content = "width=device-width, initial-scale=1.0" >
< meta name = "description" content = "Protocol identifier: / vac / waku / lightpush / 2 . 0 . 0-beta1
2023-01-12 10:30:30 +00:00
Motivation and Goals # Light nodes with short connection windows and limited bandwidth wish to publish messages into the Waku network. Additionally, there is sometimes a need for confirmation that a message has been received “ by the network” (here, at least one node).
2022-12-01 07:58:41 +00:00
19/WAKU2-LIGHTPUSH is a request/response protocol for this.
2023-01-12 10:30:30 +00:00
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 either relay the encapsulated message via 11/WAKU2-RELAY protocol on the specified pubsub_topic, or forward the PushRequest via 19/LIGHTPUSH on a 44/WAKU2-DANDELION stem.">
2022-12-01 07:58:41 +00:00
< meta name = "theme-color" content = "#FFFFFF" > < meta property = "og:title" content = "19/WAKU2-LIGHTPUSH" / >
< meta property = "og:description" content = "Protocol identifier: / vac / waku / lightpush / 2 . 0 . 0-beta1
2023-01-12 10:30:30 +00:00
Motivation and Goals # Light nodes with short connection windows and limited bandwidth wish to publish messages into the Waku network. Additionally, there is sometimes a need for confirmation that a message has been received “ by the network” (here, at least one node).
2022-12-01 07:58:41 +00:00
19/WAKU2-LIGHTPUSH is a request/response protocol for this.
2023-01-12 10:30:30 +00:00
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 either relay the encapsulated message via 11/WAKU2-RELAY protocol on the specified pubsub_topic, or forward the PushRequest via 19/LIGHTPUSH on a 44/WAKU2-DANDELION stem." />
2022-12-01 07:58:41 +00:00
< meta property = "og:type" content = "article" / >
< meta property = "og:url" content = "https://rfc.vac.dev/spec/19/" / > < meta property = "article:section" content = "docs" / >
< title > 19/WAKU2-LIGHTPUSH | Vac RFC< / title >
< link rel = "manifest" href = "/manifest.json" >
< link rel = "icon" href = "/favicon.png" type = "image/x-icon" >
< link rel = "stylesheet" href = "/book.min.e935e20bd0d469378cb482f0958edf258c731a4f895dccd55799c6fbc8043f23.css" integrity = "sha256-6TXiC9DUaTeMtILwlY7fJYxzGk+JXczVV5nG+8gEPyM=" >
2023-03-17 08:04:39 +00:00
< script defer src = "/en.search.min.569030df97a7a363e516338e1e5dd6d506564a23c5dfc6dc2d8153374fccde46.js" integrity = "sha256-VpAw35eno2PlFjOOHl3W1QZWSiPF38bcLYFTN0/M3kY=" > < / script >
2022-12-01 07:58:41 +00:00
<!--
Made with Book Theme
https://github.com/alex-shpak/hugo-book
-->
< / head >
< body dir = "ltr" >
< input type = "checkbox" class = "hidden toggle" id = "menu-control" / >
< input type = "checkbox" class = "hidden toggle" id = "toc-control" / >
< main class = "container flex" >
< aside class = "book-menu" >
< div class = "book-menu-content" >
< nav >
< h2 class = "book-brand" >
< a href = "/" > < span > Vac RFC< / span >
< / a >
< / h2 >
< div class = "book-search" >
< input type = "text" id = "book-search-input" placeholder = "Search" aria-label = "Search" maxlength = "64" data-hotkeys = "s/" / >
< div class = "book-search-spinner hidden" > < / div >
< ul id = "book-search-results" > < / ul >
< / div >
< ul >
< li > Raw
< ul >
< li > < a href = "/spec/20/" > 20/TOY-ETH-PM< / a > < / li >
< li > < a href = "/spec/24/" > 24/STATUS-CURATION< / a > < / li >
< li > < a href = "/spec/28/" > 28/STATUS-FEATURING< / a > < / li >
< li > < a href = "/spec/31/" > 31/WAKU2-ENR< / a > < / li >
< li > < a href = "/spec/32/" > 32/RLN-SPEC< / a > < / li >
< li > < a href = "/spec/34/" > 34/WAKU2-PEER-EXCHANGE< / a > < / li >
< li > < a href = "/spec/35/" > 35/WAKU2-NOISE< / a > < / li >
< li > < a href = "/spec/37/" > 37/WAKU2-NOISE-SESSIONS< / a > < / li >
2022-12-06 09:59:38 +00:00
< li > < a href = "/spec/38/" > 38/CONSENSUS-CLARO< / a > < / li >
2022-12-01 07:58:41 +00:00
< li > < a href = "/spec/43/" > 43/WAKU2-NOISE-PAIRING< / a > < / li >
< li > < a href = "/spec/44/" > 44/WAKU2-DANDELION< / a > < / li >
< li > < a href = "/spec/45/" > 45/WAKU2-ADVERSARIAL-MODELS< / a > < / li >
2022-12-02 14:32:42 +00:00
< li > < a href = "/spec/46/" > 46/GOSSIPSUB-TOR-PUSH< / a > < / li >
< li > < a href = "/spec/47/" > 47/WAKU2-TOR-PUSH< / a > < / li >
2023-01-12 10:30:30 +00:00
< li > < a href = "/spec/48/" > 48/RLN-INTEREP-SPEC< / a > < / li >
2023-01-30 13:47:41 +00:00
< li > < a href = "/spec/51/" > 51/WAKU2-RELAY-SHARDING< / a > < / li >
< li > < a href = "/spec/52/" > 52/WAKU2-RELAY-STATIC-SHARD-ALLOC< / a > < / li >
2023-03-17 08:04:39 +00:00
< li > < a href = "/spec/57/" > 57/STATUS-Simple-Scaling< / a > < / li >
2022-12-01 07:58:41 +00:00
< / ul >
< / li >
< li > Draft
< ul >
< li > < a href = "/spec/1/" > 1/COSS< / a > < / li >
< li > < a href = "/spec/3/" > 3/REMOTE-LOG< / a > < / li >
< li > < a href = "/spec/4/" > 4/MVDS-META< / a > < / li >
< li > < a href = "/spec/10/" > 10/WAKU2< / a > < / li >
< li > < a href = "/spec/12/" > 12/WAKU2-FILTER< / a > < / li >
< li > < a href = "/spec/13/" > 13/WAKU2-STORE< / a > < / li >
< li > < a href = "/spec/14/" > 14/WAKU2-MESSAGE< / a > < / li >
< li > < a href = "/spec/15/" > 15/WAKU2-BRIDGE< / a > < / li >
< li > < a href = "/spec/16/" > 16/WAKU2-RPC< / a > < / li >
< li > < a href = "/spec/17/" > 17/WAKU2-RLN-RELAY< / a > < / li >
< li > < a href = "/spec/18/" > 18/WAKU2-SWAP< / a > < / li >
< li > < a href = "/spec/19/" class = active > 19/WAKU2-LIGHTPUSH< / a > < / li >
< li > < a href = "/spec/21/" > 21/WAKU2-FTSTORE< / a > < / li >
< li > < a href = "/spec/22/" > 22/TOY-CHAT< / a > < / li >
< li > < a href = "/spec/23/" > 23/WAKU2-TOPICS< / a > < / li >
< li > < a href = "/spec/26/" > 26/WAKU2-PAYLOAD< / a > < / li >
< li > < a href = "/spec/27/" > 27/WAKU2-PEERS< / a > < / li >
< li > < a href = "/spec/29/" > 29/WAKU2-CONFIG< / a > < / li >
< li > < a href = "/spec/30/" > 30/ADAPTIVE-NODES< / a > < / li >
< li > < a href = "/spec/33/" > 33/WAKU2-DISCV5< / a > < / li >
< li > < a href = "/spec/36/" > 36/WAKU2-BINDINGS-API< / a > < / li >
2023-02-21 11:48:38 +00:00
< li > < a href = "/spec/53/" > 53/WAKU2-X3DH< / a > < / li >
< li > < a href = "/spec/54/" > 54/WAKU2-X3DH-SESSIONS< / a > < / li >
< li > < a href = "/spec/55/" > 55/STATUS-1TO1-CHAT< / a > < / li >
2023-02-21 16:18:47 +00:00
< li > < a href = "/spec/56/" > 56/STATUS-COMMUNITIES< / a > < / li >
2022-12-01 07:58:41 +00:00
< / ul >
< / li >
< li > Stable
< ul >
< li > < a href = "/spec/2/" > 2/MVDS< / a > < / li >
< li > < a href = "/spec/6/" > 6/WAKU1< / a > < / li >
< li > < a href = "/spec/7/" > 7/WAKU-DATA< / a > < / li >
< li > < a href = "/spec/8/" > 8/WAKU-MAIL< / a > < / li >
< li > < a href = "/spec/9/" > 9/WAKU-RPC< / a > < / li >
< li > < a href = "/spec/11/" > 11/WAKU2-RELAY< / a > < / li >
< / ul >
< / li >
< li > Deprecated
< ul >
< li > < a href = "/spec/5/" > 5/WAKU0< / a > < / li >
< / ul >
< / li >
< li > Retired< / li >
< / ul >
< / nav >
2022-12-01 08:37:15 +00:00
< script > ( function ( ) { var e = document . querySelector ( "aside.book-menu nav" ) ; addEventListener ( "beforeunload" , function ( ) { localStorage . setItem ( "menu.scrollTop" , e . scrollTop ) } ) , e . scrollTop = localStorage . getItem ( "menu.scrollTop" ) } ) ( ) < / script >
2022-12-01 07:58:41 +00:00
< / div >
< / aside >
< div class = "book-page" >
< header class = "book-header" >
< div class = "flex align-center justify-between" >
< label for = "menu-control" >
< img src = "/svg/menu.svg" class = "book-icon" alt = "Menu" / >
< / label >
< strong > 19/WAKU2-LIGHTPUSH< / strong >
< label for = "toc-control" >
< img src = "/svg/toc.svg" class = "book-icon" alt = "Table of Contents" / >
< / label >
< / div >
< aside class = "hidden clearfix" >
< nav id = "TableOfContents" >
< ul >
2023-01-12 10:30:30 +00:00
< li > < a href = "#message-relaying" > Message Relaying< / a > < / li >
< li > < a href = "#security-considerations" > Security Considerations< / a > < / li >
2022-12-01 07:58:41 +00:00
< / ul >
< / nav >
< / aside >
< / header >
< article class = "markdown" >
2022-12-01 08:37:15 +00:00
< h1 id = "19waku2-lightpush" >
19/WAKU2-LIGHTPUSH
< a class = "anchor" href = "#19waku2-lightpush" > #< / a >
< / h1 >
2022-12-01 07:58:41 +00:00
2022-12-01 08:37:15 +00:00
< h1 id = "waku-v2-light-push" >
Waku v2 Light Push
< a class = "anchor" href = "#waku-v2-light-push" > #< / a >
< / h1 >
2022-12-01 07:58:41 +00:00
< img src = "https://img.shields.io/badge/status-draft-blue?style=flat-square" / >
< ul >
< li > Status: draft< / li >
< li > Editor: Oskar Thorén < a href = "mailto:oskar@status.im" > oskar@status.im< / a > < / li >
2023-01-12 10:30:30 +00:00
< li > Contributors:
Daniel Kaiser < a href = "mailto:danielkaiser@status.im" > danielkaiser@status.im< / a >
< / li >
2022-12-01 07:58:41 +00:00
< / ul > < p > < strong > Protocol identifier< / strong > : < code > /vac/waku/lightpush/2.0.0-beta1< / code > < / p >
< h1 id = "motivation-and-goals" >
2023-01-12 10:30:30 +00:00
Motivation and Goals
2022-12-01 07:58:41 +00:00
< a class = "anchor" href = "#motivation-and-goals" > #< / a >
< / h1 >
2023-01-12 10:30:30 +00:00
< p > Light nodes with short connection windows and limited bandwidth wish to publish messages into the Waku network.
Additionally, there is sometimes a need for confirmation that a message has been received “ by the network”
(here, at least one node).< / p >
2022-12-01 07:58:41 +00:00
< p > < code > 19/WAKU2-LIGHTPUSH< / code > is a request/response protocol for this.< / p >
< h1 id = "payloads" >
Payloads
< a class = "anchor" href = "#payloads" > #< / a >
< / h1 >
2022-12-01 08:37:15 +00:00
< div class = "highlight" > < pre tabindex = "0" style = "color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4;" > < code class = "language-protobuf" data-lang = "protobuf" > < span style = "display:flex;" > < span > syntax < span style = "color:#f92672" > =< / span > < span style = "color:#e6db74" > " proto3" < / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#66d9ef" > message< / span > < span style = "color:#a6e22e" > PushRequest< / span > {< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#66d9ef" > string< / span > pubsub_topic < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 1< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > WakuMessage < span style = "color:#66d9ef" > message< / span > < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 2< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > }< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#66d9ef" > message< / span > < span style = "color:#a6e22e" > PushResponse< / span > {< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#66d9ef" > bool< / span > is_success < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 1< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#75715e" > // Error messages, etc
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#75715e" > < / span > < span style = "color:#66d9ef" > string< / span > info < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 2< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > }< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#66d9ef" > message< / span > < span style = "color:#a6e22e" > PushRPC< / span > {< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > < span style = "color:#66d9ef" > string< / span > request_id < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 1< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > PushRequest request < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 2< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > PushResponse response < span style = "color:#f92672" > =< / span > < span style = "color:#ae81ff" > 3< / span > ;< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < span style = "display:flex;" > < span > < span style = "color:#960050;background-color:#1e0010" > < / span > }< span style = "color:#960050;background-color:#1e0010" >
< / span > < / span > < / span > < / code > < / pre > < / div > < h2 id = "message-relaying" >
2023-01-12 10:30:30 +00:00
Message Relaying
2022-12-01 07:58:41 +00:00
< a class = "anchor" href = "#message-relaying" > #< / a >
< / h2 >
2023-01-12 10:30:30 +00:00
< p > Nodes that respond to < code > PushRequests< / code > MUST either
relay the encapsulated message via < a href = "/spec/11" > 11/WAKU2-RELAY< / a > protocol on the specified < code > pubsub_topic< / code > ,
or forward the < code > PushRequest< / code > via 19/LIGHTPUSH on a < a href = "https://rfc.vac.dev/spec/44/" > 44/WAKU2-DANDELION< / a > stem.
2022-12-01 07:58:41 +00:00
If they are unable to do so for some reason, they SHOULD return an error code in < code > PushResponse< / code > .< / p >
< h2 id = "security-considerations" >
2023-01-12 10:30:30 +00:00
Security Considerations
2022-12-01 07:58:41 +00:00
< a class = "anchor" href = "#security-considerations" > #< / a >
< / h2 >
2023-01-12 10:30:30 +00:00
< p > Since this can introduce an amplification factor, it is RECOMMENDED for the node relaying to the rest of the network to take extra precautions.
This can be done by rate limiting via < a href = "https://rfc.vac.dev/spec/17/" > 17/WAKU2-RLN-RELAY< / a > .< / p >
2022-12-01 07:58:41 +00:00
< p > Note that the above is currently not fully implemented.< / p >
< h1 id = "copyright" >
Copyright
< a class = "anchor" href = "#copyright" > #< / a >
< / h1 >
< p > Copyright and related rights waived via < a href = "https://creativecommons.org/publicdomain/zero/1.0/" > CC0< / a > .< / p >
2023-01-12 10:30:30 +00:00
< h1 id = "references" >
References
< a class = "anchor" href = "#references" > #< / a >
< / h1 >
< ul >
< li > < a href = "/spec/11" > 11/WAKU2-RELAY< / a > < / li >
< li > < a href = "https://rfc.vac.dev/spec/44/" > 44/WAKU2-DANDELION< / a > < / li >
< / ul >
2022-12-01 07:58:41 +00:00
< / article >
< footer class = "book-footer" >
< div class = "flex flex-wrap justify-between" >
< / div >
< / footer >
< div class = "book-comments" >
< / div >
< label for = "menu-control" class = "hidden book-menu-overlay" > < / label >
< / div >
< aside class = "book-toc" >
< div class = "book-toc-content" >
< nav id = "TableOfContents" >
< ul >
2023-01-12 10:30:30 +00:00
< li > < a href = "#message-relaying" > Message Relaying< / a > < / li >
< li > < a href = "#security-considerations" > Security Considerations< / a > < / li >
2022-12-01 07:58:41 +00:00
< / ul >
< / nav >
< / div >
< / aside >
< / main >
< / body >
< / html >
