@waku/message-encryption 0.0.24-678635e.0 → 0.0.24

package/src/ecies.ts

@@ -1,39 +1,41 @@
-import { DefaultPubSubTopic } from "@waku/core";
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
-import { IMetaSetter, PubSubTopic } from "@waku/interfaces";
-import type {
-  EncoderOptions as BaseEncoderOptions,
-  IDecoder,
-  IEncoder,
-  IMessage,
-  IProtoMessage
+import {
+  type EncoderOptions as BaseEncoderOptions,
+  DefaultPubsubTopic,
+  type IDecoder,
+  type IEncoder,
+  type IMessage,
+  type IMetaSetter,
+  type IProtoMessage,
+  type PubsubTopic,
+  type SingleShardInfo
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
-import { Logger } from "@waku/utils";
+import { determinePubsubTopic, Logger } from "@waku/utils";
 
+import { generatePrivateKey } from "./crypto/utils.js";
 import { DecodedMessage } from "./decoded_message.js";
 import {
   decryptAsymmetric,
   encryptAsymmetric,
   postCipher,
   preCipher
-} from "./waku_payload.js";
-
-import {
-  generatePrivateKey,
-  getPublicKey,
-  OneMillion,
-  Version
-} from "./index.js";
+} from "./encryption.js";
+import { OneMillion, Version } from "./misc.js";
 
-export { generatePrivateKey, getPublicKey };
-export type { Encoder, Decoder, DecodedMessage };
+export {
+  decryptAsymmetric,
+  encryptAsymmetric,
+  postCipher,
+  preCipher,
+  generatePrivateKey
+};
 
 const log = new Logger("message-encryption:ecies");
 
 class Encoder implements IEncoder {
   constructor(
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public contentTopic: string,
     private publicKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -78,6 +80,10 @@ class Encoder implements IEncoder {
 }
 
 export interface EncoderOptions extends BaseEncoderOptions {
+  /**
+   * @deprecated
+   */
+  pubsubTopic?: PubsubTopic;
   /** The public key to encrypt the payload for. */
   publicKey: Uint8Array;
   /**  An optional private key to be used to sign the payload before encryption. */
@@ -97,7 +103,8 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubSubTopic,
+  pubsubTopic,
+  pubsubTopicShardInfo,
   contentTopic,
   publicKey,
   sigPrivKey,
@@ -105,7 +112,7 @@ export function createEncoder({
   metaSetter
 }: EncoderOptions): Encoder {
   return new Encoder(
-    pubsubTopic,
+    determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo),
     contentTopic,
     publicKey,
     sigPrivKey,
@@ -116,7 +123,7 @@ export function createEncoder({
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
   constructor(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     contentTopic: string,
     private privateKey: Uint8Array
   ) {
@@ -193,7 +200,11 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   privateKey: Uint8Array,
-  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+  pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
 ): Decoder {
-  return new Decoder(pubsubTopic, contentTopic, privateKey);
+  return new Decoder(
+    determinePubsubTopic(contentTopic, pubsubTopicShardInfo),
+    contentTopic,
+    privateKey
+  );
 }

package/src/{waku_payload.ts → encryption.ts}

@@ -1,12 +1,14 @@
 import * as secp from "@noble/secp256k1";
 import { concat, hexToBytes } from "@waku/utils/bytes";
 
-import { Symmetric } from "./constants.js";
-import * as ecies from "./crypto/ecies.js";
-import { keccak256, randomBytes, sign } from "./crypto/index.js";
-import * as symmetric from "./crypto/symmetric.js";
-
-import { Signature } from "./index.js";
+import {
+  ecies,
+  keccak256,
+  randomBytes,
+  sign,
+  symmetric
+} from "./crypto/index.js";
+import { Symmetric } from "./misc.js";
 
 const FlagsLength = 1;
 const FlagMask = 3; // 0011
@@ -210,6 +212,11 @@ export async function preCipher(
   return envelope;
 }
 
+type Signature = {
+  signature: Uint8Array;
+  publicKey: Uint8Array | undefined;
+};
+
 /**
  * Decode a decrypted payload.
  *

package/src/index.ts

@@ -5,17 +5,9 @@ import {
 } from "./crypto/index.js";
 import { DecodedMessage } from "./decoded_message.js";
 
-export const OneMillion = BigInt(1_000_000);
-
 export { generatePrivateKey, generateSymmetricKey, getPublicKey };
 export type { DecodedMessage };
 
 export * as ecies from "./ecies.js";
 export * as symmetric from "./symmetric.js";
-
-export const Version = 1;
-
-export type Signature = {
-  signature: Uint8Array;
-  publicKey: Uint8Array | undefined;
-};
+export * as crypto from "./crypto";

package/src/{constants.ts → misc.ts}

@@ -8,3 +8,7 @@ export const Symmetric = {
 export const Asymmetric = {
   keySize: 32
 };
+
+export const OneMillion = BigInt(1_000_000);
+
+export const Version = 1;

package/src/symmetric.ts

@@ -1,35 +1,41 @@
-import { DefaultPubSubTopic } from "@waku/core";
 import { Decoder as DecoderV0 } from "@waku/core/lib/message/version_0";
-import type {
-  EncoderOptions as BaseEncoderOptions,
-  IDecoder,
-  IEncoder,
-  IMessage,
-  IMetaSetter,
-  IProtoMessage,
-  PubSubTopic
+import {
+  type EncoderOptions as BaseEncoderOptions,
+  DefaultPubsubTopic,
+  type IDecoder,
+  type IEncoder,
+  type IMessage,
+  type IMetaSetter,
+  type IProtoMessage,
+  type PubsubTopic,
+  type SingleShardInfo
 } from "@waku/interfaces";
 import { WakuMessage } from "@waku/proto";
-import { Logger } from "@waku/utils";
+import { determinePubsubTopic, Logger } from "@waku/utils";
 
+import { generateSymmetricKey } from "./crypto/utils.js";
 import { DecodedMessage } from "./decoded_message.js";
 import {
   decryptSymmetric,
   encryptSymmetric,
   postCipher,
   preCipher
-} from "./waku_payload.js";
-
-import { generateSymmetricKey, OneMillion, Version } from "./index.js";
+} from "./encryption.js";
+import { OneMillion, Version } from "./misc.js";
 
-export { generateSymmetricKey };
-export type { DecodedMessage, Encoder, Decoder };
+export {
+  decryptSymmetric,
+  encryptSymmetric,
+  postCipher,
+  preCipher,
+  generateSymmetricKey
+};
 
 const log = new Logger("message-encryption:symmetric");
 
 class Encoder implements IEncoder {
   constructor(
-    public pubsubTopic: PubSubTopic,
+    public pubsubTopic: PubsubTopic,
     public contentTopic: string,
     private symKey: Uint8Array,
     private sigPrivKey?: Uint8Array,
@@ -93,7 +99,8 @@ export interface EncoderOptions extends BaseEncoderOptions {
  * in [26/WAKU2-PAYLOAD](https://rfc.vac.dev/spec/26/).
  */
 export function createEncoder({
-  pubsubTopic = DefaultPubSubTopic,
+  pubsubTopic = DefaultPubsubTopic,
+  pubsubTopicShardInfo,
   contentTopic,
   symKey,
   sigPrivKey,
@@ -101,7 +108,7 @@ export function createEncoder({
   metaSetter
 }: EncoderOptions): Encoder {
   return new Encoder(
-    pubsubTopic,
+    determinePubsubTopic(contentTopic, pubsubTopic ?? pubsubTopicShardInfo),
     contentTopic,
     symKey,
     sigPrivKey,
@@ -112,7 +119,7 @@ export function createEncoder({
 
 class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
   constructor(
-    pubsubTopic: PubSubTopic,
+    pubsubTopic: PubsubTopic,
     contentTopic: string,
     private symKey: Uint8Array
   ) {
@@ -189,7 +196,11 @@ class Decoder extends DecoderV0 implements IDecoder<DecodedMessage> {
 export function createDecoder(
   contentTopic: string,
   symKey: Uint8Array,
-  pubsubTopic: PubSubTopic = DefaultPubSubTopic
+  pubsubTopicShardInfo: SingleShardInfo | PubsubTopic = DefaultPubsubTopic
 ): Decoder {
-  return new Decoder(pubsubTopic, contentTopic, symKey);
+  return new Decoder(
+    determinePubsubTopic(contentTopic, pubsubTopicShardInfo),
+    contentTopic,
+    symKey
+  );
 }