crawler

Documentation

Index

• type AddressEvent
  • func (a AddressEvent) Type() EventType
• type AddressObservable
• type Event
• type EventType
  • func (et EventType) String() string
• type Observable
• type Opts
• type Service
  • func NewService(opts Opts) Service
• type TransactionEvent
  • func (t TransactionEvent) Type() EventType
• type TransactionObservable

Types

type AddressEvent

type AddressEvent struct {
	EventType    EventType
	AccountIndex int
	Address      string
	Utxos        []explorer.Utxo
}

func (AddressEvent) Type

func (a AddressEvent) Type() EventType

type AddressObservable

type AddressObservable struct {
	AccountIndex int
	Address      string
	BlindingKey  []byte
}

type Event

type Event interface {
	Type() EventType
}

Event are emitted through a channel during observation.

type EventType

type EventType int

const (
	FeeAccountDeposit EventType = iota
	MarketAccountDeposit
	TransactionConfirmed
	TransactionUnConfirmed
)

func (EventType) String

func (et EventType) String() string

type Observable

type Observable interface {
	// contains filtered or unexported methods
}

Observable represent object that can be observe on the blockchain.

type Opts

type Opts struct {
	ExplorerSvc            explorer.Service
	IntervalInMilliseconds int
	Observables            []Observable
	ErrorHandler           func(err error)
}

Opts defines the parameters needed for creating a crawler service with NewService method

type Service

type Service interface {
	Start()
	Stop()
	AddObservable(observable Observable)
	RemoveObservable(observable Observable)
	IsObservingAddresses(addresses []string) bool
	GetEventChannel() chan Event
}

Service is the interface for Crawler

func NewService

func NewService(opts Opts) Service

NewService returns an utxoCrawelr that is ready for watch for blockchain activites. Use Start and Stop methods to manage it.

type TransactionEvent

type TransactionEvent struct {
	TxID      string
	EventType EventType
	BlockHash string
	BlockTime float64
}

func (TransactionEvent) Type

func (t TransactionEvent) Type() EventType

type TransactionObservable

type TransactionObservable struct {
	TxID string
}