@libp2p/autonat 1.0.13-59a97b61b → 1.0.13-82901e785

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.
Files changed (7) hide show
  1. package/README.md +14 -2
  2. package/dist/src/index.d.ts +13 -2
  3. package/dist/src/index.d.ts.map +1 -1
  4. package/dist/src/index.js +13 -2
  5. package/dist/src/index.js.map +1 -1
  6. package/package.json +7 -7
  7. package/src/index.ts +13 -2
package/README.md CHANGED
@@ -24,8 +24,20 @@ repo and examine the changes made.
24
24
 
25
25
  -->
26
26
 
27
- Use the `autoNATService` function to add support for the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
28
- to libp2p.
27
+ The AutoNAT service uses the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/).
28
+ The service confirms addresses are dialable by remote peers, and updates the list it advertises.
29
+
30
+ The service dials randomly selected peers with a request to verify it's external addresses.
31
+ The request includes a list of public multiaddrs (addressManager.getObservedAddrs()).
32
+ The remote peers dial that list and respond with the results.
33
+
34
+ The AutoNAT service uses those responses to either:
35
+
36
+ - addressManager.confirmObservedAddr(addr)
37
+ - addressManager.removeObservedAddr(addr)
38
+
39
+ The result list of candidates and confirmed addresses can be found
40
+ at addressManager.getObservedAddrs()
29
41
 
30
42
  ## Example
31
43
 
package/dist/src/index.d.ts CHANGED
@@ -1,8 +1,19 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * Use the `autoNATService` function to add support for the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
5
- * to libp2p.
4
+ * The AutoNAT service uses the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/).
5
+ * The service confirms addresses are dialable by remote peers, and updates the list it advertises.
6
+ *
7
+ * The service dials randomly selected peers with a request to verify it's external addresses.
8
+ * The request includes a list of public multiaddrs (addressManager.getObservedAddrs()).
9
+ * The remote peers dial that list and respond with the results.
10
+ *
11
+ * The AutoNAT service uses those responses to either:
12
+ * - addressManager.confirmObservedAddr(addr)
13
+ * - addressManager.removeObservedAddr(addr)
14
+ *
15
+ * The result list of candidates and confirmed addresses can be found
16
+ * at addressManager.getObservedAddrs()
6
17
  *
7
18
  * @example
8
19
  *
package/dist/src/index.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAEhH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,WAAW,EAAE,WAAW,CAAA;IACxB,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,wBAAgB,OAAO,CAAE,IAAI,GAAE,kBAAuB,GAAG,CAAC,UAAU,EAAE,iBAAiB,KAAK,OAAO,CAIlG"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAA;AAC7E,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAEhH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;IAEvB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAA;CAC5B;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,SAAS,CAAA;IACpB,cAAc,EAAE,cAAc,CAAA;IAC9B,gBAAgB,EAAE,gBAAgB,CAAA;IAClC,MAAM,EAAE,MAAM,CAAA;IACd,iBAAiB,EAAE,iBAAiB,CAAA;IACpC,WAAW,EAAE,WAAW,CAAA;IACxB,MAAM,EAAE,eAAe,CAAA;CACxB;AAED,wBAAgB,OAAO,CAAE,IAAI,GAAE,kBAAuB,GAAG,CAAC,UAAU,EAAE,iBAAiB,KAAK,OAAO,CAIlG"}
package/dist/src/index.js CHANGED
@@ -1,8 +1,19 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * Use the `autoNATService` function to add support for the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
5
- * to libp2p.
4
+ * The AutoNAT service uses the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/).
5
+ * The service confirms addresses are dialable by remote peers, and updates the list it advertises.
6
+ *
7
+ * The service dials randomly selected peers with a request to verify it's external addresses.
8
+ * The request includes a list of public multiaddrs (addressManager.getObservedAddrs()).
9
+ * The remote peers dial that list and respond with the results.
10
+ *
11
+ * The AutoNAT service uses those responses to either:
12
+ * - addressManager.confirmObservedAddr(addr)
13
+ * - addressManager.removeObservedAddr(addr)
14
+ *
15
+ * The result list of candidates and confirmed addresses can be found
16
+ * at addressManager.getObservedAddrs()
6
17
  *
7
18
  * @example
8
19
  *
package/dist/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;GAmBG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AA8C7C,MAAM,UAAU,OAAO,CAAE,OAA2B,EAAE;IACpD,OAAO,CAAC,UAAU,EAAE,EAAE;QACpB,OAAO,IAAI,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAC7C,CAAC,CAAA;AACH,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8BG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AA8C7C,MAAM,UAAU,OAAO,CAAE,OAA2B,EAAE;IACpD,OAAO,CAAC,UAAU,EAAE,EAAE;QACpB,OAAO,IAAI,cAAc,CAAC,UAAU,EAAE,IAAI,CAAC,CAAA;IAC7C,CAAC,CAAA;AACH,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/autonat",
3
- "version": "1.0.13-59a97b61b",
3
+ "version": "1.0.13-82901e785",
4
4
  "description": "Implementation of Autonat Protocol",
5
5
  "license": "Apache-2.0 OR MIT",
6
6
  "homepage": "https://github.com/libp2p/js-libp2p/tree/main/packages/protocol-autonat#readme",
@@ -52,11 +52,11 @@
52
52
  "doc-check": "aegir doc-check"
53
53
  },
54
54
  "dependencies": {
55
- "@libp2p/interface": "1.1.4-59a97b61b",
56
- "@libp2p/interface-internal": "1.0.9-59a97b61b",
57
- "@libp2p/peer-id": "4.0.7-59a97b61b",
58
- "@libp2p/peer-id-factory": "4.0.7-59a97b61b",
59
- "@libp2p/utils": "5.2.6-59a97b61b",
55
+ "@libp2p/interface": "1.1.4-82901e785",
56
+ "@libp2p/interface-internal": "1.0.9-82901e785",
57
+ "@libp2p/peer-id": "4.0.7-82901e785",
58
+ "@libp2p/peer-id-factory": "4.0.7-82901e785",
59
+ "@libp2p/utils": "5.2.6-82901e785",
60
60
  "@multiformats/multiaddr": "^12.1.14",
61
61
  "it-first": "^3.0.4",
62
62
  "it-length-prefixed": "^9.0.4",
@@ -67,7 +67,7 @@
67
67
  "uint8arraylist": "^2.4.8"
68
68
  },
69
69
  "devDependencies": {
70
- "@libp2p/logger": "4.0.7-59a97b61b",
70
+ "@libp2p/logger": "4.0.7-82901e785",
71
71
  "aegir": "^42.2.4",
72
72
  "it-all": "^3.0.4",
73
73
  "it-pushable": "^3.2.3",
package/src/index.ts CHANGED
@@ -1,8 +1,19 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * Use the `autoNATService` function to add support for the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
5
- * to libp2p.
4
+ * The AutoNAT service uses the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/).
5
+ * The service confirms addresses are dialable by remote peers, and updates the list it advertises.
6
+ *
7
+ * The service dials randomly selected peers with a request to verify it's external addresses.
8
+ * The request includes a list of public multiaddrs (addressManager.getObservedAddrs()).
9
+ * The remote peers dial that list and respond with the results.
10
+ *
11
+ * The AutoNAT service uses those responses to either:
12
+ * - addressManager.confirmObservedAddr(addr)
13
+ * - addressManager.removeObservedAddr(addr)
14
+ *
15
+ * The result list of candidates and confirmed addresses can be found
16
+ * at addressManager.getObservedAddrs()
6
17
  *
7
18
  * @example
8
19
  *