Share your code. npm Orgs help your team discover, share, and reuse code. Create a free org »

    interface-ipfs-corepublic

    interface-ipfs-core

    standard-readme compliant

    A test suite and interface you can use to implement a IPFS core interface.

    Table of Contents

    Background

    The primary goal of this module is to define and ensure that both IPFS core implementations and their respective HTTP client libraries offer the same interface, so that developers can quickly change between a local and a remote node without having to change their applications. In addition to the definition of the expected interface, this module offers a suite of tests that can be run in order to check if the interface is used as described.

    The API is presented with both Node.js and Go primitives. However, there are no actual limitations keeping it from being extended for any other language, pushing forward cross compatibility and interoperability through different stacks.

    Modules that implement the interface

    Send in a PR if you find or write one!

    Badge

    Include this badge in your readme if you make a new module that implements interface-ipfs-core API.

    [![IPFS Core API Compatible](https://cdn.rawgit.com/ipfs/interface-ipfs-core/master/img/badge.svg)](https://github.com/ipfs/interface-ipfs-core)

    Install

    In JavaScript land:

    npm install interface-ipfs-core

    In Go land:

    Not available

    Usage

    JavaScript

    Install interface-ipfs-core as one of the dependencies of your project and as a test file. Then, using mocha (for Node.js) or a test runner with compatible API, do:

    var test = require('interface-ipfs-core')
    
    var common = {
      setup: function (cb) {
        cb(null, IPFSFactory)
      },
      teardown: function (cb) {
        cb()
      }
    }
    
    // use all of the test suits
    test.all(common)
    

    Go

    WIP

    API

    In order to be considered "valid", an IPFS core implementation must expose the API described in /SPEC. You can also use this loose spec as documentation for consuming the core APIs. Here is an outline of the contents of that directory:

    Contribute

    Feel free to join in. All welcome. Open an issue!

    This repository falls under the IPFS Code of Conduct.

    Want to hack on IPFS?

    License

    MIT

    Keywords

    install

    npm i interface-ipfs-core

    Downloadsweekly downloads

    1,532

    version

    0.64.2

    license

    MIT

    repository

    github.com

    last publish

    collaborators

    • avatar