lndclient

Jun 18, 2020

Changes in this version

+ var ErrBuildTagsMissing = errors.New("build tags missing")

+ var ErrMalformedServerResponse = errors.New("one or more invoices are malformed")

+ var ErrNoRouteToServer = errors.New("no off-chain route to server")

+ var ErrVersionCheckNotImplemented = errors.New(...)

+ var ErrVersionIncompatible = errors.New("version incompatible")

+ var PaymentResultAlreadyPaid = channeldb.ErrAlreadyPaid.Error()

+ var PaymentResultInFlight = channeldb.ErrPaymentInFlight.Error()

+ var PaymentResultSuccess = ""

+ var PaymentResultUnknownPaymentHash = "UnknownPaymentHash"

+ func NewBasicClient(lndHost, tlsPath, macDir, network string, basicOptions ...BasicClientOption) (lnrpc.LightningClient, error)

+ func NewBasicConn(lndHost, tlsPath, macDir, network string, basicOptions ...BasicClientOption) (*grpc.ClientConn, error)

+ func UseLogger(logger btclog.Logger)

+ func VersionString(version *verrpc.Version) string

+ func VersionStringShort(version *verrpc.Version) string

+ type BasicClientOption func(*basicClientOptions)

+ func MacFilename(macFilename string) BasicClientOption

+ type ChainNotifierClient interface

+ RegisterBlockEpochNtfn func(ctx context.Context) (chan int32, chan error, error)

+ RegisterConfirmationsNtfn func(ctx context.Context, txid *chainhash.Hash, pkScript []byte, ...) (chan *chainntnfs.TxConfirmation, chan error, error)

+ RegisterSpendNtfn func(ctx context.Context, outpoint *wire.OutPoint, pkScript []byte, ...) (chan *chainntnfs.SpendDetail, chan error, error)

+ type ChannelInfo struct

+ Active bool

+ Capacity btcutil.Amount

+ ChannelID uint64

+ ChannelPoint string

+ Initiator bool

+ LifeTime time.Duration

+ LocalBalance btcutil.Amount

+ Private bool

+ PubKeyBytes route.Vertex

+ RemoteBalance btcutil.Amount

+ Uptime time.Duration

+ type CloseType uint8

+ const CloseTypeAbandoned

+ const CloseTypeBreach

+ const CloseTypeCooperative

+ const CloseTypeFundingCancelled

+ const CloseTypeLocalForce

+ const CloseTypeRemoteForce

+ func (c CloseType) String() string

+ type ClosedChannel struct

+ Capacity btcutil.Amount

+ ChannelID uint64

+ ChannelPoint string

+ CloseInitiator Initiator

+ CloseType CloseType

+ ClosingTxHash string

+ OpenInitiator Initiator

+ PubKeyBytes route.Vertex

+ SettledBalance btcutil.Amount

+ type DialerFunc func(context.Context, string) (net.Conn, error)

+ type ForwardingEvent struct

+ AmountMsatIn lnwire.MilliSatoshi

+ AmountMsatOut lnwire.MilliSatoshi

+ ChannelIn uint64

+ ChannelOut uint64

+ FeeMsat lnwire.MilliSatoshi

+ Timestamp time.Time

+ type ForwardingHistoryRequest struct

+ EndTime time.Time

+ MaxEvents uint32

+ Offset uint32

+ StartTime time.Time

+ type ForwardingHistoryResponse struct

+ Events []ForwardingEvent

+ LastIndexOffset uint32

+ type GrpcLndServices struct

+ func NewLndServices(cfg *LndServicesConfig) (*GrpcLndServices, error)

+ func (s *GrpcLndServices) Close()

+ type Info struct

+ Alias string

+ BlockHeight uint32

+ IdentityPubkey [33]byte

+ Network string

+ Uris []string

+ type Initiator uint8

+ const InitiatorBoth

+ const InitiatorLocal

+ const InitiatorRemote

+ const InitiatorUnrecorded

+ func (c Initiator) String() string

+ type Invoice struct

+ Amount lnwire.MilliSatoshi

+ AmountPaid lnwire.MilliSatoshi

+ CreationDate time.Time

+ Hash lntypes.Hash

+ IsKeysend bool

+ Memo string

+ PaymentRequest string

+ Preimage *lntypes.Preimage

+ SettleDate time.Time

+ State channeldb.ContractState

+ type InvoiceUpdate struct

+ AmtPaid btcutil.Amount

+ State channeldb.ContractState

+ type InvoicesClient interface

+ AddHoldInvoice func(ctx context.Context, in *invoicesrpc.AddInvoiceData) (string, error)

+ CancelInvoice func(ctx context.Context, hash lntypes.Hash) error

+ SettleInvoice func(ctx context.Context, preimage lntypes.Preimage) error

+ SubscribeSingleInvoice func(ctx context.Context, hash lntypes.Hash) (<-chan InvoiceUpdate, <-chan error, error)

+ type LightningClient interface

+ AddInvoice func(ctx context.Context, in *invoicesrpc.AddInvoiceData) (lntypes.Hash, string, error)

+ ChannelBackup func(context.Context, wire.OutPoint) ([]byte, error)

+ ChannelBackups func(ctx context.Context) ([]byte, error)

+ ClosedChannels func(ctx context.Context) ([]ClosedChannel, error)

+ ConfirmedWalletBalance func(ctx context.Context) (btcutil.Amount, error)

+ EstimateFeeToP2WSH func(ctx context.Context, amt btcutil.Amount, confTarget int32) (btcutil.Amount, error)

+ ForwardingHistory func(ctx context.Context, req ForwardingHistoryRequest) (*ForwardingHistoryResponse, error)

+ GetInfo func(ctx context.Context) (*Info, error)

+ ListChannels func(ctx context.Context) ([]ChannelInfo, error)

+ ListInvoices func(ctx context.Context, req ListInvoicesRequest) (*ListInvoicesResponse, error)

+ ListPayments func(ctx context.Context, req ListPaymentsRequest) (*ListPaymentsResponse, error)

+ ListTransactions func(ctx context.Context) ([]Transaction, error)

+ LookupInvoice func(ctx context.Context, hash lntypes.Hash) (*Invoice, error)

+ PayInvoice func(ctx context.Context, invoice string, maxFee btcutil.Amount, ...) chan PaymentResult

+ type ListInvoicesRequest struct

+ MaxInvoices uint64

+ Offset uint64

+ PendingOnly bool

+ Reversed bool

+ type ListInvoicesResponse struct

+ FirstIndexOffset uint64

+ Invoices []Invoice

+ LastIndexOffset uint64

+ type ListPaymentsRequest struct

+ IncludeIncomplete bool

+ MaxPayments uint64

+ Offset uint64

+ Reversed bool

+ type ListPaymentsResponse struct

+ FirstIndexOffset uint64

+ LastIndexOffset uint64

+ Payments []Payment

+ type LndServices struct

+ ChainNotifier ChainNotifierClient

+ ChainParams *chaincfg.Params

+ Client LightningClient

+ Invoices InvoicesClient

+ NodeAlias string

+ NodePubkey [33]byte

+ Router RouterClient

+ Signer SignerClient

+ Version *verrpc.Version

+ Versioner VersionerClient

+ WalletKit WalletKitClient

+ type LndServicesConfig struct

+ CheckVersion *verrpc.Version

+ Dialer DialerFunc

+ LndAddress string

+ MacaroonDir string

+ Network Network

+ TLSPath string

+ type Network string

+ const NetworkMainnet

+ const NetworkRegtest

+ const NetworkSimnet

+ const NetworkTestnet

+ func (n Network) ChainParams() (*chaincfg.Params, error)

+ type Payment struct

+ Amount lnwire.MilliSatoshi

+ Fee lnwire.MilliSatoshi

+ Hash lntypes.Hash

+ Htlcs []*lnrpc.HTLCAttempt

+ Preimage *lntypes.Preimage

+ SequenceNumber uint64

+ Status *PaymentStatus

+ type PaymentResult struct

+ Err error

+ PaidAmt btcutil.Amount

+ PaidFee btcutil.Amount

+ Preimage lntypes.Preimage

+ type PaymentStatus struct

+ FailureReason lnrpc.PaymentFailureReason

+ Fee lnwire.MilliSatoshi

+ InFlightAmt lnwire.MilliSatoshi

+ InFlightHtlcs int

+ Preimage lntypes.Preimage

+ State lnrpc.Payment_PaymentStatus

+ Value lnwire.MilliSatoshi

+ func (p PaymentStatus) String() string

+ type RouterClient interface

+ SendPayment func(ctx context.Context, request SendPaymentRequest) (chan PaymentStatus, chan error, error)

+ TrackPayment func(ctx context.Context, hash lntypes.Hash) (chan PaymentStatus, chan error, error)

+ type SendPaymentRequest struct

+ Amount btcutil.Amount

+ CustomRecords map[uint64][]byte

+ FinalCLTVDelta uint16

+ Invoice string

+ KeySend bool

+ LastHopPubkey *route.Vertex

+ MaxCltv *int32

+ MaxFee btcutil.Amount

+ MaxParts uint32

+ OutgoingChanIds []uint64

+ PaymentHash *lntypes.Hash

+ RouteHints [][]zpay32.HopHint

+ Target route.Vertex

+ Timeout time.Duration

+ type SignerClient interface

+ ComputeInputScript func(ctx context.Context, tx *wire.MsgTx, signDescriptors []*input.SignDescriptor) ([]*input.Script, error)

+ DeriveSharedKey func(ctx context.Context, ephemeralPubKey *btcec.PublicKey, ...) ([32]byte, error)

+ SignMessage func(ctx context.Context, msg []byte, locator keychain.KeyLocator) ([]byte, error)

+ SignOutputRaw func(ctx context.Context, tx *wire.MsgTx, signDescriptors []*input.SignDescriptor) ([][]byte, error)

+ VerifyMessage func(ctx context.Context, msg, sig []byte, pubkey [33]byte) (bool, error)

+ type Transaction struct

+ Amount btcutil.Amount

+ Confirmations int32

+ Fee btcutil.Amount

+ Label string

+ Timestamp time.Time

+ Tx *wire.MsgTx

+ TxHash string

+ type VersionerClient interface

+ GetVersion func(ctx context.Context) (*verrpc.Version, error)

+ type WalletKitClient interface

+ DeriveKey func(ctx context.Context, locator *keychain.KeyLocator) (*keychain.KeyDescriptor, error)

+ DeriveNextKey func(ctx context.Context, family int32) (*keychain.KeyDescriptor, error)

+ EstimateFee func(ctx context.Context, confTarget int32) (chainfee.SatPerKWeight, error)

+ LeaseOutput func(ctx context.Context, lockID wtxmgr.LockID, op wire.OutPoint) (time.Time, error)

+ ListSweeps func(ctx context.Context) ([]string, error)

+ ListUnspent func(ctx context.Context, minConfs, maxConfs int32) ([]*lnwallet.Utxo, error)

+ NextAddr func(ctx context.Context) (btcutil.Address, error)

+ PublishTransaction func(ctx context.Context, tx *wire.MsgTx) error

+ ReleaseOutput func(ctx context.Context, lockID wtxmgr.LockID, op wire.OutPoint) error

+ SendOutputs func(ctx context.Context, outputs []*wire.TxOut, feeRate chainfee.SatPerKWeight) (*wire.MsgTx, error)