indexservice

Documentation

Index

• Variables
• type BlockByIndex
• type IndexHistory
• type Indexer
  • func (idx *Indexer) BuildIndex(blk *block.Block) error
  • func (idx *Indexer) CreateTablesIfNotExist() error
  • func (idx *Indexer) GetBlockByIndex(indexIdentifier string, indexHash hash.Hash256) (hash.Hash256, error)
  • func (idx *Indexer) GetIndexHistory(indexIdentifier string, userAddr string) ([]hash.Hash256, error)
  • func (idx *Indexer) HandleBlock(blk *block.Block) error
  • func (idx *Indexer) UpdateBlockByIndex(blk *block.Block, tx *sql.Tx, indexIdentifier string, indexHash hash.Hash256, ...) error
  • func (idx *Indexer) UpdateIndexHistory(blk *block.Block, tx *sql.Tx, indexIdentifier string, userAddr string, ...) error
• type Server
  • func NewServer(cfg config.Config, bc blockchain.Blockchain) *Server
  • func (s *Server) Indexer() *Indexer
  • func (s *Server) Start(ctx context.Context) error
  • func (s *Server) Stop(ctx context.Context) error

Variables

var (
	// ErrNotExist indicates certain item does not exist in Blockchain database
	ErrNotExist = errors.New("not exist in DB")
	// ErrAlreadyExist indicates certain item already exists in Blockchain database
	ErrAlreadyExist = errors.New("already exist in DB")
)

Types

type BlockByIndex

type BlockByIndex struct {
	NodeAddress string
	IndexHash   []byte
	BlockHash   []byte
}

BlockByIndex defines the base schema of "index to block" table

type IndexHistory

type IndexHistory struct {
	NodeAddress string
	UserAddress string
	IndexHash   string
}

IndexHistory defines the schema of "index history" table

type Indexer

type Indexer struct {
	// contains filtered or unexported fields
}

Indexer handles the index build for blocks

func (*Indexer) BuildIndex

func (idx *Indexer) BuildIndex(blk *block.Block) error

BuildIndex builds the index for a block

func (*Indexer) CreateTablesIfNotExist

func (idx *Indexer) CreateTablesIfNotExist() error

CreateTablesIfNotExist creates tables in local database

func (*Indexer) GetBlockByIndex

func (idx *Indexer) GetBlockByIndex(indexIdentifier string, indexHash hash.Hash256) (hash.Hash256, error)

GetBlockByIndex returns block hash by index hash

func (*Indexer) GetIndexHistory

func (idx *Indexer) GetIndexHistory(indexIdentifier string, userAddr string) ([]hash.Hash256, error)

GetIndexHistory gets index history

func (*Indexer) HandleBlock

func (idx *Indexer) HandleBlock(blk *block.Block) error

HandleBlock is an implementation of interface BlockCreationSubscriber

func (*Indexer) UpdateBlockByIndex

func (idx *Indexer) UpdateBlockByIndex(blk *block.Block, tx *sql.Tx, indexIdentifier string, indexHash hash.Hash256,
	blockHash hash.Hash256) error

UpdateBlockByIndex maps index hash to block hash

func (*Indexer) UpdateIndexHistory

func (idx *Indexer) UpdateIndexHistory(blk *block.Block, tx *sql.Tx, indexIdentifier string, userAddr string,
	indexHash hash.Hash256) error

UpdateIndexHistory stores index information into index history table

type Server

type Server struct {
	// contains filtered or unexported fields
}

Server is the container of the index service

func NewServer

func NewServer(
	cfg config.Config,
	bc blockchain.Blockchain,
) *Server

NewServer instantiates an index service

func (*Server) Indexer

func (s *Server) Indexer() *Indexer

Indexer return indexer interface

func (*Server) Start

func (s *Server) Start(ctx context.Context) error

Start starts the explorer server

func (*Server) Stop

func (s *Server) Stop(ctx context.Context) error

Stop stops the explorer server