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 = "A bridge between Waku v1 and Waku v2 .
2022-12-01 08:37:15 +00:00
Bridge # A bridge requires supporting both Waku versions:
Waku v1 - using devp2p RLPx protocol Waku v2 - using libp2p protocols Packets received on the Waku v1 network SHOULD be published just once on the Waku v2 network. More specifically, the bridge SHOULD publish this through the Waku Relay (PubSub domain).
2022-12-01 07:58:41 +00:00
Publishing such packet will require the creation of a new Message with a new WakuMessage as data field.">
< meta name = "theme-color" content = "#FFFFFF" > < meta property = "og:title" content = "15/WAKU-BRIDGE" / >
< meta property = "og:description" content = "A bridge between Waku v1 and Waku v2 .
2022-12-01 08:37:15 +00:00
Bridge # A bridge requires supporting both Waku versions:
Waku v1 - using devp2p RLPx protocol Waku v2 - using libp2p protocols Packets received on the Waku v1 network SHOULD be published just once on the Waku v2 network. More specifically, the bridge SHOULD publish this through the Waku Relay (PubSub domain).
2022-12-01 07:58:41 +00:00
Publishing such packet will require the creation of a new Message with a new WakuMessage as data field." />
< meta property = "og:type" content = "article" / >
< meta property = "og:url" content = "https://rfc.vac.dev/spec/15/" / > < meta property = "article:section" content = "docs" / >
< title > 15/WAKU-BRIDGE | 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=" >
2022-12-02 14:32:42 +00:00
< script defer src = "/en.search.min.06839260bd3cd325ccc30b304a33015b3262511616f3b07ba00bf537143fcbfb.js" integrity = "sha256-BoOSYL080yXMwwswSjMBWzJiURYW87B7oAv1NxQ/y/s=" > < / 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 >
< 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 >
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/" class = active > 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/" > 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 >
< / 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 > 15/WAKU-BRIDGE< / 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 >
< li >
< ul >
< li > < a href = "#security-considerations" > Security Considerations< / a > < / li >
< / ul >
< / li >
< / ul >
< / nav >
< / aside >
< / header >
< article class = "markdown" >
2022-12-01 08:37:15 +00:00
< h1 id = "15waku-bridge" >
15/WAKU-BRIDGE
< a class = "anchor" href = "#15waku-bridge" > #< / a >
< / h1 >
2022-12-01 07:58:41 +00:00
2022-12-01 08:37:15 +00:00
< h1 id = "waku-bridge" >
Waku Bridge
< a class = "anchor" href = "#waku-bridge" > #< / 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: Hanno Cornelius < a href = "mailto:hanno@status.im" > hanno@status.im< / a > < / li >
< / ul > < p > A bridge between Waku v1 and Waku v2.< / p >
< h1 id = "bridge" >
Bridge
< a class = "anchor" href = "#bridge" > #< / a >
< / h1 >
< p > A bridge requires supporting both Waku versions:< / p >
< ul >
< li > Waku v1 - using devp2p RLPx protocol< / li >
< li > Waku v2 - using libp2p protocols< / li >
< / ul >
< p > Packets received on the Waku v1 network SHOULD be published just once on the
Waku v2 network. More specifically, the bridge SHOULD publish
this through the Waku Relay (PubSub domain).< / p >
< p > Publishing such packet will require the creation of a new < code > Message< / code > with a
new < code > WakuMessage< / code > as data field. The < code > data< / code > and < code > topic< / code > field from the Waku v1
< code > Envelope< / code > MUST be copied to the < code > payload< / code > and < code > contentTopic< / code > fields of the
< code > WakuMessage< / code > . Other fields such as nonce, expiry and ttl will be dropped as
they become obsolete in Waku v2.< / p >
< p > Before this is done, the usual envelope verification still applies:< / p >
< ul >
< li > Expiry & future time verification< / li >
< li > PoW verification< / li >
< li > Size verification< / li >
< / ul >
< p > Bridging SHOULD occur through the < code > WakuRelay< / code > , but it MAY also be done on other Waku
v2 protocols (e.g. < code > WakuFilter< / code > ). The latter is however not advised as it will
increase the complexity of the bridge and because of the
< a href = "#security-considerations" > Security Considerations< / a > explained further below.< / p >
< p > Packets received on the Waku v2 network SHOULD be posted just once on the Waku
v1 network. The Waku v2 < code > WakuMessage< / code > contains only the < code > payload< / code > and
< code > contentTopic< / code > fields. The bridge MUST create a new Waku v1 < code > Envelope< / code > and
copy over the < code > payload< / code > and < code > contentFilter< / code > fields to the < code > data< / code > and < code > topic< / code >
fields. Next, before posting on the network, the bridge MUST set a new expiry
and ttl and do the PoW nonce calculation.< / p >
< h3 id = "security-considerations" >
Security Considerations
< a class = "anchor" href = "#security-considerations" > #< / a >
< / h3 >
< p > As mentioned above, a bridge will be posting new Waku v1 envelopes, which
requires doing the PoW nonce calculation.< / p >
< p > This could be a DoS attack vector, as the PoW calculation will make it more
expensive to post the message compared to the original publishing on the Waku v2
network. Low PoW setting will lower this problem, but it is likely that it is
still more expensive.< / p >
< p > For this reason, bridges SHOULD probably be run independently of other nodes, so
that a bridge that gets overwhelmed does not disrupt regular Waku v2 to v2
traffic.< / p >
< p > Bridging functionality SHOULD also be carefully implemented so that messages do
not bounce back and forth between the two networks. The bridge SHOULD properly
track messages with a seen filter so that no amplification can be achieved here.< / 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 >
< / 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 >
< li >
< ul >
< li > < a href = "#security-considerations" > Security Considerations< / a > < / li >
< / ul >
< / li >
< / ul >
< / nav >
< / div >
< / aside >
< / main >
< / body >
< / html >
