Merge pull request #2299 from waku-org/feat/sds-message-history

feat(sds): add retrieval hint to causal history

Author: adklempner

package-lock.json

@@ -7,11 +7,81 @@
 import { type Codec, decodeMessage, type DecodeOptions, encodeMessage, MaxLengthError, message } from 'protons-runtime'
 import type { Uint8ArrayList } from 'uint8arraylist'
 
+export interface HistoryEntry {
+  messageId: string
+  retrievalHint?: Uint8Array
+}
+
+export namespace HistoryEntry {
+  let _codec: Codec<HistoryEntry>
+
+  export const codec = (): Codec<HistoryEntry> => {
+    if (_codec == null) {
+      _codec = message<HistoryEntry>((obj, w, opts = {}) => {
+        if (opts.lengthDelimited !== false) {
+          w.fork()
+        }
+
+        if ((obj.messageId != null && obj.messageId !== '')) {
+          w.uint32(10)
+          w.string(obj.messageId)
+        }
+
+        if (obj.retrievalHint != null) {
+          w.uint32(18)
+          w.bytes(obj.retrievalHint)
+        }
+
+        if (opts.lengthDelimited !== false) {
+          w.ldelim()
+        }
+      }, (reader, length, opts = {}) => {
+        const obj: any = {
+          messageId: ''
+        }
+
+        const end = length == null ? reader.len : reader.pos + length
+
+        while (reader.pos < end) {
+          const tag = reader.uint32()
+
+          switch (tag >>> 3) {
+            case 1: {
+              obj.messageId = reader.string()
+              break
+            }
+            case 2: {
+              obj.retrievalHint = reader.bytes()
+              break
+            }
+            default: {
+              reader.skipType(tag & 7)
+              break
+            }
+          }
+        }
+
+        return obj
+      })
+    }
+
+    return _codec
+  }
+
+  export const encode = (obj: Partial<HistoryEntry>): Uint8Array => {
+    return encodeMessage(obj, HistoryEntry.codec())
+  }
+
+  export const decode = (buf: Uint8Array | Uint8ArrayList, opts?: DecodeOptions<HistoryEntry>): HistoryEntry => {
+    return decodeMessage(buf, HistoryEntry.codec(), opts)
+  }
+}
+
 export interface SdsMessage {
   messageId: string
   channelId: string
   lamportTimestamp?: number
-  causalHistory: string[]
+  causalHistory: HistoryEntry[]
   bloomFilter?: Uint8Array
   content?: Uint8Array
 }
@@ -44,7 +114,7 @@ export namespace SdsMessage {
         if (obj.causalHistory != null) {
           for (const value of obj.causalHistory) {
             w.uint32(90)
-            w.string(value)
+            HistoryEntry.codec().encode(value, w)
           }
         }
 
@@ -91,7 +161,9 @@ export namespace SdsMessage {
                 throw new MaxLengthError('Decode error - map field "causalHistory" had too many elements')
               }
 
-              obj.causalHistory.push(reader.string())
+              obj.causalHistory.push(HistoryEntry.codec().decode(reader, reader.uint32(), {
+                limits: opts.limits?.causalHistory$
+              }))
               break
             }
             case 12: {

packages/proto/src/generated/sds_message.ts

@@ -1,11 +1,16 @@
 syntax = "proto3";
 
+message HistoryEntry {
+  string message_id = 1; // Unique identifier of the SDS message, as defined in `Message`
+  optional bytes retrieval_hint = 2; // Optional information to help remote parties retrieve this SDS message; For example, A Waku deterministic message hash or routing payload hash
+}
+
 message SdsMessage {
   // 1 Reserved for sender/participant id
   string message_id = 2;          // Unique identifier of the message
   string channel_id = 3;          // Identifier of the channel to which the message belongs
   optional int32 lamport_timestamp = 10;    // Logical timestamp for causal ordering in channel
-  repeated string causal_history = 11;  // List of preceding message IDs that this message causally depends on. Generally 2 or 3 message IDs are included.
+  repeated HistoryEntry causal_history = 11;  // List of preceding message IDs that this message causally depends on. Generally 2 or 3 message IDs are included.
   optional bytes bloom_filter = 12;         // Bloom filter representing received message IDs in channel
   optional bytes content = 20;             // Actual content of the message
 }

packages/proto/src/lib/sds_message.proto

@@ -59,7 +59,7 @@
         "node": ">=20"
     },
     "dependencies": {
-        "@libp2p/interface": "^2.7.0",
+        "@libp2p/interface": "2.7.0",
         "@noble/hashes": "^1.7.1",
         "@waku/message-hash": "^0.1.18",
         "@waku/proto": "^0.0.9",