channels

Documentation

Index

• Constants
• func AddChannelOrUpdateChannelStatus(db *sqlx.DB, channel Channel) (int, error)
• func CloseChannel(eventChannel chan interface{}, db *sqlx.DB, c *gin.Context, ...) (err error)
• func ConvertLNDShortChannelID(LNDShortChannelID uint64) string
• func ConvertShortChannelIDToLND(ShortChannelID string) (uint64, error)
• func CreateChannelPoint(fundingTransactionHash string, fundingOutputIndex int) string
• func GetClosureStatus(lndClosureType lnrpc.ChannelCloseSummary_ClosureType) commons.ChannelStatus
• func GetNodePeerAlias(localNodeId int, remoteNodeId int, db *sqlx.DB) (string, error)
• func InitializeManagedChannelCache(db *sqlx.DB) error
• func OpenChannel(db *sqlx.DB, eventChannel chan interface{}, req OpenChannelRequest, ...) (err error)
• func ParseChannelPoint(channelPoint string) (string, int)
• func RegisterChannelRoutes(r *gin.RouterGroup, db *sqlx.DB)
• func UpdateChannelStatus(db *sqlx.DB, channelId int, status commons.ChannelStatus) error
• type BatchOpenRequest
• type BatchOpenResponse
• type Channel
  • func GetAllChannels(db *sqlx.DB) (channels []Channel, err error)
  • func GetOpenChannelsForNodeId(db *sqlx.DB, nodeId int) (channels []Channel, err error)
• type ChannelPolicy
  • func GetLocalRoutingPolicy(chanId uint64, nodeId int, db *sqlx.DB) (ChannelPolicy, error)
  • func GetRemoteRoutingPolicy(chanId uint64, nodeId int, db *sqlx.DB) (ChannelPolicy, error)
• type CloseChannelRequest
• type CloseChannelResponse
• type OpenChannelRequest
• type OpenChannelResponse
• type OutPoint
• type PendingHtlcs
• type PsbtDetails

Constants

const (
	MEMPOOL string = "https://mempool.space/lightning/channel/"
	AMBOSS  string = "https://amboss.space/edge/"
	ONEML   string = "https://1ml.com/channel/"
)

Functions

func AddChannelOrUpdateChannelStatus

func AddChannelOrUpdateChannelStatus(db *sqlx.DB, channel Channel) (int, error)

func CloseChannel

func CloseChannel(eventChannel chan interface{}, db *sqlx.DB, c *gin.Context, ccReq CloseChannelRequest, reqId string) (err error)

func ConvertLNDShortChannelID

func ConvertLNDShortChannelID(LNDShortChannelID uint64) string

func ConvertShortChannelIDToLND

func ConvertShortChannelIDToLND(ShortChannelID string) (uint64, error)

func CreateChannelPoint

func CreateChannelPoint(fundingTransactionHash string, fundingOutputIndex int) string

func GetClosureStatus

func GetClosureStatus(lndClosureType lnrpc.ChannelCloseSummary_ClosureType) commons.ChannelStatus

GetClosureStatus returns Closing when our API is outdated and a new lnrpc.ChannelCloseSummary_ClosureType is added

func GetNodePeerAlias

func GetNodePeerAlias(localNodeId int, remoteNodeId int, db *sqlx.DB) (string, error)

func InitializeManagedChannelCache

func InitializeManagedChannelCache(db *sqlx.DB) error

func OpenChannel

func OpenChannel(db *sqlx.DB, eventChannel chan interface{}, req OpenChannelRequest, reqId string) (err error)

func ParseChannelPoint

func ParseChannelPoint(channelPoint string) (string, int)

func RegisterChannelRoutes

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

func UpdateChannelStatus

func UpdateChannelStatus(db *sqlx.DB, channelId int, status commons.ChannelStatus) error

Types

type BatchOpenRequest

type BatchOpenRequest struct {
	NodeId      int                `json:"nodeId"`
	Channels    []batchOpenChannel `json:"channels"`
	TargetConf  *int32             `json:"targetConf"`
	SatPerVbyte *int64             `json:"satPerVbyte"`
}

type BatchOpenResponse

type BatchOpenResponse struct {
	PendingChannels []pendingChannel `json:"pendingChannels"`
}

type Channel

type Channel struct {
	// ChannelID A database primary key. NOT a channel_id as specified in BOLT 2
	ChannelID int `json:"channelId" db:"channel_id"`
	// ShortChannelID In the c-lighting and BOLT format e.g. 505580:1917:1
	ShortChannelID         *string               `json:"shortChannelId" db:"short_channel_id"`
	FundingTransactionHash string                `json:"fundingTransactionHash" db:"funding_transaction_hash"`
	FundingOutputIndex     int                   `json:"fundingOutputIndex" db:"funding_output_index"`
	ClosingTransactionHash *string               `json:"closingTransactionHash" db:"closing_transaction_hash"`
	FirstNodeId            int                   `json:"firstNodeId" db:"first_node_id"`
	SecondNodeId           int                   `json:"secondNodeId" db:"second_node_id"`
	CreatedOn              time.Time             `json:"createdOn" db:"created_on"`
	UpdateOn               null.Time             `json:"updatedOn" db:"updated_on"`
	LNDShortChannelID      *uint64               `json:"lndShortChannelId" db:"lnd_short_channel_id"`
	Status                 commons.ChannelStatus `json:"status" db:"status_id"`
}

func GetAllChannels

func GetAllChannels(db *sqlx.DB) (channels []Channel, err error)

func GetOpenChannelsForNodeId

func GetOpenChannelsForNodeId(db *sqlx.DB, nodeId int) (channels []Channel, err error)

type ChannelPolicy

type ChannelPolicy struct {
	TimeLockDelta   uint32 `json:"timeLockDelta" db:"time_lock_delta"`
	MinHtlc         int64  `json:"minHtlc" db:"min_htlc"`
	MaxHtlcMsat     uint64 `json:"maxHtlcMsat" db:"max_htlc_msat"`
	FeeRateMillMsat int64  `json:"feeRateMillMsat" db:"fee_rate_mill_msat"`
	ShortChannelId  string `json:"shortChannelId" db:"short_channel_id"`
	FeeBaseMsat     int64  `json:"feeBaseMsat" db:"fee_base_msat"`
	NodeId          int    `json:"nodeId" db:"node_id"`
	RemoteNodeId    int    `json:"RemoteodeId" db:"remote_node_id"`
}

func GetLocalRoutingPolicy

func GetLocalRoutingPolicy(chanId uint64, nodeId int, db *sqlx.DB) (ChannelPolicy, error)

func GetRemoteRoutingPolicy

func GetRemoteRoutingPolicy(chanId uint64, nodeId int, db *sqlx.DB) (ChannelPolicy, error)

type CloseChannelRequest

type CloseChannelRequest struct {
	NodeId          int     `json:"nodeId"`
	ChannelPoint    string  `json:"channelPoint"`
	Force           *bool   `json:"force"`
	TargetConf      *int32  `json:"targetConf"`
	DeliveryAddress *string `json:"deliveryAddress"`
	SatPerVbyte     *uint64 `json:"satPerVbyte"`
}

type CloseChannelResponse

type CloseChannelResponse struct {
	ReqId        string             `json:"reqId"`
	Status       string             `json:"status"`
	ClosePending pendingUpdate      `json:"closePending"`
	ChanClose    channelCloseUpdate `json:"chanClose"`
}

type OpenChannelRequest

type OpenChannelRequest struct {
	NodeId             int     `json:"nodeId"`
	SatPerVbyte        *uint64 `json:"satPerVbyte"`
	NodePubKey         string  `json:"nodePubKey"`
	Host               *string `json:"host"`
	LocalFundingAmount int64   `json:"localFundingAmount"`
	PushSat            *int64  `json:"pushSat"`
	TargetConf         *int32  `json:"targetConf"`
	Private            *bool   `json:"private"`
	MinHtlcMsat        *int64  `json:"minHtlcMsat"`
	RemoteCsvDelay     *uint32 `json:"remoteCsvDelay"`
	MinConfs           *int32  `json:"minConfs"`
	SpendUnconfirmed   *bool   `json:"spendUnconfirmed"`
	CloseAddress       *string `json:"closeAddress"`
}

type OpenChannelResponse

type OpenChannelResponse struct {
	ReqId               string `json:"reqId"`
	Status              string `json:"status"`
	ChannelPoint        string `json:"channelPoint,omitempty"`
	PendingChannelPoint string `json:"pendingChannelPoint,omitempty"`
}

type OutPoint

type OutPoint struct {
	Txid        string `json:"txId"`
	OutputIndex uint32 `json:"outputIndex"`
}

type PendingHtlcs

type PendingHtlcs struct {
	ForwardingCount  int   `json:"forwardingCount"`
	ForwardingAmount int64 `json:"forwardingAmount"`
	LocalCount       int   `json:"localCount"`
	LocalAmount      int64 `json:"localAmount"`
	TotalCount       int   `json:"toalCount"`
	TotalAmount      int64 `json:"totalAmount"`
}

type PsbtDetails

type PsbtDetails struct {
	FundingAddress string `json:"funding_address,omitempty"`
	FundingAmount  int64  `json:"funding_amount,omitempty"`
	Psbt           []byte `json:"psbt,omitempty"`
}