Skip to content

Commit 1f4a39b

Browse files
committed
proofreading
1 parent 05d4085 commit 1f4a39b

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

docs/documentation/gsoc.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ To use the example scripts below, you need:
3434

3535
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.
3636

37-
Each identifier is a 64-digit hex string (32 bytes). It can be initialized with an a hex string of your choice or any arbitrary string using the `Identifier` utility class. You can also use the zero-initialized `NULL_IDENTIFIER` as a default identifier for cases where you don't need a unique identifier:
37+
Each identifier is a 32 byte (64-digit) hex string. It can be initialized with a 32 byte hex string of your choice or can be created from any arbitrary string using the `Identifier` utility class. You can also use the zero-initialized `NULL_IDENTIFIER` as a default identifier for cases where you don't need a unique identifier:
3838

3939

4040
```js
@@ -136,7 +136,7 @@ async function sendMessage() {
136136
// The signer is initialized using the overlay address and identifier shared by the receiving node
137137
const signer = bee.gsocMine(recipientOverlay, identifier)
138138

139-
// bee.gsocSend is called with the batch id, initialized signer, identifier, and message payload in order to send a GSOC message
139+
// bee.gsocSend() is called with the batch id, initialized signer, identifier, and message payload in order to send a GSOC message
140140
await bee.gsocSend(batchId, signer, identifier, 'Hello via GSOC!')
141141
console.log('Message sent')
142142
}

docs/documentation/pss.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,8 +70,8 @@ The sender (which can be a light node or a full node) needs the **overlay addres
7070
You can listen on a topic using both **continuous subscription** and **one-time receive**:
7171

7272

73-
- `bee.pssSubscribe` is used to set up a continuous subscription.
74-
- `bee.pssReceive` is used to set up a listener on a timeout which closes after receiving a message.
73+
- `bee.pssSubscribe()` is used to set up a continuous subscription.
74+
- `bee.pssReceive()` is used to set up a listener on a timeout which closes after receiving a message.
7575

7676
```js
7777
import { Bee, Topic } from '@ethersphere/bee-js'
@@ -103,7 +103,7 @@ async function receiveOnce() {
103103
receiveOnce()
104104
```
105105

106-
In this script we generate a `topic` from our chosen string with the `Topic.fromString` method. Then we subscribe to listen for incoming pss messages for that topic with the `bee.pssSubscribe` method, and we also set up a listener for receiving a single message with the `bee.pssReceive` method. When a chunk with a PSS message for that topic is synced into our node's neighborhood, it will be received and handled by our node with the `onMessage` callback function when using the `bee.pssSubscribe` or through the return value of the `bee.pssReceive` method in our `receiveOnce` function.
106+
In this script we generate a `topic` from our chosen string with the `Topic.fromString()` method. Then we subscribe to listen for incoming pss messages for that topic with the `bee.pssSubscribe()` method, and we also set up a listener for receiving a single message with the `bee.pssReceive()` method. When a chunk with a PSS message for that topic is synced into our node's neighborhood, it will be received and handled by our node with the `onMessage` callback function when using the `bee.pssSubscribe()` or through the return value of the `bee.pssReceive()` method in our `receiveOnce` function.
107107

108108
## Send Message (Light or Full Node)
109109

0 commit comments

Comments
 (0)