listener

Documentation

Index

• Constants
• type BaseListener
  • func NewBaseListener(cdc *codec.Codec, queueConnector *queue.QueueConnector, ...) *BaseListener
  • func (bl *BaseListener) StartHeaderProcess(ctx context.Context)
  • func (bl *BaseListener) StartPolling(ctx context.Context, pollInterval time.Duration)
  • func (bl *BaseListener) StartSubscription(ctx context.Context, subscription ethereum.Subscription)
  • func (bl *BaseListener) Stop()
  • func (bl *BaseListener) String() string
• type HeimdallListener
  • func NewHeimdallListener() *HeimdallListener
  • func (hl *HeimdallListener) ProcessBlockEvent(event sdk.StringEvent, blockHeight int64)
  • func (hl *HeimdallListener) ProcessHeader(*types.Header)
  • func (hl *HeimdallListener) Start() error
  • func (hl *HeimdallListener) StartPolling(ctx context.Context, pollInterval time.Duration)
• type Listener
• type ListenerService
  • func NewListenerService(cdc *codec.Codec, queueConnector *queue.QueueConnector, ...) *ListenerService
  • func (listenerService *ListenerService) OnStart() error
  • func (listenerService *ListenerService) OnStop()
• type MaticChainListener
  • func NewMaticChainListener() *MaticChainListener
  • func (ml *MaticChainListener) ProcessHeader(newHeader *types.Header)
  • func (ml *MaticChainListener) Start() error
• type RootChainListener
  • func NewRootChainListener() *RootChainListener
  • func (rl *RootChainListener) ProcessHeader(newHeader *types.Header)
  • func (rl *RootChainListener) Start() error
• type RootChainListenerContext

Constants

const (
	ListenerServiceStr = "listener"

	RootChainListenerStr  = "rootchain"
	HeimdallListenerStr   = "heimdall"
	MaticChainListenerStr = "maticchain"
)

Types

type BaseListener

type BaseListener struct {
	Logger log.Logger

	// header channel
	HeaderChannel chan *types.Header
	// contains filtered or unexported fields
}

func NewBaseListener

func NewBaseListener(cdc *codec.Codec, queueConnector *queue.QueueConnector, httpClient *httpClient.HTTP, chainClient *ethclient.Client, name string, impl Listener) *BaseListener

NewBaseListener creates a new BaseListener.

func (*BaseListener) StartHeaderProcess

func (bl *BaseListener) StartHeaderProcess(ctx context.Context)

startHeaderProcess starts header process when they get new header

func (*BaseListener) StartPolling

func (bl *BaseListener) StartPolling(ctx context.Context, pollInterval time.Duration)

startPolling starts polling

func (*BaseListener) StartSubscription

func (bl *BaseListener) StartSubscription(ctx context.Context, subscription ethereum.Subscription)

func (*BaseListener) Stop

func (bl *BaseListener) Stop()

OnStop stops all necessary go routines

func (*BaseListener) String

func (bl *BaseListener) String() string

String implements Service by returning a string representation of the service.

type HeimdallListener

type HeimdallListener struct {
	BaseListener
}

HeimdallListener - Listens to and process events from heimdall

func NewHeimdallListener

func NewHeimdallListener() *HeimdallListener

NewHeimdallListener - constructor func

func (*HeimdallListener) ProcessBlockEvent

func (hl *HeimdallListener) ProcessBlockEvent(event sdk.StringEvent, blockHeight int64)

ProcessBlockEvent - process Blockevents (BeginBlock, EndBlock events) from heimdall.

func (*HeimdallListener) ProcessHeader

func (hl *HeimdallListener) ProcessHeader(*types.Header)

ProcessHeader -

func (*HeimdallListener) Start

func (hl *HeimdallListener) Start() error

Start starts new block subscription

func (*HeimdallListener) StartPolling

func (hl *HeimdallListener) StartPolling(ctx context.Context, pollInterval time.Duration)

StartPolling - starts polling for heimdall events

type Listener

type Listener interface {
	Start() error

	StartHeaderProcess(context.Context)

	StartPolling(context.Context, time.Duration)

	StartSubscription(context.Context, ethereum.Subscription)

	ProcessHeader(*types.Header)

	Stop()

	String() string
}

Listener defines a block header listerner for Rootchain, Maticchain, Heimdall

type ListenerService

type ListenerService struct {
	// Base service
	common.BaseService
	// contains filtered or unexported fields
}

ListenerService starts and stops all chain event listeners

func NewListenerService

func NewListenerService(cdc *codec.Codec, queueConnector *queue.QueueConnector, httpClient *httpClient.HTTP) *ListenerService

NewListenerService returns new service object for listneing to events

func (*ListenerService) OnStart

func (listenerService *ListenerService) OnStart() error

OnStart starts new block subscription

func (*ListenerService) OnStop

func (listenerService *ListenerService) OnStop()

OnStop stops all necessary go routines

type MaticChainListener

type MaticChainListener struct {
	BaseListener
}

MaticChainListener - Listens to and process headerblocks from maticchain

func NewMaticChainListener

func NewMaticChainListener() *MaticChainListener

NewMaticChainListener - constructor func

func (*MaticChainListener) ProcessHeader

func (ml *MaticChainListener) ProcessHeader(newHeader *types.Header)

ProcessHeader - process headerblock from maticchain

func (*MaticChainListener) Start

func (ml *MaticChainListener) Start() error

Start starts new block subscription

type RootChainListener

type RootChainListener struct {
	BaseListener
	// contains filtered or unexported fields
}

RootChainListener - Listens to and process events from rootchain

func NewRootChainListener

func NewRootChainListener() *RootChainListener

NewRootChainListener - constructor func

func (*RootChainListener) ProcessHeader

func (rl *RootChainListener) ProcessHeader(newHeader *types.Header)

ProcessHeader - process headerblock from rootchain

func (*RootChainListener) Start

func (rl *RootChainListener) Start() error

Start starts new block subscription

type RootChainListenerContext

type RootChainListenerContext struct {
	ChainmanagerParams *chainmanagerTypes.Params
}

RootChainListenerContext root chain listener context