Module index

Example

import { BaseBlockstore } from 'blockstore-core'

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

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

  // ...etc
}
Copy

MemoryBlockstore

A simple Blockstore that stores blocks in memory.

Example

import { MemoryBlockstore } from 'blockstore-core'

const store = new MemoryBlockstore()
Copy

BlackHoleBlockstore

A Blockstore that does not store any blocks.

Example

import { BlackHoleBlockstore } from 'blockstore-core'

const store = new BlackHoleBlockstore()
Copy

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

import { TieredBlockstore } from 'blockstore-core'

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

IdentityBlockstore

An identity blockstore is one that deals exclusively in Identity CIDs - this is a special CID with the codec 0x00 where the multihash digest is the data that makes up the block.

Example

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
Copy