store

type AdStore struct {
	// contains filtered or unexported fields
}

type AdvertReadable interface {
	// Advert retrieves an existing advert from the store.
	Advert(ctx context.Context, id ipld.Link) (schema.Advertisement, error)
}

type AdvertStore interface {
	AdvertReadable
	AdvertWritable
}

type AdvertWritable interface {
	PutAdvert(ctx context.Context, ad schema.Advertisement) (ipld.Link, error)
}

type ChunkLinkStore interface {
	ChunkLinkForProviderAndContextID(ctx context.Context, p peer.ID, contextID []byte) (ipld.Link, error)
	PutChunkLinkForProviderAndContextID(ctx context.Context, p peer.ID, contextID []byte, adCid ipld.Link) error
	DeleteChunkLinkForProviderAndContextID(ctx context.Context, p peer.ID, contextID []byte) error
}

type EncodeableStore interface {
	Encode(ctx context.Context, id ipld.Link, w io.Writer) error
	EncodeHead(ctx context.Context, w io.Writer) error
}

type EntriesReadable interface {
	// Entries returns an iterable of multihashes from the store for the
	// given root of an existing advertisement entries chain.
	Entries(ctx context.Context, root ipld.Link) iter.Seq2[multihash.Multihash, error]
}

type EntriesStore interface {
	EntriesReadable
	EntriesWritable
}

type EntriesWritable interface {
	// PutEntries writes a given set of multihash entries to do the store and returns the root cid
	PutEntries(ctx context.Context, entries iter.Seq[multihash.Multihash]) (ipld.Link, error)
}

type ErrNotFound struct {
	// contains filtered or unexported fields
}

type FullStore interface {
	EncodeableStore
	PublisherStore
}

type HeadStore interface {
	Head(ctx context.Context) (*head.SignedHead, error)
	// ReplaceHead swaps the previous head for the provided new head. Note the
	// previous head may be nil when no head exists yet.
	//
	// It allows an implementation to perform conditional writes to mitigate
	// against losing an advert when 2 or more are published concurrently.
	//
	// [ErrPreconditionFailed] is returned when the write fails due to the current
	// head not matching the passed old head.
	ReplaceHead(ctx context.Context, oldHead *head.SignedHead, newHead *head.SignedHead) (ipld.Link, error)
}

type MetadataStore interface {
	MetadataForProviderAndContextID(ctx context.Context, p peer.ID, contextID []byte) (metadata.Metadata, error)
	PutMetadataForProviderAndContextID(ctx context.Context, p peer.ID, contextID []byte, md metadata.Metadata) error
	DeleteMetadataForProviderAndContextID(ctx context.Context, p peer.ID, contextID []byte) error
}

type Option func(cfg *options)

type ProviderContextTable interface {
	Get(ctx context.Context, p peer.ID, contextID []byte) ([]byte, error)
	Put(ctx context.Context, p peer.ID, contextID []byte, data []byte) error
	Delete(ctx context.Context, p peer.ID, contextID []byte) error
}

type PublisherStore interface {
	AdvertStore
	EntriesStore
	HeadStore
	ChunkLinkStore
	MetadataStore
}

type SimpleStore interface {
	Get(ctx context.Context, key string) (io.ReadCloser, error)
	Put(ctx context.Context, key string, len uint64, data io.Reader) error
}

type Store interface {
	SimpleStore
	// Replace allows conditional writes to the store. It returns
	// [ErrPreconditionFailed] when a write fails due to the old data not matching
	// the passed value. Note: old may be nil, when no old data exists.
	Replace(ctx context.Context, key string, old io.Reader, len uint64, new io.Reader) error
}