recovery.go

package recovery

import (
	"context"

	"github.com/ipfs/go-cid"
	format "github.com/ipfs/go-ipld-format"
	logging "github.com/ipfs/go-log/v2"
	"github.com/ipfs/go-merkledag"
)

var log = logging.Logger("recovery")

// Recoverability param defines max amount of Data Nodes that can be lost preserving recoverability.
type Recoverability = int

// Node wraps IPLD Node with an ability to recover lost linked Nodes.
type Node interface {
	format.Node

	// Recoverability of the Node.
	Recoverability() Recoverability

	// RecoveryLinks lists links to all recovery Nodes.
	RecoveryLinks() []*format.Link

	// FIXME This is awful, but there is no workaround fot that. IPFS is very strict about using only ProtoNode
	//  in multiple cases.
	Proto() *merkledag.ProtoNode
}

type Recoverer interface {

	// Recovers Nodes by ids from the recovery Node.
	Recover(context.Context, Node, ...cid.Cid) (<-chan *format.NodeOption, error)
}

type Encoder interface {

	// Encodes Node to a recovery Node.
	// Bigger recoverability - higher storage usage.
	Encode(context.Context, format.Node, Recoverability) (Node, error)
}