sync

type Client interface {
	// GetDiff requests a write log of entries that must be applied to get from the first given root
	// to the second one.
	GetDiff(ctx context.Context, request *GetDiffRequest) (*GetDiffResponse, rpc.PeerFeedback, error)

	// GetCheckpoints returns a list of checkpoint metadata for all known checkpoints.
	GetCheckpoints(ctx context.Context, request *GetCheckpointsRequest) (*GetCheckpointsResponse, error)

	// GetCheckpointChunk requests a specific checkpoint chunk.
	GetCheckpointChunk(ctx context.Context, request *GetCheckpointChunkRequest) (*GetCheckpointChunkResponse, rpc.PeerFeedback, error)
}

type GetCheckpointChunkRequest struct {
	Version uint16       `json:"version"`
	Root    storage.Root `json:"root"`
	Index   uint64       `json:"index"`
	Digest  hash.Hash    `json:"digest"`
}

type GetCheckpointChunkResponse struct {
	Chunk []byte `json:"chunk,omitempty"`
}

type GetCheckpointsRequest struct {
	Version uint16 `json:"version"`
}

type GetCheckpointsResponse struct {
	Checkpoints []*checkpoint.Metadata `json:"checkpoints,omitempty"`
}

type GetDiffRequest struct {
	StartRoot storage.Root `json:"start_root"`
	EndRoot   storage.Root `json:"end_root"`
}

type GetDiffResponse struct {
	WriteLog storage.WriteLog `json:"write_log,omitempty"`
}