Class MiddlewareLND

Hierarchy

ApiConnection
- MiddlewareLND

Index

Constructors

Properties

_jwt _onAuthFailed? _requestFunc? channel info lightning transaction wallet

Accessors

jwt onAuthFailed requestFunc

Methods

_request address delete get post put signMessage validateMessage

Constructors

constructor

new MiddlewareLND(baseUrl: string): MiddlewareLND
Parameters
- baseUrl: string
Returns MiddlewareLND
Overrides ApiConnection.constructor
- Defined in middleware/lnd.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)

`Readonly` channel

channel: LNDChannel

`Readonly` info

`Readonly` lightning

lightning: LNDLightning

`Readonly` transaction

transaction: LNDTransaction

`Readonly` wallet

wallet: LNDWallet

Accessors

jwt

set jwt(newJwt: string): void
Parameters
- newJwt: string
Returns void
Overrides ApiConnection.jwt
- Defined in middleware/lnd.ts:27

onAuthFailed

set onAuthFailed(callback: ((url: string) => void)): void
Parameters
- callback: ((url: string) => void)
  - - (url: string): void
    - Parameters
      
      url: string
      
      Returns void
Returns void
Overrides ApiConnection.onAuthFailed
- Defined in middleware/lnd.ts:48

requestFunc

set requestFunc(requestFunc: RequestFunction): void
Parameters
- requestFunc: RequestFunction
Returns void
Overrides ApiConnection.requestFunc
- Defined in middleware/lnd.ts:38

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

address

address(): Promise<NewAddressResponse>
Returns Promise<NewAddressResponse>
- Defined in middleware/lnd.ts:58

`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

`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

`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

signMessage

signMessage(message: string): Promise<string>
Parameters
- message: string
Returns Promise<string>
- Defined in middleware/lnd.ts:62

validateMessage

validateMessage(message: string, signature: string): Promise<{ pubkey: string; valid: boolean }>
Parameters
- message: string
- signature: string
Returns Promise<{ pubkey: string; valid: boolean }>
- Defined in middleware/lnd.ts:68

Generated using TypeDoc