vacp2p
/
rfc
mirror of https://github.com/vacp2p/rfc.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

fix(16/WAKU2-RPC): include ephemeral flag in WakuMessage definition (#536) 

* fix(16/WAKU2-RPC): include ephemeral flag in WakuMessage definition

* chore(16/WAKU2-RPC): add additional detail, fix links
This commit is contained in:
Aaryamann Challani 2022-09-21 07:53:51 +05:30 committed by GitHub
parent bb5357ae3b
commit aaa8d4fe70
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
content/docs/rfcs/16/README.md
View File

@ -9,7 +9,7 @@ editor: Hanno Cornelius <hanno@status.im>
# Introduction
This specification describes the JSON-RPC API that Waku v2 nodes MAY adhere to. Refer to the [Waku v2 specification](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-v2.md) for more information on Waku v2.
This specification describes the JSON-RPC API that Waku v2 nodes MAY adhere to. Refer to the [Waku v2 specification](/spec/10/) for more information on Waku v2.
# Wire Protocol
@ -43,7 +43,7 @@ The following structured types are defined for use throughout the document:
### WakuMessage
Refer to [`Waku Message` specification](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-message.md) for more information.
Refer to [`Waku Message` specification](/spec/14/) for more information.
`WakuMessage` is an `Object` containing the following fields:
@ -53,6 +53,7 @@ Refer to [`Waku Message` specification](https://github.com/vacp2p/specs/blob/mas
| `contentTopic` | `String` | optional | Message content topic for optional content-based filtering |
| `version` | `Number` | optional | Message version. Used to indicate type of payload encryption. Default version is 0 (no payload encryption). |
| `timestamp` | `Number` | optional | The time at which the message is generated by its sender. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. |
| `ephemeral` | `Boolean` | optional | This flag indicates the transient nature of the message. Indicates if the message is eligible to be stored by the `store` protocol, [13/WAKU2-STORE](/spec/13/). |
## Method naming
@ -129,7 +130,7 @@ The following structured types are defined for use on the Relay API:
| `payload` | `String` | mandatory | The payload being relayed as a hex encoded data string |
| `contentTopic` | `String` | optional | Message content topic for optional content-based filtering |
| `timestamp` | `Number` | optional | The time at which the message is generated by its sender. This field holds the Unix epoch time in nanoseconds as a 64-bits integer value. |
| `ephemeral` | `Boolean` | optional | This flag indicates the transient nature of the message. |
> **_NOTE:_** `WakuRelayMessage` maps directly to a [`WakuMessage`](#wakumessage), except that the latter contains an explicit message `version`. For `WakuRelay` purposes, the versioning is handled by the API.