mirror of
https://github.com/acid-info/docs.wakuconnect.dev.git
synced 2025-02-23 06:58:19 +00:00
426 lines
22 KiB
HTML
426 lines
22 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="sidebar-visible no-js light">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Retrieve Messages Using Waku Store With ReactJS - DappConnect Docs</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
|
|
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
|
|
<meta name="description" content="">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff" />
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" href="../highlight.css">
|
|
<link rel="stylesheet" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
<link rel="stylesheet" href="../custom.css">
|
|
|
|
</head>
|
|
<body>
|
|
<!-- Provide site root to javascript -->
|
|
<script type="text/javascript">
|
|
var path_to_root = "../";
|
|
var default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? "navy" : "light";
|
|
</script>
|
|
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script type="text/javascript">
|
|
try {
|
|
var theme = localStorage.getItem('mdbook-theme');
|
|
var sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script type="text/javascript">
|
|
var theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
var html = document.querySelector('html');
|
|
html.classList.remove('no-js')
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add('js');
|
|
</script>
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script type="text/javascript">
|
|
var html = document.querySelector('html');
|
|
var sidebar = 'hidden';
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
}
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<div class="sidebar-scrollbox">
|
|
<ol class="chapter"><li class="chapter-item expanded affix "><a href="../introduction.html">Introduction</a></li><li class="chapter-item expanded "><a href="../quick_start.html"><strong aria-hidden="true">1.</strong> Quick Start</a></li><li class="chapter-item expanded "><a href="../guides/index.html"><strong aria-hidden="true">2.</strong> Guides</a></li><li><ol class="section"><li class="chapter-item expanded "><a href="../guides/choose_content_topic.html"><strong aria-hidden="true">2.1.</strong> How to Choose a Content Topic</a></li><li class="chapter-item expanded "><a href="../guides/relay_receive_send_messages.html"><strong aria-hidden="true">2.2.</strong> Receive and Send Messages Using Waku Relay</a></li><li class="chapter-item expanded "><a href="../guides/store_retrieve_messages.html"><strong aria-hidden="true">2.3.</strong> Retrieve Messages Using Waku Store</a></li><li class="chapter-item expanded "><a href="../guides/encrypt_messages_version_1.html"><strong aria-hidden="true">2.4.</strong> Encrypt Messages Using Waku Message Version 1</a></li><li class="chapter-item expanded "><a href="../guides/reactjs_relay.html"><strong aria-hidden="true">2.5.</strong> Receive and Send Messages Using Waku Relay With ReactJS</a></li><li class="chapter-item expanded "><a href="../guides/reactjs_store.html" class="active"><strong aria-hidden="true">2.6.</strong> Retrieve Messages Using Waku Store With ReactJS</a></li><li class="chapter-item expanded "><a href="../guides/light_push_send_messages.html"><strong aria-hidden="true">2.7.</strong> Send Messages Using Waku Light Push</a></li></ol></li><li class="chapter-item expanded "><a href="../examples.html"><strong aria-hidden="true">3.</strong> Examples</a></li><li class="chapter-item expanded affix "><a href="../waku_protocols.html">Implemented Waku Protocols</a></li></ol> </div>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle"></div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky bordered">
|
|
<div class="left-buttons">
|
|
<button id="sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</button>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light (default)</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">DappConnect Docs</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/vacp2p/docs.dappconnect.dev" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script type="text/javascript">
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="retrieve-messages-using-waku-store-with-reactjs"><a class="header" href="#retrieve-messages-using-waku-store-with-reactjs">Retrieve Messages Using Waku Store With ReactJS</a></h1>
|
|
<p>It is easy to use DappConnect with ReactJS.
|
|
In this guide, we will demonstrate how your ReactJS dApp can use Waku Store to retrieve messages.</p>
|
|
<p>DApps running on a phone or in a browser are often offline:
|
|
The browser could be closed or mobile app in the background.</p>
|
|
<p><a href="https://rfc.vac.dev/spec/18/">Waku Relay</a> is a gossip protocol.
|
|
As a user, it means that your peers forward you messages they just received.
|
|
If you cannot be reached by your peers, then messages are not relayed;
|
|
relay peers do <strong>not</strong> save messages for later.</p>
|
|
<p>However, <a href="https://rfc.vac.dev/spec/13/">Waku Store</a> peers do save messages they relay,
|
|
allowing you to retrieve them at a later time.
|
|
The Waku Store protocol is best-effort and does not guarantee data availability.
|
|
Waku Relay should still be preferred when online;
|
|
Waku Store can be used after resuming connectivity:
|
|
For example, when the dApp starts.</p>
|
|
<p>In this guide, we'll review how you can use Waku Store to retrieve messages.</p>
|
|
<p>Before starting, you need to choose a <em>Content Topic</em> for your dApp.
|
|
Check out the <a href="./choose_content_topic.html">how to choose a content topic guide</a> to learn more about content topics.</p>
|
|
<h1 id="setup"><a class="header" href="#setup">Setup</a></h1>
|
|
<p>Create a new React app:</p>
|
|
<pre><code class="language-shell">npx create-react-app my-app
|
|
cd my-app
|
|
</code></pre>
|
|
<p>Then, install <a href="https://npmjs.com/package/js-waku">js-waku</a>:</p>
|
|
<pre><code class="language-shell">npm install js-waku
|
|
</code></pre>
|
|
<p>Start the dev server and open the dApp in your browser:</p>
|
|
<pre><code class="language-shell">npm run start
|
|
</code></pre>
|
|
<p>Note: We have noticed some <a href="https://github.com/status-im/js-waku/issues/165">issues</a> with React bundling due to <code>npm</code> pulling an old version of babel.
|
|
If you are getting an error about the <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Optional_chaining">optional chaining (?.)</a>
|
|
character not being valid, try cleaning up and re-installing your dependencies:</p>
|
|
<pre><code class="language-shell">rm -rf node_modules package-lock.json
|
|
npm install
|
|
</code></pre>
|
|
<h1 id="create-waku-instance"><a class="header" href="#create-waku-instance">Create Waku Instance</a></h1>
|
|
<p>In order to interact with the Waku network, you first need a Waku instance.
|
|
Go to <code>App.js</code> and modify the <code>App</code> function:</p>
|
|
<pre><code class="language-js">import { Waku } from 'js-waku';
|
|
import * as React from 'react';
|
|
|
|
function App() {
|
|
const [waku, setWaku] = React.useState(undefined);
|
|
const [wakuStatus, setWakuStatus] = React.useState('None');
|
|
|
|
// Start Waku
|
|
React.useEffect(() => {
|
|
// If Waku status not None, it means we are already starting Waku
|
|
if (wakuStatus !== 'None') return;
|
|
|
|
setWakuStatus('Starting');
|
|
|
|
// Create Waku
|
|
Waku.create({ bootstrap: true }).then((waku) => {
|
|
// Once done, put it in the state
|
|
setWaku(waku);
|
|
// And update the status
|
|
setWakuStatus('Connecting');
|
|
});
|
|
}, [waku, wakuStatus]);
|
|
|
|
return (
|
|
<div className='App'>
|
|
<header className='App-header'>
|
|
// Display the status on the web page
|
|
<p>{wakuStatus}</p>
|
|
</header>
|
|
</div>
|
|
);
|
|
}
|
|
</code></pre>
|
|
<h1 id="wait-to-be-connected"><a class="header" href="#wait-to-be-connected">Wait to be connected</a></h1>
|
|
<p>When using the <code>bootstrap</code> option, it may take some time to connect to other peers.
|
|
To ensure that you have store peers available to retrieve messages from,
|
|
use the <code>Waku.waitForConnectedPeer()</code> async function:</p>
|
|
<pre><code class="language-js">React.useEffect(() => {
|
|
if (!waku) return;
|
|
|
|
if (wakuStatus === 'Connected') return;
|
|
|
|
waku.waitForConnectedPeer().then(() => {
|
|
setWakuStatus('Connected');
|
|
});
|
|
}, [waku, wakuStatus]);
|
|
</code></pre>
|
|
<h1 id="use-protobuf"><a class="header" href="#use-protobuf">Use Protobuf</a></h1>
|
|
<p>Waku v2 protocols use <a href="https://developers.google.com/protocol-buffers/">protobuf</a> <a href="https://rfc.vac.dev/spec/10/">by default</a>.</p>
|
|
<p>Let's review how you can use protobuf to decode structured data.</p>
|
|
<p>First, define a data structure.
|
|
For this guide, we will use a simple chat message that contains a timestamp, nick and text:</p>
|
|
<pre><code class="language-js">{
|
|
timestamp: Date;
|
|
nick: string;
|
|
text: string;
|
|
}
|
|
</code></pre>
|
|
<p>To encode and decode protobuf payloads, you can use the <a href="https://www.npmjs.com/package/protons">protons</a> package.</p>
|
|
<h2 id="install-protobuf-library"><a class="header" href="#install-protobuf-library">Install Protobuf Library</a></h2>
|
|
<pre><code class="language-shell">npm install protons
|
|
</code></pre>
|
|
<h2 id="protobuf-definition"><a class="header" href="#protobuf-definition">Protobuf Definition</a></h2>
|
|
<p>Define the data structure with protons:</p>
|
|
<pre><code class="language-js">import protons from 'protons';
|
|
|
|
const proto = protons(`
|
|
message ChatMessage {
|
|
uint64 timestamp = 1;
|
|
string nick = 2;
|
|
bytes text = 3;
|
|
}
|
|
`);
|
|
</code></pre>
|
|
<p>You can learn about protobuf message definitions here:
|
|
<a href="https://developers.google.com/protocol-buffers/docs/proto">Protocol Buffers Language Guide</a>.</p>
|
|
<h2 id="decode-messages"><a class="header" href="#decode-messages">Decode Messages</a></h2>
|
|
<p>To decode the messages retrieved from a Waku Store node,
|
|
you need to extract the protobuf payload and decode it using <code>protons</code>.</p>
|
|
<pre><code class="language-js">function decodeMessage(wakuMessage) {
|
|
if (!wakuMessage.payload) return;
|
|
|
|
const { timestamp, nick, text } = proto.ChatMessage.decode(
|
|
wakuMessage.payload
|
|
);
|
|
|
|
// All fields in protobuf are optional so be sure to check
|
|
if (!timestamp || !text || !nick) return;
|
|
|
|
const time = new Date();
|
|
time.setTime(timestamp);
|
|
|
|
const utf8Text = Buffer.from(text).toString('utf-8');
|
|
|
|
return { text: utf8Text, timestamp: time, nick };
|
|
}
|
|
|
|
</code></pre>
|
|
<h2 id="retrieve-messages"><a class="header" href="#retrieve-messages">Retrieve messages</a></h2>
|
|
<p>You now have all the building blocks to retrieve and decode messages for a store node.</p>
|
|
<p>Note that Waku Store queries are paginated.
|
|
The API provided by <code>js-waku</code> automatically traverses all pages of the Waku Store response.
|
|
By default, the most recent page is retrieved first but this can be changed with the <code>pageDirection</code> option.</p>
|
|
<p>First, define a React state to save the messages:</p>
|
|
<pre><code class="language-js">function App() {
|
|
const [messages, setMessages] = React.useState([]);
|
|
/// [..]
|
|
}
|
|
</code></pre>
|
|
<p>Then, define <code>processMessages</code> to decode and then store messages in the React state.
|
|
You will pass <code>processMessages</code> as a <code>callback</code> option to <code>WakuStore.queryHistory</code>.
|
|
<code>processMessages</code> will be called each time a page is received from the Waku Store.</p>
|
|
<pre><code class="language-js">const processMessages = (retrievedMessages) => {
|
|
const messages = retrievedMessages.map(decodeMessage).filter(Boolean);
|
|
|
|
setMessages((currentMessages) => {
|
|
return currentMessages.concat(messages.reverse());
|
|
});
|
|
};
|
|
</code></pre>
|
|
<p>Finally, pass <code>processMessage</code> in <code>WakuStore.queryHistory</code> as the <code>callback</code> value:</p>
|
|
<pre><code class="language-js">waku.store
|
|
.queryHistory([ContentTopic], { callback: processMessages });
|
|
</code></pre>
|
|
<p>All together, you should now have:</p>
|
|
<pre><code class="language-js">const ContentTopic = '/toy-chat/2/huilong/proto';
|
|
|
|
function App() {
|
|
// [..]
|
|
// Store messages in the state
|
|
const [messages, setMessages] = React.useState([]);
|
|
|
|
React.useEffect(() => {
|
|
if (wakuStatus !== 'Connected') return;
|
|
|
|
const processMessages = (retrievedMessages) => {
|
|
const messages = retrievedMessages.map(decodeMessage).filter(Boolean);
|
|
|
|
setMessages((currentMessages) => {
|
|
return currentMessages.concat(messages.reverse());
|
|
});
|
|
};
|
|
|
|
waku.store
|
|
.queryHistory([ContentTopic], { callback: processMessages })
|
|
.catch((e) => {
|
|
console.log('Failed to retrieve messages', e);
|
|
});
|
|
}, [waku, wakuStatus]);
|
|
|
|
return (
|
|
<div className='App'>
|
|
<header className='App-header'>
|
|
<h2>{wakuStatus}</h2>
|
|
<h3>Messages</h3>
|
|
<ul>
|
|
<Messages messages={messages} />
|
|
</ul>
|
|
</header>
|
|
</div>
|
|
);
|
|
}
|
|
|
|
</code></pre>
|
|
<p>Note that <code>WakuStore.queryHistory</code> select an available store node for you.
|
|
However, it can only select a connected node, which is why the bootstrapping is necessary.
|
|
It will throw an error if no store node is available.</p>
|
|
<h2 id="filter-messages-by-send-time"><a class="header" href="#filter-messages-by-send-time">Filter messages by send time</a></h2>
|
|
<p>By default, Waku Store nodes store messages for 30 days.
|
|
Depending on your use case, you may not need to retrieve 30 days worth of messages.</p>
|
|
<p><a href="https://rfc.vac.dev/spec/14/">Waku Message</a> defines an optional unencrypted <code>timestamp</code> field.
|
|
The timestamp is set by the sender.
|
|
By default, js-waku sets the timestamp of outgoing message to the current time.</p>
|
|
<p>You can filter messages that include a timestamp within given bounds with the <code>timeFilter</code> option.</p>
|
|
<p>Retrieve messages up to a week old:</p>
|
|
<pre><code class="language-js">const startTime = new Date();
|
|
// 7 days/week, 24 hours/day, 60min/hour, 60secs/min, 100ms/sec
|
|
startTime.setTime(startTime.getTime() - 7 * 24 * 60 * 60 * 1000);
|
|
|
|
waku.store
|
|
.queryHistory([ContentTopic], {
|
|
callback: processMessages,
|
|
timeFilter: { startTime, endTime: new Date() }
|
|
});
|
|
</code></pre>
|
|
<h2 id="end-result"><a class="header" href="#end-result">End result</a></h2>
|
|
<p>You can see the complete code in the <a href="https://github.com/status-im/js-waku/tree/main/examples/store-reactjs-chat">Minimal ReactJS Waku Store App</a>.</p>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../guides/reactjs_relay.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next" href="../guides/light_push_send_messages.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../guides/reactjs_relay.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next" href="../guides/light_push_send_messages.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script type="text/javascript">
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
|
|
<script src="../elasticlunr.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../mark.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../searcher.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<script src="../clipboard.min.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../highlight.js" type="text/javascript" charset="utf-8"></script>
|
|
<script src="../book.js" type="text/javascript" charset="utf-8"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
|
|
|
|
</body>
|
|
</html>
|