types

type CandidateFinder interface {
	FindCandidates(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent), onCandidates func([]RetrievalCandidate)) error
}

type CandidateRetrieval interface {
	RetrieveFromAsyncCandidates(asyncCandidates InboundAsyncCandidates) (*RetrievalStats, error)
}

type CandidateRetriever interface {
	Retrieve(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) CandidateRetrieval
}

type CandidateSource interface {
	FindCandidates(context.Context, cid.Cid, func(RetrievalCandidate)) error
}

type EventCode string

type FIL gostatetypesbig.Int

type FetchConfig struct {
	EventsCallback func(RetrievalEvent)
}

type FetchOption func(cfg *FetchConfig)

type Fetcher interface {
	Fetch(context.Context, RetrievalRequest, ...FetchOption) (*RetrievalStats, error)
}

type FindCandidatesResult struct {
	Candidate RetrievalCandidate
	Err       error
}

type HasChecker interface {
	Has(ctx context.Context, key string) (bool, error)
}

type InboundAsyncCandidates <-chan []RetrievalCandidate

type OutboundAsyncCandidates chan<- []RetrievalCandidate

type Provider struct {
	Peer      peer.AddrInfo
	Protocols []metadata.Protocol
}

type ReadableWritableStorage interface {
	ipldstorage.ReadableStorage
	ipldstorage.WritableStorage
	ipldstorage.StreamingReadableStorage
}

type RetrievalCandidate struct {
	MinerPeer peer.AddrInfo
	RootCid   cid.Cid
	Metadata  metadata.Metadata
}

type RetrievalEvent interface {
	fmt.Stringer

	// Time returns the time that the event occurred
	Time() time.Time
	// RetrievalId returns the unique ID for this retrieval
	RetrievalId() RetrievalID
	// Code returns the type of event this is
	Code() EventCode
	// RootCid returns the CID being requested
	RootCid() cid.Cid
}

type RetrievalEventSubscriber func(event RetrievalEvent)

type RetrievalID uuid.UUID

type RetrievalRequest struct {
	trustlessutils.Request

	// RetrievalID is a unique identifier for this request.
	RetrievalID RetrievalID

	// LinkSystem is the destination for the blocks to fetch, it may be
	// pre-populated with existing blocks in the DAG, in which case they may
	// be used to satisfy the request (except in the case of an HTTP retrieval,
	// which will fetch the entire DAG, regardless).
	LinkSystem ipld.LinkSystem

	// Selector is the IPLD selector to use when fetching the DAG. If nil, the
	// Path and Scope will be used to generate a selector.
	Selector ipld.Node

	// Protocols is an optional list of protocols to use when fetching the DAG.
	// If nil, the default protocols will be used.
	Protocols []multicodec.Code

	// MaxBlocks optionally specifies the maximum number of blocks to fetch.
	// If zero, no limit is applied.
	MaxBlocks uint64

	// Providers optionally specifies a list of peers to use when fetching
	// blocks. If nil, the default peer discovery mechanism will be used.
	Providers []Provider
}

type RetrievalResult struct {
	Stats *RetrievalStats
	Err   error
}

type RetrievalStats struct {
	StorageProviderId peer.ID
	RootCid           cid.Cid
	Size              uint64
	Blocks            uint64
	Duration          time.Duration
	AverageSpeed      uint64
	TimeToFirstByte   time.Duration
	Selector          string
	// Providers lists HTTP endpoints that served blocks during retrieval
	Providers []string
}

type Retriever interface {
	Retrieve(ctx context.Context, request RetrievalRequest, events func(RetrievalEvent)) (*RetrievalStats, error)
}