@waku/enr 0.0.17 → 0.0.19-a42b7be.0

package/dist/relay_shard_codec.js

@@ -0,0 +1,54 @@
+export const decodeRelayShard = (bytes) => {
+    // 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) => {
+    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);
+};
+//# sourceMappingURL=relay_shard_codec.js.map

package/dist/relay_shard_codec.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"relay_shard_codec.js","sourceRoot":"","sources":["../src/relay_shard_codec.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,KAAiB,EAAa,EAAE;IAC/D,sDAAsD;IACtD,kDAAkD;IAClD,KAAK,GAAG,IAAI,UAAU,CAAC,KAAK,CAAC,CAAC;IAE9B,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAE3D,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IACxC,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAElC,MAAM,SAAS,GAAG,EAAE,CAAC;IAErB,IAAI,KAAK,CAAC,MAAM,KAAK,GAAG,EAAE;QACxB,0BAA0B;QAC1B,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,wCAAwC;YACjF,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7B,IAAI,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,EAAE;gBAC9C,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;aACnB;SACF;KACF;SAAM;QACL,yBAAyB;QACzB,MAAM,UAAU,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;QACpC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,CAAC,EAAE;YAC5D,IAAI,MAAM,GAAG,CAAC,IAAI,KAAK,CAAC,MAAM;gBAAE,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;YAC1E,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC;SACxC;KACF;IAED,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,CAAC;AAChC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAoB,EAAc,EAAE;IACnE,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IACzC,MAAM,WAAW,GAAG,SAAS,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,MAAM,CAAC;IAC5E,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,QAAQ,CAAC,MAAM,CAAC,CAAC;IAElC,IAAI,CAAC,SAAS,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAE3B,IAAI,SAAS,CAAC,MAAM,IAAI,EAAE,EAAE;QAC1B,0BAA0B;QAC1B,KAAK,MAAM,KAAK,IAAI,SAAS,EAAE;YAC7B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,wCAAwC;YACrF,MAAM,QAAQ,GAAG,CAAC,GAAG,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;YACjC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;SACtE;KACF;SAAM;QACL,yBAAyB;QACzB,IAAI,CAAC,QAAQ,CAAC,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;QACnC,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,MAAM,IAAI,CAAC,EAAE;YAClE,IAAI,CAAC,SAAS,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC,CAAC,CAAC;SACtC;KACF;IAED,OAAO,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC,CAAC"}

package/package.json

@@ -1,100 +1 @@
-{
-  "name": "@waku/enr",
-  "version": "0.0.17",
-  "description": "ENR (EIP-778) for Waku",
-  "types": "./dist/index.d.ts",
-  "module": "./dist/index.js",
-  "exports": {
-    ".": {
-      "types": "./dist/index.d.ts",
-      "import": "./dist/index.js"
-    }
-  },
-  "type": "module",
-  "author": "Waku Team",
-  "homepage": "https://github.com/waku-org/js-waku/tree/master/packages/enr#readme",
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/waku-org/js-waku.git"
-  },
-  "bugs": {
-    "url": "https://github.com/waku-org/js-waku/issues"
-  },
-  "license": "MIT OR Apache-2.0",
-  "keywords": [
-    "waku",
-    "decentralized",
-    "secure",
-    "communication",
-    "web3",
-    "ethereum",
-    "dapps",
-    "privacy"
-  ],
-  "scripts": {
-    "build": "run-s build:**",
-    "build:esm": "tsc",
-    "build:bundle": "rollup --config rollup.config.js",
-    "fix": "run-s fix:*",
-    "fix:lint": "eslint src *.js --fix",
-    "check": "run-s check:*",
-    "check:lint": "eslint src --ext .ts",
-    "check:spelling": "cspell \"{README.md,src/**/*.ts}\"",
-    "check:tsc": "tsc -p tsconfig.dev.json",
-    "test": "run-s test:*",
-    "test:node": "TS_NODE_PROJECT=./tsconfig.dev.json mocha",
-    "test:browser": "karma start karma.conf.cjs",
-    "prepublish": "npm run build",
-    "reset-hard": "git clean -dfx -e .idea && git reset --hard && npm i && npm run build"
-  },
-  "engines": {
-    "node": ">=16"
-  },
-  "dependencies": {
-    "@ethersproject/rlp": "^5.7.0",
-    "@libp2p/crypto": "^1.0.17",
-    "@libp2p/peer-id": "^3.0.2",
-    "@multiformats/multiaddr": "^12.0.0",
-    "@noble/secp256k1": "^1.7.1",
-    "@waku/utils": "0.0.11",
-    "debug": "^4.3.4",
-    "js-sha3": "^0.8.0"
-  },
-  "devDependencies": {
-    "@libp2p/peer-id-factory": "^3.0.3",
-    "@rollup/plugin-commonjs": "^25.0.4",
-    "@rollup/plugin-json": "^6.0.0",
-    "@rollup/plugin-node-resolve": "^15.1.0",
-    "@types/chai": "^4.3.5",
-    "@types/mocha": "^10.0.1",
-    "@waku/build-utils": "*",
-    "@waku/interfaces": "0.0.18",
-    "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",
-    "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",
-    "uint8arrays": "^4.0.4"
-  },
-  "typedoc": {
-    "entryPoint": "./src/index.ts"
-  },
-  "files": [
-    "dist",
-    "bundle",
-    "src/**/*.ts",
-    "!**/*.spec.*",
-    "!**/*.json",
-    "CHANGELOG.md",
-    "LICENSE",
-    "README.md"
-  ]
-}
+{"name":"@waku/enr","version":"0.0.19-a42b7be.0","description":"ENR (EIP-778) for Waku","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","author":"Waku Team","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/enr#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","decentralized","secure","communication","web3","ethereum","dapps","privacy"],"scripts":{"build":"run-s build:**","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:lint":"eslint src --ext .ts","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","check:tsc":"tsc -p tsconfig.dev.json","test":"run-s test:*","test:node":"TS_NODE_PROJECT=./tsconfig.dev.json mocha","test:browser":"karma start karma.conf.cjs","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=18"},"dependencies":{"@ethersproject/rlp":"^5.7.0","@libp2p/crypto":"^1.0.17","@libp2p/peer-id":"^3.0.3","@multiformats/multiaddr":"^12.0.0","@noble/secp256k1":"^1.7.1","@waku/utils":"0.0.13-a42b7be.0","debug":"^4.3.4","js-sha3":"^0.9.2"},"devDependencies":{"@libp2p/peer-id-factory":"^3.0.3","@rollup/plugin-commonjs":"^25.0.4","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.5","@types/mocha":"^10.0.1","@waku/build-utils":"*","@waku/interfaces":"0.0.20-a42b7be.0","chai":"^4.3.7","cspell":"^7.3.2","fast-check":"^3.13.1","mocha":"^10.2.0","npm-run-all":"^4.1.5","process":"^0.11.10","rollup":"^3.29.2","uint8arrays":"^4.0.4"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}

package/src/decoder.ts

@@ -1,11 +1,13 @@
 import * as RLP from "@ethersproject/rlp";
 import type { ENRKey, ENRValue } from "@waku/interfaces";
+import { Logger } from "@waku/utils";
 import { bytesToHex, bytesToUtf8, hexToBytes } from "@waku/utils/bytes";
-import { log } from "debug";
 import { fromString } from "uint8arrays/from-string";
 
 import { ENR } from "./enr.js";
 
+const log = new Logger("enr:decoder");
+
 export class EnrDecoder {
   static fromString(encoded: string): Promise<ENR> {
     if (!encoded.startsWith(ENR.RECORD_PREFIX)) {
@@ -30,7 +32,7 @@ async function fromValues(values: Uint8Array[]): Promise<ENR> {
     try {
       obj[bytesToUtf8(kvs[i])] = kvs[i + 1];
     } catch (e) {
-      log("Failed to decode ENR key to UTF-8, skipping it", kvs[i], e);
+      log.error("Failed to decode ENR key to UTF-8, skipping it", kvs[i], e);
     }
   }
   const _seq = decodeSeq(seq);

package/src/enr.ts

@@ -6,9 +6,10 @@ import type {
   ENRValue,
   IEnr,
   NodeId,
-  SequenceNumber
+  SequenceNumber,
+  ShardInfo
 } from "@waku/interfaces";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 
 import { ERR_INVALID_ID } from "./constants.js";
 import { keccak256, verifySignature } from "./crypto.js";
@@ -17,7 +18,7 @@ import { createPeerIdFromPublicKey } from "./peer_id.js";
 import { RawEnr } from "./raw_enr.js";
 import * as v4 from "./v4.js";
 
-const log = debug("waku:enr");
+const log = new Logger("enr");
 
 export enum TransportProtocol {
   TCP = "tcp",
@@ -46,7 +47,7 @@ export class ENR extends RawEnr implements IEnr {
         enr.peerId = await createPeerIdFromPublicKey(publicKey);
       }
     } catch (e) {
-      log("Could not calculate peer id for ENR", e);
+      log.error("Could not calculate peer id for ENR", e);
     }
 
     return enr;
@@ -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.warn("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);
+};