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

Fix documentation

This commit is contained in:
Franck Royer 2021-09-01 12:35:55 +10:00
parent 931a414a3c
commit f4cae60ef8
No known key found for this signature in database
GPG Key ID: A82ED75A8DFC50A4
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/lib/waku_relay/index.ts
View File

@ -65,9 +65,6 @@ export class WakuRelay extends Gossipsub {
heartbeat: RelayHeartbeat;
pubSubTopic: string;
/**
* Decryption private keys to use to attempt decryption of incoming messages.
*/
public decryptionKeys: Set<Uint8Array>;
/**
@ -125,10 +122,10 @@ export class WakuRelay extends Gossipsub {
}
/**
* Register a decryption private key or symmetric key to attempt decryption
* of messages received on the given content topic. This can either be a
* private key for asymmetric encryption or a symmetric key. Waku relay will
* attempt to decrypt messages using both methods.
* Register a decryption key to attempt decryption of received messages.
* This can either be a private key for asymmetric encryption or a symmetric
* key. `WakuRelay` will attempt to decrypt messages using both methods.
*
* Strings must be in hex format.
*/
addDecryptionKey(key: Uint8Array | string): void {
@ -136,8 +133,9 @@ export class WakuRelay extends Gossipsub {
}
/**
* Delete a decryption key to attempt decryption of messages received on the
* given content topic.
* Delete a decryption key that was used to attempt decryption of received
* messages.
*
* Strings must be in hex format.
*/
deleteDecryptionKey(key: Uint8Array | string): void {