@libp2p/autonat 2.0.36-8ad44f759 → 2.0.36

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 (10) hide show
  1. package/README.md +12 -7
  2. package/dist/index.min.js +1 -1
  3. package/dist/index.min.js.map +3 -3
  4. package/dist/src/index.d.ts +11 -7
  5. package/dist/src/index.d.ts.map +1 -1
  6. package/dist/src/index.js +11 -7
  7. package/dist/src/index.js.map +1 -1
  8. package/dist/typedoc-urls.json +8 -0
  9. package/package.json +8 -8
  10. package/src/index.ts +11 -7
package/dist/src/index.d.ts CHANGED
@@ -1,15 +1,19 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * The AutoNAT service implements the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
5
- * to confirm whether addresses the node is listening on are dialable by remote
6
- * peers.
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.
7
6
  *
8
- * It does not implement NAT hole punching.
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.
9
10
  *
10
- * > [!IMPORTANT]
11
- * > [AutoNat v2](https://www.npmjs.com/package/@libp2p/autonat-v2) is now
12
- * > available and should be preferred to this module.
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()
13
17
  *
14
18
  * @example
15
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;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAGH,OAAO,KAAK,EAAE,eAAe,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClG,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC5H,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAElD,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;IAE3B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;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,MAAM,EAAE,eAAe,CAAA;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACtC,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;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,YAAY,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAA;AAClG,OAAO,KAAK,EAAE,cAAc,EAAE,iBAAiB,EAAE,UAAU,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAA;AAC5H,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAElD,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;IAE3B;;;;;;;;OAQG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;;;;OAKG;IACH,cAAc,CAAC,EAAE,MAAM,CAAA;CACxB;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,MAAM,EAAE,eAAe,CAAA;IACvB,UAAU,EAAE,UAAU,CAAA;IACtB,MAAM,EAAE,gBAAgB,CAAC,YAAY,CAAC,CAAA;IACtC,SAAS,EAAE,SAAS,CAAA;IACpB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,wBAAgB,OAAO,CAAE,IAAI,GAAE,kBAAuB,GAAG,CAAC,UAAU,EAAE,iBAAiB,KAAK,OAAO,CAIlG"}
package/dist/src/index.js CHANGED
@@ -1,15 +1,19 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * The AutoNAT service implements the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
5
- * to confirm whether addresses the node is listening on are dialable by remote
6
- * peers.
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.
7
6
  *
8
- * It does not implement NAT hole punching.
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.
9
10
  *
10
- * > [!IMPORTANT]
11
- * > [AutoNat v2](https://www.npmjs.com/package/@libp2p/autonat-v2) is now
12
- * > available and should be preferred to this module.
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()
13
17
  *
14
18
  * @example
15
19
  *
package/dist/src/index.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAA;AAqE7C,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;AAqE7C,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/dist/typedoc-urls.json ADDED
@@ -0,0 +1,8 @@
1
+ {
2
+ "AutoNATComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_autonat.AutoNATComponents.html",
3
+ ".:AutoNATComponents": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_autonat.AutoNATComponents.html",
4
+ "AutoNATServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_autonat.AutoNATServiceInit.html",
5
+ ".:AutoNATServiceInit": "https://libp2p.github.io/js-libp2p/interfaces/_libp2p_autonat.AutoNATServiceInit.html",
6
+ "autoNAT": "https://libp2p.github.io/js-libp2p/functions/_libp2p_autonat.autoNAT.html",
7
+ ".:autoNAT": "https://libp2p.github.io/js-libp2p/functions/_libp2p_autonat.autoNAT.html"
8
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@libp2p/autonat",
3
- "version": "2.0.36-8ad44f759",
3
+ "version": "2.0.36",
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",
@@ -45,11 +45,11 @@
45
45
  "doc-check": "aegir doc-check"
46
46
  },
47
47
  "dependencies": {
48
- "@libp2p/interface": "2.10.4-8ad44f759",
49
- "@libp2p/interface-internal": "2.3.17-8ad44f759",
50
- "@libp2p/peer-collections": "6.0.33-8ad44f759",
51
- "@libp2p/peer-id": "5.1.7-8ad44f759",
52
- "@libp2p/utils": "6.7.0-8ad44f759",
48
+ "@libp2p/interface": "^2.10.4",
49
+ "@libp2p/interface-internal": "^2.3.17",
50
+ "@libp2p/peer-collections": "^6.0.33",
51
+ "@libp2p/peer-id": "^5.1.7",
52
+ "@libp2p/utils": "^6.7.0",
53
53
  "@multiformats/multiaddr": "^12.4.4",
54
54
  "any-signal": "^4.1.1",
55
55
  "it-protobuf-stream": "^2.0.2",
@@ -59,8 +59,8 @@
59
59
  "uint8arraylist": "^2.4.8"
60
60
  },
61
61
  "devDependencies": {
62
- "@libp2p/crypto": "5.1.6-8ad44f759",
63
- "@libp2p/logger": "5.1.20-8ad44f759",
62
+ "@libp2p/crypto": "^5.1.6",
63
+ "@libp2p/logger": "^5.1.20",
64
64
  "aegir": "^47.0.14",
65
65
  "it-all": "^3.0.8",
66
66
  "it-drain": "^3.0.9",
package/src/index.ts CHANGED
@@ -1,15 +1,19 @@
1
1
  /**
2
2
  * @packageDocumentation
3
3
  *
4
- * The AutoNAT service implements the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
5
- * to confirm whether addresses the node is listening on are dialable by remote
6
- * peers.
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.
7
6
  *
8
- * It does not implement NAT hole punching.
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.
9
10
  *
10
- * > [!IMPORTANT]
11
- * > [AutoNat v2](https://www.npmjs.com/package/@libp2p/autonat-v2) is now
12
- * > available and should be preferred to this module.
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()
13
17
  *
14
18
  * @example
15
19
  *