--- title: Waku v2 JSON-RPC REST API version: 0.0.1 status: Raw authors: Hanno Cornelius --- # Table of Contents 1. [Introduction](#introduction) 1. [Wire Protocol](#wire-protocol) 1. [Transport](#transport) 1. [Types](#types) 1. [Method naming](#method-naming) 1. [Debug API](#debug-api) 1. [Relay API](#relay-api) 1. [Store API](#store-api) 1. [Filter API](#filter-api) 1. [Example usage](#example-usage) 1. [Changelod](#changelog) 1. [Copyright](#copyright) # 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. # Wire Protocol ## Transport Nodes SHOULD expose an accessible [JSON-RPC](https://www.jsonrpc.org/specification) API. The JSON-RPC version SHOULD be `2.0`. Below is an example request: ```json { "jsonrpc":"2.0", "method":"get_waku_v2_debug_info", "params":[], "id":1 } ``` ### Fields | Field | Description | | --------- | --------------------------------------------------- | | `jsonrpc` | Contains the used JSON-RPC version (`Default: 2.0`) | | `method` | Contains the JSON-RPC method that is being called | | `params` | An array of parameters for the request | | `id` | The request ID | ## Types In this specification, the primitive types `Boolean`, `String`, `Number` and `Null`, as well as the structured types `Array` and `Object`, are to be interpreted according to the [JSON-RPC specification](https://www.jsonrpc.org/specification#conventions). It also adopts the same capitalisation conventions. 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. `WakuMessage` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `payload` | `String` | mandatory | The message payload | | `contentTopic` | `Number` | 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). | ## Method naming The JSON-RPC methods in this document are designed to be mappable to HTTP REST endpoints. Method names follow the pattern `_waku____` - ``: prefix of the HTTP method type that most closely matches the JSON-RPC function. Supported `method_type` values are `get`, `post`, `put`, `delete` or `patch`. - ``: Waku version. Currently **v2**. - ``: one of the listed APIs below, e.g. `store`, `debug`, or `relay`. - ``: API definition version. Currently **v1** for all APIs. - ``: the resource or resource path being addressed The method `post_waku_v2_relay_v1_message`, for example, would map to the HTTP REST endpoint `POST /waku/v2/relay/v1/message`. ## Debug API ### Types The following structured types are defined for use on the Debug API: #### WakuInfo `WakuInfo` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `listenStr` | `String` | mandatory | Address that the node is listening for | ### `get_waku_v2_debug_v1_info` The `get_waku_v2_debug_v1_info` method retrieves information about a Waku v2 node #### Parameters none #### Response - [**`WakuInfo`**](#WakuInfo) - information about a Waku v2 node ## Relay API Refer to the [Waku Relay specification](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-relay.md) for more information on the relaying of messages. ### Types The following structured types are defined for use on the Relay API: #### WakuRelayMessage `WakuRelayMessage` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `payload` | `String` | mandatory | The payload being relayed | | `contentTopic` | `Number` | optional | Message content topic for optional content-based filtering | ### `post_waku_v2_relay_v1_message` The `post_waku_v2_relay_v1_message` method publishes a message to be relayed on a [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `topic` | `String` | mandatory | The [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) being published on | | `message` | [`WakuRelayMessage`](#WakuRelayMessage) | mandatory | The `message` being relayed | #### Response - **`Bool`** - `true` on success or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ### `post_waku_v2_relay_v1_subscriptions` The `post_waku_v2_relay_v1_subscriptions` method subscribes a node to an array of [PubSub `topics`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor). #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `topics` | `Array`[`String`] | mandatory | The [PubSub `topics`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) being subscribed to | #### Response - **`Bool`** - `true` on success or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ### `delete_waku_v2_relay_v1_subscriptions` The `delete_waku_v2_relay_v1_subscriptions` method unsubscribes a node from an array of [PubSub `topics`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor). #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `topics` | `Array`[`String`] | mandatory | The [PubSub `topics`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) being unsubscribed from | #### Response - **`Bool`** - `true` on success or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ### `get_waku_v2_relay_v1_messages_head` The `get_waku_v2_relay_v1_messages_head` method returns the latest message on a subscribed [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor). The server MUST respond with an [error](https://www.jsonrpc.org/specification#error_object) if no subscription exists for the polled `topic`. If no message has yet been received on the polled `topic`, the server MUST block until a message is received or a timeout is reached. This method can be used to long poll a `topic` for new messages. #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `topic` | `String` | mandatory | The [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor) to poll for the latest message | #### Response - [**`WakuMessage`**](#WakuMessage) - the latest `message` on the polled `topic` or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ## Store API Refer to the [Waku Store specification](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-store.md) for more information on message history retrieval. ### Types The following structured types are defined for use on the Store API: #### StoreResponse `StoreResponse` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `messages` | `Array`[[`WakuMessage`](#WakuMessage)] | mandatory | Array of retrieved historical messages | | `pagingOptions` | [`PagingOptions`](#PagingOptions) | [conditional](#`get_waku_v2_store_v1_messages`) | Paging information from which to resume further historical queries | #### PagingOptions `PagingOptions` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `pageSize` | `Number` | mandatory | Number of messages to retrieve per page | | `cursor` | [`Index`](#Index) | optional | Message [`Index`](#Index) from which to perform pagination. If not included and `forward` is set to `true`, paging will be performed from the beginning of the list. If not included and `forward` is set to `false`, paging will be performed from the end of the list.| | `forward` | `Bool` | mandatory | `true` if paging forward, `false` if paging backward | #### Index `Index` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `digest` | `String` | mandatory | A hash for the message at this [`Index`](#Index) | | `receivedTime` | `Number` | mandatory | UNIX timestamp at which the message at this [`Index`](#Index) was received | ### `get_waku_v2_store_v1_messages` The `get_waku_v2_store_v1_messages` method retrieves historical messages on specific content topics. This method MAY be called with [`PagingOptions`](#PagingOptions), to retrieve historical messages on a per-page basis. If the request included [`PagingOptions`](#PagingOptions), the node MUST return messages on a per-page basis and include [`PagingOptions`](#PagingOptions) in the response. These [`PagingOptions`](#PagingOptions) MUST contain a `cursor` pointing to the [`Index`](#Index) from which a new page can be requested. #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `topics` | `Array`[`Number`] | mandatory | Array of content topics to query for historical messages | | `pagingOptions` | [`PagingOptions`](#PagingOptions) | optional | Pagination information | #### Response - [**`StoreResponse`**](#StoreResponse) - the response to a `query` for historical messages. ## Filter API Refer to the [Waku Filter specification](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-filter.md) for more information on content filtering. ### Types The following structured types are defined for use on the Filter API: #### ContentFilter `ContentFilter` is an `Object` containing the following fields: | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `topics` | `Array`[`Number`] | mandatory | Array of message content topics | ### `post_waku_v2_filter_v1_subscription` The `post_waku_v2_filter_v1_subscription` method creates a subscription in a [light node](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-filter.md#rationale) for messages that matches a content filter and, optionally, a [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor). #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `contentFilters` | `Array`[[`ContentFilter`](#ContentFilter)] | mandatory | Array of content filters being subscribed to | | `topic` | `String` | optional | Message topic | #### Response - **`Bool`** - `true` on success or an [error](https://www.jsonrpc.org/specification#error_object) on failure. ### `delete_waku_v2_filter_v1_subscription` The `delete_waku_v2_filter_v1_subscription` method removes subscriptions in a [light node](https://github.com/vacp2p/specs/blob/master/specs/waku/v2/waku-filter.md#rationale) matching a content filter and, optionally, a [PubSub `topic`](https://github.com/libp2p/specs/blob/master/pubsub/README.md#the-topic-descriptor). #### Parameters | Field | Type | Inclusion | Description | | ----: | :--: | :--: |----------- | | `contentFilters` | `Array`[[`ContentFilter`](#ContentFilter)] | mandatory | Array of content filters being unsubscribed from | | `topic` | `String` | optional | Message topic | #### Response - **`Bool`** - `true` on success or an [error](https://www.jsonrpc.org/specification#error_object) on failure. # Example usage ## Store API ### `get_waku_v2_store_v1_messages` This method is part of the `store` API and the specific resources to retrieve are (historical) `messages`. The protocol (`waku`) is on `v2`, whereas the Store API definition is on `v1`. 1. `get` *all* the historical messages for content topic **1**; no paging required #### Request ```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[[1]]}' --header "Content-Type: application/json" http://localhost:8545``` ```jsonrpc { "jsonrpc": "2.0", "id": "id", "method": "get_waku_v2_store_v1_messages", "params": [ [ 1 ] ] } ``` #### Response ```jsonrpc { "jsonrpc": "2.0", "id": "id", "result": { "messages": [ { "payload": [ 1 ], "contentTopic": 1, "version": 0 }, { "payload": [ 2 ], "contentTopic": 1, "version": 0 }, { "payload": [ 3 ], "contentTopic": 1, "version": 0 } ], "pagingInfo": null }, "error": null } ``` --- 2. `get` a single page of historical messages for content topic **1**; 2 messages per page, backward direction. Since this is the initial query, no `cursor` is provided, so paging will be performed from the end of the list. #### Request ```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[[1],{"pageSize":2,"forward":false}]}' --header "Content-Type: application/json" http://localhost:8545``` ```jsonrpc { "jsonrpc": "2.0", "id": "id", "method": "get_waku_v2_store_v1_messages", "params": [ [ 1 ], { "pageSize": 2, "forward": false } ] } ``` #### Response ```jsonrpc { "jsonrpc": "2.0", "id": "id", "result": { "messages": [ { "payload": [ 2 ], "contentTopic": 1, "version": 0 }, { "payload": [ 3 ], "contentTopic": 1, "version": 0 } ], "pagingInfo": { "pageSize": 2, "cursor": { "digest": "abcdef", "receivedTime": 1605887187 }, "forward": false } }, "error": null } ``` --- 3. `get` the next page of historical messages for content topic **1**, using the cursor received above; 2 messages per page, backward direction. #### Request ```curl -d '{"jsonrpc":"2.0","id":"id","method":"get_waku_v2_store_v1_messages", "params":[[1],{"pageSize":2,"cursor":{"digest":"abcdef","receivedTime":1605887187.00},"forward":false}]}' --header "Content-Type: application/json" http://localhost:8545``` ```jsonrpc { "jsonrpc": "2.0", "id": "id", "method": "get_waku_v2_store_v1_messages", "params": [ [ 1 ], { "pageSize": 2, "cursor": { "digest": "abcdef", "receivedTime": 1605887187 }, "forward": false } ] } ``` #### Response ```jsonrpc { "jsonrpc": "2.0", "id": "id", "result": { "messages": [ { "payload": [ 1 ], "contentTopic": 1, "version": 0 } ], "pagingInfo": { "pageSize": 2, "cursor": { "digest": "123abc", "receivedTime": 1605866187 }, "forward": false } }, "error": null } ``` # Changelog TBD # Copyright Copyright and related rights waived via [CC0](https://creativecommons.org/publicdomain/zero/1.0/).