stargate

type AppResolver interface {
	// GetResolver attempts to resolve starting from the given root. It returns a linksystem to load blocks from
	// and a resolver for the query
	GetResolver(ctx context.Context, root cid.Cid) (*ipld.LinkSystem, PathResolver, error)
}

type BlockMetadata []BlockMetadatum

type BlockMetadatum struct {
	Link   cid.Cid
	Status BlockStatus
}

type BlockStatus string

type DAG struct {
	Ordering Ordering
	Blocks   BlockMetadata
}

type ErrNoMoreMessages struct{}

type ErrNotFound struct {
	Cid cid.Cid
}

type ErrPathError struct {
	Cid  cid.Cid
	Path string
	Err  error
}

type Kind string

type Ordering string

type Path struct {
	// name of this path segment
	Segments []string
	// CIDs required, in order, to verify this segment of the path
	Blocks BlockMetadata
}

type PathResolver interface {
	// ResolvePathSegments attempts to resolve a path
	// On success, an implementation should:
	// - resolve at least one path segment
	// - return:
	//   - a valid stargate path message
	//   - any unresolved segments
	//   - a resolver operating whose root is at the end of the resolved portion of the path
	// On error, all values should be nil except the error value
	ResolvePathSegments(ctx context.Context, path PathSegments) (*Path, PathSegments, PathResolver, error)

	// ResolverQuery returns a resolver to fulfill the remaining portion of a request after path resolution with the
	// given query string.
	ResolveQuery(ctx context.Context, query Query) (QueryResolver, error)
}

type PathSegments []string

type Query map[string][]string

type QueryResolver interface {
	// Next returns the next message
	Next() (*DAG, error)
	// done indicates where the query is fully resolved or there are more messages
	Done() bool
}

type StarGateMessage struct {
	Kind Kind
	Path *Path
	DAG  *DAG
}