Skip to content

Commit 8ad44f7

Browse files
authored
docs: update autonat readme (#3199)
Update readme to link to v2 module
1 parent 1a716dc commit 8ad44f7

File tree

2 files changed

+14
-23
lines changed

2 files changed

+14
-23
lines changed

packages/protocol-autonat/README.md

Lines changed: 7 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,20 +24,15 @@ repo and examine the changes made.
2424
2525
-->
2626

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.
2930

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.
3332

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.
4136
4237
## Example
4338

packages/protocol-autonat/src/index.ts

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,15 @@
11
/**
22
* @packageDocumentation
33
*
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.
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.
67
*
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.
8+
* It does not implement NAT hole punching.
109
*
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()
10+
* > [!IMPORTANT]
11+
* > [AutoNat v2](https://www.npmjs.com/package/@libp2p/autonat-v2) is now
12+
* > available and should be preferred to this module.
1713
*
1814
* @example
1915
*

0 commit comments

Comments
 (0)