You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/documentation/gsoc.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,7 +42,7 @@ To use the example scripts below, you need:
42
42
- A light node for sending GSOC messages.
43
43
- The batch ID of a usable postage batch. If you don't have one already, you will need to [buy a batch](/docs/storage/#purchasing-storage) to upload data. If you do have one, you will need to [get and save](/docs/storage/#selecting-a-batch) its batch ID.
44
44
45
-
## 1. Create an Identifier (Receiver and Sender)
45
+
## Create an Identifier (Receiver and Sender)
46
46
47
47
Identifiers in GSOC are similar to topics in PSS — they define the stream of messages a receiver node is subscribed to. The sender must use the same identifier so that their messages are received.
- Use any hex string to initialize a new `Identifier` object .
67
67
- Use `Identifier.fromString()` to generate an identifier derived from your string of choice (allows for easy to remember human readable identifiers `"notifications"`, `"chat:user1"`).
68
68
69
-
## 2. Get Target Overlay (Receiver Node)
69
+
## Get Target Overlay (Receiver Node)
70
70
71
71
This step **is performed by the receiving full node** to retrieve its overlay address. This overlay address is then shared with the sender node to use as a target overlay for its GSOC messages:
72
72
@@ -100,7 +100,7 @@ Underlay: [
100
100
101
101
The `Overlay` should be saved and shared with sender nodes.
102
102
103
-
## 3. Set Up a Listener (Receiver Node)
103
+
## Set Up a Listener (Receiver Node)
104
104
105
105
This must be run on a full node. It mines a key that lands within its own neighborhood and starts listening.
106
106
@@ -129,7 +129,7 @@ async function listen() {
129
129
listen()
130
130
```
131
131
132
-
## 4. Send a Message (Sender Node)
132
+
## Send a Message (Sender Node)
133
133
134
134
The sending node must have a ***usable postage batch id*** and also know the ***target overlay address*** and ***identifier*** in order to send a message:
0 commit comments