# interface-blockstore

> An interface for storing and retrieving blocks

Latest version **7.0.1** (published 2026-05-11) · Apache-2.0 OR MIT license · 0 weekly downloads

## Install

```sh
npm install interface-blockstore
pnpm add interface-blockstore
yarn add interface-blockstore
bun add interface-blockstore
```

## Health

**Score 65/100 (B)** — status: active.

Positive: has types; esm support; no vulnerabilities; has provenance; high maintenance score.

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 7.0.1 |
| Published | 2026-05-11 |
| First published | 2021-05-14 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 2 |
| Unpacked size | 16 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 38 |
| Maintainers | achingbrain, npm-service-account-ipfs |

## Links

- npm: https://www.npmjs.com/package/interface-blockstore
- Repository: https://github.com/ipfs/js-stores
- Homepage: https://github.com/ipfs/js-stores/tree/main/packages/interface-blockstore#readme
- Issues: https://github.com/ipfs/js-stores/issues
- npm.io page: https://npm.io/package/interface-blockstore

## Dependencies (2)

- [multiformats](https://npm.io/package/multiformats.md) ^14.0.0
- [interface-store](https://npm.io/package/interface-store.md) ^8.0.0

## Recent versions

- 7.0.1 (latest) — 2026-05-11
- 7.0.0 — 2026-05-11
- 6.0.2 — 2026-04-10
- 6.0.1 — 2025-10-03
- 6.0.0 — 2025-10-03
- 5.3.2 — 2025-05-26
- 5.3.1 — 2024-09-13
- 5.3.0 — 2024-08-02
- 5.2.10 — 2024-02-12
- 5.2.9 — 2023-12-30
- 5.2.8 — 2023-12-28
- 5.2.7 — 2023-11-27
- 5.2.6 — 2023-09-05
- 5.2.5 — 2023-08-03
- 5.2.4 — 2023-08-03
- … 26 more at https://npm.io/package/interface-blockstore/versions

## README

# interface-blockstore

[![ipfs.tech](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.tech)
[![Discuss](https://img.shields.io/discourse/https/discuss.ipfs.tech/posts.svg?style=flat-square)](https://discuss.ipfs.tech)
[![codecov](https://img.shields.io/codecov/c/github/ipfs/js-stores.svg?style=flat-square)](https://codecov.io/gh/ipfs/js-stores)
[![CI](https://img.shields.io/github/actions/workflow/status/ipfs/js-stores/js-test-and-release.yml?branch=main\&style=flat-square)](https://github.com/ipfs/js-stores/actions/workflows/js-test-and-release.yml?query=branch%3Amain)

> An interface for storing and retrieving blocks

# About

<!--

!IMPORTANT!

Everything in this README between "# About" and "# Install" is automatically
generated and will be overwritten the next time the doc generator is run.

To make changes to this section, please update the @packageDocumentation section
of src/index.js or src/index.ts

To experiment with formatting, please run "npm run docs" from the root of this
repo and examine the changes made.

-->

A Blockstore is a key/value database that lets use CIDs to store/retrieve binary blobs.

It is used by IPFS to store/retrieve the block that a given CID resolves to.

## Implementations

- File System: [`blockstore-fs`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-fs)
- IndexedDB: [`blockstore-idb`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-idb)
- level: [`blockstore-level`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-level) (supports any levelup compatible backend)
- Memory: [`blockstore-core/memory`](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/src/memory.ts)
- S3: [`blockstore-s3`](https://github.com/ipfs/js-stores/tree/main/packages/blockstore-s3)

# Install

```console
$ npm i interface-blockstore
```

# API Docs

- <https://ipfs.github.io/js-stores/modules/interface-blockstore.html>

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/packages/interface-blockstore/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/packages/interface-blockstore/LICENSE-MIT) / <http://opensource.org/licenses/MIT>)

# Contribute

Contributions welcome! Please check out [the issues](https://github.com/ipfs/js-stores/issues).

Also see our [contributing document](https://github.com/ipfs/community/blob/master/CONTRIBUTING_JS.md) for more information on how we work, and about contributing in general.

Please be aware that all interactions related to this repo are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

[![](https://cdn.rawgit.com/jbenet/contribute-ipfs-gif/master/img/contribute.gif)](https://github.com/ipfs/community/blob/master/CONTRIBUTING.md)

---
_Source: https://npm.io/package/interface-blockstore · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
