@waku/enr 0.0.17 → 0.0.18

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/enr",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "ENR (EIP-778) for Waku",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -48,7 +48,7 @@
     "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
   },
   "engines": {
-    "node": ">=16"
+    "node": ">=18"
   },
   "dependencies": {
     "@ethersproject/rlp": "^5.7.0",
@@ -56,9 +56,9 @@
     "@libp2p/peer-id": "^3.0.2",
     "@multiformats/multiaddr": "^12.0.0",
     "@noble/secp256k1": "^1.7.1",
-    "@waku/utils": "0.0.11",
+    "@waku/utils": "0.0.12",
     "debug": "^4.3.4",
-    "js-sha3": "^0.8.0"
+    "js-sha3": "^0.9.2"
   },
   "devDependencies": {
     "@libp2p/peer-id-factory": "^3.0.3",
@@ -68,25 +68,16 @@
     "@types/chai": "^4.3.5",
     "@types/mocha": "^10.0.1",
     "@waku/build-utils": "*",
-    "@waku/interfaces": "0.0.18",
+    "@waku/interfaces": "0.0.19",
     "chai": "^4.3.7",
     "cspell": "^7.3.2",
-    "karma": "^6.4.1",
-    "karma-chrome-launcher": "^3.2.0",
-    "karma-mocha": "^2.0.1",
-    "karma-webpack": "^5.0.0",
+    "fast-check": "^3.13.1",
     "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
     "process": "^0.11.10",
-    "puppeteer": "^21.1.1",
-    "rollup": "^3.29.0",
-    "ts-loader": "^9.4.2",
-    "typescript": "^5.0.4",
+    "rollup": "^3.29.2",
     "uint8arrays": "^4.0.4"
   },
-  "typedoc": {
-    "entryPoint": "./src/index.ts"
-  },
   "files": [
     "dist",
     "bundle",

package/src/enr.ts

@@ -6,7 +6,8 @@ import type {
   ENRValue,
   IEnr,
   NodeId,
-  SequenceNumber
+  SequenceNumber,
+  ShardInfo
 } from "@waku/interfaces";
 import debug from "debug";
 
@@ -64,6 +65,13 @@ export class ENR extends RawEnr implements IEnr {
     protocol: TransportProtocol | TransportProtocolPerIpVersion
   ) => Multiaddr | undefined = locationMultiaddrFromEnrFields.bind({}, this);
 
+  get shardInfo(): ShardInfo | undefined {
+    if (this.rs && this.rsv) {
+      log("Warning: ENR contains both `rs` and `rsv` fields.");
+    }
+    return this.rs || this.rsv;
+  }
+
   setLocationMultiaddr(multiaddr: Multiaddr): void {
     const protoNames = multiaddr.protoNames();
     if (

package/src/index.ts

@@ -5,3 +5,4 @@ export * from "./enr.js";
 export * from "./peer_id.js";
 export * from "./waku2_codec.js";
 export * from "./crypto.js";
+export * from "./relay_shard_codec.js";

package/src/raw_enr.ts

@@ -3,11 +3,18 @@ import {
   convertToBytes,
   convertToString
 } from "@multiformats/multiaddr/convert";
-import type { ENRKey, ENRValue, SequenceNumber, Waku2 } from "@waku/interfaces";
+import type {
+  ENRKey,
+  ENRValue,
+  SequenceNumber,
+  ShardInfo,
+  Waku2
+} from "@waku/interfaces";
 import { bytesToUtf8 } from "@waku/utils/bytes";
 
 import { ERR_INVALID_ID } from "./constants.js";
 import { decodeMultiaddrs, encodeMultiaddrs } from "./multiaddrs_codec.js";
+import { decodeRelayShard } from "./relay_shard_codec.js";
 import { decodeWaku2, encodeWaku2 } from "./waku2_codec.js";
 
 export class RawEnr extends Map<ENRKey, ENRValue> {
@@ -45,6 +52,18 @@ export class RawEnr extends Map<ENRKey, ENRValue> {
     }
   }
 
+  get rs(): ShardInfo | undefined {
+    const rs = this.get("rs");
+    if (!rs) return undefined;
+    return decodeRelayShard(rs);
+  }
+
+  get rsv(): ShardInfo | undefined {
+    const rsv = this.get("rsv");
+    if (!rsv) return undefined;
+    return decodeRelayShard(rsv);
+  }
+
   get ip(): string | undefined {
     return getStringValue(this, "ip", "ip4");
   }

package/src/relay_shard_codec.ts

@@ -0,0 +1,60 @@
+import type { ShardInfo } from "@waku/interfaces";
+
+export const decodeRelayShard = (bytes: Uint8Array): ShardInfo => {
+  // explicitly converting to Uint8Array to avoid Buffer
+  // https://github.com/libp2p/js-libp2p/issues/2146
+  bytes = new Uint8Array(bytes);
+
+  if (bytes.length < 3) throw new Error("Insufficient data");
+
+  const view = new DataView(bytes.buffer);
+  const cluster = view.getUint16(0);
+
+  const indexList = [];
+
+  if (bytes.length === 130) {
+    // rsv format (Bit Vector)
+    for (let i = 0; i < 1024; i++) {
+      const byteIndex = Math.floor(i / 8) + 2; // Adjusted for the 2-byte cluster field
+      const bitIndex = 7 - (i % 8);
+      if (view.getUint8(byteIndex) & (1 << bitIndex)) {
+        indexList.push(i);
+      }
+    }
+  } else {
+    // rs format (Index List)
+    const numIndices = view.getUint8(2);
+    for (let i = 0, offset = 3; i < numIndices; i++, offset += 2) {
+      if (offset + 1 >= bytes.length) throw new Error("Unexpected end of data");
+      indexList.push(view.getUint16(offset));
+    }
+  }
+
+  return { cluster, indexList };
+};
+
+export const encodeRelayShard = (shardInfo: ShardInfo): Uint8Array => {
+  const { cluster, indexList } = shardInfo;
+  const totalLength = indexList.length >= 64 ? 130 : 3 + 2 * indexList.length;
+  const buffer = new ArrayBuffer(totalLength);
+  const view = new DataView(buffer);
+
+  view.setUint16(0, cluster);
+
+  if (indexList.length >= 64) {
+    // rsv format (Bit Vector)
+    for (const index of indexList) {
+      const byteIndex = Math.floor(index / 8) + 2; // Adjusted for the 2-byte cluster field
+      const bitIndex = 7 - (index % 8);
+      view.setUint8(byteIndex, view.getUint8(byteIndex) | (1 << bitIndex));
+    }
+  } else {
+    // rs format (Index List)
+    view.setUint8(2, indexList.length);
+    for (let i = 0, offset = 3; i < indexList.length; i++, offset += 2) {
+      view.setUint16(offset, indexList[i]);
+    }
+  }
+
+  return new Uint8Array(buffer);
+};