isabella232 / interface-content-routing

⛔️ DEPRECATED: interface-content-routing is now included in https://github.com/libp2p/js-interfaces

⛔️ DEPRECATED: interface-content-routing is now included in libp2p-interfaces

interface-content-routing

A test suite and interface you can use to implement a Content Routing module for libp2p.

The primary goal of this module is to enable developers to pick and swap their Content Routing 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 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.

Lead Maintainer

Vasco Santos.

Modules that implement the interface

• JavaScript libp2p-kad-dht
• JavaScript libp2p-delegated-peer-routing
• JavaScript libp2p-kad-routing

Badge

Include this badge in your readme if you make a module that is compatible with the interface-content-routing API. You can validate this by running the tests.

How to use the battery of tests

Node.js

var tape = require('tape')
var tests = require('interface-content-routing/tests')
var yourImpl = require('../src')

var common = {
    setup: function (t, cb) {
      cb(null, yourImpl)
    },
    teardown: function (t, cb) {
      cb()
    }
}

tests(tape, common)

Go

WIP - The go-libp2p implementation does not have a test suite to be used, yet.

API

A valid (read: that follows this abstraction) Content Routing module must implement the following API.

.findProviders

• JavaScript peerRouting.findProviders

.provide

• JavaScript peerRouting.provide