Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/libp2p/js-libp2p-mdns

libp2p MulticastDNS Peer Discovery
https://github.com/libp2p/js-libp2p-mdns

Last synced: 9 days ago
JSON representation

libp2p MulticastDNS Peer Discovery

Host: GitHub
URL: https://github.com/libp2p/js-libp2p-mdns
Owner: libp2p
License: other
Archived: true
Created: 2015-07-24T22:16:29.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2023-07-21T15:52:27.000Z (over 1 year ago)
Last Synced: 2024-08-12T21:27:46.881Z (3 months ago)
Language: TypeScript
Homepage: https://libp2p.io
Size: 1.84 MB
Stars: 52
Watchers: 21
Forks: 17
Open Issues: 5
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

awesome-peer-to-peer - libp2p-mdns-discovery

README

        # 📁 Archived - this module has been merged into [js-libp2p](https://github.com/libp2p/js-libp2p/tree/master/packages/peer-discovery-mdns)

# @libp2p/mdns 

[![libp2p.io](https://img.shields.io/badge/project-libp2p-yellow.svg?style=flat-square)](http://libp2p.io/)

[![Discuss](https://img.shields.io/discourse/https/discuss.libp2p.io/posts.svg?style=flat-square)](https://discuss.libp2p.io)

[![codecov](https://img.shields.io/codecov/c/github/libp2p/js-libp2p-mdns.svg?style=flat-square)](https://codecov.io/gh/libp2p/js-libp2p-mdns)

[![CI](https://img.shields.io/github/actions/workflow/status/libp2p/js-libp2p-mdns/js-test-and-release.yml?branch=master\&style=flat-square)](https://github.com/libp2p/js-libp2p-mdns/actions/workflows/js-test-and-release.yml?query=branch%3Amaster)

> Node.js libp2p mDNS discovery implementation for peer discovery

## Table of contents 

- [Install](#install)

- [Usage](#usage)

- [MDNS messages](#mdns-messages)

- [API Docs](#api-docs)

- [License](#license)

- [Contribute](#contribute)

## Install

```console

$ npm i @libp2p/mdns

```

## Usage

```Typescript

import { mdns } from '@libp2p/mdns'

const options = {

  peerDiscovery: [

    mdns()

  ]

}

async function start () {

  const libp2p = await createLibp2p(options)

  libp2p.on('peer:discovery', function (peerId) {

    console.log('found peer: ', peerId.toB58String())

  })

  await libp2p.start()

}

```

- options

  - `peerName` - Peer name to announce (should not be peeer id), default random string

  - `multiaddrs` - multiaddrs to announce

  - `broadcast` - (true/false) announce our presence through mDNS, default `false`

  - `interval` - query interval, default 10 \* 1000 (10 seconds)

  - `serviceTag` - name of the service announce , default 'ipfs.local\`

## MDNS messages

A query is sent to discover the IPFS nodes on the local network

```js

{

  type: 'query',

  questions: [ { name: 'ipfs.local', type: 'PTR' } ]

}

```

When a query is detected, each IPFS node sends an answer about itself

```js

    [ { name: 'ipfs.local',

        type: 'PTR',

        class: 'IN',

        ttl: 120,

        data: 'QmNPubsDWATVngE3d5WDSNe7eVrFLuk38qb9t6vdLnu2aK.ipfs.local' },

      { name: 'QmNPubsDWATVngE3d5WDSNe7eVrFLuk38qb9t6vdLnu2aK.ipfs.local',

        type: 'SRV',

        class: 'IN',

        ttl: 120,

        data:

         { priority: 10,

           weight: 1,

           port: '20002',

           target: 'LAPTOP-G5LJ7VN9' } },

      { name: 'QmNPubsDWATVngE3d5WDSNe7eVrFLuk38qb9t6vdLnu2aK.ipfs.local',

        type: 'TXT',

        class: 'IN',

        ttl: 120,

        data: ['QmNPubsDWATVngE3d5WDSNe7eVrFLuk38qb9t6vdLnu2aK'] },

      { name: 'LAPTOP-G5LJ7VN9',

        type: 'A',

        class: 'IN',

        ttl: 120,

        data: '127.0.0.1' },

      { name: 'LAPTOP-G5LJ7VN9',

        type: 'AAAA',

        class: 'IN',

        ttl: 120,

        data: '::1' } ]

```

## API Docs

- 

## License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](LICENSE-APACHE) / )

- MIT ([LICENSE-MIT](LICENSE-MIT) / )

## Contribute

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.