Class LNDChannel

Hierarchy

ApiConnection
- LNDChannel

Index

Constructors

constructor

new LNDChannel(baseUrl: string): LNDChannel
Parameters
- baseUrl: string
Returns LNDChannel
Overrides ApiConnection.constructor
- Defined in middleware/lnd/channel.ts:38

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

channelCount

channelCount(): Promise<number>
Returns Promise<number>
- Defined in middleware/lnd/channel.ts:104

closeChannel

closeChannel(channelPoint: string, force?: boolean): Promise<void>
Parameters
- channelPoint: string
- force: boolean = false
Returns Promise<void>
- Defined in middleware/lnd/channel.ts:97

`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

estimateFee

estimateFee(amt: string | number, confTarget: RangeOf2<2, 1000>, sweep?: boolean): Promise<EstimateFeeResponseExtended>
Parameters
- amt: string | number
- confTarget: RangeOf2<2, 1000>
- sweep: boolean = false
Returns Promise<EstimateFeeResponseExtended>
- Defined in middleware/lnd/channel.ts:46

estimateFeeAll

estimateFeeAll(amt: string | number, sweep?: boolean): Promise<{ cheapest: EstimateFeeResponseExtended; fast: EstimateFeeResponseExtended; normal: EstimateFeeResponseExtended; slow: EstimateFeeResponseExtended }>
Parameters
- amt: string | number
- sweep: boolean = false
Returns Promise<{ cheapest: EstimateFeeResponseExtended; fast: EstimateFeeResponseExtended; normal: EstimateFeeResponseExtended; slow: EstimateFeeResponseExtended }>
- Defined in middleware/lnd/channel.ts:56

`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

getBackup

getBackup(): Promise<Blob>
Returns Promise<Blob>
- Defined in middleware/lnd/channel.ts:136

getPendingChannels

getPendingChannels(): Promise<PendingChannelsResponse>
Returns Promise<PendingChannelsResponse>
- Defined in middleware/lnd/channel.ts:73

getPolicy

getPolicy(): Promise<ChannelFeeReport[]>
Returns Promise<ChannelFeeReport[]>
- Defined in middleware/lnd/channel.ts:77

list

list(): Promise<Channel_extended[]>
Returns Promise<Channel_extended[]>
- Defined in middleware/lnd/channel.ts:42

openChannel

openChannel(pubKey: string, ip: string, port: string | number, amt: string | number, satPerByte: undefined | number): Promise<string>
Open a new channel

Returns
The ID of the funding transaction
Parameters
- pubKey: string
  
  The pubkey of the peer to open a channel with
- ip: string
  
  The IP address of the peer to open a channel with
- port: string | number
  
  The port of the peer to open a channel with
- amt: string | number
  
  The amount to open the channel with
- satPerByte: undefined | number
  
  The amount to pay per byte of the opening transaction
Returns Promise<string>
- Defined in middleware/lnd/channel.ts:118

`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

setPolicy

setPolicy(chanPoint: string, baseFeeMsat: string | number, feeRate: number, timeLockDelta?: number, global?: boolean): Promise<void>
Parameters
- chanPoint: string
- baseFeeMsat: string | number
- feeRate: number
- timeLockDelta: number = 144
- global: boolean = false
Returns Promise<void>
- Defined in middleware/lnd/channel.ts:81

Class LNDChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

baseUrl: string

Returns LNDChannel

Properties

Protected _jwt

Protected Optional _onAuthFailed

Type declaration

Parameters

url: string

Returns void

Protected Optional _requestFunc

Accessors

jwt

Parameters

jwt: string

Returns void

onAuthFailed

Parameters

callback: ((url: string) => void)

Parameters

url: string

Returns void

Returns void

requestFunc

Parameters

requestFunc: RequestFunction

Returns void

Methods

_request

Type Parameters

ResponseType = unknown

Parameters

url: string

method: "GET" | "POST" | "PUT" | "DELETE" = 'GET'

body: unknown = {}

auth: boolean = true

blob: boolean = false

Returns Promise<ResponseType>

channelCount

Returns Promise<number>

closeChannel

Parameters

channelPoint: string

force: boolean = false

Returns Promise<void>

Protected delete

Type Parameters

ResponseType = unknown

Parameters

url: string

body: unknown = {}

auth: boolean = true

blob: boolean = false

Returns Promise<ResponseType>

estimateFee

Parameters

amt: string | number

confTarget: RangeOf2<2, 1000>

sweep: boolean = false

Returns Promise<EstimateFeeResponseExtended>

estimateFeeAll

Parameters

amt: string | number

sweep: boolean = false

Returns Promise<{ cheapest: EstimateFeeResponseExtended; fast: EstimateFeeResponseExtended; normal: EstimateFeeResponseExtended; slow: EstimateFeeResponseExtended }>

Protected get

Type Parameters

ResponseType = unknown

Parameters

url: string

auth: boolean = true

`Protected` _jwt

`Protected` `Optional` _onAuthFailed

`Protected` `Optional` _requestFunc

`Protected` delete

`Protected` get

`Protected` post

`Protected` put