vacp2p/rfc-index
1
0
Fork 0
mirror of https://github.com/vacp2p/rfc-index.git synced 2026-01-09 13:58:08 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update bindings-api.md

Browse Source
This commit is contained in:
Cofson
2025-02-14 05:02:23 +01:00
parent a60a2c45de
commit dfb5b167e2
1 changed files with 15 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
waku/standards/core/36/bindings-api.md
View File

@@ -823,7 +823,7 @@ This list has this format:
"peerID": "16Uiu2HAmJb2e28qLXxT5kZxVUUoJt72EMzNGXB47RedcBafeDCBA",
"protocols": [
"/ipfs/id/1.0.0",
"/vac/waku/relay/2.0.0",
"/waku/relay/2.0.0",
"/ipfs/ping/1.0.0"
],
"addrs": [
@@ -846,7 +846,7 @@ This list has this format:
extern int waku_content_topic(char* applicationName, unsigned int applicationVersion, char* contentTopicName, char* encoding, WakuCallBack onOkCb){}
```
Create a content topic string according to [RFC 23](../../../informational/23/topics.md).
Create a content topic string according to [RFC 23](waku/informational/23/waku2-topics.md).
Parameters
@@ -861,7 +861,7 @@ Returns
`int` with a status code. Possible values:
- 0 - The operation was completed successfuly.
`onOkCb` will receive the content topic formatted according to [RFC 23](../../../informational/23/topics.md):
`onOkCb` will receive the content topic formatted according to [RFC 23](waku/informational/23/waku2-topics.md):
`/{application-name}/{version-of-the-application}/{content-topic-name}/{encoding}`
- 1 - The operation failed for any reason.
- 2 - The function is missing the `onOkCb` callback
@@ -872,7 +872,7 @@ Returns
extern int waku_pubsub_topic(char* name, char* encoding, WakuCallBack onOkCb){}
```
Create a pubsub topic string according to [RFC 23](../../../informational/23/topics.md).
Create a pubsub topic string according to [RFC 23](waku/informational/23/waku2-topics.md).
Parameters
@@ -885,7 +885,7 @@ Returns
`int` with a status code. Possible values:
- 0 - The operation was completed successfuly.
`onOkCb` will get populated with a pubsub topic formatted according to [RFC 23](../../../informational/23/topics.md):
`onOkCb` will get populated with a pubsub topic formatted according to [RFC 23](waku/informational/23/waku2-topics.md):
`/waku/2/{topic-name}/{encoding}`
- 1 - The operation failed for any reason.
- 2 - The function is missing the `onOkCb` callback
@@ -897,7 +897,7 @@ extern int waku_default_pubsub_topic(WakuCallBack onOkCb){}
```
Returns the default pubsub topic used for exchanging waku messages
defined in [RFC 10](../10/waku2.md).
defined in [RFC 10](waku/standards/core/10/waku2.md).
Parameters
@@ -923,7 +923,7 @@ Publish a message using Waku Relay.
Parameters
1. `char* messageJson`:
JSON string containing the [Waku Message](../14/message.md)
JSON string containing the [Waku Message](waku/standards/core/14/waku2-message.md)
as [`JsonMessage`](#jsonmessage-type).
2. `char* pubsubTopic`: pubsub topic on which to publish the message.
If `NULL`, it uses the default pubsub topic.
@@ -1028,7 +1028,8 @@ For Example:
extern int waku_relay_unsubscribe(char* topic, WakuCallBack onErrCb)
```
Closes the pubsub subscription to a pubsub topic. No more messages will be received
Closes the pubsub subscription to a pubsub topic.
No more messages will be received
from this pubsub topic.
Parameters
@@ -1077,7 +1078,7 @@ i.e `["pubsubTopic1", "pubsubTopic2"]`
extern int waku_filter_subscribe(char* filterJSON, char* peerID, int timeoutMs, WakuCallBack onOkCb, WakuCallBack onErrCb)
```
Creates a subscription to a filter full node matching a content filter..
Creates a subscription to a filter full node matching a content filter.
Parameters
@@ -1350,7 +1351,7 @@ Publish a message using Waku Lightpush.
Parameters
1. `char* messageJson`:
JSON string containing the [Waku Message](../14/message.md) as [`JsonMessage`](#jsonmessage-type).
JSON string containing the [Waku Message](waku/standards/core/14/waku2-message.md) as [`JsonMessage`](#jsonmessage-type).
2. `char* pubsubTopic`: pubsub topic on which to publish the message.
If `NULL`, it uses the default pubsub topic.
3. `char* peerID`: Peer ID supporting the lightpush protocol.
@@ -1465,7 +1466,7 @@ Encrypt a message using symmetric encryption and optionally sign the message
Parameters
1. `char* messageJson`:
JSON string containing the [Waku Message](../14/message.md) as [`JsonMessage`](#jsonmessage-type).
JSON string containing the [Waku Message](waku/standards/core/14/waku2-message.md) as [`JsonMessage`](#jsonmessage-type).
2. `char* symmetricKey`: hex encoded secret key to be used for encryption.
3. `char* optionalSigningKey`: hex encoded private key to be used to sign the message.
4. `WakuCallBack onOkCb`: callback to be executed if the function is succesful
@@ -1495,7 +1496,7 @@ Encrypt a message using asymmetric encryption and optionally sign the message
Parameters
1. `char* messageJson`:
JSON string containing the [Waku Message](../14/message.md) as [`JsonMessage`](#jsonmessage-type).
JSON string containing the [Waku Message](waku/standards/core/14/waku2-message.md) as [`JsonMessage`](#jsonmessage-type).
2. `char* publicKey`: hex encoded public key to be used for encryption.
3. `char* optionalSigningKey`: hex encoded private key to be used to sign the message.
4. `WakuCallBack onOkCb`: callback to be executed if the function is succesful
@@ -1527,7 +1528,7 @@ Decrypt a message using a symmetric key
Parameters
1. `char* messageJson`:
JSON string containing the [Waku Message](../14/message.md) as [`JsonMessage`](#jsonmessage-type).
JSON string containing the [Waku Message](waku/standards/core/14/waku2-message.md) as [`JsonMessage`](#jsonmessage-type).
2. `char* symmetricKey`: 32 byte symmetric key hex encoded.
3. `WakuCallBack onOkCb`: callback to be executed if the function is succesful
4. `WakuCallBack onErrCb`: callback to be executed if the function fails
@@ -1565,7 +1566,7 @@ Decrypt a message using a secp256k1 private key
Parameters
1. `char* messageJson`:
JSON string containing the [Waku Message](../14/message.md) as [`JsonMessage`](#jsonmessage-type).
JSON string containing the [Waku Message](waku/standards/core/14/waku2-message.md) as [`JsonMessage`](#jsonmessage-type).
2. `char* privateKey`: secp256k1 private key hex encoded.
3. `WakuCallBack onOkCb`: callback to be executed if the function is succesful
4. `WakuCallBack onErrCb`: callback to be executed if the function fails