indexer

type Client struct {
	Requester rpc.EndpointRequester
}

type Config struct {
	DB                   database.Database
	Log                  log.Logger
	IndexingEnabled      bool
	AllowIncompleteIndex bool
	BlockAcceptorGroup   nodeconsensus.AcceptorGroup
	TxAcceptorGroup      nodeconsensus.AcceptorGroup
	VertexAcceptorGroup  nodeconsensus.AcceptorGroup
	APIServer            server.PathAdder
	ShutdownF            func()
}

type Container struct {
	// ID of this container
	ID ids.ID `serialize:"true"`
	// Byte representation of this container
	Bytes []byte `serialize:"true"`
	// Unix time, in nanoseconds, at which this container was accepted by this node
	Timestamp int64 `serialize:"true"`
}

type FormattedContainer struct {
	// ID is the container's own id.
	ID ids.ID `json:"id"`
	// Bytes is the container, written in Encoding.
	Bytes string `json:"bytes"`
	// Timestamp is when this node accepted the container.
	Timestamp json.Time `json:"timestamp"`
	// Encoding is how Bytes is written.
	Encoding formatting.Encoding `json:"encoding"`
	// Index is the container's position in the accepted order, from zero.
	Index json.Uint64 `json:"index"`
}

type GetContainerByIDArgs struct {
	// ID is the container to read.
	ID ids.ID `json:"id"`
	// Encoding is how to write the container's bytes.
	Encoding formatting.Encoding `json:"encoding"`
}

type GetContainerByIndexArgs struct {
	// Index is the position to read, from zero.
	Index json.Uint64 `json:"index"`
	// Encoding is how to write the container's bytes.
	Encoding formatting.Encoding `json:"encoding"`
}

type GetContainerRangeArgs struct {
	// StartIndex is the first position to read, from zero.
	StartIndex json.Uint64 `json:"startIndex"`
	// NumToFetch is how many to read from there.
	NumToFetch json.Uint64 `json:"numToFetch"`
	// Encoding is how to write each container's bytes.
	Encoding formatting.Encoding `json:"encoding"`
}

type GetContainerRangeResponse struct {
	// Containers are those read, in accepted order.
	Containers []FormattedContainer `json:"containers"`
}

type GetIndexArgs struct {
	// ID is the container to locate.
	ID ids.ID `json:"id"`
}

type GetIndexResponse struct {
	// Index is the container's position in the accepted order, from zero.
	Index json.Uint64 `json:"index"`
}

type GetLastAcceptedArgs struct {
	// Encoding is how to write the container's bytes.
	Encoding formatting.Encoding `json:"encoding"`
}

type Indexer interface {
	chains.Registrant
	// Close will do nothing and return nil after the first call
	io.Closer
}

type IsAcceptedArgs struct {
	// ID is the container to ask about.
	ID ids.ID `json:"id"`
}

type IsAcceptedResponse struct {
	// IsAccepted is whether this node has accepted and indexed the container.
	IsAccepted bool `json:"isAccepted"`
}