@waku/enr 0.0.4 → 0.0.6

package/dist/raw_enr.js

@@ -0,0 +1,142 @@
+import { convertToBytes, convertToString, } from "@multiformats/multiaddr/convert";
+import { bytesToUtf8 } from "@waku/utils/bytes";
+import { ERR_INVALID_ID } from "./constants.js";
+import { decodeMultiaddrs, encodeMultiaddrs } from "./multiaddrs_codec.js";
+import { decodeWaku2, encodeWaku2 } from "./waku2_codec.js";
+export class RawEnr extends Map {
+    constructor(kvs = {}, seq = BigInt(1), signature) {
+        super(Object.entries(kvs));
+        this.seq = seq;
+        this.signature = signature;
+    }
+    set(k, v) {
+        this.signature = undefined;
+        this.seq++;
+        return super.set(k, v);
+    }
+    get id() {
+        const id = this.get("id");
+        if (!id)
+            throw new Error("id not found.");
+        return bytesToUtf8(id);
+    }
+    get publicKey() {
+        switch (this.id) {
+            case "v4":
+                return this.get("secp256k1");
+            default:
+                throw new Error(ERR_INVALID_ID);
+        }
+    }
+    get ip() {
+        return getStringValue(this, "ip", "ip4");
+    }
+    set ip(ip) {
+        setStringValue(this, "ip", "ip4", ip);
+    }
+    get tcp() {
+        return getNumberAsStringValue(this, "tcp", "tcp");
+    }
+    set tcp(port) {
+        setNumberAsStringValue(this, "tcp", "tcp", port);
+    }
+    get udp() {
+        return getNumberAsStringValue(this, "udp", "udp");
+    }
+    set udp(port) {
+        setNumberAsStringValue(this, "udp", "udp", port);
+    }
+    get ip6() {
+        return getStringValue(this, "ip6", "ip6");
+    }
+    set ip6(ip) {
+        setStringValue(this, "ip6", "ip6", ip);
+    }
+    get tcp6() {
+        return getNumberAsStringValue(this, "tcp6", "tcp");
+    }
+    set tcp6(port) {
+        setNumberAsStringValue(this, "tcp6", "tcp", port);
+    }
+    get udp6() {
+        return getNumberAsStringValue(this, "udp6", "udp");
+    }
+    set udp6(port) {
+        setNumberAsStringValue(this, "udp6", "udp", port);
+    }
+    /**
+     * Get the `multiaddrs` field from ENR.
+     *
+     * This field is used to store multiaddresses that cannot be stored with the current ENR pre-defined keys.
+     * These can be a multiaddresses that include encapsulation (e.g. wss) or do not use `ip4` nor `ip6` for the host
+     * address (e.g. `dns4`, `dnsaddr`, etc)..
+     *
+     * If the peer information only contains information that can be represented with the ENR pre-defined keys
+     * (ip, tcp, etc) then the usage of { @link ENR.getLocationMultiaddr } should be preferred.
+     *
+     * The multiaddresses stored in this field are expected to be location multiaddresses, ie, peer id less.
+     */
+    get multiaddrs() {
+        const raw = this.get("multiaddrs");
+        if (raw)
+            return decodeMultiaddrs(raw);
+        return;
+    }
+    /**
+     * Set the `multiaddrs` field on the ENR.
+     *
+     * This field is used to store multiaddresses that cannot be stored with the current ENR pre-defined keys.
+     * These can be a multiaddresses that include encapsulation (e.g. wss) or do not use `ip4` nor `ip6` for the host
+     * address (e.g. `dns4`, `dnsaddr`, etc)..
+     *
+     * If the peer information only contains information that can be represented with the ENR pre-defined keys
+     * (ip, tcp, etc) then the usage of { @link ENR.setLocationMultiaddr } should be preferred.
+     * The multiaddresses stored in this field must be location multiaddresses,
+     * ie, without a peer id.
+     */
+    set multiaddrs(multiaddrs) {
+        deleteUndefined(this, "multiaddrs", multiaddrs, encodeMultiaddrs);
+    }
+    /**
+     * Get the `waku2` field from ENR.
+     */
+    get waku2() {
+        const raw = this.get("waku2");
+        if (raw)
+            return decodeWaku2(raw[0]);
+        return;
+    }
+    /**
+     * Set the `waku2` field on the ENR.
+     */
+    set waku2(waku2) {
+        deleteUndefined(this, "waku2", waku2, (w) => new Uint8Array([encodeWaku2(w)]));
+    }
+}
+function getStringValue(map, key, proto) {
+    const raw = map.get(key);
+    if (!raw)
+        return;
+    return convertToString(proto, raw);
+}
+function getNumberAsStringValue(map, key, proto) {
+    const raw = map.get(key);
+    if (!raw)
+        return;
+    return Number(convertToString(proto, raw));
+}
+function setStringValue(map, key, proto, value) {
+    deleteUndefined(map, key, value, convertToBytes.bind({}, proto));
+}
+function setNumberAsStringValue(map, key, proto, value) {
+    setStringValue(map, key, proto, value?.toString(10));
+}
+function deleteUndefined(map, key, value, transform) {
+    if (value !== undefined) {
+        map.set(key, transform(value));
+    }
+    else {
+        map.delete(key);
+    }
+}
+//# sourceMappingURL=raw_enr.js.map

package/dist/raw_enr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"raw_enr.js","sourceRoot":"","sources":["../src/raw_enr.ts"],"names":[],"mappings":"AACA,OAAO,EACL,cAAc,EACd,eAAe,GAChB,MAAM,iCAAiC,CAAC;AAEzC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAChD,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC3E,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE5D,MAAM,OAAO,MAAO,SAAQ,GAAqB;IAI/C,YACE,MAAgC,EAAE,EAClC,MAAsB,MAAM,CAAC,CAAC,CAAC,EAC/B,SAAsB;QAEtB,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;QAC3B,IAAI,CAAC,GAAG,GAAG,GAAG,CAAC;QACf,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,GAAG,CAAC,CAAS,EAAE,CAAW;QACxB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,GAAG,EAAE,CAAC;QACX,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,EAAE;QACJ,MAAM,EAAE,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,EAAE;YAAE,MAAM,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC;QAC1C,OAAO,WAAW,CAAC,EAAE,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,SAAS;QACX,QAAQ,IAAI,CAAC,EAAE,EAAE;YACf,KAAK,IAAI;gBACP,OAAO,IAAI,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC/B;gBACE,MAAM,IAAI,KAAK,CAAC,cAAc,CAAC,CAAC;SACnC;IACH,CAAC;IAED,IAAI,EAAE;QACJ,OAAO,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,EAAE,CAAC,EAAsB;QAC3B,cAAc,CAAC,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,GAAG;QACL,OAAO,sBAAsB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,GAAG,CAAC,IAAwB;QAC9B,sBAAsB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,GAAG;QACL,OAAO,sBAAsB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,GAAG,CAAC,IAAwB;QAC9B,sBAAsB,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACnD,CAAC;IAED,IAAI,GAAG;QACL,OAAO,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,IAAI,GAAG,CAAC,EAAsB;QAC5B,cAAc,CAAC,IAAI,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,IAAI;QACN,OAAO,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,IAAwB;QAC/B,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,IAAI;QACN,OAAO,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,IAAI,CAAC,IAAwB;QAC/B,sBAAsB,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IACpD,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,UAAU;QACZ,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;QAEnC,IAAI,GAAG;YAAE,OAAO,gBAAgB,CAAC,GAAG,CAAC,CAAC;QAEtC,OAAO;IACT,CAAC;IAED;;;;;;;;;;;OAWG;IACH,IAAI,UAAU,CAAC,UAAmC;QAChD,eAAe,CAAC,IAAI,EAAE,YAAY,EAAE,UAAU,EAAE,gBAAgB,CAAC,CAAC;IACpE,CAAC;IAED;;OAEG;IACH,IAAI,KAAK;QACP,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAC9B,IAAI,GAAG;YAAE,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC;QAEpC,OAAO;IACT,CAAC;IAED;;OAEG;IACH,IAAI,KAAK,CAAC,KAAwB;QAChC,eAAe,CACb,IAAI,EACJ,OAAO,EACP,KAAK,EACL,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,UAAU,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CACxC,CAAC;IACJ,CAAC;CACF;AAED,SAAS,cAAc,CACrB,GAA0B,EAC1B,GAAW,EACX,KAAa;IAEb,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,IAAI,CAAC,GAAG;QAAE,OAAO;IACjB,OAAO,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAA0B,EAC1B,GAAW,EACX,KAAa;IAEb,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACzB,IAAI,CAAC,GAAG;QAAE,OAAO;IACjB,OAAO,MAAM,CAAC,eAAe,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,cAAc,CACrB,GAA0B,EAC1B,GAAW,EACX,KAAa,EACb,KAAyB;IAEzB,eAAe,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,cAAc,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC,CAAC;AACnE,CAAC;AAED,SAAS,sBAAsB,CAC7B,GAA0B,EAC1B,GAAW,EACX,KAAa,EACb,KAAyB;IAEzB,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE,KAAK,EAAE,KAAK,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,eAAe,CACtB,GAAc,EACd,GAAM,EACN,KAAoB,EACpB,SAAsB;IAEtB,IAAI,KAAK,KAAK,SAAS,EAAE;QACvB,GAAG,CAAC,GAAG,CAAC,GAAG,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC;KAChC;SAAM;QACL,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;KACjB;AACH,CAAC"}

package/dist/v4.js

@@ -1,5 +1,5 @@
 import * as secp from "@noble/secp256k1";
-import { bytesToHex } from "@waku/byte-utils";
+import { bytesToHex } from "@waku/utils/bytes";
 import { keccak256 } from "./crypto.js";
 export async function sign(privKey, msg) {
     return secp.sign(keccak256(msg), privKey, {

package/dist/v4.js.map

@@ -1 +1 @@
-{"version":3,"file":"v4.js","sourceRoot":"","sources":["../src/v4.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAG9C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAExC,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,OAAmB,EACnB,GAAe;IAEf,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE;QACxC,GAAG,EAAE,KAAK;KACX,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAkB;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,kBAAkB,GAAG,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAEvD,OAAO,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,CAAC"}
+{"version":3,"file":"v4.js","sourceRoot":"","sources":["../src/v4.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,kBAAkB,CAAC;AAEzC,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAE/C,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACxC,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,OAAmB,EACnB,GAAe;IAEf,OAAO,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE;QACxC,GAAG,EAAE,KAAK;KACX,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,MAAM,CAAC,MAAkB;IACvC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC7C,MAAM,kBAAkB,GAAG,SAAS,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;IAEvD,OAAO,UAAU,CAAC,SAAS,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5D,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/enr",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "ENR (EIP-778) for Waku",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -37,7 +37,7 @@
     "build:bundle": "rollup --config rollup.config.js",
     "fix": "run-s fix:*",
     "fix:prettier": "prettier . --write",
-    "fix:lint": "eslint src --ext .ts --ext .cjs --fix",
+    "fix:lint": "eslint src *.js --fix",
     "check": "run-s check:*",
     "check:lint": "eslint src --ext .ts",
     "check:prettier": "prettier . --list-different",
@@ -53,38 +53,49 @@
     "node": ">=16"
   },
   "dependencies": {
-    "@ethersproject/rlp": "^5.5.0",
-    "@libp2p/crypto": "^1.0.4",
-    "@libp2p/interface-peer-id": "^1.0.2",
-    "@libp2p/peer-id": "^1.1.10",
-    "@multiformats/multiaddr": "^11.0.6",
-    "@noble/secp256k1": "^1.3.4",
-    "@waku/byte-utils": "*",
-    "chai": "^4.3.6",
+    "@ethersproject/rlp": "^5.7.0",
+    "@libp2p/crypto": "^1.0.14",
+    "@libp2p/peer-id": "^2.0.2",
+    "@multiformats/multiaddr": "^11.4.0",
+    "@noble/secp256k1": "^1.7.1",
+    "@waku/utils": "0.0.2",
     "debug": "^4.3.4",
     "js-sha3": "^0.8.0"
   },
   "devDependencies": {
-    "@waku/interfaces": "*",
-    "uint8arrays": "^4.0.2",
-    "@libp2p/peer-id-factory": "^1.0.15",
-    "@rollup/plugin-commonjs": "^22.0.0",
-    "@rollup/plugin-json": "^4.1.0",
-    "@rollup/plugin-node-resolve": "^13.3.0",
-    "@typescript-eslint/eslint-plugin": "^5.8.1",
-    "@typescript-eslint/parser": "^5.8.1",
-    "cspell": "^6.17.0",
-    "eslint": "^8.6.0",
-    "eslint-config-prettier": "^8.3.0",
+    "@libp2p/interface-peer-id": "^2.0.1",
+    "@libp2p/interface-peer-info": "^1.0.8",
+    "@libp2p/peer-id-factory": "^2.0.1",
+    "@rollup/plugin-commonjs": "^24.0.1",
+    "@rollup/plugin-json": "^6.0.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "@types/chai": "^4.3.4",
+    "@types/mocha": "^10.0.1",
+    "@typescript-eslint/eslint-plugin": "^5.54.1",
+    "@typescript-eslint/parser": "^5.51.0",
+    "@waku/build-utils": "*",
+    "@waku/interfaces": "0.0.8",
+    "chai": "^4.3.7",
+    "cspell": "^6.28.0",
+    "eslint": "^8.35.0",
+    "eslint-config-prettier": "^8.6.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
-    "eslint-plugin-functional": "^4.0.2",
-    "eslint-plugin-import": "^2.25.3",
-    "eslint-plugin-prettier": "^4.0.0",
+    "eslint-plugin-functional": "^5.0.4",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-prettier": "^4.2.1",
+    "karma": "^6.4.1",
+    "karma-chrome-launcher": "^3.1.1",
+    "karma-mocha": "^2.0.1",
+    "karma-webpack": "^5.0.0",
+    "mocha": "^10.2.0",
     "npm-run-all": "^4.1.5",
-    "prettier": "^2.1.1",
-    "rollup": "^2.75.0",
-    "ts-loader": "^9.4.1",
-    "typescript": "^4.6.3"
+    "prettier": "^2.8.4",
+    "process": "^0.11.10",
+    "puppeteer": "^19.7.2",
+    "rollup": "^3.15.0",
+    "ts-loader": "^9.4.2",
+    "typescript": "^4.9.5",
+    "uint8arrays": "^4.0.3"
   },
   "typedoc": {
     "entryPoint": "./src/index.ts"

package/src/creator.ts

@@ -0,0 +1,36 @@
+import { PeerId } from "@libp2p/interface-peer-id";
+import type { ENRKey, ENRValue } from "@waku/interfaces";
+import { utf8ToBytes } from "@waku/utils/bytes";
+
+import { compressPublicKey } from "./crypto.js";
+import { ENR } from "./enr.js";
+import { getPublicKeyFromPeerId } from "./peer_id.js";
+
+export class EnrCreator {
+  static fromPublicKey(
+    publicKey: Uint8Array,
+    kvs: Record<ENRKey, ENRValue> = {}
+  ): Promise<ENR> {
+    // EIP-778 specifies that the key must be in compressed format, 33 bytes
+    if (publicKey.length !== 33) {
+      publicKey = compressPublicKey(publicKey);
+    }
+    return ENR.create({
+      ...kvs,
+      id: utf8ToBytes("v4"),
+      secp256k1: publicKey,
+    });
+  }
+
+  static async fromPeerId(
+    peerId: PeerId,
+    kvs: Record<ENRKey, ENRValue> = {}
+  ): Promise<ENR> {
+    switch (peerId.type) {
+      case "secp256k1":
+        return EnrCreator.fromPublicKey(getPublicKeyFromPeerId(peerId), kvs);
+      default:
+        throw new Error();
+    }
+  }
+}

package/src/crypto.ts

@@ -1,15 +1,7 @@
 import * as secp from "@noble/secp256k1";
-import { concat } from "@waku/byte-utils";
+import { concat } from "@waku/utils/bytes";
 import sha3 from "js-sha3";
 
-export const randomBytes = secp.utils.randomBytes;
-
-/**
- * Return the public key for the given private key, to be used for asymmetric
- * encryption.
- */
-export const getPublicKey = secp.getPublicKey;
-
 /**
  * ECDSA Sign a message with the given private key.
  *

package/src/decoder.ts

@@ -0,0 +1,84 @@
+import * as RLP from "@ethersproject/rlp";
+import type { ENRKey, ENRValue } from "@waku/interfaces";
+import { bytesToHex, bytesToUtf8, hexToBytes } from "@waku/utils/bytes";
+import { log } from "debug";
+import { fromString } from "uint8arrays/from-string";
+
+import { ENR } from "./enr.js";
+
+export class EnrDecoder {
+  static fromString(encoded: string): Promise<ENR> {
+    if (!encoded.startsWith(ENR.RECORD_PREFIX)) {
+      throw new Error(
+        `"string encoded ENR must start with '${ENR.RECORD_PREFIX}'`
+      );
+    }
+    return EnrDecoder.fromRLP(fromString(encoded.slice(4), "base64url"));
+  }
+
+  static fromRLP(encoded: Uint8Array): Promise<ENR> {
+    const decoded = RLP.decode(encoded).map(hexToBytes);
+    return fromValues(decoded);
+  }
+}
+
+async function fromValues(values: Uint8Array[]): Promise<ENR> {
+  const { signature, seq, kvs } = checkValues(values);
+
+  const obj: Record<ENRKey, ENRValue> = {};
+  for (let i = 0; i < kvs.length; i += 2) {
+    try {
+      obj[bytesToUtf8(kvs[i])] = kvs[i + 1];
+    } catch (e) {
+      log("Failed to decode ENR key to UTF-8, skipping it", kvs[i], e);
+    }
+  }
+  const _seq = decodeSeq(seq);
+
+  const enr = await ENR.create(obj, _seq, signature);
+  checkSignature(seq, kvs, enr, signature);
+  return enr;
+}
+
+function decodeSeq(seq: Uint8Array): bigint {
+  // If seq is an empty array, translate as value 0
+  if (!seq.length) return BigInt(0);
+
+  return BigInt("0x" + bytesToHex(seq));
+}
+
+function checkValues(values: Uint8Array[]): {
+  signature: Uint8Array;
+  seq: Uint8Array;
+  kvs: Uint8Array[];
+} {
+  if (!Array.isArray(values)) {
+    throw new Error("Decoded ENR must be an array");
+  }
+  if (values.length % 2 !== 0) {
+    throw new Error("Decoded ENR must have an even number of elements");
+  }
+  const [signature, seq, ...kvs] = values;
+  if (!signature || Array.isArray(signature)) {
+    throw new Error("Decoded ENR invalid signature: must be a byte array");
+  }
+  if (!seq || Array.isArray(seq)) {
+    throw new Error(
+      "Decoded ENR invalid sequence number: must be a byte array"
+    );
+  }
+
+  return { signature, seq, kvs };
+}
+
+function checkSignature(
+  seq: Uint8Array,
+  kvs: Uint8Array[],
+  enr: ENR,
+  signature: Uint8Array
+): void {
+  const rlpEncodedBytes = hexToBytes(RLP.encode([seq, ...kvs]));
+  if (!enr.verify(rlpEncodedBytes, signature)) {
+    throw new Error("Unable to verify ENR signature");
+  }
+}

package/src/encoder.ts

@@ -0,0 +1,50 @@
+import * as RLP from "@ethersproject/rlp";
+import type { ENRKey, ENRValue } from "@waku/interfaces";
+import { hexToBytes, utf8ToBytes } from "@waku/utils/bytes";
+import { toString } from "uint8arrays/to-string";
+
+import { ERR_NO_SIGNATURE, MAX_RECORD_SIZE } from "./constants.js";
+import { ENR } from "./enr.js";
+
+export class EnrEncoder {
+  static async toValues(
+    enr: ENR,
+    privateKey?: Uint8Array
+  ): Promise<(ENRKey | ENRValue | number[])[]> {
+    // sort keys and flatten into [k, v, k, v, ...]
+    const content: Array<ENRKey | ENRValue | number[]> = Array.from(enr.keys())
+      .sort((a, b) => a.localeCompare(b))
+      .map((k) => [k, enr.get(k)] as [ENRKey, ENRValue])
+      .map(([k, v]) => [utf8ToBytes(k), v])
+      .flat();
+    content.unshift(new Uint8Array([Number(enr.seq)]));
+    if (privateKey) {
+      content.unshift(
+        await enr.sign(hexToBytes(RLP.encode(content)), privateKey)
+      );
+    } else {
+      if (!enr.signature) {
+        throw new Error(ERR_NO_SIGNATURE);
+      }
+      content.unshift(enr.signature);
+    }
+    return content;
+  }
+
+  static async toBytes(enr: ENR, privateKey?: Uint8Array): Promise<Uint8Array> {
+    const encoded = hexToBytes(
+      RLP.encode(await EnrEncoder.toValues(enr, privateKey))
+    );
+    if (encoded.length >= MAX_RECORD_SIZE) {
+      throw new Error("ENR must be less than 300 bytes");
+    }
+    return encoded;
+  }
+
+  static async toString(enr: ENR, privateKey?: Uint8Array): Promise<string> {
+    return (
+      ENR.RECORD_PREFIX +
+      toString(await EnrEncoder.toBytes(enr, privateKey), "base64url")
+    );
+  }
+}