{"id":13555462,"url":"https://github.com/ipfs-shipyard/ipfs-blob-store","last_synced_at":"2025-11-01T00:30:32.743Z","repository":{"id":33112794,"uuid":"36750732","full_name":"ipfs-shipyard/ipfs-blob-store","owner":"ipfs-shipyard","description":"An abstract-blob-store compatible implementation built using IPFS as the storage backend","archived":false,"fork":false,"pushed_at":"2019-03-22T20:14:44.000Z","size":1698,"stargazers_count":56,"open_issues_count":1,"forks_count":8,"subscribers_count":21,"default_branch":"master","last_synced_at":"2024-04-22T02:58:53.206Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/ipfs-shipyard.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-06-02T17:46:07.000Z","updated_at":"2022-12-24T13:10:33.000Z","dependencies_parsed_at":"2022-09-12T17:21:08.077Z","dependency_job_id":null,"html_url":"https://github.com/ipfs-shipyard/ipfs-blob-store","commit_stats":null,"previous_names":[],"tags_count":16,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fipfs-blob-store","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fipfs-blob-store/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fipfs-blob-store/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ipfs-shipyard%2Fipfs-blob-store/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ipfs-shipyard","download_url":"https://codeload.github.com/ipfs-shipyard/ipfs-blob-store/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239141468,"owners_count":19588616,"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","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-08-01T12:03:13.507Z","updated_at":"2025-11-01T00:30:32.702Z","avatar_url":"https://github.com/ipfs-shipyard.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"# ipfs-blob-store\n\n[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)\n[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)\n[![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)\n[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)\n![](https://img.shields.io/badge/coverage-%3F-yellow.svg?style=flat-square)\n[![Dependency Status](https://david-dm.org/ipfs-shipyard/ipfs-blob-store.svg?style=flat-square)](https://david-dm.org/ipfs-shipyard/ipfs-blob-store)\n[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/feross/standard)\n[![npm](https://img.shields.io/npm/v/ipfs-blob-store.svg?style=flat-square)](http://npmjs.com/package/ipfs-blob-store)\n\n\u003e An abstract-blob-store compatible implementation built using IPFS as the storage backend\n\nImplements the [abstract-blob-store](https://github.com/maxogden/abstract-blob-store), using IPFS for storage.\n\n![](https://github.com/maxogden/abstract-blob-store/raw/master/badge.png)\n\n## Install\n\n```js\nnpm install ipfs-blob-store\n```\n\n## Usage\n\n`ipfs-blob-store` uses the [IPFS Files API](#) to create the abstraction of a mutable filesystem over snapshots of Merkle DAGs (per mutation). You'll need to use the Files API directly to get the `/ipfs/Qm...` address of the filesystem root so that other IPFS nodes can retrieve it.\n\nIt requires an IPFS node to run - you can either specify a host/port combination to connect to a remote daemon, pass an instance of [`ipfs`](https://www.npmjs.com/package/ipfs) or nothing at all to have the blob store manage it's own IPFS node.\n\n### Self-managed IPFS node\n\n```JavaScript\nconst ipfsBlobStore = require('ipfs-blob-store')\n\nconst store = await ipfsBlobStore()\n\nstore.exists('/my-file.txt', (error, exists) =\u003e {\n  // ...\n})\n```\n\n### Pre-configured IPFS node\n\n```JavaScript\nconst ipfsBlobStore = require('ipfs-blob-store')\nconst IPFS = require('ipfs')\n\nconst node = new IPFS({\n  // some config here\n})\n\nnode.once('ready', () =\u003e {\n  const store = await ipfsBlobStore({\n    ipfs: node\n  })\n\n  store.exists('/my-file.txt', (error, exists) =\u003e {\n    // ...\n  })\n})\n```\n\n### Remote IPFS daemon\n\n```JavaScript\nconst ipfsBlobStore = require('ipfs-blob-store')\n\nconst store = await ipfsBlobStore({\n  host: '127.0.0.1',\n  port: 5001\n})\n\nstore.exists('/my-file.txt', (error, exists) =\u003e {\n  // ...\n})\n```\n\n### Options\n\n```JavaScript\nvar options = {\n  ipfs: null, // an instance of ipfs or ipfs-api\n  port: 5001,   // default value\n  host: '127.0.0.1', // default value\n  baseDir: '/', // default value\n  flush: true  // default value\n}\n\nconst store = await ipfsBlobStore(options)\n```\n\n### API\n\nSee [abstract-blob-store](https://www.npmjs.com/package/abstract-blob-store) for the blob store API.\n\n## Contribute\n\nFeel free to join in. All welcome. Open an [issue](https://github.com/ipfs/ipfs-blob-store/issues)!\n\nThis repository falls under the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).\n\n### Want to hack on IPFS?\n\n[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/contributing.md)\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-shipyard%2Fipfs-blob-store","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fipfs-shipyard%2Fipfs-blob-store","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fipfs-shipyard%2Fipfs-blob-store/lists"}