Create README.md

This commit is contained in:
Jimmy Debe 2024-01-05 13:41:17 -05:00 committed by GitHub
parent b555910202
commit f457db0a77
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 38 additions and 0 deletions

View File

@ -0,0 +1,38 @@
# Build a Waku Node: Waku Relay
## Introduction
This is the first guide in the tutorial demonstatraing how to build your own Waku node using python.
Waku provides a collection of protocols on top of libp2p to create mesage anonymity.
These guides will use the core protocols of Waku, as described in [10/WAKU2](https://rfc.vac.dev/spec/10/),
other protocols can be added to your node after completing the tutorial.
This tutorial will focus on the Waku Relay protocol.
## Configuration
Nodes must use configurations detailed in [11/WAKU2-RELAY](https://rfc.vac.dev/spec/11/).
The [11/WAKU2-RELAY](https://rfc.vac.dev/spec/11/) is the most important protocol to implement,
as a Waku node should be a running a relay, as detailed (here)[].
Since this is the first
Let's set up the basic libp2p modules that are need for a Waku Relay.
First, lets create a directory for our new project:
``` bash
# create a new directory and make sure you change into it
> mkdir waku-node
> cd waku-node
```
In your new directory, download the supported py-libp2p from the github repository.
> Note: py-libp2p is still under development and should not be used for production envirnoments.
``` bash
> git clone git@github.com:libp2p/py-libp2p.git
```