java-ipfs-api

A Java implementation of the IPFS http api

Table of Contents

• Install
• Usage
• Building
• Contribute
• License

Install

Official releases

You can use this project by including ipfs.jar from one of the releases.

Maven, Gradle, SBT

Package managers are supported through JitPack which supports Maven, Gradle, SBT, etc.

for Maven, add the following sections to your pom.xml (replacing $LATEST_VERSION):

  <repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
  </repositories>

  <dependencies>
    <dependency>
      <groupId>com.github.ipfs</groupId>
      <artifactId>java-ipfs-api</artifactId>
      <version>$LATEST_VERSION</version>
    </dependency>
  </dependencies>

Building

• Clone this repository
• Run ant dist
• Copy dist/ipfs.jar into your project. Appropriate versions of other dependencies are also included in dist/lib/.
• Run tests using ant test.

Running tests

To run tests, IPFS daemon must be running on 127.0.0.1 interface.

IPFS installation

Command line

Download ipfs from https://dist.ipfs.io/#go-ipfs and run with ipfs daemon --enable-pubsub-experiment

Docker Compose

Run docker-compose up from the project's root directory. Check docker-compose.yml for more details.

Usage

Create an IPFS instance with:

IPFS ipfs = new IPFS("/ip4/127.0.0.1/tcp/5001");

Then run commands like:

ipfs.refs.local();

To add a file use (the add method returns a list of merklenodes, in this case there is only one element):

NamedStreamable.FileWrapper file = new NamedStreamable.FileWrapper(new File("hello.txt"));
MerkleNode addResult = ipfs.add(file).get(0);

To add a byte[] use:

NamedStreamable.ByteArrayWrapper file = new NamedStreamable.ByteArrayWrapper("hello.txt", "G'day world! IPFS rocks!".getBytes());
MerkleNode addResult = ipfs.add(file).get(0);

To get a file use:

Multihash filePointer = Multihash.fromBase58("QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB");
byte[] fileContents = ipfs.cat(filePointer);

To timestamp your files with OriginStamp use:

IPFS ipfs = new IPFS("localhost", 5001, "/api/v0/", false, new OriginStamp("Insert your api key"));
NamedStreamable.ByteArrayWrapper file = new NamedStreamable.ByteArrayWrapper("hello.txt", "test".getBytes());

MerkleNode addResult = ipfs.add(file).get(0);

System.out.println(ipfs.getTimestamp(file, OriginStamp.CryptoCurrency.BITCOIN).get());

Dependencies

Current versions of dependencies are included in the ./lib directory.

• multibase
• multiaddr
• multihash
• cid

Contribute

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

This repository falls under the IPFS Code of Conduct.

License

MIT