lncli

Documentation

Index

• func NewProtoOutPoint(op string) (*lnrpc.OutPoint, error)
• func RunCommand(command string, connection *grpc.ClientConn) (string, error)
• type OutPoint
  • func NewOutPointFromProto(op *lnrpc.OutPoint) OutPoint
• type PendingSweep
  • func NewPendingSweepFromProto(pendingSweep *walletrpc.PendingSweep) *PendingSweep
• type Utxo
  • func NewUtxoFromProto(utxo *lnrpc.Utxo) *Utxo

Functions

func NewProtoOutPoint

func NewProtoOutPoint(op string) (*lnrpc.OutPoint, error)

NewProtoOutPoint parses an OutPoint into its corresponding lnrpc.OutPoint type.

func RunCommand

func RunCommand(command string, connection *grpc.ClientConn) (string, error)

Types

type OutPoint

type OutPoint string

OutPoint displays an outpoint string in the form "<txid>:<output-index>".

func NewOutPointFromProto

func NewOutPointFromProto(op *lnrpc.OutPoint) OutPoint

NewOutPointFromProto formats the lnrpc.OutPoint into an OutPoint for display.

type PendingSweep

type PendingSweep struct {
	OutPoint            OutPoint `json:"outpoint"`
	WitnessType         string   `json:"witness_type"`
	AmountSat           uint32   `json:"amount_sat"`
	SatPerByte          uint32   `json:"sat_per_byte"`
	BroadcastAttempts   uint32   `json:"broadcast_attempts"`
	NextBroadcastHeight uint32   `json:"next_broadcast_height"`
}

PendingSweep is a CLI-friendly type of the walletrpc.PendingSweep proto. We use this to show more useful string versions of byte slices and enums.

func NewPendingSweepFromProto

func NewPendingSweepFromProto(pendingSweep *walletrpc.PendingSweep) *PendingSweep

NewPendingSweepFromProto converts the walletrpc.PendingSweep proto type into its corresponding CLI-friendly type.

type Utxo

type Utxo struct {
	Type          lnrpc.AddressType `json:"address_type"`
	Address       string            `json:"address"`
	AmountSat     int64             `json:"amount_sat"`
	PkScript      string            `json:"pk_script"`
	OutPoint      OutPoint          `json:"outpoint"`
	Confirmations int64             `json:"confirmations"`
}

Utxo displays information about an unspent output, including its address, amount, pkscript, and confirmations.

func NewUtxoFromProto

func NewUtxoFromProto(utxo *lnrpc.Utxo) *Utxo

NewUtxoFromProto creates a display Utxo from the Utxo proto. This filters out the raw txid bytes from the provided outpoint, which will otherwise be printed in base64.