mirror of
https://github.com/fluencelabs/js-libp2p-tcp
synced 2025-07-03 01:11:38 +00:00
Compare commits
37 Commits
Author | SHA1 | Date | |
---|---|---|---|
1a550bac26 | |||
51c5594d49 | |||
d5476caee1 | |||
4b211f5cd6 | |||
433188f182 | |||
f3de45d198 | |||
2afaed5f2a | |||
308dead134 | |||
1c8603b721 | |||
c883475a4f | |||
515c6a32ec | |||
a107e1da57 | |||
2ec97b3c8c | |||
cb449a6c5c | |||
1773efecdf | |||
49e23f1961 | |||
10b35b22f6 | |||
5677e12592 | |||
9524e8670a | |||
32dc4fa5c6 | |||
9d697f66a4 | |||
fb6c61abe9 | |||
114998db1c | |||
4a94e3ca01 | |||
e451201848 | |||
e7524e1747 | |||
06689e3ff0 | |||
376f938cc0 | |||
a2958b9bca | |||
7b7e521e57 | |||
2330732ed5 | |||
7b7e7f6344 | |||
850a414e6f | |||
f6df6cfa40 | |||
c16376f567 | |||
0025407a5b | |||
48708ac4d2 |
3
.gitignore
vendored
3
.gitignore
vendored
@ -25,6 +25,3 @@ build/Release
|
|||||||
# Dependency directory
|
# Dependency directory
|
||||||
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
# https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
|
||||||
node_modules
|
node_modules
|
||||||
|
|
||||||
lib
|
|
||||||
dist
|
|
22
.travis.yml
22
.travis.yml
@ -1,9 +1,13 @@
|
|||||||
sudo: false
|
sudo: false
|
||||||
language: node_js
|
language: node_js
|
||||||
node_js:
|
matrix:
|
||||||
- 4
|
include:
|
||||||
- 5
|
- node_js: 4
|
||||||
- stable
|
env: CXX=g++-4.8
|
||||||
|
- node_js: 6
|
||||||
|
env: CXX=g++-4.8
|
||||||
|
- node_js: stable
|
||||||
|
env: CXX=g++-4.8
|
||||||
|
|
||||||
# Make sure we have new NPM.
|
# Make sure we have new NPM.
|
||||||
before_install:
|
before_install:
|
||||||
@ -14,12 +18,16 @@ script:
|
|||||||
- npm test
|
- npm test
|
||||||
- npm run coverage
|
- npm run coverage
|
||||||
|
|
||||||
addons:
|
|
||||||
firefox: 'latest'
|
|
||||||
|
|
||||||
before_script:
|
before_script:
|
||||||
- export DISPLAY=:99.0
|
- export DISPLAY=:99.0
|
||||||
- sh -e /etc/init.d/xvfb start
|
- sh -e /etc/init.d/xvfb start
|
||||||
|
|
||||||
after_success:
|
after_success:
|
||||||
- npm run coverage-publish
|
- npm run coverage-publish
|
||||||
|
|
||||||
|
addons:
|
||||||
|
apt:
|
||||||
|
sources:
|
||||||
|
- ubuntu-toolchain-r-test
|
||||||
|
packages:
|
||||||
|
- g++-4.8
|
2
LICENSE
2
LICENSE
@ -1,6 +1,6 @@
|
|||||||
The MIT License (MIT)
|
The MIT License (MIT)
|
||||||
|
|
||||||
Copyright (c) 2015 David Dias
|
Copyright (c) 2015-2016 David Dias
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||||
of this software and associated documentation files (the "Software"), to deal
|
of this software and associated documentation files (the "Software"), to deal
|
||||||
|
70
README.md
70
README.md
@ -3,22 +3,44 @@
|
|||||||
[](http://ipn.io)
|
[](http://ipn.io)
|
||||||
[](http://webchat.freenode.net/?channels=%23ipfs)
|
[](http://webchat.freenode.net/?channels=%23ipfs)
|
||||||
[](https://travis-ci.org/libp2p/js-libp2p-tcp)
|
[](https://travis-ci.org/libp2p/js-libp2p-tcp)
|
||||||

|
[](https://coveralls.io/github/libp2p/js-libp2p-tcp?branch=master)
|
||||||
[](https://david-dm.org/libp2p/js-libp2p-tcp)
|
[](https://david-dm.org/libp2p/js-libp2p-tcp)
|
||||||
[](https://github.com/feross/standard)
|
[](https://github.com/feross/standard)
|
||||||
|

|
||||||
|

|
||||||
|
|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
> Node.js implementation of the TCP module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/interface-connection) interface for dial/listen.
|
> Node.js implementation of the TCP module that libp2p uses, which implements the [interface-connection](https://github.com/libp2p/interface-connection) interface for dial/listen.
|
||||||
|
|
||||||
## Description
|
|
||||||
|
|
||||||
`libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
|
`libp2p-tcp` in Node.js is a very thin shim that adds support for dialing to a `multiaddr`. This small shim will enable libp2p to use other different transports.
|
||||||
|
|
||||||
**Note:** This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
|
**Note:** This module uses [pull-streams](https://pull-stream.github.io) for all stream based interfaces.
|
||||||
|
|
||||||
## Example
|
## Table of Contents
|
||||||
|
|
||||||
|
- [Install](#install)
|
||||||
|
- [npm](#npm)
|
||||||
|
- [Usage](#usage)
|
||||||
|
- [Example](#example)
|
||||||
|
- [This module uses `pull-streams`](#this-module-uses-pull-streams)
|
||||||
|
- [Converting `pull-streams` to Node.js Streams](#converting-pull-streams-to-nodejs-streams)
|
||||||
|
- [API](#api)
|
||||||
|
- [Contribute](#contribute)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
### npm
|
||||||
|
|
||||||
|
```sh
|
||||||
|
> npm i libp2p-tcp
|
||||||
|
```
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### Example
|
||||||
|
|
||||||
```js
|
```js
|
||||||
const TCP = require('libp2p-tcp')
|
const TCP = require('libp2p-tcp')
|
||||||
@ -51,25 +73,17 @@ listener.listen(() => {
|
|||||||
})
|
})
|
||||||
```
|
```
|
||||||
|
|
||||||
outputs
|
Outputs:
|
||||||
|
|
||||||
```
|
```sh
|
||||||
listening
|
listening
|
||||||
new connection opened
|
new connection opened
|
||||||
hello
|
hello
|
||||||
```
|
```
|
||||||
|
|
||||||
## Installation
|
### This module uses `pull-streams`
|
||||||
|
|
||||||
### npm
|
We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about why we did this, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
|
||||||
|
|
||||||
```sh
|
|
||||||
> npm i libp2p-tcp
|
|
||||||
```
|
|
||||||
|
|
||||||
## This module uses `pull-streams`
|
|
||||||
|
|
||||||
We expose a streaming interface based on `pull-streams`, rather then on the Node.js core streams implementation (aka Node.js streams). `pull-streams` offers us a better mechanism for error handling and flow control guarantees. If you would like to know more about what took us to make this migration, see the discussion at this [issue](https://github.com/ipfs/js-ipfs/issues/362).
|
|
||||||
|
|
||||||
You can learn more about pull-streams at:
|
You can learn more about pull-streams at:
|
||||||
|
|
||||||
@ -78,22 +92,22 @@ You can learn more about pull-streams at:
|
|||||||
- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
|
- [pull-streams, the simple streaming primitive](http://dominictarr.com/post/149248845122/pull-streams-pull-streams-are-a-very-simple)
|
||||||
- [pull-streams documentation](https://pull-stream.github.io/)
|
- [pull-streams documentation](https://pull-stream.github.io/)
|
||||||
|
|
||||||
### Converting `pull-streams` to Node.js Streams
|
#### Converting `pull-streams` to Node.js Streams
|
||||||
|
|
||||||
If you are a Node.js streams user, you can convert a pull-stream to Node.js Stream using the module `pull-stream-to-stream`, giving you an instance of a Node.js stream that is linked to the pull-stream. Example:
|
If you are a Node.js streams user, you can convert a pull-stream to a Node.js stream using the module [`pull-stream-to-stream`](https://github.com/dominictarr/pull-stream-to-stream), giving you an instance of a Node.js stream that is linked to the pull-stream. For example:
|
||||||
|
|
||||||
```
|
```js
|
||||||
const pullToStream = require('pull-stream-to-stream')
|
const pullToStream = require('pull-stream-to-stream')
|
||||||
|
|
||||||
const nodeStreamInstance = pullToStream(pullStreamInstance)
|
const nodeStreamInstance = pullToStream(pullStreamInstance)
|
||||||
// nodeStreamInstance is an instance of a Node.js Stream
|
// nodeStreamInstance is an instance of a Node.js Stream
|
||||||
```
|
```
|
||||||
|
|
||||||
To learn more about his utility, visit https://pull-stream.github.io/#pull-stream-to-stream
|
To learn more about this utility, visit https://pull-stream.github.io/#pull-stream-to-stream.
|
||||||
|
|
||||||
## API
|
## API
|
||||||
|
|
||||||
[](https://github.com/diasdavid/interface-transport)
|
[](https://github.com/libp2p/interface-transport)
|
||||||
|
|
||||||
`libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e:
|
`libp2p-tcp` accepts TCP addresses both IPFS and non IPFS encapsulated addresses, i.e:
|
||||||
|
|
||||||
@ -102,6 +116,18 @@ To learn more about his utility, visit https://pull-stream.github.io/#pull-strea
|
|||||||
|
|
||||||
Both for dialing and listening.
|
Both for dialing and listening.
|
||||||
|
|
||||||
|
## Contribute
|
||||||
|
|
||||||
|
Contributions are welcome! The libp2p implementation in JavaScript is a work in progress. As such, there's a few things you can do right now to help out:
|
||||||
|
|
||||||
|
- [Check out the existing issues](//github.com/libp2p/js-libp2p-tcp/issues).
|
||||||
|
- **Perform code reviews**.
|
||||||
|
- **Add tests**. There can never be enough tests.
|
||||||
|
|
||||||
|
Please be aware that all interactions related to libp2p are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
|
||||||
|
|
||||||
|
Small note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
[MIT](LICENSE) © 2015-2016 David Dias
|
||||||
|
49
package.json
49
package.json
@ -1,16 +1,14 @@
|
|||||||
{
|
{
|
||||||
"name": "libp2p-tcp",
|
"name": "libp2p-tcp",
|
||||||
"version": "0.8.0",
|
"version": "0.9.3",
|
||||||
"description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
|
"description": "Node.js implementation of the TCP module that libp2p uses, which implements the interface-connection and interface-transport interfaces",
|
||||||
"main": "lib/index.js",
|
"main": "src/index.js",
|
||||||
"jsnext:main": "src/index.js",
|
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"lint": "aegir-lint",
|
"lint": "aegir-lint",
|
||||||
"build": "aegir-build --env node",
|
|
||||||
"test": "aegir-test --env node",
|
"test": "aegir-test --env node",
|
||||||
"release": "aegir-release --env node",
|
"release": "aegir-release --env no-build",
|
||||||
"release-minor": "aegir-release --type minor --env node",
|
"release-minor": "aegir-release --type minor --env no-build",
|
||||||
"release-major": "aegir-release --type major --env node",
|
"release-major": "aegir-release --type major --env no-build",
|
||||||
"coverage": "aegir-coverage",
|
"coverage": "aegir-coverage",
|
||||||
"coverage-publish": "aegir-coverage publish"
|
"coverage-publish": "aegir-coverage publish"
|
||||||
},
|
},
|
||||||
@ -20,7 +18,7 @@
|
|||||||
],
|
],
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "https://github.com/diasdavid/js-libp2p-tcp.git"
|
"url": "https://github.com/libp2p/js-libp2p-tcp.git"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"IPFS"
|
"IPFS"
|
||||||
@ -28,32 +26,37 @@
|
|||||||
"author": "David Dias <daviddias@ipfs.io>",
|
"author": "David Dias <daviddias@ipfs.io>",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/diasdavid/js-libp2p-tcp/issues"
|
"url": "https://github.com/libp2p/js-libp2p-tcp/issues"
|
||||||
|
},
|
||||||
|
"homepage": "https://github.com/libp2p/js-libp2p-tcp",
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4.0.0"
|
||||||
},
|
},
|
||||||
"homepage": "https://github.com/diasdavid/js-libp2p-tcp",
|
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"aegir": "^6.0.1",
|
"interface-transport": "~0.3.3",
|
||||||
|
"aegir": "^10.0.0",
|
||||||
"chai": "^3.5.0",
|
"chai": "^3.5.0",
|
||||||
"interface-transport": "^0.3.3",
|
|
||||||
"lodash.isfunction": "^3.0.8",
|
"lodash.isfunction": "^3.0.8",
|
||||||
"pre-commit": "^1.1.2"
|
"pre-commit": "^1.2.2",
|
||||||
|
"pull-stream": "^3.5.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"interface-connection": "0.2.1",
|
"interface-connection": "~0.3.0",
|
||||||
"ip-address": "^5.8.0",
|
"ip-address": "^5.8.6",
|
||||||
"lodash.contains": "^2.4.3",
|
"lodash.includes": "^4.3.0",
|
||||||
"mafmt": "^2.1.2",
|
"lodash.isfunction": "^3.0.8",
|
||||||
"multiaddr": "^2.0.2",
|
"mafmt": "^2.1.6",
|
||||||
"pull": "^2.1.1",
|
"multiaddr": "^2.2.1",
|
||||||
"stream-to-pull-stream": "^1.7.0"
|
"stream-to-pull-stream": "^1.7.2"
|
||||||
},
|
},
|
||||||
"contributors": [
|
"contributors": [
|
||||||
"David Dias <daviddias.p@gmail.com>",
|
"David Dias <daviddias.p@gmail.com>",
|
||||||
"Evan Schwartz <evan.mark.schwartz@gmail.com>",
|
"Evan Schwartz <evan.mark.schwartz@gmail.com>",
|
||||||
|
"Friedel Ziegelmayer <dignifiedquire@gmail.com>",
|
||||||
|
"Greenkeeper <support@greenkeeper.io>",
|
||||||
"João Antunes <j.goncalo.antunes@gmail.com>",
|
"João Antunes <j.goncalo.antunes@gmail.com>",
|
||||||
|
"Prashanth Chandra <coolshanth94@gmail.com>",
|
||||||
"Richard Littauer <richard.littauer@gmail.com>",
|
"Richard Littauer <richard.littauer@gmail.com>",
|
||||||
"Stephen Whitmore <stephen.whitmore@gmail.com>",
|
"Stephen Whitmore <stephen.whitmore@gmail.com>"
|
||||||
"dignifiedquire <dignifiedquire@gmail.com>",
|
|
||||||
"greenkeeperio-bot <support@greenkeeper.io>"
|
|
||||||
]
|
]
|
||||||
}
|
}
|
@ -3,7 +3,7 @@
|
|||||||
const net = require('net')
|
const net = require('net')
|
||||||
const toPull = require('stream-to-pull-stream')
|
const toPull = require('stream-to-pull-stream')
|
||||||
const mafmt = require('mafmt')
|
const mafmt = require('mafmt')
|
||||||
const contains = require('lodash.contains')
|
const includes = require('lodash.includes')
|
||||||
const isFunction = require('lodash.isfunction')
|
const isFunction = require('lodash.isfunction')
|
||||||
const Connection = require('interface-connection').Connection
|
const Connection = require('interface-connection').Connection
|
||||||
const debug = require('debug')
|
const debug = require('debug')
|
||||||
@ -59,7 +59,7 @@ module.exports = class TCP {
|
|||||||
multiaddrs = [multiaddrs]
|
multiaddrs = [multiaddrs]
|
||||||
}
|
}
|
||||||
return multiaddrs.filter((ma) => {
|
return multiaddrs.filter((ma) => {
|
||||||
if (contains(ma.protoNames(), 'ipfs')) {
|
if (includes(ma.protoNames(), 'ipfs')) {
|
||||||
ma = ma.decapsulate('ipfs')
|
ma = ma.decapsulate('ipfs')
|
||||||
}
|
}
|
||||||
return mafmt.TCP.matches(ma)
|
return mafmt.TCP.matches(ma)
|
||||||
|
@ -3,7 +3,7 @@
|
|||||||
const multiaddr = require('multiaddr')
|
const multiaddr = require('multiaddr')
|
||||||
const Connection = require('interface-connection').Connection
|
const Connection = require('interface-connection').Connection
|
||||||
const os = require('os')
|
const os = require('os')
|
||||||
const contains = require('lodash.contains')
|
const includes = require('lodash.includes')
|
||||||
const net = require('net')
|
const net = require('net')
|
||||||
const toPull = require('stream-to-pull-stream')
|
const toPull = require('stream-to-pull-stream')
|
||||||
const EventEmitter = require('events').EventEmitter
|
const EventEmitter = require('events').EventEmitter
|
||||||
@ -78,7 +78,7 @@ module.exports = (handler) => {
|
|||||||
|
|
||||||
listener.listen = (ma, cb) => {
|
listener.listen = (ma, cb) => {
|
||||||
listeningAddr = ma
|
listeningAddr = ma
|
||||||
if (contains(ma.protoNames(), 'ipfs')) {
|
if (includes(ma.protoNames(), 'ipfs')) {
|
||||||
ipfsId = getIpfsId(ma)
|
ipfsId = getIpfsId(ma)
|
||||||
listeningAddr = ma.decapsulate('ipfs')
|
listeningAddr = ma.decapsulate('ipfs')
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user