fluencelabs/js-libp2p-interfaces
1
0
Fork 0
mirror of https://github.com/fluencelabs/js-libp2p-interfaces synced 2025-05-12 07:27:32 +00:00
Code Issues Projects Releases Wiki Activity

update name

Browse Source
This commit is contained in:
David Dias 2015-12-11 20:44:47 -08:00
parent c48504ecbd
commit c121fd83fa
2 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -1,15 +1,15 @@
abstract-transport
interface-transport
===================
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io) [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
> A test suite and interface you can use to implement a transport. A transport is understood as something that offers a dial+listen interface
The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and abstract-stream-muxer.
The primary goal of this module is to enable developers to pick and swap their Record Store module as they see fit for their libp2p installation, without having to go through shims or compatibility issues. This module and test suite were heavily inspired by abstract-blob-store and interface-stream-muxer.
Publishing a test suite as a module lets multiple modules all ensure compatibility since they use the same test suite.
The purpose of this abstraction is not to reinvent any wheels when it comes to dialing and listening to transports, instead, it tries to uniform several transports through a shimmed interface.
The purpose of this interfaceion is not to reinvent any wheels when it comes to dialing and listening to transports, instead, it tries to uniform several transports through a shimmed interface.
The API is presented with both Node.js and Go primitives, however, there is not actual limitations for it to be extended for any other language, pushing forward the cross compatibility and interop through diferent stacks.
@ -21,9 +21,9 @@ note: for any new given implementation that adds one more option to the multiadd
# Badge
Include this badge in your readme if you make a module that is compatible with the abstract-transport API. You can validate this by running the tests.
Include this badge in your readme if you make a module that is compatible with the interface-transport API. You can validate this by running the tests.
![](https://raw.githubusercontent.com/diasdavid/abstract-transport/master/img/badge.png)
![](https://raw.githubusercontent.com/diasdavid/interface-transport/master/img/badge.png)
# How to use the battery of tests
@ -31,7 +31,7 @@ Include this badge in your readme if you make a module that is compatible with t
```
var tape = require('tape')
var tests = require('abstract-transport/tests')
var tests = require('interface-transport/tests')
var YourTransportHandler = require('../src')
var common = {
@ -62,7 +62,7 @@ This method dials a transport to the Peer referenced by the peerInfo object.
multiaddr must be of the type [`multiaddr`](http://npmjs.org/multiaddr).
`stream` must implements the [abstract-connection](https://github.com/diasdavid/abstract-connection) interface.
`stream` must implements the [interface-connection](https://github.com/diasdavid/interface-connection) interface.
`[options]` are not mandatory fields for all the implementations that might be passed for certain implementations for them to work (e.g. a Signalling Server for a WebRTC transport implementation)
@ -72,7 +72,7 @@ multiaddr must be of the type [`multiaddr`](http://npmjs.org/multiaddr).
This method waits and listens for incoming transports by other peers.
`stream` must be a stream that implements the [abstract-connection](https://github.com/diasdavid/abstract-connection) interface.
`stream` must be a stream that implements the [interface-connection](https://github.com/diasdavid/interface-connection) interface.
Options are the properties this listener must have access in order to properly listen on a given transport/socket

8
package.json
View File

@ -1,10 +1,10 @@
{
"name": "abstract-transport",
"name": "interface-transport",
"version": "0.1.0",
"description": "A test suite and interface you can use to implement a transport.",
"repository": {
"type": "git",
"url": "https://github.com/diasdavid/abstract-transport.git"
"url": "https://github.com/diasdavid/interface-transport.git"
},
"keywords": [
"IPFS"
@ -12,9 +12,9 @@
"author": "David Dias <daviddias@ipfs.io>",
"license": "MIT",
"bugs": {
"url": "https://github.com/diasdavid/abstract-transport/issues"
"url": "https://github.com/diasdavid/interface-transport/issues"
},
"homepage": "https://github.com/diasdavid/abstract-transport",
"homepage": "https://github.com/diasdavid/interface-transport",
"devDependencies": {},
"dependencies": {
"multiaddr": "^1.0.0",