filter

README

Filter

This is a simple interface to filter based on channel id or (peer) pubkey. Currently just a whitelist of what to report is supported but it is easily extendible to blacklists too.

Documentation

Index

• type AllowAllFilter
  • func (f *AllowAllFilter) AllowChanID(id uint64) bool
  • func (f *AllowAllFilter) AllowPubKey(id string) bool
  • func (f *AllowAllFilter) AllowSpecial(private bool) bool
• type FileFilter
  • func (f *FileFilter) AllowChanID(id uint64) bool
  • func (f *FileFilter) AllowPubKey(id string) bool
  • func (f *FileFilter) AllowSpecial(private bool) bool
  • func (f *FileFilter) Reload() error
• type Filter
  • func (f *Filter) AllowChanID(id uint64) bool
  • func (f *Filter) AllowPubKey(id string) bool
  • func (f *Filter) AllowSpecial(private bool) bool
• type FilteringInterface
  • func NewAllowAllFilter() (FilteringInterface, error)
  • func NewFilterFromFile(ctx context.Context, filePath string, options Options) (FilteringInterface, error)
  • func NewUnitTestFilter() (FilteringInterface, error)
• type Options
• type UnitTestFilter
  • func (u *UnitTestFilter) AddAllowChanID(id uint64)
  • func (u *UnitTestFilter) AddAllowPubKey(id string)
  • func (u *UnitTestFilter) ChangeOptions(options Options)

Types

type AllowAllFilter

type AllowAllFilter struct {
	Filter
}

AllowAllFilter struct

func (*AllowAllFilter) AllowChanID

func (f *AllowAllFilter) AllowChanID(id uint64) bool

AllowChanID returns true if short channel ID should be allowed

func (*AllowAllFilter) AllowPubKey

func (f *AllowAllFilter) AllowPubKey(id string) bool

AllowPubKey returns true if pubkey should be allowed

func (*AllowAllFilter) AllowSpecial

func (f *AllowAllFilter) AllowSpecial(private bool) bool

AllowSpecial checks against bitmask and can allow all private or public channels

type FileFilter

type FileFilter struct {
	Filter
	WhitelistFilePath string
	Mutex             sync.Mutex
	DefaultOptions    Options
}

FileFilter struct

func (*FileFilter) AllowChanID

func (f *FileFilter) AllowChanID(id uint64) bool

AllowChanID checks short channel id

func (*FileFilter) AllowPubKey

func (f *FileFilter) AllowPubKey(id string) bool

AllowPubKey checks whether pubkey is allowed

func (*FileFilter) AllowSpecial

func (f *FileFilter) AllowSpecial(private bool) bool

AllowSpecial is used to allow all private/public chans

func (*FileFilter) Reload

func (f *FileFilter) Reload() error

Reload from file

type Filter

type Filter struct {
	// Options for the filter
	Options Options
	// contains filtered or unexported fields
}

Filter is the main type

func (*Filter) AllowChanID

func (f *Filter) AllowChanID(id uint64) bool

AllowChanID returns true if short channel ID should be allowed

func (*Filter) AllowPubKey

func (f *Filter) AllowPubKey(id string) bool

AllowPubKey returns true if pubkey should be allowed

func (*Filter) AllowSpecial

func (f *Filter) AllowSpecial(private bool) bool

AllowSpecial checks against bitmask and can allow all private or public channels

type FilteringInterface

type FilteringInterface interface {
	// AllowPubKey returns true if pubkey should be allowed
	AllowPubKey(id string) bool
	// AllowChanID returns true if short channel ID should be allowed
	AllowChanID(id uint64) bool
	// AllowSpecial checks against bitmask and can allow all private or public channels
	AllowSpecial(private bool) bool
}

FilteringInterface is the interface for all filters

func NewAllowAllFilter

func NewAllowAllFilter() (FilteringInterface, error)

NewAllowAllFilter - creates a filter that allow everything

func NewFilterFromFile

func NewFilterFromFile(ctx context.Context, filePath string, options Options) (FilteringInterface, error)

NewFilterFromFile create new FileFilter

func NewUnitTestFilter

func NewUnitTestFilter() (FilteringInterface, error)

NewUnitTestFilter - creates a filter suitable for unit tests

type Options

type Options uint8

Options bitmask for filter

const (
	// None - no options
	None Options = 1 << iota
	// AllowAllPrivate - allow all private channels
	AllowAllPrivate
	// AllowAllPublic - allow all public channels
	AllowAllPublic
)

type UnitTestFilter

type UnitTestFilter struct {
	Filter
}

UnitTestFilter struct

func (*UnitTestFilter) AddAllowChanID

func (u *UnitTestFilter) AddAllowChanID(id uint64)

AddAllowChanID - add channel id to allow list

func (*UnitTestFilter) AddAllowPubKey

func (u *UnitTestFilter) AddAllowPubKey(id string)

AddAllowPubKey - add pubkey to allow list

func (*UnitTestFilter) ChangeOptions

func (u *UnitTestFilter) ChangeOptions(options Options)

ChangeOptions - change options of the filter