explorer

Documentation

Overview

Package explorer implements the blockchain explorer microservice. The explorer scans transactions in the networks mined blocks and sends events when a monitored address or account is involved in a transaction.

Index

• type Explorer
  • func New(dbtype string, db store.DB, mb msg.MsgBroker, bc map[string]block.Chain) *Explorer
  • func (e *Explorer) Explore() chan string
  • func (e *Explorer) ExploreChain(net string, ret chan string)
  • func (e *Explorer) ManageWalletRequests(net string) error
  • func (e *Explorer) StopExplorer()

Types

type Explorer

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

Explorer implements an explorer service.

func New

func New(dbtype string, db store.DB, mb msg.MsgBroker, bc map[string]block.Chain) *Explorer

New instantiates a new explorer service.

func (*Explorer) Explore

func (e *Explorer) Explore() chan string

Explore starts a go routine for each network available. The exploration of each network is controlled by a NetExplorer (see package explorer/netexplorer for details) and contains a map of the addresses being monitored and the current status of scanned blocks. The explorer consumes wallet requests to monitor new addresses. In case of graceful termination, the explorer will wait for all the blocks being scanned to finish and sending the events if any.

func (*Explorer) ExploreChain

func (e *Explorer) ExploreChain(net string, ret chan string)

ExploreChain starts a network explorer go routine for blockchain named 'net'. When the routine ends, returns its error status via the 'ret' channel given so the calling routine can control graceful termination. When a network does not have any monitored addresses, the explorer will keep waiting and will not scan any mined blocks.

func (*Explorer) ManageWalletRequests

func (e *Explorer) ManageWalletRequests(net string) error

ManageWalletRequests starts a go routine to receive and manage wallet requests for objects (addresses, ...) to be monitored for the blockchain named 'net'.

func (*Explorer) StopExplorer

func (e *Explorer) StopExplorer()

StopExplorer will send termination signals to all network explorer go routines.