status-im
/
go-waku
mirror of https://github.com/status-im/go-waku.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

fix: optional parameters

This commit is contained in:
Richard Ramos 2022-05-11 14:13:28 -04:00
parent f7b117b3a8
commit 5b7d0daeea
No known key found for this signature in database
GPG Key ID: BD36D48BC9FFC88C
2 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

56
examples/android-kotlin/app/src/main/java/com/example/waku/Node.kt
View File

@ -151,9 +151,9 @@ fun Node.disconnect(peerID: String) {
/** /**
* Subscribe to a WakuRelay topic to receive messages * Subscribe to a WakuRelay topic to receive messages
* @param topic Pubsub topic to subscribe to. Use NULL for subscribing to the default pubsub topic * @param topic Pubsub topic to subscribe to. Use "" for subscribing to the default pubsub topic
*/ */
fun Node.relaySubscribe(topic: String? = null) { fun Node.relaySubscribe(topic: String = "") {
val response = Gowaku.relaySubscribe(topic) val response = Gowaku.relaySubscribe(topic)
handleResponse(response) handleResponse(response)
} }
@ -161,12 +161,12 @@ fun Node.relaySubscribe(topic: String? = null) {
/** /**
* Publish a message using waku relay * Publish a message using waku relay
* @param msg Message to broadcast * @param msg Message to broadcast
* @param topic Pubsub topic. Set to `null` to use the default pubsub topic * @param topic Pubsub topic. Set to "" to use the default pubsub topic
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
* @return message id * @return message id
*/ */
fun Node.relayPublish(msg: Message, topic: String? = null, ms: Long = 0): String { fun Node.relayPublish(msg: Message, topic: String = "", ms: Long = 0): String {
val jsonMsg = Json.encodeToString(msg) val jsonMsg = Json.encodeToString(msg)
val response = Gowaku.relayPublish(jsonMsg, topic, ms) val response = Gowaku.relayPublish(jsonMsg, topic, ms)
return handleResponse<String>(response) return handleResponse<String>(response)
@ -175,13 +175,13 @@ fun Node.relayPublish(msg: Message, topic: String? = null, ms: Long = 0): String
/** /**
* Publish a message using waku lightpush * Publish a message using waku lightpush
* @param msg Message to broadcast * @param msg Message to broadcast
* @param topic Pubsub topic. Set to `null` to use the default pubsub topic * @param topic Pubsub topic. Set to "" to use the default pubsub topic
* @param peerID ID of a peer supporting the lightpush protocol. Use NULL to automatically select a node * @param peerID ID of a peer supporting the lightpush protocol. Use "" to automatically select a node
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
* @return message id * @return message id
*/ */
fun Node.lightpushPublish(msg: Message, topic: String? = null, peerID: String? = null, ms: Long = 0): String { fun Node.lightpushPublish(msg: Message, topic: String = "", peerID: String = "", ms: Long = 0): String {
val jsonMsg = Json.encodeToString(msg) val jsonMsg = Json.encodeToString(msg)
val response = Gowaku.lightpushPublish(jsonMsg, topic, peerID, ms) val response = Gowaku.lightpushPublish(jsonMsg, topic, peerID, ms)
return handleResponse<String>(response) return handleResponse<String>(response)
@ -192,7 +192,7 @@ fun Node.lightpushPublish(msg: Message, topic: String? = null, peerID: String? =
* @param msg Message to broadcast * @param msg Message to broadcast
* @param publicKey Secp256k1 public key * @param publicKey Secp256k1 public key
* @param optionalSigningKey Optional secp256k1 private key for signing the message * @param optionalSigningKey Optional secp256k1 private key for signing the message
* @param topic Pubsub topic. Set to `null` to use the default pubsub topic * @param topic Pubsub topic. Set to "" to use the default pubsub topic
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
* @return message id * @return message id
@ -200,8 +200,8 @@ fun Node.lightpushPublish(msg: Message, topic: String? = null, peerID: String? =
fun Node.relayPublishEncodeAsymmetric( fun Node.relayPublishEncodeAsymmetric(
msg: Message, msg: Message,
publicKey: String, publicKey: String,
optionalSigningKey: String? = null, optionalSigningKey: String = "",
topic: String? = null, topic: String = "",
ms: Long = 0 ms: Long = 0
): String { ): String {
val jsonMsg = Json.encodeToString(msg) val jsonMsg = Json.encodeToString(msg)
@ -215,7 +215,7 @@ fun Node.relayPublishEncodeAsymmetric(
* @param msg Message to broadcast * @param msg Message to broadcast
* @param publicKey Secp256k1 public key * @param publicKey Secp256k1 public key
* @param optionalSigningKey Optional secp256k1 private key for signing the message * @param optionalSigningKey Optional secp256k1 private key for signing the message
* @param topic Pubsub topic. Set to `null` to use the default pubsub topic * @param topic Pubsub topic. Set to "" to use the default pubsub topic
* @param peerID ID of a peer supporting the lightpush protocol. Use NULL to automatically select a node * @param peerID ID of a peer supporting the lightpush protocol. Use NULL to automatically select a node
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
@ -224,9 +224,9 @@ fun Node.relayPublishEncodeAsymmetric(
fun Node.lightpushPublishEncodeAsymmetric( fun Node.lightpushPublishEncodeAsymmetric(
msg: Message, msg: Message,
publicKey: String, publicKey: String,
optionalSigningKey: String? = null, optionalSigningKey: String = "",
topic: String? = null, topic: String = "",
peerID: String? = null, peerID: String = "",
ms: Long = 0 ms: Long = 0
): String { ): String {
val jsonMsg = Json.encodeToString(msg) val jsonMsg = Json.encodeToString(msg)
@ -240,7 +240,7 @@ fun Node.lightpushPublishEncodeAsymmetric(
* @param msg Message to broadcast * @param msg Message to broadcast
* @param symmetricKey 32 byte hex string containing a symmetric key * @param symmetricKey 32 byte hex string containing a symmetric key
* @param optionalSigningKey Optional secp256k1 private key for signing the message * @param optionalSigningKey Optional secp256k1 private key for signing the message
* @param topic Pubsub topic. Set to `null` to use the default pubsub topic * @param topic Pubsub topic. Set to "" to use the default pubsub topic
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
* @return message id * @return message id
@ -248,8 +248,8 @@ fun Node.lightpushPublishEncodeAsymmetric(
fun Node.relayPublishEncodeSymmetric( fun Node.relayPublishEncodeSymmetric(
msg: Message, msg: Message,
symmetricKey: String, symmetricKey: String,
optionalSigningKey: String? = null, optionalSigningKey: String = "",
topic: String? = null, topic: String = "",
ms: Long = 0 ms: Long = 0
): String { ): String {
val jsonMsg = Json.encodeToString(msg) val jsonMsg = Json.encodeToString(msg)
@ -263,8 +263,8 @@ fun Node.relayPublishEncodeSymmetric(
* @param msg Message to broadcast * @param msg Message to broadcast
* @param symmetricKey 32 byte hex string containing a symmetric key * @param symmetricKey 32 byte hex string containing a symmetric key
* @param optionalSigningKey Optional secp256k1 private key for signing the message * @param optionalSigningKey Optional secp256k1 private key for signing the message
* @param topic Pubsub topic. Set to `null` to use the default pubsub topic * @param topic Pubsub topic. Set to "" to use the default pubsub topic
* @param peerID ID of a peer supporting the lightpush protocol. Use NULL to automatically select a node * @param peerID ID of a peer supporting the lightpush protocol. Use "" to automatically select a node
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
* @return message id * @return message id
@ -272,9 +272,9 @@ fun Node.relayPublishEncodeSymmetric(
fun Node.lightpushPublishEncodeSymmetric( fun Node.lightpushPublishEncodeSymmetric(
msg: Message, msg: Message,
symmetricKey: String, symmetricKey: String,
optionalSigningKey: String? = null, optionalSigningKey: String = "",
topic: String? = null, topic: String = "",
peerID: String? = null, peerID: String = "",
ms: Long = 0 ms: Long = 0
): String { ): String {
val jsonMsg = Json.encodeToString(msg) val jsonMsg = Json.encodeToString(msg)
@ -285,19 +285,19 @@ fun Node.lightpushPublishEncodeSymmetric(
/** /**
* Determine if there are enough peers to publish a message on a topic * Determine if there are enough peers to publish a message on a topic
* @param topic pubsub topic to verify. Use NULL to verify the number of peers in the default pubsub topic * @param topic pubsub topic to verify. Use "" to verify the number of peers in the default pubsub topic
* @return boolean indicating if there are enough peers or not * @return boolean indicating if there are enough peers or not
*/ */
fun Node.relayEnoughPeers(topic: String? = null): Boolean { fun Node.relayEnoughPeers(topic: String = ""): Boolean {
val response = Gowaku.relayEnoughPeers(topic) val response = Gowaku.relayEnoughPeers(topic)
return handleResponse<Boolean>(response) return handleResponse<Boolean>(response)
} }
/** /**
* Closes the pubsub subscription to a pubsub topic * Closes the pubsub subscription to a pubsub topic
* @param topic Pubsub topic to unsubscribe. Use NULL for unsubscribe from the default pubsub topic * @param topic Pubsub topic to unsubscribe. Use "" for unsubscribe from the default pubsub topic
*/ */
fun Node.relayUnsubscribe(topic: String? = null) { fun Node.relayUnsubscribe(topic: String = "") {
val response = Gowaku.relayUnsubscribe(topic) val response = Gowaku.relayUnsubscribe(topic)
handleResponse(response) handleResponse(response)
} }
@ -314,12 +314,12 @@ fun Node.peers(): List<Peer> {
/** /**
* Query message history * Query message history
* @param query Query * @param query Query
* @param peerID PeerID to ask the history from. Use NULL to automatically select a peer * @param peerID PeerID to ask the history from. Use "" to automatically select a peer
* @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout * @param ms If ms is greater than 0, the broadcast of the message must happen before the timeout
* (in milliseconds) is reached, or an error will be returned * (in milliseconds) is reached, or an error will be returned
* @return Response containing the messages and cursor for pagination. Use the cursor in further queries to retrieve more results * @return Response containing the messages and cursor for pagination. Use the cursor in further queries to retrieve more results
*/ */
fun Node.storeQuery(query: StoreQuery, peerID: String?, ms: Long = 0): StoreResponse{ fun Node.storeQuery(query: StoreQuery, peerID: String = "", ms: Long = 0): StoreResponse{
val queryJSON = Json.encodeToString(query) val queryJSON = Json.encodeToString(query)
val response = Gowaku.storeQuery(queryJSON, peerID, ms) val response = Gowaku.storeQuery(queryJSON, peerID, ms)
return handleResponse<StoreResponse>(response) return handleResponse<StoreResponse>(response)

30
examples/swift-waku/swift-waku/WakuNode.swift
View File

@ -95,12 +95,12 @@ class WakuNode {
try handleResponse(response) try handleResponse(response)
} }
func relaySubscribe(_ topic: String? = nil) throws { func relaySubscribe(_ topic: String = "") throws {
let response = GowakuRelaySubscribe(topic) let response = GowakuRelaySubscribe(topic)
try handleResponse(response) try handleResponse(response)
} }
func relayPublish(_ msg: Message, _ topic: String? = nil, _ ms: Int = 0) throws -> String { func relayPublish(_ msg: Message, _ topic: String = "", _ ms: Int = 0) throws -> String {
let jsonEncoder = JSONEncoder() let jsonEncoder = JSONEncoder()
let jsonData = try! jsonEncoder.encode(msg) let jsonData = try! jsonEncoder.encode(msg)
let jsonMsg = String(data: jsonData, encoding: String.Encoding.utf8) let jsonMsg = String(data: jsonData, encoding: String.Encoding.utf8)
@ -108,7 +108,7 @@ class WakuNode {
return try handleResponse(response) return try handleResponse(response)
} }
func lightpushPublish(_ msg: Message, _ topic: String? = nil, _ peerID: String? = nil, _ ms: Int = 0) throws -> String { func lightpushPublish(_ msg: Message, _ topic: String = "", _ peerID: String = "", _ ms: Int = 0) throws -> String {
let jsonEncoder = JSONEncoder() let jsonEncoder = JSONEncoder()
let jsonData = try! jsonEncoder.encode(msg) let jsonData = try! jsonEncoder.encode(msg)
let jsonMsg = String(data: jsonData, encoding: String.Encoding.utf8) let jsonMsg = String(data: jsonData, encoding: String.Encoding.utf8)
@ -119,8 +119,8 @@ class WakuNode {
func relayPublishEncodeAsymmetric( func relayPublishEncodeAsymmetric(
_ msg: Message, _ msg: Message,
_ publicKey: String, _ publicKey: String,
_ optionalSigningKey: String? = nil, _ optionalSigningKey: String = "",
_ topic: String? = nil, _ topic: String = "",
_ ms: Int = 0 _ ms: Int = 0
) throws -> String { ) throws -> String {
let jsonEncoder = JSONEncoder() let jsonEncoder = JSONEncoder()
@ -133,9 +133,9 @@ class WakuNode {
func lightpushPublishEncodeAsymmetric( func lightpushPublishEncodeAsymmetric(
_ msg: Message, _ msg: Message,
_ publicKey: String, _ publicKey: String,
_ optionalSigningKey: String? = nil, _ optionalSigningKey: String = "",
_ topic: String? = nil, _ topic: String = "",
_ peerID: String? = nil, _ peerID: String = "",
_ ms: Int = 0 _ ms: Int = 0
) throws -> String { ) throws -> String {
let jsonEncoder = JSONEncoder() let jsonEncoder = JSONEncoder()
@ -148,8 +148,8 @@ class WakuNode {
func relayPublishEncodeSymmetric( func relayPublishEncodeSymmetric(
msg: Message, msg: Message,
symmetricKey: String, symmetricKey: String,
optionalSigningKey: String? = nil, optionalSigningKey: String = "",
topic: String? = nil, topic: String = "",
ms: Int = 0 ms: Int = 0
) throws -> String { ) throws -> String {
let jsonEncoder = JSONEncoder() let jsonEncoder = JSONEncoder()
@ -162,9 +162,9 @@ class WakuNode {
func lightpushPublishEncodeSymmetric( func lightpushPublishEncodeSymmetric(
_ msg: Message, _ msg: Message,
_ symmetricKey: String, _ symmetricKey: String,
_ optionalSigningKey: String? = nil, _ optionalSigningKey: String = "",
_ topic: String? = nil, _ topic: String = "",
_ peerID: String? = nil, _ peerID: String = "",
_ ms: Int = 0 _ ms: Int = 0
) throws -> String { ) throws -> String {
let jsonEncoder = JSONEncoder() let jsonEncoder = JSONEncoder()
@ -174,12 +174,12 @@ class WakuNode {
return try handleResponse(response) return try handleResponse(response)
} }
func relayEnoughPeers(_ topic: String? = nil) throws -> Bool { func relayEnoughPeers(_ topic: String = "") throws -> Bool {
let response = GowakuRelayEnoughPeers(topic) let response = GowakuRelayEnoughPeers(topic)
return try handleResponse(response) return try handleResponse(response)
} }
func relayUnsubscribe(_ topic: String? = nil) throws { func relayUnsubscribe(_ topic: String = "") throws {
let response = GowakuRelayUnsubscribe(topic) let response = GowakuRelayUnsubscribe(topic)
try handleResponse(response) try handleResponse(response)
} }