LightningWallet
Hierarchy
- LightningWallet
Index
Methods
- addHoldInvoice
- addInvoice
- confirmedChannelBalance
- confirmedWalletBalance
- getInfo
- getPubkey
- lookupInvoice
- newAddress
- openChannel
- sendPayment
- sendPaymentWithRequest
- settleInvoice
- newInstance
Methods
addHoldInvoice
▸ addHoldInvoice(satAmount: string, secretHash: string, expiry: number, memo: string): Promise‹string›
Defined in lightning_wallet.ts:48
Parameters:
| Name | Type |
|---|---|
satAmount | string |
secretHash | string |
expiry | number |
memo | string |
Returns: Promise‹string›
addInvoice
▸ addInvoice(satAmount: string): Promise‹object›
Defined in lightning_wallet.ts:124
Parameters:
| Name | Type |
|---|---|
satAmount | string |
Returns: Promise‹object›
confirmedChannelBalance
▸ confirmedChannelBalance(): Promise‹string›
Defined in lightning_wallet.ts:75
Returns: Promise‹string›
confirmedWalletBalance
▸ confirmedWalletBalance(): Promise‹string›
Defined in lightning_wallet.ts:79
Returns: Promise‹string›
getInfo
▸ getInfo(): Promise‹GetInfoResponse›
Defined in lightning_wallet.ts:87
Returns: Promise‹GetInfoResponse›
getPubkey
▸ getPubkey(): Promise‹string›
Defined in lightning_wallet.ts:83
Returns: Promise‹string›
lookupInvoice
▸ lookupInvoice(secretHash: string): Promise‹Invoice›
Defined in lightning_wallet.ts:118
Parameters:
| Name | Type |
|---|---|
secretHash | string |
Returns: Promise‹Invoice›
newAddress
▸ newAddress(type: AddressType): Promise‹string›
Defined in lightning_wallet.ts:71
Parameters:
| Name | Type |
|---|---|
type | AddressType |
Returns: Promise‹string›
openChannel
▸ openChannel(toPubkey: string, satAmount: number): Promise‹Outpoint›
Defined in lightning_wallet.ts:91
Parameters:
| Name | Type |
|---|---|
toPubkey | string |
satAmount | number |
Returns: Promise‹Outpoint›
sendPayment
▸ sendPayment(publicKey: string, satAmount: string, secretHash: string, finalCltvDelta: number): Promise‹SendResponse›
Defined in lightning_wallet.ts:31
Parameters:
| Name | Type |
|---|---|
publicKey | string |
satAmount | string |
secretHash | string |
finalCltvDelta | number |
Returns: Promise‹SendResponse›
sendPaymentWithRequest
▸ sendPaymentWithRequest(paymentRequest: string): Promise‹SendResponse›
Defined in lightning_wallet.ts:112
Parameters:
| Name | Type |
|---|---|
paymentRequest | string |
Returns: Promise‹SendResponse›
settleInvoice
▸ settleInvoice(secret: string): Promise‹void›
Defined in lightning_wallet.ts:66
Parameters:
| Name | Type |
|---|---|
secret | string |
Returns: Promise‹void›
Static newInstance
▸ newInstance(certPath: string | false, macaroonPath: string, lndRpcSocket: string, lndP2pSocket: string): Promise‹LightningWallet›
Defined in lightning_wallet.ts:12
Parameters:
| Name | Type |
|---|---|
certPath | string | false |
macaroonPath | string |
lndRpcSocket | string |
lndP2pSocket | string |
Returns: Promise‹LightningWallet›