contentclaims

Documentation

Index

• func NewStoreFromBucket(bucket store.Store) types.ContentClaimsStore
• func NewStoreFromDatastore(ds datastore.Datastore) types.ContentClaimsStore
• func NewUCANServer(id principal.Signer, service types.Publisher, options ...server.Option) (server.ServerView, error)
• func NewUCANService(service types.Publisher) map[ucan.Ability]server.ServiceMethod[ok.Unit]
• type ClaimService
  • func New(store types.ContentClaimsStore, cache types.ContentClaimsCache, ...) *ClaimService
  • func (cs *ClaimService) Cache(ctx context.Context, claim delegation.Delegation) error
  • func (cs *ClaimService) Find(ctx context.Context, claim ipld.Link, url url.URL) (delegation.Delegation, error)
  • func (cs *ClaimService) Get(ctx context.Context, claim ipld.Link) (delegation.Delegation, error)
  • func (cs *ClaimService) Publish(ctx context.Context, claim delegation.Delegation) error
• type Failure
  • func NewMissingClaimError() Failure
  • func (f Failure) Error() string
  • func (f Failure) ToIPLD() (datamodel.Node, error)
• type Finder
  • func NewSimpleFinder(httpClient *http.Client) Finder
  • func WithCache(finder Finder, cache types.ContentClaimsCache) Finder
  • func WithStore(finder Finder, store types.ContentClaimsStore) Finder
• type Service

Functions

func NewStoreFromBucket

func NewStoreFromBucket(bucket store.Store) types.ContentClaimsStore

NewStoreFromBucket creates a claims store from a bucket style interface.

func NewStoreFromDatastore

func NewStoreFromDatastore(ds datastore.Datastore) types.ContentClaimsStore

func NewUCANServer

func NewUCANServer(id principal.Signer, service types.Publisher, options ...server.Option) (server.ServerView, error)

func NewUCANService

func NewUCANService(service types.Publisher) map[ucan.Ability]server.ServiceMethod[ok.Unit]

Types

type ClaimService

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

func New

func New(store types.ContentClaimsStore, cache types.ContentClaimsCache, httpClient *http.Client) *ClaimService

func (*ClaimService) Cache

func (cs *ClaimService) Cache(ctx context.Context, claim delegation.Delegation) error

func (*ClaimService) Find

func (cs *ClaimService) Find(ctx context.Context, claim ipld.Link, url url.URL) (delegation.Delegation, error)

func (*ClaimService) Get

func (cs *ClaimService) Get(ctx context.Context, claim ipld.Link) (delegation.Delegation, error)

func (*ClaimService) Publish

func (cs *ClaimService) Publish(ctx context.Context, claim delegation.Delegation) error

type Failure

type Failure struct {
	Name    string
	Message string
}

func NewMissingClaimError

func NewMissingClaimError() Failure

func (Failure) Error

func (f Failure) Error() string

func (Failure) ToIPLD

func (f Failure) ToIPLD() (datamodel.Node, error)

type Finder

type Finder interface {
	// Find and retrieve a claim via URL.
	Find(ctx context.Context, claim ipld.Link, fetchURL url.URL) (delegation.Delegation, error)
}

func NewSimpleFinder

func NewSimpleFinder(httpClient *http.Client) Finder

NewSimpleFinder creates a new Finder with the provided HTTP client.

func WithCache

func WithCache(finder Finder, cache types.ContentClaimsCache) Finder

WithCache augments a ClaimFinder with cached claims from a claim cache

func WithStore

func WithStore(finder Finder, store types.ContentClaimsStore) Finder

WithStore augments a ClaimFinder with claims retrieved from a claim store

type Service

type Service interface {
	// Get reads the claim from the cache, or from storage if not found.
	Get(ctx context.Context, claim ipld.Link) (delegation.Delegation, error)
	// Find attempts to read the claim from the cache, falling back to retrieving
	// it from storage and finally, if still not found, fetching it from the
	// provided URL. The result is stored in the cache.
	Find(ctx context.Context, claim ipld.Link, fetchURL url.URL) (delegation.Delegation, error)
	// Cache writes the claim to the cache with default expiry.
	Cache(ctx context.Context, claim delegation.Delegation) error
	// Publish writes the claim to the cache, and adds it to storage.
	Publish(ctx context.Context, claim delegation.Delegation) error
}