@waku/discovery 0.0.7-09108d9.0 → 0.0.7-0e49a1e.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundle/index.js +1263 -4317
- package/dist/.tsbuildinfo +1 -1
- package/dist/dns/constants.d.ts +0 -2
- package/dist/dns/constants.js +0 -5
- package/dist/dns/constants.js.map +1 -1
- package/dist/dns/dns.d.ts +3 -12
- package/dist/dns/dns.js +16 -39
- package/dist/dns/dns.js.map +1 -1
- package/dist/dns/dns_discovery.d.ts +3 -3
- package/dist/dns/dns_discovery.js +4 -5
- package/dist/dns/dns_discovery.js.map +1 -1
- package/dist/dns/dns_over_https.d.ts +2 -8
- package/dist/dns/dns_over_https.js +8 -22
- package/dist/dns/dns_over_https.js.map +1 -1
- package/dist/dns/fetch_nodes.d.ts +5 -11
- package/dist/dns/fetch_nodes.js +15 -117
- package/dist/dns/fetch_nodes.js.map +1 -1
- package/package.json +1 -1
- package/src/dns/constants.ts +0 -8
- package/src/dns/dns.ts +20 -68
- package/src/dns/dns_discovery.ts +6 -14
- package/src/dns/dns_over_https.ts +6 -31
- package/src/dns/fetch_nodes.ts +20 -157
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dns_discovery.js","sourceRoot":"","sources":["../../src/dns/dns_discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;
|
|
1
|
+
{"version":3,"file":"dns_discovery.js","sourceRoot":"","sources":["../../src/dns/dns_discovery.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,IAAI,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAQlE,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAEvD,OAAO,EACL,0BAA0B,EAC1B,yBAAyB,EACzB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AACxB,OAAO,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAE5C,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,oBAAoB,CAAC,CAAC;AAE7C;;GAEG;AACH,MAAM,OAAO,gBACX,SAAQ,iBAAsC;IAGtC,QAAQ,CAA2C;IACnD,QAAQ,CAAU;IAClB,WAAW,CAAyB;IAC3B,QAAQ,CAAiB;IAE1C,YACE,UAAkC,EAClC,OAAuB;QAEvB,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;QACtB,IAAI,CAAC,WAAW,GAAG,UAAU,CAAC;QAC9B,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC;QAExB,MAAM,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC;QAC5B,GAAG,CAAC,IAAI,CAAC,wCAAwC,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,KAAK;QAChB,GAAG,CAAC,IAAI,CAAC,iCAAiC,CAAC,CAAC;QAE5C,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrB,MAAM,IAAI,CAAC,SAAS,EAAE,CAAC;IACzB,CAAC;IAEM,KAAK,CAAC,SAAS;QACpB,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;YACnB,IAAI,EAAE,OAAO,EAAE,GAAG,IAAI,CAAC,QAAQ,CAAC;YAChC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC;gBAAE,OAAO,GAAG,CAAC,OAAO,CAAC,CAAC;YAEjD,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC,WAAW,EAAE,CAAC;YAEjD,IAAI,CAAC,QAAQ,GAAG,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;QACrD,CAAC;QAED,IAAI,KAAK,EAAE,MAAM,OAAO,IAAI,IAAI,CAAC,QAAQ,EAAE,EAAE,CAAC;YAC5C,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACnB,OAAO;YACT,CAAC;YAED,MAAM,EAAE,QAAQ,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;YAExC,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,SAAS;YACX,CAAC;YAED,MAAM,YAAY,GAAG;gBACnB,CAAC,0BAA0B,CAAC,EAAE;oBAC5B,KAAK,EAAE,IAAI,CAAC,QAAQ,CAAC,QAAQ,IAAI,2BAA2B;oBAC5D,GAAG,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,yBAAyB;iBACvD;aACF,CAAC;YAEF,IAAI,aAAa,GAAG,KAAK,CAAC;YAC1B,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAEvE,IAAI,YAAY,EAAE,CAAC;gBACjB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;gBAC/D,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAAC;gBAElE,IAAI,CAAC,eAAe,EAAE,CAAC;oBACrB,aAAa,GAAG,IAAI,CAAC;oBACrB,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,EAAE;wBAClD,IAAI,EAAE,YAAY;qBACnB,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;iBAAM,CAAC;gBACN,aAAa,GAAG,IAAI,CAAC;gBACrB,MAAM,IAAI,CAAC,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE;oBACjD,IAAI,EAAE,YAAY;oBAClB,GAAG,CAAC,SAAS,IAAI;wBACf,QAAQ,EAAE;4BACR,SAAS,EAAE,gBAAgB,CAAC,SAAS,CAAC;yBACvC;qBACF,CAAC;iBACH,CAAC,CAAC;YACL,CAAC;YAED,IAAI,aAAa,EAAE,CAAC;gBAClB,IAAI,CAAC,aAAa,CAChB,IAAI,WAAW,CAAW,MAAM,EAAE,EAAE,MAAM,EAAE,QAAQ,EAAE,CAAC,CACxD,CAAC;YACJ,CAAC;QACH,CAAC;IACH,CAAC;IAED;;OAEG;IACI,IAAI;QACT,IAAI,CAAC,QAAQ,GAAG,KAAK,CAAC;IACxB,CAAC;IAED,IAAW,CAAC,MAAM,CAAC;QACjB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAW,CAAC,MAAM,CAAC,WAAW,CAAC;QAC7B,OAAO,iBAAiB,CAAC;IAC3B,CAAC;CACF;AAED,MAAM,UAAU,gBAAgB,CAC9B,OAAiB;IAEjB,OAAO,CAAC,UAAkC,EAAE,EAAE,CAC5C,IAAI,gBAAgB,CAAC,UAAU,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;AAClD,CAAC"}
|
|
@@ -1,18 +1,12 @@
|
|
|
1
1
|
import type { DnsClient } from "@waku/interfaces";
|
|
2
|
-
import { Endpoint } from "dns-query";
|
|
3
2
|
export declare class DnsOverHttps implements DnsClient {
|
|
4
|
-
private
|
|
5
|
-
private retries;
|
|
3
|
+
private resolver;
|
|
6
4
|
/**
|
|
7
5
|
* Create new Dns-Over-Http DNS client.
|
|
8
6
|
*
|
|
9
|
-
* @param endpoints The endpoints for Dns-Over-Https queries;
|
|
10
|
-
* Defaults to using dns-query's API..
|
|
11
|
-
* @param retries Retries if a given endpoint fails.
|
|
12
|
-
*
|
|
13
7
|
* @throws {code: string} If DNS query fails.
|
|
14
8
|
*/
|
|
15
|
-
static create(
|
|
9
|
+
static create(): Promise<DnsOverHttps>;
|
|
16
10
|
private constructor();
|
|
17
11
|
/**
|
|
18
12
|
* Resolves a TXT record
|
|
@@ -1,26 +1,19 @@
|
|
|
1
1
|
import { Logger } from "@waku/utils";
|
|
2
2
|
import { bytesToUtf8 } from "@waku/utils/bytes";
|
|
3
|
-
import
|
|
3
|
+
import DnsOverHttpResolver from "dns-over-http-resolver";
|
|
4
4
|
const log = new Logger("dns-over-https");
|
|
5
5
|
export class DnsOverHttps {
|
|
6
|
-
|
|
7
|
-
retries;
|
|
6
|
+
resolver;
|
|
8
7
|
/**
|
|
9
8
|
* Create new Dns-Over-Http DNS client.
|
|
10
9
|
*
|
|
11
|
-
* @param endpoints The endpoints for Dns-Over-Https queries;
|
|
12
|
-
* Defaults to using dns-query's API..
|
|
13
|
-
* @param retries Retries if a given endpoint fails.
|
|
14
|
-
*
|
|
15
10
|
* @throws {code: string} If DNS query fails.
|
|
16
11
|
*/
|
|
17
|
-
static async create(
|
|
18
|
-
|
|
19
|
-
return new DnsOverHttps(_endpoints, retries);
|
|
12
|
+
static async create() {
|
|
13
|
+
return new DnsOverHttps();
|
|
20
14
|
}
|
|
21
|
-
constructor(
|
|
22
|
-
this.
|
|
23
|
-
this.retries = retries;
|
|
15
|
+
constructor(resolver = new DnsOverHttpResolver()) {
|
|
16
|
+
this.resolver = resolver;
|
|
24
17
|
}
|
|
25
18
|
/**
|
|
26
19
|
* Resolves a TXT record
|
|
@@ -32,13 +25,7 @@ export class DnsOverHttps {
|
|
|
32
25
|
async resolveTXT(domain) {
|
|
33
26
|
let answers;
|
|
34
27
|
try {
|
|
35
|
-
|
|
36
|
-
question: { type: "TXT", name: domain }
|
|
37
|
-
}, {
|
|
38
|
-
endpoints: this.endpoints,
|
|
39
|
-
retries: this.retries
|
|
40
|
-
});
|
|
41
|
-
answers = res.answers;
|
|
28
|
+
answers = await this.resolver.resolveTxt(domain);
|
|
42
29
|
}
|
|
43
30
|
catch (error) {
|
|
44
31
|
log.error("query failed: ", error);
|
|
@@ -46,9 +33,8 @@ export class DnsOverHttps {
|
|
|
46
33
|
}
|
|
47
34
|
if (!answers)
|
|
48
35
|
throw new Error(`Could not resolve ${domain}`);
|
|
49
|
-
const data = answers.map((a) => a.data);
|
|
50
36
|
const result = [];
|
|
51
|
-
|
|
37
|
+
answers.forEach((d) => {
|
|
52
38
|
if (typeof d === "string") {
|
|
53
39
|
result.push(d);
|
|
54
40
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dns_over_https.js","sourceRoot":"","sources":["../../src/dns/dns_over_https.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,
|
|
1
|
+
{"version":3,"file":"dns_over_https.js","sourceRoot":"","sources":["../../src/dns/dns_over_https.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,mBAAmB,MAAM,wBAAwB,CAAC;AAEzD,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,gBAAgB,CAAC,CAAC;AAEzC,MAAM,OAAO,YAAY;IAUK;IAT5B;;;;OAIG;IACI,MAAM,CAAC,KAAK,CAAC,MAAM;QACxB,OAAO,IAAI,YAAY,EAAE,CAAC;IAC5B,CAAC;IAED,YAA4B,WAAW,IAAI,mBAAmB,EAAE;QAApC,aAAQ,GAAR,QAAQ,CAA4B;IAAG,CAAC;IAEpE;;;;;;OAMG;IACI,KAAK,CAAC,UAAU,CAAC,MAAc;QACpC,IAAI,OAAO,CAAC;QACZ,IAAI,CAAC;YACH,OAAO,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC;QACnD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,GAAG,CAAC,KAAK,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACnC,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACtC,CAAC;QAED,IAAI,CAAC,OAAO;YAAE,MAAM,IAAI,KAAK,CAAC,qBAAqB,MAAM,EAAE,CAAC,CAAC;QAE7D,MAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE;YACpB,IAAI,OAAO,CAAC,KAAK,QAAQ,EAAE,CAAC;gBAC1B,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YACjB,CAAC;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC;gBAC5B,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE;oBACf,IAAI,OAAO,EAAE,KAAK,QAAQ,EAAE,CAAC;wBAC3B,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAClB,CAAC;yBAAM,CAAC;wBACN,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC;oBAC/B,CAAC;gBACH,CAAC,CAAC,CAAC;YACL,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC;YAC9B,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF"}
|
|
@@ -1,13 +1,7 @@
|
|
|
1
|
-
import type { IEnr
|
|
1
|
+
import type { IEnr } from "@waku/interfaces";
|
|
2
2
|
/**
|
|
3
|
-
* Fetch nodes using passed [[getNode]] until
|
|
4
|
-
*
|
|
5
|
-
*
|
|
3
|
+
* Fetch nodes using passed [[getNode]] until it has been called [[maxGet]]
|
|
4
|
+
* times, or it has returned empty or duplicate results more than [[maxErrors]]
|
|
5
|
+
* times.
|
|
6
6
|
*/
|
|
7
|
-
export declare function
|
|
8
|
-
/**
|
|
9
|
-
* Fetch nodes using passed [[getNode]] until all wanted capabilities are
|
|
10
|
-
* fulfilled or the number of [[getNode]] call exceeds the sum of
|
|
11
|
-
* [[wantedNodeCapabilityCount]] plus [[errorTolerance]].
|
|
12
|
-
*/
|
|
13
|
-
export declare function yieldNodesUntilCapabilitiesFulfilled(wantedNodeCapabilityCount: Partial<NodeCapabilityCount>, errorTolerance: number, getNode: () => Promise<IEnr | null>): AsyncGenerator<IEnr>;
|
|
7
|
+
export declare function fetchNodes(getNode: () => Promise<IEnr | null>, maxGet?: number, maxErrors?: number): AsyncGenerator<IEnr>;
|
package/dist/dns/fetch_nodes.js
CHANGED
|
@@ -1,133 +1,31 @@
|
|
|
1
1
|
import { Logger } from "@waku/utils";
|
|
2
2
|
const log = new Logger("discovery:fetch_nodes");
|
|
3
3
|
/**
|
|
4
|
-
* Fetch nodes using passed [[getNode]] until
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* Fetch nodes using passed [[getNode]] until it has been called [[maxGet]]
|
|
5
|
+
* times, or it has returned empty or duplicate results more than [[maxErrors]]
|
|
6
|
+
* times.
|
|
7
7
|
*/
|
|
8
|
-
export async function
|
|
9
|
-
const
|
|
10
|
-
relay: wantedNodeCapabilityCount.relay ?? 0,
|
|
11
|
-
store: wantedNodeCapabilityCount.store ?? 0,
|
|
12
|
-
filter: wantedNodeCapabilityCount.filter ?? 0,
|
|
13
|
-
lightPush: wantedNodeCapabilityCount.lightPush ?? 0
|
|
14
|
-
};
|
|
15
|
-
const maxSearches = wanted.relay + wanted.store + wanted.filter + wanted.lightPush;
|
|
16
|
-
const actual = {
|
|
17
|
-
relay: 0,
|
|
18
|
-
store: 0,
|
|
19
|
-
filter: 0,
|
|
20
|
-
lightPush: 0
|
|
21
|
-
};
|
|
8
|
+
export async function* fetchNodes(getNode, maxGet = 10, maxErrors = 3) {
|
|
9
|
+
const peerNodeIds = new Set();
|
|
22
10
|
let totalSearches = 0;
|
|
23
|
-
|
|
24
|
-
while (
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
if (peer && isNewPeer(peer, peers)) {
|
|
28
|
-
// ENRs without a waku2 key are ignored.
|
|
29
|
-
if (peer.waku2) {
|
|
30
|
-
if (helpsSatisfyCapabilities(peer.waku2, wanted, actual)) {
|
|
31
|
-
addCapabilities(peer.waku2, actual);
|
|
32
|
-
peers.push(peer);
|
|
33
|
-
}
|
|
34
|
-
}
|
|
35
|
-
log.info(`got new peer candidate from DNS address=${peer.nodeId}@${peer.ip}`);
|
|
36
|
-
}
|
|
11
|
+
let erroneousSearches = 0;
|
|
12
|
+
while (totalSearches < maxGet &&
|
|
13
|
+
erroneousSearches < maxErrors // Allows a couple of empty results before calling it quit
|
|
14
|
+
) {
|
|
37
15
|
totalSearches++;
|
|
38
|
-
}
|
|
39
|
-
return peers;
|
|
40
|
-
}
|
|
41
|
-
/**
|
|
42
|
-
* Fetch nodes using passed [[getNode]] until all wanted capabilities are
|
|
43
|
-
* fulfilled or the number of [[getNode]] call exceeds the sum of
|
|
44
|
-
* [[wantedNodeCapabilityCount]] plus [[errorTolerance]].
|
|
45
|
-
*/
|
|
46
|
-
export async function* yieldNodesUntilCapabilitiesFulfilled(wantedNodeCapabilityCount, errorTolerance, getNode) {
|
|
47
|
-
const wanted = {
|
|
48
|
-
relay: wantedNodeCapabilityCount.relay ?? 0,
|
|
49
|
-
store: wantedNodeCapabilityCount.store ?? 0,
|
|
50
|
-
filter: wantedNodeCapabilityCount.filter ?? 0,
|
|
51
|
-
lightPush: wantedNodeCapabilityCount.lightPush ?? 0
|
|
52
|
-
};
|
|
53
|
-
const maxSearches = wanted.relay + wanted.store + wanted.filter + wanted.lightPush;
|
|
54
|
-
const actual = {
|
|
55
|
-
relay: 0,
|
|
56
|
-
store: 0,
|
|
57
|
-
filter: 0,
|
|
58
|
-
lightPush: 0
|
|
59
|
-
};
|
|
60
|
-
let totalSearches = 0;
|
|
61
|
-
const peerNodeIds = new Set();
|
|
62
|
-
while (!isSatisfied(wanted, actual) &&
|
|
63
|
-
totalSearches < maxSearches + errorTolerance) {
|
|
64
16
|
const peer = await getNode();
|
|
65
|
-
if (peer
|
|
17
|
+
if (!peer || !peer.nodeId) {
|
|
18
|
+
erroneousSearches++;
|
|
19
|
+
continue;
|
|
20
|
+
}
|
|
21
|
+
if (!peerNodeIds.has(peer.nodeId)) {
|
|
66
22
|
peerNodeIds.add(peer.nodeId);
|
|
67
23
|
// ENRs without a waku2 key are ignored.
|
|
68
24
|
if (peer.waku2) {
|
|
69
|
-
|
|
70
|
-
addCapabilities(peer.waku2, actual);
|
|
71
|
-
yield peer;
|
|
72
|
-
}
|
|
25
|
+
yield peer;
|
|
73
26
|
}
|
|
74
27
|
log.info(`got new peer candidate from DNS address=${peer.nodeId}@${peer.ip}`);
|
|
75
28
|
}
|
|
76
|
-
totalSearches++;
|
|
77
29
|
}
|
|
78
30
|
}
|
|
79
|
-
function isSatisfied(wanted, actual) {
|
|
80
|
-
return (actual.relay >= wanted.relay &&
|
|
81
|
-
actual.store >= wanted.store &&
|
|
82
|
-
actual.filter >= wanted.filter &&
|
|
83
|
-
actual.lightPush >= wanted.lightPush);
|
|
84
|
-
}
|
|
85
|
-
function isNewPeer(peer, peers) {
|
|
86
|
-
if (!peer.nodeId)
|
|
87
|
-
return false;
|
|
88
|
-
for (const existingPeer of peers) {
|
|
89
|
-
if (peer.nodeId === existingPeer.nodeId) {
|
|
90
|
-
return false;
|
|
91
|
-
}
|
|
92
|
-
}
|
|
93
|
-
return true;
|
|
94
|
-
}
|
|
95
|
-
function addCapabilities(node, total) {
|
|
96
|
-
if (node.relay)
|
|
97
|
-
total.relay += 1;
|
|
98
|
-
if (node.store)
|
|
99
|
-
total.store += 1;
|
|
100
|
-
if (node.filter)
|
|
101
|
-
total.filter += 1;
|
|
102
|
-
if (node.lightPush)
|
|
103
|
-
total.lightPush += 1;
|
|
104
|
-
}
|
|
105
|
-
/**
|
|
106
|
-
* Checks if the proposed ENR [[node]] helps satisfy the [[wanted]] capabilities,
|
|
107
|
-
* considering the [[actual]] capabilities of nodes retrieved so far..
|
|
108
|
-
*
|
|
109
|
-
* @throws If the function is called when the wanted capabilities are already fulfilled.
|
|
110
|
-
*/
|
|
111
|
-
function helpsSatisfyCapabilities(node, wanted, actual) {
|
|
112
|
-
if (isSatisfied(wanted, actual)) {
|
|
113
|
-
throw "Internal Error: Waku2 wanted capabilities are already fulfilled";
|
|
114
|
-
}
|
|
115
|
-
const missing = missingCapabilities(wanted, actual);
|
|
116
|
-
return ((missing.relay && node.relay) ||
|
|
117
|
-
(missing.store && node.store) ||
|
|
118
|
-
(missing.filter && node.filter) ||
|
|
119
|
-
(missing.lightPush && node.lightPush));
|
|
120
|
-
}
|
|
121
|
-
/**
|
|
122
|
-
* Return a [[Waku2]] Object for which capabilities are set to true if they are
|
|
123
|
-
* [[wanted]] yet missing from [[actual]].
|
|
124
|
-
*/
|
|
125
|
-
function missingCapabilities(wanted, actual) {
|
|
126
|
-
return {
|
|
127
|
-
relay: actual.relay < wanted.relay,
|
|
128
|
-
store: actual.store < wanted.store,
|
|
129
|
-
filter: actual.filter < wanted.filter,
|
|
130
|
-
lightPush: actual.lightPush < wanted.lightPush
|
|
131
|
-
};
|
|
132
|
-
}
|
|
133
31
|
//# sourceMappingURL=fetch_nodes.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"fetch_nodes.js","sourceRoot":"","sources":["../../src/dns/fetch_nodes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,CAAC,KAAK,
|
|
1
|
+
{"version":3,"file":"fetch_nodes.js","sourceRoot":"","sources":["../../src/dns/fetch_nodes.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,GAAG,GAAG,IAAI,MAAM,CAAC,uBAAuB,CAAC,CAAC;AAEhD;;;;GAIG;AACH,MAAM,CAAC,KAAK,SAAS,CAAC,CAAC,UAAU,CAC/B,OAAmC,EACnC,SAAiB,EAAE,EACnB,YAAoB,CAAC;IAErB,MAAM,WAAW,GAAG,IAAI,GAAG,EAAE,CAAC;IAE9B,IAAI,aAAa,GAAG,CAAC,CAAC;IACtB,IAAI,iBAAiB,GAAG,CAAC,CAAC;IAE1B,OACE,aAAa,GAAG,MAAM;QACtB,iBAAiB,GAAG,SAAS,CAAC,0DAA0D;MACxF,CAAC;QACD,aAAa,EAAE,CAAC;QAEhB,MAAM,IAAI,GAAG,MAAM,OAAO,EAAE,CAAC;QAC7B,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;YAC1B,iBAAiB,EAAE,CAAC;YACpB,SAAS;QACX,CAAC;QAED,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;YAClC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YAC7B,wCAAwC;YACxC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;gBACf,MAAM,IAAI,CAAC;YACb,CAAC;YACD,GAAG,CAAC,IAAI,CACN,2CAA2C,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,EAAE,EAAE,CACpE,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}
|
package/package.json
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"name":"@waku/discovery","version":"0.0.7-
|
|
1
|
+
{"name":"@waku/discovery","version":"0.0.7-0e49a1e.0","description":"Contains various discovery mechanisms: DNS Discovery (EIP-1459, Peer Exchange, Local Peer Cache Discovery.","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/discovery#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","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build","test":"NODE_ENV=test run-s test:*","test:node":"NODE_ENV=test TS_NODE_PROJECT=./tsconfig.dev.json mocha 'src/**/*.spec.ts'","test:browser":"NODE_ENV=test karma start karma.conf.cjs"},"engines":{"node":">=20"},"dependencies":{"@waku/core":"0.0.34-0e49a1e.0","@waku/enr":"0.0.28-0e49a1e.0","@waku/interfaces":"0.0.29-0e49a1e.0","@waku/proto":"0.0.9-0e49a1e.0","@waku/utils":"0.0.22-0e49a1e.0","debug":"^4.3.4","dns-over-http-resolver":"^3.0.8","hi-base32":"^0.5.1","uint8arrays":"^5.0.1"},"devDependencies":{"@libp2p/interface":"^2.1.3","@libp2p/peer-id":"5.0.1","@multiformats/multiaddr":"^12.3.0","@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/node-localstorage":"^1.3.3","@waku/build-utils":"*","chai":"^4.3.10","chai-as-promised":"^7.1.1","cspell":"^8.6.1","mocha":"^10.3.0","node-localstorage":"^3.0.5","npm-run-all":"^4.1.5","rollup":"^4.12.0","sinon":"^18.0.0"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"]}
|
package/src/dns/constants.ts
CHANGED
|
@@ -1,5 +1,3 @@
|
|
|
1
|
-
import type { NodeCapabilityCount } from "@waku/interfaces";
|
|
2
|
-
|
|
3
1
|
/**
|
|
4
2
|
* The ENR tree for the different fleets.
|
|
5
3
|
* SANDBOX and TEST fleets are for The Waku Network.
|
|
@@ -13,9 +11,3 @@ export const enrTree = {
|
|
|
13
11
|
export const DEFAULT_BOOTSTRAP_TAG_NAME = "bootstrap";
|
|
14
12
|
export const DEFAULT_BOOTSTRAP_TAG_VALUE = 50;
|
|
15
13
|
export const DEFAULT_BOOTSTRAP_TAG_TTL = 100_000_000;
|
|
16
|
-
|
|
17
|
-
export const DEFAULT_NODE_REQUIREMENTS: Partial<NodeCapabilityCount> = {
|
|
18
|
-
store: 1,
|
|
19
|
-
filter: 2,
|
|
20
|
-
lightPush: 2
|
|
21
|
-
};
|
package/src/dns/dns.ts
CHANGED
|
@@ -1,25 +1,16 @@
|
|
|
1
1
|
import { ENR, EnrDecoder } from "@waku/enr";
|
|
2
|
-
import type {
|
|
3
|
-
|
|
4
|
-
IEnr,
|
|
5
|
-
NodeCapabilityCount,
|
|
6
|
-
SearchContext
|
|
7
|
-
} from "@waku/interfaces";
|
|
8
|
-
import { Logger } from "@waku/utils";
|
|
2
|
+
import type { DnsClient, IEnr, SearchContext } from "@waku/interfaces";
|
|
3
|
+
import { Logger, shuffle } from "@waku/utils";
|
|
9
4
|
|
|
10
5
|
import { DnsOverHttps } from "./dns_over_https.js";
|
|
11
6
|
import { ENRTree } from "./enrtree.js";
|
|
12
|
-
import {
|
|
13
|
-
fetchNodesUntilCapabilitiesFulfilled,
|
|
14
|
-
yieldNodesUntilCapabilitiesFulfilled
|
|
15
|
-
} from "./fetch_nodes.js";
|
|
7
|
+
import { fetchNodes } from "./fetch_nodes.js";
|
|
16
8
|
|
|
17
9
|
const log = new Logger("discovery:dns");
|
|
18
10
|
|
|
19
11
|
export class DnsNodeDiscovery {
|
|
20
12
|
private readonly dns: DnsClient;
|
|
21
13
|
private readonly _DNSTreeCache: { [key: string]: string };
|
|
22
|
-
private readonly _errorTolerance: number = 10;
|
|
23
14
|
|
|
24
15
|
public static async dnsOverHttp(
|
|
25
16
|
dnsClient?: DnsClient
|
|
@@ -30,68 +21,29 @@ export class DnsNodeDiscovery {
|
|
|
30
21
|
return new DnsNodeDiscovery(dnsClient);
|
|
31
22
|
}
|
|
32
23
|
|
|
33
|
-
/**
|
|
34
|
-
* Returns a list of verified peers listed in an EIP-1459 DNS tree. Method may
|
|
35
|
-
* return fewer peers than requested if @link wantedNodeCapabilityCount requires
|
|
36
|
-
* larger quantity of peers than available or the number of errors/duplicate
|
|
37
|
-
* peers encountered by randomized search exceeds the sum of the fields of
|
|
38
|
-
* @link wantedNodeCapabilityCount plus the @link _errorTolerance factor.
|
|
39
|
-
*/
|
|
40
|
-
public async getPeers(
|
|
41
|
-
enrTreeUrls: string[],
|
|
42
|
-
wantedNodeCapabilityCount: Partial<NodeCapabilityCount>
|
|
43
|
-
): Promise<IEnr[]> {
|
|
44
|
-
const networkIndex = Math.floor(Math.random() * enrTreeUrls.length);
|
|
45
|
-
const { publicKey, domain } = ENRTree.parseTree(enrTreeUrls[networkIndex]);
|
|
46
|
-
const context: SearchContext = {
|
|
47
|
-
domain,
|
|
48
|
-
publicKey,
|
|
49
|
-
visits: {}
|
|
50
|
-
};
|
|
51
|
-
|
|
52
|
-
const peers = await fetchNodesUntilCapabilitiesFulfilled(
|
|
53
|
-
wantedNodeCapabilityCount,
|
|
54
|
-
this._errorTolerance,
|
|
55
|
-
() => this._search(domain, context)
|
|
56
|
-
);
|
|
57
|
-
log.info(
|
|
58
|
-
"retrieved peers: ",
|
|
59
|
-
peers.map((peer) => {
|
|
60
|
-
return {
|
|
61
|
-
id: peer.peerId?.toString(),
|
|
62
|
-
multiaddrs: peer.multiaddrs?.map((ma) => ma.toString())
|
|
63
|
-
};
|
|
64
|
-
})
|
|
65
|
-
);
|
|
66
|
-
return peers;
|
|
67
|
-
}
|
|
68
|
-
|
|
69
24
|
public constructor(dns: DnsClient) {
|
|
70
25
|
this._DNSTreeCache = {};
|
|
71
26
|
this.dns = dns;
|
|
72
27
|
}
|
|
73
28
|
|
|
74
29
|
/**
|
|
75
|
-
*
|
|
30
|
+
* Retrieve the next peers from the passed [[enrTreeUrls]],
|
|
76
31
|
*/
|
|
77
|
-
public async *getNextPeer(
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
() => this._search(domain, context)
|
|
93
|
-
)) {
|
|
94
|
-
yield peer;
|
|
32
|
+
public async *getNextPeer(enrTreeUrls: string[]): AsyncGenerator<IEnr> {
|
|
33
|
+
// Shuffle the ENR Trees so that not all clients connect to same nodes first.
|
|
34
|
+
for (const enrTreeUrl of shuffle(enrTreeUrls)) {
|
|
35
|
+
const { publicKey, domain } = ENRTree.parseTree(enrTreeUrl);
|
|
36
|
+
const context: SearchContext = {
|
|
37
|
+
domain,
|
|
38
|
+
publicKey,
|
|
39
|
+
visits: {}
|
|
40
|
+
};
|
|
41
|
+
|
|
42
|
+
for await (const peer of fetchNodes(() =>
|
|
43
|
+
this._search(domain, context)
|
|
44
|
+
)) {
|
|
45
|
+
yield peer;
|
|
46
|
+
}
|
|
95
47
|
}
|
|
96
48
|
}
|
|
97
49
|
|
|
@@ -165,7 +117,7 @@ export class DnsNodeDiscovery {
|
|
|
165
117
|
throw new Error("Received empty result array while fetching TXT record");
|
|
166
118
|
if (!response[0].length) throw new Error("Received empty TXT record");
|
|
167
119
|
|
|
168
|
-
// Branch entries can be an array of strings of comma
|
|
120
|
+
// Branch entries can be an array of strings of comma-delimited subdomains, with
|
|
169
121
|
// some subdomain strings split across the array elements
|
|
170
122
|
const result = response.join("");
|
|
171
123
|
|
package/src/dns/dns_discovery.ts
CHANGED
|
@@ -9,8 +9,7 @@ import type {
|
|
|
9
9
|
DiscoveryTrigger,
|
|
10
10
|
DnsDiscOptions,
|
|
11
11
|
DnsDiscoveryComponents,
|
|
12
|
-
IEnr
|
|
13
|
-
NodeCapabilityCount
|
|
12
|
+
IEnr
|
|
14
13
|
} from "@waku/interfaces";
|
|
15
14
|
import { DNS_DISCOVERY_TAG } from "@waku/interfaces";
|
|
16
15
|
import { encodeRelayShard, Logger } from "@waku/utils";
|
|
@@ -18,8 +17,7 @@ import { encodeRelayShard, Logger } from "@waku/utils";
|
|
|
18
17
|
import {
|
|
19
18
|
DEFAULT_BOOTSTRAP_TAG_NAME,
|
|
20
19
|
DEFAULT_BOOTSTRAP_TAG_TTL,
|
|
21
|
-
DEFAULT_BOOTSTRAP_TAG_VALUE
|
|
22
|
-
DEFAULT_NODE_REQUIREMENTS
|
|
20
|
+
DEFAULT_BOOTSTRAP_TAG_VALUE
|
|
23
21
|
} from "./constants.js";
|
|
24
22
|
import { DnsNodeDiscovery } from "./dns.js";
|
|
25
23
|
|
|
@@ -35,7 +33,7 @@ export class PeerDiscoveryDns
|
|
|
35
33
|
private nextPeer: (() => AsyncGenerator<IEnr>) | undefined;
|
|
36
34
|
private _started: boolean;
|
|
37
35
|
private _components: DnsDiscoveryComponents;
|
|
38
|
-
private _options: DnsDiscOptions;
|
|
36
|
+
private readonly _options: DnsDiscOptions;
|
|
39
37
|
|
|
40
38
|
public constructor(
|
|
41
39
|
components: DnsDiscoveryComponents,
|
|
@@ -65,14 +63,9 @@ export class PeerDiscoveryDns
|
|
|
65
63
|
let { enrUrls } = this._options;
|
|
66
64
|
if (!Array.isArray(enrUrls)) enrUrls = [enrUrls];
|
|
67
65
|
|
|
68
|
-
const { wantedNodeCapabilityCount } = this._options;
|
|
69
66
|
const dns = await DnsNodeDiscovery.dnsOverHttp();
|
|
70
67
|
|
|
71
|
-
this.nextPeer = dns.getNextPeer.bind(
|
|
72
|
-
dns,
|
|
73
|
-
enrUrls,
|
|
74
|
-
wantedNodeCapabilityCount
|
|
75
|
-
);
|
|
68
|
+
this.nextPeer = dns.getNextPeer.bind(dns, enrUrls);
|
|
76
69
|
}
|
|
77
70
|
|
|
78
71
|
for await (const peerEnr of this.nextPeer()) {
|
|
@@ -143,9 +136,8 @@ export class PeerDiscoveryDns
|
|
|
143
136
|
}
|
|
144
137
|
|
|
145
138
|
export function wakuDnsDiscovery(
|
|
146
|
-
enrUrls: string[]
|
|
147
|
-
wantedNodeCapabilityCount: Partial<NodeCapabilityCount> = DEFAULT_NODE_REQUIREMENTS
|
|
139
|
+
enrUrls: string[]
|
|
148
140
|
): (components: DnsDiscoveryComponents) => PeerDiscoveryDns {
|
|
149
141
|
return (components: DnsDiscoveryComponents) =>
|
|
150
|
-
new PeerDiscoveryDns(components, { enrUrls
|
|
142
|
+
new PeerDiscoveryDns(components, { enrUrls });
|
|
151
143
|
}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import type { DnsClient } from "@waku/interfaces";
|
|
2
2
|
import { Logger } from "@waku/utils";
|
|
3
3
|
import { bytesToUtf8 } from "@waku/utils/bytes";
|
|
4
|
-
import
|
|
4
|
+
import DnsOverHttpResolver from "dns-over-http-resolver";
|
|
5
5
|
|
|
6
6
|
const log = new Logger("dns-over-https");
|
|
7
7
|
|
|
@@ -9,25 +9,13 @@ export class DnsOverHttps implements DnsClient {
|
|
|
9
9
|
/**
|
|
10
10
|
* Create new Dns-Over-Http DNS client.
|
|
11
11
|
*
|
|
12
|
-
* @param endpoints The endpoints for Dns-Over-Https queries;
|
|
13
|
-
* Defaults to using dns-query's API..
|
|
14
|
-
* @param retries Retries if a given endpoint fails.
|
|
15
|
-
*
|
|
16
12
|
* @throws {code: string} If DNS query fails.
|
|
17
13
|
*/
|
|
18
|
-
public static async create(
|
|
19
|
-
|
|
20
|
-
retries?: number
|
|
21
|
-
): Promise<DnsOverHttps> {
|
|
22
|
-
const _endpoints = endpoints ?? (await wellknown.endpoints("doh"));
|
|
23
|
-
|
|
24
|
-
return new DnsOverHttps(_endpoints, retries);
|
|
14
|
+
public static async create(): Promise<DnsOverHttps> {
|
|
15
|
+
return new DnsOverHttps();
|
|
25
16
|
}
|
|
26
17
|
|
|
27
|
-
private constructor(
|
|
28
|
-
private endpoints: Endpoint[],
|
|
29
|
-
private retries: number = 3
|
|
30
|
-
) {}
|
|
18
|
+
private constructor(private resolver = new DnsOverHttpResolver()) {}
|
|
31
19
|
|
|
32
20
|
/**
|
|
33
21
|
* Resolves a TXT record
|
|
@@ -39,16 +27,7 @@ export class DnsOverHttps implements DnsClient {
|
|
|
39
27
|
public async resolveTXT(domain: string): Promise<string[]> {
|
|
40
28
|
let answers;
|
|
41
29
|
try {
|
|
42
|
-
|
|
43
|
-
{
|
|
44
|
-
question: { type: "TXT", name: domain }
|
|
45
|
-
},
|
|
46
|
-
{
|
|
47
|
-
endpoints: this.endpoints,
|
|
48
|
-
retries: this.retries
|
|
49
|
-
}
|
|
50
|
-
);
|
|
51
|
-
answers = res.answers;
|
|
30
|
+
answers = await this.resolver.resolveTxt(domain);
|
|
52
31
|
} catch (error) {
|
|
53
32
|
log.error("query failed: ", error);
|
|
54
33
|
throw new Error("DNS query failed");
|
|
@@ -56,13 +35,9 @@ export class DnsOverHttps implements DnsClient {
|
|
|
56
35
|
|
|
57
36
|
if (!answers) throw new Error(`Could not resolve ${domain}`);
|
|
58
37
|
|
|
59
|
-
const data = answers.map((a) => a.data) as
|
|
60
|
-
| Array<string | Uint8Array>
|
|
61
|
-
| Array<Array<string | Uint8Array>>;
|
|
62
|
-
|
|
63
38
|
const result: string[] = [];
|
|
64
39
|
|
|
65
|
-
|
|
40
|
+
answers.forEach((d) => {
|
|
66
41
|
if (typeof d === "string") {
|
|
67
42
|
result.push(d);
|
|
68
43
|
} else if (Array.isArray(d)) {
|