{"id":22165589,"url":"https://github.com/textileio/android-ipfs-lite","last_synced_at":"2025-07-31T04:06:26.394Z","repository":{"id":97399760,"uuid":"220350788","full_name":"textileio/android-ipfs-lite","owner":"textileio","description":null,"archived":false,"fork":false,"pushed_at":"2020-04-09T20:48:17.000Z","size":59319,"stargazers_count":81,"open_issues_count":7,"forks_count":14,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-07-26T15:57:35.503Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textileio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-11-07T23:55:33.000Z","updated_at":"2025-05-31T14:01:21.000Z","dependencies_parsed_at":null,"dependency_job_id":"3d6c471d-39c5-42db-8855-497ef5345b11","html_url":"https://github.com/textileio/android-ipfs-lite","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/textileio/android-ipfs-lite","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fandroid-ipfs-lite","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fandroid-ipfs-lite/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fandroid-ipfs-lite/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fandroid-ipfs-lite/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textileio","download_url":"https://codeload.github.com/textileio/android-ipfs-lite/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textileio%2Fandroid-ipfs-lite/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267985277,"owners_count":24176422,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-31T02:00:08.723Z","response_time":66,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-02T05:15:37.812Z","updated_at":"2025-07-31T04:06:26.354Z","avatar_url":"https://github.com/textileio.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# android-ipfs-lite\n\n[![Made by Textile](https://img.shields.io/badge/made%20by-Textile-informational.svg?style=flat-square)](https://textile.io)\n[![Chat on Slack](https://img.shields.io/badge/slack-slack.textile.io-informational.svg?style=flat-square)](https://slack.textile.io)\n[![GitHub license](https://img.shields.io/github/license/textileio/android-ipfs-lite.svg?style=flat-square)](./LICENSE)\n[![Release](https://img.shields.io/github/release/textileio/android-ipfs-lite.svg?style=flat-square)](https://github.com/textileio/android-ipfs-lite/releases/latest)\n[![CircleCI branch](https://img.shields.io/circleci/project/github/textileio/android-ipfs-lite/master.svg?style=flat-square)](https://circleci.com/gh/textileio/android-ipfs-lite)\n[![docs](https://img.shields.io/badge/docs-master-success.svg?style=popout-square)](https://textileio.github.io/android-ipfs-lite/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n\n\u003e A lightweight, extensible IPFS peer for Android.\n\nIPFS Lite runs the minimal setup required to get and put IPLD DAGs on the IPFS network. It is a port of the [Go IPFS Lite](https://github.com/hsanjuan/ipfs-lite) library.\n\n## Table of Contents\n\n- [android-ipfs-lite](#android-ipfs-lite)\n  - [Table of Contents](#table-of-contents)\n  - [Background](#background)\n    - [IPFS-lite Libraries](#ipfs-lite-libraries)\n  - [Roadmap](#roadmap)\n  - [Install](#install)\n  - [Usage](#usage)\n    - [Initialize and start a Peer](#initialize-and-start-a-peer)\n    - [Add data](#add-data)\n    - [Add a file](#add-a-file)\n    - [Fetch a file by CID](#fetch-a-file-by-cid)\n  - [Maintainers](#maintainers)\n  - [Contributing](#contributing)\n  - [License](#license)\n\n## Background\n\nIPFS Lite runs the minimal setup required to provide a DAG service. It is a port of the [Go IPFS Lite](https://github.com/hsanjuan/ipfs-lite) library, and as such, has the same requirements. The goal of IPFS Lite is to run the bare minimal functionality for any IPLD-based application to interact with the IPFS network (by getting and putting blocks). This saves having to deal with the complexities of using a full IPFS daemon, while maintaining the ability to share the underlying libp2p host and DHT with other components.\n\n### IPFS-lite Libraries\n\n\u003e The following includes information about support for ipfs-lite.\n\n| Name | Build | Language | Description |\n|:---------|:---------|:---------|:---------|\n| [`ipfs-lite`](https://github.com/hsanjuan/ipfs-lite) | [![Build Status](https://img.shields.io/travis/hsanjuan/ipfs-lite.svg?branch=master\u0026style=flat-square)](https://travis-ci.org/hsanjuan/ipfs-lite) | [![golang](https://img.shields.io/badge/golang-blueviolet.svg?style=popout-square)](https://github.com/hsanjuan/ipfs-lite) | The reference implementaiton of ipfs-lite, written in Go. |\n| [`js-ipfs-lite`](//github.com/textileio/js-ipfs-lite) | [![Build status](https://img.shields.io/github/workflow/status/textileio/js-ipfs-lite/Test/master.svg?style=popout-square)](https://github.com/textileio/js-ipfs-lite/actions?query=branch%3Amaster) | [![javascript](https://img.shields.io/badge/javascript-blueviolet.svg?style=popout-square)](https://github.com/textileio/js-ipfs-lite)| The Javascript version of ipfs-lite available for web, nodejs, and React Native applications. |\n| [`ios-ipfs-lite`](//github.com/textileio/ios-ipfs-lite) | [![Build status](https://img.shields.io/circleci/project/github/textileio/ios-ipfs-lite/master.svg?style=flat-square)](https://github.com/textileio/ios-ipfs-lite/actions?query=branch%3Amaster) | [![objc](https://img.shields.io/badge/objc-blueviolet.svg?style=popout-square)](https://github.com/textileio/ios-ipfs-lite)| The iOS ipfs-lite library for use in Objc and Swift apps |\n| [`android-ipfs-lite`](//github.com/textileio/android-ipfs-lite) | [![Build status](https://img.shields.io/circleci/project/github/textileio/android-ipfs-lite/master.svg?style=flat-square)](https://github.com/textileio/android-ipfs-lite/actions?query=branch%3Amaster) | [![java](https://img.shields.io/badge/java-blueviolet.svg?style=popout-square)](https://github.com/textileio/android-ipfs-lite)| The Java ipfs-lite library for us in Android apps |\n| [`grpc-ipfs-lite`](//github.com/textileio/grpc-ipfs-lite) | [![Build status](https://img.shields.io/circleci/project/github/textileio/grpc-ipfs-lite/master.svg?style=flat-square)](https://github.com/textileio/grpc-ipfs-lite/actions?query=branch%3Amaster) | [![java](https://img.shields.io/badge/grpc--api-blueviolet.svg?style=popout-square)](https://github.com/textileio/grpc-ipfs-lite)| A common gRPC API interface that runs on the Go ipfs-lite node. |\n\n## Roadmap\n\n- [x] Start IPFS Lite\n- [x] Stop IPFS Lite\n- [x] `getFile(String cid)` Get file by Content Address.\n- [x] `getFileSync(String cid)` Synchronously get file by Content Address.\n- [x] `addFile(byte[] data)` Add file to IPFS.\n- [x] `addFileSync(byte[] data)` Synchronously Add file to IPFS.\n- [x] `getNode(String cid)` Get IPLD node.\n- [x] `removeNode(String cid)` Remove IPLD node.\n- [ ] Add IPLD node.\n- [x] `resolveLink(String link)`\n\n## Install\n\nThe IPFS Lite library is published in [Textile's Bintray Maven repository](https://dl.bintray.com/textile/maven).\nYou can install it using Gradle.\n\nFirst, you'll need to add Textile's Bintray Maven repository to you project's top level `build.gradle` in the `allProjects.repositories` section:\n\n```cmd\nallprojects {\n    repositories {\n        ...\n        maven { url 'https://dl.bintray.com/textile/maven' }\n        maven { url 'https://jitpack.io' }\n        ...\n    }\n}\n```\n\nNext, add the IPFS Lite dependency to your app module's `build.gradle` `dependencies` section, specifying the [latest version available](https://bintray.com/textile/maven/ipfs-lite/_latestVersion):\n\n```cmd\ndependencies {\n    ...\n    implementation 'io.textile:ipfslite:0.1.4'\n    ...\n}\n```\n\n## Usage\n\n### Initialize and start a Peer\n\n```java\n  Boolean debug = false;\n  Peer litePeer = new Peer('/path/', debug, true);\n  litePeer.start();\n```\n\n* To learn see how a path is choosen, see the [test suite example](https://github.com/textileio/android-ipfs-lite/blob/master/ipfslite/src/androidTest/java/io/textile/ipfslite/PeerTest.java#L38).\n\n### Add data\n\n```java\n  String message = \"Hello World\";\n  String cid = litePeer.addFileSync(message.getBytes());\n```\n\n### Add a file\n\n```java\n  File file = openFile(\"secret_plans\");\n  byte[] bytes = Files.readAllBytes(file.toPath());\n  String cid = litePeer.addFileSync(bytes);\n\n  // OR Asynchronously\n  litePeer.addFile(bytes, resultHandler);\n```\n\n### Fetch a file by CID\n\n```java\n  byte[] data = litePeer.getFileSync(\"bafybeic35nent64fowmiohupnwnkfm2uxh6vpnyjlt3selcodjipfrokgi\");\n  // OR Asynchronously\n  litePeer.getFile(\"bafybeic35nent64fowmiohupnwnkfm2uxh6vpnyjlt3selcodjipfrokgi\", resultHandler);\n```\n\n## Maintainers\n\n[Andrew Hill](https://github.com/andrewxhill)\n\n## Contributing\n\nSee [the contributing file](CONTRIBUTING.md)!\n\nPRs accepted.\n\nSmall note: If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.\n\n## License\n\n[MIT](LICENSE) (c) 2019 Textile\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fandroid-ipfs-lite","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextileio%2Fandroid-ipfs-lite","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextileio%2Fandroid-ipfs-lite/lists"}