Contains various implementations of the API contract described in interface-blockstore
npm install blockstore-core
> Contains various implementations of the API contract described in interface-blockstore
Various Blockstore implementations are available.
- Base: src/base
- Memory: src/memory
- BlackHole: 'src/black-hole
- Tiered: 'src/tiered
Provides a complete implementation of the Blockstore interface. You must implement .get, .put, etc.
``js
import { BaseBlockstore } from 'blockstore-core/base'
class MyCustomBlockstore extends BaseBlockstore {
put (key, val, options) {
// store a block
}
get (key, options) {
// retrieve a block
}
// ...etc
}
`
A simple Blockstore that stores blocks in memory.
`js
import { MemoryBlockstore } from 'blockstore-core/memory'
const store = new MemoryBlockstore()
`
A Blockstore that does not store any blocks.
`js
import { BlackHoleBlockstore } from 'blockstore-core/black-hole'
const store = new BlackHoleBlockstore()
`
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.
`js
import { TieredBlockstore } from 'blockstore-core/tiered'
const store = new TieredBlockstore([
store1,
store2,
// ...etc
])
`
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.
`TypeScript
import { IdentityBlockstore } from 'blockstore-core/identity'
import { CID } from 'multiformats/cid'
const blockstore = new IdentityBlockstore()
blockstore.has(CID.parse('QmFoo')) // false
blockstore.has(CID.parse('bafkqac3imvwgy3zao5xxe3de')) // true
`
`console`
$ npm i blockstore-core
-
Licensed under either of
- Apache 2.0, (LICENSE-APACHE /
- MIT (LICENSE-MIT /
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.
