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

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

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

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.

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

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

Install

`console
$ npm i @libp2p/circuit-relay-v2
`

Browser
``

API Docs

-

License

Licensed under either of

- Apache 2.0, (LICENSE-APACHE / )
- MIT (LICENSE-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.