ethreceipts

type FilterCond struct {
	TxnHash  *ethkit.Hash
	From     *ethkit.Address
	To       *ethkit.Address
	LogTopic *ethkit.Hash // event signature topic hash
	Logs     func([]*types.Log) bool
}

type FilterOptions struct {
	// ..
	ID uint64

	// ..
	Finalize bool

	// .
	LimitOne bool

	// ..
	SearchCache bool

	// QueryOnChainTxnHash will query the chain for the txn hash at the start
	// of a filter subscription. This is only useful when used in combination with
	// TxnHash filter cond, to search for past transactions which may have been
	// mined before the filter was created.
	QueryOnChainTxnHash bool

	// ..
	QueryOnChain func(context.Context) (*types.Receipt, error)

	// MaxWait filter option waits some number of blocks without a filter match after
	// which point will auto-unsubscribe the filter. This is useful to help automatically
	// remove filters which likely won't come up.
	//
	// nil : use the ReceiptsListener option FilterMaxWaitNumBlocks value as the default
	// -1  : set value to ReceiptsListener option NumFinality * 3
	// 0   : option is disabled, and has no limit on wait. filters need to be manually unsubscribed
	// N   : a specified number of blocks without a match before unsusbcribe
	MaxWait *int
}

type FilterQuery interface {
	ID(uint64) FilterQuery
	Finalize(bool) FilterQuery
	LimitOne(bool) FilterQuery
	SearchCache(bool) FilterQuery
	QueryOnChainTxnHash(bool) FilterQuery
	QueryOnChain(func(context.Context) (*types.Receipt, error)) FilterQuery
	MaxWait(int) FilterQuery

	// DEPRECATED: please use QueryOnChainTxnHash instead, which is the same thing, renamed to be more clear
	// in addition, see new QueryChain(fn) as additional feature.
	SearchOnChain(bool) FilterQuery
}

type Filterer interface {
	FilterQuery

	FilterID() uint64
	Options() FilterOptions
	Cond() FilterCond

	Match(ctx context.Context, receipt Receipt) (bool, error)
	StartBlockNum() uint64
	LastMatchBlockNum() uint64
	Exhausted() <-chan struct{}
}

type Options struct {
	// ..
	MaxConcurrentFetchReceiptWorkers int

	// ..
	MaxConcurrentFilterWorkers int

	// MaxConcurrentSearchOnChainWorkers is the maximum amount of concurrent
	// on-chain searches (this is per subscriber)
	MaxConcurrentSearchOnChainWorkers int

	// ..
	PastReceiptsCacheSize int

	// ..
	NumBlocksToFinality int

	// FilterMaxWaitNumBlocks is the maximum amount of blocks a filter will wait between getting
	// a receipt filter match, before the filter will unsubscribe itself and stop listening.
	// This value may be overriden by setting FilterCond#MaxListenNumBlocks on per-filter basis.
	//
	// NOTE:
	// * value of -1 will use NumBlocksToFinality*2
	// * value of 0 will set no limit, so filter will always listen [default]
	// * value of N will set the N number of blocks without results before unsubscribing between iterations
	FilterMaxWaitNumBlocks int

	// Alerter config via github.com/goware/alerter
	Alerter util.Alerter
}

type Receipt struct {
	Filter  Filterer // reference to filter which triggered this event
	Final   bool     // flags that this receipt is finalized
	Reorged bool     // chain reorged / removed the txn
	// contains filtered or unexported fields
}

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

type Subscription interface {
	TransactionReceipt() <-chan Receipt
	Done() <-chan struct{}
	Unsubscribe()

	Filters() []Filterer
	AddFilter(filters ...FilterQuery)
	RemoveFilter(filter Filterer)
	ClearFilters()
}

type WaitReceiptFinalityFunc func(ctx context.Context) (*Receipt, error)