@libp2p/echo

Implementation of an Echo protocol

About

An implementation of a simple Echo protocol.

Any data received by the receiver will be sent back to the sender.

Example

import { noise } from '@chainsafe/libp2p-noise'
import { yamux } from '@chainsafe/libp2p-yamux'
import { echo } from '@libp2p/echo'
import { peerIdFromString } from '@libp2p/peer-id'
import { createLibp2p } from 'libp2p'

const receiver = await createLibp2p({
  addresses: {
    listen: ['/ip4/0.0.0.0/tcp/0']
  },
  connectionEncryption: [noise()],
  streamMuxers: [yamux()],
  services: {
    echo: echo()
  }
})

const sender = await createLibp2p({
  addresses: {
    listen: ['/ip4/0.0.0.0/tcp/0']
  },
  connectionEncryption: [noise()],
  streamMuxers: [yamux()],
  services: {
    echo: echo()
  }
})

const stream = await sender.dialProtocol(receiver.getMultiaddrs(), sender.services.echo.protocol)

// write/read stream

Install

$ npm i @libp2p/echo

Browser <script> tag

Loading this module through a script tag will make it's exports available as Libp2pEcho in the global namespace.

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

API Docs

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