@libp2p/circuit-relay-v2

Implementation of Circuit Relay v2

About

The circuitRelayTransport allows libp2p to dial and listen on Circuit Relay addresses.

Example - Use as a transport

Configuring a transport will let you dial other circuit relay addresses.

import { createLibp2p } from 'libp2p'
import { circuitRelayTransport } from '@libp2p/circuit-relay-v2'

const node = await createLibp2p({
  transports: [
    circuitRelayTransport()
  ]
})
Copy

The circuitRelayServer function allows libp2p to function as a Circuit Relay server. This will not work in browsers.

Example - Use as a server

Configuring a server will let you function as a network relay for other nodes.

import { createLibp2p } from 'libp2p'
import { circuitRelayServer } from '@libp2p/circuit-relay-v2'

const node = await createLibp2p({
  services: {
    circuitRelay: circuitRelayServer()
  }
})
Copy

Install

$ npm i @libp2p/circuit-relay-v2
Copy

Browser <script> tag

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

<script src="https://unpkg.com/@libp2p/circuit-relay-v2/dist/index.min.js"></script>
Copy

API Docs

• https://libp2p.github.io/js-libp2p/modules/_libp2p_circuit_relay_v2.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.