From 4639537fd64ac24f4bfa8715fe0d1362fecbdc3e Mon Sep 17 00:00:00 2001 From: Franck Royer Date: Wed, 18 May 2022 16:30:28 +1000 Subject: [PATCH] Ensure `ENR.create` is used instead of the constructor --- src/lib/discovery/fetch_nodes.spec.ts | 2 +- src/lib/enr/enr.node.spec.ts | 6 +-- src/lib/enr/enr.spec.ts | 62 +++++++++++++-------------- src/lib/enr/enr.ts | 16 +++---- 4 files changed, 43 insertions(+), 43 deletions(-) diff --git a/src/lib/discovery/fetch_nodes.spec.ts b/src/lib/discovery/fetch_nodes.spec.ts index 4e2c560e24..c6040332a9 100644 --- a/src/lib/discovery/fetch_nodes.spec.ts +++ b/src/lib/discovery/fetch_nodes.spec.ts @@ -8,7 +8,7 @@ import fetchNodesUntilCapabilitiesFulfilled from "./fetch_nodes"; async function createEnr(waku2: Waku2): Promise { const peerId = await PeerId.create({ keyType: "secp256k1" }); - const enr = ENR.createFromPeerId(peerId); + const enr = await ENR.createFromPeerId(peerId); enr.setLocationMultiaddr(new Multiaddr("/ip4/18.223.219.100/udp/9000")); enr.multiaddrs = [ new Multiaddr("/dns4/node1.do-ams.wakuv2.test.statusim.net/tcp/443/wss"), diff --git a/src/lib/enr/enr.node.spec.ts b/src/lib/enr/enr.node.spec.ts index 2a487eb950..b918fa22da 100644 --- a/src/lib/enr/enr.node.spec.ts +++ b/src/lib/enr/enr.node.spec.ts @@ -35,7 +35,7 @@ describe("ENR Interop: nwaku", function () { const nimPeerId = await nwaku.getPeerId(); expect(nwakuInfo.enrUri).to.not.be.undefined; - const dec = ENR.decodeTxt(nwakuInfo.enrUri ?? ""); + const dec = await ENR.decodeTxt(nwakuInfo.enrUri ?? ""); expect(dec.peerId?.toB58String()).to.eq(nimPeerId.toB58String()); expect(dec.waku2).to.deep.eq({ relay: true, @@ -66,7 +66,7 @@ describe("ENR Interop: nwaku", function () { const nimPeerId = await nwaku.getPeerId(); expect(nwakuInfo.enrUri).to.not.be.undefined; - const dec = ENR.decodeTxt(nwakuInfo.enrUri ?? ""); + const dec = await ENR.decodeTxt(nwakuInfo.enrUri ?? ""); expect(dec.peerId?.toB58String()).to.eq(nimPeerId.toB58String()); expect(dec.waku2).to.deep.eq({ relay: true, @@ -97,7 +97,7 @@ describe("ENR Interop: nwaku", function () { const nimPeerId = await nwaku.getPeerId(); expect(nwakuInfo.enrUri).to.not.be.undefined; - const dec = ENR.decodeTxt(nwakuInfo.enrUri ?? ""); + const dec = await ENR.decodeTxt(nwakuInfo.enrUri ?? ""); expect(dec.peerId?.toB58String()).to.eq(nimPeerId.toB58String()); expect(dec.waku2).to.deep.eq({ relay: true, diff --git a/src/lib/enr/enr.spec.ts b/src/lib/enr/enr.spec.ts index 7827f19b61..0b4738a338 100644 --- a/src/lib/enr/enr.spec.ts +++ b/src/lib/enr/enr.spec.ts @@ -15,7 +15,7 @@ describe("ENR", function () { describe("Txt codec", () => { it("should encodeTxt and decodeTxt", async () => { const peerId = await PeerId.create({ keyType: "secp256k1" }); - const enr = ENR.createFromPeerId(peerId); + const enr = await ENR.createFromPeerId(peerId); const keypair = createKeypairFromPeerId(peerId); enr.setLocationMultiaddr(new Multiaddr("/ip4/18.223.219.100/udp/9000")); enr.multiaddrs = [ @@ -38,7 +38,7 @@ describe("ENR", function () { }; const txt = await enr.encodeTxt(keypair.privateKey); - const enr2 = ENR.decodeTxt(txt); + const enr2 = await ENR.decodeTxt(txt); if (!enr.signature) throw "enr.signature is undefined"; if (!enr2.signature) throw "enr.signature is undefined"; @@ -66,19 +66,19 @@ describe("ENR", function () { }); }); - it("should decode valid enr successfully", () => { + it("should decode valid enr successfully", async () => { const txt = "enr:-Ku4QMh15cIjmnq-co5S3tYaNXxDzKTgj0ufusA-QfZ66EWHNsULt2kb0eTHoo1Dkjvvf6CAHDS1Di-htjiPFZzaIPcLh2F0dG5ldHOIAAAAAAAAAACEZXRoMpD2d10HAAABE________x8AgmlkgnY0gmlwhHZFkMSJc2VjcDI1NmsxoQIWSDEWdHwdEA3Lw2B_byeFQOINTZ0GdtF9DBjes6JqtIN1ZHCCIyg"; - const enr = ENR.decodeTxt(txt); + const enr = await ENR.decodeTxt(txt); const eth2 = enr.get("eth2"); if (!eth2) throw "eth2 is undefined"; expect(bytesToHex(eth2)).to.be.equal("f6775d0700000113ffffffffffff1f00"); }); - it("should decode valid ENR with multiaddrs successfully [shared test vector]", () => { + it("should decode valid ENR with multiaddrs successfully [shared test vector]", async () => { const txt = "enr:-QEnuEBEAyErHEfhiQxAVQoWowGTCuEF9fKZtXSd7H_PymHFhGJA3rGAYDVSHKCyJDGRLBGsloNbS8AZF33IVuefjOO6BIJpZIJ2NIJpcIQS39tkim11bHRpYWRkcnO4lgAvNihub2RlLTAxLmRvLWFtczMud2FrdXYyLnRlc3Quc3RhdHVzaW0ubmV0BgG73gMAODcxbm9kZS0wMS5hYy1jbi1ob25na29uZy1jLndha3V2Mi50ZXN0LnN0YXR1c2ltLm5ldAYBu94DACm9A62t7AQL4Ef5ZYZosRpQTzFVAB8jGjf1TER2wH-0zBOe1-MDBNLeA4lzZWNwMjU2azGhAzfsxbxyCkgCqq8WwYsVWH7YkpMLnU2Bw5xJSimxKav-g3VkcIIjKA"; - const enr = ENR.decodeTxt(txt); + const enr = await ENR.decodeTxt(txt); expect(enr.multiaddrs).to.not.be.undefined; expect(enr.multiaddrs!.length).to.be.equal(3); @@ -97,7 +97,7 @@ describe("ENR", function () { it("should decode valid enr with tcp successfully", async () => { const txt = "enr:-IS4QAmC_o1PMi5DbR4Bh4oHVyQunZblg4bTaottPtBodAhJZvxVlWW-4rXITPNg4mwJ8cW__D9FBDc9N4mdhyMqB-EBgmlkgnY0gmlwhIbRi9KJc2VjcDI1NmsxoQOevTdO6jvv3fRruxguKR-3Ge4bcFsLeAIWEDjrfaigNoN0Y3CCdl8"; - const enr = ENR.decodeTxt(txt); + const enr = await ENR.decodeTxt(txt); expect(enr.tcp).to.not.be.undefined; expect(enr.tcp).to.be.equal(30303); expect(enr.ip).to.not.be.undefined; @@ -111,7 +111,7 @@ describe("ENR", function () { it("should throw error - no id", async () => { try { const peerId = await PeerId.create({ keyType: "secp256k1" }); - const enr = ENR.createFromPeerId(peerId); + const enr = await ENR.createFromPeerId(peerId); const keypair = createKeypairFromPeerId(peerId); enr.setLocationMultiaddr(new Multiaddr("/ip4/18.223.219.100/udp/9000")); @@ -140,9 +140,9 @@ describe("ENR", function () { }); describe("Verify", () => { - it("should throw error - no id", () => { + it("should throw error - no id", async () => { try { - const enr = new ENR({}, BigInt(0), new Uint8Array()); + const enr = await ENR.create({}, BigInt(0), new Uint8Array()); enr.verify(new Uint8Array(), new Uint8Array()); assert.fail("Expect error here"); } catch (err: unknown) { @@ -151,9 +151,9 @@ describe("ENR", function () { } }); - it("should throw error - invalid id", () => { + it("should throw error - invalid id", async () => { try { - const enr = new ENR( + const enr = await ENR.create( { id: utf8ToBytes("v3") }, BigInt(0), new Uint8Array() @@ -166,9 +166,9 @@ describe("ENR", function () { } }); - it("should throw error - no public key", () => { + it("should throw error - no public key", async () => { try { - const enr = new ENR( + const enr = await ENR.create( { id: utf8ToBytes("v4") }, BigInt(0), new Uint8Array() @@ -181,10 +181,10 @@ describe("ENR", function () { } }); - it("should return false", () => { + it("should return false", async () => { const txt = "enr:-Ku4QMh15cIjmnq-co5S3tYaNXxDzKTgj0ufusA-QfZ66EWHNsULt2kb0eTHoo1Dkjvvf6CAHDS1Di-htjiPFZzaIPcLh2F0dG5ldHOIAAAAAAAAAACEZXRoMpD2d10HAAABE________x8AgmlkgnY0gmlwhHZFkMSJc2VjcDI1NmsxoQIWSDEWdHwdEA3Lw2B_byeFQOINTZ0GdtF9DBjes6JqtIN1ZHCCIyg"; - const enr = ENR.decodeTxt(txt); + const enr = await ENR.decodeTxt(txt); // should have id and public key inside ENR expect(enr.verify(new Uint8Array(32), new Uint8Array(64))).to.be.false; }); @@ -199,7 +199,7 @@ describe("ENR", function () { privateKey = hexToBytes( "b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291" ); - record = ENR.createV4(v4.publicKey(privateKey)); + record = await ENR.createV4(v4.publicKey(privateKey)); record.setLocationMultiaddr(new Multiaddr("/ip4/127.0.0.1/udp/30303")); record.seq = seq; await record.encodeTxt(privateKey); @@ -212,7 +212,7 @@ describe("ENR", function () { }); it("should encode/decode to RLP encoding", async function () { - const decoded = ENR.decode(await record.encode(privateKey)); + const decoded = await ENR.decode(await record.encode(privateKey)); expect(decoded).to.deep.equal(record); }); @@ -220,7 +220,7 @@ describe("ENR", function () { // spec enr https://eips.ethereum.org/EIPS/eip-778 const testTxt = "enr:-IS4QHCYrYZbAKWCBRlAy5zzaDZXJBGkcnh4MHcBFZntXNFrdvJjX04jRzjzCBOonrkTfj499SZuOh8R33Ls8RRcy5wBgmlkgnY0gmlwhH8AAAGJc2VjcDI1NmsxoQPKY0yuDUmstAHYpMa2_oxVtw0RW_QAdpzBQA8yWM0xOIN1ZHCCdl8"; - const decoded = ENR.decodeTxt(testTxt); + const decoded = await ENR.decodeTxt(testTxt); // Note: Signatures are different due to the extra entropy added // by @noble/secp256k1: // https://github.com/paulmillr/noble-secp256k1#signmsghash-privatekey @@ -236,11 +236,11 @@ describe("ENR", function () { let privateKey: Uint8Array; let record: ENR; - beforeEach(() => { + beforeEach(async () => { privateKey = hexToBytes( "b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291" ); - record = ENR.createV4(v4.publicKey(privateKey)); + record = await ENR.createV4(v4.publicKey(privateKey)); }); it("should get / set UDP multiaddr", () => { @@ -309,7 +309,7 @@ describe("ENR", function () { before(async function () { peerId = await PeerId.create({ keyType: "secp256k1" }); - enr = ENR.createFromPeerId(peerId); + enr = await ENR.createFromPeerId(peerId); enr.ip = ip4; enr.ip6 = ip6; enr.tcp = tcp; @@ -389,7 +389,7 @@ describe("ENR", function () { beforeEach(async function () { peerId = await PeerId.create({ keyType: "secp256k1" }); - enr = ENR.createFromPeerId(peerId); + enr = await ENR.createFromPeerId(peerId); keypair = createKeypairFromPeerId(peerId); waku2Protocols = { relay: false, @@ -403,7 +403,7 @@ describe("ENR", function () { enr.waku2 = waku2Protocols; const txt = await enr.encodeTxt(keypair.privateKey); - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(false); expect(decoded.store).to.equal(false); @@ -419,7 +419,7 @@ describe("ENR", function () { enr.waku2 = waku2Protocols; const txt = await enr.encodeTxt(keypair.privateKey); - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(true); expect(decoded.store).to.equal(true); @@ -432,7 +432,7 @@ describe("ENR", function () { enr.waku2 = waku2Protocols; const txt = await enr.encodeTxt(keypair.privateKey); - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(true); expect(decoded.store).to.equal(false); @@ -445,7 +445,7 @@ describe("ENR", function () { enr.waku2 = waku2Protocols; const txt = await enr.encodeTxt(keypair.privateKey); - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(false); expect(decoded.store).to.equal(true); @@ -458,7 +458,7 @@ describe("ENR", function () { enr.waku2 = waku2Protocols; const txt = await enr.encodeTxt(keypair.privateKey); - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(false); expect(decoded.store).to.equal(false); @@ -471,7 +471,7 @@ describe("ENR", function () { enr.waku2 = waku2Protocols; const txt = await enr.encodeTxt(keypair.privateKey); - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(false); expect(decoded.store).to.equal(false); @@ -481,11 +481,11 @@ describe("ENR", function () { }); describe("Waku2 key: decode", () => { - it("Relay + Store", function () { + it("Relay + Store", async function () { const txt = "enr:-Iu4QADPfXNCM6iYyte0pIdbMirIw_AsKR7J1DeJBysXDWz4DZvyjgIwpMt-sXTVUzLJdE9FaStVy2ZKtHUVQAH61-KAgmlkgnY0gmlwhMCosvuJc2VjcDI1NmsxoQI0OCNtPJtBayNgvFvKp-0YyCozcvE1rqm_V1W51nHVv4N0Y3CC6mCFd2FrdTIH"; - const decoded = ENR.decodeTxt(txt).waku2!; + const decoded = (await ENR.decodeTxt(txt)).waku2!; expect(decoded.relay).to.equal(true); expect(decoded.store).to.equal(true); diff --git a/src/lib/enr/enr.ts b/src/lib/enr/enr.ts index ccc8a15389..517ad530b7 100644 --- a/src/lib/enr/enr.ts +++ b/src/lib/enr/enr.ts @@ -33,7 +33,7 @@ export class ENR extends Map { public signature: Uint8Array | null; public peerId?: PeerId; - constructor( + private constructor( kvs: Record = {}, seq: SequenceNumber = BigInt(1), signature: Uint8Array | null = null @@ -65,12 +65,12 @@ export class ENR extends Map { static createV4( publicKey: Uint8Array, kvs: Record = {} - ): ENR { + ): Promise { // EIP-778 specifies that the key must be in compressed format, 33 bytes if (publicKey.length !== 33) { publicKey = compressPublicKey(publicKey); } - return new ENR({ + return ENR.create({ ...kvs, id: utf8ToBytes("v4"), secp256k1: publicKey, @@ -80,7 +80,7 @@ export class ENR extends Map { static createFromPeerId( peerId: PeerId, kvs: Record = {} - ): ENR { + ): Promise { const keypair = createKeypairFromPeerId(peerId); switch (keypair.type) { case KeypairType.secp256k1: @@ -90,7 +90,7 @@ export class ENR extends Map { } } - static decodeFromValues(decoded: Uint8Array[]): ENR { + static async decodeFromValues(decoded: Uint8Array[]): Promise { if (!Array.isArray(decoded)) { throw new Error("Decoded ENR must be an array"); } @@ -117,7 +117,7 @@ export class ENR extends Map { // If seq is an empty array, translate as value 0 const hexSeq = "0x" + (seq.length ? bytesToHex(seq) : "00"); - const enr = new ENR(obj, BigInt(hexSeq), signature); + const enr = await ENR.create(obj, BigInt(hexSeq), signature); const rlpEncodedBytes = hexToBytes(RLP.encode([seq, ...kvs])); if (!enr.verify(rlpEncodedBytes, signature)) { @@ -126,12 +126,12 @@ export class ENR extends Map { return enr; } - static decode(encoded: Uint8Array): ENR { + static decode(encoded: Uint8Array): Promise { const decoded = RLP.decode(encoded).map(hexToBytes); return ENR.decodeFromValues(decoded); } - static decodeTxt(encoded: string): ENR { + static decodeTxt(encoded: string): Promise { if (!encoded.startsWith(this.RECORD_PREFIX)) { throw new Error( `"string encoded ENR must start with '${this.RECORD_PREFIX}'`