indexer

Documentation

Overview

Package indexer is a generated GoMock package.

Index

• type GenesisBlockData
• type MockParser
  • func NewMockParser(ctrl *gomock.Controller) *MockParser
  • func (m *MockParser) EXPECT() *MockParserMockRecorder
  • func (m *MockParser) GetGenesisBlock(arg0 context.Context) (*ParsedGenesisBlock, error)
  • func (m *MockParser) GetPlatformHeight(arg0 context.Context) (uint64, error)
  • func (m *MockParser) ParseCurrentBlock(arg0 context.Context) (*ParsedBlock, error)
  • func (m *MockParser) ParseNonGenesisBlock(arg0 context.Context, arg1 string, arg2 uint64) (*ParsedBlock, error)
• type MockParserMockRecorder
  • func (mr *MockParserMockRecorder) GetGenesisBlock(arg0 any) *gomock.Call
  • func (mr *MockParserMockRecorder) GetPlatformHeight(arg0 any) *gomock.Call
  • func (mr *MockParserMockRecorder) ParseCurrentBlock(arg0 any) *gomock.Call
  • func (mr *MockParserMockRecorder) ParseNonGenesisBlock(arg0, arg1, arg2 any) *gomock.Call
• type ParsedBlock
• type ParsedGenesisBlock
• type Parser
  • func NewParser(pChainClient client.PChainClient, avalancheNetworkID uint32) (Parser, error)

Types

type GenesisBlockData

type GenesisBlockData struct {
	Message       string          `json:"message"`
	InitialSupply uint64          `json:"initialSupply"`
	UTXOs         []*genesis.UTXO `json:"utxos"`
}

GenesisBlockData contains Genesis state details

type MockParser

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

MockParser is a mock of Parser interface.

func NewMockParser

func NewMockParser(ctrl *gomock.Controller) *MockParser

NewMockParser creates a new mock instance.

func (*MockParser) EXPECT

func (m *MockParser) EXPECT() *MockParserMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockParser) GetGenesisBlock

func (m *MockParser) GetGenesisBlock(arg0 context.Context) (*ParsedGenesisBlock, error)

GetGenesisBlock mocks base method.

func (*MockParser) GetPlatformHeight

func (m *MockParser) GetPlatformHeight(arg0 context.Context) (uint64, error)

GetPlatformHeight mocks base method.

func (*MockParser) ParseCurrentBlock

func (m *MockParser) ParseCurrentBlock(arg0 context.Context) (*ParsedBlock, error)

ParseCurrentBlock mocks base method.

func (*MockParser) ParseNonGenesisBlock

func (m *MockParser) ParseNonGenesisBlock(arg0 context.Context, arg1 string, arg2 uint64) (*ParsedBlock, error)

ParseNonGenesisBlock mocks base method.

type MockParserMockRecorder

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

MockParserMockRecorder is the mock recorder for MockParser.

func (*MockParserMockRecorder) GetGenesisBlock

func (mr *MockParserMockRecorder) GetGenesisBlock(arg0 any) *gomock.Call

GetGenesisBlock indicates an expected call of GetGenesisBlock.

func (*MockParserMockRecorder) GetPlatformHeight

func (mr *MockParserMockRecorder) GetPlatformHeight(arg0 any) *gomock.Call

GetPlatformHeight indicates an expected call of GetPlatformHeight.

func (*MockParserMockRecorder) ParseCurrentBlock

func (mr *MockParserMockRecorder) ParseCurrentBlock(arg0 any) *gomock.Call

ParseCurrentBlock indicates an expected call of ParseCurrentBlock.

func (*MockParserMockRecorder) ParseNonGenesisBlock

func (mr *MockParserMockRecorder) ParseNonGenesisBlock(arg0, arg1, arg2 any) *gomock.Call

ParseNonGenesisBlock indicates an expected call of ParseNonGenesisBlock.

type ParsedBlock

type ParsedBlock struct {
	BlockID   ids.ID    `json:"id"`
	BlockType string    `json:"type"`
	ParentID  ids.ID    `json:"parent"`
	Timestamp int64     `json:"timestamp"`
	Height    uint64    `json:"height"`
	Txs       []*txs.Tx `json:"transactions"`
}

ParsedBlock contains block details parsed from indexer containers

type ParsedGenesisBlock

type ParsedGenesisBlock struct {
	ParsedBlock
	GenesisBlockData `json:"data"`
}

ParsedGenesisBlock contains Genesis state details

type Parser

type Parser interface {
	// GetGenesisBlock parses and returns the Genesis block
	GetGenesisBlock(ctx context.Context) (*ParsedGenesisBlock, error)
	// ParseNonGenesisBlock returns the block with provided hash or height
	ParseNonGenesisBlock(ctx context.Context, hash string, height uint64) (*ParsedBlock, error)
	// GetPlatformHeight returns the current block height of P-chain
	GetPlatformHeight(ctx context.Context) (uint64, error)
	// ParseCurrentBlock parses and returns the current tip of P-chain
	ParseCurrentBlock(ctx context.Context) (*ParsedBlock, error)
}

Parser defines the interface for a P-chain indexer parser Note: we use indexer just because platformVM does not currently offer a way to retrieve blocks by height. However we do NOT want to use the indexer to retrieve blocks by ID; instead we'll use platformvm.GetBlock api for that. The reason is that we want to use platformVM-level block ID as P-chain blocks identifier rather than proposerVM-level.

func NewParser

func NewParser(pChainClient client.PChainClient, avalancheNetworkID uint32) (Parser, error)

NewParser creates a new P-chain indexer parser Note: NewParser should not contain calls to pChainClient as we cannot assume client is ready to serve requests immediately