graph

Documentation

Index

• type CompatWriter
• type MutationWriter
• type Resolver
• type Writer

Types

type CompatWriter

type CompatWriter interface {
	CreateStructure(ctx context.Context, namespace string, arcs arcset.ArcSet) (cid.Cid, error)
	UpdateArc(ctx context.Context, namespace string, root cid.Cid, path string, newTarget cid.Cid) (*writer.UpdateResult, error)
	BatchUpdateArcs(ctx context.Context, namespace string, root cid.Cid, updates map[string]cid.Cid) (*writer.BatchUpdateResult, error)
	GetArc(ctx context.Context, namespace string, root cid.Cid, path string) (cid.Cid, error)
	GetSnapshot(ctx context.Context, namespace string, root cid.Cid) (arcset.ArcSet, error)
}

CompatWriter exposes reference-runtime helper methods used by the local server, CLI, and tests. These helpers are not the gateway product API.

type MutationWriter

type MutationWriter interface {
	Apply(ctx context.Context, namespace string, mut writer.SemanticMutation) (writer.WriteReceipt, error)
}

MutationWriter is the stable graph mutation port. Callers supply an explicit base root through writer.SemanticMutation and receive a result root in the write receipt; this interface does not publish heads or arbitrate freshness.

type Resolver

type Resolver interface {
	// ResolveKey traverses explicit authenticated relations without assuming a
	// payload coordinate. It is the generic graph-data authentication port.
	ResolveKey(ctx context.Context, root cid.Cid, path string) (*resolver.ResolveResult, error)
	// Resolve retains the reference materialization behavior that follows a
	// terminal @payload binding on map roots.
	Resolve(ctx context.Context, root cid.Cid, path string) (*resolver.ResolveResult, error)
	VerifyTranscript(ctx context.Context, root cid.Cid, transcript *resolver.Transcript) (bool, error)
}

Resolver is the graph read/proof port.

type Writer

type Writer interface {
	MutationWriter
	CompatWriter
}

Writer is the reference-runtime write surface. New core integrations should prefer MutationWriter unless they intentionally need compatibility helpers.