Skip to content

Commit b64dacc

Browse files
committed
Expand application interface
1 parent a5187b9 commit b64dacc

File tree

1 file changed

+8
-11
lines changed

1 file changed

+8
-11
lines changed

pubsub/gossipsub/partial-messages.md

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -133,19 +133,16 @@ on signaling bandwidth tradeoff considerations.
133133
## Application Interface
134134

135135
Message contents are application defined. Thus splitting a message must be
136-
application defined. Here is a list of operations an application is expected to
136+
application defined. Here are a list of operations an application is expected to
137137
provide to Gossipsub to enable partial message delivery.
138138

139-
1. Splitting a message into partial message.
140-
2. Given two partial messages, merge them into a more complete partial message.
141-
2a. If merging results in a complete message, return the complete message.
142-
3. Encode and decode a partial message.
143-
4. Given a partial message, encode a request for the rest of the message.
144-
5. Given the request above and a complete message, return relevant parts of the
145-
message.
146-
147-
148-
TODO, think about this more.
139+
1. Split a full message into a group of partial messages.
140+
2. Given a group of partial messages, encode a request for the missing parts. (Used by `PartialIWANT`)
141+
3. Given the request above and a group of partial messages, return the relevant
142+
parts of the message. (Used to fulfill a `PartialIWANT`)
143+
4. Given a group of partial messages, encode metadata for the parts present. (Used by `PartialIHAVE`)
144+
5. Validate a partial message.
145+
6. Encode and decode a group of partial messages.
149146

150147
## Protobuf
151148

0 commit comments

Comments
 (0)