Deprecate repo

README.md

@@ -1,33 +1,26 @@
 interface-go-ipfs-core
 ==================
 
+> The CoreAPI interfaces for go-ipfs.
+
 [![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://protocol.ai)
 [![](https://img.shields.io/badge/project-IPFS-blue.svg?style=flat-square)](https://ipfs.io/)
 [![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](https://webchat.freenode.net/?channels=%23ipfs)
 [![Coverage Status](https://codecov.io/gh/ipfs/interface-go-ipfs-core/branch/master/graph/badge.svg)](https://codecov.io/gh/ipfs/interface-go-ipfs-core/branch/master)
 
-> The CoreAPI interfaces for go-ipfs.
+## ❗ This repo is no longer maintained.
+👉 We highly recommend switching to the maintained version at https://github.com/ipfs/boxo/tree/main/coreiface.
+🏎️ Good news!  There is [tooling and documentation](https://github.com/ipfs/boxo#migrating-to-boxo) to expedite a switch in your repo. 
 
-## Lead Maintainer
+⚠️ If you continue using this repo, please note that security fixes will not be provided (unless someone steps in to maintain it).
 
-[Steven Allen](https://github.com/Stebalien)
+📚 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
 
-- [Background](#background)
-- [Contribute](#contribute)
+- [Background](#background
 - [License](#license)
 
-## Documentation
-
-TODO
-
-## Contribute
-
-PRs are welcome!
-
-Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
-
 ## License
 
 MIT © Protocol Labs

block.go

@@ -10,6 +10,8 @@ import (
 )
 
 // BlockStat contains information about a block
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.BlockStat
 type BlockStat interface {
 	// Size is the size of a block
 	Size() int
@@ -19,6 +21,8 @@ type BlockStat interface {
 }
 
 // BlockAPI specifies the interface to the block layer
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.BlockAPI
 type BlockAPI interface {
 	// Put imports raw block data, hashing it using specified settings.
 	Put(context.Context, io.Reader, ...options.BlockPutOption) (BlockStat, error)

coreapi.go

@@ -13,6 +13,8 @@ import (
 )
 
 // CoreAPI defines an unified interface to IPFS for Go programs
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.CoreAPI
 type CoreAPI interface {
 	// Unixfs returns an implementation of Unixfs API
 	Unixfs() UnixfsAPI

dag.go

@@ -5,6 +5,8 @@ import (
 )
 
 // APIDagService extends ipld.DAGService
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.APIDagService
 type APIDagService interface {
 	ipld.DAGService
 

dht.go

@@ -13,6 +13,8 @@ import (
 // DhtAPI specifies the interface to the DHT
 // Note: This API will likely get deprecated in near future, see
 // https://github.com/ipfs/interface-ipfs-core/issues/249 for more context.
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.DhtAPI
 type DhtAPI interface {
 	// FindPeer queries the DHT for all of the multiaddresses associated with a
 	// Peer ID

errors.go

@@ -3,8 +3,12 @@ package iface
 import "errors"
 
 var (
-	ErrIsDir        = errors.New("this dag node is a directory")
-	ErrNotFile      = errors.New("this dag node is not a regular file")
-	ErrOffline      = errors.New("this action must be run in online mode, try running 'ipfs daemon' first")
+	// Deprecated: use github.com/ipfs/boxo/coreiface.ErrIsDir
+	ErrIsDir = errors.New("this dag node is a directory")
+	// Deprecated: use github.com/ipfs/boxo/coreiface.ErrNotFile
+	ErrNotFile = errors.New("this dag node is not a regular file")
+	// Deprecated: use github.com/ipfs/boxo/coreiface.ErrOffline
+	ErrOffline = errors.New("this action must be run in online mode, try running 'ipfs daemon' first")
+	// Deprecated: use github.com/ipfs/boxo/coreiface.ErrNotSupported
 	ErrNotSupported = errors.New("operation not supported")
 )

idfmt.go

@@ -5,6 +5,7 @@ import (
 	mbase "github.com/multiformats/go-multibase"
 )
 
+// Deprecated: use github.com/ipfs/boxo/coreiface.FormatKeyID
 func FormatKeyID(id peer.ID) string {
 	if s, err := peer.ToCid(id).StringOfBase(mbase.Base36); err != nil {
 		panic(err)
@@ -14,6 +15,8 @@ func FormatKeyID(id peer.ID) string {
 }
 
 // FormatKey formats the given IPNS key in a canonical way.
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.FormatKey
 func FormatKey(key Key) string {
 	return FormatKeyID(key.ID())
 }

key.go

@@ -11,6 +11,8 @@ import (
 )
 
 // Key specifies the interface to Keys in KeyAPI Keystore
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.Key
 type Key interface {
 	// Key returns key name
 	Name() string
@@ -23,6 +25,8 @@ type Key interface {
 }
 
 // KeyAPI specifies the interface to Keystore
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.KeyAPI
 type KeyAPI interface {
 	// Generate generates new key, stores it in the keystore under the specified
 	// name and returns a base58 encoded multihash of it's public key

name.go

@@ -9,16 +9,20 @@ import (
 	"github.com/ipfs/interface-go-ipfs-core/options"
 )
 
+// Deprecated: use github.com/ipfs/boxo/coreiface.ErrResolveFailed
 var ErrResolveFailed = errors.New("could not resolve name")
 
 // IpnsEntry specifies the interface to IpnsEntries
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.IpnsEntry
 type IpnsEntry interface {
 	// Name returns IpnsEntry name
 	Name() string
 	// Value returns IpnsEntry value
 	Value() path.Path
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface.IpnsResult
 type IpnsResult struct {
 	path.Path
 	Err error
@@ -32,6 +36,8 @@ type IpnsResult struct {
 // its public key.
 //
 // You can use .Key API to list and generate more names and their respective keys.
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.NameAPI
 type NameAPI interface {
 	// Publish announces new IPNS name
 	Publish(ctx context.Context, path path.Path, opts ...options.NamePublishOption) (IpnsEntry, error)

object.go

@@ -13,6 +13,8 @@ import (
 )
 
 // ObjectStat provides information about dag nodes
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.ObjectStat
 type ObjectStat struct {
 	// Cid is the CID of the node
 	Cid cid.Cid
@@ -34,20 +36,30 @@ type ObjectStat struct {
 }
 
 // ChangeType denotes type of change in ObjectChange
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.ChangeType
 type ChangeType int
 
 const (
 	// DiffAdd is set when a link was added to the graph
+	//
+	// Deprecated: use github.com/ipfs/boxo/coreiface.DiffAdd
 	DiffAdd ChangeType = iota
 
 	// DiffRemove is set when a link was removed from the graph
+	//
+	// Deprecated: use github.com/ipfs/boxo/coreiface.DiffRemove
 	DiffRemove
 
 	// DiffMod is set when a link was changed in the graph
+	//
+	// Deprecated: use github.com/ipfs/boxo/coreiface.DiffMod
 	DiffMod
 )
 
 // ObjectChange represents a change ia a graph
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.ObjectChange
 type ObjectChange struct {
 	// Type of the change, either:
 	// * DiffAdd - Added a link
@@ -69,6 +81,8 @@ type ObjectChange struct {
 
 // ObjectAPI specifies the interface to MerkleDAG and contains useful utilities
 // for manipulating MerkleDAG data structures.
+//
+// Deprecated: use github.com/ipfs/boxo/coreiface.ObjectAPI
 type ObjectAPI interface {
 	// New creates new, empty (by default) dag-node.
 	New(context.Context, ...options.ObjectNewOption) (ipld.Node, error)

options/block.go

@@ -8,18 +8,24 @@ import (
 	mh "github.com/multiformats/go-multihash"
 )
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockPutSettings
 type BlockPutSettings struct {
 	CidPrefix cid.Prefix
 	Pin       bool
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockRmSettings
 type BlockRmSettings struct {
 	Force bool
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockPutOption
 type BlockPutOption func(*BlockPutSettings) error
+
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockRmOption
 type BlockRmOption func(*BlockRmSettings) error
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockPutOptions
 func BlockPutOptions(opts ...BlockPutOption) (*BlockPutSettings, error) {
 	var cidPrefix cid.Prefix
 
@@ -45,6 +51,7 @@ func BlockPutOptions(opts ...BlockPutOption) (*BlockPutSettings, error) {
 	return options, nil
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.BlockRmOptions
 func BlockRmOptions(opts ...BlockRmOption) (*BlockRmSettings, error) {
 	options := &BlockRmSettings{
 		Force: false,
@@ -61,6 +68,7 @@ func BlockRmOptions(opts ...BlockRmOption) (*BlockRmSettings, error) {
 
 type blockOpts struct{}
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.Block
 var Block blockOpts
 
 // CidCodec is the modern option for Block.Put which specifies the multicodec to use

options/dht.go

@@ -1,16 +1,22 @@
 package options
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtProvideSettings
 type DhtProvideSettings struct {
 	Recursive bool
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtFindProvidersSettings
 type DhtFindProvidersSettings struct {
 	NumProviders int
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtProvideOption
 type DhtProvideOption func(*DhtProvideSettings) error
+
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtFindProvidersOption
 type DhtFindProvidersOption func(*DhtFindProvidersSettings) error
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtProvideOptions
 func DhtProvideOptions(opts ...DhtProvideOption) (*DhtProvideSettings, error) {
 	options := &DhtProvideSettings{
 		Recursive: false,
@@ -25,6 +31,7 @@ func DhtProvideOptions(opts ...DhtProvideOption) (*DhtProvideSettings, error) {
 	return options, nil
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.DhtFindProvidersOptions
 func DhtFindProvidersOptions(opts ...DhtFindProvidersOption) (*DhtFindProvidersSettings, error) {
 	options := &DhtFindProvidersSettings{
 		NumProviders: 20,
@@ -41,6 +48,7 @@ func DhtFindProvidersOptions(opts ...DhtFindProvidersOption) (*DhtFindProvidersS
 
 type dhtOpts struct{}
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.Dht
 var Dht dhtOpts
 
 // Recursive is an option for Dht.Provide which specifies whether to provide

options/global.go

@@ -1,12 +1,15 @@
 package options
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiSettings
 type ApiSettings struct {
 	Offline     bool
 	FetchBlocks bool
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiOption
 type ApiOption func(*ApiSettings) error
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiOptions
 func ApiOptions(opts ...ApiOption) (*ApiSettings, error) {
 	options := &ApiSettings{
 		Offline:     false,
@@ -16,6 +19,7 @@ func ApiOptions(opts ...ApiOption) (*ApiSettings, error) {
 	return ApiOptionsTo(options, opts...)
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.ApiOptionsTo
 func ApiOptionsTo(options *ApiSettings, opts ...ApiOption) (*ApiSettings, error) {
 	for _, opt := range opts {
 		err := opt(options)
@@ -28,6 +32,7 @@ func ApiOptionsTo(options *ApiSettings, opts ...ApiOption) (*ApiSettings, error)
 
 type apiOpts struct{}
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.Api
 var Api apiOpts
 
 func (apiOpts) Offline(offline bool) ApiOption {

options/key.go

@@ -1,24 +1,33 @@
 package options
 
 const (
-	RSAKey     = "rsa"
+	// Deprecated: use github.com/ipfs/boxo/coreiface/options.RSAKey
+	RSAKey = "rsa"
+	// Deprecated: use github.com/ipfs/boxo/coreiface/options.Ed25519Key
 	Ed25519Key = "ed25519"
 
+	// Deprecated: use github.com/ipfs/boxo/coreiface/options.DefaultRSALen
 	DefaultRSALen = 2048
 )
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyGenerateSettings
 type KeyGenerateSettings struct {
 	Algorithm string
 	Size      int
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyRenameSettings
 type KeyRenameSettings struct {
 	Force bool
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyGenerateOption
 type KeyGenerateOption func(*KeyGenerateSettings) error
+
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyRenameOption
 type KeyRenameOption func(*KeyRenameSettings) error
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyGenerateOptions
 func KeyGenerateOptions(opts ...KeyGenerateOption) (*KeyGenerateSettings, error) {
 	options := &KeyGenerateSettings{
 		Algorithm: RSAKey,
@@ -34,6 +43,7 @@ func KeyGenerateOptions(opts ...KeyGenerateOption) (*KeyGenerateSettings, error)
 	return options, nil
 }
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.KeyRenameOptions
 func KeyRenameOptions(opts ...KeyRenameOption) (*KeyRenameSettings, error) {
 	options := &KeyRenameSettings{
 		Force: false,
@@ -50,6 +60,7 @@ func KeyRenameOptions(opts ...KeyRenameOption) (*KeyRenameSettings, error) {
 
 type keyOpts struct{}
 
+// Deprecated: use github.com/ipfs/boxo/coreiface/options.Key
 var Key keyOpts
 
 // Type is an option for Key.Generate which specifies which algorithm