crawler

Documentation

Index

• type AddressEvent
  • func (a AddressEvent) Type() EventType
• type AddressObservable
  • func (a *AddressObservable) Key() string
  • func (a *AddressObservable) Observe(explorerSvc explorer.Service, errChan chan error, eventChan chan Event)
• type CloseEvent
  • func (q CloseEvent) Type() EventType
• type Event
• type EventType
  • func (et EventType) String() string
• type Observable
  • func NewAddressObservable(address string, blindKey []byte, extraData interface{}) Observable
  • func NewOutpointsObservable(outpoints []Outpoint, extraData interface{}) Observable
  • func NewTransactionObservable(txid string, extraData interface{}) Observable
• type ObservableHandler
  • func NewObservableHandler(observable Observable, explorerSvc explorer.Service, wg *sync.WaitGroup, ...) *ObservableHandler
  • func (oh *ObservableHandler) Start()
  • func (oh ObservableHandler) Stop()
• type Opts
• type Outpoint
• type OutpointsEvent
  • func (o OutpointsEvent) Type() EventType
• type OutpointsObservable
  • func (o *OutpointsObservable) Key() string
  • func (o *OutpointsObservable) Observe(explorerSvc explorer.Service, errChan chan error, eventChan chan Event)
• type Service
  • func NewService(opts Opts) Service
• type TransactionEvent
  • func (t TransactionEvent) Type() EventType
• type TransactionObservable
  • func (t *TransactionObservable) Key() string
  • func (t *TransactionObservable) Observe(explorerSvc explorer.Service, errChan chan error, eventChan chan Event)

Types

type AddressEvent

type AddressEvent struct {
	EventType EventType
	Address   string
	ExtraData interface{}
	Utxos     []explorer.Utxo
}

func (AddressEvent) Type

func (a AddressEvent) Type() EventType

type AddressObservable

type AddressObservable struct {
	Address     string
	BlindingKey []byte
	ExtraData   interface{}
	// contains filtered or unexported fields
}

func (*AddressObservable) Key

func (a *AddressObservable) Key() string

func (*AddressObservable) Observe

func (a *AddressObservable) Observe(
	explorerSvc explorer.Service,
	errChan chan error,
	eventChan chan Event,
)

type CloseEvent

type CloseEvent struct{}

func (CloseEvent) Type

func (q CloseEvent) Type() EventType

type Event

type Event interface {
	Type() EventType
}

Event are emitted through a channel during observation.

type EventType

type EventType int

const (
	CloseSignal EventType = iota
	AddressUnspents
	TransactionConfirmed
	TransactionUnconfirmed
	OutpointsUnspent
	OutpointsSpentAndUnconfirmed
	OutpointsSpentAndConfirmed
)

func (EventType) String

func (et EventType) String() string

type Observable

type Observable interface {
	Observe(
		explorerSvc explorer.Service,
		errChan chan error,
		eventChan chan Event,
	)
	Key() string
}

Observable represent object that can be observe on the blockchain.

func NewAddressObservable

func NewAddressObservable(
	address string, blindKey []byte, extraData interface{},
) Observable

func NewOutpointsObservable

func NewOutpointsObservable(
	outpoints []Outpoint, extraData interface{},
) Observable

func NewTransactionObservable

func NewTransactionObservable(txid string, extraData interface{}) Observable

type ObservableHandler

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

func NewObservableHandler

func NewObservableHandler(
	observable Observable,
	explorerSvc explorer.Service,
	wg *sync.WaitGroup,
	interval time.Duration,
	eventChan chan Event,
	errChan chan error,
) *ObservableHandler

func (*ObservableHandler) Start

func (oh *ObservableHandler) Start()

func (ObservableHandler) Stop

func (oh ObservableHandler) Stop()

type Opts

type Opts struct {
	ExplorerSvc explorer.Service
	// Crawler interval in milliseconds
	CrawlerInterval time.Duration
	ErrorHandler    func(err error)
}

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

type Outpoint

type Outpoint interface {
	Hash() string
	Index() uint32
}

type OutpointsEvent

type OutpointsEvent struct {
	EventType EventType
	Outpoints []Outpoint
	ExtraData interface{}
	TxID      string
	TxHex     string
	BlockHash string
	BlockTime int
}

func (OutpointsEvent) Type

func (o OutpointsEvent) Type() EventType

type OutpointsObservable

type OutpointsObservable struct {
	Outpoints []Outpoint
	ExtraData interface{}
	// contains filtered or unexported fields
}

func (*OutpointsObservable) Key

func (o *OutpointsObservable) Key() string

func (*OutpointsObservable) Observe

func (o *OutpointsObservable) Observe(
	explorerSvc explorer.Service,
	errChan chan error,
	eventChan chan Event,
)

type Service

type Service interface {
	Start()
	Stop()
	AddObservable(observable Observable)
	RemoveObservable(observable Observable)
	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
	TxHex     string
	EventType EventType
	BlockHash string
	BlockTime int
	ExtraData interface{}
}

func (TransactionEvent) Type

func (t TransactionEvent) Type() EventType

type TransactionObservable

type TransactionObservable struct {
	TxID      string
	TxHex     string
	ExtraData interface{}
	// contains filtered or unexported fields
}

func (*TransactionObservable) Key

func (t *TransactionObservable) Key() string

func (*TransactionObservable) Observe

func (t *TransactionObservable) Observe(
	explorerSvc explorer.Service,
	errChan chan error,
	eventChan chan Event,
)