@libp2p/autonat

Implementation of Autonat Protocol

About

The AutoNAT service implements the AutoNAT protocol to confirm whether addresses the node is listening on are dialable by remote peers.

It does not implement NAT hole punching.

[!IMPORTANT] AutoNat v2 is now available and should be preferred to this module.

Example

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

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

Install

$ npm i @libp2p/autonat

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>

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.