@waku/interfaces 0.0.6 → 0.0.7

package/CHANGELOG.md

@@ -7,6 +7,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.0.7] - 2023-01-18
+
+### Added
+
+- `IPeerExchange` interface.
+- `IEnr` interface.
+
 ## [0.0.6] - 2022-12-15
 
 ### Changed
@@ -21,7 +28,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Alpha version of `@waku/interfaces`.
 
-[unreleased]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.6...HEAD
+[unreleased]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.7...HEAD
+[0.0.7]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.6...@waku/interfaces@0.0.7
 [0.0.6]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.5...@waku/interfaces@0.0.6
 [0.0.5]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.4...@waku/interfaces@0.0.5
 [0.0.4]: https://github.com/waku-org/js-waku/compare/@waku/interfaces@0.0.3...@waku/interfaces@0.0.4

package/dist/enr.d.ts

@@ -0,0 +1,34 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+export declare type ENRKey = string;
+export declare type ENRValue = Uint8Array;
+/**
+ * We represent NodeId as a hex string, since node equality is used very heavily
+ * and it is convenient to index data by NodeId
+ */
+export declare type NodeId = string;
+export declare type SequenceNumber = bigint;
+export interface Waku2 {
+    relay: boolean;
+    store: boolean;
+    filter: boolean;
+    lightPush: boolean;
+}
+export interface IEnr extends Map<ENRKey, ENRValue> {
+    nodeId?: NodeId;
+    peerId?: PeerId;
+    id: string;
+    seq: SequenceNumber;
+    publicKey?: Uint8Array;
+    signature?: Uint8Array;
+    ip?: string;
+    tcp?: number;
+    udp?: number;
+    ip6?: string;
+    tcp6?: number;
+    udp6?: number;
+    multiaddrs?: Multiaddr[];
+    waku2?: Waku2;
+    encode(privateKey?: Uint8Array): Promise<Uint8Array>;
+    getFullMultiaddrs(): Multiaddr[];
+}

package/dist/enr.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=enr.js.map

package/dist/enr.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enr.js","sourceRoot":"","sources":["../src/enr.ts"],"names":[],"mappings":""}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export * from "./enr.js";
 export * from "./filter.js";
 export * from "./light_push.js";
 export * from "./message.js";

package/dist/index.js

@@ -1,3 +1,4 @@
+export * from "./enr.js";
 export * from "./filter.js";
 export * from "./light_push.js";
 export * from "./message.js";

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,iBAAiB,CAAC;AAChC,cAAc,cAAc,CAAC;AAC7B,cAAc,oBAAoB,CAAC;AACnC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC"}

package/dist/peer_exchange.d.ts

@@ -1,19 +1,21 @@
 import type { ConnectionManager } from "@libp2p/interface-connection-manager";
+import type { PeerId } from "@libp2p/interface-peer-id";
 import type { PeerStore } from "@libp2p/interface-peer-store";
 import type { Registrar } from "@libp2p/interface-registrar";
-import { ENR } from "@waku/enr";
+import { IEnr } from "./enr.js";
 import { PointToPointProtocol } from "./protocols.js";
 export interface IPeerExchange extends PointToPointProtocol {
     query(params: PeerExchangeQueryParams, callback: (response: PeerExchangeResponse) => Promise<void> | void): Promise<void>;
 }
 export interface PeerExchangeQueryParams {
     numPeers: number;
+    peerId?: PeerId;
 }
 export interface PeerExchangeResponse {
     peerInfos: PeerInfo[];
 }
 export interface PeerInfo {
-    ENR?: ENR;
+    ENR?: IEnr;
 }
 export interface PeerExchangeComponents {
     connectionManager: ConnectionManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/interfaces",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Definition of Waku interfaces",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",

package/src/enr.ts

@@ -0,0 +1,38 @@
+import type { PeerId } from "@libp2p/interface-peer-id";
+import type { Multiaddr } from "@multiformats/multiaddr";
+
+export type ENRKey = string;
+export type ENRValue = Uint8Array;
+/**
+ * We represent NodeId as a hex string, since node equality is used very heavily
+ * and it is convenient to index data by NodeId
+ */
+export type NodeId = string;
+export type SequenceNumber = bigint;
+
+export interface Waku2 {
+  relay: boolean;
+  store: boolean;
+  filter: boolean;
+  lightPush: boolean;
+}
+
+export interface IEnr extends Map<ENRKey, ENRValue> {
+  nodeId?: NodeId;
+  peerId?: PeerId;
+  id: string;
+  seq: SequenceNumber;
+  publicKey?: Uint8Array;
+  signature?: Uint8Array;
+  ip?: string;
+  tcp?: number;
+  udp?: number;
+  ip6?: string;
+  tcp6?: number;
+  udp6?: number;
+  multiaddrs?: Multiaddr[];
+  waku2?: Waku2;
+
+  encode(privateKey?: Uint8Array): Promise<Uint8Array>;
+  getFullMultiaddrs(): Multiaddr[];
+}

package/src/index.ts

@@ -1,3 +1,4 @@
+export * from "./enr.js";
 export * from "./filter.js";
 export * from "./light_push.js";
 export * from "./message.js";

package/src/peer_exchange.ts

@@ -1,8 +1,9 @@
 import type { ConnectionManager } from "@libp2p/interface-connection-manager";
+import type { PeerId } from "@libp2p/interface-peer-id";
 import type { PeerStore } from "@libp2p/interface-peer-store";
 import type { Registrar } from "@libp2p/interface-registrar";
-import { ENR } from "@waku/enr";
 
+import { IEnr } from "./enr.js";
 import { PointToPointProtocol } from "./protocols.js";
 
 export interface IPeerExchange extends PointToPointProtocol {
@@ -14,6 +15,7 @@ export interface IPeerExchange extends PointToPointProtocol {
 
 export interface PeerExchangeQueryParams {
   numPeers: number;
+  peerId?: PeerId;
 }
 
 export interface PeerExchangeResponse {
@@ -21,7 +23,7 @@ export interface PeerExchangeResponse {
 }
 
 export interface PeerInfo {
-  ENR?: ENR;
+  ENR?: IEnr;
 }
 
 export interface PeerExchangeComponents {