channel_history

Documentation

Index

• Constants
• func RegisterChannelHistoryRoutes(r *gin.RouterGroup, db *sqlx.DB)
• type Balance
• type ChannelBalance
• type ChannelBalanceHistory
• type ChannelEvent
• type ChannelEventHistory
• type ChannelHistory
• type ChannelHistoryRecords
• type ChannelOnChainCost
• type ChannelReBalancing
• type RebalancingDetails

Constants

const (
	FROM_ERROR = "Invalid 'from' date."
	TO_ERROR   = "Invalid 'to' date."
)

Functions

func RegisterChannelHistoryRoutes

func RegisterChannelHistoryRoutes(r *gin.RouterGroup, db *sqlx.DB)

Types

type Balance

type Balance struct {
	Date             time.Time `db:"date" json:"date"`
	InboundCapacity  int64     `db:"inbound_capacity" json:"inboundCapacity"`
	OutboundCapacity int64     `db:"outbound_capacity" json:"outboundCapacity"`
	CapacityDiff     *int64    `db:"capacity_diff" json:"capacityDiff"`
}

type ChannelBalance

type ChannelBalance struct {
	LNDShortChannelId string     `json:"lndShortChannelId"`
	Balances          []*Balance `json:"balances"`
}

type ChannelBalanceHistory

type ChannelBalanceHistory struct {
	// Channel balances over time
	ChannelBalances []*ChannelBalance `json:"channelBalances"`
}

type ChannelEvent

type ChannelEvent struct {
	// The date used by the chart library to place roughly in the timeline. Usually bucketed pr day
	Date time.Time `json:"date"`
	// Specific time the event happened.
	Datetime  time.Time `json:"datetime"`
	ChannelId int       `json:"channelId"`
	// The type of event. E.g. disable/enable, change in fee rate, base fee, min/max htlc amount
	Type *string `json:"type"`
	// Was this changed by our node (outbound) or their node (inbound)
	Outbound *bool `json:"outbound"`
	// The value, in cases where there is a value change,
	//like with fee rate etc. Not used by disable/enable and channel open/close
	Value *uint64 `json:"value"`
	// The previous value
	PreviousValue *uint64 `json:"previousValue"`
}

type ChannelEventHistory

type ChannelEventHistory struct {
	Events []*ChannelEvent `json:"events"`
}

type ChannelHistory

type ChannelHistory struct {
	// The Label of the requested channels group,
	// this is either an alias in the case where a single channel or a single node is requested.
	// In the case where a group of channels is requested the Label will be based on the common name,
	// such as a tag.
	Label string `json:"label"`

	// The  outbound amount in sats (Satoshis)
	AmountOut *uint64 `json:"amountOut"`
	// The inbound amount in sats (Satoshis)
	AmountIn *uint64 `json:"amountIn"`
	// The total amount in sats (Satoshis) forwarded
	AmountTotal *uint64 `json:"amountTotal"`

	// The outbound revenue in sats. This is what the channel has directly produced.
	RevenueOut *uint64 `json:"revenueOut"`
	// The inbound revenue in sats. This is what the channel has indirectly produced.
	// This revenue are not really earned by this channel/peer/group, but represents
	// the channel/peer/group contribution to revenue earned by other channels.
	RevenueIn *uint64 `json:"revenueIn"`
	// The total revenue in sats. This is what the channel has directly and indirectly produced.
	RevenueTotal *uint64 `json:"revenueTotal"`

	// Number of outbound forwards.
	CountOut *uint64 `json:"countOut"`
	// Number of inbound forwards.
	CountIn *uint64 `json:"countIn"`
	// Number of total forwards.
	CountTotal *uint64 `json:"countTotal"`

	// A list of channels included in this response
	Channels []*channels.Channel      `json:"channels"`
	History  []*ChannelHistoryRecords `json:"history"`
}

type ChannelHistoryRecords

type ChannelHistoryRecords struct {
	Alias string `json:"alias"`

	Date time.Time `json:"date"`
	// The  outbound amount in sats (Satoshis)
	AmountOut *uint64 `json:"amountOut"`
	// The inbound amount in sats (Satoshis)
	AmountIn *uint64 `json:"amountIn"`
	// The total amount in sats (Satoshis) forwarded
	AmountTotal *uint64 `json:"amountTotal"`

	// The outbound revenue in sats. This is what the channel has directly produced.
	RevenueOut *uint64 `json:"revenueOut"`
	// The inbound revenue in sats. This is what the channel has indirectly produced.
	// This revenue are not really earned by this channel/peer/group, but represents
	// the channel/peer/group contribution to revenue earned by other channels.
	RevenueIn *uint64 `json:"revenueIn"`
	// The total revenue in sats. This is what the channel has directly and indirectly produced.
	RevenueTotal *uint64 `json:"revenueTotal"`

	// Number of outbound forwards.
	CountOut *uint64 `json:"countOut"`
	// Number of inbound forwards.
	CountIn *uint64 `json:"countIn"`
	// Number of total forwards.
	CountTotal *uint64 `json:"countTotal"`
}

type ChannelOnChainCost

type ChannelOnChainCost struct {
	OnChainCost *uint64 `json:"onChainCost"`
}

type ChannelReBalancing

type ChannelReBalancing struct {
	RebalancingCost *uint64 `json:"rebalancingCost"`
	// Aggregated details about successful rebalancing (i.g. amount, cost, counts)
	RebalancingDetails RebalancingDetails `json:"rebalancingDetails"`
}

type RebalancingDetails

type RebalancingDetails struct {
	AmountMsat    uint64 `db:"amount_msat" json:"amountMsat"`
	TotalCostMsat uint64 `db:"total_cost_msat" json:"totalCostMsat"`
	SplitCostMsat uint64 `db:"split_cost_msat" json:"splitCostMsat"`
	Count         uint64 `db:"count" json:"count"`
}