entities

type ChannelBalance struct {
	// Active - is channel active
	Active bool `json:"active"`
	// Private - is channel private
	Private bool `json:"private"`
	// Deprecated - ActivePrevious is whether channel was Active in previous run
	ActivePrevious bool `json:"active_previous"`

	// LocalPubkey is the local node pubkey
	LocalPubkey string `json:"local_pubkey"`
	// RemotePubkey is the remote node pubkey
	RemotePubkey string `json:"remote_pubkey"`
	// ChanID - short channel id
	ChanID uint64 `json:"chan_id"`
	// Capacity - capacity of channel in satoshis
	Capacity uint64 `json:"capacity"`

	// RemoteNominator - is the remote side nominator
	RemoteNominator uint64 `json:"remote_nominator"`
	// LocalNominator - is the local side nominator
	LocalNominator uint64 `json:"local_nominator"`
	// Denominator - is the denominator (with high entropy allowed this is more or less channnel capacity)
	Denominator uint64 `json:"denominator"`

	// Deprecated - RemoteNominatorDiff is the difference of RemoteNominator between now and previous run
	RemoteNominatorDiff int64 `json:"remote_nominator_diff"`
	// Deprecated - LocalNominatorDiff is the difference of LocalNominator between now and previous run
	LocalNominatorDiff int64 `json:"local_nominator_diff"`
	// Deprecated - DenominatorDiff is the difference of Denominator between now and previous run
	DenominatorDiff int64 `json:"denominator_diff"`

	// ActiveRemote - does other node specify channel as active
	ActiveRemote bool `json:"active_remote"`
	// Deprecated - ActiveRemotePrevious - ActiveRemote from previous run
	ActiveRemotePrevious bool `json:"active_remote_previous"`
	// ActiveLocal - does current node specify channel as active
	ActiveLocal bool `json:"active_local"`
	// Deprecated - ActiveLocalPrevious - ActiveLocal from previous run
	ActiveLocalPrevious bool `json:"active_local_previous"`
}

type ClosedChannel struct {
	ChannelID uint64 `json:"channel_id"`
}

type InfoCallback func(ctx context.Context, report *InfoReport) bool

type InfoReport struct {
	UniqueID  string            `json:"uniqueId,omitempty"` // optional unique identifier
	Timestamp entities.JsonTime `json:"timestamp"`

	api.NodeInfoAPIExtended
}

type Interval int

type Invalidatable interface {
	Invalidate() error
}

type MessageCallback func(PluginMessage) error

type NodeDataReport struct {
	ReportingSettings
	// Chain - should be bitcoin (bitcoin, litecoin)
	Chain string `json:"chain"`
	// Network - should be mainnet (regtest, testnet, mainnet)
	Network string `json:"network"`
	// Pubkey - node pubkey
	PubKey string `json:"pubkey"`
	// UniqueID is the optional unique identifier
	UniqueID string `json:"uniqueId,omitempty"`
	// Timestamp - timestamp of report
	Timestamp entities.JsonTime `json:"timestamp"`
	// ChangedChannels - contains all channels were balance has changed
	ChangedChannels []ChannelBalance `json:"changed_channels"`
	// ClosedChannels - contains all channels that were determined to be closed
	ClosedChannels []ClosedChannel `json:"closed_channels"`
	// Node Details
	NodeDetails *NodeDetails `json:"node_details,omitempty"`
}

type NodeDataReportCallback func(ctx context.Context, report *NodeDataReport) bool

type NodeDetails struct {
	NodeVersion               string `json:"node_version"`
	IsSyncedToChain           bool   `json:"is_synced_to_chain"`
	IsSyncedToGraph           bool   `json:"is_synced_to_graph"`
	AgentVersion              string `json:"agent_version"`                          // will be filled before sending
	OnChainBalanceNotReported bool   `json:"onchain_balance_not_reported,omitempty"` // or else we cannot distinguish 0 and disallowed to report
	OnChainBalanceConfirmed   uint64 `json:"onchain_balance_confirmed"`
	OnChainBalanceTotal       uint64 `json:"onchain_balance_total"`

	api.NodeInfoAPIExtended
}

type NodeIdentifier struct {
	Identifier string `json:"identifier"`
	UniqueID   string `json:"unique_id"`
}

type Plugin interface {
	// Execute can be called multiple times for the same job
	// It's plugin responsibility to check if the job is already running and ignore such requests
	Execute(jobID int64, data []byte, msgCallback MessageCallback) error
}

type PluginCommon struct {
	PluginName string
}

type PluginMessage struct {
	JobID      int64
	Message    string
	Data       []byte
	IsError    bool
	IsFinished bool
}

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

type ReportingSettings struct {
	// GraphPollInterval - interval for graph polling
	GraphPollInterval time.Duration `json:"-"`
	// NoopInterval - send keepalive also when no changes happened
	NoopInterval time.Duration `json:"-"`
	// Filter is used to filter specific channels
	Filter filter.FilteringInterface `json:"-"`
	// PollInterval - defines how often the polling happens
	PollInterval Interval `json:"poll_interval"`
	// AllowedEntropy - is user specified entropy that can be reported
	AllowedEntropy int `json:"allowed_entropy"` // 64 bits is the default
	// AllowPrivateChannels - whether private channels were allowed (fitering will set this to true too)
	AllowPrivateChannels bool `json:"allow_private_channels"` // default is false
	// NotSyncedToChainCoolDown - how long to wait before reporting node as not synced to chain
	NotSyncedToChainCoolDown time.Duration `json:"-"`
}