indexer

Documentation

Index

• Constants
• type Client
  • func NewClient(host, endpoint string) Client
• type Config
• type Container
• type FormattedContainer
• type GetContainer
• type GetContainerRangeArgs
• type GetContainerRangeResponse
• type GetIndexArgs
• type GetIndexResponse
• type GetLastAcceptedArgs
• type Index
• type Indexer
  • func NewIndexer(config Config) (Indexer, error)
• type IsAcceptedResponse

Constants

const (
	// Maximum number of containers IDs that can be fetched at a time
	// in a call to GetContainerRange
	MaxFetchedByRange = 1024
)

Types

type Client

type Client interface {
	// GetContainerRange returns the transactions at index [startIndex], [startIndex+1], ... , [startIndex+n-1]
	// If [n] == 0, returns an empty response (i.e. null).
	// If [startIndex] > the last accepted index, returns an error (unless the above apply.)
	// If we run out of transactions, returns the ones fetched before running out.
	GetContainerRange(context.Context, *GetContainerRangeArgs, ...rpc.Option) ([]Container, error)
	// Get a container by its index
	GetContainerByIndex(context.Context, *GetContainer, ...rpc.Option) (Container, error)
	// Get the most recently accepted container
	GetLastAccepted(context.Context, *GetLastAcceptedArgs, ...rpc.Option) (Container, error)
	// Returns 1 less than the number of containers accepted on this chain
	GetIndex(context.Context, *GetIndexArgs, ...rpc.Option) (uint64, error)
	// Returns true if the given container is accepted
	IsAccepted(context.Context, *GetIndexArgs, ...rpc.Option) (bool, error)
	// Get a container by its index
	GetContainerByID(context.Context, *GetIndexArgs, ...rpc.Option) (Container, error)
}

Client interface for Avalanche Indexer API Endpoint

func NewClient

func NewClient(host, endpoint string) Client

NewClient creates a client that can interact with an index via HTTP API calls. [host] is the host to make API calls to (e.g. http://1.2.3.4:9650). [endpoint] is the path to the index endpoint (e.g. /ext/index/C/block or /ext/index/X/tx).

type Config

type Config struct {
	DB                                      database.Database
	Log                                     logging.Logger
	IndexingEnabled                         bool
	AllowIncompleteIndex                    bool
	DecisionDispatcher, ConsensusDispatcher *triggers.EventDispatcher
	APIServer                               server.PathAdder
	ShutdownF                               func()
}

Config for an indexer

type Container

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"`
}

Container is something that gets accepted (a block, transaction or vertex)

type FormattedContainer

type FormattedContainer struct {
	ID        ids.ID              `json:"id"`
	Bytes     string              `json:"bytes"`
	Timestamp time.Time           `json:"timestamp"`
	Encoding  formatting.Encoding `json:"encoding"`
	Index     json.Uint64         `json:"index"`
}

type GetContainer

type GetContainer struct {
	Index    json.Uint64         `json:"index"`
	Encoding formatting.Encoding `json:"encoding"`
}

type GetContainerRangeArgs

type GetContainerRangeArgs struct {
	StartIndex json.Uint64         `json:"startIndex"`
	NumToFetch json.Uint64         `json:"numToFetch"`
	Encoding   formatting.Encoding `json:"encoding"`
}

type GetContainerRangeResponse

type GetContainerRangeResponse struct {
	Containers []FormattedContainer `json:"containers"`
}

type GetIndexArgs

type GetIndexArgs struct {
	ContainerID ids.ID              `json:"containerID"`
	Encoding    formatting.Encoding `json:"encoding"`
}

type GetIndexResponse

type GetIndexResponse struct {
	Index json.Uint64 `json:"index"`
}

type GetLastAcceptedArgs

type GetLastAcceptedArgs struct {
	Encoding formatting.Encoding `json:"encoding"`
}

type Index

type Index interface {
	snow.Acceptor
	GetContainerByIndex(index uint64) (Container, error)
	GetContainerRange(startIndex uint64, numToFetch uint64) ([]Container, error)
	GetLastAccepted() (Container, error)
	GetIndex(containerID ids.ID) (uint64, error)
	GetContainerByID(containerID ids.ID) (Container, error)
	io.Closer
}

Index indexes containers in their order of acceptance Index is thread-safe. Index assumes that Accept is called before the container is committed to the database of the VM that the container exists in.

type Indexer

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

Indexer causes accepted containers for a given chain to be indexed by their ID and by the order in which they were accepted by this node. Indexer is threadsafe.

func NewIndexer

func NewIndexer(config Config) (Indexer, error)

NewIndexer returns a new Indexer and registers a new endpoint on the given API server.

type IsAcceptedResponse

type IsAcceptedResponse struct {
	IsAccepted bool `json:"isAccepted"`
}