@libp2p/dcutr NPM | npm.io

1.0.19 • Published 2 days ago

Install

Weekly downloads

-

License

Apache-2.0 OR MIT

Repository

Last release

2 days ago

Implementation of the DCUtR Protocol

About

Direct Connection Upgrade through Relay (DCUtR) is a protocol that allows two nodes to connect to each other who would otherwise be prevented doing so due to being behind NATed connections or firewalls.

The protocol involves making a relayed connection between the two peers and using the relay to synchronise connection timings so that they dial each other at precisely the same moment.

Example

import { createLibp2p } from 'libp2p'
import { circuitRelayTransport } from 'libp2p/circuit-relay'
import { tcp } from '@libp2p/tcp'
import { identify } from '@libp2p/identify'
import { dcutr } from '@libp2p/dcutr'

const node = await createLibp2p({
  transports: [
    circuitRelayTransport(),
    tcp()
  ],
  services: {
    identify: identify(),
    dcutr: dcutr()
  }
})

// QmTarget is a peer that is behind a NAT, supports TCP and has a relay
// reservation
await node.dial('/ip4/.../p2p/QmRelay/p2p-circuit/p2p/QmTarget')

// after a while the connection should automatically get upgraded to a
// direct connection (e.g. non-transient)
while (true) {
  const connections = node.getConnections()

  if (connections.find(conn => conn.transient === false)) {
    console.info('have direct connection')
    break
  } else {
    console.info('have relayed connection')

    // wait a few seconds to see if it's succeeded yet
    await new Promise((resolve) => {
      setTimeout(() => resolve(), 5000)
    })
  }
}

Install

$ npm i @libp2p/dcutr

Browser `<script>` tag

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

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

API Docs

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

@libp2p/interface @libp2p/interface-internal @libp2p/utils @multiformats/multiaddr @multiformats/multiaddr-matcher delay it-protobuf-stream protons-runtime uint8arraylist

@everything-registry/sub-chunk-546 helia ipfs-node ipdw @soketi/p2p @constl/ipa @blockless/browser-node

1.0.19-7ae6063df

2 days ago

1.0.19-d9366f9aa

5 days ago

1.0.19-4ad63bb79

5 days ago

1.0.19-bfa7660d5

5 days ago

1.0.19-1488a7371

5 days ago

1.0.19-510d9ce65

5 days ago

1.0.19-767b23e71

5 days ago

1.0.19-a11e135c2

10 days ago

1.0.18-de3f7aeaf

11 days ago

1.0.19-9d13a2f6a

11 days ago

11 days ago

1.0.18-c82432312

12 days ago

1.0.18-3bc94b403

12 days ago

1.0.18-3d7a9da17

12 days ago

1.0.18-998fcaf94

16 days ago

1.0.18-e1923b0a7

16 days ago

1.0.18-90cfd25e2

17 days ago

1.0.17-c2181f0cf

18 days ago

18 days ago

1.0.17-2281f802b

18 days ago

1.0.17-fd1f8343d

19 days ago

1.0.17-eaf8ac7cf

20 days ago

1.0.17-acef72613

20 days ago

26 days ago

1.0.17-ea4f26285

26 days ago

1.0.16-08dabd390

27 days ago

1.0.16-31c78f4ed

27 days ago

1.0.15-2c56203f9

1 month ago

30 days ago

1.0.15-b17824a1d

30 days ago

1.0.15-936dbba10

1 month ago

1.0.15-732c436d4

1 month ago

1.0.15-2b2958fe6

1 month ago

1.0.14-3e515f007

1 month ago

1 month ago

1.0.14-d446c6c31

1 month ago

1.0.14-a2b41f793

1 month ago

1.0.14-4fc0a7d30

1 month ago

1.0.14-ab5f05763

1 month ago

1.0.14-afe15f669

1 month ago

1.0.14-3ffecc5bf

1 month ago

1.0.14-1f589c822

1 month ago

1.0.14-80278b36b

1 month ago

1.0.13-82901e785

2 months ago

1.0.13-330a5ed72

2 months ago

1.0.13-1fc929c1c

2 months ago

1.0.13-59a97b61b

2 months ago

1.0.13-bf720c045

2 months ago

2 months ago

1.0.13-cad9cf007

2 months ago

1.0.13-e1798aa26

2 months ago

1.0.13-fad3074b8

2 months ago

1.0.13-f39ce5f13

2 months ago

1.0.13-83ef3717e

2 months ago

1.0.13-ab466004b

2 months ago

1.0.13-a9cc0ee49

2 months ago

1.0.13-2122a713d

2 months ago

1.0.13-28e51652a

2 months ago

1.0.13-f71bc49bd

2 months ago

2 months ago

1.0.12-f0d2b52d0

3 months ago

1.0.12-bedfd0aa2

3 months ago

1.0.12-8072a2e59

3 months ago

1.0.12-b1b77adb4

3 months ago

1.0.12-e1c01370b

3 months ago

1.0.12-fb7c51c3c

3 months ago

1.0.10-03ff9fd82

3 months ago

1.0.10-dab5cf724

3 months ago

1.0.10-0321812e7

3 months ago

1.0.10-9891ecd73

3 months ago

1.0.11-0c7bbbb07

3 months ago

1.0.10-2370d1c39

3 months ago

1.0.10-1cb2408ac

3 months ago

3 months ago

3 months ago

1.0.10-e1db332a4

3 months ago

1.0.10-6f323de7d

3 months ago

1.0.10-c9ed1c7d6

4 months ago

1.0.9-f4dda4a3c

4 months ago

1.0.9-dbc92ab74

4 months ago

1.0.9-2e464c099

4 months ago

1.0.9-72f0e09f7

4 months ago

1.0.9-74fb5671d

4 months ago

4 months ago

1.0.9-3e47d88fd

4 months ago

1.0.9-f27138ca1

4 months ago

1.0.9-8c6654c3a

4 months ago

1.0.9-9376e61a1

4 months ago

1.0.9-08f6f607d

4 months ago

1.0.9-74477f6ea

4 months ago

4 months ago

1.0.8-092861e23

4 months ago

4 months ago

1.0.7-856ccd708

4 months ago

1.0.7-ddaa59a60

4 months ago

1.0.8-8bbd43628

4 months ago

1.0.7-4691f4173

4 months ago

1.0.7-ee7ffe9b9

4 months ago

1.0.7-821a38e24

4 months ago

1.0.7-900236724

4 months ago

4 months ago

1.0.6-528d73781

4 months ago

1.0.6-444d83751

4 months ago

1.0.6-d011f6130

4 months ago

1.0.6-581574d6d

4 months ago

1.0.6-ba7089984

4 months ago

1.0.6-388d02b33

4 months ago

4 months ago

1.0.5-5d1f68e92

5 months ago

1.0.5-28587d24f

5 months ago

1.0.5-4e0135c7d

5 months ago

1.0.5-6fd681d09

5 months ago

1.0.5-178fe2671

5 months ago

1.0.5-cd8cafcd5

5 months ago

1.0.5-c00378909

5 months ago

1.0.5-83dfc7dc8

5 months ago

1.0.5-f71f2e14e

5 months ago

1.0.5-984f13e42

5 months ago

1.0.5-07f3afe2d

5 months ago

1.0.5-ad6f70bf3

5 months ago

1.0.5-9eff7eff0

5 months ago

1.0.5-a7c6a93c6

5 months ago

1.0.5-230afea4b

5 months ago

1.0.5-f81be145a

5 months ago

1.0.5-01e9a5fe4

5 months ago

5 months ago

1.0.5-742915567

5 months ago

1.0.4-341581166

5 months ago

1.0.4-6d11e8268

5 months ago

1.0.3-d10506189

5 months ago

5 months ago

1.0.3-64a915ae9

5 months ago

1.0.3-3bf6387ff

5 months ago

1.0.3-93890c8f9

5 months ago

1.0.3-16588d27c

5 months ago

1.0.3-887c6ffe1

5 months ago

1.0.3-bcfa15993

5 months ago

1.0.3-10ea19700

5 months ago

1.0.3-09dd02987

5 months ago

1.0.3-5a9362e21

5 months ago

5 months ago

1.0.2-738dd40f1

5 months ago

5 months ago

1.0.1-7861ed882

5 months ago

1.0.1-9197f10ba

5 months ago

1.0.1-e7167fe52

5 months ago

1.0.1-f537b3731

5 months ago

1.0.1-8c169db1b

5 months ago

1.0.1-561797a89

5 months ago

1.0.1-cf963694f

5 months ago

1.0.1-bca8d6e68

5 months ago

5 months ago

1.0.1-53224004f

5 months ago

1.0.0-273d8177c

5 months ago

1.0.1-6c1f0ee81

5 months ago

1.0.0-a32e70bac

5 months ago

1.0.0-06e6d235f

5 months ago

1.0.0-bcf18265e

5 months ago

1.0.0-8e4fbe13a

5 months ago

1.0.0-7682861f9

5 months ago

1.0.0-551622a96

5 months ago

6 months ago

0.0.0-8f921ee97

6 months ago

0.0.0-74e84bc29

6 months ago

0.0.0-8bb6d5333

6 months ago

0.0.0-7877a50e0

6 months ago

0.0.0-68db79f6b

6 months ago

0.0.0-e2267d437

6 months ago

0.0.0-4a474d54d

6 months ago

0.0.0-0b4a2ee79

6 months ago

0.0.0-6b6ba9ab7

6 months ago

0.0.0-d729d66a5

6 months ago

0.0.0-bb6ceb192

6 months ago

0.0.0-d8f5bc211

6 months ago

0.0.0-13a870cbe

6 months ago

0.0.0-3dee5df4d

6 months ago

0.0.0-adea7bbbf

6 months ago

0.0.0-6625a27fc

6 months ago

0.0.0-9c67c5b3d

6 months ago

0.0.0-05b52d69c

6 months ago

0.0.0-97ab31c0c

6 months ago

6 months ago