celeduc/java-ipfs-api

A Java implementation of the HTTP IPFS API

Download

Step 1. Add the JitPack repository to your build file

Add it in your root settings.gradle at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url 'https://jitpack.io' }
		}
	}

Add it in your settings.gradle.kts at the end of repositories:

	dependencyResolutionManagement {
		repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
		repositories {
			mavenCentral()
			maven { url = uri("https://jitpack.io") }
		}
	}

Add to pom.xml

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

Add it in your build.sbt at the end of resolvers:

 
    resolvers += "jitpack" at "https://jitpack.io"

Add it in your project.clj at the end of repositories:

 
    :repositories [["jitpack" "https://jitpack.io"]]

Step 2. Add the dependency

	dependencies {
		implementation 'com.github.celeduc:java-ipfs-api:v1.0.0-PRE'
	}

	dependencies {
		implementation("com.github.celeduc:java-ipfs-api:v1.0.0-PRE")
	}

	<dependency>
	    <groupId>com.github.celeduc</groupId>
	    <artifactId>java-ipfs-api</artifactId>
	    <version>v1.0.0-PRE</version>
	</dependency>


                            
    libraryDependencies += "com.github.celeduc" % "java-ipfs-api" % "v1.0.0-PRE"


                            
    :dependencies [[com.github.celeduc/java-ipfs-api "v1.0.0-PRE"]]

Readme

java-ipfs-api

A Java implementation of the IPFS http api

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 whcih supports Maven, Gradle, SBT, etc.

for Maven, add the following sections to your pom.xml:

  <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>v1.1.1</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.

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:

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

To add a byte[] use:

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

To get a file use:

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

Dependencies

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

Contribute

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

This repository falls under the IPFS Code of Conduct.

License

MIT