blockstore-core

blockstore-core

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

Table of contents

• Install
  • Browser <script> tag
• Implementations
• Usage
  • BaseBlockstore
  • MemoryBlockstore
  • BlackHoleBlockstore
  • TieredBlockstore
• API Docs
• License
• Contribute

Install

$ npm i blockstore-core

Browser <script> tag

Loading this module through a script tag will make it's exports available as BlockstoreCore in the global namespace.

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

Implementations

• Base: src/base
• Memory: src/memory
• BlackHole: 'src/black-hole
• Tiered: 'src/tiered

Usage

BaseBlockstore

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

import { BaseBlockstore } from 'blockstore-core/base'

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.

import { MemoryBlockstore } from 'blockstore-core/memory'

const store = new MemoryBlockstore()

BlackHoleBlockstore

A Blockstore that does not store any blocks.

import { BlackHoleBlockstore } from 'blockstore-core/black-hole'

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.

import { TieredBlockstore } from 'blockstore-core/tiered'

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

API Docs

• https://ipfs.github.io/js-stores/modules/blockstore_core.html

License

Licensed under either of

• Apache 2.0, (LICENSE-APACHE / http://www.apache.org/licenses/LICENSE-2.0)
• MIT (LICENSE-MIT / http://opensource.org/licenses/MIT)

Contribute

Contributions welcome! Please check out the issues.

Also see our contributing document 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.

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.