From 56c30059b22ddadd53ffd1707e0ffaece589f9c1 Mon Sep 17 00:00:00 2001 From: Franck Royer Date: Wed, 14 Jul 2021 16:51:04 +1000 Subject: [PATCH] Add comments on Waku Message Options --- src/lib/waku_message/index.ts | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/src/lib/waku_message/index.ts b/src/lib/waku_message/index.ts index 7a95e3234c..cf87a6c845 100644 --- a/src/lib/waku_message/index.ts +++ b/src/lib/waku_message/index.ts @@ -14,9 +14,23 @@ const DefaultVersion = 0; const dbg = debug('waku:message'); export interface Options { + /** + * Content topic to set on the message, defaults to {@link DefaultContentTopic} + * if not passed. + */ contentTopic?: string; + /** + * Timestamp to set on the message, defaults to now if not passed. + */ timestamp?: Date; + /** + * Public Key to use to encrypt the messages using ECIES (Asymmetric Encryption). + */ encPublicKey?: Uint8Array | string; + /** + * Private key to use to sign the message, `encPublicKey` must be provided as only + * encrypted messages are signed. + */ sigPrivKey?: Uint8Array; }