Compare commits
6 Commits
8ab78abe65
...
73d6b78413
Author | SHA1 | Date |
---|---|---|
LordGhostX | 73d6b78413 | |
LordGhostX | 38bc3a0a80 | |
LordGhostX | fc0672d80b | |
LordGhostX | 5c969c54b8 | |
LordGhostX | 57453e47d1 | |
LordGhostX | e7d6cdba54 |
|
@ -16,7 +16,9 @@ graph LR
|
|||
W -->|Message 3| R2(Message Receiver 2)
|
||||
```
|
||||
|
||||
<iframe class="yt-video" src="https://www.youtube.com/watch?v=PYQaXCxUCwA" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
<div class="video-container">
|
||||
<iframe class="yt-video" src="https://www.youtube.com/embed/nIWx5Vp_Qxk" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
:::tip
|
||||
Check out our [Learn section](/learn/waku-network), [YouTube channel](https://www.youtube.com/@wakuorg), and [Blog](https://blog.waku.org/) to dive into how Waku works behind the scenes!
|
||||
|
@ -43,17 +45,34 @@ Check out our [Learn section](/learn/waku-network), [YouTube channel](https://ww
|
|||
Looking for what to build with Waku? Discover a collection of sample ideas and use cases for inspiration, curated by our community at: https://ideas.waku.org/ and [Awesome Waku](https://github.com/waku-org/awesome-waku/).
|
||||
:::
|
||||
|
||||
## Run a Waku node
|
||||
## Case studies
|
||||
|
||||
<div class="case-study-container">
|
||||
<a href="https://blog.waku.org/thegraph-waku-case-study/" target="_blank" rel="noopener noreferrer"><img src="/img/graph-use-case.jpeg" /></a>
|
||||
<a href="https://blog.waku.org/railgun-waku-case-study/" target="_blank" rel="noopener noreferrer"><img src="/img/railgun-use-case.jpeg" /></a>
|
||||
</div>
|
||||
|
||||
## Getting started
|
||||
|
||||
<div class="video-container">
|
||||
<iframe class="yt-video two-items" src="https://www.youtube.com/embed/PYQaXCxUCwA" title="Waku Tutorial 001: Introduction to Waku" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
|
||||
<iframe class="yt-video two-items" src="https://www.youtube.com/embed/sfmMcrbiX0c" title="Build a game using Waku Protocol" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
### Run a Waku node
|
||||
|
||||
Waku is a decentralised, permissionless system where anyone can run a node, use the network, and contribute to its support. We recommend following the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide and [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to easily run a node.
|
||||
|
||||
<iframe class="yt-video" src="https://www.youtube.com/watch?v=fs0ynLk4z0I" title="How to run a Waku node using Nwaku Compose" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
<div class="video-container">
|
||||
<iframe class="yt-video" src="https://www.youtube.com/embed/fs0ynLk4z0I" title="How to run a Waku node using Nwaku Compose" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
:::tip
|
||||
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||
:::
|
||||
|
||||
## Integrate using SDKs
|
||||
### Integrate using SDKs
|
||||
|
||||
Waku is implemented in multiple SDKs, allowing it to integrate with different languages and address various use cases efficiently.
|
||||
|
||||
|
@ -62,7 +81,7 @@ Waku is implemented in multiple SDKs, allowing it to integrate with different la
|
|||
| [@waku/sdk](https://github.com/waku-org/js-waku) | JavaScript/TypeScript SDK designed for browser environments | [JavaScript Waku SDK](/guides/js-waku/) |
|
||||
| [@waku/react](https://www.npmjs.com/package/@waku/react) | React components and UI adapters designed for seamless integration with `@waku/sdk` | [Build React DApps Using @waku/react](/guides/js-waku/use-waku-react) |
|
||||
|
||||
## Other integrations
|
||||
### Other integrations
|
||||
|
||||
| | Description | Documentation |
|
||||
| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
|
|
|
@ -11,7 +11,9 @@ hide_table_of_contents: true
|
|||
|
||||
## Video tutorial
|
||||
|
||||
<iframe class="yt-video" src="https://www.youtube.com/watch?v=fs0ynLk4z0I" title="How to run a Waku node using Nwaku Compose" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
<div class="video-container">
|
||||
<iframe class="yt-video" src="https://www.youtube.com/embed/fs0ynLk4z0I" title="How to run a Waku node using Nwaku Compose" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>
|
||||
</div>
|
||||
|
||||
:::tip
|
||||
Check out the [Waku Node Operator Cheatsheet](/Waku-NodeOperator.pdf) to learn how to easily run, monitor, and interact with a node.
|
||||
|
@ -117,6 +119,10 @@ curl --location 'http://127.0.0.1:8645/store/v1/messages?contentTopics=%2Fmy-app
|
|||
--header 'Accept: application/json'
|
||||
```
|
||||
|
||||
:::tip
|
||||
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||
:::
|
||||
|
||||
:::tip Congratulations!
|
||||
You have successfully started a `nwaku` node with `RLN` enabled using Docker Compose. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) and [Advanced Configuration](https://github.com/waku-org/nwaku-compose/blob/master/ADVANCED.md) guides to learn how to configure `nwaku` for different use cases.
|
||||
:::
|
||||
|
|
|
@ -56,10 +56,14 @@ To find your public IP, use:
|
|||
dig TXT +short o-o.myaddr.l.google.com @ns1.google.com | awk -F'"' '{ print $2}'
|
||||
```
|
||||
|
||||
:::tip
|
||||
:::info
|
||||
We recommend using explicit port mappings (`-p`) when exposing ports accessible from outside the host (listening and discovery ports, API servers).
|
||||
:::
|
||||
|
||||
:::tip
|
||||
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||
:::
|
||||
|
||||
:::tip Congratulations!
|
||||
You have successfully built and started a `nwaku` node in a Docker container. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||
:::
|
||||
|
|
|
@ -132,6 +132,10 @@ Node is healthy
|
|||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
:::tip
|
||||
If you encounter issues running your node or require assistance with anything, please visit the [#node-help channel](https://discord.com/channels/1110799176264056863/1216748184592711691) on our Discord.
|
||||
:::
|
||||
|
||||
:::tip Congratulations!
|
||||
You have successfully started, configured, and connected a `nwaku` node to the Waku Network. Have a look at the [Node Configuration Examples](/guides/nwaku/configure-nwaku) guide to learn how to configure `nwaku` for different use cases.
|
||||
:::
|
||||
|
|
|
@ -10,10 +10,8 @@ The Waku Network is a shared p2p messaging network that is open-access, useful f
|
|||
3. Automatic shard selection based on content topic.
|
||||
4. Services for resource-restricted nodes, including historical message storage and retrieval, filtering, etc.
|
||||
|
||||
If you want to learn more about the Waku Network, the [WAKU2-NETWORK RFC](https://rfc.vac.dev/waku/standards/core/10/waku2) provides an in-depth look under the hood.
|
||||
|
||||
:::info
|
||||
The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, scalability, and reasonable bandwidth usage.
|
||||
:::tip
|
||||
If you want to learn more about the Waku Network, the [The Waku Network: Technical Overview](https://blog.waku.org/2024-waku-network-tech-overview) article provides an in-depth look under the hood.
|
||||
:::
|
||||
|
||||
## Why join the Waku network?
|
||||
|
@ -30,3 +28,7 @@ The public Waku Network replaces the previous experimental shared routing layer
|
|||
## Running a Waku network node
|
||||
|
||||
Have a look at the [Run Nwaku with Docker Compose](/guides/nwaku/run-docker-compose) guide for instructions on running a [nwaku](https://github.com/waku-org/nwaku) node in the Waku Network. Use the Sepolia node and wallet you obtained above.
|
||||
|
||||
:::info
|
||||
The public Waku Network replaces the previous experimental shared routing layer based on a default pubsub topic (`/waku/2/default-waku/proto`). If your project currently uses this or any other shared pubsub topics, we encourage you to migrate to the public Waku Network with built-in DoS protection, scalability, and reasonable bandwidth usage.
|
||||
:::
|
||||
|
|
|
@ -85,6 +85,11 @@ const sidebars = {
|
|||
value:
|
||||
'<a href="https://ideas.waku.org" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Waku Idea Board<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
|
||||
},
|
||||
{
|
||||
type: "html",
|
||||
value:
|
||||
'<a href="https://github.com/waku-org/bounties/" target="_blank" rel="noopener noreferrer" class="menu__link external-link">Post-Hackathon Bounties<svg width="16" height="16" viewBox="0 0 16 16" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M11.1918 4H3.42848V2.85715H13.1428V12.5714H11.9999V4.80813L3.83254 12.9755L3.02441 12.1674L11.1918 4Z" fill="white"/></svg>',
|
||||
},
|
||||
],
|
||||
learn: [
|
||||
"learn/waku-network",
|
||||
|
|
|
@ -19,10 +19,52 @@ html[data-theme="dark"] .header-github-link:before {
|
|||
no-repeat;
|
||||
}
|
||||
|
||||
.video-container {
|
||||
display: flex;
|
||||
flex-wrap: wrap;
|
||||
justify-content: space-around;
|
||||
align-items: flex-start;
|
||||
}
|
||||
|
||||
.yt-video {
|
||||
flex: 1 1 auto;
|
||||
max-width: 100%;
|
||||
width: 640px;
|
||||
height: 360px;
|
||||
height: 432px;
|
||||
}
|
||||
|
||||
.two-items {
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
/* Media query for tablets and desktops */
|
||||
@media (min-width: 768px) {
|
||||
.two-items {
|
||||
width: 48%;
|
||||
}
|
||||
}
|
||||
|
||||
.case-study-container a {
|
||||
display: block;
|
||||
width: 100%;
|
||||
margin-bottom: 20px;
|
||||
}
|
||||
|
||||
.case-study-container a img {
|
||||
width: 100%;
|
||||
height: auto;
|
||||
}
|
||||
|
||||
@media (min-width: 768px) {
|
||||
.case-study-container a {
|
||||
display: inline-block;
|
||||
width: 48%;
|
||||
margin-bottom: 20px;
|
||||
margin-right: 2%;
|
||||
}
|
||||
|
||||
.case-study-container a:nth-child(2n) {
|
||||
margin-right: 0;
|
||||
}
|
||||
}
|
||||
|
||||
.external-link {
|
||||
|
|
Binary file not shown.
After Width: | Height: | Size: 279 KiB |
Binary file not shown.
After Width: | Height: | Size: 994 KiB |
Loading…
Reference in New Issue