@libp2p/autonat 2.0.36 → 2.0.37-87e5d5938

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 +7 -12
  2. package/dist/index.min.js +1 -1
  3. package/dist/index.min.js.map +3 -3
  4. package/dist/src/index.d.ts +7 -11
  5. package/dist/src/index.d.ts.map +1 -1
  6. package/dist/src/index.js +7 -11
  7. package/dist/src/index.js.map +1 -1
  8. package/package.json +8 -8
  9. package/src/index.ts +7 -11
  10. package/dist/typedoc-urls.json +0 -8
package/README.md CHANGED
@@ -24,20 +24,15 @@ repo and examine the changes made.
24
24
 
25
25
  -->
26
26
 
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.
27
+ The AutoNAT service implements the [AutoNAT protocol](https://docs.libp2p.io/concepts/nat/autonat/)
28
+ to confirm whether addresses the node is listening on are dialable by remote
29
+ peers.
29
30
 
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.
31
+ It does not implement NAT hole punching.
33
32
 
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()
33
+ > \[!IMPORTANT]
34
+ > [AutoNat v2](https://www.npmjs.com/package/@libp2p/autonat-v2) is now
35
+ > available and should be preferred to this module.
41
36
 
42
37
  ## Example
43
38