chore: deprecate types and readme

Author: hacdias

README.md

@@ -1,17 +1,20 @@
 # go-ipfs-blockstore
 
+> go-ipfs-blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects.
+
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](http://ipfs.io/)
 [![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 [![GoDoc](https://godoc.org/github.com/ipfs/go-ipfs-blockstore?status.svg)](https://godoc.org/github.com/ipfs/go-ipfs-blockstore)
 [![Build Status](https://travis-ci.com/ipfs/go-ipfs-blockstore.svg?branch=master)](https://travis-ci.com/ipfs/go-ipfs-blockstore)
 
-> go-ipfs-blockstore implements a thin wrapper over a datastore, giving a clean interface for Getting and Putting block objects.
-
-## Lead Maintainer
+## ❗ This repo is no longer maintained.
+👉 We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/blockstore.
+🏎️ Good news!  There is [tooling and documentation](https://github.com/ipfs/boxo#migrating-to-boxo) to expedite a switch in your repo. 
 
-[Steven Allen](https://github.com/Stebalien)
+⚠️ If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).
 
+📚 Learn more, including how to take the maintainership mantle or ask questions, [here](https://github.com/ipfs/boxo/wiki/Copied-or-Migrated-Repos-FAQ).
 
 ## Table of Contents
 

blockstore.go

@@ -22,14 +22,20 @@ import (
 var logger = logging.Logger("blockstore")
 
 // BlockPrefix namespaces blockstore datastores
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.BlockPrefix
 var BlockPrefix = ds.NewKey("blocks")
 
 // ErrHashMismatch is an error returned when the hash of a block
 // is different than expected.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.ErrHashMismatch
 var ErrHashMismatch = errors.New("block in storage has different hash than requested")
 
 // Blockstore wraps a Datastore block-centered methods and provides a layer
 // of abstraction which allows to add different caching strategies.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.Blockstore
 type Blockstore interface {
 	DeleteBlock(context.Context, cid.Cid) error
 	Has(context.Context, cid.Cid) (bool, error)
@@ -66,12 +72,16 @@ type Blockstore interface {
 // The callback will only be called iff the query operation is successful (and
 // the block is found); otherwise, the error will be propagated. Errors returned
 // by the callback will be propagated as well.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.Viewer
 type Viewer interface {
 	View(ctx context.Context, cid cid.Cid, callback func([]byte) error) error
 }
 
 // GCLocker abstract functionality to lock a blockstore when performing
 // garbage-collection operations.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.GCLocker
 type GCLocker interface {
 	// GCLock locks the blockstore for garbage collection. No operations
 	// that expect to finish with a pin should ocurr simultaneously.
@@ -91,13 +101,17 @@ type GCLocker interface {
 
 // GCBlockstore is a blockstore that can safely run garbage-collection
 // operations.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.GCBlockstore
 type GCBlockstore interface {
 	Blockstore
 	GCLocker
 }
 
 // NewGCBlockstore returns a default implementation of GCBlockstore
 // using the given Blockstore and GCLocker.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.NewGCBlockstore
 func NewGCBlockstore(bs Blockstore, gcl GCLocker) GCBlockstore {
 	return gcBlockstore{bs, gcl}
 }
@@ -108,12 +122,16 @@ type gcBlockstore struct {
 }
 
 // Option is a default implementation Blockstore option
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.Option
 type Option struct {
 	f func(bs *blockstore)
 }
 
 // WriteThrough skips checking if the blockstore already has a block before
 // writing it.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.WriteThrough
 func WriteThrough() Option {
 	return Option{
 		func(bs *blockstore) {
@@ -124,6 +142,8 @@ func WriteThrough() Option {
 
 // NoPrefix avoids wrapping the blockstore into the BlockPrefix namespace
 // ("/blocks"), so keys will not be modified in any way.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.NoPrefix
 func NoPrefix() Option {
 	return Option{
 		func(bs *blockstore) {
@@ -134,6 +154,8 @@ func NoPrefix() Option {
 
 // NewBlockstore returns a default Blockstore implementation
 // using the provided datastore.Batching backend.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.NewBlockstore
 func NewBlockstore(d ds.Batching, opts ...Option) Blockstore {
 	bs := &blockstore{
 		datastore: d,
@@ -155,6 +177,8 @@ func NewBlockstore(d ds.Batching, opts ...Option) Blockstore {
 // This constructor does not modify input keys in any way
 //
 // Deprecated: Use NewBlockstore with the NoPrefix option instead.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.NewBlockstoreNoPrefix
 func NewBlockstoreNoPrefix(d ds.Batching) Blockstore {
 	return NewBlockstore(d, NoPrefix())
 }
@@ -305,6 +329,8 @@ func (bs *blockstore) AllKeysChan(ctx context.Context) (<-chan cid.Cid, error) {
 
 // NewGCLocker returns a default implementation of
 // GCLocker using standard [RW] mutexes.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.NewGCLocker
 func NewGCLocker() GCLocker {
 	return &gclocker{}
 }
@@ -316,6 +342,8 @@ type gclocker struct {
 
 // Unlocker represents an object which can Unlock
 // something.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.Unlocker
 type Unlocker interface {
 	Unlock(context.Context)
 }

caching.go

@@ -9,13 +9,17 @@ import (
 
 // CacheOpts wraps options for CachedBlockStore().
 // Next to each option is it aproximate memory usage per unit
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.CacheOpts
 type CacheOpts struct {
 	HasBloomFilterSize   int // 1 byte
 	HasBloomFilterHashes int // No size, 7 is usually best, consult bloom papers
 	HasARCCacheSize      int // 32 bytes
 }
 
 // DefaultCacheOpts returns a CacheOpts initialized with default values.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.DefaultCacheOpts
 func DefaultCacheOpts() CacheOpts {
 	return CacheOpts{
 		HasBloomFilterSize:   512 << 10,
@@ -26,6 +30,8 @@ func DefaultCacheOpts() CacheOpts {
 
 // CachedBlockstore returns a blockstore wrapped in an ARCCache and
 // then in a bloom filter cache, if the options indicate it.
+//
+// Deprecated: use github.com/ipfs/boxo/blockstore.CachedBlockstore
 func CachedBlockstore(
 	ctx context.Context,
 	bs Blockstore,

idstore.go

@@ -19,6 +19,7 @@ var _ Blockstore = (*idstore)(nil)
 var _ Viewer = (*idstore)(nil)
 var _ io.Closer = (*idstore)(nil)
 
+// Deprecated: use github.com/ipfs/boxo/blockstore.NewIdStore
 func NewIdStore(bs Blockstore) Blockstore {
 	ids := &idstore{bs: bs}
 	if v, ok := bs.(Viewer); ok {