scanner

type EventType int

type Report struct {
	// Transaction is the transaction that includes the item that was found.
	Transaction *transaction.Transaction

	// BlockHash is the block hash of the block that includes the transaction.
	BlockHash   *chainhash.Hash
	BlockHeight uint32

	// the request resolved by the report
	Request *ScanRequest
}

type ScanRequest struct {
	// ClientID of the client sending request
	ClientID uuid.UUID
	// StartHeight from which scan should be performed, nil means scan from genesis block
	StartHeight uint32
	// Item to watch
	Item WatchItem
	// IsPersistent if true, the request will be re-added with StartHeight = StartHeiht + 1
	IsPersistent bool
}

type ScanRequestOption func(req *ScanRequest)

type Service interface {
	// Start runs a go-routine in order to handle incoming requests via Watch
	Start() (<-chan Report, error)
	// Stop the scanner
	Stop()
	// Watch add a new request to the queue
	Watch(...ScanRequestOption)
	// WatchDescriptorWallet imports wallet descriptor, generates scripts and which
	//for specific events for those scripts
	WatchDescriptorWallet(
		requestID uuid.UUID,
		descriptor string,
		eventType []EventType,
		blockStart int,
	) error
}

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

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

type WatchItem interface {
	// Bytes returns the element search in the block filter
	Bytes() []byte
	// Match is used to check if a transaction matches the watch item
	Match(tx *transaction.Transaction) bool
	// EventType returns the type of event that will be reported by the scanner
	EventType() EventType
}