@waku/enr 0.0.25-ce62600.0 → 0.0.25

package/src/encoder.ts

@@ -7,7 +7,7 @@ import { ERR_NO_SIGNATURE, MAX_RECORD_SIZE } from "./constants.js";
 import { ENR } from "./enr.js";
 
 export class EnrEncoder {
-  static async toValues(
+  public static async toValues(
     enr: ENR,
     privateKey?: Uint8Array
   ): Promise<(ENRKey | ENRValue | number[])[]> {
@@ -31,7 +31,10 @@ export class EnrEncoder {
     return content;
   }
 
-  static async toBytes(enr: ENR, privateKey?: Uint8Array): Promise<Uint8Array> {
+  public static async toBytes(
+    enr: ENR,
+    privateKey?: Uint8Array
+  ): Promise<Uint8Array> {
     const encoded = hexToBytes(
       RLP.encode(await EnrEncoder.toValues(enr, privateKey))
     );
@@ -41,7 +44,10 @@ export class EnrEncoder {
     return encoded;
   }
 
-  static async toString(enr: ENR, privateKey?: Uint8Array): Promise<string> {
+  public static async toString(
+    enr: ENR,
+    privateKey?: Uint8Array
+  ): Promise<string> {
     return (
       ENR.RECORD_PREFIX +
       toString(await EnrEncoder.toBytes(enr, privateKey), "base64url")

package/src/enr.ts

@@ -34,7 +34,7 @@ export class ENR extends RawEnr implements IEnr {
   public static readonly RECORD_PREFIX = "enr:";
   public peerId?: PeerId;
 
-  static async create(
+  public static async create(
     kvs: Record<ENRKey, ENRValue> = {},
     seq: SequenceNumber = BigInt(1),
     signature?: Uint8Array
@@ -52,7 +52,7 @@ export class ENR extends RawEnr implements IEnr {
     return enr;
   }
 
-  get nodeId(): NodeId | undefined {
+  public get nodeId(): NodeId | undefined {
     switch (this.id) {
       case "v4":
         return this.publicKey ? v4.nodeId(this.publicKey) : undefined;
@@ -60,18 +60,18 @@ export class ENR extends RawEnr implements IEnr {
         throw new Error(ERR_INVALID_ID);
     }
   }
-  getLocationMultiaddr: (
+  public getLocationMultiaddr: (
     protocol: TransportProtocol | TransportProtocolPerIpVersion
   ) => Multiaddr | undefined = locationMultiaddrFromEnrFields.bind({}, this);
 
-  get shardInfo(): ShardInfo | undefined {
+  public 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 {
+  public setLocationMultiaddr(multiaddr: Multiaddr): void {
     const protoNames = multiaddr.protoNames();
     if (
       protoNames.length !== 2 &&
@@ -95,7 +95,7 @@ export class ENR extends RawEnr implements IEnr {
     }
   }
 
-  getAllLocationMultiaddrs(): Multiaddr[] {
+  public getAllLocationMultiaddrs(): Multiaddr[] {
     const multiaddrs = [];
 
     for (const protocol of Object.values(TransportProtocolPerIpVersion)) {
@@ -115,7 +115,7 @@ export class ENR extends RawEnr implements IEnr {
     });
   }
 
-  get peerInfo(): PeerInfo | undefined {
+  public get peerInfo(): PeerInfo | undefined {
     const id = this.peerId;
     if (!id) return;
     return {
@@ -132,7 +132,7 @@ export class ENR extends RawEnr implements IEnr {
    *
    * @param protocol
    */
-  getFullMultiaddr(
+  public getFullMultiaddr(
     protocol: TransportProtocol | TransportProtocolPerIpVersion
   ): Multiaddr | undefined {
     if (this.peerId) {
@@ -147,7 +147,7 @@ export class ENR extends RawEnr implements IEnr {
   /**
    * Returns the full multiaddrs from the `multiaddrs` ENR field.
    */
-  getFullMultiaddrs(): Multiaddr[] {
+  public getFullMultiaddrs(): Multiaddr[] {
     if (this.peerId && this.multiaddrs) {
       const peerId = this.peerId;
       return this.multiaddrs.map((ma) => {
@@ -157,7 +157,7 @@ export class ENR extends RawEnr implements IEnr {
     return [];
   }
 
-  verify(data: Uint8Array, signature: Uint8Array): boolean {
+  public verify(data: Uint8Array, signature: Uint8Array): boolean {
     if (!this.get("id") || this.id !== "v4") {
       throw new Error(ERR_INVALID_ID);
     }
@@ -167,7 +167,10 @@ export class ENR extends RawEnr implements IEnr {
     return verifySignature(signature, keccak256(data), this.publicKey);
   }
 
-  async sign(data: Uint8Array, privateKey: Uint8Array): Promise<Uint8Array> {
+  public async sign(
+    data: Uint8Array,
+    privateKey: Uint8Array
+  ): Promise<Uint8Array> {
     switch (this.id) {
       case "v4":
         this.signature = await v4.sign(privateKey, data);

package/src/peer_id.ts

@@ -15,6 +15,10 @@ export function getPublicKeyFromPeerId(peerId: PeerId): Uint8Array {
     throw new Error("Unsupported peer id type");
   }
 
+  if (!peerId.publicKey) {
+    throw new Error("Public key not present on peer id");
+  }
+
   return unmarshalPublicKey(peerId.publicKey).marshal();
 }
 

package/src/raw_enr.ts

@@ -31,19 +31,19 @@ export class RawEnr extends Map<ENRKey, ENRValue> {
     this.signature = signature;
   }
 
-  set(k: ENRKey, v: ENRValue): this {
+  public set(k: ENRKey, v: ENRValue): this {
     this.signature = undefined;
     this.seq++;
     return super.set(k, v);
   }
 
-  get id(): string {
+  public get id(): string {
     const id = this.get("id");
     if (!id) throw new Error("id not found.");
     return bytesToUtf8(id);
   }
 
-  get publicKey(): Uint8Array | undefined {
+  public get publicKey(): Uint8Array | undefined {
     switch (this.id) {
       case "v4":
         return this.get("secp256k1");
@@ -52,63 +52,63 @@ export class RawEnr extends Map<ENRKey, ENRValue> {
     }
   }
 
-  get rs(): ShardInfo | undefined {
+  public get rs(): ShardInfo | undefined {
     const rs = this.get("rs");
     if (!rs) return undefined;
     return decodeRelayShard(rs);
   }
 
-  get rsv(): ShardInfo | undefined {
+  public get rsv(): ShardInfo | undefined {
     const rsv = this.get("rsv");
     if (!rsv) return undefined;
     return decodeRelayShard(rsv);
   }
 
-  get ip(): string | undefined {
+  public get ip(): string | undefined {
     return getStringValue(this, "ip", "ip4");
   }
 
-  set ip(ip: string | undefined) {
+  public set ip(ip: string | undefined) {
     setStringValue(this, "ip", "ip4", ip);
   }
 
-  get tcp(): number | undefined {
+  public get tcp(): number | undefined {
     return getNumberAsStringValue(this, "tcp", "tcp");
   }
 
-  set tcp(port: number | undefined) {
+  public set tcp(port: number | undefined) {
     setNumberAsStringValue(this, "tcp", "tcp", port);
   }
 
-  get udp(): number | undefined {
+  public get udp(): number | undefined {
     return getNumberAsStringValue(this, "udp", "udp");
   }
 
-  set udp(port: number | undefined) {
+  public set udp(port: number | undefined) {
     setNumberAsStringValue(this, "udp", "udp", port);
   }
 
-  get ip6(): string | undefined {
+  public get ip6(): string | undefined {
     return getStringValue(this, "ip6", "ip6");
   }
 
-  set ip6(ip: string | undefined) {
+  public set ip6(ip: string | undefined) {
     setStringValue(this, "ip6", "ip6", ip);
   }
 
-  get tcp6(): number | undefined {
+  public get tcp6(): number | undefined {
     return getNumberAsStringValue(this, "tcp6", "tcp");
   }
 
-  set tcp6(port: number | undefined) {
+  public set tcp6(port: number | undefined) {
     setNumberAsStringValue(this, "tcp6", "tcp", port);
   }
 
-  get udp6(): number | undefined {
+  public get udp6(): number | undefined {
     return getNumberAsStringValue(this, "udp6", "udp");
   }
 
-  set udp6(port: number | undefined) {
+  public set udp6(port: number | undefined) {
     setNumberAsStringValue(this, "udp6", "udp", port);
   }
 
@@ -124,7 +124,7 @@ export class RawEnr extends Map<ENRKey, ENRValue> {
    *
    * The multiaddresses stored in this field are expected to be location multiaddresses, ie, peer id less.
    */
-  get multiaddrs(): Multiaddr[] | undefined {
+  public get multiaddrs(): Multiaddr[] | undefined {
     const raw = this.get("multiaddrs");
 
     if (raw) return decodeMultiaddrs(raw);
@@ -144,14 +144,14 @@ export class RawEnr extends Map<ENRKey, ENRValue> {
    * The multiaddresses stored in this field must be location multiaddresses,
    * ie, without a peer id.
    */
-  set multiaddrs(multiaddrs: Multiaddr[] | undefined) {
+  public set multiaddrs(multiaddrs: Multiaddr[] | undefined) {
     deleteUndefined(this, "multiaddrs", multiaddrs, encodeMultiaddrs);
   }
 
   /**
    * Get the `waku2` field from ENR.
    */
-  get waku2(): Waku2 | undefined {
+  public get waku2(): Waku2 | undefined {
     const raw = this.get("waku2");
     if (raw) return decodeWaku2(raw[0]);
 
@@ -161,7 +161,7 @@ export class RawEnr extends Map<ENRKey, ENRValue> {
   /**
    * Set the `waku2` field on the ENR.
    */
-  set waku2(waku2: Waku2 | undefined) {
+  public set waku2(waku2: Waku2 | undefined) {
     deleteUndefined(
       this,
       "waku2",