Skip to content

docs: add PSS prerequisites section #796

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
EchinopsisMonstrose wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add PSS prerequisites section #796

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/develop/tools-and-features/pss.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,17 @@ Out of the ashes of Ethereum's vision for a leak-proof decentralised anonymous m

PSS provides a pub-sub facility that can be used for a variety of tasks. Nodes are able to listen to messages received for a specific topic in their nearest neighborhood and create messages destined for another neighborhood which are sent over the network using Swarm's usual data dissemination protocols.

## Prerequisites

:::warning
**You must be running a full node to receive PSS messages.** Ultra-light and light nodes cannot subscribe to or receive messages. Full nodes connected to a blockchain RPC endpoint are required for PSS functionality.
:::

Additionally, to send PSS messages, you will need:
- A postage stamp batch with sufficient xBZZ balance
- The recipient's Swarm address prefix (at least 2 bytes)
- The recipient's public key

### Subscribe and Receive Messages

Once your Bee node is up and running, you will be able to subscribe to feeds using WebSockets. For testing, it is useful to use the [websocat](https://docs.rs/crate/websocat/1.0.1) command line utility.
Expand Down
Loading