isabella232 / interop-1

Interoperability tests for IPFS Implementations (on-the-wire interop)

Interoperability Tests for IPFS

Interoperability tests for IPFS Implementations

This repository will be used for interop tests. Please jump into the issues if you'd like to help out setting this up!

Usage

Install

$ npm install -g ipfs-interop

Run the tests

$ ipfs-interop

Testing with different versions of go/js IPFS

As a project

This module declares peer dependencies of ipfs, ipfs-http-client and go-ipfs so if you have ipfs-interop as a dependecy of your project, simply add the extra IPFS dependencies:

{
  "name": "my-project",
  "scripts": {
    "interop": "ipfs-interop"
  },
  "dependencies": {
    "go-ipfs": "...",
    "ipfs": "...",
    "ipfs-http-client": "...",
    "ipfs-interop": "..."
  }
}

Then run:

$ npm run interop

As environmental variables

Specify the following environmental variables to control which versions of IPFS ipfs-interop uses when installed globally:

• IPFS_GO_EXEC A path to a go-IPFS binary
• IPFS_JS_EXEC A path to /src/cli.js inside a js-IPFS install
• IPFS_JS_MODULE A path to a js-IPFS install
• IPFS_JS_HTTP_MODULE A path to a ipfs-http-client install (optional)

Then run:

$ npm install -g ipfs-interop
$ IPFS_GO_EXEC=/path IPFS_JS_EXEC=/path IPFS_JS_MODULE=/path IPFS_JS_HTTP_MODULE=/path ipfs-interop

Contribute

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

This repository falls under the IPFS Code of Conduct.

License

MIT