Class LNDLightning

Hierarchy

ApiConnection
- LNDLightning

Index

Constructors

Properties

_jwt _onAuthFailed? _requestFunc?

Accessors

jwt onAuthFailed requestFunc

Methods

_request addInvoice addOffer delete forwardingHistory get getPayments invoices isPaid parsePaymentRequest payInvoice post put

Constructors

constructor

new LNDLightning(baseUrl: string): LNDLightning
Parameters
- baseUrl: string
Returns LNDLightning
Overrides ApiConnection.constructor
- Defined in middleware/lnd/lightning.ts:17

Properties

`Protected` _jwt

_jwt: string = ''

`Protected` `Optional` _onAuthFailed

_onAuthFailed?: ((url: string) => void)

Type declaration

- (url: string): void
- Callback to run when a request returns status 401 (optional)
  Parameters
  - url: string
  Returns void

`Protected` `Optional` _requestFunc

_requestFunc?: RequestFunction

Custom request function (optional)

Accessors

jwt

set jwt(jwt: string): void
Parameters
- jwt: string
Returns void
Inherited from ApiConnection.jwt
- Defined in common/connection.ts:13

onAuthFailed

set onAuthFailed(callback: ((url: string) => void)): void
Parameters
- callback: ((url: string) => void)
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
Inherited from ApiConnection.onAuthFailed
- Defined in common/connection.ts:29

requestFunc

set requestFunc(requestFunc: RequestFunction): void
Parameters
- requestFunc: RequestFunction
Returns void
Inherited from ApiConnection.requestFunc
- Defined in common/connection.ts:21

Methods

_request

_request<ResponseType>(url: string, method?: "GET" | "POST" | "PUT" | "DELETE", body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection._request
- Defined in common/connection.ts:33

addInvoice

addInvoice(amt: string, memo?: string): Promise<{ paymentRequest: string; rHashStr: string }>
Parameters
- amt: string
- memo: string = ''
Returns Promise<{ paymentRequest: string; rHashStr: string }>
- Defined in middleware/lnd/lightning.ts:21

addOffer

addOffer(amount: string | number, description?: string): Promise<{ bolt12: string; bolt12_unsigned: string }>
Parameters
- amount: string | number
- description: string = ''
Returns Promise<{ bolt12: string; bolt12_unsigned: string }>
- Defined in middleware/lnd/lightning.ts:37

`Protected` delete

delete<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.delete
- Defined in common/connection.ts:125

forwardingHistory

forwardingHistory(startTime: number, endTime: number, indexOffset: number): Promise<ForwardingHistoryResponse>
Parameters
- startTime: number
- endTime: number
- indexOffset: number
Returns Promise<ForwardingHistoryResponse>
- Defined in middleware/lnd/lightning.ts:53

`Protected` get

get<ResponseType>(url: string, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.get
- Defined in common/connection.ts:99

getPayments

getPayments(): Promise<Payment[]>
Returns Promise<Payment[]>
- Defined in middleware/lnd/lightning.ts:92

invoices

invoices(): Promise<Invoice[]>
Returns Promise<Invoice[]>
- Defined in middleware/lnd/lightning.ts:71

isPaid

isPaid(paymentHash: string): Promise<boolean>
Parameters
- paymentHash: string
Returns Promise<boolean>
- Defined in middleware/lnd/lightning.ts:75

parsePaymentRequest

parsePaymentRequest(paymentRequest: string): Promise<extendedPaymentRequest>
Parameters
- paymentRequest: string
Returns Promise<extendedPaymentRequest>
- Defined in middleware/lnd/lightning.ts:63

payInvoice

payInvoice(paymentRequest: string, amt?: number): Promise<SendResponse>
Parameters
- paymentRequest: string
- Optional amt: number
Returns Promise<SendResponse>
- Defined in middleware/lnd/lightning.ts:82

`Protected` post

post<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.post
- Defined in common/connection.ts:107

`Protected` put

put<ResponseType>(url: string, body?: unknown, auth?: boolean, blob?: boolean): Promise<ResponseType>
Type Parameters
- ResponseType = unknown
Parameters
- url: string
- body: unknown = {}
- auth: boolean = true
- blob: boolean = false
Returns Promise<ResponseType>
Inherited from ApiConnection.put
- Defined in common/connection.ts:116

Generated using TypeDoc