# blockstore-core

> Contains various implementations of the API contract described in interface-blockstore

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

## Install

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

## Health

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

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

Warnings: low downloads.

## Facts

| | |
|---|---|
| Version | 7.0.1 |
| Published | 2026-05-11 |
| First published | 2021-09-09 |
| Weekly downloads | 0 |
| License | Apache-2.0 OR MIT |
| TypeScript types | bundled |
| Module format | ESM |
| Dependencies | 8 |
| Unpacked size | 250.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 38 |
| Author | Alex Potsides |
| Maintainers | achingbrain, npm-service-account-ipfs |
| Keywords | datastore, interface, ipfs, key-value |

## Links

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

## Dependencies (8)

- [it-all](https://npm.io/package/it-all.md) ^3.0.9
- [it-merge](https://npm.io/package/it-merge.md) ^3.0.12
- [it-filter](https://npm.io/package/it-filter.md) ^3.1.4
- [abort-error](https://npm.io/package/abort-error.md) ^1.0.2
- [multiformats](https://npm.io/package/multiformats.md) ^14.0.0
- [@libp2p/logger](https://npm.io/package/@libp2p/logger.md) ^6.2.4
- [interface-store](https://npm.io/package/interface-store.md) ^8.0.0
- [interface-blockstore](https://npm.io/package/interface-blockstore.md) ^7.0.0

## Recent versions

- 7.0.1 (latest) — 2026-05-11
- 7.0.0 — 2026-05-11
- 6.1.3 — 2026-04-10
- 6.1.2 — 2026-01-08
- 6.1.1 — 2025-10-09
- 6.1.0 — 2025-10-09
- 6.0.2 — 2025-10-03
- 6.0.1 — 2025-10-03
- 6.0.0 — 2025-10-03
- 5.0.4 — 2025-05-28
- 5.0.3 — 2025-05-26
- 5.0.2 — 2024-09-13
- 5.0.1 — 2024-09-12
- 5.0.0 — 2024-08-02
- 4.4.1 — 2024-04-09
- … 31 more at https://npm.io/package/blockstore-core/versions

## README

# blockstore-core

[![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)

> Contains various implementations of the API contract described in interface-blockstore

# 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.

-->

Various Blockstore implementations are available.

## BaseBlockstore

Provides a complete implementation of the Blockstore interface.  You must implement `.get`, `.put`, etc.

## Example

```js
import { BaseBlockstore } from 'blockstore-core'

class MyCustomBlockstore extends BaseBlockstore {
  put (key, val, options) {
    // store a block
  }

  get (key, options) {
    // retrieve a block
  }

  // ...etc
}
```

## MemoryBlockstore

A simple Blockstore that stores blocks in memory.

## Example

```js
import { MemoryBlockstore } from 'blockstore-core'

const store = new MemoryBlockstore()
```

## BlackHoleBlockstore

A Blockstore that does not store any blocks.

## Example

```js
import { BlackHoleBlockstore } from 'blockstore-core'

const store = new BlackHoleBlockstore()
```

## TieredBlockstore

A tiered blockstore wraps one or more blockstores and will query each in parallel to retrieve a block - the operation will succeed if any wrapped store has the block.

Writes are invoked on all wrapped blockstores.

## Example

```js
import { TieredBlockstore } from 'blockstore-core'

const store = new TieredBlockstore([
  store1,
  store2,
  // ...etc
])
```

## IdentityBlockstore

An identity blockstore is one that deals exclusively in Identity CIDs - this is a special CID with the codec [0x00](https://github.com/multiformats/multicodec/blob/d06fc6194710e8909bac64273c43f16b56ca4c34/table.csv#L2) where the multihash digest is the data that makes up the block.

## Example

```TypeScript
import { IdentityBlockstore } from 'blockstore-core'
import { CID } from 'multiformats/cid'

const blockstore = new IdentityBlockstore()

blockstore.has(CID.parse('QmFoo')) // false

blockstore.has(CID.parse('bafkqac3imvwgy3zao5xxe3de')) // true
```

# Install

```console
$ npm i blockstore-core
```

## Browser `<script>` tag

Loading this module through a script tag will make its exports available as `BlockstoreCore` in the global namespace.

```html
<script src="https://unpkg.com/blockstore-core/dist/index.min.js"></script>
```

# API Docs

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

# License

Licensed under either of

- Apache 2.0, ([LICENSE-APACHE](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/LICENSE-APACHE) / <http://www.apache.org/licenses/LICENSE-2.0>)
- MIT ([LICENSE-MIT](https://github.com/ipfs/js-stores/blob/main/packages/blockstore-core/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/blockstore-core · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._