@lightsparkdev/lightspark-sdk 1.2.2 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +21 -0
- package/dist/{BitcoinNetwork-a816c0be.d.ts → BitcoinNetwork-972b1d01.d.ts} +4 -1
- package/dist/{chunk-GLL4KTUT.js → chunk-Y55D3PD4.js} +11 -11
- package/dist/env.d.cts +1 -1
- package/dist/env.d.ts +1 -1
- package/dist/{index-eb604025.d.ts → index-a5028d74.d.ts} +866 -451
- package/dist/index.cjs +622 -557
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +363 -298
- package/dist/objects/index.d.cts +2 -2
- package/dist/objects/index.d.ts +2 -2
- package/dist/objects/index.js +1 -1
- package/package.json +4 -4
- package/src/NodeKeyLoaderCache.ts +4 -3
- package/src/SigningKeyLoader.ts +12 -7
- package/src/client.ts +117 -65
- package/src/env.ts +3 -1
- package/src/graphql/CancelInvoice.ts +17 -0
- package/src/objects/Account.ts +7 -3
- package/src/objects/AccountToApiTokensConnection.ts +3 -2
- package/src/objects/AccountToChannelsConnection.ts +3 -2
- package/src/objects/AccountToNodesConnection.ts +3 -2
- package/src/objects/AccountToPaymentRequestsConnection.ts +3 -2
- package/src/objects/AccountToTransactionsConnection.ts +7 -6
- package/src/objects/AccountToWalletsConnection.ts +3 -2
- package/src/objects/ApiToken.ts +10 -5
- package/src/objects/Balances.ts +20 -12
- package/src/objects/BitcoinNetwork.ts +4 -1
- package/src/objects/CancelInvoiceInput.ts +18 -0
- package/src/objects/CancelInvoiceOutput.ts +26 -0
- package/src/objects/Channel.ts +26 -12
- package/src/objects/ChannelClosingTransaction.ts +7 -3
- package/src/objects/ChannelOpeningTransaction.ts +7 -3
- package/src/objects/ChannelStatus.ts +24 -5
- package/src/objects/ChannelToTransactionsConnection.ts +9 -8
- package/src/objects/Connection.ts +3 -2
- package/src/objects/CreateApiTokenOutput.ts +3 -3
- package/src/objects/CreateLnurlInvoiceInput.ts +3 -2
- package/src/objects/CreateTestModePaymentInput.ts +2 -2
- package/src/objects/CreateTestModePaymentoutput.ts +5 -1
- package/src/objects/CurrencyAmount.ts +2 -2
- package/src/objects/CurrencyUnit.ts +29 -6
- package/src/objects/Deposit.ts +8 -3
- package/src/objects/Entity.ts +8 -3
- package/src/objects/FeeEstimate.ts +5 -1
- package/src/objects/GraphNode.ts +20 -11
- package/src/objects/Hop.ts +8 -3
- package/src/objects/HtlcAttemptFailureCode.ts +4 -1
- package/src/objects/IncentivesIneligibilityReason.ts +16 -4
- package/src/objects/IncentivesStatus.ts +9 -2
- package/src/objects/IncomingPayment.ts +9 -5
- package/src/objects/IncomingPaymentAttempt.ts +7 -3
- package/src/objects/IncomingPaymentToAttemptsConnection.ts +3 -2
- package/src/objects/Invoice.ts +2 -2
- package/src/objects/InvoiceData.ts +7 -3
- package/src/objects/LightningFeeEstimateForInvoiceInput.ts +2 -2
- package/src/objects/LightningTransaction.ts +7 -3
- package/src/objects/LightsparkNode.ts +21 -12
- package/src/objects/LightsparkNodeOwner.ts +2 -2
- package/src/objects/LightsparkNodeToChannelsConnection.ts +3 -2
- package/src/objects/LightsparkNodeWithOSK.ts +20 -12
- package/src/objects/LightsparkNodeWithRemoteSigning.ts +16 -11
- package/src/objects/Node.ts +19 -11
- package/src/objects/NodeAddressType.ts +4 -1
- package/src/objects/NodeToAddressesConnection.ts +7 -3
- package/src/objects/OnChainTransaction.ts +8 -3
- package/src/objects/OutgoingPayment.ts +8 -3
- package/src/objects/OutgoingPaymentAttempt.ts +16 -9
- package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts +7 -3
- package/src/objects/OutgoingPaymentToAttemptsConnection.ts +3 -2
- package/src/objects/PageInfo.ts +5 -1
- package/src/objects/PayInvoiceInput.ts +4 -1
- package/src/objects/PaymentFailureReason.ts +4 -1
- package/src/objects/PaymentRequest.ts +7 -3
- package/src/objects/PaymentRequestData.ts +5 -1
- package/src/objects/PaymentRequestStatus.ts +4 -1
- package/src/objects/Permission.ts +4 -1
- package/src/objects/RegisterPaymentInput.ts +8 -7
- package/src/objects/RequestWithdrawalInput.ts +2 -2
- package/src/objects/RiskRating.ts +5 -1
- package/src/objects/RoutingTransaction.ts +11 -5
- package/src/objects/RoutingTransactionFailureReason.ts +4 -1
- package/src/objects/ScreenNodeInput.ts +3 -2
- package/src/objects/SendPaymentInput.ts +4 -1
- package/src/objects/SetInvoicePaymentHashInput.ts +3 -2
- package/src/objects/Signable.ts +2 -2
- package/src/objects/SignablePayload.ts +6 -3
- package/src/objects/Transaction.ts +8 -3
- package/src/objects/TransactionStatus.ts +8 -2
- package/src/objects/TransactionType.ts +16 -4
- package/src/objects/TransactionUpdate.ts +6 -3
- package/src/objects/UmaInvitation.ts +2 -2
- package/src/objects/Wallet.ts +12 -4
- package/src/objects/WalletStatus.ts +18 -4
- package/src/objects/WalletToPaymentRequestsConnection.ts +3 -2
- package/src/objects/WalletToTransactionsConnection.ts +3 -2
- package/src/objects/WebhookEventType.ts +4 -1
- package/src/objects/Withdrawal.ts +7 -3
- package/src/objects/WithdrawalRequest.ts +10 -5
- package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +3 -2
- package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +3 -2
- package/src/objects/index.ts +8 -6
- package/src/tests/integration/general-regtest.test.ts +15 -1
|
@@ -1,6 +1,30 @@
|
|
|
1
1
|
import { Maybe, Query, AuthProvider, CryptoInterface, SigningKey, KeyOrAliasType } from '@lightsparkdev/core';
|
|
2
2
|
import Observable from 'zen-observable';
|
|
3
|
-
import { B as BitcoinNetwork } from './BitcoinNetwork-
|
|
3
|
+
import { B as BitcoinNetwork } from './BitcoinNetwork-972b1d01.js';
|
|
4
|
+
|
|
5
|
+
/**
|
|
6
|
+
* Args for creating a new SigningKeyLoader. Must be one of the sub types.
|
|
7
|
+
*/
|
|
8
|
+
type SigningKeyLoaderArgs = NodeIdAndPasswordSigningKeyLoaderArgs | MasterSeedSigningKeyLoaderArgs;
|
|
9
|
+
/**
|
|
10
|
+
* Args for creating a new SigningKeyLoader from a node ID and password.
|
|
11
|
+
* This cannot be used if you are using remote signing.
|
|
12
|
+
* It is used to recover an RSA operation signing key using the password you
|
|
13
|
+
* chose when setting up your node. For REGTEST nodes, the password is
|
|
14
|
+
* "1234!@#$".
|
|
15
|
+
*/
|
|
16
|
+
interface NodeIdAndPasswordSigningKeyLoaderArgs {
|
|
17
|
+
password: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Args for creating a new SigningKeyLoader from a master seed and network.
|
|
21
|
+
* This should be used if you are using remote signing,
|
|
22
|
+
* rather than an RSA operation signing key.
|
|
23
|
+
*/
|
|
24
|
+
interface MasterSeedSigningKeyLoaderArgs {
|
|
25
|
+
masterSeed: Uint8Array;
|
|
26
|
+
network: BitcoinNetwork;
|
|
27
|
+
}
|
|
4
28
|
|
|
5
29
|
/** This enum identifies the unit of currency associated with a CurrencyAmount. **/
|
|
6
30
|
declare enum CurrencyUnit {
|
|
@@ -9,19 +33,42 @@ declare enum CurrencyUnit {
|
|
|
9
33
|
* Clients should support unknown values as more of them could be added without notice.
|
|
10
34
|
*/
|
|
11
35
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
12
|
-
/**
|
|
36
|
+
/**
|
|
37
|
+
* Bitcoin is the cryptocurrency native to the Bitcoin network.
|
|
38
|
+
* It is used as the native medium for value transfer for the Lightning Network.
|
|
39
|
+
* *
|
|
40
|
+
*/
|
|
13
41
|
BITCOIN = "BITCOIN",
|
|
14
|
-
/**
|
|
42
|
+
/**
|
|
43
|
+
* 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin.
|
|
44
|
+
* This is the unit most commonly used in Lightning transactions.
|
|
45
|
+
* *
|
|
46
|
+
*/
|
|
15
47
|
SATOSHI = "SATOSHI",
|
|
16
|
-
/**
|
|
48
|
+
/**
|
|
49
|
+
* 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
|
|
50
|
+
* *
|
|
51
|
+
*/
|
|
17
52
|
MILLISATOSHI = "MILLISATOSHI",
|
|
18
53
|
/** United States Dollar. **/
|
|
19
54
|
USD = "USD",
|
|
20
|
-
/**
|
|
55
|
+
/**
|
|
56
|
+
* 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin.
|
|
57
|
+
* We recommend using the Satoshi unit instead when possible.
|
|
58
|
+
* *
|
|
59
|
+
*/
|
|
21
60
|
NANOBITCOIN = "NANOBITCOIN",
|
|
22
|
-
/**
|
|
61
|
+
/**
|
|
62
|
+
* 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin.
|
|
63
|
+
* We recommend using the Satoshi unit instead when possible.
|
|
64
|
+
* *
|
|
65
|
+
*/
|
|
23
66
|
MICROBITCOIN = "MICROBITCOIN",
|
|
24
|
-
/**
|
|
67
|
+
/**
|
|
68
|
+
* 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin.
|
|
69
|
+
* We recommend using the Satoshi unit instead when possible.
|
|
70
|
+
* *
|
|
71
|
+
*/
|
|
25
72
|
MILLIBITCOIN = "MILLIBITCOIN"
|
|
26
73
|
}
|
|
27
74
|
|
|
@@ -39,8 +86,8 @@ interface CurrencyAmount {
|
|
|
39
86
|
**/
|
|
40
87
|
preferredCurrencyValueRounded: number;
|
|
41
88
|
/**
|
|
42
|
-
* The approximate float value for this CurrencyAmount in the very base level of user's
|
|
43
|
-
* currency. For example, for USD, the value will be in cents.
|
|
89
|
+
* The approximate float value for this CurrencyAmount in the very base level of user's
|
|
90
|
+
* preferred currency. For example, for USD, the value will be in cents.
|
|
44
91
|
**/
|
|
45
92
|
preferredCurrencyValueApprox: number;
|
|
46
93
|
}
|
|
@@ -63,7 +110,10 @@ declare enum LightsparkNodeStatus {
|
|
|
63
110
|
FAILED_TO_DEPLOY = "FAILED_TO_DEPLOY"
|
|
64
111
|
}
|
|
65
112
|
|
|
66
|
-
/**
|
|
113
|
+
/**
|
|
114
|
+
* This is an enum of the potential types of addresses that a node on the Lightning Network can
|
|
115
|
+
* have. *
|
|
116
|
+
*/
|
|
67
117
|
declare enum NodeAddressType {
|
|
68
118
|
/**
|
|
69
119
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -108,7 +158,10 @@ type AccountDashboard = {
|
|
|
108
158
|
remoteBalance: Maybe<CurrencyAmount>;
|
|
109
159
|
};
|
|
110
160
|
|
|
111
|
-
/**
|
|
161
|
+
/**
|
|
162
|
+
* This is an enum of the potential permissions that a Lightspark user can have in regards to
|
|
163
|
+
* account management. *
|
|
164
|
+
*/
|
|
112
165
|
declare enum Permission {
|
|
113
166
|
/**
|
|
114
167
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -131,11 +184,16 @@ declare enum Permission {
|
|
|
131
184
|
ACCOUNT_MANAGE = "ACCOUNT_MANAGE"
|
|
132
185
|
}
|
|
133
186
|
|
|
134
|
-
/**
|
|
187
|
+
/**
|
|
188
|
+
* This is an object representing a Lightspark API token,
|
|
189
|
+
* that can be used to authenticate this account when making API calls or using our SDKs.
|
|
190
|
+
* See the “Authentication” section of our API docs for more details on its usage.
|
|
191
|
+
* *
|
|
192
|
+
*/
|
|
135
193
|
interface ApiToken {
|
|
136
194
|
/**
|
|
137
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
138
|
-
* string.
|
|
195
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
196
|
+
* Should be treated as an opaque string.
|
|
139
197
|
**/
|
|
140
198
|
id: string;
|
|
141
199
|
/** The date and time when the entity was first created. **/
|
|
@@ -148,8 +206,8 @@ interface ApiToken {
|
|
|
148
206
|
**/
|
|
149
207
|
clientId: string;
|
|
150
208
|
/**
|
|
151
|
-
* An arbitrary name chosen by the creator of the token to help identify the token in the list
|
|
152
|
-
* tokens that have been created for the account.
|
|
209
|
+
* An arbitrary name chosen by the creator of the token to help identify the token in the list
|
|
210
|
+
* of tokens that have been created for the account.
|
|
153
211
|
**/
|
|
154
212
|
name: string;
|
|
155
213
|
/** A list of permissions granted to the token. **/
|
|
@@ -159,7 +217,11 @@ interface ApiToken {
|
|
|
159
217
|
}
|
|
160
218
|
declare const getApiTokenQuery: (id: string) => Query<ApiToken>;
|
|
161
219
|
|
|
162
|
-
/**
|
|
220
|
+
/**
|
|
221
|
+
* This is an object representing information about a page returned by the Lightspark API.
|
|
222
|
+
* For more information, please see the “Pagination” section of our API docs for more information
|
|
223
|
+
* about its usage. *
|
|
224
|
+
*/
|
|
163
225
|
interface PageInfo {
|
|
164
226
|
hasNextPage?: boolean | undefined;
|
|
165
227
|
hasPreviousPage?: boolean | undefined;
|
|
@@ -169,8 +231,9 @@ interface PageInfo {
|
|
|
169
231
|
|
|
170
232
|
interface AccountToApiTokensConnection {
|
|
171
233
|
/**
|
|
172
|
-
* The total count of objects in this connection, using the current filters.
|
|
173
|
-
* number of objects returned in the current page (in the `entities`
|
|
234
|
+
* The total count of objects in this connection, using the current filters.
|
|
235
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
236
|
+
* field).
|
|
174
237
|
**/
|
|
175
238
|
count: number;
|
|
176
239
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -190,17 +253,36 @@ declare enum ChannelStatus {
|
|
|
190
253
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
191
254
|
/** The channel is online and ready to send and receive funds. **/
|
|
192
255
|
OK = "OK",
|
|
193
|
-
/**
|
|
256
|
+
/**
|
|
257
|
+
* The channel has been created, but the Bitcoin transaction that initiates it still needs to be
|
|
258
|
+
* confirmed on the Bitcoin blockchain. *
|
|
259
|
+
*/
|
|
194
260
|
PENDING = "PENDING",
|
|
195
261
|
/** The channel is not available, likely because the peer is not online. **/
|
|
196
262
|
OFFLINE = "OFFLINE",
|
|
197
|
-
/**
|
|
263
|
+
/**
|
|
264
|
+
* The channel is behaving properly, but its remote balance is much higher than its local balance
|
|
265
|
+
* so it is not balanced properly for sending funds out.
|
|
266
|
+
* *
|
|
267
|
+
*/
|
|
198
268
|
UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
|
|
199
|
-
/**
|
|
269
|
+
/**
|
|
270
|
+
* The channel is behaving properly, but its remote balance is much lower than its local balance
|
|
271
|
+
* so it is not balanced properly for receiving funds.
|
|
272
|
+
* *
|
|
273
|
+
*/
|
|
200
274
|
UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
|
|
201
|
-
/**
|
|
275
|
+
/**
|
|
276
|
+
* The channel has been closed. Information about the channel is still available for historical
|
|
277
|
+
* purposes but the channel cannot be used anymore.
|
|
278
|
+
* *
|
|
279
|
+
*/
|
|
202
280
|
CLOSED = "CLOSED",
|
|
203
|
-
/**
|
|
281
|
+
/**
|
|
282
|
+
* Something unexpected happened and we cannot determine the status of this channel.
|
|
283
|
+
* Please try again later or contact the support.
|
|
284
|
+
* *
|
|
285
|
+
*/
|
|
204
286
|
ERROR = "ERROR"
|
|
205
287
|
}
|
|
206
288
|
|
|
@@ -212,32 +294,38 @@ interface ChannelFees {
|
|
|
212
294
|
|
|
213
295
|
interface ChannelToTransactionsConnection {
|
|
214
296
|
/**
|
|
215
|
-
* The total count of objects in this connection, using the current filters.
|
|
216
|
-
* number of objects returned in the current page (in the `entities`
|
|
297
|
+
* The total count of objects in this connection, using the current filters.
|
|
298
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
299
|
+
* field).
|
|
217
300
|
**/
|
|
218
301
|
count: number;
|
|
219
302
|
/**
|
|
220
|
-
* The average fee for the transactions that transited through this channel,
|
|
221
|
-
* and constraints of the connection.
|
|
303
|
+
* The average fee for the transactions that transited through this channel,
|
|
304
|
+
* according to the filters and constraints of the connection.
|
|
222
305
|
**/
|
|
223
306
|
averageFee?: CurrencyAmount | undefined;
|
|
224
307
|
/**
|
|
225
|
-
* The total amount transacted for the transactions that transited through this channel,
|
|
226
|
-
* the filters and constraints of the connection.
|
|
308
|
+
* The total amount transacted for the transactions that transited through this channel,
|
|
309
|
+
* according to the filters and constraints of the connection.
|
|
227
310
|
**/
|
|
228
311
|
totalAmountTransacted?: CurrencyAmount | undefined;
|
|
229
312
|
/**
|
|
230
|
-
* The total amount of fees for the transactions that transited through this channel,
|
|
231
|
-
* filters and constraints of the connection.
|
|
313
|
+
* The total amount of fees for the transactions that transited through this channel,
|
|
314
|
+
* according to the filters and constraints of the connection.
|
|
232
315
|
**/
|
|
233
316
|
totalFees?: CurrencyAmount | undefined;
|
|
234
317
|
}
|
|
235
318
|
|
|
236
|
-
/**
|
|
319
|
+
/**
|
|
320
|
+
* This interface is used by all the entities in the Lightspark system.
|
|
321
|
+
* It defines a few core fields that are available everywhere.
|
|
322
|
+
* Any object that implements this interface can be queried using the `entity` query and its ID.
|
|
323
|
+
* *
|
|
324
|
+
*/
|
|
237
325
|
interface Entity {
|
|
238
326
|
/**
|
|
239
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
240
|
-
* string.
|
|
327
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
328
|
+
* Should be treated as an opaque string.
|
|
241
329
|
**/
|
|
242
330
|
id: string;
|
|
243
331
|
/** The date and time when the entity was first created. **/
|
|
@@ -248,7 +336,10 @@ interface Entity {
|
|
|
248
336
|
typename: string;
|
|
249
337
|
}
|
|
250
338
|
|
|
251
|
-
/**
|
|
339
|
+
/**
|
|
340
|
+
* This is an enum of the potential types of transactions that can be associated with your
|
|
341
|
+
* Lightspark Node. *
|
|
342
|
+
*/
|
|
252
343
|
declare enum TransactionType {
|
|
253
344
|
/**
|
|
254
345
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -261,13 +352,22 @@ declare enum TransactionType {
|
|
|
261
352
|
INCOMING_PAYMENT = "INCOMING_PAYMENT",
|
|
262
353
|
/** Transactions that forwarded payments through Lightspark nodes on Lightning Network. **/
|
|
263
354
|
ROUTED = "ROUTED",
|
|
264
|
-
/**
|
|
355
|
+
/**
|
|
356
|
+
* Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark node to a Bitcoin
|
|
357
|
+
* wallet. *
|
|
358
|
+
*/
|
|
265
359
|
L1_WITHDRAW = "L1_WITHDRAW",
|
|
266
360
|
/** Transactions on Bitcoin blockchain to fund a Lightspark node's wallet. **/
|
|
267
361
|
L1_DEPOSIT = "L1_DEPOSIT",
|
|
268
|
-
/**
|
|
362
|
+
/**
|
|
363
|
+
* Transactions on Bitcoin blockchain to open a channel on Lightning Network funded by the local
|
|
364
|
+
* Lightspark node. *
|
|
365
|
+
*/
|
|
269
366
|
CHANNEL_OPEN = "CHANNEL_OPEN",
|
|
270
|
-
/**
|
|
367
|
+
/**
|
|
368
|
+
* Transactions on Bitcoin blockchain to close a channel on Lightning Network where the balances
|
|
369
|
+
* are allocated back to local and remote nodes. *
|
|
370
|
+
*/
|
|
271
371
|
CHANNEL_CLOSE = "CHANNEL_CLOSE",
|
|
272
372
|
/** Transactions initiated from a Lightspark node on Lightning Network. **/
|
|
273
373
|
PAYMENT = "PAYMENT",
|
|
@@ -277,11 +377,15 @@ declare enum TransactionType {
|
|
|
277
377
|
ROUTE = "ROUTE"
|
|
278
378
|
}
|
|
279
379
|
|
|
280
|
-
/**
|
|
380
|
+
/**
|
|
381
|
+
* This is an object representing a channel on the Lightning Network.
|
|
382
|
+
* You can retrieve this object to get detailed information on a specific Lightning Network
|
|
383
|
+
* channel. *
|
|
384
|
+
*/
|
|
281
385
|
declare class Channel implements Entity {
|
|
282
386
|
/**
|
|
283
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
284
|
-
* string.
|
|
387
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
388
|
+
* Should be treated as an opaque string.
|
|
285
389
|
**/
|
|
286
390
|
readonly id: string;
|
|
287
391
|
/** The date and time when the entity was first created. **/
|
|
@@ -295,27 +399,36 @@ declare class Channel implements Entity {
|
|
|
295
399
|
/** The transaction that funded the channel upon channel opening. **/
|
|
296
400
|
readonly fundingTransactionId?: string | undefined;
|
|
297
401
|
/**
|
|
298
|
-
* The total amount of funds in this channel, including the channel balance on the local node,
|
|
299
|
-
* channel balance on the remote node and the on-chain fees to close the channel.
|
|
402
|
+
* The total amount of funds in this channel, including the channel balance on the local node,
|
|
403
|
+
* the channel balance on the remote node and the on-chain fees to close the channel.
|
|
300
404
|
**/
|
|
301
405
|
readonly capacity?: CurrencyAmount | undefined;
|
|
302
406
|
/** The channel balance on the local node. **/
|
|
303
407
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
304
|
-
/**
|
|
408
|
+
/**
|
|
409
|
+
* The channel balance on the local node that is currently allocated to in-progress payments.
|
|
410
|
+
* *
|
|
411
|
+
*/
|
|
305
412
|
readonly localUnsettledBalance?: CurrencyAmount | undefined;
|
|
306
413
|
/** The channel balance on the remote node. **/
|
|
307
414
|
readonly remoteBalance?: CurrencyAmount | undefined;
|
|
308
|
-
/**
|
|
415
|
+
/**
|
|
416
|
+
* The channel balance on the remote node that is currently allocated to in-progress payments.
|
|
417
|
+
* *
|
|
418
|
+
*/
|
|
309
419
|
readonly remoteUnsettledBalance?: CurrencyAmount | undefined;
|
|
310
420
|
/** The channel balance that is currently allocated to in-progress payments. **/
|
|
311
421
|
readonly unsettledBalance?: CurrencyAmount | undefined;
|
|
312
|
-
/**
|
|
422
|
+
/**
|
|
423
|
+
* The total balance in this channel, including the channel balance on both local and remote
|
|
424
|
+
* nodes. *
|
|
425
|
+
*/
|
|
313
426
|
readonly totalBalance?: CurrencyAmount | undefined;
|
|
314
427
|
/** The current status of this channel. **/
|
|
315
428
|
readonly status?: ChannelStatus | undefined;
|
|
316
429
|
/**
|
|
317
|
-
* The estimated time to wait for the channel's hash timelock contract to expire when force
|
|
318
|
-
* the channel. It is in unit of minutes.
|
|
430
|
+
* The estimated time to wait for the channel's hash timelock contract to expire when force
|
|
431
|
+
* closing the channel. It is in unit of minutes.
|
|
319
432
|
**/
|
|
320
433
|
readonly estimatedForceClosureWaitMinutes?: number | undefined;
|
|
321
434
|
/** The amount to be paid in fees for the current set of commitment transactions. **/
|
|
@@ -325,14 +438,15 @@ declare class Channel implements Entity {
|
|
|
325
438
|
/** If known, the remote node of the channel. **/
|
|
326
439
|
readonly remoteNodeId?: string | undefined;
|
|
327
440
|
/**
|
|
328
|
-
* The unique identifier of the channel on Lightning Network,
|
|
329
|
-
* the channel was confirmed. The format is
|
|
441
|
+
* The unique identifier of the channel on Lightning Network,
|
|
442
|
+
* which is the location in the chain that the channel was confirmed. The format is
|
|
443
|
+
* <block-height>:<tx-index>:<tx-output>.
|
|
330
444
|
**/
|
|
331
445
|
readonly shortChannelId?: string | undefined;
|
|
332
446
|
constructor(
|
|
333
447
|
/**
|
|
334
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
335
|
-
* string.
|
|
448
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
449
|
+
* Should be treated as an opaque string.
|
|
336
450
|
**/
|
|
337
451
|
id: string,
|
|
338
452
|
/** The date and time when the entity was first created. **/
|
|
@@ -346,27 +460,36 @@ declare class Channel implements Entity {
|
|
|
346
460
|
/** The transaction that funded the channel upon channel opening. **/
|
|
347
461
|
fundingTransactionId?: string | undefined,
|
|
348
462
|
/**
|
|
349
|
-
* The total amount of funds in this channel, including the channel balance on the local node,
|
|
350
|
-
* channel balance on the remote node and the on-chain fees to close the channel.
|
|
463
|
+
* The total amount of funds in this channel, including the channel balance on the local node,
|
|
464
|
+
* the channel balance on the remote node and the on-chain fees to close the channel.
|
|
351
465
|
**/
|
|
352
466
|
capacity?: CurrencyAmount | undefined,
|
|
353
467
|
/** The channel balance on the local node. **/
|
|
354
468
|
localBalance?: CurrencyAmount | undefined,
|
|
355
|
-
/**
|
|
469
|
+
/**
|
|
470
|
+
* The channel balance on the local node that is currently allocated to in-progress payments.
|
|
471
|
+
* *
|
|
472
|
+
*/
|
|
356
473
|
localUnsettledBalance?: CurrencyAmount | undefined,
|
|
357
474
|
/** The channel balance on the remote node. **/
|
|
358
475
|
remoteBalance?: CurrencyAmount | undefined,
|
|
359
|
-
/**
|
|
476
|
+
/**
|
|
477
|
+
* The channel balance on the remote node that is currently allocated to in-progress payments.
|
|
478
|
+
* *
|
|
479
|
+
*/
|
|
360
480
|
remoteUnsettledBalance?: CurrencyAmount | undefined,
|
|
361
481
|
/** The channel balance that is currently allocated to in-progress payments. **/
|
|
362
482
|
unsettledBalance?: CurrencyAmount | undefined,
|
|
363
|
-
/**
|
|
483
|
+
/**
|
|
484
|
+
* The total balance in this channel, including the channel balance on both local and remote
|
|
485
|
+
* nodes. *
|
|
486
|
+
*/
|
|
364
487
|
totalBalance?: CurrencyAmount | undefined,
|
|
365
488
|
/** The current status of this channel. **/
|
|
366
489
|
status?: ChannelStatus | undefined,
|
|
367
490
|
/**
|
|
368
|
-
* The estimated time to wait for the channel's hash timelock contract to expire when force
|
|
369
|
-
* the channel. It is in unit of minutes.
|
|
491
|
+
* The estimated time to wait for the channel's hash timelock contract to expire when force
|
|
492
|
+
* closing the channel. It is in unit of minutes.
|
|
370
493
|
**/
|
|
371
494
|
estimatedForceClosureWaitMinutes?: number | undefined,
|
|
372
495
|
/** The amount to be paid in fees for the current set of commitment transactions. **/
|
|
@@ -376,8 +499,9 @@ declare class Channel implements Entity {
|
|
|
376
499
|
/** If known, the remote node of the channel. **/
|
|
377
500
|
remoteNodeId?: string | undefined,
|
|
378
501
|
/**
|
|
379
|
-
* The unique identifier of the channel on Lightning Network,
|
|
380
|
-
* the channel was confirmed. The format is
|
|
502
|
+
* The unique identifier of the channel on Lightning Network,
|
|
503
|
+
* which is the location in the chain that the channel was confirmed. The format is
|
|
504
|
+
* <block-height>:<tx-index>:<tx-output>.
|
|
381
505
|
**/
|
|
382
506
|
shortChannelId?: string | undefined);
|
|
383
507
|
getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
|
|
@@ -414,16 +538,18 @@ declare class Channel implements Entity {
|
|
|
414
538
|
|
|
415
539
|
declare class AccountToChannelsConnection {
|
|
416
540
|
/**
|
|
417
|
-
* The total count of objects in this connection, using the current filters.
|
|
418
|
-
* number of objects returned in the current page (in the `entities`
|
|
541
|
+
* The total count of objects in this connection, using the current filters.
|
|
542
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
543
|
+
* field).
|
|
419
544
|
**/
|
|
420
545
|
readonly count: number;
|
|
421
546
|
/** The channels for the current page of this connection. **/
|
|
422
547
|
readonly entities: Channel[];
|
|
423
548
|
constructor(
|
|
424
549
|
/**
|
|
425
|
-
* The total count of objects in this connection, using the current filters.
|
|
426
|
-
* number of objects returned in the current page (in the `entities`
|
|
550
|
+
* The total count of objects in this connection, using the current filters.
|
|
551
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
552
|
+
* field).
|
|
427
553
|
**/
|
|
428
554
|
count: number,
|
|
429
555
|
/** The channels for the current page of this connection. **/
|
|
@@ -460,26 +586,34 @@ declare class AccountToChannelsConnection {
|
|
|
460
586
|
};
|
|
461
587
|
}
|
|
462
588
|
|
|
463
|
-
/**
|
|
589
|
+
/**
|
|
590
|
+
* This is an object representing the balance associated with your Lightspark account.
|
|
591
|
+
* You can retrieve this object to see your balance,
|
|
592
|
+
* which can be broken down into several different categorizations.
|
|
593
|
+
* *
|
|
594
|
+
*/
|
|
464
595
|
interface Balances {
|
|
465
596
|
/**
|
|
466
|
-
* This represents the balance that should be displayed when asked "how much do I own right
|
|
467
|
-
* represents the amount currently owned,
|
|
468
|
-
*
|
|
469
|
-
* officially owned at this
|
|
597
|
+
* This represents the balance that should be displayed when asked "how much do I own right
|
|
598
|
+
* now?". It represents the amount currently owned,
|
|
599
|
+
* including things that may not be owned soon (e.g. in-flight outgoing payments, in-flight
|
|
600
|
+
* withdrawals, commit fees, etc.). It really is a snapshot of what is officially owned at this
|
|
601
|
+
* instant.
|
|
470
602
|
**/
|
|
471
603
|
ownedBalance: CurrencyAmount;
|
|
472
604
|
/**
|
|
473
|
-
* This represents the balance that should be displayed when asked "how much can I send on
|
|
474
|
-
* right now?". It represents the amount currently available to be sent on the
|
|
475
|
-
* remove from the balance all the funds that are temporarily locked
|
|
605
|
+
* This represents the balance that should be displayed when asked "how much can I send on
|
|
606
|
+
* Lightning right now?". It represents the amount currently available to be sent on the
|
|
607
|
+
* Lightning network. We remove from the balance all the funds that are temporarily locked
|
|
608
|
+
* (e.g. channel reserves).
|
|
476
609
|
**/
|
|
477
610
|
availableToSendBalance: CurrencyAmount;
|
|
478
611
|
/**
|
|
479
|
-
* This represents the balance that should be displayed when asked "how much money can I
|
|
480
|
-
* the Bitcoin network right now?".
|
|
481
|
-
*
|
|
482
|
-
*
|
|
612
|
+
* This represents the balance that should be displayed when asked "how much money can I
|
|
613
|
+
* withdraw on the Bitcoin network right now?".
|
|
614
|
+
* It represents the amount currently available to withdraw and is usually equal to the
|
|
615
|
+
* `owned_balance` but it does not include in-flight operations (which would likely succeed and
|
|
616
|
+
* therefore likely make your withdrawal fail).
|
|
483
617
|
**/
|
|
484
618
|
availableToWithdrawBalance: CurrencyAmount;
|
|
485
619
|
}
|
|
@@ -502,8 +636,9 @@ interface BlockchainBalance {
|
|
|
502
636
|
|
|
503
637
|
interface LightsparkNodeToChannelsConnection {
|
|
504
638
|
/**
|
|
505
|
-
* The total count of objects in this connection, using the current filters.
|
|
506
|
-
* number of objects returned in the current page (in the `entities`
|
|
639
|
+
* The total count of objects in this connection, using the current filters.
|
|
640
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
641
|
+
* field).
|
|
507
642
|
**/
|
|
508
643
|
count: number;
|
|
509
644
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -522,22 +657,30 @@ interface NodeAddress {
|
|
|
522
657
|
type: NodeAddressType;
|
|
523
658
|
}
|
|
524
659
|
|
|
525
|
-
/**
|
|
660
|
+
/**
|
|
661
|
+
* A connection between a node and the addresses it has announced for itself on Lightning Network.
|
|
662
|
+
* *
|
|
663
|
+
*/
|
|
526
664
|
interface NodeToAddressesConnection {
|
|
527
665
|
/**
|
|
528
|
-
* The total count of objects in this connection, using the current filters.
|
|
529
|
-
* number of objects returned in the current page (in the `entities`
|
|
666
|
+
* The total count of objects in this connection, using the current filters.
|
|
667
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
668
|
+
* field).
|
|
530
669
|
**/
|
|
531
670
|
count: number;
|
|
532
671
|
/** The addresses for the current page of this connection. **/
|
|
533
672
|
entities: NodeAddress[];
|
|
534
673
|
}
|
|
535
674
|
|
|
536
|
-
/**
|
|
675
|
+
/**
|
|
676
|
+
* This is an object representing a node managed by Lightspark and owned by the current connected
|
|
677
|
+
* account. This object contains information about the node’s configuration, state, and metadata.
|
|
678
|
+
* *
|
|
679
|
+
*/
|
|
537
680
|
interface LightsparkNode {
|
|
538
681
|
/**
|
|
539
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
540
|
-
* string.
|
|
682
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
683
|
+
* Should be treated as an opaque string.
|
|
541
684
|
**/
|
|
542
685
|
id: string;
|
|
543
686
|
/** The date and time when the entity was first created. **/
|
|
@@ -547,8 +690,8 @@ interface LightsparkNode {
|
|
|
547
690
|
/** The Bitcoin Network this node is deployed in. **/
|
|
548
691
|
bitcoinNetwork: BitcoinNetwork;
|
|
549
692
|
/**
|
|
550
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
551
|
-
* on the data available for this node.
|
|
693
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
694
|
+
* depending on the data available for this node.
|
|
552
695
|
**/
|
|
553
696
|
displayName: string;
|
|
554
697
|
/** The owner of this LightsparkNode. **/
|
|
@@ -561,14 +704,15 @@ interface LightsparkNode {
|
|
|
561
704
|
/** The typename of the object **/
|
|
562
705
|
typename: string;
|
|
563
706
|
/**
|
|
564
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
565
|
-
* way to identify and search for commercial services or popular nodes.
|
|
566
|
-
* any time by the node operator.
|
|
707
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
708
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
709
|
+
* This alias can be changed at any time by the node operator.
|
|
567
710
|
**/
|
|
568
711
|
alias?: string | undefined;
|
|
569
712
|
/**
|
|
570
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
571
|
-
* has no importance in terms of operating the node,
|
|
713
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
714
|
+
* white. It has no importance in terms of operating the node,
|
|
715
|
+
* it is just a way to visually differentiate nodes.
|
|
572
716
|
* That color can be changed at any time by the node operator.
|
|
573
717
|
**/
|
|
574
718
|
color?: string | undefined;
|
|
@@ -578,12 +722,16 @@ interface LightsparkNode {
|
|
|
578
722
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
579
723
|
**/
|
|
580
724
|
conductivity?: number | undefined;
|
|
581
|
-
/**
|
|
725
|
+
/**
|
|
726
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
727
|
+
* Network. *
|
|
728
|
+
*/
|
|
582
729
|
publicKey?: string | undefined;
|
|
583
730
|
/** The current status of this node. **/
|
|
584
731
|
status?: LightsparkNodeStatus | undefined;
|
|
585
732
|
/**
|
|
586
|
-
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
733
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
734
|
+
* node.
|
|
587
735
|
*
|
|
588
736
|
* @deprecated Use `balances` instead.
|
|
589
737
|
**/
|
|
@@ -622,8 +770,9 @@ declare const getLightsparkNodeQuery: (id: string) => Query<LightsparkNode>;
|
|
|
622
770
|
/** A connection between an account and the nodes it manages. **/
|
|
623
771
|
interface AccountToNodesConnection {
|
|
624
772
|
/**
|
|
625
|
-
* The total count of objects in this connection, using the current filters.
|
|
626
|
-
* number of objects returned in the current page (in the `entities`
|
|
773
|
+
* The total count of objects in this connection, using the current filters.
|
|
774
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
775
|
+
* field).
|
|
627
776
|
**/
|
|
628
777
|
count: number;
|
|
629
778
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -634,7 +783,11 @@ interface AccountToNodesConnection {
|
|
|
634
783
|
typename: string;
|
|
635
784
|
}
|
|
636
785
|
|
|
637
|
-
/**
|
|
786
|
+
/**
|
|
787
|
+
* This object is an interface of a payment request on the Lightning Network (i.e., a Lightning
|
|
788
|
+
* Invoice). It contains data related to parsing the payment details of a Lightning Invoice.
|
|
789
|
+
* *
|
|
790
|
+
*/
|
|
638
791
|
interface PaymentRequestData {
|
|
639
792
|
encodedPaymentRequest: string;
|
|
640
793
|
bitcoinNetwork: BitcoinNetwork;
|
|
@@ -642,7 +795,10 @@ interface PaymentRequestData {
|
|
|
642
795
|
typename: string;
|
|
643
796
|
}
|
|
644
797
|
|
|
645
|
-
/**
|
|
798
|
+
/**
|
|
799
|
+
* This is an enum of the potential states that a payment request on the Lightning Network can
|
|
800
|
+
* take. *
|
|
801
|
+
*/
|
|
646
802
|
declare enum PaymentRequestStatus {
|
|
647
803
|
/**
|
|
648
804
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -653,11 +809,15 @@ declare enum PaymentRequestStatus {
|
|
|
653
809
|
CLOSED = "CLOSED"
|
|
654
810
|
}
|
|
655
811
|
|
|
656
|
-
/**
|
|
812
|
+
/**
|
|
813
|
+
* This object contains information related to a payment request generated or received by a
|
|
814
|
+
* LightsparkNode. You can retrieve this object to receive payment information about a specific
|
|
815
|
+
* invoice. *
|
|
816
|
+
*/
|
|
657
817
|
interface PaymentRequest {
|
|
658
818
|
/**
|
|
659
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
660
|
-
* string.
|
|
819
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
820
|
+
* Should be treated as an opaque string.
|
|
661
821
|
**/
|
|
662
822
|
id: string;
|
|
663
823
|
/** The date and time when the entity was first created. **/
|
|
@@ -675,8 +835,9 @@ declare const getPaymentRequestQuery: (id: string) => Query<PaymentRequest>;
|
|
|
675
835
|
|
|
676
836
|
interface AccountToPaymentRequestsConnection {
|
|
677
837
|
/**
|
|
678
|
-
* The total count of objects in this connection, using the current filters.
|
|
679
|
-
* number of objects returned in the current page (in the `entities`
|
|
838
|
+
* The total count of objects in this connection, using the current filters.
|
|
839
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
840
|
+
* field).
|
|
680
841
|
**/
|
|
681
842
|
count: number;
|
|
682
843
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -687,7 +848,10 @@ interface AccountToPaymentRequestsConnection {
|
|
|
687
848
|
typename: string;
|
|
688
849
|
}
|
|
689
850
|
|
|
690
|
-
/**
|
|
851
|
+
/**
|
|
852
|
+
* This is an enum of the potential statuses a transaction associated with your Lightspark Node can
|
|
853
|
+
* take. *
|
|
854
|
+
*/
|
|
691
855
|
declare enum TransactionStatus {
|
|
692
856
|
/**
|
|
693
857
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -700,7 +864,10 @@ declare enum TransactionStatus {
|
|
|
700
864
|
FAILED = "FAILED",
|
|
701
865
|
/** Transaction has been initiated and is currently in-flight. **/
|
|
702
866
|
PENDING = "PENDING",
|
|
703
|
-
/**
|
|
867
|
+
/**
|
|
868
|
+
* For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
|
|
869
|
+
* *
|
|
870
|
+
*/
|
|
704
871
|
NOT_STARTED = "NOT_STARTED",
|
|
705
872
|
/** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/
|
|
706
873
|
EXPIRED = "EXPIRED",
|
|
@@ -708,11 +875,16 @@ declare enum TransactionStatus {
|
|
|
708
875
|
CANCELLED = "CANCELLED"
|
|
709
876
|
}
|
|
710
877
|
|
|
711
|
-
/**
|
|
878
|
+
/**
|
|
879
|
+
* This object represents a payment transaction. The transaction can occur either on a Bitcoin
|
|
880
|
+
* Network, or over the Lightning Network. You can retrieve this object to receive specific
|
|
881
|
+
* information about a particular transaction tied to your Lightspark Node.
|
|
882
|
+
* *
|
|
883
|
+
*/
|
|
712
884
|
interface Transaction {
|
|
713
885
|
/**
|
|
714
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
715
|
-
* string.
|
|
886
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
887
|
+
* Should be treated as an opaque string.
|
|
716
888
|
**/
|
|
717
889
|
id: string;
|
|
718
890
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -734,8 +906,9 @@ declare const getTransactionQuery: (id: string) => Query<Transaction>;
|
|
|
734
906
|
|
|
735
907
|
interface AccountToTransactionsConnection {
|
|
736
908
|
/**
|
|
737
|
-
* The total count of objects in this connection, using the current filters.
|
|
738
|
-
* number of objects returned in the current page (in the `entities`
|
|
909
|
+
* The total count of objects in this connection, using the current filters.
|
|
910
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
911
|
+
* field).
|
|
739
912
|
**/
|
|
740
913
|
count: number;
|
|
741
914
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -745,13 +918,13 @@ interface AccountToTransactionsConnection {
|
|
|
745
918
|
/** The typename of the object **/
|
|
746
919
|
typename: string;
|
|
747
920
|
/**
|
|
748
|
-
* Profit (or loss) generated by the transactions in this connection,
|
|
749
|
-
* constraints provided.
|
|
921
|
+
* Profit (or loss) generated by the transactions in this connection,
|
|
922
|
+
* with the set of filters and constraints provided.
|
|
750
923
|
**/
|
|
751
924
|
profitLoss?: CurrencyAmount | undefined;
|
|
752
925
|
/**
|
|
753
|
-
* Average fee earned for the transactions in this connection,
|
|
754
|
-
* provided.
|
|
926
|
+
* Average fee earned for the transactions in this connection,
|
|
927
|
+
* with the set of filters and constraints provided.
|
|
755
928
|
**/
|
|
756
929
|
averageFeeEarned?: CurrencyAmount | undefined;
|
|
757
930
|
/**
|
|
@@ -764,8 +937,8 @@ interface AccountToTransactionsConnection {
|
|
|
764
937
|
/** This is an object representing the owner of a LightsparkNode. **/
|
|
765
938
|
interface LightsparkNodeOwner {
|
|
766
939
|
/**
|
|
767
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
768
|
-
* string.
|
|
940
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
941
|
+
* Should be treated as an opaque string.
|
|
769
942
|
**/
|
|
770
943
|
id: string;
|
|
771
944
|
/** The date and time when the entity was first created. **/
|
|
@@ -784,11 +957,18 @@ declare enum WalletStatus {
|
|
|
784
957
|
* Clients should support unknown values as more of them could be added without notice.
|
|
785
958
|
*/
|
|
786
959
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
787
|
-
/**
|
|
960
|
+
/**
|
|
961
|
+
* The wallet has not been set up yet and is ready to be deployed.
|
|
962
|
+
* This is the default status after the first login.
|
|
963
|
+
* *
|
|
964
|
+
*/
|
|
788
965
|
NOT_SETUP = "NOT_SETUP",
|
|
789
966
|
/** The wallet is currently being deployed in the Lightspark infrastructure. **/
|
|
790
967
|
DEPLOYING = "DEPLOYING",
|
|
791
|
-
/**
|
|
968
|
+
/**
|
|
969
|
+
* The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized.
|
|
970
|
+
* *
|
|
971
|
+
*/
|
|
792
972
|
DEPLOYED = "DEPLOYED",
|
|
793
973
|
/** The wallet is currently being initialized. **/
|
|
794
974
|
INITIALIZING = "INITIALIZING",
|
|
@@ -796,18 +976,26 @@ declare enum WalletStatus {
|
|
|
796
976
|
READY = "READY",
|
|
797
977
|
/** The wallet is temporarily available, due to a transient issue or a scheduled maintenance. **/
|
|
798
978
|
UNAVAILABLE = "UNAVAILABLE",
|
|
799
|
-
/**
|
|
979
|
+
/**
|
|
980
|
+
* The wallet had an unrecoverable failure. This status is not expected to happend and will be
|
|
981
|
+
* investigated by the Lightspark team. *
|
|
982
|
+
*/
|
|
800
983
|
FAILED = "FAILED",
|
|
801
984
|
/** The wallet is being terminated. **/
|
|
802
985
|
TERMINATING = "TERMINATING",
|
|
803
|
-
/**
|
|
986
|
+
/**
|
|
987
|
+
* The wallet has been terminated and is not available in the Lightspark infrastructure anymore.
|
|
988
|
+
* It is not connected to the Lightning network and its funds can only be accessed using the Funds
|
|
989
|
+
* Recovery flow. *
|
|
990
|
+
*/
|
|
804
991
|
TERMINATED = "TERMINATED"
|
|
805
992
|
}
|
|
806
993
|
|
|
807
994
|
interface WalletToPaymentRequestsConnection {
|
|
808
995
|
/**
|
|
809
|
-
* The total count of objects in this connection, using the current filters.
|
|
810
|
-
* number of objects returned in the current page (in the `entities`
|
|
996
|
+
* The total count of objects in this connection, using the current filters.
|
|
997
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
998
|
+
* field).
|
|
811
999
|
**/
|
|
812
1000
|
count: number;
|
|
813
1001
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -820,8 +1008,9 @@ interface WalletToPaymentRequestsConnection {
|
|
|
820
1008
|
|
|
821
1009
|
interface WalletToTransactionsConnection {
|
|
822
1010
|
/**
|
|
823
|
-
* The total count of objects in this connection, using the current filters.
|
|
824
|
-
* number of objects returned in the current page (in the `entities`
|
|
1011
|
+
* The total count of objects in this connection, using the current filters.
|
|
1012
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
1013
|
+
* field).
|
|
825
1014
|
**/
|
|
826
1015
|
count: number;
|
|
827
1016
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -832,18 +1021,26 @@ interface WalletToTransactionsConnection {
|
|
|
832
1021
|
typename: string;
|
|
833
1022
|
}
|
|
834
1023
|
|
|
835
|
-
/**
|
|
1024
|
+
/**
|
|
1025
|
+
* This object represents a Lightspark Wallet, tied to your Lightspark account.
|
|
1026
|
+
* Wallets can be used to send or receive funds over the Lightning Network.
|
|
1027
|
+
* You can retrieve this object to receive information about a specific wallet tied to your
|
|
1028
|
+
* Lightspark account. *
|
|
1029
|
+
*/
|
|
836
1030
|
declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
837
1031
|
/**
|
|
838
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
839
|
-
* string.
|
|
1032
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1033
|
+
* Should be treated as an opaque string.
|
|
840
1034
|
**/
|
|
841
1035
|
readonly id: string;
|
|
842
1036
|
/** The date and time when the entity was first created. **/
|
|
843
1037
|
readonly createdAt: string;
|
|
844
1038
|
/** The date and time when the entity was last updated. **/
|
|
845
1039
|
readonly updatedAt: string;
|
|
846
|
-
/**
|
|
1040
|
+
/**
|
|
1041
|
+
* The unique identifier of this wallet, as provided by the Lightspark Customer during login.
|
|
1042
|
+
* *
|
|
1043
|
+
*/
|
|
847
1044
|
readonly thirdPartyIdentifier: string;
|
|
848
1045
|
/** The status of this wallet. **/
|
|
849
1046
|
readonly status: WalletStatus;
|
|
@@ -857,15 +1054,18 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
|
857
1054
|
readonly accountId?: string | undefined;
|
|
858
1055
|
constructor(
|
|
859
1056
|
/**
|
|
860
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
861
|
-
* string.
|
|
1057
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1058
|
+
* Should be treated as an opaque string.
|
|
862
1059
|
**/
|
|
863
1060
|
id: string,
|
|
864
1061
|
/** The date and time when the entity was first created. **/
|
|
865
1062
|
createdAt: string,
|
|
866
1063
|
/** The date and time when the entity was last updated. **/
|
|
867
1064
|
updatedAt: string,
|
|
868
|
-
/**
|
|
1065
|
+
/**
|
|
1066
|
+
* The unique identifier of this wallet, as provided by the Lightspark Customer during login.
|
|
1067
|
+
* *
|
|
1068
|
+
*/
|
|
869
1069
|
thirdPartyIdentifier: string,
|
|
870
1070
|
/** The status of this wallet. **/
|
|
871
1071
|
status: WalletStatus,
|
|
@@ -899,8 +1099,9 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
|
899
1099
|
|
|
900
1100
|
interface AccountToWalletsConnection {
|
|
901
1101
|
/**
|
|
902
|
-
* The total count of objects in this connection, using the current filters.
|
|
903
|
-
* number of objects returned in the current page (in the `entities`
|
|
1102
|
+
* The total count of objects in this connection, using the current filters.
|
|
1103
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
1104
|
+
* field).
|
|
904
1105
|
**/
|
|
905
1106
|
count: number;
|
|
906
1107
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -911,7 +1112,10 @@ interface AccountToWalletsConnection {
|
|
|
911
1112
|
typename: string;
|
|
912
1113
|
}
|
|
913
1114
|
|
|
914
|
-
/**
|
|
1115
|
+
/**
|
|
1116
|
+
* This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may
|
|
1117
|
+
* have failed. *
|
|
1118
|
+
*/
|
|
915
1119
|
declare enum PaymentFailureReason {
|
|
916
1120
|
/**
|
|
917
1121
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -930,7 +1134,10 @@ declare enum PaymentFailureReason {
|
|
|
930
1134
|
RISK_SCREENING_FAILED = "RISK_SCREENING_FAILED"
|
|
931
1135
|
}
|
|
932
1136
|
|
|
933
|
-
/**
|
|
1137
|
+
/**
|
|
1138
|
+
* This is an enum of the potential reasons that an attempted routed transaction through a
|
|
1139
|
+
* Lightspark node may have failed. *
|
|
1140
|
+
*/
|
|
934
1141
|
declare enum RoutingTransactionFailureReason {
|
|
935
1142
|
/**
|
|
936
1143
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -948,11 +1155,15 @@ interface TransactionFailures {
|
|
|
948
1155
|
routingTransactionFailures?: RoutingTransactionFailureReason[] | undefined;
|
|
949
1156
|
}
|
|
950
1157
|
|
|
951
|
-
/**
|
|
1158
|
+
/**
|
|
1159
|
+
* This is an object representing the connected Lightspark account.
|
|
1160
|
+
* You can retrieve this object to see your account information and objects tied to your account.
|
|
1161
|
+
* *
|
|
1162
|
+
*/
|
|
952
1163
|
declare class Account implements LightsparkNodeOwner, Entity {
|
|
953
1164
|
/**
|
|
954
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
955
|
-
* string.
|
|
1165
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1166
|
+
* Should be treated as an opaque string.
|
|
956
1167
|
**/
|
|
957
1168
|
readonly id: string;
|
|
958
1169
|
/** The date and time when the entity was first created. **/
|
|
@@ -965,8 +1176,8 @@ declare class Account implements LightsparkNodeOwner, Entity {
|
|
|
965
1176
|
readonly name?: string | undefined;
|
|
966
1177
|
constructor(
|
|
967
1178
|
/**
|
|
968
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
969
|
-
* string.
|
|
1179
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1180
|
+
* Should be treated as an opaque string.
|
|
970
1181
|
**/
|
|
971
1182
|
id: string,
|
|
972
1183
|
/** The date and time when the entity was first created. **/
|
|
@@ -1002,14 +1213,18 @@ interface CreateApiTokenOutput {
|
|
|
1002
1213
|
/** The API Token that has been created. **/
|
|
1003
1214
|
apiToken: ApiToken;
|
|
1004
1215
|
/**
|
|
1005
|
-
* The secret that should be used to authenticate against our API.
|
|
1006
|
-
* never be available again after this.
|
|
1007
|
-
* account.
|
|
1216
|
+
* The secret that should be used to authenticate against our API.
|
|
1217
|
+
* This secret is not stored and will never be available again after this.
|
|
1218
|
+
* You must keep this secret secure as it grants access to your account.
|
|
1008
1219
|
**/
|
|
1009
1220
|
clientSecret: string;
|
|
1010
1221
|
}
|
|
1011
1222
|
|
|
1012
|
-
/**
|
|
1223
|
+
/**
|
|
1224
|
+
* This object represents the estimated L1 transaction fees for the Bitcoin network.
|
|
1225
|
+
* Fee estimates are separated by potential confirmation speeds for settlement.
|
|
1226
|
+
* *
|
|
1227
|
+
*/
|
|
1013
1228
|
interface FeeEstimate {
|
|
1014
1229
|
feeFast: CurrencyAmount;
|
|
1015
1230
|
feeMin: CurrencyAmount;
|
|
@@ -1028,11 +1243,15 @@ declare enum IncomingPaymentAttemptStatus {
|
|
|
1028
1243
|
UNKNOWN = "UNKNOWN"
|
|
1029
1244
|
}
|
|
1030
1245
|
|
|
1031
|
-
/**
|
|
1246
|
+
/**
|
|
1247
|
+
* This object represents any attempted payment sent to a Lightspark node on the Lightning Network.
|
|
1248
|
+
* You can retrieve this object to receive payment related information about a specific incoming
|
|
1249
|
+
* payment attempt. *
|
|
1250
|
+
*/
|
|
1032
1251
|
interface IncomingPaymentAttempt {
|
|
1033
1252
|
/**
|
|
1034
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1035
|
-
* string.
|
|
1253
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1254
|
+
* Should be treated as an opaque string.
|
|
1036
1255
|
**/
|
|
1037
1256
|
id: string;
|
|
1038
1257
|
/** The date and time when the entity was first created. **/
|
|
@@ -1055,8 +1274,9 @@ declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaym
|
|
|
1055
1274
|
/** The connection from incoming payment to all attempts. **/
|
|
1056
1275
|
interface IncomingPaymentToAttemptsConnection {
|
|
1057
1276
|
/**
|
|
1058
|
-
* The total count of objects in this connection, using the current filters.
|
|
1059
|
-
* number of objects returned in the current page (in the `entities`
|
|
1277
|
+
* The total count of objects in this connection, using the current filters.
|
|
1278
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
1279
|
+
* field).
|
|
1060
1280
|
**/
|
|
1061
1281
|
count: number;
|
|
1062
1282
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -1067,11 +1287,15 @@ interface IncomingPaymentToAttemptsConnection {
|
|
|
1067
1287
|
typename: string;
|
|
1068
1288
|
}
|
|
1069
1289
|
|
|
1070
|
-
/**
|
|
1290
|
+
/**
|
|
1291
|
+
* This is an object representing a transaction made over the Lightning Network.
|
|
1292
|
+
* You can retrieve this object to receive information about a specific transaction made over
|
|
1293
|
+
* Lightning for a Lightspark node. *
|
|
1294
|
+
*/
|
|
1071
1295
|
interface LightningTransaction {
|
|
1072
1296
|
/**
|
|
1073
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1074
|
-
* string.
|
|
1297
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1298
|
+
* Should be treated as an opaque string.
|
|
1075
1299
|
**/
|
|
1076
1300
|
id: string;
|
|
1077
1301
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1102,11 +1326,15 @@ interface PostTransactionData {
|
|
|
1102
1326
|
amount: CurrencyAmount;
|
|
1103
1327
|
}
|
|
1104
1328
|
|
|
1105
|
-
/**
|
|
1329
|
+
/**
|
|
1330
|
+
* This object represents any payment sent to a Lightspark node on the Lightning Network.
|
|
1331
|
+
* You can retrieve this object to receive payment related information about a specific payment
|
|
1332
|
+
* received by a Lightspark node. *
|
|
1333
|
+
*/
|
|
1106
1334
|
declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
|
|
1107
1335
|
/**
|
|
1108
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1109
|
-
* string.
|
|
1336
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1337
|
+
* Should be treated as an opaque string.
|
|
1110
1338
|
**/
|
|
1111
1339
|
readonly id: string;
|
|
1112
1340
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1126,16 +1354,16 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1126
1354
|
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1127
1355
|
readonly transactionHash?: string | undefined;
|
|
1128
1356
|
/**
|
|
1129
|
-
* The optional payment request for this incoming payment,
|
|
1130
|
-
* through keysend.
|
|
1357
|
+
* The optional payment request for this incoming payment,
|
|
1358
|
+
* which will be null if the payment is sent through keysend.
|
|
1131
1359
|
**/
|
|
1132
1360
|
readonly paymentRequestId?: string | undefined;
|
|
1133
1361
|
/** The post transaction data which can be used in KYT payment registration. **/
|
|
1134
1362
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
1135
1363
|
constructor(
|
|
1136
1364
|
/**
|
|
1137
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1138
|
-
* string.
|
|
1365
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1366
|
+
* Should be treated as an opaque string.
|
|
1139
1367
|
**/
|
|
1140
1368
|
id: string,
|
|
1141
1369
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1155,8 +1383,8 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1155
1383
|
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1156
1384
|
transactionHash?: string | undefined,
|
|
1157
1385
|
/**
|
|
1158
|
-
* The optional payment request for this incoming payment,
|
|
1159
|
-
* through keysend.
|
|
1386
|
+
* The optional payment request for this incoming payment,
|
|
1387
|
+
* which will be null if the payment is sent through keysend.
|
|
1160
1388
|
**/
|
|
1161
1389
|
paymentRequestId?: string | undefined,
|
|
1162
1390
|
/** The post transaction data which can be used in KYT payment registration. **/
|
|
@@ -1182,11 +1410,15 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1182
1410
|
};
|
|
1183
1411
|
}
|
|
1184
1412
|
|
|
1185
|
-
/**
|
|
1413
|
+
/**
|
|
1414
|
+
* This object is an interface representing a Lightning Node on the Lightning Network,
|
|
1415
|
+
* and could either be a Lightspark node or a node managed by a third party.
|
|
1416
|
+
* *
|
|
1417
|
+
*/
|
|
1186
1418
|
interface Node {
|
|
1187
1419
|
/**
|
|
1188
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1189
|
-
* string.
|
|
1420
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1421
|
+
* Should be treated as an opaque string.
|
|
1190
1422
|
**/
|
|
1191
1423
|
id: string;
|
|
1192
1424
|
/** The date and time when the entity was first created. **/
|
|
@@ -1196,21 +1428,22 @@ interface Node {
|
|
|
1196
1428
|
/** The Bitcoin Network this node is deployed in. **/
|
|
1197
1429
|
bitcoinNetwork: BitcoinNetwork;
|
|
1198
1430
|
/**
|
|
1199
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
1200
|
-
* on the data available for this node.
|
|
1431
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
1432
|
+
* depending on the data available for this node.
|
|
1201
1433
|
**/
|
|
1202
1434
|
displayName: string;
|
|
1203
1435
|
/** The typename of the object **/
|
|
1204
1436
|
typename: string;
|
|
1205
1437
|
/**
|
|
1206
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
1207
|
-
* way to identify and search for commercial services or popular nodes.
|
|
1208
|
-
* any time by the node operator.
|
|
1438
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
1439
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
1440
|
+
* This alias can be changed at any time by the node operator.
|
|
1209
1441
|
**/
|
|
1210
1442
|
alias?: string | undefined;
|
|
1211
1443
|
/**
|
|
1212
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
1213
|
-
* has no importance in terms of operating the node,
|
|
1444
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
1445
|
+
* white. It has no importance in terms of operating the node,
|
|
1446
|
+
* it is just a way to visually differentiate nodes.
|
|
1214
1447
|
* That color can be changed at any time by the node operator.
|
|
1215
1448
|
**/
|
|
1216
1449
|
color?: string | undefined;
|
|
@@ -1220,21 +1453,28 @@ interface Node {
|
|
|
1220
1453
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
1221
1454
|
**/
|
|
1222
1455
|
conductivity?: number | undefined;
|
|
1223
|
-
/**
|
|
1456
|
+
/**
|
|
1457
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
1458
|
+
* Network. *
|
|
1459
|
+
*/
|
|
1224
1460
|
publicKey?: string | undefined;
|
|
1225
1461
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
1226
1462
|
}
|
|
1227
1463
|
declare const getNodeQuery: (id: string) => Query<Node>;
|
|
1228
1464
|
|
|
1229
|
-
/**
|
|
1465
|
+
/**
|
|
1466
|
+
* This object represents the data associated with a BOLT #11 invoice.
|
|
1467
|
+
* You can retrieve this object to receive the relevant data associated with a specific invoice.
|
|
1468
|
+
* *
|
|
1469
|
+
*/
|
|
1230
1470
|
interface InvoiceData {
|
|
1231
1471
|
encodedPaymentRequest: string;
|
|
1232
1472
|
bitcoinNetwork: BitcoinNetwork;
|
|
1233
1473
|
/** The payment hash of this invoice. **/
|
|
1234
1474
|
paymentHash: string;
|
|
1235
1475
|
/**
|
|
1236
|
-
* The requested amount in this invoice. If it is equal to 0,
|
|
1237
|
-
* send.
|
|
1476
|
+
* The requested amount in this invoice. If it is equal to 0,
|
|
1477
|
+
* the sender should choose the amount to send.
|
|
1238
1478
|
**/
|
|
1239
1479
|
amount: CurrencyAmount;
|
|
1240
1480
|
/** The date and time when this invoice was created. **/
|
|
@@ -1252,8 +1492,8 @@ interface InvoiceData {
|
|
|
1252
1492
|
/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node. **/
|
|
1253
1493
|
interface Invoice {
|
|
1254
1494
|
/**
|
|
1255
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1256
|
-
* string.
|
|
1495
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1496
|
+
* Should be treated as an opaque string.
|
|
1257
1497
|
**/
|
|
1258
1498
|
id: string;
|
|
1259
1499
|
/** The date and time when the entity was first created. **/
|
|
@@ -1294,7 +1534,10 @@ interface ChannelSnapshot {
|
|
|
1294
1534
|
remoteUnsettledBalance?: CurrencyAmount | undefined;
|
|
1295
1535
|
}
|
|
1296
1536
|
|
|
1297
|
-
/**
|
|
1537
|
+
/**
|
|
1538
|
+
* This is an enum representing a particular reason why an htlc sent over the Lightning Network may
|
|
1539
|
+
* have failed. *
|
|
1540
|
+
*/
|
|
1298
1541
|
declare enum HtlcAttemptFailureCode {
|
|
1299
1542
|
/**
|
|
1300
1543
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -1343,11 +1586,16 @@ declare enum OutgoingPaymentAttemptStatus {
|
|
|
1343
1586
|
FAILED = "FAILED"
|
|
1344
1587
|
}
|
|
1345
1588
|
|
|
1346
|
-
/**
|
|
1589
|
+
/**
|
|
1590
|
+
* This object represents a specific node that existed on a particular payment route.
|
|
1591
|
+
* You can retrieve this object to get information about a node on a particular payment path and
|
|
1592
|
+
* all payment-relevant information for that node.
|
|
1593
|
+
* *
|
|
1594
|
+
*/
|
|
1347
1595
|
interface Hop {
|
|
1348
1596
|
/**
|
|
1349
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1350
|
-
* string.
|
|
1597
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1598
|
+
* Should be treated as an opaque string.
|
|
1351
1599
|
**/
|
|
1352
1600
|
id: string;
|
|
1353
1601
|
/** The date and time when the entity was first created. **/
|
|
@@ -1371,11 +1619,15 @@ interface Hop {
|
|
|
1371
1619
|
}
|
|
1372
1620
|
declare const getHopQuery: (id: string) => Query<Hop>;
|
|
1373
1621
|
|
|
1374
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* The connection from an outgoing payment attempt to the list of sequential hops that define the
|
|
1624
|
+
* path from sender node to recipient node. *
|
|
1625
|
+
*/
|
|
1375
1626
|
interface OutgoingPaymentAttemptToHopsConnection {
|
|
1376
1627
|
/**
|
|
1377
|
-
* The total count of objects in this connection, using the current filters.
|
|
1378
|
-
* number of objects returned in the current page (in the `entities`
|
|
1628
|
+
* The total count of objects in this connection, using the current filters.
|
|
1629
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
1630
|
+
* field).
|
|
1379
1631
|
**/
|
|
1380
1632
|
count: number;
|
|
1381
1633
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -1386,11 +1638,17 @@ interface OutgoingPaymentAttemptToHopsConnection {
|
|
|
1386
1638
|
typename: string;
|
|
1387
1639
|
}
|
|
1388
1640
|
|
|
1389
|
-
/**
|
|
1641
|
+
/**
|
|
1642
|
+
* This object represents an attempted Lightning Network payment sent from a Lightspark Node.
|
|
1643
|
+
* You can retrieve this object to receive payment related information about any payment attempt
|
|
1644
|
+
* sent from your Lightspark Node on the Lightning Network,
|
|
1645
|
+
* including any potential reasons the payment may have failed.
|
|
1646
|
+
* *
|
|
1647
|
+
*/
|
|
1390
1648
|
declare class OutgoingPaymentAttempt implements Entity {
|
|
1391
1649
|
/**
|
|
1392
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1393
|
-
* string.
|
|
1650
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1651
|
+
* Should be treated as an opaque string.
|
|
1394
1652
|
**/
|
|
1395
1653
|
readonly id: string;
|
|
1396
1654
|
/** The date and time when the entity was first created. **/
|
|
@@ -1415,23 +1673,24 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1415
1673
|
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1416
1674
|
readonly resolvedAt?: string | undefined;
|
|
1417
1675
|
/**
|
|
1418
|
-
* The total amount of funds required to complete a payment over this route.
|
|
1419
|
-
* cumulative fees for each hop. As a result,
|
|
1420
|
-
*
|
|
1421
|
-
* an insufficient amount.
|
|
1676
|
+
* The total amount of funds required to complete a payment over this route.
|
|
1677
|
+
* This value includes the cumulative fees for each hop. As a result,
|
|
1678
|
+
* the attempt extended to the first-hop in the route will need to have at least this much
|
|
1679
|
+
* value, otherwise the route will fail at an intermediate node due to an insufficient amount.
|
|
1422
1680
|
**/
|
|
1423
1681
|
readonly amount?: CurrencyAmount | undefined;
|
|
1424
1682
|
/**
|
|
1425
|
-
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1426
|
-
* payment, this value will be zero as we don't need to pay a fee to
|
|
1683
|
+
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1684
|
+
* In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to
|
|
1685
|
+
* ourselves.
|
|
1427
1686
|
**/
|
|
1428
1687
|
readonly fees?: CurrencyAmount | undefined;
|
|
1429
1688
|
/** The channel snapshot at the time the outgoing payment attempt was made. **/
|
|
1430
1689
|
readonly channelSnapshot?: ChannelSnapshot | undefined;
|
|
1431
1690
|
constructor(
|
|
1432
1691
|
/**
|
|
1433
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1434
|
-
* string.
|
|
1692
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1693
|
+
* Should be treated as an opaque string.
|
|
1435
1694
|
**/
|
|
1436
1695
|
id: string,
|
|
1437
1696
|
/** The date and time when the entity was first created. **/
|
|
@@ -1456,15 +1715,16 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1456
1715
|
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1457
1716
|
resolvedAt?: string | undefined,
|
|
1458
1717
|
/**
|
|
1459
|
-
* The total amount of funds required to complete a payment over this route.
|
|
1460
|
-
* cumulative fees for each hop. As a result,
|
|
1461
|
-
*
|
|
1462
|
-
* an insufficient amount.
|
|
1718
|
+
* The total amount of funds required to complete a payment over this route.
|
|
1719
|
+
* This value includes the cumulative fees for each hop. As a result,
|
|
1720
|
+
* the attempt extended to the first-hop in the route will need to have at least this much
|
|
1721
|
+
* value, otherwise the route will fail at an intermediate node due to an insufficient amount.
|
|
1463
1722
|
**/
|
|
1464
1723
|
amount?: CurrencyAmount | undefined,
|
|
1465
1724
|
/**
|
|
1466
|
-
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1467
|
-
* payment, this value will be zero as we don't need to pay a fee to
|
|
1725
|
+
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1726
|
+
* In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to
|
|
1727
|
+
* ourselves.
|
|
1468
1728
|
**/
|
|
1469
1729
|
fees?: CurrencyAmount | undefined,
|
|
1470
1730
|
/** The channel snapshot at the time the outgoing payment attempt was made. **/
|
|
@@ -1493,8 +1753,9 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1493
1753
|
/** The connection from outgoing payment to all attempts. **/
|
|
1494
1754
|
interface OutgoingPaymentToAttemptsConnection {
|
|
1495
1755
|
/**
|
|
1496
|
-
* The total count of objects in this connection, using the current filters.
|
|
1497
|
-
* number of objects returned in the current page (in the `entities`
|
|
1756
|
+
* The total count of objects in this connection, using the current filters.
|
|
1757
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
1758
|
+
* field).
|
|
1498
1759
|
**/
|
|
1499
1760
|
count: number;
|
|
1500
1761
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -1509,11 +1770,16 @@ interface RichText {
|
|
|
1509
1770
|
text: string;
|
|
1510
1771
|
}
|
|
1511
1772
|
|
|
1512
|
-
/**
|
|
1773
|
+
/**
|
|
1774
|
+
* This object represents a Lightning Network payment sent from a Lightspark Node.
|
|
1775
|
+
* You can retrieve this object to receive payment related information about any payment sent from
|
|
1776
|
+
* your Lightspark Node on the Lightning Network.
|
|
1777
|
+
* *
|
|
1778
|
+
*/
|
|
1513
1779
|
declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
|
|
1514
1780
|
/**
|
|
1515
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1516
|
-
* string.
|
|
1781
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1782
|
+
* Should be treated as an opaque string.
|
|
1517
1783
|
**/
|
|
1518
1784
|
readonly id: string;
|
|
1519
1785
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1548,8 +1814,8 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1548
1814
|
readonly paymentPreimage?: string | undefined;
|
|
1549
1815
|
constructor(
|
|
1550
1816
|
/**
|
|
1551
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1552
|
-
* string.
|
|
1817
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1818
|
+
* Should be treated as an opaque string.
|
|
1553
1819
|
**/
|
|
1554
1820
|
id: string,
|
|
1555
1821
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2140,8 +2406,8 @@ type SingleNodeDashboard = {
|
|
|
2140
2406
|
|
|
2141
2407
|
type TransactionUpdate = {
|
|
2142
2408
|
/**
|
|
2143
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2144
|
-
* string.
|
|
2409
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2410
|
+
* Should be treated as an opaque string.
|
|
2145
2411
|
**/
|
|
2146
2412
|
id: string;
|
|
2147
2413
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2156,7 +2422,10 @@ type TransactionUpdate = {
|
|
|
2156
2422
|
typename: string;
|
|
2157
2423
|
/** The date and time when this transaction was completed or failed. **/
|
|
2158
2424
|
resolvedAt?: string;
|
|
2159
|
-
/**
|
|
2425
|
+
/**
|
|
2426
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2427
|
+
* Lightning Network. *
|
|
2428
|
+
*/
|
|
2160
2429
|
transactionHash?: string;
|
|
2161
2430
|
};
|
|
2162
2431
|
|
|
@@ -2167,17 +2436,29 @@ declare enum IncentivesIneligibilityReason {
|
|
|
2167
2436
|
* Clients should support unknown values as more of them could be added without notice.
|
|
2168
2437
|
*/
|
|
2169
2438
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2170
|
-
/**
|
|
2439
|
+
/**
|
|
2440
|
+
* This invitation is not eligible for incentives because it has been created outside of the
|
|
2441
|
+
* incentives flow. *
|
|
2442
|
+
*/
|
|
2171
2443
|
DISABLED = "DISABLED",
|
|
2172
2444
|
/** This invitation is not eligible for incentives because the sender is not eligible. **/
|
|
2173
2445
|
SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
|
|
2174
2446
|
/** This invitation is not eligible for incentives because the receiver is not eligible. **/
|
|
2175
2447
|
RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
|
|
2176
|
-
/**
|
|
2448
|
+
/**
|
|
2449
|
+
* This invitation is not eligible for incentives because the sending VASP is not part of the
|
|
2450
|
+
* incentives program. *
|
|
2451
|
+
*/
|
|
2177
2452
|
SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
|
|
2178
|
-
/**
|
|
2453
|
+
/**
|
|
2454
|
+
* This invitation is not eligible for incentives because the receiving VASP is not part of the
|
|
2455
|
+
* incentives program. *
|
|
2456
|
+
*/
|
|
2179
2457
|
RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
|
|
2180
|
-
/**
|
|
2458
|
+
/**
|
|
2459
|
+
* This invitation is not eligible for incentives because the sender and receiver are in the same
|
|
2460
|
+
* region. *
|
|
2461
|
+
*/
|
|
2181
2462
|
NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
|
|
2182
2463
|
}
|
|
2183
2464
|
|
|
@@ -2188,19 +2469,26 @@ declare enum IncentivesStatus {
|
|
|
2188
2469
|
* Clients should support unknown values as more of them could be added without notice.
|
|
2189
2470
|
*/
|
|
2190
2471
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2191
|
-
/**
|
|
2472
|
+
/**
|
|
2473
|
+
* The invitation is eligible for incentives in its current state. When it is claimed, we will
|
|
2474
|
+
* reassess. *
|
|
2475
|
+
*/
|
|
2192
2476
|
PENDING = "PENDING",
|
|
2193
2477
|
/** The incentives have been validated. **/
|
|
2194
2478
|
VALIDATED = "VALIDATED",
|
|
2195
|
-
/**
|
|
2479
|
+
/**
|
|
2480
|
+
* This invitation is not eligible for incentives.
|
|
2481
|
+
* A more detailed reason can be found in the `incentives_ineligibility_reason` field.
|
|
2482
|
+
* *
|
|
2483
|
+
*/
|
|
2196
2484
|
INELIGIBLE = "INELIGIBLE"
|
|
2197
2485
|
}
|
|
2198
2486
|
|
|
2199
2487
|
/** This is an object representing an UMA.ME invitation. **/
|
|
2200
2488
|
interface UmaInvitation {
|
|
2201
2489
|
/**
|
|
2202
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2203
|
-
* string.
|
|
2490
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2491
|
+
* Should be treated as an opaque string.
|
|
2204
2492
|
**/
|
|
2205
2493
|
id: string;
|
|
2206
2494
|
/** The date and time when the entity was first created. **/
|
|
@@ -2248,11 +2536,15 @@ declare enum WithdrawalRequestStatus {
|
|
|
2248
2536
|
SUCCESSFUL = "SUCCESSFUL"
|
|
2249
2537
|
}
|
|
2250
2538
|
|
|
2251
|
-
/**
|
|
2539
|
+
/**
|
|
2540
|
+
* This is an object representing a transaction which closes a channel on the Lightning Network.
|
|
2541
|
+
* This operation allocates balances back to the local and remote nodes.
|
|
2542
|
+
* *
|
|
2543
|
+
*/
|
|
2252
2544
|
interface ChannelClosingTransaction {
|
|
2253
2545
|
/**
|
|
2254
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2255
|
-
* string.
|
|
2546
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2547
|
+
* Should be treated as an opaque string.
|
|
2256
2548
|
**/
|
|
2257
2549
|
id: string;
|
|
2258
2550
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2297,19 +2589,24 @@ interface WithdrawalRequestToChannelClosingTransactionsConnection {
|
|
|
2297
2589
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
2298
2590
|
pageInfo: PageInfo;
|
|
2299
2591
|
/**
|
|
2300
|
-
* The total count of objects in this connection, using the current filters.
|
|
2301
|
-
* number of objects returned in the current page (in the `entities`
|
|
2592
|
+
* The total count of objects in this connection, using the current filters.
|
|
2593
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
2594
|
+
* field).
|
|
2302
2595
|
**/
|
|
2303
2596
|
count: number;
|
|
2304
2597
|
/** The channel closing transactions for the current page of this connection. **/
|
|
2305
2598
|
entities: ChannelClosingTransaction[];
|
|
2306
2599
|
}
|
|
2307
2600
|
|
|
2308
|
-
/**
|
|
2601
|
+
/**
|
|
2602
|
+
* This is an object representing a transaction which opens a channel on the Lightning Network.
|
|
2603
|
+
* This object occurs only for channels funded by the local Lightspark node.
|
|
2604
|
+
* *
|
|
2605
|
+
*/
|
|
2309
2606
|
interface ChannelOpeningTransaction {
|
|
2310
2607
|
/**
|
|
2311
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2312
|
-
* string.
|
|
2608
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2609
|
+
* Should be treated as an opaque string.
|
|
2313
2610
|
**/
|
|
2314
2611
|
id: string;
|
|
2315
2612
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2354,19 +2651,25 @@ interface WithdrawalRequestToChannelOpeningTransactionsConnection {
|
|
|
2354
2651
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
2355
2652
|
pageInfo: PageInfo;
|
|
2356
2653
|
/**
|
|
2357
|
-
* The total count of objects in this connection, using the current filters.
|
|
2358
|
-
* number of objects returned in the current page (in the `entities`
|
|
2654
|
+
* The total count of objects in this connection, using the current filters.
|
|
2655
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
2656
|
+
* field).
|
|
2359
2657
|
**/
|
|
2360
2658
|
count: number;
|
|
2361
2659
|
/** The channel opening transactions for the current page of this connection. **/
|
|
2362
2660
|
entities: ChannelOpeningTransaction[];
|
|
2363
2661
|
}
|
|
2364
2662
|
|
|
2365
|
-
/**
|
|
2663
|
+
/**
|
|
2664
|
+
* This object represents a request made for an L1 withdrawal from your Lightspark Node to any
|
|
2665
|
+
* Bitcoin wallet. You can retrieve this object to receive detailed information about any
|
|
2666
|
+
* withdrawal request made from your Lightspark account.
|
|
2667
|
+
* *
|
|
2668
|
+
*/
|
|
2366
2669
|
declare class WithdrawalRequest implements Entity {
|
|
2367
2670
|
/**
|
|
2368
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2369
|
-
* string.
|
|
2671
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2672
|
+
* Should be treated as an opaque string.
|
|
2370
2673
|
**/
|
|
2371
2674
|
readonly id: string;
|
|
2372
2675
|
/** The date and time when the entity was first created. **/
|
|
@@ -2384,8 +2687,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2384
2687
|
/** The typename of the object **/
|
|
2385
2688
|
readonly typename: string;
|
|
2386
2689
|
/**
|
|
2387
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
2388
|
-
* for the withdrawal.
|
|
2690
|
+
* If the requested amount is `-1` (i.e. everything),
|
|
2691
|
+
* this field may contain an estimate of the amount for the withdrawal.
|
|
2389
2692
|
**/
|
|
2390
2693
|
readonly estimatedAmount?: CurrencyAmount | undefined;
|
|
2391
2694
|
/** The time at which this request was completed. **/
|
|
@@ -2394,8 +2697,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2394
2697
|
readonly withdrawalId?: string | undefined;
|
|
2395
2698
|
constructor(
|
|
2396
2699
|
/**
|
|
2397
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2398
|
-
* string.
|
|
2700
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2701
|
+
* Should be treated as an opaque string.
|
|
2399
2702
|
**/
|
|
2400
2703
|
id: string,
|
|
2401
2704
|
/** The date and time when the entity was first created. **/
|
|
@@ -2413,8 +2716,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2413
2716
|
/** The typename of the object **/
|
|
2414
2717
|
typename: string,
|
|
2415
2718
|
/**
|
|
2416
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
2417
|
-
* for the withdrawal.
|
|
2719
|
+
* If the requested amount is `-1` (i.e. everything),
|
|
2720
|
+
* this field may contain an estimate of the amount for the withdrawal.
|
|
2418
2721
|
**/
|
|
2419
2722
|
estimatedAmount?: CurrencyAmount | undefined,
|
|
2420
2723
|
/** The time at which this request was completed. **/
|
|
@@ -2442,28 +2745,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2442
2745
|
}
|
|
2443
2746
|
|
|
2444
2747
|
/**
|
|
2445
|
-
*
|
|
2446
|
-
|
|
2447
|
-
type SigningKeyLoaderArgs = NodeIdAndPasswordSigningKeyLoaderArgs | MasterSeedSigningKeyLoaderArgs;
|
|
2448
|
-
/**
|
|
2449
|
-
* Args for creating a new SigningKeyLoader from a node ID and password.
|
|
2450
|
-
* This cannot be used if you are using remote signing. It is used to recover an RSA operation signing key using
|
|
2451
|
-
* the password you chose when setting up your node. For REGTEST nodes, the password is "1234!@#$".
|
|
2452
|
-
*/
|
|
2453
|
-
interface NodeIdAndPasswordSigningKeyLoaderArgs {
|
|
2454
|
-
password: string;
|
|
2455
|
-
}
|
|
2456
|
-
/**
|
|
2457
|
-
* Args for creating a new SigningKeyLoader from a master seed and network.
|
|
2458
|
-
* This should be used if you are using remote signing, rather than an RSA operation signing key.
|
|
2459
|
-
*/
|
|
2460
|
-
interface MasterSeedSigningKeyLoaderArgs {
|
|
2461
|
-
masterSeed: Uint8Array;
|
|
2462
|
-
network: BitcoinNetwork;
|
|
2463
|
-
}
|
|
2464
|
-
|
|
2465
|
-
/**
|
|
2466
|
-
* The LightsparkClient is the main entrypoint for interacting with the Lightspark API.
|
|
2748
|
+
* The LightsparkClient is the main entrypoint for interacting with the
|
|
2749
|
+
* Lightspark API.
|
|
2467
2750
|
*
|
|
2468
2751
|
* ```ts
|
|
2469
2752
|
* const lightsparkClient = new LightsparkClient(
|
|
@@ -2501,27 +2784,32 @@ declare class LightsparkClient {
|
|
|
2501
2784
|
* use, you should use the `AccountTokenAuthProvider`.
|
|
2502
2785
|
* @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
|
|
2503
2786
|
* @param cryptoImpl The crypto implementation to use. Defaults to web and node compatible crypto.
|
|
2504
|
-
* For React Native, you should use the `ReactNativeCrypto`
|
|
2787
|
+
* For React Native, you should use the `ReactNativeCrypto`
|
|
2788
|
+
* implementation from `@lightsparkdev/react-native`.
|
|
2505
2789
|
*/
|
|
2506
2790
|
constructor(authProvider?: AuthProvider, serverUrl?: string, cryptoImpl?: CryptoInterface);
|
|
2507
2791
|
/**
|
|
2508
|
-
* Sets the key loader for a node. This unlocks client operations that
|
|
2509
|
-
* Passing in [NodeIdAndPasswordSigningKeyLoaderArgs]
|
|
2510
|
-
*
|
|
2792
|
+
* Sets the key loader for a node. This unlocks client operations that
|
|
2793
|
+
* require a private key. Passing in [NodeIdAndPasswordSigningKeyLoaderArgs]
|
|
2794
|
+
* loads the RSA key for an OSK node.
|
|
2795
|
+
* Passing in [MasterSeedSigningKeyLoaderArgs] loads the Secp256k1 key for a
|
|
2796
|
+
* remote signing node.
|
|
2511
2797
|
*
|
|
2512
2798
|
* @param nodeId The ID of the node the key is for
|
|
2513
2799
|
* @param loader The loader for the key
|
|
2514
2800
|
*/
|
|
2515
2801
|
loadNodeSigningKey(nodeId: string, loaderArgs: SigningKeyLoaderArgs): Promise<boolean>;
|
|
2516
2802
|
/**
|
|
2517
|
-
* Gets the signing key for a node. Must have previously called
|
|
2803
|
+
* Gets the signing key for a node. Must have previously called
|
|
2804
|
+
* [loadNodeSigningKey].
|
|
2518
2805
|
*
|
|
2519
2806
|
* @param nodeId The ID of the node the key is for
|
|
2520
2807
|
* @returns The signing key for the node
|
|
2521
2808
|
*/
|
|
2522
2809
|
getNodeSigningKey(nodeId: string): Promise<SigningKey | undefined>;
|
|
2523
2810
|
/**
|
|
2524
|
-
* Sets the auth provider for the client.
|
|
2811
|
+
* Sets the auth provider for the client.
|
|
2812
|
+
* This is useful for switching between auth providers if you are using
|
|
2525
2813
|
* multiple accounts or waiting for the user to log in.
|
|
2526
2814
|
*
|
|
2527
2815
|
* @param authProvider
|
|
@@ -2557,15 +2845,16 @@ declare class LightsparkClient {
|
|
|
2557
2845
|
*/
|
|
2558
2846
|
getRecentPaymentRequests(nodeId: string, numTransactions?: number, bitcoinNetwork?: BitcoinNetwork, afterDate?: Maybe<string>): Promise<Transaction[]>;
|
|
2559
2847
|
/**
|
|
2560
|
-
* Starts listening for new transactions or updates to existing transactions
|
|
2848
|
+
* Starts listening for new transactions or updates to existing transactions
|
|
2849
|
+
* for a list of nodes.
|
|
2561
2850
|
*
|
|
2562
2851
|
* @param nodeIds The node IDs for which to listen to transactions.
|
|
2563
2852
|
* @returns A zen-observable that emits transaction updates for the given node IDs.
|
|
2564
2853
|
*/
|
|
2565
2854
|
listenToTransactions(nodeIds: string[]): Observable<TransactionUpdate | undefined>;
|
|
2566
2855
|
/**
|
|
2567
|
-
* Retrieves a dashboard of basic info for the authenticated account.
|
|
2568
|
-
* included.
|
|
2856
|
+
* Retrieves a dashboard of basic info for the authenticated account.
|
|
2857
|
+
* See `AccountDashboard` for which info is included.
|
|
2569
2858
|
*
|
|
2570
2859
|
* @param nodeIds The node IDs to include in the dashboard. Defaults to undefined (all nodes).
|
|
2571
2860
|
* @param bitcoinNetwork The bitcoin network to include in the dashboard. Defaults to MAINNET.
|
|
@@ -2574,8 +2863,8 @@ declare class LightsparkClient {
|
|
|
2574
2863
|
*/
|
|
2575
2864
|
getAccountDashboard(nodeIds?: string[] | undefined, bitcoinNetwork?: BitcoinNetwork): Promise<AccountDashboard>;
|
|
2576
2865
|
/**
|
|
2577
|
-
* Gets a basic dashboard for a single node, including recent transactions.
|
|
2578
|
-
* included.
|
|
2866
|
+
* Gets a basic dashboard for a single node, including recent transactions.
|
|
2867
|
+
* See `SingleNodeDashboard` for which info is included.
|
|
2579
2868
|
*
|
|
2580
2869
|
* @param nodeId The node ID for which to get a dashboard.
|
|
2581
2870
|
* @param bitcoinNetwork The bitcoin network for which to get a dashboard. Defaults to MAINNET.
|
|
@@ -2587,7 +2876,8 @@ declare class LightsparkClient {
|
|
|
2587
2876
|
/**
|
|
2588
2877
|
* Creates an invoice for the given node.
|
|
2589
2878
|
*
|
|
2590
|
-
* Test mode note: You can simulate a payment of this invoice in test move
|
|
2879
|
+
* Test mode note: You can simulate a payment of this invoice in test move
|
|
2880
|
+
* using [createTestModePayment].
|
|
2591
2881
|
*
|
|
2592
2882
|
* @param nodeId The node ID for which to create an invoice.
|
|
2593
2883
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2600,11 +2890,13 @@ declare class LightsparkClient {
|
|
|
2600
2890
|
*/
|
|
2601
2891
|
createInvoice(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined): Promise<string | undefined>;
|
|
2602
2892
|
/**
|
|
2603
|
-
* Generates a Lightning Invoice (follows the Bolt 11 specification) to
|
|
2604
|
-
* from another Lightning Node.
|
|
2893
|
+
* Generates a Lightning Invoice (follows the Bolt 11 specification) to
|
|
2894
|
+
* request a payment from another Lightning Node.
|
|
2895
|
+
* This should only be used for generating invoices for LNURLs,
|
|
2605
2896
|
* with [createInvoice] preferred in the general case.
|
|
2606
2897
|
*
|
|
2607
|
-
* Test mode note: You can simulate a payment of this invoice in test move
|
|
2898
|
+
* Test mode note: You can simulate a payment of this invoice in test move
|
|
2899
|
+
* using [createTestModePayment].
|
|
2608
2900
|
*
|
|
2609
2901
|
* @param nodeId The node ID for which to create an invoice.
|
|
2610
2902
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2616,10 +2908,12 @@ declare class LightsparkClient {
|
|
|
2616
2908
|
*/
|
|
2617
2909
|
createLnurlInvoice(nodeId: string, amountMsats: number, metadata: string, expirySecs?: number | undefined): Promise<Invoice | undefined>;
|
|
2618
2910
|
/**
|
|
2619
|
-
* Creates a new invoice for the UMA protocol.
|
|
2620
|
-
*
|
|
2621
|
-
*
|
|
2622
|
-
*
|
|
2911
|
+
* Creates a new invoice for the UMA protocol.
|
|
2912
|
+
* The metadata is hashed and included in the invoice.
|
|
2913
|
+
* This API generates a Lightning Invoice (follows the Bolt 11 specification)
|
|
2914
|
+
* to request a payment from another Lightning Node.
|
|
2915
|
+
* This should only be used for generating invoices for UMA,
|
|
2916
|
+
* with `createInvoice` preferred in the general case.
|
|
2623
2917
|
*
|
|
2624
2918
|
* @param nodeId The node ID for which to create an invoice.
|
|
2625
2919
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2630,6 +2924,13 @@ declare class LightsparkClient {
|
|
|
2630
2924
|
* @returns An Invoice object representing the generated invoice.
|
|
2631
2925
|
*/
|
|
2632
2926
|
createUmaInvoice(nodeId: string, amountMsats: number, metadata: string, expirySecs?: number | undefined): Promise<Invoice | undefined>;
|
|
2927
|
+
/**
|
|
2928
|
+
* Cancels an existing unpaid invoice and returns that invoice. Cancelled invoices cannot be paid.
|
|
2929
|
+
*
|
|
2930
|
+
* @param invoiceId The ID of the invoice to cancel.
|
|
2931
|
+
* @returns The cancelled invoice, or undefined if the invoice could not be cancelled.
|
|
2932
|
+
*/
|
|
2933
|
+
cancelInvoice(invoiceId: string): Promise<Invoice | undefined>;
|
|
2633
2934
|
/**
|
|
2634
2935
|
* Decodes an encoded lightning invoice string.
|
|
2635
2936
|
*
|
|
@@ -2638,7 +2939,8 @@ declare class LightsparkClient {
|
|
|
2638
2939
|
*/
|
|
2639
2940
|
decodeInvoice(encodedInvoice: string): Promise<InvoiceData>;
|
|
2640
2941
|
/**
|
|
2641
|
-
* Gets an estimate of the fee for sending a payment over the given bitcoin
|
|
2942
|
+
* Gets an estimate of the fee for sending a payment over the given bitcoin
|
|
2943
|
+
* network.
|
|
2642
2944
|
*
|
|
2643
2945
|
* @param bitcoinNetwork The bitcoin network for which to get a fee estimate. Defaults to MAINNET.
|
|
2644
2946
|
* @returns A fee estimate for the given bitcoin network including a minimum fee rate, and a max-speed fee rate.
|
|
@@ -2655,7 +2957,8 @@ declare class LightsparkClient {
|
|
|
2655
2957
|
*/
|
|
2656
2958
|
getLightningFeeEstimateForInvoice(nodeId: string, encodedPaymentRequest: string, amountMsats?: number | undefined): Promise<CurrencyAmount>;
|
|
2657
2959
|
/**
|
|
2658
|
-
* Returns an estimate of the fees that will be paid to send a payment to
|
|
2960
|
+
* Returns an estimate of the fees that will be paid to send a payment to
|
|
2961
|
+
* another Lightning node.
|
|
2659
2962
|
*
|
|
2660
2963
|
* @param nodeId The node from where you want to send the payment.
|
|
2661
2964
|
* @param destinationNodePublicKey The public key of the node that you want to pay.
|
|
@@ -2673,70 +2976,86 @@ declare class LightsparkClient {
|
|
|
2673
2976
|
/**
|
|
2674
2977
|
* Sends a lightning payment for a given invoice.
|
|
2675
2978
|
*
|
|
2676
|
-
* Test mode note: For test mode, you can use the [createTestModeInvoice]
|
|
2677
|
-
* pay in test mode.
|
|
2979
|
+
* Test mode note: For test mode, you can use the [createTestModeInvoice]
|
|
2980
|
+
* function to create an invoice you can pay in test mode.
|
|
2678
2981
|
*
|
|
2679
2982
|
* @param payerNodeId The ID of the node that will pay the invoice.
|
|
2680
2983
|
* @param encodedInvoice The encoded invoice to pay.
|
|
2681
2984
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2682
|
-
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2683
|
-
*
|
|
2985
|
+
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2986
|
+
* transactions succeed. For example,
|
|
2987
|
+
* for a transaction between 10k sats and 100k sats,
|
|
2988
|
+
* this would mean a fee limit of 16 to 160 sats.
|
|
2684
2989
|
* @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
|
|
2685
2990
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
2686
|
-
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
2991
|
+
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
2992
|
+
* invoice. Otherwise, the call will fail.
|
|
2687
2993
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2688
2994
|
*/
|
|
2689
2995
|
payInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
2690
2996
|
/**
|
|
2691
|
-
* sends an UMA payment to a node on the Lightning Network,
|
|
2692
|
-
* (as defined by the BOLT11 specification) that you
|
|
2693
|
-
*
|
|
2997
|
+
* sends an UMA payment to a node on the Lightning Network,
|
|
2998
|
+
* based on the invoice (as defined by the BOLT11 specification) that you
|
|
2999
|
+
* provide.
|
|
3000
|
+
* This should only be used for paying UMA invoices,
|
|
3001
|
+
* with `payInvoice` preferred in the general case.
|
|
2694
3002
|
*
|
|
2695
3003
|
* @param payerNodeId The ID of the node that will pay the invoice.
|
|
2696
3004
|
* @param encodedInvoice The encoded invoice to pay.
|
|
2697
3005
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2698
|
-
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2699
|
-
*
|
|
3006
|
+
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
3007
|
+
* transactions succeed. For example,
|
|
3008
|
+
* for a transaction between 10k sats and 100k sats,
|
|
3009
|
+
* this would mean a fee limit of 16 to 160 sats.
|
|
2700
3010
|
* @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
|
|
2701
3011
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
2702
|
-
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3012
|
+
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3013
|
+
* invoice. Otherwise, the call will fail.
|
|
2703
3014
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2704
3015
|
*/
|
|
2705
3016
|
payUmaInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
2706
3017
|
/**
|
|
2707
|
-
* Waits for a transaction to have a completed status, and returns the
|
|
3018
|
+
* Waits for a transaction to have a completed status, and returns the
|
|
3019
|
+
* transaction.
|
|
2708
3020
|
*
|
|
2709
3021
|
* @param transactionId The ID of the transaction to wait for
|
|
2710
3022
|
* @param pollTimeoutSecs The timeout in seconds that we will wait before throwing an exception
|
|
2711
3023
|
*/
|
|
2712
3024
|
waitForTransactionComplete<T = Transaction>(transactionId: string, pollTimeoutSecs?: number): Promise<T>;
|
|
2713
3025
|
/**
|
|
2714
|
-
* Sends a payment directly to a node on the Lightning Network through the
|
|
3026
|
+
* Sends a payment directly to a node on the Lightning Network through the
|
|
3027
|
+
* public key of the node without an invoice.
|
|
2715
3028
|
*
|
|
2716
3029
|
* @param payerNodeId The ID of the node that will send the payment.
|
|
2717
3030
|
* @param destinationPublicKey The public key of the destination node.
|
|
2718
3031
|
* @param timeoutSecs The timeout in seconds that we will try to make the payment.
|
|
2719
3032
|
* @param amountMsats The amount to pay in msats.
|
|
2720
3033
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2721
|
-
* As guidance, a maximum fee of 15 basis points should make almost all
|
|
2722
|
-
*
|
|
3034
|
+
* As guidance, a maximum fee of 15 basis points should make almost all
|
|
3035
|
+
* transactions succeed. For example,
|
|
3036
|
+
* for a transaction between 10k sats and 100k sats,
|
|
3037
|
+
* this would mean a fee limit of 15 to 150 sats.
|
|
2723
3038
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2724
3039
|
*/
|
|
2725
3040
|
sendPayment(payerNodeId: string, destinationPublicKey: string, timeoutSecs: number | undefined, amountMsats: number, maximumFeesMsats: number): Promise<OutgoingPayment | undefined>;
|
|
2726
3041
|
/**
|
|
2727
|
-
* Creates an L1 Bitcoin wallet address for a given node which can be used to
|
|
3042
|
+
* Creates an L1 Bitcoin wallet address for a given node which can be used to
|
|
3043
|
+
* deposit or withdraw funds.
|
|
2728
3044
|
*
|
|
2729
3045
|
* @param nodeId The ID of the node to create a wallet address for.
|
|
2730
3046
|
* @returns A string containing the wallet address for the given node.
|
|
2731
3047
|
*/
|
|
2732
3048
|
createNodeWalletAddress(nodeId: string): Promise<string>;
|
|
2733
3049
|
/**
|
|
2734
|
-
* Withdraws funds from the account and sends it to the requested bitcoin
|
|
3050
|
+
* Withdraws funds from the account and sends it to the requested bitcoin
|
|
3051
|
+
* address.
|
|
2735
3052
|
*
|
|
2736
|
-
* Depending on the chosen mode, it will first take the funds from the
|
|
2737
|
-
*
|
|
2738
|
-
*
|
|
2739
|
-
*
|
|
3053
|
+
* Depending on the chosen mode, it will first take the funds from the
|
|
3054
|
+
* wallet, and if applicable, close channels appropriately to recover enough
|
|
3055
|
+
* funds and reopen channels with the remaining funds.
|
|
3056
|
+
* The process is asynchronous and may take up to a few minutes.
|
|
3057
|
+
* You can check the progress by polling the `WithdrawalRequest` that is
|
|
3058
|
+
* created, or by subscribing to a webhook.
|
|
2740
3059
|
*
|
|
2741
3060
|
* @param nodeId The ID of the node from which to withdraw funds.
|
|
2742
3061
|
* @param amountSats The amount of funds to withdraw in satoshis.
|
|
@@ -2745,9 +3064,10 @@ declare class LightsparkClient {
|
|
|
2745
3064
|
*/
|
|
2746
3065
|
requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode): Promise<WithdrawalRequest>;
|
|
2747
3066
|
/**
|
|
2748
|
-
* Adds funds to a Lightspark node on the REGTEST network.
|
|
2749
|
-
*
|
|
2750
|
-
*
|
|
3067
|
+
* Adds funds to a Lightspark node on the REGTEST network.
|
|
3068
|
+
* If the amount is not specified, 10,000,000 SATOSHI will be added.
|
|
3069
|
+
* This API only functions for nodes created on the REGTEST network and will
|
|
3070
|
+
* return an error when called for any non-REGTEST node.
|
|
2751
3071
|
*
|
|
2752
3072
|
* @param nodeId The ID of the node to fund. Must be a REGTEST node.
|
|
2753
3073
|
* @param amountSats The amount of funds to add to the node in satoshis. Defaults to 10,000,000 SATOSHI.
|
|
@@ -2755,8 +3075,8 @@ declare class LightsparkClient {
|
|
|
2755
3075
|
*/
|
|
2756
3076
|
fundNode(nodeId: string, amountSats?: number | undefined): Promise<CurrencyAmount>;
|
|
2757
3077
|
/**
|
|
2758
|
-
* Creates a new API token that can be used to authenticate requests for this
|
|
2759
|
-
* and SDKs.
|
|
3078
|
+
* Creates a new API token that can be used to authenticate requests for this
|
|
3079
|
+
* account when using the Lightspark APIs and SDKs.
|
|
2760
3080
|
*
|
|
2761
3081
|
* @param name Creates a new API token that can be used to authenticate requests for this account when using the
|
|
2762
3082
|
* Lightspark APIs and SDKs.
|
|
@@ -2772,8 +3092,9 @@ declare class LightsparkClient {
|
|
|
2772
3092
|
*/
|
|
2773
3093
|
deleteApiToken(id: string): Promise<void>;
|
|
2774
3094
|
/**
|
|
2775
|
-
* In test mode, generates a Lightning Invoice which can be paid by a local
|
|
2776
|
-
* This call is only valid in test mode.
|
|
3095
|
+
* In test mode, generates a Lightning Invoice which can be paid by a local
|
|
3096
|
+
* node. This call is only valid in test mode.
|
|
3097
|
+
* You can then pay the invoice using [payInvoice].
|
|
2777
3098
|
*
|
|
2778
3099
|
* @param localNodeId The ID of the node that will pay the invoice.
|
|
2779
3100
|
* @param amountMsats The amount to pay in milli-satoshis.
|
|
@@ -2782,8 +3103,9 @@ declare class LightsparkClient {
|
|
|
2782
3103
|
*/
|
|
2783
3104
|
createTestModeInvoice(localNodeId: string, amountMsats: number, memo?: string | undefined, invoiceType?: InvoiceType): Promise<string | null>;
|
|
2784
3105
|
/**
|
|
2785
|
-
* In test mode, simulates a payment of a Lightning Invoice from another
|
|
2786
|
-
* This can only be used in test mode and should be used with invoices
|
|
3106
|
+
* In test mode, simulates a payment of a Lightning Invoice from another
|
|
3107
|
+
* node. This can only be used in test mode and should be used with invoices
|
|
3108
|
+
* generated by [createInvoice].
|
|
2787
3109
|
*
|
|
2788
3110
|
* @param localNodeId The ID of the node that will receive the payment.
|
|
2789
3111
|
* @param encodedInvoice The encoded invoice to pay.
|
|
@@ -2792,8 +3114,8 @@ declare class LightsparkClient {
|
|
|
2792
3114
|
*/
|
|
2793
3115
|
createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<IncomingPayment | null>;
|
|
2794
3116
|
/**
|
|
2795
|
-
* Creates an UMA invitation. If you are part of the incentive program,
|
|
2796
|
-
* [createUmaInvitationWithIncentives].
|
|
3117
|
+
* Creates an UMA invitation. If you are part of the incentive program,
|
|
3118
|
+
* you should use [createUmaInvitationWithIncentives].
|
|
2797
3119
|
*
|
|
2798
3120
|
* @param inviterUma The UMA of the inviter.
|
|
2799
3121
|
* @returns The invitation that was created.
|
|
@@ -2808,8 +3130,8 @@ declare class LightsparkClient {
|
|
|
2808
3130
|
*/
|
|
2809
3131
|
createUmaInvitationWithIncentives(inviterUma: string, inviterPhoneNumber: string, inviterRegion: RegionCode): Promise<UmaInvitation | null>;
|
|
2810
3132
|
/**
|
|
2811
|
-
* Claims an UMA invitation. If you are part of the incentive program,
|
|
2812
|
-
* [claimUmaInvitationWithIncentives].
|
|
3133
|
+
* Claims an UMA invitation. If you are part of the incentive program,
|
|
3134
|
+
* you should use [claimUmaInvitationWithIncentives].
|
|
2813
3135
|
*
|
|
2814
3136
|
* @param invitationCode The invitation code to claim.
|
|
2815
3137
|
* @param inviteeUma The UMA of the invitee.
|
|
@@ -2837,7 +3159,8 @@ declare class LightsparkClient {
|
|
|
2837
3159
|
/**
|
|
2838
3160
|
* Executes a raw `Query` against the Lightspark API.
|
|
2839
3161
|
*
|
|
2840
|
-
* This generally should not be used directly,
|
|
3162
|
+
* This generally should not be used directly,
|
|
3163
|
+
* but is exposed for advanced use cases and for internal use to retrieve
|
|
2841
3164
|
* complex fields from objects.
|
|
2842
3165
|
*
|
|
2843
3166
|
* @param query The `Query` to execute.
|
|
@@ -2846,6 +3169,14 @@ declare class LightsparkClient {
|
|
|
2846
3169
|
executeRawQuery<T>(query: Query<T>): Promise<T | null>;
|
|
2847
3170
|
}
|
|
2848
3171
|
|
|
3172
|
+
interface CancelInvoiceInput {
|
|
3173
|
+
invoiceId: string;
|
|
3174
|
+
}
|
|
3175
|
+
|
|
3176
|
+
interface CancelInvoiceOutput {
|
|
3177
|
+
invoiceId: string;
|
|
3178
|
+
}
|
|
3179
|
+
|
|
2849
3180
|
interface ClaimUmaInvitationInput {
|
|
2850
3181
|
invitationCode: string;
|
|
2851
3182
|
inviteeUma: string;
|
|
@@ -2878,8 +3209,9 @@ declare enum ComplianceProvider {
|
|
|
2878
3209
|
|
|
2879
3210
|
interface Connection {
|
|
2880
3211
|
/**
|
|
2881
|
-
* The total count of objects in this connection, using the current filters.
|
|
2882
|
-
* number of objects returned in the current page (in the `entities`
|
|
3212
|
+
* The total count of objects in this connection, using the current filters.
|
|
3213
|
+
* It is different from the number of objects returned in the current page (in the `entities`
|
|
3214
|
+
* field).
|
|
2883
3215
|
**/
|
|
2884
3216
|
count: number;
|
|
2885
3217
|
/** An object that holds pagination information about the objects in this connection. **/
|
|
@@ -2926,8 +3258,9 @@ interface CreateLnurlInvoiceInput {
|
|
|
2926
3258
|
/** The amount for which the invoice should be created, in millisatoshis. **/
|
|
2927
3259
|
amountMsats: number;
|
|
2928
3260
|
/**
|
|
2929
|
-
* The SHA256 hash of the LNURL metadata payload.
|
|
2930
|
-
* payment) of the resulting Bolt 11
|
|
3261
|
+
* The SHA256 hash of the LNURL metadata payload.
|
|
3262
|
+
* This will be present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11
|
|
3263
|
+
* invoice.
|
|
2931
3264
|
**/
|
|
2932
3265
|
metadataHash: string;
|
|
2933
3266
|
/** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
|
|
@@ -2960,13 +3293,17 @@ interface CreateTestModePaymentInput {
|
|
|
2960
3293
|
/** The invoice you want to be paid (as defined by the BOLT11 standard). **/
|
|
2961
3294
|
encodedInvoice: string;
|
|
2962
3295
|
/**
|
|
2963
|
-
* The amount you will be paid for this invoice, expressed in msats.
|
|
2964
|
-
* invoice amount is zero.
|
|
3296
|
+
* The amount you will be paid for this invoice, expressed in msats.
|
|
3297
|
+
* It should ONLY be set when the invoice amount is zero.
|
|
2965
3298
|
**/
|
|
2966
3299
|
amountMsats?: number | undefined;
|
|
2967
3300
|
}
|
|
2968
3301
|
|
|
2969
|
-
/**
|
|
3302
|
+
/**
|
|
3303
|
+
* This is an object identifying the output of a test mode payment.
|
|
3304
|
+
* This object can be used to retrieve the associated payment made from a Test Mode Payment call.
|
|
3305
|
+
* *
|
|
3306
|
+
*/
|
|
2970
3307
|
interface CreateTestModePaymentoutput {
|
|
2971
3308
|
/**
|
|
2972
3309
|
* The payment that has been sent.
|
|
@@ -3012,8 +3349,8 @@ declare enum SignablePayloadStatus {
|
|
|
3012
3349
|
|
|
3013
3350
|
interface SignablePayload {
|
|
3014
3351
|
/**
|
|
3015
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3016
|
-
* string.
|
|
3352
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3353
|
+
* Should be treated as an opaque string.
|
|
3017
3354
|
**/
|
|
3018
3355
|
id: string;
|
|
3019
3356
|
/** The date and time when the entity was first created. **/
|
|
@@ -3022,7 +3359,10 @@ interface SignablePayload {
|
|
|
3022
3359
|
updatedAt: string;
|
|
3023
3360
|
/** The payload that needs to be signed. **/
|
|
3024
3361
|
payload: string;
|
|
3025
|
-
/**
|
|
3362
|
+
/**
|
|
3363
|
+
* The consistent method for generating the same set of accounts and wallets for a given
|
|
3364
|
+
* private key *
|
|
3365
|
+
*/
|
|
3026
3366
|
derivationPath: string;
|
|
3027
3367
|
/** The status of the payload. **/
|
|
3028
3368
|
status: SignablePayloadStatus;
|
|
@@ -3049,11 +3389,16 @@ interface DeleteApiTokenOutput {
|
|
|
3049
3389
|
accountId: string;
|
|
3050
3390
|
}
|
|
3051
3391
|
|
|
3052
|
-
/**
|
|
3392
|
+
/**
|
|
3393
|
+
* This object represents a Deposit made to a Lightspark node wallet.
|
|
3394
|
+
* This operation occurs for any L1 funding transaction to the wallet.
|
|
3395
|
+
* You can retrieve this object to receive detailed information about the deposit.
|
|
3396
|
+
* *
|
|
3397
|
+
*/
|
|
3053
3398
|
interface Deposit {
|
|
3054
3399
|
/**
|
|
3055
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3056
|
-
* string.
|
|
3400
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3401
|
+
* Should be treated as an opaque string.
|
|
3057
3402
|
**/
|
|
3058
3403
|
id: string;
|
|
3059
3404
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3103,11 +3448,16 @@ interface FundNodeOutput {
|
|
|
3103
3448
|
amount: CurrencyAmount;
|
|
3104
3449
|
}
|
|
3105
3450
|
|
|
3106
|
-
/**
|
|
3451
|
+
/**
|
|
3452
|
+
* This object represents a node that exists on the Lightning Network,
|
|
3453
|
+
* including nodes not managed by Lightspark. You can retrieve this object to get publicly
|
|
3454
|
+
* available information about any node on the Lightning Network.
|
|
3455
|
+
* *
|
|
3456
|
+
*/
|
|
3107
3457
|
declare class GraphNode implements Node, Entity {
|
|
3108
3458
|
/**
|
|
3109
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3110
|
-
* string.
|
|
3459
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3460
|
+
* Should be treated as an opaque string.
|
|
3111
3461
|
**/
|
|
3112
3462
|
readonly id: string;
|
|
3113
3463
|
/** The date and time when the entity was first created. **/
|
|
@@ -3117,21 +3467,22 @@ declare class GraphNode implements Node, Entity {
|
|
|
3117
3467
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3118
3468
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3119
3469
|
/**
|
|
3120
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3121
|
-
* on the data available for this node.
|
|
3470
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3471
|
+
* depending on the data available for this node.
|
|
3122
3472
|
**/
|
|
3123
3473
|
readonly displayName: string;
|
|
3124
3474
|
/** The typename of the object **/
|
|
3125
3475
|
readonly typename: string;
|
|
3126
3476
|
/**
|
|
3127
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3128
|
-
* way to identify and search for commercial services or popular nodes.
|
|
3129
|
-
* any time by the node operator.
|
|
3477
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3478
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
3479
|
+
* This alias can be changed at any time by the node operator.
|
|
3130
3480
|
**/
|
|
3131
3481
|
readonly alias?: string | undefined;
|
|
3132
3482
|
/**
|
|
3133
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3134
|
-
* has no importance in terms of operating the node,
|
|
3483
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3484
|
+
* white. It has no importance in terms of operating the node,
|
|
3485
|
+
* it is just a way to visually differentiate nodes.
|
|
3135
3486
|
* That color can be changed at any time by the node operator.
|
|
3136
3487
|
**/
|
|
3137
3488
|
readonly color?: string | undefined;
|
|
@@ -3141,12 +3492,15 @@ declare class GraphNode implements Node, Entity {
|
|
|
3141
3492
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3142
3493
|
**/
|
|
3143
3494
|
readonly conductivity?: number | undefined;
|
|
3144
|
-
/**
|
|
3495
|
+
/**
|
|
3496
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
3497
|
+
* Network. *
|
|
3498
|
+
*/
|
|
3145
3499
|
readonly publicKey?: string | undefined;
|
|
3146
3500
|
constructor(
|
|
3147
3501
|
/**
|
|
3148
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3149
|
-
* string.
|
|
3502
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3503
|
+
* Should be treated as an opaque string.
|
|
3150
3504
|
**/
|
|
3151
3505
|
id: string,
|
|
3152
3506
|
/** The date and time when the entity was first created. **/
|
|
@@ -3156,21 +3510,22 @@ declare class GraphNode implements Node, Entity {
|
|
|
3156
3510
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3157
3511
|
bitcoinNetwork: BitcoinNetwork,
|
|
3158
3512
|
/**
|
|
3159
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3160
|
-
* on the data available for this node.
|
|
3513
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3514
|
+
* depending on the data available for this node.
|
|
3161
3515
|
**/
|
|
3162
3516
|
displayName: string,
|
|
3163
3517
|
/** The typename of the object **/
|
|
3164
3518
|
typename: string,
|
|
3165
3519
|
/**
|
|
3166
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3167
|
-
* way to identify and search for commercial services or popular nodes.
|
|
3168
|
-
* any time by the node operator.
|
|
3520
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3521
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
3522
|
+
* This alias can be changed at any time by the node operator.
|
|
3169
3523
|
**/
|
|
3170
3524
|
alias?: string | undefined,
|
|
3171
3525
|
/**
|
|
3172
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3173
|
-
* has no importance in terms of operating the node,
|
|
3526
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3527
|
+
* white. It has no importance in terms of operating the node,
|
|
3528
|
+
* it is just a way to visually differentiate nodes.
|
|
3174
3529
|
* That color can be changed at any time by the node operator.
|
|
3175
3530
|
**/
|
|
3176
3531
|
color?: string | undefined,
|
|
@@ -3180,7 +3535,10 @@ declare class GraphNode implements Node, Entity {
|
|
|
3180
3535
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3181
3536
|
**/
|
|
3182
3537
|
conductivity?: number | undefined,
|
|
3183
|
-
/**
|
|
3538
|
+
/**
|
|
3539
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
3540
|
+
* Network. *
|
|
3541
|
+
*/
|
|
3184
3542
|
publicKey?: string | undefined);
|
|
3185
3543
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
3186
3544
|
static getGraphNodeQuery(id: string): Query<GraphNode>;
|
|
@@ -3211,8 +3569,8 @@ interface LightningFeeEstimateForInvoiceInput {
|
|
|
3211
3569
|
/** The invoice you want to pay (as defined by the BOLT11 standard). **/
|
|
3212
3570
|
encodedPaymentRequest: string;
|
|
3213
3571
|
/**
|
|
3214
|
-
* If the invoice does not specify a payment amount, then the amount that you wish to pay,
|
|
3215
|
-
* in msats.
|
|
3572
|
+
* If the invoice does not specify a payment amount, then the amount that you wish to pay,
|
|
3573
|
+
* expressed in msats.
|
|
3216
3574
|
**/
|
|
3217
3575
|
amountMsats?: number | undefined;
|
|
3218
3576
|
}
|
|
@@ -3239,8 +3597,8 @@ interface Secret {
|
|
|
3239
3597
|
/** This is a Lightspark node with OSK. **/
|
|
3240
3598
|
declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
3241
3599
|
/**
|
|
3242
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3243
|
-
* string.
|
|
3600
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3601
|
+
* Should be treated as an opaque string.
|
|
3244
3602
|
**/
|
|
3245
3603
|
readonly id: string;
|
|
3246
3604
|
/** The date and time when the entity was first created. **/
|
|
@@ -3250,8 +3608,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3250
3608
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3251
3609
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3252
3610
|
/**
|
|
3253
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3254
|
-
* on the data available for this node.
|
|
3611
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3612
|
+
* depending on the data available for this node.
|
|
3255
3613
|
**/
|
|
3256
3614
|
readonly displayName: string;
|
|
3257
3615
|
/** The owner of this LightsparkNode. **/
|
|
@@ -3264,14 +3622,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3264
3622
|
/** The typename of the object **/
|
|
3265
3623
|
readonly typename: string;
|
|
3266
3624
|
/**
|
|
3267
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3268
|
-
* way to identify and search for commercial services or popular nodes.
|
|
3269
|
-
* any time by the node operator.
|
|
3625
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3626
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
3627
|
+
* This alias can be changed at any time by the node operator.
|
|
3270
3628
|
**/
|
|
3271
3629
|
readonly alias?: string | undefined;
|
|
3272
3630
|
/**
|
|
3273
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3274
|
-
* has no importance in terms of operating the node,
|
|
3631
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3632
|
+
* white. It has no importance in terms of operating the node,
|
|
3633
|
+
* it is just a way to visually differentiate nodes.
|
|
3275
3634
|
* That color can be changed at any time by the node operator.
|
|
3276
3635
|
**/
|
|
3277
3636
|
readonly color?: string | undefined;
|
|
@@ -3281,12 +3640,16 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3281
3640
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3282
3641
|
**/
|
|
3283
3642
|
readonly conductivity?: number | undefined;
|
|
3284
|
-
/**
|
|
3643
|
+
/**
|
|
3644
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
3645
|
+
* Network. *
|
|
3646
|
+
*/
|
|
3285
3647
|
readonly publicKey?: string | undefined;
|
|
3286
3648
|
/** The current status of this node. **/
|
|
3287
3649
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
3288
3650
|
/**
|
|
3289
|
-
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3651
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3652
|
+
* node.
|
|
3290
3653
|
*
|
|
3291
3654
|
* @deprecated Use `balances` instead.
|
|
3292
3655
|
**/
|
|
@@ -3317,12 +3680,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3317
3680
|
readonly blockchainBalance?: BlockchainBalance | undefined;
|
|
3318
3681
|
/** The balances that describe the funds in this node. **/
|
|
3319
3682
|
readonly balances?: Balances | undefined;
|
|
3320
|
-
/**
|
|
3683
|
+
/**
|
|
3684
|
+
* The private key client is using to sign a GraphQL request which will be verified at server
|
|
3685
|
+
* side. *
|
|
3686
|
+
*/
|
|
3321
3687
|
readonly encryptedSigningPrivateKey?: Secret | undefined;
|
|
3322
3688
|
constructor(
|
|
3323
3689
|
/**
|
|
3324
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3325
|
-
* string.
|
|
3690
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3691
|
+
* Should be treated as an opaque string.
|
|
3326
3692
|
**/
|
|
3327
3693
|
id: string,
|
|
3328
3694
|
/** The date and time when the entity was first created. **/
|
|
@@ -3332,8 +3698,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3332
3698
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3333
3699
|
bitcoinNetwork: BitcoinNetwork,
|
|
3334
3700
|
/**
|
|
3335
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3336
|
-
* on the data available for this node.
|
|
3701
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3702
|
+
* depending on the data available for this node.
|
|
3337
3703
|
**/
|
|
3338
3704
|
displayName: string,
|
|
3339
3705
|
/** The owner of this LightsparkNode. **/
|
|
@@ -3346,14 +3712,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3346
3712
|
/** The typename of the object **/
|
|
3347
3713
|
typename: string,
|
|
3348
3714
|
/**
|
|
3349
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3350
|
-
* way to identify and search for commercial services or popular nodes.
|
|
3351
|
-
* any time by the node operator.
|
|
3715
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3716
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
3717
|
+
* This alias can be changed at any time by the node operator.
|
|
3352
3718
|
**/
|
|
3353
3719
|
alias?: string | undefined,
|
|
3354
3720
|
/**
|
|
3355
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3356
|
-
* has no importance in terms of operating the node,
|
|
3721
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3722
|
+
* white. It has no importance in terms of operating the node,
|
|
3723
|
+
* it is just a way to visually differentiate nodes.
|
|
3357
3724
|
* That color can be changed at any time by the node operator.
|
|
3358
3725
|
**/
|
|
3359
3726
|
color?: string | undefined,
|
|
@@ -3363,12 +3730,16 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3363
3730
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3364
3731
|
**/
|
|
3365
3732
|
conductivity?: number | undefined,
|
|
3366
|
-
/**
|
|
3733
|
+
/**
|
|
3734
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
3735
|
+
* Network. *
|
|
3736
|
+
*/
|
|
3367
3737
|
publicKey?: string | undefined,
|
|
3368
3738
|
/** The current status of this node. **/
|
|
3369
3739
|
status?: LightsparkNodeStatus | undefined,
|
|
3370
3740
|
/**
|
|
3371
|
-
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3741
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3742
|
+
* node.
|
|
3372
3743
|
*
|
|
3373
3744
|
* @deprecated Use `balances` instead.
|
|
3374
3745
|
**/
|
|
@@ -3399,7 +3770,10 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3399
3770
|
blockchainBalance?: BlockchainBalance | undefined,
|
|
3400
3771
|
/** The balances that describe the funds in this node. **/
|
|
3401
3772
|
balances?: Balances | undefined,
|
|
3402
|
-
/**
|
|
3773
|
+
/**
|
|
3774
|
+
* The private key client is using to sign a GraphQL request which will be verified at server
|
|
3775
|
+
* side. *
|
|
3776
|
+
*/
|
|
3403
3777
|
encryptedSigningPrivateKey?: Secret | undefined);
|
|
3404
3778
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
3405
3779
|
getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
@@ -3433,8 +3807,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3433
3807
|
/** This is a Lightspark node with remote signing. **/
|
|
3434
3808
|
declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
|
|
3435
3809
|
/**
|
|
3436
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3437
|
-
* string.
|
|
3810
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3811
|
+
* Should be treated as an opaque string.
|
|
3438
3812
|
**/
|
|
3439
3813
|
readonly id: string;
|
|
3440
3814
|
/** The date and time when the entity was first created. **/
|
|
@@ -3444,8 +3818,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3444
3818
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3445
3819
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3446
3820
|
/**
|
|
3447
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3448
|
-
* on the data available for this node.
|
|
3821
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3822
|
+
* depending on the data available for this node.
|
|
3449
3823
|
**/
|
|
3450
3824
|
readonly displayName: string;
|
|
3451
3825
|
/** The owner of this LightsparkNode. **/
|
|
@@ -3458,14 +3832,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3458
3832
|
/** The typename of the object **/
|
|
3459
3833
|
readonly typename: string;
|
|
3460
3834
|
/**
|
|
3461
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3462
|
-
* way to identify and search for commercial services or popular nodes.
|
|
3463
|
-
* any time by the node operator.
|
|
3835
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3836
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
3837
|
+
* This alias can be changed at any time by the node operator.
|
|
3464
3838
|
**/
|
|
3465
3839
|
readonly alias?: string | undefined;
|
|
3466
3840
|
/**
|
|
3467
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3468
|
-
* has no importance in terms of operating the node,
|
|
3841
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3842
|
+
* white. It has no importance in terms of operating the node,
|
|
3843
|
+
* it is just a way to visually differentiate nodes.
|
|
3469
3844
|
* That color can be changed at any time by the node operator.
|
|
3470
3845
|
**/
|
|
3471
3846
|
readonly color?: string | undefined;
|
|
@@ -3475,12 +3850,16 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3475
3850
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3476
3851
|
**/
|
|
3477
3852
|
readonly conductivity?: number | undefined;
|
|
3478
|
-
/**
|
|
3853
|
+
/**
|
|
3854
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
3855
|
+
* Network. *
|
|
3856
|
+
*/
|
|
3479
3857
|
readonly publicKey?: string | undefined;
|
|
3480
3858
|
/** The current status of this node. **/
|
|
3481
3859
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
3482
3860
|
/**
|
|
3483
|
-
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3861
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3862
|
+
* node.
|
|
3484
3863
|
*
|
|
3485
3864
|
* @deprecated Use `balances` instead.
|
|
3486
3865
|
**/
|
|
@@ -3513,8 +3892,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3513
3892
|
readonly balances?: Balances | undefined;
|
|
3514
3893
|
constructor(
|
|
3515
3894
|
/**
|
|
3516
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3517
|
-
* string.
|
|
3895
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3896
|
+
* Should be treated as an opaque string.
|
|
3518
3897
|
**/
|
|
3519
3898
|
id: string,
|
|
3520
3899
|
/** The date and time when the entity was first created. **/
|
|
@@ -3524,8 +3903,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3524
3903
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3525
3904
|
bitcoinNetwork: BitcoinNetwork,
|
|
3526
3905
|
/**
|
|
3527
|
-
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3528
|
-
* on the data available for this node.
|
|
3906
|
+
* The name of this node in the network. It will be the most human-readable option possible,
|
|
3907
|
+
* depending on the data available for this node.
|
|
3529
3908
|
**/
|
|
3530
3909
|
displayName: string,
|
|
3531
3910
|
/** The owner of this LightsparkNode. **/
|
|
@@ -3538,14 +3917,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3538
3917
|
/** The typename of the object **/
|
|
3539
3918
|
typename: string,
|
|
3540
3919
|
/**
|
|
3541
|
-
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3542
|
-
* way to identify and search for commercial services or popular nodes.
|
|
3543
|
-
* any time by the node operator.
|
|
3920
|
+
* A name that identifies the node. It has no importance in terms of operating the node,
|
|
3921
|
+
* it is just a way to identify and search for commercial services or popular nodes.
|
|
3922
|
+
* This alias can be changed at any time by the node operator.
|
|
3544
3923
|
**/
|
|
3545
3924
|
alias?: string | undefined,
|
|
3546
3925
|
/**
|
|
3547
|
-
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3548
|
-
* has no importance in terms of operating the node,
|
|
3926
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
|
|
3927
|
+
* white. It has no importance in terms of operating the node,
|
|
3928
|
+
* it is just a way to visually differentiate nodes.
|
|
3549
3929
|
* That color can be changed at any time by the node operator.
|
|
3550
3930
|
**/
|
|
3551
3931
|
color?: string | undefined,
|
|
@@ -3555,12 +3935,16 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3555
3935
|
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3556
3936
|
**/
|
|
3557
3937
|
conductivity?: number | undefined,
|
|
3558
|
-
/**
|
|
3938
|
+
/**
|
|
3939
|
+
* The public key of this node. It acts as a unique identifier of this node in the Lightning
|
|
3940
|
+
* Network. *
|
|
3941
|
+
*/
|
|
3559
3942
|
publicKey?: string | undefined,
|
|
3560
3943
|
/** The current status of this node. **/
|
|
3561
3944
|
status?: LightsparkNodeStatus | undefined,
|
|
3562
3945
|
/**
|
|
3563
|
-
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3946
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
|
|
3947
|
+
* node.
|
|
3564
3948
|
*
|
|
3565
3949
|
* @deprecated Use `balances` instead.
|
|
3566
3950
|
**/
|
|
@@ -3619,11 +4003,16 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3619
4003
|
};
|
|
3620
4004
|
}
|
|
3621
4005
|
|
|
3622
|
-
/**
|
|
4006
|
+
/**
|
|
4007
|
+
* This object represents an L1 transaction that occurred on the Bitcoin Network.
|
|
4008
|
+
* You can retrieve this object to receive information about a specific on-chain transaction made
|
|
4009
|
+
* on the Lightning Network associated with your Lightspark Node.
|
|
4010
|
+
* *
|
|
4011
|
+
*/
|
|
3623
4012
|
interface OnChainTransaction {
|
|
3624
4013
|
/**
|
|
3625
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3626
|
-
* string.
|
|
4014
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4015
|
+
* Should be treated as an opaque string.
|
|
3627
4016
|
**/
|
|
3628
4017
|
id: string;
|
|
3629
4018
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3680,7 +4069,10 @@ interface PayInvoiceInput {
|
|
|
3680
4069
|
encodedInvoice: string;
|
|
3681
4070
|
/** The timeout in seconds that we will try to make the payment. **/
|
|
3682
4071
|
timeoutSecs: number;
|
|
3683
|
-
/**
|
|
4072
|
+
/**
|
|
4073
|
+
* The maximum amount of fees that you want to pay for this payment to be sent, expressed in
|
|
4074
|
+
* msats. *
|
|
4075
|
+
*/
|
|
3684
4076
|
maximumFeesMsats: number;
|
|
3685
4077
|
/**
|
|
3686
4078
|
* The amount you will pay for this invoice, expressed in msats. It should ONLY be set when the
|
|
@@ -3694,6 +4086,14 @@ interface PayInvoiceOutput {
|
|
|
3694
4086
|
paymentId: string;
|
|
3695
4087
|
}
|
|
3696
4088
|
|
|
4089
|
+
interface PayUmaInvoiceInput {
|
|
4090
|
+
nodeId: string;
|
|
4091
|
+
encodedInvoice: string;
|
|
4092
|
+
timeoutSecs: number;
|
|
4093
|
+
maximumFeesMsats: number;
|
|
4094
|
+
amountMsats?: number | undefined;
|
|
4095
|
+
}
|
|
4096
|
+
|
|
3697
4097
|
/** This is an enum indicating the direction of the payment. **/
|
|
3698
4098
|
declare enum PaymentDirection {
|
|
3699
4099
|
/**
|
|
@@ -3705,29 +4105,22 @@ declare enum PaymentDirection {
|
|
|
3705
4105
|
RECEIVED = "RECEIVED"
|
|
3706
4106
|
}
|
|
3707
4107
|
|
|
3708
|
-
interface PayUmaInvoiceInput {
|
|
3709
|
-
nodeId: string;
|
|
3710
|
-
encodedInvoice: string;
|
|
3711
|
-
timeoutSecs: number;
|
|
3712
|
-
maximumFeesMsats: number;
|
|
3713
|
-
amountMsats?: number | undefined;
|
|
3714
|
-
}
|
|
3715
|
-
|
|
3716
4108
|
interface RegisterPaymentInput {
|
|
3717
4109
|
/**
|
|
3718
|
-
* The compliance provider that is going to screen the node.
|
|
3719
|
-
* provider and store the API key on the Lightspark
|
|
4110
|
+
* The compliance provider that is going to screen the node.
|
|
4111
|
+
* You need to be a customer of the selected provider and store the API key on the Lightspark
|
|
4112
|
+
* account setting page.
|
|
3720
4113
|
**/
|
|
3721
4114
|
provider: ComplianceProvider;
|
|
3722
4115
|
/**
|
|
3723
|
-
* The Lightspark ID of the lightning payment you want to register.
|
|
3724
|
-
* OutgoingPayment or an IncomingPayment.
|
|
4116
|
+
* The Lightspark ID of the lightning payment you want to register.
|
|
4117
|
+
* It can be the id of either an OutgoingPayment or an IncomingPayment.
|
|
3725
4118
|
**/
|
|
3726
4119
|
paymentId: string;
|
|
3727
4120
|
/**
|
|
3728
|
-
* The public key of the counterparty lightning node,
|
|
3729
|
-
*
|
|
3730
|
-
* register an incoming payment.
|
|
4121
|
+
* The public key of the counterparty lightning node,
|
|
4122
|
+
* which would be the public key of the recipient node if it is to register an outgoing
|
|
4123
|
+
* payment, or the public key of the sender node if it is to register an incoming payment.
|
|
3731
4124
|
**/
|
|
3732
4125
|
nodePubkey: string;
|
|
3733
4126
|
/** Indicates whether this payment is an OutgoingPayment or an IncomingPayment. **/
|
|
@@ -3787,8 +4180,8 @@ interface RequestWithdrawalInput {
|
|
|
3787
4180
|
/** The bitcoin address where the withdrawal should be sent. **/
|
|
3788
4181
|
bitcoinAddress: string;
|
|
3789
4182
|
/**
|
|
3790
|
-
* The amount you want to withdraw from this node in Satoshis.
|
|
3791
|
-
* all funds from this node.
|
|
4183
|
+
* The amount you want to withdraw from this node in Satoshis.
|
|
4184
|
+
* Use the special value -1 to withdrawal all funds from this node.
|
|
3792
4185
|
**/
|
|
3793
4186
|
amountSats: number;
|
|
3794
4187
|
/** The strategy that should be used to withdraw the funds from this node. **/
|
|
@@ -3800,7 +4193,11 @@ interface RequestWithdrawalOutput {
|
|
|
3800
4193
|
requestId: string;
|
|
3801
4194
|
}
|
|
3802
4195
|
|
|
3803
|
-
/**
|
|
4196
|
+
/**
|
|
4197
|
+
* This is an enum of the potential risk ratings related to a transaction made over the Lightning
|
|
4198
|
+
* Network. These risk ratings are returned from the CryptoSanctionScreeningProvider.
|
|
4199
|
+
* *
|
|
4200
|
+
*/
|
|
3804
4201
|
declare enum RiskRating {
|
|
3805
4202
|
/**
|
|
3806
4203
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -3812,11 +4209,16 @@ declare enum RiskRating {
|
|
|
3812
4209
|
UNKNOWN = "UNKNOWN"
|
|
3813
4210
|
}
|
|
3814
4211
|
|
|
3815
|
-
/**
|
|
4212
|
+
/**
|
|
4213
|
+
* This object represents a transaction that was forwarded through a Lightspark node on the
|
|
4214
|
+
* Lightning Network, i.e., a routed transaction.
|
|
4215
|
+
* You can retrieve this object to receive information about any transaction routed through your
|
|
4216
|
+
* Lightspark Node. *
|
|
4217
|
+
*/
|
|
3816
4218
|
interface RoutingTransaction {
|
|
3817
4219
|
/**
|
|
3818
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3819
|
-
* string.
|
|
4220
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4221
|
+
* Should be treated as an opaque string.
|
|
3820
4222
|
**/
|
|
3821
4223
|
id: string;
|
|
3822
4224
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3838,8 +4240,9 @@ interface RoutingTransaction {
|
|
|
3838
4240
|
/** If known, the channel this transaction was forwarded to. **/
|
|
3839
4241
|
outgoingChannelId?: string | undefined;
|
|
3840
4242
|
/**
|
|
3841
|
-
* The fees collected by the node when routing this transaction.
|
|
3842
|
-
* the incoming amount to determine how much fees were
|
|
4243
|
+
* The fees collected by the node when routing this transaction.
|
|
4244
|
+
* We subtract the outgoing amount to the incoming amount to determine how much fees were
|
|
4245
|
+
* collected.
|
|
3843
4246
|
**/
|
|
3844
4247
|
fees?: CurrencyAmount | undefined;
|
|
3845
4248
|
/** If applicable, user-facing error message describing why the routing failed. **/
|
|
@@ -3851,8 +4254,9 @@ declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransacti
|
|
|
3851
4254
|
|
|
3852
4255
|
interface ScreenNodeInput {
|
|
3853
4256
|
/**
|
|
3854
|
-
* The compliance provider that is going to screen the node.
|
|
3855
|
-
* provider and store the API key on the Lightspark
|
|
4257
|
+
* The compliance provider that is going to screen the node.
|
|
4258
|
+
* You need to be a customer of the selected provider and store the API key on the Lightspark
|
|
4259
|
+
* account setting page.
|
|
3856
4260
|
**/
|
|
3857
4261
|
provider: ComplianceProvider;
|
|
3858
4262
|
/** The public key of the lightning node that needs to be screened. **/
|
|
@@ -3872,7 +4276,10 @@ interface SendPaymentInput {
|
|
|
3872
4276
|
timeoutSecs: number;
|
|
3873
4277
|
/** The amount you will send to the destination node, expressed in msats. **/
|
|
3874
4278
|
amountMsats: number;
|
|
3875
|
-
/**
|
|
4279
|
+
/**
|
|
4280
|
+
* The maximum amount of fees that you want to pay for this payment to be sent, expressed in
|
|
4281
|
+
* msats. *
|
|
4282
|
+
*/
|
|
3876
4283
|
maximumFeesMsats: number;
|
|
3877
4284
|
}
|
|
3878
4285
|
|
|
@@ -3887,8 +4294,9 @@ interface SetInvoicePaymentHashInput {
|
|
|
3887
4294
|
/** The 32-byte hash of the payment preimage. **/
|
|
3888
4295
|
paymentHash: string;
|
|
3889
4296
|
/**
|
|
3890
|
-
* The 32-byte nonce used to generate the invoice preimage if applicable.
|
|
3891
|
-
* RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw
|
|
4297
|
+
* The 32-byte nonce used to generate the invoice preimage if applicable.
|
|
4298
|
+
* It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw
|
|
4299
|
+
* preimage.
|
|
3892
4300
|
**/
|
|
3893
4301
|
preimageNonce?: string | undefined;
|
|
3894
4302
|
}
|
|
@@ -3897,21 +4305,6 @@ interface SetInvoicePaymentHashOutput {
|
|
|
3897
4305
|
invoiceId: string;
|
|
3898
4306
|
}
|
|
3899
4307
|
|
|
3900
|
-
interface Signable {
|
|
3901
|
-
/**
|
|
3902
|
-
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3903
|
-
* string.
|
|
3904
|
-
**/
|
|
3905
|
-
id: string;
|
|
3906
|
-
/** The date and time when the entity was first created. **/
|
|
3907
|
-
createdAt: string;
|
|
3908
|
-
/** The date and time when the entity was last updated. **/
|
|
3909
|
-
updatedAt: string;
|
|
3910
|
-
/** The typename of the object **/
|
|
3911
|
-
typename: string;
|
|
3912
|
-
}
|
|
3913
|
-
declare const getSignableQuery: (id: string) => Query<Signable>;
|
|
3914
|
-
|
|
3915
4308
|
interface SignInvoiceInput {
|
|
3916
4309
|
/** The unique identifier of the invoice to be signed. **/
|
|
3917
4310
|
invoiceId: string;
|
|
@@ -3936,6 +4329,21 @@ interface SignMessagesOutput {
|
|
|
3936
4329
|
signedPayloads: SignablePayload[];
|
|
3937
4330
|
}
|
|
3938
4331
|
|
|
4332
|
+
interface Signable {
|
|
4333
|
+
/**
|
|
4334
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4335
|
+
* Should be treated as an opaque string.
|
|
4336
|
+
**/
|
|
4337
|
+
id: string;
|
|
4338
|
+
/** The date and time when the entity was first created. **/
|
|
4339
|
+
createdAt: string;
|
|
4340
|
+
/** The date and time when the entity was last updated. **/
|
|
4341
|
+
updatedAt: string;
|
|
4342
|
+
/** The typename of the object **/
|
|
4343
|
+
typename: string;
|
|
4344
|
+
}
|
|
4345
|
+
declare const getSignableQuery: (id: string) => Query<Signable>;
|
|
4346
|
+
|
|
3939
4347
|
interface UpdateChannelPerCommitmentPointInput {
|
|
3940
4348
|
channelId: string;
|
|
3941
4349
|
perCommitmentPoint: string;
|
|
@@ -3955,7 +4363,10 @@ interface UpdateNodeSharedSecretOutput {
|
|
|
3955
4363
|
nodeId: string;
|
|
3956
4364
|
}
|
|
3957
4365
|
|
|
3958
|
-
/**
|
|
4366
|
+
/**
|
|
4367
|
+
* This is an enum of the potential event types that can be associated with your Lightspark
|
|
4368
|
+
* wallets. *
|
|
4369
|
+
*/
|
|
3959
4370
|
declare enum WebhookEventType {
|
|
3960
4371
|
/**
|
|
3961
4372
|
* This is an enum value that represents values that could be added in the future.
|
|
@@ -3977,11 +4388,15 @@ declare enum WebhookEventType {
|
|
|
3977
4388
|
LOW_BALANCE = "LOW_BALANCE"
|
|
3978
4389
|
}
|
|
3979
4390
|
|
|
3980
|
-
/**
|
|
4391
|
+
/**
|
|
4392
|
+
* This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet.
|
|
4393
|
+
* You can retrieve this object to receive detailed information about any L1 withdrawal associated
|
|
4394
|
+
* with your Lightspark Node or account. *
|
|
4395
|
+
*/
|
|
3981
4396
|
interface Withdrawal {
|
|
3982
4397
|
/**
|
|
3983
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3984
|
-
* string.
|
|
4398
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4399
|
+
* Should be treated as an opaque string.
|
|
3985
4400
|
**/
|
|
3986
4401
|
id: string;
|
|
3987
4402
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -4022,4 +4437,4 @@ interface Withdrawal {
|
|
|
4022
4437
|
}
|
|
4023
4438
|
declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
|
|
4024
4439
|
|
|
4025
|
-
export {
|
|
4440
|
+
export { getDepositQuery as $, Account as A, Balances as B, CancelInvoiceInput as C, CreateApiTokenOutput as D, CreateInvitationWithIncentivesInput as E, CreateInvitationWithIncentivesOutput as F, CreateInvoiceInput as G, CreateInvoiceOutput as H, CreateLnurlInvoiceInput as I, CreateNodeWalletAddressInput as J, CreateNodeWalletAddressOutput as K, LightsparkClient as L, CreateTestModeInvoiceInput as M, CreateTestModeInvoiceOutput as N, CreateTestModePaymentInput as O, CreateTestModePaymentoutput as P, CreateUmaInvitationInput as Q, CreateUmaInvitationOutput as R, CreateUmaInvoiceInput as S, CurrencyAmount as T, CurrencyUnit as U, DeclineToSignMessagesInput as V, WebhookEventType as W, DeclineToSignMessagesOutput as X, DeleteApiTokenInput as Y, DeleteApiTokenOutput as Z, Deposit as _, AccountToApiTokensConnection as a, ReleaseChannelPerCommitmentSecretOutput as a$, Entity as a0, FeeEstimate as a1, FundNodeInput as a2, FundNodeOutput as a3, GraphNode as a4, Hop as a5, getHopQuery as a6, HtlcAttemptFailureCode as a7, IdAndSignature as a8, IncentivesIneligibilityReason as a9, NodeAddressType as aA, NodeToAddressesConnection as aB, OnChainTransaction as aC, getOnChainTransactionQuery as aD, OutgoingPayment as aE, OutgoingPaymentAttempt as aF, OutgoingPaymentAttemptStatus as aG, OutgoingPaymentAttemptToHopsConnection as aH, OutgoingPaymentToAttemptsConnection as aI, OutgoingPaymentsForInvoiceQueryInput as aJ, OutgoingPaymentsForInvoiceQueryOutput as aK, PageInfo as aL, PayInvoiceInput as aM, PayInvoiceOutput as aN, PayUmaInvoiceInput as aO, PaymentDirection as aP, PaymentFailureReason as aQ, PaymentRequest as aR, getPaymentRequestQuery as aS, PaymentRequestData as aT, PaymentRequestStatus as aU, Permission as aV, PostTransactionData as aW, RegionCode as aX, RegisterPaymentInput as aY, RegisterPaymentOutput as aZ, ReleaseChannelPerCommitmentSecretInput as a_, IncentivesStatus as aa, IncomingPayment as ab, IncomingPaymentAttempt as ac, getIncomingPaymentAttemptQuery as ad, IncomingPaymentAttemptStatus as ae, IncomingPaymentToAttemptsConnection as af, Invoice as ag, getInvoiceQuery as ah, InvoiceData as ai, InvoiceType as aj, LightningFeeEstimateForInvoiceInput as ak, LightningFeeEstimateForNodeInput as al, LightningFeeEstimateOutput as am, LightningTransaction as an, getLightningTransactionQuery as ao, LightsparkNode as ap, getLightsparkNodeQuery as aq, LightsparkNodeOwner as ar, getLightsparkNodeOwnerQuery as as, LightsparkNodeStatus as at, LightsparkNodeToChannelsConnection as au, LightsparkNodeWithOSK as av, LightsparkNodeWithRemoteSigning as aw, Node as ax, getNodeQuery as ay, NodeAddress as az, AccountToChannelsConnection as b, ReleasePaymentPreimageInput as b0, ReleasePaymentPreimageOutput as b1, RemoteSigningSubEventType as b2, RequestWithdrawalInput as b3, RequestWithdrawalOutput as b4, RichText as b5, RiskRating as b6, RoutingTransaction as b7, getRoutingTransactionQuery as b8, RoutingTransactionFailureReason as b9, UpdateChannelPerCommitmentPointOutput as bA, UpdateNodeSharedSecretInput as bB, UpdateNodeSharedSecretOutput as bC, Wallet as bD, WalletStatus as bE, WalletToPaymentRequestsConnection as bF, WalletToTransactionsConnection as bG, Withdrawal as bH, getWithdrawalQuery as bI, WithdrawalMode as bJ, WithdrawalRequest as bK, WithdrawalRequestStatus as bL, WithdrawalRequestToChannelClosingTransactionsConnection as bM, WithdrawalRequestToChannelOpeningTransactionsConnection as bN, ScreenNodeInput as ba, ScreenNodeOutput as bb, Secret as bc, SendPaymentInput as bd, SendPaymentOutput as be, SetInvoicePaymentHashInput as bf, SetInvoicePaymentHashOutput as bg, SignInvoiceInput as bh, SignInvoiceOutput as bi, SignMessagesInput as bj, SignMessagesOutput as bk, Signable as bl, getSignableQuery as bm, SignablePayload as bn, getSignablePayloadQuery as bo, SignablePayloadStatus as bp, SingleNodeDashboard as bq, Transaction as br, getTransactionQuery as bs, TransactionFailures as bt, TransactionStatus as bu, TransactionType as bv, TransactionUpdate as bw, UmaInvitation as bx, getUmaInvitationQuery as by, UpdateChannelPerCommitmentPointInput as bz, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BlockchainBalance as i, CancelInvoiceOutput as j, Channel as k, ChannelClosingTransaction as l, getChannelClosingTransactionQuery as m, ChannelFees as n, ChannelOpeningTransaction as o, getChannelOpeningTransactionQuery as p, ChannelSnapshot as q, ChannelStatus as r, ChannelToTransactionsConnection as s, ClaimUmaInvitationInput as t, ClaimUmaInvitationOutput as u, ClaimUmaInvitationWithIncentivesInput as v, ClaimUmaInvitationWithIncentivesOutput as w, ComplianceProvider as x, Connection as y, CreateApiTokenInput as z };
|