komputing/ipfs-api-kotlin


IPFS API for kotlin to access a IPFS node via http http://ipfs.io

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.ligi:ipfs-api-kotlin:0.15'
	}
	dependencies {
		implementation("com.github.ligi:ipfs-api-kotlin:0.15")
	}
	<dependency>
	    <groupId>com.github.ligi</groupId>
	    <artifactId>ipfs-api-kotlin</artifactId>
	    <version>0.15</version>
	</dependency>

                            
    libraryDependencies += "com.github.ligi" % "ipfs-api-kotlin" % "0.15"
        
        

                            
    :dependencies [[com.github.ligi/ipfs-api-kotlin "0.15"]]
        
        

Readme


IPFS API for kotlin to access a IPFS node via http

Release

Get it

You can get the artifact via jitpack - here you see how to use with gradle - for other build systems have a look here

repositories {
  maven { url "https://jitpack.io" }
}
dependencies {
  implementation 'com.github.ligi:ipfs-api-kotlin:$current_version'
}

Use it with kotlin

add a string

val multihash = LocalIPFS().add.string("test-string").Hash

get a string

val content = LocalIPFS().get.cat(multihash)

get commit from version

val commit = LocalIPFS().info.version()?.Commit

Note: when you are not running a local IPFS daemon you can also use infura just replace LocalIPFS() with InfuraIPFS() or write your own configuration.

Apps that use this library

Please send a message or even PR if you write/find an app that also uses this library.

Dependencies

We depend on okhttp and moshi which play well together with okio

License

MIT