dataformat

Documentation

Index

• func FundingTXID(chanPoint string) string
• func FundingTXIndex(chanPoint string) uint32
• type BasePoint
  • func (b *BasePoint) Desc() (*keychain.KeyDescriptor, error)
• type ChannelDBFile
  • func (c *ChannelDBFile) AsSummaryEntries() ([]*SummaryEntry, error)
• type ClosingTX
• type ForceClose
• type Input
• type InputFile
• type ListChannelsChannel
  • func (c *ListChannelsChannel) AsSummaryEntry() *SummaryEntry
• type ListChannelsFile
  • func (f *ListChannelsFile) AsSummaryEntries() ([]*SummaryEntry, error)
• type NumberString
  • func (n *NumberString) UnmarshalJSON(b []byte) error
• type Out
• type PendingChannelsChannel
  • func (c *PendingChannelsChannel) AsSummaryEntry() *SummaryEntry
• type PendingChannelsFile
  • func (f *PendingChannelsFile) AsSummaryEntries() ([]*SummaryEntry, error)
• type SummaryEntry
• type SummaryEntryFile
  • func (f *SummaryEntryFile) AsSummaryEntries() ([]*SummaryEntry, error)

Functions

func FundingTXID

func FundingTXID(chanPoint string) string

func FundingTXIndex

func FundingTXIndex(chanPoint string) uint32

Types

type BasePoint

type BasePoint struct {
	Family uint16 `json:"family,omitempty"`
	Index  uint32 `json:"index,omitempty"`
	PubKey string `json:"pubkey"`
}

func (*BasePoint) Desc

func (b *BasePoint) Desc() (*keychain.KeyDescriptor, error)

type ChannelDBFile

type ChannelDBFile struct {
	DB *channeldb.ChannelStateDB
}

func (*ChannelDBFile) AsSummaryEntries

func (c *ChannelDBFile) AsSummaryEntries() ([]*SummaryEntry, error)

type ClosingTX

type ClosingTX struct {
	TXID         string `json:"txid"`
	ForceClose   bool   `json:"force_close"`
	AllOutsSpent bool   `json:"all_outputs_spent"`
	OurAddr      string `json:"our_addr"`
	ToRemoteAddr string `json:"to_remote_addr"`
	SweepPrivkey string `json:"sweep_privkey"`
	ConfHeight   uint32 `json:"conf_height"`
}

type ForceClose

type ForceClose struct {
	TXID                string     `json:"txid"`
	Serialized          string     `json:"serialized"`
	CSVDelay            uint16     `json:"csv_delay"`
	DelayBasePoint      *BasePoint `json:"delay_basepoint"`
	RevocationBasePoint *BasePoint `json:"revocation_basepoint"`
	CommitPoint         string     `json:"commit_point"`
	Outs                []*Out     `json:"outs"`
}

type Input

type Input interface {
	AsSummaryEntry() *SummaryEntry
}

type InputFile

type InputFile interface {
	AsSummaryEntries() ([]*SummaryEntry, error)
}

type ListChannelsChannel

type ListChannelsChannel struct {
	RemotePubkey  string       `json:"remote_pubkey"`
	ChannelPoint  string       `json:"channel_point"`
	Capacity      NumberString `json:"capacity"`
	Initiator     bool         `json:"initiator"`
	LocalBalance  NumberString `json:"local_balance"`
	RemoteBalance NumberString `json:"remote_balance"`
}

func (*ListChannelsChannel) AsSummaryEntry

func (c *ListChannelsChannel) AsSummaryEntry() *SummaryEntry

type ListChannelsFile

type ListChannelsFile struct {
	Channels []*ListChannelsChannel `json:"channels"`
}

func (*ListChannelsFile) AsSummaryEntries

func (f *ListChannelsFile) AsSummaryEntries() ([]*SummaryEntry, error)

type NumberString

type NumberString uint64

func (*NumberString) UnmarshalJSON

func (n *NumberString) UnmarshalJSON(b []byte) error

type Out

type Out struct {
	Script    string `json:"script"`
	ScriptAsm string `json:"script_asm"`
	Value     uint64 `json:"value"`
}

type PendingChannelsChannel

type PendingChannelsChannel struct {
	Channel struct {
		RemotePubkey  string       `json:"remote_node_pub"`
		ChannelPoint  string       `json:"channel_point"`
		Capacity      NumberString `json:"capacity"`
		LocalBalance  NumberString `json:"local_balance"`
		RemoteBalance NumberString `json:"remote_balance"`
	} `json:"channel"`
}

func (*PendingChannelsChannel) AsSummaryEntry

func (c *PendingChannelsChannel) AsSummaryEntry() *SummaryEntry

type PendingChannelsFile

type PendingChannelsFile struct {
	PendingOpen         []*PendingChannelsChannel `json:"pending_open_channels"`
	PendingClosing      []*PendingChannelsChannel `json:"pending_closing_channels"`
	PendingForceClosing []*PendingChannelsChannel `json:"pending_force_closing_channels"`
	WaitingClose        []*PendingChannelsChannel `json:"waiting_close_channels"`
}

func (*PendingChannelsFile) AsSummaryEntries

func (f *PendingChannelsFile) AsSummaryEntries() ([]*SummaryEntry, error)

type SummaryEntry

type SummaryEntry struct {
	RemotePubkey   string      `json:"remote_pubkey"`
	ChannelPoint   string      `json:"channel_point"`
	FundingTXID    string      `json:"funding_txid"`
	FundingTXIndex uint32      `json:"funding_tx_index"`
	Capacity       uint64      `json:"capacity"`
	Initiator      bool        `json:"initiator"`
	LocalBalance   uint64      `json:"local_balance"`
	RemoteBalance  uint64      `json:"remote_balance"`
	ChanExists     bool        `json:"chan_exists_onchain"`
	HasPotential   bool        `json:"has_potential_funds"`
	ClosingTX      *ClosingTX  `json:"closing_tx,omitempty"`
	ForceClose     *ForceClose `json:"force_close"`
}

type SummaryEntryFile

type SummaryEntryFile struct {
	Channels              []*SummaryEntry `json:"channels"`
	OpenChannels          uint32          `json:"open_channels"`
	ClosedChannels        uint32          `json:"closed_channels"`
	ForceClosedChannels   uint32          `json:"force_closed_channels"`
	CoopClosedChannels    uint32          `json:"coop_closed_channels"`
	FullySpentChannels    uint32          `json:"fully_spent_channels"`
	ChannelsWithUnspent   uint32          `json:"channels_with_unspent_funds"`
	ChannelsWithPotential uint32          `json:"channels_with_potential_funds"`
	FundsOpenChannels     uint64          `json:"funds_open_channels"`
	FundsClosedChannels   uint64          `json:"funds_closed_channels"`
	FundsClosedSpent      uint64          `json:"funds_closed_channels_spent"`
	FundsForceClose       uint64          `json:"funds_force_closed_maybe_ours"`
	FundsCoopClose        uint64          `json:"funds_coop_closed_maybe_ours"`
}

func (*SummaryEntryFile) AsSummaryEntries

func (f *SummaryEntryFile) AsSummaryEntries() ([]*SummaryEntry, error)