@libp2p/autonat

Implementation of Autonat Protocol

About

The AutoNAT service uses the AutoNAT protocol. The service confirms addresses are dialable by remote peers, and updates the list it advertises.

The service dials randomly selected peers with a request to verify it's external addresses. The request includes a list of public multiaddrs (addressManager.getObservedAddrs()). The remote peers dial that list and respond with the results.

The AutoNAT service uses those responses to either:

• addressManager.confirmObservedAddr(addr)
• addressManager.removeObservedAddr(addr)

The result list of candidates and confirmed addresses can be found at addressManager.getObservedAddrs()

Example

import { createLibp2p } from 'libp2p'
import { autoNAT } from '@libp2p/autonat'

const node = await createLibp2p({
  // ...other options
  services: {
    autoNAT: autoNAT()
  }
})
Copy

Install

$ npm i @libp2p/autonat
Copy

Browser <script> tag

Loading this module through a script tag will make its exports available as Libp2pAutonat in the global namespace.

<script src="https://unpkg.com/@libp2p/autonat/dist/index.min.js"></script>
Copy

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_autonat.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.