@waku/sds 0.0.6-ced989a.0 → 0.0.6-e1212cc.0

package/dist/message_channel/events.js

@@ -1,4 +1,3 @@
-import { proto_sds_message } from "@waku/proto";
 export var MessageChannelEvent;
 (function (MessageChannelEvent) {
     MessageChannelEvent["OutMessageSent"] = "sds:out:message-sent";
@@ -9,142 +8,7 @@ export var MessageChannelEvent;
     MessageChannelEvent["InMessageMissing"] = "sds:in:message-missing";
     MessageChannelEvent["OutSyncSent"] = "sds:out:sync-sent";
     MessageChannelEvent["InSyncReceived"] = "sds:in:sync-received";
-    MessageChannelEvent["InMessageIrretrievablyLost"] = "sds:in:message-irretrievably-lost";
+    MessageChannelEvent["InMessageLost"] = "sds:in:message-irretrievably-lost";
     MessageChannelEvent["ErrorTask"] = "sds:error-task";
 })(MessageChannelEvent || (MessageChannelEvent = {}));
-export class Message {
-    messageId;
-    channelId;
-    senderId;
-    causalHistory;
-    lamportTimestamp;
-    bloomFilter;
-    content;
-    retrievalHint;
-    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
-    /**
-     * Not encoded, set after it is sent, used to include in follow-up messages
-     */
-    retrievalHint) {
-        this.messageId = messageId;
-        this.channelId = channelId;
-        this.senderId = senderId;
-        this.causalHistory = causalHistory;
-        this.lamportTimestamp = lamportTimestamp;
-        this.bloomFilter = bloomFilter;
-        this.content = content;
-        this.retrievalHint = retrievalHint;
-    }
-    encode() {
-        return proto_sds_message.SdsMessage.encode(this);
-    }
-    static decode(data) {
-        const { messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content } = proto_sds_message.SdsMessage.decode(data);
-        return new Message(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content);
-    }
-}
-export class SyncMessage extends Message {
-    messageId;
-    channelId;
-    senderId;
-    causalHistory;
-    lamportTimestamp;
-    bloomFilter;
-    content;
-    retrievalHint;
-    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
-    /**
-     * Not encoded, set after it is sent, used to include in follow-up messages
-     */
-    retrievalHint) {
-        super(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, retrievalHint);
-        this.messageId = messageId;
-        this.channelId = channelId;
-        this.senderId = senderId;
-        this.causalHistory = causalHistory;
-        this.lamportTimestamp = lamportTimestamp;
-        this.bloomFilter = bloomFilter;
-        this.content = content;
-        this.retrievalHint = retrievalHint;
-    }
-}
-export function isSyncMessage(message) {
-    return Boolean("lamportTimestamp" in message &&
-        typeof message.lamportTimestamp === "number" &&
-        (message.content === undefined || message.content.length === 0));
-}
-export class EphemeralMessage extends Message {
-    messageId;
-    channelId;
-    senderId;
-    causalHistory;
-    lamportTimestamp;
-    bloomFilter;
-    content;
-    retrievalHint;
-    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
-    /**
-     * Not encoded, set after it is sent, used to include in follow-up messages
-     */
-    retrievalHint) {
-        if (!content || !content.length) {
-            throw Error("Ephemeral Message must have content");
-        }
-        super(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, retrievalHint);
-        this.messageId = messageId;
-        this.channelId = channelId;
-        this.senderId = senderId;
-        this.causalHistory = causalHistory;
-        this.lamportTimestamp = lamportTimestamp;
-        this.bloomFilter = bloomFilter;
-        this.content = content;
-        this.retrievalHint = retrievalHint;
-    }
-}
-export function isEphemeralMessage(message) {
-    return Boolean(message.lamportTimestamp === undefined &&
-        "content" in message &&
-        message.content &&
-        message.content.length);
-}
-export class ContentMessage extends Message {
-    messageId;
-    channelId;
-    senderId;
-    causalHistory;
-    lamportTimestamp;
-    bloomFilter;
-    content;
-    retrievalHint;
-    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
-    /**
-     * Not encoded, set after it is sent, used to include in follow-up messages
-     */
-    retrievalHint) {
-        if (!content.length) {
-            throw Error("Content Message must have content");
-        }
-        super(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, retrievalHint);
-        this.messageId = messageId;
-        this.channelId = channelId;
-        this.senderId = senderId;
-        this.causalHistory = causalHistory;
-        this.lamportTimestamp = lamportTimestamp;
-        this.bloomFilter = bloomFilter;
-        this.content = content;
-        this.retrievalHint = retrievalHint;
-    }
-    static compare(a, b) {
-        if (a.lamportTimestamp !== b.lamportTimestamp) {
-            return a.lamportTimestamp - b.lamportTimestamp;
-        }
-        return a.messageId.localeCompare(b.messageId);
-    }
-}
-export function isContentMessage(message) {
-    return Boolean("lamportTimestamp" in message &&
-        typeof message.lamportTimestamp === "number" &&
-        message.content &&
-        message.content.length);
-}
 //# sourceMappingURL=events.js.map

package/dist/message_channel/events.js.map

@@ -1 +1 @@
-{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/message_channel/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAEhD,MAAM,CAAN,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,8DAAuC,CAAA;IACvC,sEAA+C,CAAA;IAC/C,oEAA6C,CAAA;IAC7C,8EAAuD,CAAA;IACvD,+FAAwE,CAAA;IACxE,kEAA2C,CAAA;IAC3C,wDAAiC,CAAA;IACjC,8DAAuC,CAAA;IACvC,uFAAgE,CAAA;IAChE,mDAA4B,CAAA;AAC9B,CAAC,EAXW,mBAAmB,KAAnB,mBAAmB,QAW9B;AAOD,MAAM,OAAO,OAAO;IAET;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAAqC,EACrC,WAAqD,EACrD,OAAiD;IACxD;;OAEG;IACI,aAAsC;QAVtC,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAqB;QACrC,gBAAW,GAAX,WAAW,CAA0C;QACrD,YAAO,GAAP,OAAO,CAA0C;QAIjD,kBAAa,GAAb,aAAa,CAAyB;IAC5C,CAAC;IAEG,MAAM;QACX,OAAO,iBAAiB,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,IAAgB;QACnC,MAAM,EACJ,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACR,GAAG,iBAAiB,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,OAAO,CAChB,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,OAAO;IAE7B;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAAwB,EACxB,WAAoD,EACpD,OAAkB;IACzB;;OAEG;IACI,aAAsC;QAE7C,KAAK,CACH,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,aAAa,CACd,CAAC;QArBK,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,gBAAW,GAAX,WAAW,CAAyC;QACpD,YAAO,GAAP,OAAO,CAAW;QAIlB,kBAAa,GAAb,aAAa,CAAyB;IAY/C,CAAC;CACF;AAED,MAAM,UAAU,aAAa,CAC3B,OAAkE;IAElE,OAAO,OAAO,CACZ,kBAAkB,IAAI,OAAO;QAC3B,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ;QAC5C,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAElC;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAA2B,EAC3B,WAAoD,EACpD,OAAoC;IAC3C;;OAEG;IACI,aAAsC;QAE7C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACrD,CAAC;QACD,KAAK,CACH,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,aAAa,CACd,CAAC;QAxBK,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAW;QAC3B,gBAAW,GAAX,WAAW,CAAyC;QACpD,YAAO,GAAP,OAAO,CAA6B;QAIpC,kBAAa,GAAb,aAAa,CAAyB;IAe/C,CAAC;CACF;AAED,MAAM,UAAU,kBAAkB,CAChC,OAAkE;IAElE,OAAO,OAAO,CACZ,OAAO,CAAC,gBAAgB,KAAK,SAAS;QACpC,SAAS,IAAI,OAAO;QACpB,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,OAAO,CAAC,MAAM,CACzB,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,cAAe,SAAQ,OAAO;IAEhC;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAAwB,EACxB,WAAoD,EACpD,OAAoC;IAC3C;;OAEG;IACI,aAAsC;QAE7C,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,CACH,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,aAAa,CACd,CAAC;QAxBK,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,gBAAW,GAAX,WAAW,CAAyC;QACpD,YAAO,GAAP,OAAO,CAA6B;QAIpC,kBAAa,GAAb,aAAa,CAAyB;IAe/C,CAAC;IAEM,MAAM,CAAC,OAAO,CAAC,CAAiB,EAAE,CAAiB;QACxD,IAAI,CAAC,CAAC,gBAAgB,KAAK,CAAC,CAAC,gBAAgB,EAAE,CAAC;YAC9C,OAAO,CAAC,CAAC,gBAAgB,GAAG,CAAC,CAAC,gBAAgB,CAAC;QACjD,CAAC;QACD,OAAO,CAAC,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC;IAChD,CAAC;CACF;AAED,MAAM,UAAU,gBAAgB,CAC9B,OAAiC;IAEjC,OAAO,OAAO,CACZ,kBAAkB,IAAI,OAAO;QAC3B,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ;QAC5C,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,OAAO,CAAC,MAAM,CACzB,CAAC;AACJ,CAAC"}
+{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/message_channel/events.ts"],"names":[],"mappings":"AAEA,MAAM,CAAN,IAAY,mBAWX;AAXD,WAAY,mBAAmB;IAC7B,8DAAuC,CAAA;IACvC,sEAA+C,CAAA;IAC/C,oEAA6C,CAAA;IAC7C,8EAAuD,CAAA;IACvD,+FAAwE,CAAA;IACxE,kEAA2C,CAAA;IAC3C,wDAAiC,CAAA;IACjC,8DAAuC,CAAA;IACvC,0EAAmD,CAAA;IACnD,mDAA4B,CAAA;AAC9B,CAAC,EAXW,mBAAmB,KAAnB,mBAAmB,QAW9B"}

package/dist/message_channel/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./command_queue.js";
 export * from "./events.js";
 export * from "./message_channel.js";
+export { ChannelId, ContentMessage, EphemeralMessage, HistoryEntry, Message, MessageId, SenderId, SyncMessage, isContentMessage, isEphemeralMessage, isSyncMessage } from "./message.js";

package/dist/message_channel/index.js

@@ -1,4 +1,5 @@
 export * from "./command_queue.js";
 export * from "./events.js";
 export * from "./message_channel.js";
+export { ContentMessage, EphemeralMessage, Message, SyncMessage, isContentMessage, isEphemeralMessage, isSyncMessage } from "./message.js";
 //# sourceMappingURL=index.js.map

package/dist/message_channel/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/message_channel/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/message_channel/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC;AACnC,cAAc,aAAa,CAAC;AAC5B,cAAc,sBAAsB,CAAC;AACrC,OAAO,EAEL,cAAc,EACd,gBAAgB,EAEhB,OAAO,EAGP,WAAW,EACX,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACd,MAAM,cAAc,CAAC"}

package/dist/message_channel/mem_local_history.d.ts

@@ -1,5 +1,4 @@
-import { ContentMessage } from "./events.js";
-import { SortedArrayBase } from "./sorted_array_base.js";
+import { ContentMessage } from "./message.js";
 /**
  * In-Memory implementation of a local store of messages.
  *
@@ -9,11 +8,12 @@ import { SortedArrayBase } from "./sorted_array_base.js";
  *
  * Only stores content message: `message.lamportTimestamp` and `message.content` are present.
  */
-export declare class MemLocalHistory extends SortedArrayBase<ContentMessage> {
-    protected getCompareFn(): (a: ContentMessage, b: ContentMessage) => number;
+export declare class MemLocalHistory {
+    private items;
+    get length(): number;
     push(...items: ContentMessage[]): number;
-    unshift(...items: ContentMessage[]): number;
-    fill(value: ContentMessage, start?: number, end?: number): ContentMessage[];
+    some(predicate: (value: ContentMessage, index: number, array: ContentMessage[]) => unknown, thisArg?: any): boolean;
+    slice(start?: number, end?: number): ContentMessage[];
+    find(predicate: (value: ContentMessage, index: number, obj: ContentMessage[]) => unknown, thisArg?: any): ContentMessage | undefined;
     private validateMessage;
-    private validateAndAddMessage;
 }

package/dist/message_channel/mem_local_history.js

@@ -1,5 +1,5 @@
-import { ContentMessage } from "./events.js";
-import { SortedArrayBase } from "./sorted_array_base.js";
+import _ from "lodash";
+import { isContentMessage } from "./message.js";
 /**
  * In-Memory implementation of a local store of messages.
  *
@@ -9,47 +9,33 @@ import { SortedArrayBase } from "./sorted_array_base.js";
  *
  * Only stores content message: `message.lamportTimestamp` and `message.content` are present.
  */
-export class MemLocalHistory extends SortedArrayBase {
-    getCompareFn() {
-        return ContentMessage.compare;
+export class MemLocalHistory {
+    items = [];
+    get length() {
+        return this.items.length;
     }
     push(...items) {
         for (const item of items) {
-            this.validateAndAddMessage(item);
+            this.validateMessage(item);
         }
-        this.sort();
+        // Add new items and ensure uniqueness by messageId using sortedUniqBy
+        // The valueOf() method on ContentMessage enables native < operator sorting
+        this.items = _.sortedUniqBy([...this.items, ...items], "messageId");
         return this.items.length;
     }
-    unshift(...items) {
-        for (const item of items) {
-            this.validateMessage(item);
-        }
-        const result = this.items.unshift(...items);
-        this.sort();
-        return result;
+    some(predicate, thisArg) {
+        return this.items.some(predicate, thisArg);
+    }
+    slice(start, end) {
+        return this.items.slice(start, end);
     }
-    fill(value, start, end) {
-        this.validateMessage(value);
-        this.items.fill(value, start, end);
-        this.sort();
-        return this.items;
+    find(predicate, thisArg) {
+        return this.items.find(predicate, thisArg);
     }
     validateMessage(message) {
-        if (!message.lamportTimestamp ||
-            !message.content ||
-            !message.content.length ||
-            !message.messageId) {
+        if (!isContentMessage(message)) {
             throw new Error("Message must have lamportTimestamp and content defined, sync and ephemeral messages cannot be stored");
         }
     }
-    validateAndAddMessage(newMessage) {
-        this.validateMessage(newMessage);
-        // Check if the entry is already present
-        const existingHistoryEntry = this.items.find(({ messageId }) => newMessage.messageId === messageId);
-        // If history entry is already present, no need to re-add
-        if (!existingHistoryEntry) {
-            this.items.push(newMessage);
-        }
-    }
 }
 //# sourceMappingURL=mem_local_history.js.map

package/dist/message_channel/mem_local_history.js.map

@@ -1 +1 @@
-{"version":3,"file":"mem_local_history.js","sourceRoot":"","sources":["../../src/message_channel/mem_local_history.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAgB,SAAQ,eAA+B;IACxD,YAAY;QACpB,OAAO,cAAc,CAAC,OAAO,CAAC;IAChC,CAAC;IAEM,IAAI,CAAC,GAAG,KAAuB;QACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACnC,CAAC;QACD,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAEM,OAAO,CAAC,GAAG,KAAuB;QACvC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QACD,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,KAAK,CAAC,CAAC;QAC5C,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,MAAM,CAAC;IAChB,CAAC;IAEM,IAAI,CACT,KAAqB,EACrB,KAAc,EACd,GAAY;QAEZ,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;QAC5B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,EAAE,CAAC;QACZ,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,eAAe,CAAC,OAAuB;QAC7C,IACE,CAAC,OAAO,CAAC,gBAAgB;YACzB,CAAC,OAAO,CAAC,OAAO;YAChB,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM;YACvB,CAAC,OAAO,CAAC,SAAS,EAClB,CAAC;YACD,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;QACJ,CAAC;IACH,CAAC;IAEO,qBAAqB,CAAC,UAA0B;QACtD,IAAI,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC;QAEjC,wCAAwC;QACxC,MAAM,oBAAoB,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAC1C,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,CAAC,UAAU,CAAC,SAAS,KAAK,SAAS,CACtD,CAAC;QAEF,yDAAyD;QACzD,IAAI,CAAC,oBAAoB,EAAE,CAAC;YAC1B,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9B,CAAC;IACH,CAAC;CACF"}
+{"version":3,"file":"mem_local_history.js","sourceRoot":"","sources":["../../src/message_channel/mem_local_history.ts"],"names":[],"mappings":"AAAA,OAAO,CAAC,MAAM,QAAQ,CAAC;AAEvB,OAAO,EAAkB,gBAAgB,EAAE,MAAM,cAAc,CAAC;AAEhE;;;;;;;;GAQG;AACH,MAAM,OAAO,eAAe;IAClB,KAAK,GAAqB,EAAE,CAAC;IAErC,IAAW,MAAM;QACf,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAEM,IAAI,CAAC,GAAG,KAAuB;QACpC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;QAC7B,CAAC;QAED,sEAAsE;QACtE,2EAA2E;QAC3E,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,YAAY,CAAC,CAAC,GAAG,IAAI,CAAC,KAAK,EAAE,GAAG,KAAK,CAAC,EAAE,WAAW,CAAC,CAAC;QAEpE,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;IAC3B,CAAC;IAEM,IAAI,CACT,SAIY,EACZ,OAAa;QAEb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEM,KAAK,CAAC,KAAc,EAAE,GAAY;QACvC,OAAO,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;IACtC,CAAC;IAEM,IAAI,CACT,SAIY,EACZ,OAAa;QAEb,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7C,CAAC;IAEO,eAAe,CAAC,OAAuB;QAC7C,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC;YAC/B,MAAM,IAAI,KAAK,CACb,sGAAsG,CACvG,CAAC;QACJ,CAAC;IACH,CAAC;CACF"}

package/dist/message_channel/message.d.ts

@@ -0,0 +1,83 @@
+import { proto_sds_message } from "@waku/proto";
+export type MessageId = string;
+export type HistoryEntry = proto_sds_message.HistoryEntry;
+export type ChannelId = string;
+export type SenderId = string;
+export declare class Message implements proto_sds_message.SdsMessage {
+    messageId: string;
+    channelId: string;
+    senderId: string;
+    causalHistory: proto_sds_message.HistoryEntry[];
+    lamportTimestamp?: number | undefined;
+    bloomFilter?: Uint8Array<ArrayBufferLike> | undefined;
+    content?: Uint8Array<ArrayBufferLike> | undefined;
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined;
+    constructor(messageId: string, channelId: string, senderId: string, causalHistory: proto_sds_message.HistoryEntry[], lamportTimestamp?: number | undefined, bloomFilter?: Uint8Array<ArrayBufferLike> | undefined, content?: Uint8Array<ArrayBufferLike> | undefined, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined);
+    encode(): Uint8Array;
+    static decode(data: Uint8Array): Message;
+}
+export declare class SyncMessage extends Message {
+    messageId: string;
+    channelId: string;
+    senderId: string;
+    causalHistory: proto_sds_message.HistoryEntry[];
+    lamportTimestamp: number;
+    bloomFilter: Uint8Array<ArrayBufferLike> | undefined;
+    content: undefined;
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined;
+    constructor(messageId: string, channelId: string, senderId: string, causalHistory: proto_sds_message.HistoryEntry[], lamportTimestamp: number, bloomFilter: Uint8Array<ArrayBufferLike> | undefined, content: undefined, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined);
+}
+export declare function isSyncMessage(message: Message | ContentMessage | SyncMessage | EphemeralMessage): message is SyncMessage;
+export declare class EphemeralMessage extends Message {
+    messageId: string;
+    channelId: string;
+    senderId: string;
+    causalHistory: proto_sds_message.HistoryEntry[];
+    lamportTimestamp: undefined;
+    bloomFilter: Uint8Array<ArrayBufferLike> | undefined;
+    content: Uint8Array<ArrayBufferLike>;
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined;
+    constructor(messageId: string, channelId: string, senderId: string, causalHistory: proto_sds_message.HistoryEntry[], lamportTimestamp: undefined, bloomFilter: Uint8Array<ArrayBufferLike> | undefined, content: Uint8Array<ArrayBufferLike>, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined);
+}
+export declare function isEphemeralMessage(message: Message | ContentMessage | SyncMessage | EphemeralMessage): message is EphemeralMessage;
+export declare class ContentMessage extends Message {
+    messageId: string;
+    channelId: string;
+    senderId: string;
+    causalHistory: proto_sds_message.HistoryEntry[];
+    lamportTimestamp: number;
+    bloomFilter: Uint8Array<ArrayBufferLike> | undefined;
+    content: Uint8Array<ArrayBufferLike>;
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined;
+    constructor(messageId: string, channelId: string, senderId: string, causalHistory: proto_sds_message.HistoryEntry[], lamportTimestamp: number, bloomFilter: Uint8Array<ArrayBufferLike> | undefined, content: Uint8Array<ArrayBufferLike>, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint?: Uint8Array | undefined);
+    valueOf(): string;
+}
+export declare function isContentMessage(message: Message | ContentMessage): message is ContentMessage;

package/dist/message_channel/message.js

@@ -0,0 +1,139 @@
+import { proto_sds_message } from "@waku/proto";
+export class Message {
+    messageId;
+    channelId;
+    senderId;
+    causalHistory;
+    lamportTimestamp;
+    bloomFilter;
+    content;
+    retrievalHint;
+    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint) {
+        this.messageId = messageId;
+        this.channelId = channelId;
+        this.senderId = senderId;
+        this.causalHistory = causalHistory;
+        this.lamportTimestamp = lamportTimestamp;
+        this.bloomFilter = bloomFilter;
+        this.content = content;
+        this.retrievalHint = retrievalHint;
+    }
+    encode() {
+        return proto_sds_message.SdsMessage.encode(this);
+    }
+    static decode(data) {
+        const { messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content } = proto_sds_message.SdsMessage.decode(data);
+        return new Message(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content);
+    }
+}
+export class SyncMessage extends Message {
+    messageId;
+    channelId;
+    senderId;
+    causalHistory;
+    lamportTimestamp;
+    bloomFilter;
+    content;
+    retrievalHint;
+    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint) {
+        super(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, retrievalHint);
+        this.messageId = messageId;
+        this.channelId = channelId;
+        this.senderId = senderId;
+        this.causalHistory = causalHistory;
+        this.lamportTimestamp = lamportTimestamp;
+        this.bloomFilter = bloomFilter;
+        this.content = content;
+        this.retrievalHint = retrievalHint;
+    }
+}
+export function isSyncMessage(message) {
+    return Boolean("lamportTimestamp" in message &&
+        typeof message.lamportTimestamp === "number" &&
+        (message.content === undefined || message.content.length === 0));
+}
+export class EphemeralMessage extends Message {
+    messageId;
+    channelId;
+    senderId;
+    causalHistory;
+    lamportTimestamp;
+    bloomFilter;
+    content;
+    retrievalHint;
+    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint) {
+        if (!content || !content.length) {
+            throw Error("Ephemeral Message must have content");
+        }
+        super(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, retrievalHint);
+        this.messageId = messageId;
+        this.channelId = channelId;
+        this.senderId = senderId;
+        this.causalHistory = causalHistory;
+        this.lamportTimestamp = lamportTimestamp;
+        this.bloomFilter = bloomFilter;
+        this.content = content;
+        this.retrievalHint = retrievalHint;
+    }
+}
+export function isEphemeralMessage(message) {
+    return Boolean(message.lamportTimestamp === undefined &&
+        "content" in message &&
+        message.content &&
+        message.content.length);
+}
+export class ContentMessage extends Message {
+    messageId;
+    channelId;
+    senderId;
+    causalHistory;
+    lamportTimestamp;
+    bloomFilter;
+    content;
+    retrievalHint;
+    constructor(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, 
+    /**
+     * Not encoded, set after it is sent, used to include in follow-up messages
+     */
+    retrievalHint) {
+        if (!content.length) {
+            throw Error("Content Message must have content");
+        }
+        super(messageId, channelId, senderId, causalHistory, lamportTimestamp, bloomFilter, content, retrievalHint);
+        this.messageId = messageId;
+        this.channelId = channelId;
+        this.senderId = senderId;
+        this.causalHistory = causalHistory;
+        this.lamportTimestamp = lamportTimestamp;
+        this.bloomFilter = bloomFilter;
+        this.content = content;
+        this.retrievalHint = retrievalHint;
+    }
+    // `valueOf` is used by comparison operands such as `<`
+    valueOf() {
+        // Create a sortable string representation that matches the compare logic
+        // Pad lamportTimestamp to ensure proper lexicographic ordering
+        // Use 16 digits to handle up to Number.MAX_SAFE_INTEGER (9007199254740991)
+        const paddedTimestamp = this.lamportTimestamp.toString().padStart(16, "0");
+        return `${paddedTimestamp}_${this.messageId}`;
+    }
+}
+export function isContentMessage(message) {
+    return Boolean("lamportTimestamp" in message &&
+        typeof message.lamportTimestamp === "number" &&
+        message.content &&
+        message.content.length);
+}
+//# sourceMappingURL=message.js.map

package/dist/message_channel/message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"message.js","sourceRoot":"","sources":["../../src/message_channel/message.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,aAAa,CAAC;AAOhD,MAAM,OAAO,OAAO;IAET;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAAqC,EACrC,WAAqD,EACrD,OAAiD;IACxD;;OAEG;IACI,aAAsC;QAVtC,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAqB;QACrC,gBAAW,GAAX,WAAW,CAA0C;QACrD,YAAO,GAAP,OAAO,CAA0C;QAIjD,kBAAa,GAAb,aAAa,CAAyB;IAC5C,CAAC;IAEG,MAAM;QACX,OAAO,iBAAiB,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACnD,CAAC;IAEM,MAAM,CAAC,MAAM,CAAC,IAAgB;QACnC,MAAM,EACJ,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACR,GAAG,iBAAiB,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAC9C,OAAO,IAAI,OAAO,CAChB,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,WAAY,SAAQ,OAAO;IAE7B;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAAwB,EACxB,WAAoD,EACpD,OAAkB;IACzB;;OAEG;IACI,aAAsC;QAE7C,KAAK,CACH,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,aAAa,CACd,CAAC;QArBK,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,gBAAW,GAAX,WAAW,CAAyC;QACpD,YAAO,GAAP,OAAO,CAAW;QAIlB,kBAAa,GAAb,aAAa,CAAyB;IAY/C,CAAC;CACF;AAED,MAAM,UAAU,aAAa,CAC3B,OAAkE;IAElE,OAAO,OAAO,CACZ,kBAAkB,IAAI,OAAO;QAC3B,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ;QAC5C,CAAC,OAAO,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,OAAO,CAAC,MAAM,KAAK,CAAC,CAAC,CAClE,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,gBAAiB,SAAQ,OAAO;IAElC;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAA2B,EAC3B,WAAoD,EACpD,OAAoC;IAC3C;;OAEG;IACI,aAAsC;QAE7C,IAAI,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YAChC,MAAM,KAAK,CAAC,qCAAqC,CAAC,CAAC;QACrD,CAAC;QACD,KAAK,CACH,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,aAAa,CACd,CAAC;QAxBK,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAW;QAC3B,gBAAW,GAAX,WAAW,CAAyC;QACpD,YAAO,GAAP,OAAO,CAA6B;QAIpC,kBAAa,GAAb,aAAa,CAAyB;IAe/C,CAAC;CACF;AAED,MAAM,UAAU,kBAAkB,CAChC,OAAkE;IAElE,OAAO,OAAO,CACZ,OAAO,CAAC,gBAAgB,KAAK,SAAS;QACpC,SAAS,IAAI,OAAO;QACpB,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,OAAO,CAAC,MAAM,CACzB,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,cAAe,SAAQ,OAAO;IAEhC;IACA;IACA;IACA;IACA;IACA;IACA;IAIA;IAXT,YACS,SAAiB,EACjB,SAAiB,EACjB,QAAgB,EAChB,aAA+C,EAC/C,gBAAwB,EACxB,WAAoD,EACpD,OAAoC;IAC3C;;OAEG;IACI,aAAsC;QAE7C,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;YACpB,MAAM,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACnD,CAAC;QACD,KAAK,CACH,SAAS,EACT,SAAS,EACT,QAAQ,EACR,aAAa,EACb,gBAAgB,EAChB,WAAW,EACX,OAAO,EACP,aAAa,CACd,CAAC;QAxBK,cAAS,GAAT,SAAS,CAAQ;QACjB,cAAS,GAAT,SAAS,CAAQ;QACjB,aAAQ,GAAR,QAAQ,CAAQ;QAChB,kBAAa,GAAb,aAAa,CAAkC;QAC/C,qBAAgB,GAAhB,gBAAgB,CAAQ;QACxB,gBAAW,GAAX,WAAW,CAAyC;QACpD,YAAO,GAAP,OAAO,CAA6B;QAIpC,kBAAa,GAAb,aAAa,CAAyB;IAe/C,CAAC;IAED,uDAAuD;IAChD,OAAO;QACZ,yEAAyE;QACzE,+DAA+D;QAC/D,2EAA2E;QAC3E,MAAM,eAAe,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAC;QAC3E,OAAO,GAAG,eAAe,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;IAChD,CAAC;CACF;AAED,MAAM,UAAU,gBAAgB,CAC9B,OAAiC;IAEjC,OAAO,OAAO,CACZ,kBAAkB,IAAI,OAAO;QAC3B,OAAO,OAAO,CAAC,gBAAgB,KAAK,QAAQ;QAC5C,OAAO,CAAC,OAAO;QACf,OAAO,CAAC,OAAO,CAAC,MAAM,CACzB,CAAC;AACJ,CAAC"}

package/dist/message_channel/message_channel.d.ts

@@ -1,5 +1,6 @@
 import { TypedEventEmitter } from "@libp2p/interface";
-import { type ChannelId, ContentMessage, type HistoryEntry, Message, MessageChannelEvents, type MessageId, type SenderId, SyncMessage } from "./events.js";
+import { MessageChannelEvents } from "./events.js";
+import { ChannelId, ContentMessage, HistoryEntry, Message, MessageId, SenderId, SyncMessage } from "./message.js";
 export declare const DEFAULT_BLOOM_FILTER_OPTIONS: {
     capacity: number;
     errorRate: number;
@@ -13,7 +14,7 @@ export interface MessageChannelOptions {
      *
      * @default undefined because it is coupled to processTask calls frequency
      */
-    timeoutToMarkMessageIrretrievableMs?: number;
+    timeoutForLostMessagesMs?: number;
     /**
      * How many possible acks does it take to consider it a definitive ack.
      */
@@ -32,7 +33,7 @@ export declare class MessageChannel extends TypedEventEmitter<MessageChannelEven
     private timeReceived;
     private readonly causalHistorySize;
     private readonly possibleAcksThreshold;
-    private readonly timeoutToMarkMessageIrretrievableMs?;
+    private readonly timeoutForLostMessagesMs?;
     private tasks;
     private handlers;
     constructor(channelId: ChannelId, senderId: SenderId, options?: MessageChannelOptions, localHistory?: ILocalHistory);

package/dist/message_channel/message_channel.js

@@ -4,8 +4,9 @@ import { bytesToHex } from "@noble/hashes/utils";
 import { Logger } from "@waku/utils";
 import { DefaultBloomFilter } from "../bloom_filter/bloom.js";
 import { Command } from "./command_queue.js";
-import { ContentMessage, EphemeralMessage, isContentMessage, isEphemeralMessage, isSyncMessage, MessageChannelEvent, SyncMessage } from "./events.js";
+import { MessageChannelEvent } from "./events.js";
 import { MemLocalHistory } from "./mem_local_history.js";
+import { ContentMessage, EphemeralMessage, isContentMessage, isEphemeralMessage, isSyncMessage, SyncMessage } from "./message.js";
 export const DEFAULT_BLOOM_FILTER_OPTIONS = {
     capacity: 10000,
     errorRate: 0.001
@@ -25,7 +26,7 @@ export class MessageChannel extends TypedEventEmitter {
     timeReceived;
     causalHistorySize;
     possibleAcksThreshold;
-    timeoutToMarkMessageIrretrievableMs;
+    timeoutForLostMessagesMs;
     tasks = [];
     handlers = {
         [Command.Send]: async (params) => {
@@ -54,8 +55,7 @@ export class MessageChannel extends TypedEventEmitter {
         this.possibleAcksThreshold =
             options.possibleAcksThreshold ?? DEFAULT_POSSIBLE_ACKS_THRESHOLD;
         this.timeReceived = new Map();
-        this.timeoutToMarkMessageIrretrievableMs =
-            options.timeoutToMarkMessageIrretrievableMs;
+        this.timeoutForLostMessagesMs = options.timeoutForLostMessagesMs;
     }
     static getMessageId(payload) {
         return bytesToHex(sha256(payload));
@@ -199,11 +199,11 @@ export class MessageChannel extends TypedEventEmitter {
             log.info(this.senderId, message.messageId, "is missing dependencies", missingDependencies.map((ch) => ch.messageId));
             // Optionally, if a message has not been received after a predetermined amount of time,
             // its dependencies are marked as irretrievably lost (implicitly by removing it from the buffer without delivery)
-            if (this.timeoutToMarkMessageIrretrievableMs) {
+            if (this.timeoutForLostMessagesMs) {
                 const timeReceived = this.timeReceived.get(message.messageId);
                 if (timeReceived &&
-                    Date.now() - timeReceived > this.timeoutToMarkMessageIrretrievableMs) {
-                    this.safeSendEvent(MessageChannelEvent.InMessageIrretrievablyLost, {
+                    Date.now() - timeReceived > this.timeoutForLostMessagesMs) {
+                    this.safeSendEvent(MessageChannelEvent.InMessageLost, {
                         detail: Array.from(missingDependencies)
                     });
                     return { buffer, missing };