mirror of
https://github.com/fluencelabs/js-libp2p-tcp
synced 2025-07-02 05:11:42 +00:00
Compare commits
12 Commits
Author | SHA1 | Date | |
---|---|---|---|
a0c23e49f7 | |||
66ab208182 | |||
168d111158 | |||
4b04b17dfa | |||
6c36a46831 | |||
d39ec2db40 | |||
79428f3e62 | |||
8a394b5286 | |||
b7f73bcda1 | |||
8b44aa28ee | |||
ded1f6831c | |||
5ef24695fc |
3
.gitignore
vendored
3
.gitignore
vendored
@ -4,6 +4,9 @@ docs
|
||||
test/repo-tests*
|
||||
**/bundle.js
|
||||
|
||||
# yarn
|
||||
yarn.lock
|
||||
|
||||
# Logs
|
||||
logs
|
||||
*.log
|
||||
|
20
CHANGELOG.md
20
CHANGELOG.md
@ -1,3 +1,23 @@
|
||||
<a name="0.12.1"></a>
|
||||
## [0.12.1](https://github.com/libp2p/js-libp2p-tcp/compare/v0.12.0...v0.12.1) (2018-07-31)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* invalid ip address and daemon can be crashed by remote user ([4b04b17](https://github.com/libp2p/js-libp2p-tcp/commit/4b04b17))
|
||||
|
||||
|
||||
|
||||
<a name="0.12.0"></a>
|
||||
# [0.12.0](https://github.com/libp2p/js-libp2p-tcp/compare/v0.11.6...v0.12.0) (2018-04-05)
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* add class-is module ([ded1f68](https://github.com/libp2p/js-libp2p-tcp/commit/ded1f68))
|
||||
|
||||
|
||||
|
||||
<a name="0.11.6"></a>
|
||||
## [0.11.6](https://github.com/libp2p/js-libp2p-tcp/compare/v0.11.5...v0.11.6) (2018-02-20)
|
||||
|
||||
|
29
README.md
29
README.md
@ -15,6 +15,10 @@
|
||||
|
||||
> JavaScript implementation of the TCP module for libp2p. It exposes the [interface-transport](https://github.com/libp2p/interface-connection) for dial/listen. `libp2p-tcp` is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
|
||||
|
||||
## Lead Maintainer
|
||||
|
||||
[Jacob Heun](https://github.com/jacobheun)
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [Install](#install)
|
||||
@ -39,12 +43,11 @@ const TCP = require('libp2p-tcp')
|
||||
const multiaddr = require('multiaddr')
|
||||
const pull = require('pull-stream')
|
||||
|
||||
const mh1 = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
||||
const mh2 = multiaddr('/ip6/::/tcp/9092')
|
||||
const mh = multiaddr('/ip4/127.0.0.1/tcp/9090')
|
||||
|
||||
const tcp = new TCP()
|
||||
|
||||
const listener = tcp.createListener(mh1, (socket) => {
|
||||
const listener = tcp.createListener((socket) => {
|
||||
console.log('new connection opened')
|
||||
pull(
|
||||
pull.values(['hello']),
|
||||
@ -52,15 +55,21 @@ const listener = tcp.createListener(mh1, (socket) => {
|
||||
)
|
||||
})
|
||||
|
||||
listener.listen(() => {
|
||||
listener.listen(mh, () => {
|
||||
console.log('listening')
|
||||
|
||||
pull(
|
||||
tcp.dial(mh1),
|
||||
pull.log,
|
||||
pull.onEnd(() => {
|
||||
tcp.close()
|
||||
})
|
||||
tcp.dial(mh),
|
||||
pull.collect((err, values) => {
|
||||
if (!err) {
|
||||
console.log(`Value: ${values.toString()}`)
|
||||
} else {
|
||||
console.log(`Error: ${err}`)
|
||||
}
|
||||
|
||||
// Close connection after reading
|
||||
listener.close()
|
||||
}),
|
||||
)
|
||||
})
|
||||
```
|
||||
@ -70,7 +79,7 @@ Outputs:
|
||||
```sh
|
||||
listening
|
||||
new connection opened
|
||||
hello
|
||||
Value: hello
|
||||
```
|
||||
|
||||
## API
|
||||
|
25
package.json
25
package.json
@ -1,11 +1,12 @@
|
||||
{
|
||||
"name": "libp2p-tcp",
|
||||
"version": "0.11.6",
|
||||
"version": "0.12.1",
|
||||
"description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
|
||||
"leadMaintainer": "Jacob Heun <jacobheun@gmail.com>",
|
||||
"main": "src/index.js",
|
||||
"scripts": {
|
||||
"lint": "aegir lint",
|
||||
"test": "aegir test -t node",
|
||||
"test": "aegir test -t node -f test/**/*.js",
|
||||
"release": "aegir release -t node --no-build",
|
||||
"release-minor": "aegir release -t node --type minor --no-build",
|
||||
"release-major": "aegir-release -t node --type major --no-build",
|
||||
@ -23,7 +24,6 @@
|
||||
"keywords": [
|
||||
"IPFS"
|
||||
],
|
||||
"author": "David Dias <daviddias@ipfs.io>",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/libp2p/js-libp2p-tcp/issues"
|
||||
@ -34,36 +34,41 @@
|
||||
"npm": ">=3.0.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"aegir": "^13.0.5",
|
||||
"aegir": "^15.1.0",
|
||||
"chai": "^4.1.2",
|
||||
"dirty-chai": "^2.0.1",
|
||||
"interface-transport": "~0.3.5",
|
||||
"interface-transport": "~0.3.6",
|
||||
"lodash.isfunction": "^3.0.9",
|
||||
"pre-commit": "^1.2.2",
|
||||
"pull-stream": "^3.6.2"
|
||||
"pull-stream": "^3.6.7"
|
||||
},
|
||||
"dependencies": {
|
||||
"class-is": "^1.1.0",
|
||||
"debug": "^3.1.0",
|
||||
"interface-connection": "~0.3.2",
|
||||
"ip-address": "^5.8.9",
|
||||
"lodash.includes": "^4.3.0",
|
||||
"lodash.isfunction": "^3.0.9",
|
||||
"mafmt": "^4.0.0",
|
||||
"multiaddr": "^3.0.2",
|
||||
"mafmt": "^6.0.0",
|
||||
"multiaddr": "^4.0.0",
|
||||
"once": "^1.4.0",
|
||||
"stream-to-pull-stream": "^1.7.2"
|
||||
},
|
||||
"contributors": [
|
||||
"Alan Shaw <alan@tableflip.io>",
|
||||
"David Dias <daviddias.p@gmail.com>",
|
||||
"Diogo Silva <fsdiogo@gmail.com>",
|
||||
"Dmitriy Ryajov <dryajov@gmail.com>",
|
||||
"Drew Stone <drewstone329@gmail.com>",
|
||||
"Evan Schwartz <evan.mark.schwartz@gmail.com>",
|
||||
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||
"Greenkeeper <support@greenkeeper.io>",
|
||||
"Jacob Heun <jacobheun@gmail.com>",
|
||||
"Jacob Heun <jake@andyet.net>",
|
||||
"João Antunes <j.goncalo.antunes@gmail.com>",
|
||||
"Pedro Teixeira <i@pgte.me>",
|
||||
"Prashanth Chandra <coolshanth94@gmail.com>",
|
||||
"Richard Littauer <richard.littauer@gmail.com>",
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>"
|
||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
||||
"TomCoded <tomtinkerer@gmail.com>"
|
||||
]
|
||||
}
|
||||
|
@ -2,10 +2,13 @@
|
||||
|
||||
const multiaddr = require('multiaddr')
|
||||
const Address6 = require('ip-address').Address6
|
||||
const debug = require('debug')
|
||||
const log = debug('libp2p:tcp:get-multiaddr')
|
||||
|
||||
module.exports = (socket) => {
|
||||
let ma
|
||||
|
||||
try {
|
||||
if (socket.remoteFamily === 'IPv6') {
|
||||
const addr = new Address6(socket.remoteAddress)
|
||||
|
||||
@ -23,6 +26,8 @@ module.exports = (socket) => {
|
||||
ma = multiaddr('/ip4/' + socket.remoteAddress +
|
||||
'/tcp/' + socket.remotePort)
|
||||
}
|
||||
|
||||
} catch (err) {
|
||||
log(err)
|
||||
}
|
||||
return ma
|
||||
}
|
||||
|
@ -3,6 +3,7 @@
|
||||
const net = require('net')
|
||||
const toPull = require('stream-to-pull-stream')
|
||||
const mafmt = require('mafmt')
|
||||
const withIs = require('class-is')
|
||||
const includes = require('lodash.includes')
|
||||
const isFunction = require('lodash.isfunction')
|
||||
const Connection = require('interface-connection').Connection
|
||||
@ -81,4 +82,4 @@ class TCP {
|
||||
}
|
||||
}
|
||||
|
||||
module.exports = TCP
|
||||
module.exports = withIs(TCP, { className: 'TCP', symbolName: '@libp2p/js-libp2p-tcp/tcp' })
|
||||
|
@ -25,6 +25,15 @@ module.exports = (handler) => {
|
||||
socket.on('error', noop)
|
||||
|
||||
const addr = getMultiaddr(socket)
|
||||
if (!addr) {
|
||||
if (socket.remoteAddress === undefined) {
|
||||
log('connection closed before p2p connection made')
|
||||
} else {
|
||||
log('error interpreting incoming p2p connection')
|
||||
}
|
||||
return
|
||||
}
|
||||
|
||||
log('new connection', addr.toString())
|
||||
|
||||
const s = toPull.duplex(socket)
|
||||
|
@ -89,7 +89,7 @@ describe('Connection Wrap', () => {
|
||||
})
|
||||
|
||||
it('dial error', (done) => {
|
||||
tcp.dial(multiaddr('/ip4/999.0.0.1/tcp/1234'), (err) => {
|
||||
tcp.dial(multiaddr('/ip4/127.0.0.1/tcp/22234'), (err) => {
|
||||
expect(err).to.exist()
|
||||
done()
|
||||
})
|
||||
|
54
test/get-multiaddr.spec.js
Normal file
54
test/get-multiaddr.spec.js
Normal file
@ -0,0 +1,54 @@
|
||||
/* eslint-env mocha */
|
||||
'use strict'
|
||||
|
||||
const chai = require('chai')
|
||||
const dirtyChai = require('dirty-chai')
|
||||
const expect = chai.expect
|
||||
chai.use(dirtyChai)
|
||||
const getMultiaddr = require('../src/get-multiaddr')
|
||||
|
||||
const goodSocket4 = {
|
||||
remoteAddress: '127.0.0.1',
|
||||
remotePort: '9090',
|
||||
remoteFamily: 'IPv4'
|
||||
}
|
||||
|
||||
const goodSocket6 = {
|
||||
remoteAddress: '::1',
|
||||
remotePort: '9090',
|
||||
remoteFamily: 'IPv6'
|
||||
}
|
||||
|
||||
const badSocket = {}
|
||||
|
||||
const badSocketData = {
|
||||
remoteAddress: 'aewmrn4awoew',
|
||||
remotePort: '234',
|
||||
remoteFamily: 'Hufflepuff'
|
||||
}
|
||||
|
||||
describe('getMultiaddr multiaddr creation', () => {
|
||||
it('creates multiaddr from valid socket data', (done) => {
|
||||
expect(getMultiaddr(goodSocket4))
|
||||
.to.exist()
|
||||
done()
|
||||
})
|
||||
|
||||
it('creates multiaddr from valid IPv6 socket data', (done) => {
|
||||
expect(getMultiaddr(goodSocket6))
|
||||
.to.exist()
|
||||
done()
|
||||
})
|
||||
|
||||
it('returns undefined multiaddr from missing socket data', (done) => {
|
||||
expect(getMultiaddr(badSocket))
|
||||
.to.equal(undefined)
|
||||
done()
|
||||
})
|
||||
|
||||
it('returns undefined multiaddr from unparseable socket data', (done) => {
|
||||
expect(getMultiaddr(badSocketData))
|
||||
.to.equal(undefined)
|
||||
done()
|
||||
})
|
||||
})
|
@ -194,10 +194,9 @@ describe('dial', () => {
|
||||
})
|
||||
})
|
||||
|
||||
// TODO: figure out why is this failing
|
||||
it.skip('dial and destroy on listener', (done) => {
|
||||
it('dial and destroy on listener', (done) => {
|
||||
let count = 0
|
||||
const closed = ++count === 2 ? finish() : null
|
||||
const closed = () => ++count === 2 ? finish() : null
|
||||
|
||||
const ma = multiaddr('/ip6/::/tcp/9067')
|
||||
|
||||
|
Reference in New Issue
Block a user