@waku/enr 0.0.20-7eb3375.0 → 0.0.21

package/package.json

@@ -1 +1,91 @@
-{"name":"@waku/enr","version":"0.0.20-7eb3375.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":"^2.0.8","@libp2p/peer-id":"^3.0.3","@multiformats/multiaddr":"^12.0.0","@noble/secp256k1":"^1.7.1","@waku/utils":"0.0.14-7eb3375.0","debug":"^4.3.4","js-sha3":"^0.9.2"},"devDependencies":{"@libp2p/peer-id-factory":"^3.0.3","@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^4.3.11","@types/mocha":"^10.0.1","@waku/build-utils":"*","@waku/interfaces":"0.0.21-7eb3375.0","chai":"^4.3.10","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"]}
+{
+  "name": "@waku/enr",
+  "version": "0.0.21",
+  "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": "NODE_ENV=test run-s test:*",
+    "test:node": "NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha",
+    "test:browser": "NODE_ENV=test 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": "^4.0.0",
+    "@libp2p/peer-id": "^4.0.4",
+    "@multiformats/multiaddr": "^12.0.0",
+    "@noble/secp256k1": "^1.7.1",
+    "@waku/utils": "0.0.15",
+    "debug": "^4.3.4",
+    "js-sha3": "^0.9.2"
+  },
+  "devDependencies": {
+    "@libp2p/peer-id-factory": "^4.0.5",
+    "@rollup/plugin-commonjs": "^25.0.7",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@types/chai": "^4.3.11",
+    "@types/mocha": "^10.0.6",
+    "@waku/build-utils": "*",
+    "@waku/interfaces": "0.0.22",
+    "chai": "^4.3.10",
+    "cspell": "^8.3.2",
+    "fast-check": "^3.15.1",
+    "mocha": "^10.3.0",
+    "npm-run-all": "^4.1.5",
+    "process": "^0.11.10",
+    "rollup": "^4.12.0",
+    "uint8arrays": "^5.0.1"
+  },
+  "files": [
+    "dist",
+    "bundle",
+    "src/**/*.ts",
+    "!**/*.spec.*",
+    "!**/*.json",
+    "CHANGELOG.md",
+    "LICENSE",
+    "README.md"
+  ]
+}

package/src/creator.ts

@@ -1,4 +1,4 @@
-import type { PeerId } from "@libp2p/interface/peer-id";
+import type { PeerId } from "@libp2p/interface";
 import type { ENRKey, ENRValue } from "@waku/interfaces";
 import { utf8ToBytes } from "@waku/utils/bytes";
 

package/src/enr.ts

@@ -1,5 +1,4 @@
-import type { PeerId } from "@libp2p/interface/peer-id";
-import type { PeerInfo } from "@libp2p/interface/peer-info";
+import type { PeerId, PeerInfo } from "@libp2p/interface";
 import type { Multiaddr } from "@multiformats/multiaddr";
 import type {
   ENRKey,
@@ -108,7 +107,12 @@ export class ENR extends RawEnr implements IEnr {
 
     const _multiaddrs = this.multiaddrs ?? [];
 
-    return multiaddrs.concat(_multiaddrs);
+    return multiaddrs.concat(_multiaddrs).map((ma) => {
+      if (this.peerId) {
+        return ma.encapsulate(`/p2p/${this.peerId.toString()}`);
+      }
+      return ma;
+    });
   }
 
   get peerInfo(): PeerInfo | undefined {
@@ -116,8 +120,7 @@ export class ENR extends RawEnr implements IEnr {
     if (!id) return;
     return {
       id,
-      multiaddrs: this.getAllLocationMultiaddrs(),
-      protocols: []
+      multiaddrs: this.getAllLocationMultiaddrs()
     };
   }
 

package/src/index.ts

@@ -5,4 +5,3 @@ 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/peer_id.ts

@@ -1,6 +1,6 @@
 import { unmarshalPrivateKey, unmarshalPublicKey } from "@libp2p/crypto/keys";
 import { supportedKeys } from "@libp2p/crypto/keys";
-import type { PeerId } from "@libp2p/interface/peer-id";
+import type { PeerId } from "@libp2p/interface";
 import { peerIdFromKeys } from "@libp2p/peer-id";
 
 export function createPeerIdFromPublicKey(

package/src/raw_enr.ts

@@ -10,11 +10,11 @@ import type {
   ShardInfo,
   Waku2
 } from "@waku/interfaces";
+import { decodeRelayShard } from "@waku/utils";
 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> {

package/dist/relay_shard_codec.d.ts

@@ -1,3 +0,0 @@
-import type { ShardInfo } from "@waku/interfaces";
-export declare const decodeRelayShard: (bytes: Uint8Array) => ShardInfo;
-export declare const encodeRelayShard: (shardInfo: ShardInfo) => Uint8Array;

package/dist/relay_shard_codec.js

@@ -1,54 +0,0 @@
-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

@@ -1 +0,0 @@
-{"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/src/relay_shard_codec.ts

@@ -1,60 +0,0 @@
-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);
-};