@lightsparkdev/lightspark-sdk 1.2.3 → 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.
Files changed (110) hide show
  1. package/CHANGELOG.md +13 -0
  2. package/dist/{BitcoinNetwork-37e9f091.d.ts → BitcoinNetwork-972b1d01.d.ts} +4 -6
  3. package/dist/{chunk-NCPWHRFO.js → chunk-Y55D3PD4.js} +11 -11
  4. package/dist/env.d.cts +1 -1
  5. package/dist/env.d.ts +1 -1
  6. package/dist/{index-449c9f58.d.ts → index-a5028d74.d.ts} +572 -943
  7. package/dist/index.cjs +263 -232
  8. package/dist/index.d.cts +3 -3
  9. package/dist/index.d.ts +3 -3
  10. package/dist/index.js +43 -12
  11. package/dist/objects/index.d.cts +2 -2
  12. package/dist/objects/index.d.ts +2 -2
  13. package/dist/objects/index.js +1 -1
  14. package/package.json +2 -2
  15. package/src/client.ts +18 -0
  16. package/src/graphql/CancelInvoice.ts +17 -0
  17. package/src/objects/Account.ts +2 -2
  18. package/src/objects/AccountToApiTokensConnection.ts +3 -6
  19. package/src/objects/AccountToChannelsConnection.ts +3 -3
  20. package/src/objects/AccountToNodesConnection.ts +3 -6
  21. package/src/objects/AccountToPaymentRequestsConnection.ts +3 -6
  22. package/src/objects/AccountToTransactionsConnection.ts +5 -8
  23. package/src/objects/AccountToWalletsConnection.ts +3 -6
  24. package/src/objects/ApiToken.ts +7 -8
  25. package/src/objects/Balances.ts +16 -18
  26. package/src/objects/BitcoinNetwork.ts +4 -6
  27. package/src/objects/BlockchainBalance.ts +1 -4
  28. package/src/objects/CancelInvoiceInput.ts +18 -0
  29. package/src/objects/CancelInvoiceOutput.ts +26 -0
  30. package/src/objects/Channel.ts +16 -25
  31. package/src/objects/ChannelClosingTransaction.ts +10 -17
  32. package/src/objects/ChannelFees.ts +1 -4
  33. package/src/objects/ChannelOpeningTransaction.ts +10 -17
  34. package/src/objects/ChannelStatus.ts +13 -19
  35. package/src/objects/ChannelToTransactionsConnection.ts +6 -6
  36. package/src/objects/ComplianceProvider.ts +2 -3
  37. package/src/objects/Connection.ts +3 -6
  38. package/src/objects/CreateApiTokenInput.ts +1 -4
  39. package/src/objects/CreateLnurlInvoiceInput.ts +2 -2
  40. package/src/objects/CreateTestModePaymentoutput.ts +2 -2
  41. package/src/objects/CurrencyAmount.ts +4 -6
  42. package/src/objects/CurrencyUnit.ts +7 -11
  43. package/src/objects/Deposit.ts +10 -16
  44. package/src/objects/Entity.ts +2 -2
  45. package/src/objects/FeeEstimate.ts +3 -3
  46. package/src/objects/GraphNode.ts +13 -20
  47. package/src/objects/Hop.ts +4 -7
  48. package/src/objects/HtlcAttemptFailureCode.ts +4 -5
  49. package/src/objects/IncentivesIneligibilityReason.ts +13 -25
  50. package/src/objects/IncentivesStatus.ts +5 -8
  51. package/src/objects/IncomingPayment.ts +5 -12
  52. package/src/objects/IncomingPaymentAttempt.ts +3 -4
  53. package/src/objects/IncomingPaymentAttemptStatus.ts +3 -7
  54. package/src/objects/IncomingPaymentToAttemptsConnection.ts +3 -6
  55. package/src/objects/InvoiceData.ts +2 -2
  56. package/src/objects/InvoiceType.ts +2 -3
  57. package/src/objects/LightningFeeEstimateForInvoiceInput.ts +2 -2
  58. package/src/objects/LightningTransaction.ts +4 -8
  59. package/src/objects/LightsparkNode.ts +19 -25
  60. package/src/objects/LightsparkNodeStatus.ts +2 -3
  61. package/src/objects/LightsparkNodeToChannelsConnection.ts +3 -6
  62. package/src/objects/LightsparkNodeWithOSK.ts +19 -27
  63. package/src/objects/LightsparkNodeWithRemoteSigning.ts +17 -25
  64. package/src/objects/Node.ts +13 -19
  65. package/src/objects/NodeAddressType.ts +4 -5
  66. package/src/objects/NodeToAddressesConnection.ts +4 -4
  67. package/src/objects/OnChainTransaction.ts +11 -18
  68. package/src/objects/OutgoingPayment.ts +7 -19
  69. package/src/objects/OutgoingPaymentAttempt.ts +11 -19
  70. package/src/objects/OutgoingPaymentAttemptStatus.ts +3 -7
  71. package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts +5 -9
  72. package/src/objects/OutgoingPaymentToAttemptsConnection.ts +3 -6
  73. package/src/objects/PageInfo.ts +2 -3
  74. package/src/objects/PayInvoiceInput.ts +4 -4
  75. package/src/objects/PaymentDirection.ts +2 -3
  76. package/src/objects/PaymentFailureReason.ts +4 -5
  77. package/src/objects/PaymentRequest.ts +3 -4
  78. package/src/objects/PaymentRequestData.ts +3 -3
  79. package/src/objects/PaymentRequestStatus.ts +4 -5
  80. package/src/objects/Permission.ts +4 -5
  81. package/src/objects/PostTransactionData.ts +3 -6
  82. package/src/objects/RegionCode.ts +12 -43
  83. package/src/objects/RegisterPaymentInput.ts +5 -9
  84. package/src/objects/RemoteSigningSubEventType.ts +3 -7
  85. package/src/objects/RiskRating.ts +5 -6
  86. package/src/objects/RoutingTransaction.ts +8 -15
  87. package/src/objects/RoutingTransactionFailureReason.ts +4 -6
  88. package/src/objects/ScreenNodeInput.ts +2 -2
  89. package/src/objects/SendPaymentInput.ts +2 -2
  90. package/src/objects/SetInvoicePaymentHashInput.ts +2 -2
  91. package/src/objects/SignablePayload.ts +2 -2
  92. package/src/objects/SignablePayloadStatus.ts +2 -3
  93. package/src/objects/Transaction.ts +4 -9
  94. package/src/objects/TransactionFailures.ts +1 -4
  95. package/src/objects/TransactionStatus.ts +6 -11
  96. package/src/objects/TransactionType.ts +12 -22
  97. package/src/objects/UmaInvitation.ts +2 -8
  98. package/src/objects/Wallet.ts +3 -4
  99. package/src/objects/WalletStatus.ts +12 -25
  100. package/src/objects/WalletToPaymentRequestsConnection.ts +3 -6
  101. package/src/objects/WalletToTransactionsConnection.ts +3 -6
  102. package/src/objects/WebhookEventType.ts +4 -5
  103. package/src/objects/Withdrawal.ts +11 -18
  104. package/src/objects/WithdrawalMode.ts +3 -7
  105. package/src/objects/WithdrawalRequest.ts +3 -7
  106. package/src/objects/WithdrawalRequestStatus.ts +2 -3
  107. package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +4 -10
  108. package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +4 -10
  109. package/src/objects/index.ts +2 -0
  110. package/src/tests/integration/general-regtest.test.ts +14 -0
@@ -1,6 +1,6 @@
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-37e9f091.js';
3
+ import { B as BitcoinNetwork } from './BitcoinNetwork-972b1d01.js';
4
4
 
5
5
  /**
6
6
  * Args for creating a new SigningKeyLoader. Must be one of the sub types.
@@ -26,21 +26,17 @@ interface MasterSeedSigningKeyLoaderArgs {
26
26
  network: BitcoinNetwork;
27
27
  }
28
28
 
29
- /**
30
- * This enum identifies the unit of currency associated with a CurrencyAmount.
31
- * *
32
- */
29
+ /** This enum identifies the unit of currency associated with a CurrencyAmount. **/
33
30
  declare enum CurrencyUnit {
34
31
  /**
35
- * This is an enum value that represents values that could be added in the
36
- * future. Clients should support unknown values as more of them could be
37
- * added without notice.
32
+ * This is an enum value that represents values that could be added in the future.
33
+ * Clients should support unknown values as more of them could be added without notice.
38
34
  */
39
35
  FUTURE_VALUE = "FUTURE_VALUE",
40
36
  /**
41
37
  * Bitcoin is the cryptocurrency native to the Bitcoin network.
42
- * It is used as the native medium for value transfer for the Lightning
43
- * Network. *
38
+ * It is used as the native medium for value transfer for the Lightning Network.
39
+ * *
44
40
  */
45
41
  BITCOIN = "BITCOIN",
46
42
  /**
@@ -50,8 +46,8 @@ declare enum CurrencyUnit {
50
46
  */
51
47
  SATOSHI = "SATOSHI",
52
48
  /**
53
- * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit
54
- * instead when possible. *
49
+ * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
50
+ * *
55
51
  */
56
52
  MILLISATOSHI = "MILLISATOSHI",
57
53
  /** United States Dollar. **/
@@ -85,24 +81,21 @@ interface CurrencyAmount {
85
81
  /** The unit of user's preferred currency. **/
86
82
  preferredCurrencyUnit: CurrencyUnit;
87
83
  /**
88
- * The rounded numeric value for this CurrencyAmount in the very base level
89
- * of user's preferred currency. For example, for USD, the value will be in
90
- * cents.
84
+ * The rounded numeric value for this CurrencyAmount in the very base level of user's preferred
85
+ * currency. For example, for USD, the value will be in cents.
91
86
  **/
92
87
  preferredCurrencyValueRounded: number;
93
88
  /**
94
- * The approximate float value for this CurrencyAmount in the very base level
95
- * of user's preferred currency. For example, for USD, the value will be in
96
- * 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.
97
91
  **/
98
92
  preferredCurrencyValueApprox: number;
99
93
  }
100
94
 
101
95
  declare enum LightsparkNodeStatus {
102
96
  /**
103
- * This is an enum value that represents values that could be added in the
104
- * future. Clients should support unknown values as more of them could be
105
- * added without notice.
97
+ * This is an enum value that represents values that could be added in the future.
98
+ * Clients should support unknown values as more of them could be added without notice.
106
99
  */
107
100
  FUTURE_VALUE = "FUTURE_VALUE",
108
101
  CREATED = "CREATED",
@@ -118,14 +111,13 @@ declare enum LightsparkNodeStatus {
118
111
  }
119
112
 
120
113
  /**
121
- * This is an enum of the potential types of addresses that a node on the
122
- * Lightning Network can have. *
114
+ * This is an enum of the potential types of addresses that a node on the Lightning Network can
115
+ * have. *
123
116
  */
124
117
  declare enum NodeAddressType {
125
118
  /**
126
- * This is an enum value that represents values that could be added in the
127
- * future. Clients should support unknown values as more of them could be
128
- * added without notice.
119
+ * This is an enum value that represents values that could be added in the future.
120
+ * Clients should support unknown values as more of them could be added without notice.
129
121
  */
130
122
  FUTURE_VALUE = "FUTURE_VALUE",
131
123
  IPV4 = "IPV4",
@@ -167,14 +159,13 @@ type AccountDashboard = {
167
159
  };
168
160
 
169
161
  /**
170
- * This is an enum of the potential permissions that a Lightspark user can have
171
- * in regards to account management. *
162
+ * This is an enum of the potential permissions that a Lightspark user can have in regards to
163
+ * account management. *
172
164
  */
173
165
  declare enum Permission {
174
166
  /**
175
- * This is an enum value that represents values that could be added in the
176
- * future. Clients should support unknown values as more of them could be
177
- * added without notice.
167
+ * This is an enum value that represents values that could be added in the future.
168
+ * Clients should support unknown values as more of them could be added without notice.
178
169
  */
179
170
  FUTURE_VALUE = "FUTURE_VALUE",
180
171
  ALL = "ALL",
@@ -195,9 +186,9 @@ declare enum Permission {
195
186
 
196
187
  /**
197
188
  * This is an object representing a Lightspark API token,
198
- * that can be used to authenticate this account when making API calls or using
199
- * our SDKs. See the “Authentication” section of our API docs for more details
200
- * on its usage. *
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
+ * *
201
192
  */
202
193
  interface ApiToken {
203
194
  /**
@@ -210,14 +201,13 @@ interface ApiToken {
210
201
  /** The date and time when the entity was last updated. **/
211
202
  updatedAt: string;
212
203
  /**
213
- * An opaque identifier that should be used as a client_id (or username) in
214
- * the HTTP Basic Authentication scheme when issuing requests against the
215
- * Lightspark API.
204
+ * An opaque identifier that should be used as a client_id (or username) in the HTTP Basic
205
+ * Authentication scheme when issuing requests against the Lightspark API.
216
206
  **/
217
207
  clientId: string;
218
208
  /**
219
- * An arbitrary name chosen by the creator of the token to help identify the
220
- * token in the list of 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.
221
211
  **/
222
212
  name: string;
223
213
  /** A list of permissions granted to the token. **/
@@ -228,9 +218,8 @@ interface ApiToken {
228
218
  declare const getApiTokenQuery: (id: string) => Query<ApiToken>;
229
219
 
230
220
  /**
231
- * This is an object representing information about a page returned by the
232
- * Lightspark API. For more information,
233
- * please see the “Pagination” section of our API docs for more information
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
234
223
  * about its usage. *
235
224
  */
236
225
  interface PageInfo {
@@ -243,14 +232,11 @@ interface PageInfo {
243
232
  interface AccountToApiTokensConnection {
244
233
  /**
245
234
  * The total count of objects in this connection, using the current filters.
246
- * It is different from the number of objects returned in the current page
247
- * (in the `entities` field).
235
+ * It is different from the number of objects returned in the current page (in the `entities`
236
+ * field).
248
237
  **/
249
238
  count: number;
250
- /**
251
- * An object that holds pagination information about the objects in this
252
- * connection. *
253
- */
239
+ /** An object that holds pagination information about the objects in this connection. **/
254
240
  pageInfo: PageInfo;
255
241
  /** The API tokens for the current page of this connection. **/
256
242
  entities: ApiToken[];
@@ -258,58 +244,49 @@ interface AccountToApiTokensConnection {
258
244
  typename: string;
259
245
  }
260
246
 
261
- /**
262
- * This is an enum representing the status of a channel on the Lightning
263
- * Network. *
264
- */
247
+ /** This is an enum representing the status of a channel on the Lightning Network. **/
265
248
  declare enum ChannelStatus {
266
249
  /**
267
- * This is an enum value that represents values that could be added in the
268
- * future. Clients should support unknown values as more of them could be
269
- * added without notice.
250
+ * This is an enum value that represents values that could be added in the future.
251
+ * Clients should support unknown values as more of them could be added without notice.
270
252
  */
271
253
  FUTURE_VALUE = "FUTURE_VALUE",
272
254
  /** The channel is online and ready to send and receive funds. **/
273
255
  OK = "OK",
274
256
  /**
275
- * The channel has been created, but the Bitcoin transaction that initiates
276
- * it still needs to be confirmed on the Bitcoin blockchain.
277
- * *
257
+ * The channel has been created, but the Bitcoin transaction that initiates it still needs to be
258
+ * confirmed on the Bitcoin blockchain. *
278
259
  */
279
260
  PENDING = "PENDING",
280
261
  /** The channel is not available, likely because the peer is not online. **/
281
262
  OFFLINE = "OFFLINE",
282
263
  /**
283
- * The channel is behaving properly, but its remote balance is much higher
284
- * than its local balance so it is not balanced properly for sending funds
285
- * out.
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.
286
266
  * *
287
267
  */
288
268
  UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
289
269
  /**
290
- * The channel is behaving properly, but its remote balance is much lower
291
- * than its local balance so it is not balanced properly for receiving funds.
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.
292
272
  * *
293
273
  */
294
274
  UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
295
275
  /**
296
- * The channel has been closed. Information about the channel is still
297
- * available for historical purposes but the channel cannot be used anymore.
276
+ * The channel has been closed. Information about the channel is still available for historical
277
+ * purposes but the channel cannot be used anymore.
298
278
  * *
299
279
  */
300
280
  CLOSED = "CLOSED",
301
281
  /**
302
- * Something unexpected happened and we cannot determine the status of this
303
- * channel. Please try again later or contact the support.
282
+ * Something unexpected happened and we cannot determine the status of this channel.
283
+ * Please try again later or contact the support.
304
284
  * *
305
285
  */
306
286
  ERROR = "ERROR"
307
287
  }
308
288
 
309
- /**
310
- * This represents the fee policies set for a channel on the Lightning Network.
311
- * *
312
- */
289
+ /** This represents the fee policies set for a channel on the Lightning Network. **/
313
290
  interface ChannelFees {
314
291
  baseFee?: CurrencyAmount | undefined;
315
292
  feeRatePerMil?: number | undefined;
@@ -318,8 +295,8 @@ interface ChannelFees {
318
295
  interface ChannelToTransactionsConnection {
319
296
  /**
320
297
  * The total count of objects in this connection, using the current filters.
321
- * It is different from the number of objects returned in the current page
322
- * (in the `entities` field).
298
+ * It is different from the number of objects returned in the current page (in the `entities`
299
+ * field).
323
300
  **/
324
301
  count: number;
325
302
  /**
@@ -328,13 +305,13 @@ interface ChannelToTransactionsConnection {
328
305
  **/
329
306
  averageFee?: CurrencyAmount | undefined;
330
307
  /**
331
- * The total amount transacted for the transactions that transited through
332
- * this channel, according to 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.
333
310
  **/
334
311
  totalAmountTransacted?: CurrencyAmount | undefined;
335
312
  /**
336
- * The total amount of fees for the transactions that transited through this
337
- * channel, according to the 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.
338
315
  **/
339
316
  totalFees?: CurrencyAmount | undefined;
340
317
  }
@@ -342,8 +319,8 @@ interface ChannelToTransactionsConnection {
342
319
  /**
343
320
  * This interface is used by all the entities in the Lightspark system.
344
321
  * It defines a few core fields that are available everywhere.
345
- * Any object that implements this interface can be queried using the `entity`
346
- * query and its ID. *
322
+ * Any object that implements this interface can be queried using the `entity` query and its ID.
323
+ * *
347
324
  */
348
325
  interface Entity {
349
326
  /**
@@ -360,60 +337,50 @@ interface Entity {
360
337
  }
361
338
 
362
339
  /**
363
- * This is an enum of the potential types of transactions that can be
364
- * associated with your Lightspark Node.
365
- * *
340
+ * This is an enum of the potential types of transactions that can be associated with your
341
+ * Lightspark Node. *
366
342
  */
367
343
  declare enum TransactionType {
368
344
  /**
369
- * This is an enum value that represents values that could be added in the
370
- * future. Clients should support unknown values as more of them could be
371
- * added without notice.
345
+ * This is an enum value that represents values that could be added in the future.
346
+ * Clients should support unknown values as more of them could be added without notice.
372
347
  */
373
348
  FUTURE_VALUE = "FUTURE_VALUE",
374
349
  /** Transactions initiated from a Lightspark node on Lightning Network. **/
375
350
  OUTGOING_PAYMENT = "OUTGOING_PAYMENT",
376
351
  /** Transactions received by a Lightspark node on Lightning Network. **/
377
352
  INCOMING_PAYMENT = "INCOMING_PAYMENT",
378
- /**
379
- * Transactions that forwarded payments through Lightspark nodes on Lightning
380
- * Network. *
381
- */
353
+ /** Transactions that forwarded payments through Lightspark nodes on Lightning Network. **/
382
354
  ROUTED = "ROUTED",
383
355
  /**
384
- * Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark
385
- * node to a Bitcoin wallet. *
356
+ * Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark node to a Bitcoin
357
+ * wallet. *
386
358
  */
387
359
  L1_WITHDRAW = "L1_WITHDRAW",
388
360
  /** Transactions on Bitcoin blockchain to fund a Lightspark node's wallet. **/
389
361
  L1_DEPOSIT = "L1_DEPOSIT",
390
362
  /**
391
- * Transactions on Bitcoin blockchain to open a channel on Lightning Network
392
- * funded by the local Lightspark node.
393
- * *
363
+ * Transactions on Bitcoin blockchain to open a channel on Lightning Network funded by the local
364
+ * Lightspark node. *
394
365
  */
395
366
  CHANNEL_OPEN = "CHANNEL_OPEN",
396
367
  /**
397
- * Transactions on Bitcoin blockchain to close a channel on Lightning Network
398
- * where the balances are allocated back to local and remote nodes.
399
- * *
368
+ * Transactions on Bitcoin blockchain to close a channel on Lightning Network where the balances
369
+ * are allocated back to local and remote nodes. *
400
370
  */
401
371
  CHANNEL_CLOSE = "CHANNEL_CLOSE",
402
372
  /** Transactions initiated from a Lightspark node on Lightning Network. **/
403
373
  PAYMENT = "PAYMENT",
404
374
  /** Payment requests from a Lightspark node on Lightning Network **/
405
375
  PAYMENT_REQUEST = "PAYMENT_REQUEST",
406
- /**
407
- * Transactions that forwarded payments through Lightspark nodes on Lightning
408
- * Network. *
409
- */
376
+ /** Transactions that forwarded payments through Lightspark nodes on Lightning Network. **/
410
377
  ROUTE = "ROUTE"
411
378
  }
412
379
 
413
380
  /**
414
381
  * This is an object representing a channel on the Lightning Network.
415
- * You can retrieve this object to get detailed information on a specific
416
- * Lightning Network channel. *
382
+ * You can retrieve this object to get detailed information on a specific Lightning Network
383
+ * channel. *
417
384
  */
418
385
  declare class Channel implements Entity {
419
386
  /**
@@ -432,48 +399,39 @@ declare class Channel implements Entity {
432
399
  /** The transaction that funded the channel upon channel opening. **/
433
400
  readonly fundingTransactionId?: string | undefined;
434
401
  /**
435
- * The total amount of funds in this channel,
436
- * including the channel balance on the local node,
437
- * the channel balance on the remote node and the on-chain fees to close
438
- * 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.
439
404
  **/
440
405
  readonly capacity?: CurrencyAmount | undefined;
441
406
  /** The channel balance on the local node. **/
442
407
  readonly localBalance?: CurrencyAmount | undefined;
443
408
  /**
444
- * The channel balance on the local node that is currently allocated to
445
- * in-progress payments. *
409
+ * The channel balance on the local node that is currently allocated to in-progress payments.
410
+ * *
446
411
  */
447
412
  readonly localUnsettledBalance?: CurrencyAmount | undefined;
448
413
  /** The channel balance on the remote node. **/
449
414
  readonly remoteBalance?: CurrencyAmount | undefined;
450
415
  /**
451
- * The channel balance on the remote node that is currently allocated to
452
- * in-progress payments. *
453
- */
454
- readonly remoteUnsettledBalance?: CurrencyAmount | undefined;
455
- /**
456
- * The channel balance that is currently allocated to in-progress payments.
416
+ * The channel balance on the remote node that is currently allocated to in-progress payments.
457
417
  * *
458
418
  */
419
+ readonly remoteUnsettledBalance?: CurrencyAmount | undefined;
420
+ /** The channel balance that is currently allocated to in-progress payments. **/
459
421
  readonly unsettledBalance?: CurrencyAmount | undefined;
460
422
  /**
461
- * The total balance in this channel,
462
- * including the channel balance on both local and remote nodes.
463
- * *
423
+ * The total balance in this channel, including the channel balance on both local and remote
424
+ * nodes. *
464
425
  */
465
426
  readonly totalBalance?: CurrencyAmount | undefined;
466
427
  /** The current status of this channel. **/
467
428
  readonly status?: ChannelStatus | undefined;
468
429
  /**
469
- * The estimated time to wait for the channel's hash timelock contract to
470
- * expire when force closing 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.
471
432
  **/
472
433
  readonly estimatedForceClosureWaitMinutes?: number | undefined;
473
- /**
474
- * The amount to be paid in fees for the current set of commitment
475
- * transactions. *
476
- */
434
+ /** The amount to be paid in fees for the current set of commitment transactions. **/
477
435
  readonly commitFee?: CurrencyAmount | undefined;
478
436
  /** The fees charged for routing payments through this channel. **/
479
437
  readonly fees?: ChannelFees | undefined;
@@ -481,8 +439,8 @@ declare class Channel implements Entity {
481
439
  readonly remoteNodeId?: string | undefined;
482
440
  /**
483
441
  * The unique identifier of the channel on Lightning Network,
484
- * which is the location in the chain that the channel was confirmed.
485
- * The format is <block-height>:<tx-index>:<tx-output>.
442
+ * which is the location in the chain that the channel was confirmed. The format is
443
+ * <block-height>:<tx-index>:<tx-output>.
486
444
  **/
487
445
  readonly shortChannelId?: string | undefined;
488
446
  constructor(
@@ -502,48 +460,39 @@ declare class Channel implements Entity {
502
460
  /** The transaction that funded the channel upon channel opening. **/
503
461
  fundingTransactionId?: string | undefined,
504
462
  /**
505
- * The total amount of funds in this channel,
506
- * including the channel balance on the local node,
507
- * the channel balance on the remote node and the on-chain fees to close
508
- * 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.
509
465
  **/
510
466
  capacity?: CurrencyAmount | undefined,
511
467
  /** The channel balance on the local node. **/
512
468
  localBalance?: CurrencyAmount | undefined,
513
469
  /**
514
- * The channel balance on the local node that is currently allocated to
515
- * in-progress payments. *
470
+ * The channel balance on the local node that is currently allocated to in-progress payments.
471
+ * *
516
472
  */
517
473
  localUnsettledBalance?: CurrencyAmount | undefined,
518
474
  /** The channel balance on the remote node. **/
519
475
  remoteBalance?: CurrencyAmount | undefined,
520
476
  /**
521
- * The channel balance on the remote node that is currently allocated to
522
- * in-progress payments. *
523
- */
524
- remoteUnsettledBalance?: CurrencyAmount | undefined,
525
- /**
526
- * The channel balance that is currently allocated to in-progress payments.
477
+ * The channel balance on the remote node that is currently allocated to in-progress payments.
527
478
  * *
528
479
  */
480
+ remoteUnsettledBalance?: CurrencyAmount | undefined,
481
+ /** The channel balance that is currently allocated to in-progress payments. **/
529
482
  unsettledBalance?: CurrencyAmount | undefined,
530
483
  /**
531
- * The total balance in this channel,
532
- * including the channel balance on both local and remote nodes.
533
- * *
484
+ * The total balance in this channel, including the channel balance on both local and remote
485
+ * nodes. *
534
486
  */
535
487
  totalBalance?: CurrencyAmount | undefined,
536
488
  /** The current status of this channel. **/
537
489
  status?: ChannelStatus | undefined,
538
490
  /**
539
- * The estimated time to wait for the channel's hash timelock contract to
540
- * expire when force closing 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.
541
493
  **/
542
494
  estimatedForceClosureWaitMinutes?: number | undefined,
543
- /**
544
- * The amount to be paid in fees for the current set of commitment
545
- * transactions. *
546
- */
495
+ /** The amount to be paid in fees for the current set of commitment transactions. **/
547
496
  commitFee?: CurrencyAmount | undefined,
548
497
  /** The fees charged for routing payments through this channel. **/
549
498
  fees?: ChannelFees | undefined,
@@ -551,8 +500,8 @@ declare class Channel implements Entity {
551
500
  remoteNodeId?: string | undefined,
552
501
  /**
553
502
  * The unique identifier of the channel on Lightning Network,
554
- * which is the location in the chain that the channel was confirmed.
555
- * The format is <block-height>:<tx-index>:<tx-output>.
503
+ * which is the location in the chain that the channel was confirmed. The format is
504
+ * <block-height>:<tx-index>:<tx-output>.
556
505
  **/
557
506
  shortChannelId?: string | undefined);
558
507
  getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
@@ -589,18 +538,18 @@ declare class Channel implements Entity {
589
538
 
590
539
  declare class AccountToChannelsConnection {
591
540
  /**
592
- * The total count of objects in this connection, using the current
593
- * filters. It is different from the number of objects returned in the
594
- * current page (in the `entities` field).
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).
595
544
  **/
596
545
  readonly count: number;
597
546
  /** The channels for the current page of this connection. **/
598
547
  readonly entities: Channel[];
599
548
  constructor(
600
549
  /**
601
- * The total count of objects in this connection, using the current
602
- * filters. It is different from the number of objects returned in the
603
- * current page (in the `entities` field).
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).
604
553
  **/
605
554
  count: number,
606
555
  /** The channels for the current page of this connection. **/
@@ -638,43 +587,38 @@ declare class AccountToChannelsConnection {
638
587
  }
639
588
 
640
589
  /**
641
- * This is an object representing the balance associated with your Lightspark
642
- * account. You can retrieve this object to see your balance,
590
+ * This is an object representing the balance associated with your Lightspark account.
591
+ * You can retrieve this object to see your balance,
643
592
  * which can be broken down into several different categorizations.
644
593
  * *
645
594
  */
646
595
  interface Balances {
647
596
  /**
648
- * This represents the balance that should be displayed when asked "how much
649
- * do I own right now?". It represents the amount currently owned,
650
- * including things that may not be owned soon (e.g. in-flight outgoing
651
- * payments, in-flight withdrawals, commit fees, etc.).
652
- * It really is a snapshot of what is officially owned at this instant.
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.
653
602
  **/
654
603
  ownedBalance: CurrencyAmount;
655
604
  /**
656
- * This represents the balance that should be displayed when asked "how much
657
- * can I send on Lightning right now?".
658
- * It represents the amount currently available to be sent on the Lightning
659
- * network. We remove from the balance all the funds that are temporarily
660
- * locked (e.g. channel reserves).
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).
661
609
  **/
662
610
  availableToSendBalance: CurrencyAmount;
663
611
  /**
664
- * This represents the balance that should be displayed when asked "how much
665
- * money can I withdraw on the Bitcoin network right now?".
666
- * It represents the amount currently available to withdraw and is usually
667
- * equal to the `owned_balance` but it does not include in-flight operations
668
- * (which would likely succeed and therefore likely make your withdrawal
669
- * fail).
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).
670
617
  **/
671
618
  availableToWithdrawBalance: CurrencyAmount;
672
619
  }
673
620
 
674
- /**
675
- * This is an object representing a detailed breakdown of the balance for a
676
- * Lightspark Node. *
677
- */
621
+ /** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
678
622
  interface BlockchainBalance {
679
623
  /** The total wallet balance, including unconfirmed UTXOs. **/
680
624
  totalBalance?: CurrencyAmount | undefined;
@@ -693,14 +637,11 @@ interface BlockchainBalance {
693
637
  interface LightsparkNodeToChannelsConnection {
694
638
  /**
695
639
  * The total count of objects in this connection, using the current filters.
696
- * It is different from the number of objects returned in the current page
697
- * (in the `entities` field).
640
+ * It is different from the number of objects returned in the current page (in the `entities`
641
+ * field).
698
642
  **/
699
643
  count: number;
700
- /**
701
- * An object that holds pagination information about the objects in this
702
- * connection. *
703
- */
644
+ /** An object that holds pagination information about the objects in this connection. **/
704
645
  pageInfo: PageInfo;
705
646
  /** The channels for the current page of this connection. **/
706
647
  entities: Channel[];
@@ -717,14 +658,14 @@ interface NodeAddress {
717
658
  }
718
659
 
719
660
  /**
720
- * A connection between a node and the addresses it has announced for itself on
721
- * Lightning Network. *
661
+ * A connection between a node and the addresses it has announced for itself on Lightning Network.
662
+ * *
722
663
  */
723
664
  interface NodeToAddressesConnection {
724
665
  /**
725
666
  * The total count of objects in this connection, using the current filters.
726
- * It is different from the number of objects returned in the current page
727
- * (in the `entities` field).
667
+ * It is different from the number of objects returned in the current page (in the `entities`
668
+ * field).
728
669
  **/
729
670
  count: number;
730
671
  /** The addresses for the current page of this connection. **/
@@ -732,9 +673,9 @@ interface NodeToAddressesConnection {
732
673
  }
733
674
 
734
675
  /**
735
- * This is an object representing a node managed by Lightspark and owned by the
736
- * current connected account. This object contains information about the node’s
737
- * configuration, state, and metadata. *
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
+ * *
738
679
  */
739
680
  interface LightsparkNode {
740
681
  /**
@@ -749,53 +690,48 @@ interface LightsparkNode {
749
690
  /** The Bitcoin Network this node is deployed in. **/
750
691
  bitcoinNetwork: BitcoinNetwork;
751
692
  /**
752
- * The name of this node in the network.
753
- * It will be the most human-readable option possible,
693
+ * The name of this node in the network. It will be the most human-readable option possible,
754
694
  * depending on the data available for this node.
755
695
  **/
756
696
  displayName: string;
757
697
  /** The owner of this LightsparkNode. **/
758
698
  ownerId: string;
759
699
  /**
760
- * The utxos of the channels that are connected to this node.
761
- * This is used in uma flow for pre-screening.
700
+ * The utxos of the channels that are connected to this node. This is used in uma flow for
701
+ * pre-screening.
762
702
  **/
763
703
  umaPrescreeningUtxos: string[];
764
704
  /** The typename of the object **/
765
705
  typename: string;
766
706
  /**
767
- * A name that identifies the node. It has no importance in terms of
768
- * operating the node, it is just a way to identify and search for commercial
769
- * services or popular nodes. This alias can be changed at any time by the
770
- * 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.
771
710
  **/
772
711
  alias?: string | undefined;
773
712
  /**
774
- * A hexadecimal string that describes a color. For example "#000000" is
775
- * black, "#FFFFFF" is white. It has no importance in terms of operating the
776
- * 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,
777
715
  * it is just a way to visually differentiate nodes.
778
716
  * That color can be changed at any time by the node operator.
779
717
  **/
780
718
  color?: string | undefined;
781
719
  /**
782
- * A summary metric used to capture how well positioned a node is to send,
783
- * receive, or route transactions efficiently.
784
- * Maximizing a node's conductivity helps a node’s transactions to be capital
785
- * efficient. The value is an integer ranging between 0 and 10 (bounds
786
- * included).
720
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
721
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
722
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
787
723
  **/
788
724
  conductivity?: number | undefined;
789
725
  /**
790
- * The public key of this node. It acts as a unique identifier of this node
791
- * in the Lightning Network. *
726
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
727
+ * Network. *
792
728
  */
793
729
  publicKey?: string | undefined;
794
730
  /** The current status of this node. **/
795
731
  status?: LightsparkNodeStatus | undefined;
796
732
  /**
797
- * The sum of the balance on the Bitcoin Network, channel balances,
798
- * and commit fees on this node.
733
+ * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
734
+ * node.
799
735
  *
800
736
  * @deprecated Use `balances` instead.
801
737
  **/
@@ -807,8 +743,7 @@ interface LightsparkNode {
807
743
  **/
808
744
  totalLocalBalance?: CurrencyAmount | undefined;
809
745
  /**
810
- * The sum of the channel balances (online only) that are available to send
811
- * on this node.
746
+ * The sum of the channel balances (online only) that are available to send on this node.
812
747
  *
813
748
  * @deprecated Use `balances` instead.
814
749
  **/
@@ -836,14 +771,11 @@ declare const getLightsparkNodeQuery: (id: string) => Query<LightsparkNode>;
836
771
  interface AccountToNodesConnection {
837
772
  /**
838
773
  * 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
840
- * (in the `entities` field).
774
+ * It is different from the number of objects returned in the current page (in the `entities`
775
+ * field).
841
776
  **/
842
777
  count: number;
843
- /**
844
- * An object that holds pagination information about the objects in this
845
- * connection. *
846
- */
778
+ /** An object that holds pagination information about the objects in this connection. **/
847
779
  pageInfo: PageInfo;
848
780
  /** The nodes for the current page of this connection. **/
849
781
  entities: LightsparkNode[];
@@ -852,9 +784,9 @@ interface AccountToNodesConnection {
852
784
  }
853
785
 
854
786
  /**
855
- * This object is an interface of a payment request on the Lightning Network
856
- * (i.e., a Lightning Invoice). It contains data related to parsing the payment
857
- * details of a Lightning Invoice. *
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
+ * *
858
790
  */
859
791
  interface PaymentRequestData {
860
792
  encodedPaymentRequest: string;
@@ -864,14 +796,13 @@ interface PaymentRequestData {
864
796
  }
865
797
 
866
798
  /**
867
- * This is an enum of the potential states that a payment request on the
868
- * Lightning Network can take. *
799
+ * This is an enum of the potential states that a payment request on the Lightning Network can
800
+ * take. *
869
801
  */
870
802
  declare enum PaymentRequestStatus {
871
803
  /**
872
- * This is an enum value that represents values that could be added in the
873
- * future. Clients should support unknown values as more of them could be
874
- * added without notice.
804
+ * This is an enum value that represents values that could be added in the future.
805
+ * Clients should support unknown values as more of them could be added without notice.
875
806
  */
876
807
  FUTURE_VALUE = "FUTURE_VALUE",
877
808
  OPEN = "OPEN",
@@ -879,10 +810,9 @@ declare enum PaymentRequestStatus {
879
810
  }
880
811
 
881
812
  /**
882
- * This object contains information related to a payment request generated or
883
- * received by a LightsparkNode. You can retrieve this object to receive
884
- * payment information about a specific invoice.
885
- * *
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. *
886
816
  */
887
817
  interface PaymentRequest {
888
818
  /**
@@ -906,14 +836,11 @@ declare const getPaymentRequestQuery: (id: string) => Query<PaymentRequest>;
906
836
  interface AccountToPaymentRequestsConnection {
907
837
  /**
908
838
  * The total count of objects in this connection, using the current filters.
909
- * It is different from the number of objects returned in the current page
910
- * (in the `entities` field).
839
+ * It is different from the number of objects returned in the current page (in the `entities`
840
+ * field).
911
841
  **/
912
842
  count: number;
913
- /**
914
- * An object that holds pagination information about the objects in this
915
- * connection. *
916
- */
843
+ /** An object that holds pagination information about the objects in this connection. **/
917
844
  pageInfo: PageInfo;
918
845
  /** The payment requests for the current page of this connection. **/
919
846
  entities: PaymentRequest[];
@@ -922,14 +849,13 @@ interface AccountToPaymentRequestsConnection {
922
849
  }
923
850
 
924
851
  /**
925
- * This is an enum of the potential statuses a transaction associated with your
926
- * Lightspark Node can take. *
852
+ * This is an enum of the potential statuses a transaction associated with your Lightspark Node can
853
+ * take. *
927
854
  */
928
855
  declare enum TransactionStatus {
929
856
  /**
930
- * This is an enum value that represents values that could be added in the
931
- * future. Clients should support unknown values as more of them could be
932
- * added without notice.
857
+ * This is an enum value that represents values that could be added in the future.
858
+ * Clients should support unknown values as more of them could be added without notice.
933
859
  */
934
860
  FUTURE_VALUE = "FUTURE_VALUE",
935
861
  /** Transaction succeeded.. **/
@@ -939,26 +865,20 @@ declare enum TransactionStatus {
939
865
  /** Transaction has been initiated and is currently in-flight. **/
940
866
  PENDING = "PENDING",
941
867
  /**
942
- * For transaction type PAYMENT_REQUEST only.
943
- * No payments have been made to a payment request.
868
+ * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
944
869
  * *
945
870
  */
946
871
  NOT_STARTED = "NOT_STARTED",
947
- /**
948
- * For transaction type PAYMENT_REQUEST only. A payment request has expired.
949
- * *
950
- */
872
+ /** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/
951
873
  EXPIRED = "EXPIRED",
952
874
  /** For transaction type PAYMENT_REQUEST only. **/
953
875
  CANCELLED = "CANCELLED"
954
876
  }
955
877
 
956
878
  /**
957
- * This object represents a payment transaction.
958
- * The transaction can occur either on a Bitcoin Network,
959
- * or over the Lightning Network. You can retrieve this object to receive
960
- * specific information about a particular transaction tied to your Lightspark
961
- * Node.
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.
962
882
  * *
963
883
  */
964
884
  interface Transaction {
@@ -979,10 +899,7 @@ interface Transaction {
979
899
  typename: string;
980
900
  /** The date and time when this transaction was completed or failed. **/
981
901
  resolvedAt?: string | undefined;
982
- /**
983
- * The hash of this transaction, so it can be uniquely identified on the
984
- * Lightning Network. *
985
- */
902
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
986
903
  transactionHash?: string | undefined;
987
904
  }
988
905
  declare const getTransactionQuery: (id: string) => Query<Transaction>;
@@ -990,14 +907,11 @@ declare const getTransactionQuery: (id: string) => Query<Transaction>;
990
907
  interface AccountToTransactionsConnection {
991
908
  /**
992
909
  * The total count of objects in this connection, using the current filters.
993
- * It is different from the number of objects returned in the current page
994
- * (in the `entities` field).
910
+ * It is different from the number of objects returned in the current page (in the `entities`
911
+ * field).
995
912
  **/
996
913
  count: number;
997
- /**
998
- * An object that holds pagination information about the objects in this
999
- * connection. *
1000
- */
914
+ /** An object that holds pagination information about the objects in this connection. **/
1001
915
  pageInfo: PageInfo;
1002
916
  /** The transactions for the current page of this connection. **/
1003
917
  entities: Transaction[];
@@ -1014,8 +928,8 @@ interface AccountToTransactionsConnection {
1014
928
  **/
1015
929
  averageFeeEarned?: CurrencyAmount | undefined;
1016
930
  /**
1017
- * Total amount transacted by the transactions in this connection,
1018
- * with the set of filters and constraints provided.
931
+ * Total amount transacted by the transactions in this connection, with the set of filters and
932
+ * constraints provided.
1019
933
  **/
1020
934
  totalAmountTransacted?: CurrencyAmount | undefined;
1021
935
  }
@@ -1036,15 +950,11 @@ interface LightsparkNodeOwner {
1036
950
  }
1037
951
  declare const getLightsparkNodeOwnerQuery: (id: string) => Query<LightsparkNodeOwner>;
1038
952
 
1039
- /**
1040
- * This is an enum of the potential statuses that your Lightspark wallet can
1041
- * take. *
1042
- */
953
+ /** This is an enum of the potential statuses that your Lightspark wallet can take. **/
1043
954
  declare enum WalletStatus {
1044
955
  /**
1045
- * This is an enum value that represents values that could be added in the
1046
- * future. Clients should support unknown values as more of them could be
1047
- * added without notice.
956
+ * This is an enum value that represents values that could be added in the future.
957
+ * Clients should support unknown values as more of them could be added without notice.
1048
958
  */
1049
959
  FUTURE_VALUE = "FUTURE_VALUE",
1050
960
  /**
@@ -1053,39 +963,30 @@ declare enum WalletStatus {
1053
963
  * *
1054
964
  */
1055
965
  NOT_SETUP = "NOT_SETUP",
1056
- /**
1057
- * The wallet is currently being deployed in the Lightspark infrastructure.
1058
- * *
1059
- */
966
+ /** The wallet is currently being deployed in the Lightspark infrastructure. **/
1060
967
  DEPLOYING = "DEPLOYING",
1061
968
  /**
1062
- * The wallet has been deployed in the Lightspark infrastructure and is ready
1063
- * to be initialized. *
969
+ * The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized.
970
+ * *
1064
971
  */
1065
972
  DEPLOYED = "DEPLOYED",
1066
973
  /** The wallet is currently being initialized. **/
1067
974
  INITIALIZING = "INITIALIZING",
1068
975
  /** The wallet is available and ready to be used. **/
1069
976
  READY = "READY",
1070
- /**
1071
- * The wallet is temporarily available,
1072
- * due to a transient issue or a scheduled maintenance.
1073
- * *
1074
- */
977
+ /** The wallet is temporarily available, due to a transient issue or a scheduled maintenance. **/
1075
978
  UNAVAILABLE = "UNAVAILABLE",
1076
979
  /**
1077
- * The wallet had an unrecoverable failure.
1078
- * This status is not expected to happend and will be investigated by the
1079
- * Lightspark team. *
980
+ * The wallet had an unrecoverable failure. This status is not expected to happend and will be
981
+ * investigated by the Lightspark team. *
1080
982
  */
1081
983
  FAILED = "FAILED",
1082
984
  /** The wallet is being terminated. **/
1083
985
  TERMINATING = "TERMINATING",
1084
986
  /**
1085
- * The wallet has been terminated and is not available in the Lightspark
1086
- * infrastructure anymore. It is not connected to the Lightning network and
1087
- * its funds can only be accessed using the Funds Recovery flow.
1088
- * *
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. *
1089
990
  */
1090
991
  TERMINATED = "TERMINATED"
1091
992
  }
@@ -1093,14 +994,11 @@ declare enum WalletStatus {
1093
994
  interface WalletToPaymentRequestsConnection {
1094
995
  /**
1095
996
  * The total count of objects in this connection, using the current filters.
1096
- * It is different from the number of objects returned in the current page
1097
- * (in the `entities` field).
997
+ * It is different from the number of objects returned in the current page (in the `entities`
998
+ * field).
1098
999
  **/
1099
1000
  count: number;
1100
- /**
1101
- * An object that holds pagination information about the objects in this
1102
- * connection. *
1103
- */
1001
+ /** An object that holds pagination information about the objects in this connection. **/
1104
1002
  pageInfo: PageInfo;
1105
1003
  /** The payment requests for the current page of this connection. **/
1106
1004
  entities: PaymentRequest[];
@@ -1111,14 +1009,11 @@ interface WalletToPaymentRequestsConnection {
1111
1009
  interface WalletToTransactionsConnection {
1112
1010
  /**
1113
1011
  * The total count of objects in this connection, using the current filters.
1114
- * It is different from the number of objects returned in the current page
1115
- * (in the `entities` field).
1012
+ * It is different from the number of objects returned in the current page (in the `entities`
1013
+ * field).
1116
1014
  **/
1117
1015
  count: number;
1118
- /**
1119
- * An object that holds pagination information about the objects in this
1120
- * connection. *
1121
- */
1016
+ /** An object that holds pagination information about the objects in this connection. **/
1122
1017
  pageInfo: PageInfo;
1123
1018
  /** The transactions for the current page of this connection. **/
1124
1019
  entities: Transaction[];
@@ -1129,8 +1024,8 @@ interface WalletToTransactionsConnection {
1129
1024
  /**
1130
1025
  * This object represents a Lightspark Wallet, tied to your Lightspark account.
1131
1026
  * Wallets can be used to send or receive funds over the Lightning Network.
1132
- * You can retrieve this object to receive information about a specific wallet
1133
- * tied to your Lightspark account. *
1027
+ * You can retrieve this object to receive information about a specific wallet tied to your
1028
+ * Lightspark account. *
1134
1029
  */
1135
1030
  declare class Wallet implements LightsparkNodeOwner, Entity {
1136
1031
  /**
@@ -1143,8 +1038,7 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1143
1038
  /** The date and time when the entity was last updated. **/
1144
1039
  readonly updatedAt: string;
1145
1040
  /**
1146
- * The unique identifier of this wallet,
1147
- * as provided by the Lightspark Customer during login.
1041
+ * The unique identifier of this wallet, as provided by the Lightspark Customer during login.
1148
1042
  * *
1149
1043
  */
1150
1044
  readonly thirdPartyIdentifier: string;
@@ -1169,8 +1063,7 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1169
1063
  /** The date and time when the entity was last updated. **/
1170
1064
  updatedAt: string,
1171
1065
  /**
1172
- * The unique identifier of this wallet,
1173
- * as provided by the Lightspark Customer during login.
1066
+ * The unique identifier of this wallet, as provided by the Lightspark Customer during login.
1174
1067
  * *
1175
1068
  */
1176
1069
  thirdPartyIdentifier: string,
@@ -1207,14 +1100,11 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1207
1100
  interface AccountToWalletsConnection {
1208
1101
  /**
1209
1102
  * The total count of objects in this connection, using the current filters.
1210
- * It is different from the number of objects returned in the current page
1211
- * (in the `entities` field).
1103
+ * It is different from the number of objects returned in the current page (in the `entities`
1104
+ * field).
1212
1105
  **/
1213
1106
  count: number;
1214
- /**
1215
- * An object that holds pagination information about the objects in this
1216
- * connection. *
1217
- */
1107
+ /** An object that holds pagination information about the objects in this connection. **/
1218
1108
  pageInfo: PageInfo;
1219
1109
  /** The wallets for the current page of this connection. **/
1220
1110
  entities: Wallet[];
@@ -1223,14 +1113,13 @@ interface AccountToWalletsConnection {
1223
1113
  }
1224
1114
 
1225
1115
  /**
1226
- * This is an enum of the potential reasons why an OutgoingPayment sent from a
1227
- * Lightspark Node may have failed. *
1116
+ * This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may
1117
+ * have failed. *
1228
1118
  */
1229
1119
  declare enum PaymentFailureReason {
1230
1120
  /**
1231
- * This is an enum value that represents values that could be added in the
1232
- * future. Clients should support unknown values as more of them could be
1233
- * added without notice.
1121
+ * This is an enum value that represents values that could be added in the future.
1122
+ * Clients should support unknown values as more of them could be added without notice.
1234
1123
  */
1235
1124
  FUTURE_VALUE = "FUTURE_VALUE",
1236
1125
  NONE = "NONE",
@@ -1246,15 +1135,13 @@ declare enum PaymentFailureReason {
1246
1135
  }
1247
1136
 
1248
1137
  /**
1249
- * This is an enum of the potential reasons that an attempted routed
1250
- * transaction through a Lightspark node may have failed.
1251
- * *
1138
+ * This is an enum of the potential reasons that an attempted routed transaction through a
1139
+ * Lightspark node may have failed. *
1252
1140
  */
1253
1141
  declare enum RoutingTransactionFailureReason {
1254
1142
  /**
1255
- * This is an enum value that represents values that could be added in the
1256
- * future. Clients should support unknown values as more of them could be
1257
- * added without notice.
1143
+ * This is an enum value that represents values that could be added in the future.
1144
+ * Clients should support unknown values as more of them could be added without notice.
1258
1145
  */
1259
1146
  FUTURE_VALUE = "FUTURE_VALUE",
1260
1147
  INCOMING_LINK_FAILURE = "INCOMING_LINK_FAILURE",
@@ -1262,10 +1149,7 @@ declare enum RoutingTransactionFailureReason {
1262
1149
  FORWARDING_FAILURE = "FORWARDING_FAILURE"
1263
1150
  }
1264
1151
 
1265
- /**
1266
- * This object represents payment failures associated with your Lightspark
1267
- * Node. *
1268
- */
1152
+ /** This object represents payment failures associated with your Lightspark Node. **/
1269
1153
  interface TransactionFailures {
1270
1154
  paymentFailures?: PaymentFailureReason[] | undefined;
1271
1155
  routingTransactionFailures?: RoutingTransactionFailureReason[] | undefined;
@@ -1273,8 +1157,8 @@ interface TransactionFailures {
1273
1157
 
1274
1158
  /**
1275
1159
  * This is an object representing the connected Lightspark account.
1276
- * You can retrieve this object to see your account information and objects
1277
- * tied to your account. *
1160
+ * You can retrieve this object to see your account information and objects tied to your account.
1161
+ * *
1278
1162
  */
1279
1163
  declare class Account implements LightsparkNodeOwner, Entity {
1280
1164
  /**
@@ -1337,24 +1221,20 @@ interface CreateApiTokenOutput {
1337
1221
  }
1338
1222
 
1339
1223
  /**
1340
- * This object represents the estimated L1 transaction fees for the Bitcoin
1341
- * network. Fee estimates are separated by potential confirmation speeds for
1342
- * settlement. *
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
+ * *
1343
1227
  */
1344
1228
  interface FeeEstimate {
1345
1229
  feeFast: CurrencyAmount;
1346
1230
  feeMin: CurrencyAmount;
1347
1231
  }
1348
1232
 
1349
- /**
1350
- * This is an enum that enumerates all potential statuses for an incoming
1351
- * payment attempt. *
1352
- */
1233
+ /** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
1353
1234
  declare enum IncomingPaymentAttemptStatus {
1354
1235
  /**
1355
- * This is an enum value that represents values that could be added in the
1356
- * future. Clients should support unknown values as more of them could be
1357
- * added without notice.
1236
+ * This is an enum value that represents values that could be added in the future.
1237
+ * Clients should support unknown values as more of them could be added without notice.
1358
1238
  */
1359
1239
  FUTURE_VALUE = "FUTURE_VALUE",
1360
1240
  ACCEPTED = "ACCEPTED",
@@ -1364,10 +1244,9 @@ declare enum IncomingPaymentAttemptStatus {
1364
1244
  }
1365
1245
 
1366
1246
  /**
1367
- * This object represents any attempted payment sent to a Lightspark node on
1368
- * the Lightning Network. You can retrieve this object to receive payment
1369
- * related information about a specific incoming payment attempt.
1370
- * *
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. *
1371
1250
  */
1372
1251
  interface IncomingPaymentAttempt {
1373
1252
  /**
@@ -1396,14 +1275,11 @@ declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaym
1396
1275
  interface IncomingPaymentToAttemptsConnection {
1397
1276
  /**
1398
1277
  * The total count of objects in this connection, using the current filters.
1399
- * It is different from the number of objects returned in the current page
1400
- * (in the `entities` field).
1278
+ * It is different from the number of objects returned in the current page (in the `entities`
1279
+ * field).
1401
1280
  **/
1402
1281
  count: number;
1403
- /**
1404
- * An object that holds pagination information about the objects in this
1405
- * connection. *
1406
- */
1282
+ /** An object that holds pagination information about the objects in this connection. **/
1407
1283
  pageInfo: PageInfo;
1408
1284
  /** The incoming payment attempts for the current page of this connection. **/
1409
1285
  entities: IncomingPaymentAttempt[];
@@ -1412,10 +1288,9 @@ interface IncomingPaymentToAttemptsConnection {
1412
1288
  }
1413
1289
 
1414
1290
  /**
1415
- * This is an object representing a transaction made over the Lightning
1416
- * Network. You can retrieve this object to receive information about a
1417
- * specific transaction made over Lightning for a Lightspark node.
1418
- * *
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. *
1419
1294
  */
1420
1295
  interface LightningTransaction {
1421
1296
  /**
@@ -1435,22 +1310,16 @@ interface LightningTransaction {
1435
1310
  typename: string;
1436
1311
  /** The date and time when this transaction was completed or failed. **/
1437
1312
  resolvedAt?: string | undefined;
1438
- /**
1439
- * The hash of this transaction, so it can be uniquely identified on the
1440
- * Lightning Network. *
1441
- */
1313
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1442
1314
  transactionHash?: string | undefined;
1443
1315
  }
1444
1316
  declare const getLightningTransactionQuery: (id: string) => Query<LightningTransaction>;
1445
1317
 
1446
- /**
1447
- * This object represents post-transaction data that could be used to register
1448
- * payment for KYT. *
1449
- */
1318
+ /** This object represents post-transaction data that could be used to register payment for KYT. **/
1450
1319
  interface PostTransactionData {
1451
1320
  /**
1452
- * The utxo of the channel over which the payment went through in the format
1453
- * of <transaction_hash>:<output_index>.
1321
+ * The utxo of the channel over which the payment went through in the format of
1322
+ * <transaction_hash>:<output_index>.
1454
1323
  **/
1455
1324
  utxo: string;
1456
1325
  /** The amount of funds transferred in the payment. **/
@@ -1458,10 +1327,9 @@ interface PostTransactionData {
1458
1327
  }
1459
1328
 
1460
1329
  /**
1461
- * This object represents any payment sent to a Lightspark node on the
1462
- * Lightning Network. You can retrieve this object to receive payment related
1463
- * information about a specific payment received by a Lightspark node.
1464
- * *
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. *
1465
1333
  */
1466
1334
  declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
1467
1335
  /**
@@ -1483,20 +1351,14 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
1483
1351
  readonly typename: string;
1484
1352
  /** The date and time when this transaction was completed or failed. **/
1485
1353
  readonly resolvedAt?: string | undefined;
1486
- /**
1487
- * The hash of this transaction, so it can be uniquely identified on the
1488
- * Lightning Network. *
1489
- */
1354
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1490
1355
  readonly transactionHash?: string | undefined;
1491
1356
  /**
1492
1357
  * The optional payment request for this incoming payment,
1493
1358
  * which will be null if the payment is sent through keysend.
1494
1359
  **/
1495
1360
  readonly paymentRequestId?: string | undefined;
1496
- /**
1497
- * The post transaction data which can be used in KYT payment registration.
1498
- * *
1499
- */
1361
+ /** The post transaction data which can be used in KYT payment registration. **/
1500
1362
  readonly umaPostTransactionData?: PostTransactionData[] | undefined;
1501
1363
  constructor(
1502
1364
  /**
@@ -1518,20 +1380,14 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
1518
1380
  typename: string,
1519
1381
  /** The date and time when this transaction was completed or failed. **/
1520
1382
  resolvedAt?: string | undefined,
1521
- /**
1522
- * The hash of this transaction, so it can be uniquely identified on the
1523
- * Lightning Network. *
1524
- */
1383
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1525
1384
  transactionHash?: string | undefined,
1526
1385
  /**
1527
1386
  * The optional payment request for this incoming payment,
1528
1387
  * which will be null if the payment is sent through keysend.
1529
1388
  **/
1530
1389
  paymentRequestId?: string | undefined,
1531
- /**
1532
- * The post transaction data which can be used in KYT payment registration.
1533
- * *
1534
- */
1390
+ /** The post transaction data which can be used in KYT payment registration. **/
1535
1391
  umaPostTransactionData?: PostTransactionData[] | undefined);
1536
1392
  getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
1537
1393
  static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
@@ -1555,9 +1411,8 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
1555
1411
  }
1556
1412
 
1557
1413
  /**
1558
- * This object is an interface representing a Lightning Node on the Lightning
1559
- * Network, and could either be a Lightspark node or a node managed by a third
1560
- * party.
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.
1561
1416
  * *
1562
1417
  */
1563
1418
  interface Node {
@@ -1573,39 +1428,34 @@ interface Node {
1573
1428
  /** The Bitcoin Network this node is deployed in. **/
1574
1429
  bitcoinNetwork: BitcoinNetwork;
1575
1430
  /**
1576
- * The name of this node in the network.
1577
- * It will be the most human-readable option possible,
1431
+ * The name of this node in the network. It will be the most human-readable option possible,
1578
1432
  * depending on the data available for this node.
1579
1433
  **/
1580
1434
  displayName: string;
1581
1435
  /** The typename of the object **/
1582
1436
  typename: string;
1583
1437
  /**
1584
- * A name that identifies the node. It has no importance in terms of
1585
- * operating the node, it is just a way to identify and search for commercial
1586
- * services or popular nodes. This alias can be changed at any time by the
1587
- * 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.
1588
1441
  **/
1589
1442
  alias?: string | undefined;
1590
1443
  /**
1591
- * A hexadecimal string that describes a color. For example "#000000" is
1592
- * black, "#FFFFFF" is white. It has no importance in terms of operating the
1593
- * 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,
1594
1446
  * it is just a way to visually differentiate nodes.
1595
1447
  * That color can be changed at any time by the node operator.
1596
1448
  **/
1597
1449
  color?: string | undefined;
1598
1450
  /**
1599
- * A summary metric used to capture how well positioned a node is to send,
1600
- * receive, or route transactions efficiently.
1601
- * Maximizing a node's conductivity helps a node’s transactions to be capital
1602
- * efficient. The value is an integer ranging between 0 and 10 (bounds
1603
- * included).
1451
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
1452
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
1453
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
1604
1454
  **/
1605
1455
  conductivity?: number | undefined;
1606
1456
  /**
1607
- * The public key of this node. It acts as a unique identifier of this node
1608
- * in the Lightning Network. *
1457
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
1458
+ * Network. *
1609
1459
  */
1610
1460
  publicKey?: string | undefined;
1611
1461
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
@@ -1614,8 +1464,8 @@ declare const getNodeQuery: (id: string) => Query<Node>;
1614
1464
 
1615
1465
  /**
1616
1466
  * This object represents the data associated with a BOLT #11 invoice.
1617
- * You can retrieve this object to receive the relevant data associated with a
1618
- * specific invoice. *
1467
+ * You can retrieve this object to receive the relevant data associated with a specific invoice.
1468
+ * *
1619
1469
  */
1620
1470
  interface InvoiceData {
1621
1471
  encodedPaymentRequest: string;
@@ -1664,9 +1514,8 @@ declare const getInvoiceQuery: (id: string) => Query<Invoice>;
1664
1514
  /** This is an enum for potential invoice types. **/
1665
1515
  declare enum InvoiceType {
1666
1516
  /**
1667
- * This is an enum value that represents values that could be added in the
1668
- * future. Clients should support unknown values as more of them could be
1669
- * added without notice.
1517
+ * This is an enum value that represents values that could be added in the future.
1518
+ * Clients should support unknown values as more of them could be added without notice.
1670
1519
  */
1671
1520
  FUTURE_VALUE = "FUTURE_VALUE",
1672
1521
  /** A standard Bolt 11 invoice. **/
@@ -1686,14 +1535,13 @@ interface ChannelSnapshot {
1686
1535
  }
1687
1536
 
1688
1537
  /**
1689
- * This is an enum representing a particular reason why an htlc sent over the
1690
- * Lightning Network may have failed. *
1538
+ * This is an enum representing a particular reason why an htlc sent over the Lightning Network may
1539
+ * have failed. *
1691
1540
  */
1692
1541
  declare enum HtlcAttemptFailureCode {
1693
1542
  /**
1694
- * This is an enum value that represents values that could be added in the
1695
- * future. Clients should support unknown values as more of them could be
1696
- * added without notice.
1543
+ * This is an enum value that represents values that could be added in the future.
1544
+ * Clients should support unknown values as more of them could be added without notice.
1697
1545
  */
1698
1546
  FUTURE_VALUE = "FUTURE_VALUE",
1699
1547
  INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS = "INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS",
@@ -1726,15 +1574,11 @@ declare enum HtlcAttemptFailureCode {
1726
1574
  UNREADABLE_FAILURE = "UNREADABLE_FAILURE"
1727
1575
  }
1728
1576
 
1729
- /**
1730
- * This is an enum of all potential statuses of a payment attempt made from a
1731
- * Lightspark Node. *
1732
- */
1577
+ /** This is an enum of all potential statuses of a payment attempt made from a Lightspark Node. **/
1733
1578
  declare enum OutgoingPaymentAttemptStatus {
1734
1579
  /**
1735
- * This is an enum value that represents values that could be added in the
1736
- * future. Clients should support unknown values as more of them could be
1737
- * added without notice.
1580
+ * This is an enum value that represents values that could be added in the future.
1581
+ * Clients should support unknown values as more of them could be added without notice.
1738
1582
  */
1739
1583
  FUTURE_VALUE = "FUTURE_VALUE",
1740
1584
  IN_FLIGHT = "IN_FLIGHT",
@@ -1743,9 +1587,9 @@ declare enum OutgoingPaymentAttemptStatus {
1743
1587
  }
1744
1588
 
1745
1589
  /**
1746
- * This object represents a specific node that existed on a particular payment
1747
- * route. You can retrieve this object to get information about a node on a
1748
- * particular payment path and all payment-relevant information for that node.
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.
1749
1593
  * *
1750
1594
  */
1751
1595
  interface Hop {
@@ -1768,10 +1612,7 @@ interface Hop {
1768
1612
  publicKey?: string | undefined;
1769
1613
  /** The amount that is to be forwarded to the destination node. **/
1770
1614
  amountToForward?: CurrencyAmount | undefined;
1771
- /**
1772
- * The fees to be collected by the source node for forwarding the payment
1773
- * over the hop. *
1774
- */
1615
+ /** The fees to be collected by the source node for forwarding the payment over the hop. **/
1775
1616
  fee?: CurrencyAmount | undefined;
1776
1617
  /** The block height at which an unsettled HTLC is considered expired. **/
1777
1618
  expiryBlockHeight?: number | undefined;
@@ -1779,21 +1620,17 @@ interface Hop {
1779
1620
  declare const getHopQuery: (id: string) => Query<Hop>;
1780
1621
 
1781
1622
  /**
1782
- * The connection from an outgoing payment attempt to the list of sequential
1783
- * hops that define the path from sender node to recipient node.
1784
- * *
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. *
1785
1625
  */
1786
1626
  interface OutgoingPaymentAttemptToHopsConnection {
1787
1627
  /**
1788
1628
  * The total count of objects in this connection, using the current filters.
1789
- * It is different from the number of objects returned in the current page
1790
- * (in the `entities` field).
1629
+ * It is different from the number of objects returned in the current page (in the `entities`
1630
+ * field).
1791
1631
  **/
1792
1632
  count: number;
1793
- /**
1794
- * An object that holds pagination information about the objects in this
1795
- * connection. *
1796
- */
1633
+ /** An object that holds pagination information about the objects in this connection. **/
1797
1634
  pageInfo: PageInfo;
1798
1635
  /** The hops for the current page of this connection. **/
1799
1636
  entities: Hop[];
@@ -1802,10 +1639,9 @@ interface OutgoingPaymentAttemptToHopsConnection {
1802
1639
  }
1803
1640
 
1804
1641
  /**
1805
- * This object represents an attempted Lightning Network payment sent from a
1806
- * Lightspark Node. You can retrieve this object to receive payment related
1807
- * information about any payment attempt sent from your Lightspark Node on the
1808
- * Lightning Network,
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,
1809
1645
  * including any potential reasons the payment may have failed.
1810
1646
  * *
1811
1647
  */
@@ -1827,14 +1663,11 @@ declare class OutgoingPaymentAttempt implements Entity {
1827
1663
  readonly outgoingPaymentId: string;
1828
1664
  /** The typename of the object **/
1829
1665
  readonly typename: string;
1830
- /**
1831
- * If the payment attempt failed, then this contains the Bolt #4 failure
1832
- * code. *
1833
- */
1666
+ /** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
1834
1667
  readonly failureCode?: HtlcAttemptFailureCode | undefined;
1835
1668
  /**
1836
- * If the payment attempt failed, then this contains the index of the hop
1837
- * at which the problem occurred.
1669
+ * If the payment attempt failed, then this contains the index of the hop at which the problem
1670
+ * occurred.
1838
1671
  **/
1839
1672
  readonly failureSourceIndex?: number | undefined;
1840
1673
  /** The time the outgoing payment attempt failed or succeeded. **/
@@ -1842,21 +1675,17 @@ declare class OutgoingPaymentAttempt implements Entity {
1842
1675
  /**
1843
1676
  * The total amount of funds required to complete a payment over this route.
1844
1677
  * This value includes the cumulative fees for each hop. As a result,
1845
- * the attempt extended to the first-hop in the route will need to have at
1846
- * least this much value, otherwise the route will fail at an intermediate
1847
- * node due to an insufficient amount.
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.
1848
1680
  **/
1849
1681
  readonly amount?: CurrencyAmount | undefined;
1850
1682
  /**
1851
1683
  * The sum of the fees paid at each hop within the route of this attempt.
1852
- * In the case of a one-hop payment,
1853
- * this value will be zero as we don't need to pay a fee to ourselves.
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.
1854
1686
  **/
1855
1687
  readonly fees?: CurrencyAmount | undefined;
1856
- /**
1857
- * The channel snapshot at the time the outgoing payment attempt was made.
1858
- * *
1859
- */
1688
+ /** The channel snapshot at the time the outgoing payment attempt was made. **/
1860
1689
  readonly channelSnapshot?: ChannelSnapshot | undefined;
1861
1690
  constructor(
1862
1691
  /**
@@ -1876,14 +1705,11 @@ declare class OutgoingPaymentAttempt implements Entity {
1876
1705
  outgoingPaymentId: string,
1877
1706
  /** The typename of the object **/
1878
1707
  typename: string,
1879
- /**
1880
- * If the payment attempt failed, then this contains the Bolt #4 failure
1881
- * code. *
1882
- */
1708
+ /** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
1883
1709
  failureCode?: HtlcAttemptFailureCode | undefined,
1884
1710
  /**
1885
- * If the payment attempt failed, then this contains the index of the hop
1886
- * at which the problem occurred.
1711
+ * If the payment attempt failed, then this contains the index of the hop at which the problem
1712
+ * occurred.
1887
1713
  **/
1888
1714
  failureSourceIndex?: number | undefined,
1889
1715
  /** The time the outgoing payment attempt failed or succeeded. **/
@@ -1891,21 +1717,17 @@ declare class OutgoingPaymentAttempt implements Entity {
1891
1717
  /**
1892
1718
  * The total amount of funds required to complete a payment over this route.
1893
1719
  * This value includes the cumulative fees for each hop. As a result,
1894
- * the attempt extended to the first-hop in the route will need to have at
1895
- * least this much value, otherwise the route will fail at an intermediate
1896
- * node due to an insufficient amount.
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.
1897
1722
  **/
1898
1723
  amount?: CurrencyAmount | undefined,
1899
1724
  /**
1900
1725
  * The sum of the fees paid at each hop within the route of this attempt.
1901
- * In the case of a one-hop payment,
1902
- * this value will be zero as we don't need to pay a fee to ourselves.
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.
1903
1728
  **/
1904
1729
  fees?: CurrencyAmount | undefined,
1905
- /**
1906
- * The channel snapshot at the time the outgoing payment attempt was made.
1907
- * *
1908
- */
1730
+ /** The channel snapshot at the time the outgoing payment attempt was made. **/
1909
1731
  channelSnapshot?: ChannelSnapshot | undefined);
1910
1732
  getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
1911
1733
  static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
@@ -1932,14 +1754,11 @@ declare class OutgoingPaymentAttempt implements Entity {
1932
1754
  interface OutgoingPaymentToAttemptsConnection {
1933
1755
  /**
1934
1756
  * The total count of objects in this connection, using the current filters.
1935
- * It is different from the number of objects returned in the current page
1936
- * (in the `entities` field).
1757
+ * It is different from the number of objects returned in the current page (in the `entities`
1758
+ * field).
1937
1759
  **/
1938
1760
  count: number;
1939
- /**
1940
- * An object that holds pagination information about the objects in this
1941
- * connection. *
1942
- */
1761
+ /** An object that holds pagination information about the objects in this connection. **/
1943
1762
  pageInfo: PageInfo;
1944
1763
  /** The attempts for the current page of this connection. **/
1945
1764
  entities: OutgoingPaymentAttempt[];
@@ -1952,9 +1771,9 @@ interface RichText {
1952
1771
  }
1953
1772
 
1954
1773
  /**
1955
- * This object represents a Lightning Network payment sent from a Lightspark
1956
- * Node. You can retrieve this object to receive payment related information
1957
- * about any payment sent from your Lightspark Node on the Lightning Network.
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.
1958
1777
  * *
1959
1778
  */
1960
1779
  declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
@@ -1977,31 +1796,19 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
1977
1796
  readonly typename: string;
1978
1797
  /** The date and time when this transaction was completed or failed. **/
1979
1798
  readonly resolvedAt?: string | undefined;
1980
- /**
1981
- * The hash of this transaction, so it can be uniquely identified on the
1982
- * Lightning Network. *
1983
- */
1799
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1984
1800
  readonly transactionHash?: string | undefined;
1985
1801
  /** If known, the final recipient node this payment was sent to. **/
1986
1802
  readonly destinationId?: string | undefined;
1987
1803
  /** The fees paid by the sender node to send the payment. **/
1988
1804
  readonly fees?: CurrencyAmount | undefined;
1989
- /**
1990
- * The data of the payment request that was paid by this transaction, if
1991
- * known. *
1992
- */
1805
+ /** The data of the payment request that was paid by this transaction, if known. **/
1993
1806
  readonly paymentRequestData?: PaymentRequestData | undefined;
1994
1807
  /** If applicable, the reason why the payment failed. **/
1995
1808
  readonly failureReason?: PaymentFailureReason | undefined;
1996
- /**
1997
- * If applicable, user-facing error message describing why the payment
1998
- * failed. *
1999
- */
1809
+ /** If applicable, user-facing error message describing why the payment failed. **/
2000
1810
  readonly failureMessage?: RichText | undefined;
2001
- /**
2002
- * The post transaction data which can be used in KYT payment registration.
2003
- * *
2004
- */
1811
+ /** The post transaction data which can be used in KYT payment registration. **/
2005
1812
  readonly umaPostTransactionData?: PostTransactionData[] | undefined;
2006
1813
  /** The preimage of the payment. **/
2007
1814
  readonly paymentPreimage?: string | undefined;
@@ -2025,31 +1832,19 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
2025
1832
  typename: string,
2026
1833
  /** The date and time when this transaction was completed or failed. **/
2027
1834
  resolvedAt?: string | undefined,
2028
- /**
2029
- * The hash of this transaction, so it can be uniquely identified on the
2030
- * Lightning Network. *
2031
- */
1835
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2032
1836
  transactionHash?: string | undefined,
2033
1837
  /** If known, the final recipient node this payment was sent to. **/
2034
1838
  destinationId?: string | undefined,
2035
1839
  /** The fees paid by the sender node to send the payment. **/
2036
1840
  fees?: CurrencyAmount | undefined,
2037
- /**
2038
- * The data of the payment request that was paid by this transaction, if
2039
- * known. *
2040
- */
1841
+ /** The data of the payment request that was paid by this transaction, if known. **/
2041
1842
  paymentRequestData?: PaymentRequestData | undefined,
2042
1843
  /** If applicable, the reason why the payment failed. **/
2043
1844
  failureReason?: PaymentFailureReason | undefined,
2044
- /**
2045
- * If applicable, user-facing error message describing why the payment
2046
- * failed. *
2047
- */
1845
+ /** If applicable, user-facing error message describing why the payment failed. **/
2048
1846
  failureMessage?: RichText | undefined,
2049
- /**
2050
- * The post transaction data which can be used in KYT payment registration.
2051
- * *
2052
- */
1847
+ /** The post transaction data which can be used in KYT payment registration. **/
2053
1848
  umaPostTransactionData?: PostTransactionData[] | undefined,
2054
1849
  /** The preimage of the payment. **/
2055
1850
  paymentPreimage?: string | undefined);
@@ -2079,15 +1874,11 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
2079
1874
  };
2080
1875
  }
2081
1876
 
2082
- /**
2083
- * The alpha-2 representation of a country, as defined by the ISO 3166-1
2084
- * standard. *
2085
- */
1877
+ /** The alpha-2 representation of a country, as defined by the ISO 3166-1 standard. **/
2086
1878
  declare enum RegionCode {
2087
1879
  /**
2088
- * This is an enum value that represents values that could be added in the
2089
- * future. Clients should support unknown values as more of them could be
2090
- * added without notice.
1880
+ * This is an enum value that represents values that could be added in the future.
1881
+ * Clients should support unknown values as more of them could be added without notice.
2091
1882
  */
2092
1883
  FUTURE_VALUE = "FUTURE_VALUE",
2093
1884
  /** The code representing the country of Afghanistan. **/
@@ -2142,15 +1933,9 @@ declare enum RegionCode {
2142
1933
  BM = "BM",
2143
1934
  /** The code representing the country of Bhutan. **/
2144
1935
  BT = "BT",
2145
- /**
2146
- * The code representing the country of The Plurinational State of Bolivia.
2147
- * *
2148
- */
1936
+ /** The code representing the country of The Plurinational State of Bolivia. **/
2149
1937
  BO = "BO",
2150
- /**
2151
- * The code representing the country of Bonaire, Sint Eustatius, and Saba.
2152
- * *
2153
- */
1938
+ /** The code representing the country of Bonaire, Sint Eustatius, and Saba. **/
2154
1939
  BQ = "BQ",
2155
1940
  /** The code representing the country of Bosnia and Herzegovina. **/
2156
1941
  BA = "BA",
@@ -2198,10 +1983,7 @@ declare enum RegionCode {
2198
1983
  KM = "KM",
2199
1984
  /** The code representing the country of Congo. **/
2200
1985
  CG = "CG",
2201
- /**
2202
- * The code representing the country of The Democratic Republic of the Congo.
2203
- * *
2204
- */
1986
+ /** The code representing the country of The Democratic Republic of the Congo. **/
2205
1987
  CD = "CD",
2206
1988
  /** The code representing the country of Cook Islands. **/
2207
1989
  CK = "CK",
@@ -2291,10 +2073,7 @@ declare enum RegionCode {
2291
2073
  GY = "GY",
2292
2074
  /** The code representing the country of Haiti. **/
2293
2075
  HT = "HT",
2294
- /**
2295
- * The code representing the country of Heard Island and McDonald Islands.
2296
- * *
2297
- */
2076
+ /** The code representing the country of Heard Island and McDonald Islands. **/
2298
2077
  HM = "HM",
2299
2078
  /** The code representing the country of Holy See (Vatican City State). **/
2300
2079
  VA = "VA",
@@ -2336,10 +2115,7 @@ declare enum RegionCode {
2336
2115
  KE = "KE",
2337
2116
  /** The code representing the country of Kiribati. **/
2338
2117
  KI = "KI",
2339
- /**
2340
- * The code representing the country of Democratic People's Republic ofKorea.
2341
- * *
2342
- */
2118
+ /** The code representing the country of Democratic People's Republic ofKorea. **/
2343
2119
  KP = "KP",
2344
2120
  /** The code representing the country of Republic of Korea. **/
2345
2121
  KR = "KR",
@@ -2367,10 +2143,7 @@ declare enum RegionCode {
2367
2143
  LU = "LU",
2368
2144
  /** The code representing the country of Macao. **/
2369
2145
  MO = "MO",
2370
- /**
2371
- * The code representing the country of The Former Yugoslav Republic of
2372
- * Macedonia. *
2373
- */
2146
+ /** The code representing the country of The Former Yugoslav Republic of Macedonia. **/
2374
2147
  MK = "MK",
2375
2148
  /** The code representing the country of Madagascar. **/
2376
2149
  MG = "MG",
@@ -2478,10 +2251,7 @@ declare enum RegionCode {
2478
2251
  RW = "RW",
2479
2252
  /** The code representing the country of Saint Barthélemy. **/
2480
2253
  BL = "BL",
2481
- /**
2482
- * The code representing the country of Saint Helena Ascension and Tristan
2483
- * da Cunha. *
2484
- */
2254
+ /** The code representing the country of Saint Helena Ascension and Tristan da Cunha. **/
2485
2255
  SH = "SH",
2486
2256
  /** The code representing the country of Saint Kitts and Nevis. **/
2487
2257
  KN = "KN",
@@ -2523,10 +2293,7 @@ declare enum RegionCode {
2523
2293
  SO = "SO",
2524
2294
  /** The code representing the country of South Africa. **/
2525
2295
  ZA = "ZA",
2526
- /**
2527
- * The code representing the country of South Georgia and the South Sandwich
2528
- * Islands. *
2529
- */
2296
+ /** The code representing the country of South Georgia and the South Sandwich Islands. **/
2530
2297
  GS = "GS",
2531
2298
  /** The code representing the country of South Sudan. **/
2532
2299
  SS = "SS",
@@ -2586,10 +2353,7 @@ declare enum RegionCode {
2586
2353
  GB = "GB",
2587
2354
  /** The code representing the country of United States. **/
2588
2355
  US = "US",
2589
- /**
2590
- * The code representing the country of United States Minor Outlying Islands.
2591
- * *
2592
- */
2356
+ /** The code representing the country of United States Minor Outlying Islands. **/
2593
2357
  UM = "UM",
2594
2358
  /** The code representing the country of Uruguay. **/
2595
2359
  UY = "UY",
@@ -2665,47 +2429,35 @@ type TransactionUpdate = {
2665
2429
  transactionHash?: string;
2666
2430
  };
2667
2431
 
2668
- /**
2669
- * Describes the reason for an invitation to not be eligible for incentives.
2670
- * *
2671
- */
2432
+ /** Describes the reason for an invitation to not be eligible for incentives. **/
2672
2433
  declare enum IncentivesIneligibilityReason {
2673
2434
  /**
2674
- * This is an enum value that represents values that could be added in the
2675
- * future. Clients should support unknown values as more of them could be
2676
- * added without notice.
2435
+ * This is an enum value that represents values that could be added in the future.
2436
+ * Clients should support unknown values as more of them could be added without notice.
2677
2437
  */
2678
2438
  FUTURE_VALUE = "FUTURE_VALUE",
2679
2439
  /**
2680
- * This invitation is not eligible for incentives because it has been created
2681
- * outside of the incentives flow. *
2440
+ * This invitation is not eligible for incentives because it has been created outside of the
2441
+ * incentives flow. *
2682
2442
  */
2683
2443
  DISABLED = "DISABLED",
2684
- /**
2685
- * This invitation is not eligible for incentives because the sender is not
2686
- * eligible. *
2687
- */
2444
+ /** This invitation is not eligible for incentives because the sender is not eligible. **/
2688
2445
  SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
2689
- /**
2690
- * This invitation is not eligible for incentives because the receiver is not
2691
- * eligible. *
2692
- */
2446
+ /** This invitation is not eligible for incentives because the receiver is not eligible. **/
2693
2447
  RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
2694
2448
  /**
2695
- * This invitation is not eligible for incentives because the sending VASP is
2696
- * not part of the incentives program.
2697
- * *
2449
+ * This invitation is not eligible for incentives because the sending VASP is not part of the
2450
+ * incentives program. *
2698
2451
  */
2699
2452
  SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
2700
2453
  /**
2701
- * This invitation is not eligible for incentives because the receiving VASP
2702
- * is not part of the incentives program.
2703
- * *
2454
+ * This invitation is not eligible for incentives because the receiving VASP is not part of the
2455
+ * incentives program. *
2704
2456
  */
2705
2457
  RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
2706
2458
  /**
2707
- * This invitation is not eligible for incentives because the sender and
2708
- * receiver are in the same region. *
2459
+ * This invitation is not eligible for incentives because the sender and receiver are in the same
2460
+ * region. *
2709
2461
  */
2710
2462
  NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
2711
2463
  }
@@ -2713,23 +2465,20 @@ declare enum IncentivesIneligibilityReason {
2713
2465
  /** Describes the status of the incentives for this invitation. **/
2714
2466
  declare enum IncentivesStatus {
2715
2467
  /**
2716
- * This is an enum value that represents values that could be added in the
2717
- * future. Clients should support unknown values as more of them could be
2718
- * added without notice.
2468
+ * This is an enum value that represents values that could be added in the future.
2469
+ * Clients should support unknown values as more of them could be added without notice.
2719
2470
  */
2720
2471
  FUTURE_VALUE = "FUTURE_VALUE",
2721
2472
  /**
2722
- * The invitation is eligible for incentives in its current state.
2723
- * When it is claimed, we will reassess.
2724
- * *
2473
+ * The invitation is eligible for incentives in its current state. When it is claimed, we will
2474
+ * reassess. *
2725
2475
  */
2726
2476
  PENDING = "PENDING",
2727
2477
  /** The incentives have been validated. **/
2728
2478
  VALIDATED = "VALIDATED",
2729
2479
  /**
2730
2480
  * This invitation is not eligible for incentives.
2731
- * A more detailed reason can be found in the
2732
- * `incentives_ineligibility_reason` field.
2481
+ * A more detailed reason can be found in the `incentives_ineligibility_reason` field.
2733
2482
  * *
2734
2483
  */
2735
2484
  INELIGIBLE = "INELIGIBLE"
@@ -2752,32 +2501,22 @@ interface UmaInvitation {
2752
2501
  url: string;
2753
2502
  /** The UMA of the user who created the invitation. **/
2754
2503
  inviterUma: string;
2755
- /**
2756
- * The current status of the incentives that may be tied to this invitation.
2757
- * *
2758
- */
2504
+ /** The current status of the incentives that may be tied to this invitation. **/
2759
2505
  incentivesStatus: IncentivesStatus;
2760
2506
  /** The typename of the object **/
2761
2507
  typename: string;
2762
2508
  /** The UMA of the user who claimed the invitation. **/
2763
2509
  inviteeUma?: string | undefined;
2764
- /**
2765
- * The reason why the invitation is not eligible for incentives, if
2766
- * applicable. *
2767
- */
2510
+ /** The reason why the invitation is not eligible for incentives, if applicable. **/
2768
2511
  incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
2769
2512
  }
2770
2513
  declare const getUmaInvitationQuery: (id: string) => Query<UmaInvitation>;
2771
2514
 
2772
- /**
2773
- * This is an enum of the potential modes that your Bitcoin withdrawal can
2774
- * take. *
2775
- */
2515
+ /** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
2776
2516
  declare enum WithdrawalMode {
2777
2517
  /**
2778
- * This is an enum value that represents values that could be added in the
2779
- * future. Clients should support unknown values as more of them could be
2780
- * added without notice.
2518
+ * This is an enum value that represents values that could be added in the future.
2519
+ * Clients should support unknown values as more of them could be added without notice.
2781
2520
  */
2782
2521
  FUTURE_VALUE = "FUTURE_VALUE",
2783
2522
  WALLET_ONLY = "WALLET_ONLY",
@@ -2787,9 +2526,8 @@ declare enum WithdrawalMode {
2787
2526
  /** This is an enum of the potential statuses that a Withdrawal can take. **/
2788
2527
  declare enum WithdrawalRequestStatus {
2789
2528
  /**
2790
- * This is an enum value that represents values that could be added in the
2791
- * future. Clients should support unknown values as more of them could be
2792
- * added without notice.
2529
+ * This is an enum value that represents values that could be added in the future.
2530
+ * Clients should support unknown values as more of them could be added without notice.
2793
2531
  */
2794
2532
  FUTURE_VALUE = "FUTURE_VALUE",
2795
2533
  CREATED = "CREATED",
@@ -2799,9 +2537,8 @@ declare enum WithdrawalRequestStatus {
2799
2537
  }
2800
2538
 
2801
2539
  /**
2802
- * This is an object representing a transaction which closes a channel on the
2803
- * Lightning Network. This operation allocates balances back to the local and
2804
- * remote nodes.
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.
2805
2542
  * *
2806
2543
  */
2807
2544
  interface ChannelClosingTransaction {
@@ -2819,8 +2556,8 @@ interface ChannelClosingTransaction {
2819
2556
  /** The amount of money involved in this transaction. **/
2820
2557
  amount: CurrencyAmount;
2821
2558
  /**
2822
- * The height of the block that included this transaction.
2823
- * This will be zero for unconfirmed transactions.
2559
+ * The height of the block that included this transaction. This will be zero for unconfirmed
2560
+ * transactions.
2824
2561
  **/
2825
2562
  blockHeight: number;
2826
2563
  /** The Bitcoin blockchain addresses this transaction was sent to. **/
@@ -2829,25 +2566,19 @@ interface ChannelClosingTransaction {
2829
2566
  typename: string;
2830
2567
  /** The date and time when this transaction was completed or failed. **/
2831
2568
  resolvedAt?: string | undefined;
2832
- /**
2833
- * The hash of this transaction, so it can be uniquely identified on the
2834
- * Lightning Network. *
2835
- */
2569
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2836
2570
  transactionHash?: string | undefined;
2837
2571
  /**
2838
- * The fees that were paid by the wallet sending the transaction to commit it
2839
- * to the Bitcoin blockchain.
2572
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
2573
+ * blockchain.
2840
2574
  **/
2841
2575
  fees?: CurrencyAmount | undefined;
2842
2576
  /**
2843
- * The hash of the block that included this transaction.
2844
- * This will be null for unconfirmed transactions.
2577
+ * The hash of the block that included this transaction. This will be null for unconfirmed
2578
+ * transactions.
2845
2579
  **/
2846
2580
  blockHash?: string | undefined;
2847
- /**
2848
- * The number of blockchain confirmations for this transaction in real time.
2849
- * *
2850
- */
2581
+ /** The number of blockchain confirmations for this transaction in real time. **/
2851
2582
  numConfirmations?: number | undefined;
2852
2583
  /** If known, the channel this transaction is closing. **/
2853
2584
  channelId?: string | undefined;
@@ -2855,28 +2586,21 @@ interface ChannelClosingTransaction {
2855
2586
  declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
2856
2587
 
2857
2588
  interface WithdrawalRequestToChannelClosingTransactionsConnection {
2858
- /**
2859
- * An object that holds pagination information about the objects in this
2860
- * connection. *
2861
- */
2589
+ /** An object that holds pagination information about the objects in this connection. **/
2862
2590
  pageInfo: PageInfo;
2863
2591
  /**
2864
2592
  * The total count of objects in this connection, using the current filters.
2865
- * It is different from the number of objects returned in the current page
2866
- * (in the `entities` field).
2593
+ * It is different from the number of objects returned in the current page (in the `entities`
2594
+ * field).
2867
2595
  **/
2868
2596
  count: number;
2869
- /**
2870
- * The channel closing transactions for the current page of this connection.
2871
- * *
2872
- */
2597
+ /** The channel closing transactions for the current page of this connection. **/
2873
2598
  entities: ChannelClosingTransaction[];
2874
2599
  }
2875
2600
 
2876
2601
  /**
2877
- * This is an object representing a transaction which opens a channel on the
2878
- * Lightning Network. This object occurs only for channels funded by the local
2879
- * Lightspark node.
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.
2880
2604
  * *
2881
2605
  */
2882
2606
  interface ChannelOpeningTransaction {
@@ -2894,8 +2618,8 @@ interface ChannelOpeningTransaction {
2894
2618
  /** The amount of money involved in this transaction. **/
2895
2619
  amount: CurrencyAmount;
2896
2620
  /**
2897
- * The height of the block that included this transaction.
2898
- * This will be zero for unconfirmed transactions.
2621
+ * The height of the block that included this transaction. This will be zero for unconfirmed
2622
+ * transactions.
2899
2623
  **/
2900
2624
  blockHeight: number;
2901
2625
  /** The Bitcoin blockchain addresses this transaction was sent to. **/
@@ -2904,25 +2628,19 @@ interface ChannelOpeningTransaction {
2904
2628
  typename: string;
2905
2629
  /** The date and time when this transaction was completed or failed. **/
2906
2630
  resolvedAt?: string | undefined;
2907
- /**
2908
- * The hash of this transaction, so it can be uniquely identified on the
2909
- * Lightning Network. *
2910
- */
2631
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2911
2632
  transactionHash?: string | undefined;
2912
2633
  /**
2913
- * The fees that were paid by the wallet sending the transaction to commit it
2914
- * to the Bitcoin blockchain.
2634
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
2635
+ * blockchain.
2915
2636
  **/
2916
2637
  fees?: CurrencyAmount | undefined;
2917
2638
  /**
2918
- * The hash of the block that included this transaction.
2919
- * This will be null for unconfirmed transactions.
2639
+ * The hash of the block that included this transaction. This will be null for unconfirmed
2640
+ * transactions.
2920
2641
  **/
2921
2642
  blockHash?: string | undefined;
2922
- /**
2923
- * The number of blockchain confirmations for this transaction in real time.
2924
- * *
2925
- */
2643
+ /** The number of blockchain confirmations for this transaction in real time. **/
2926
2644
  numConfirmations?: number | undefined;
2927
2645
  /** If known, the channel this transaction is opening. **/
2928
2646
  channelId?: string | undefined;
@@ -2930,28 +2648,21 @@ interface ChannelOpeningTransaction {
2930
2648
  declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
2931
2649
 
2932
2650
  interface WithdrawalRequestToChannelOpeningTransactionsConnection {
2933
- /**
2934
- * An object that holds pagination information about the objects in this
2935
- * connection. *
2936
- */
2651
+ /** An object that holds pagination information about the objects in this connection. **/
2937
2652
  pageInfo: PageInfo;
2938
2653
  /**
2939
2654
  * The total count of objects in this connection, using the current filters.
2940
- * It is different from the number of objects returned in the current page
2941
- * (in the `entities` field).
2655
+ * It is different from the number of objects returned in the current page (in the `entities`
2656
+ * field).
2942
2657
  **/
2943
2658
  count: number;
2944
- /**
2945
- * The channel opening transactions for the current page of this connection.
2946
- * *
2947
- */
2659
+ /** The channel opening transactions for the current page of this connection. **/
2948
2660
  entities: ChannelOpeningTransaction[];
2949
2661
  }
2950
2662
 
2951
2663
  /**
2952
- * This object represents a request made for an L1 withdrawal from your
2953
- * Lightspark Node to any Bitcoin wallet.
2954
- * You can retrieve this object to receive detailed information about any
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
2955
2666
  * withdrawal request made from your Lightspark account.
2956
2667
  * *
2957
2668
  */
@@ -2969,10 +2680,7 @@ declare class WithdrawalRequest implements Entity {
2969
2680
  readonly amount: CurrencyAmount;
2970
2681
  /** The bitcoin address where the funds should be sent. **/
2971
2682
  readonly bitcoinAddress: string;
2972
- /**
2973
- * The strategy that should be used to withdraw the funds from the account.
2974
- * *
2975
- */
2683
+ /** The strategy that should be used to withdraw the funds from the account. **/
2976
2684
  readonly withdrawalMode: WithdrawalMode;
2977
2685
  /** The current status of this withdrawal request. **/
2978
2686
  readonly status: WithdrawalRequestStatus;
@@ -3001,10 +2709,7 @@ declare class WithdrawalRequest implements Entity {
3001
2709
  amount: CurrencyAmount,
3002
2710
  /** The bitcoin address where the funds should be sent. **/
3003
2711
  bitcoinAddress: string,
3004
- /**
3005
- * The strategy that should be used to withdraw the funds from the account.
3006
- * *
3007
- */
2712
+ /** The strategy that should be used to withdraw the funds from the account. **/
3008
2713
  withdrawalMode: WithdrawalMode,
3009
2714
  /** The current status of this withdrawal request. **/
3010
2715
  status: WithdrawalRequestStatus,
@@ -3219,6 +2924,13 @@ declare class LightsparkClient {
3219
2924
  * @returns An Invoice object representing the generated invoice.
3220
2925
  */
3221
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>;
3222
2934
  /**
3223
2935
  * Decodes an encoded lightning invoice string.
3224
2936
  *
@@ -3457,6 +3169,14 @@ declare class LightsparkClient {
3457
3169
  executeRawQuery<T>(query: Query<T>): Promise<T | null>;
3458
3170
  }
3459
3171
 
3172
+ interface CancelInvoiceInput {
3173
+ invoiceId: string;
3174
+ }
3175
+
3176
+ interface CancelInvoiceOutput {
3177
+ invoiceId: string;
3178
+ }
3179
+
3460
3180
  interface ClaimUmaInvitationInput {
3461
3181
  invitationCode: string;
3462
3182
  inviteeUma: string;
@@ -3480,9 +3200,8 @@ interface ClaimUmaInvitationWithIncentivesOutput {
3480
3200
  /** This is an enum identifying a type of compliance provider. **/
3481
3201
  declare enum ComplianceProvider {
3482
3202
  /**
3483
- * This is an enum value that represents values that could be added in the
3484
- * future. Clients should support unknown values as more of them could be
3485
- * added without notice.
3203
+ * This is an enum value that represents values that could be added in the future.
3204
+ * Clients should support unknown values as more of them could be added without notice.
3486
3205
  */
3487
3206
  FUTURE_VALUE = "FUTURE_VALUE",
3488
3207
  CHAINALYSIS = "CHAINALYSIS"
@@ -3491,24 +3210,18 @@ declare enum ComplianceProvider {
3491
3210
  interface Connection {
3492
3211
  /**
3493
3212
  * The total count of objects in this connection, using the current filters.
3494
- * It is different from the number of objects returned in the current page
3495
- * (in the `entities` field).
3213
+ * It is different from the number of objects returned in the current page (in the `entities`
3214
+ * field).
3496
3215
  **/
3497
3216
  count: number;
3498
- /**
3499
- * An object that holds pagination information about the objects in this
3500
- * connection. *
3501
- */
3217
+ /** An object that holds pagination information about the objects in this connection. **/
3502
3218
  pageInfo: PageInfo;
3503
3219
  /** The typename of the object **/
3504
3220
  typename: string;
3505
3221
  }
3506
3222
 
3507
3223
  interface CreateApiTokenInput {
3508
- /**
3509
- * An arbitrary name that the user can choose to identify the API token in a
3510
- * list. *
3511
- */
3224
+ /** An arbitrary name that the user can choose to identify the API token in a list. **/
3512
3225
  name: string;
3513
3226
  /** List of permissions to grant to the API token **/
3514
3227
  permissions: Permission[];
@@ -3546,8 +3259,8 @@ interface CreateLnurlInvoiceInput {
3546
3259
  amountMsats: number;
3547
3260
  /**
3548
3261
  * The SHA256 hash of the LNURL metadata payload.
3549
- * This will be present in the h-tag (SHA256 purpose of payment) of the
3550
- * resulting Bolt 11 invoice.
3262
+ * This will be present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11
3263
+ * invoice.
3551
3264
  **/
3552
3265
  metadataHash: string;
3553
3266
  /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
@@ -3588,8 +3301,8 @@ interface CreateTestModePaymentInput {
3588
3301
 
3589
3302
  /**
3590
3303
  * This is an object identifying the output of a test mode payment.
3591
- * This object can be used to retrieve the associated payment made from a Test
3592
- * Mode Payment call. *
3304
+ * This object can be used to retrieve the associated payment made from a Test Mode Payment call.
3305
+ * *
3593
3306
  */
3594
3307
  interface CreateTestModePaymentoutput {
3595
3308
  /**
@@ -3624,9 +3337,8 @@ interface DeclineToSignMessagesInput {
3624
3337
 
3625
3338
  declare enum SignablePayloadStatus {
3626
3339
  /**
3627
- * This is an enum value that represents values that could be added in the
3628
- * future. Clients should support unknown values as more of them could be
3629
- * added without notice.
3340
+ * This is an enum value that represents values that could be added in the future.
3341
+ * Clients should support unknown values as more of them could be added without notice.
3630
3342
  */
3631
3343
  FUTURE_VALUE = "FUTURE_VALUE",
3632
3344
  CREATED = "CREATED",
@@ -3648,8 +3360,8 @@ interface SignablePayload {
3648
3360
  /** The payload that needs to be signed. **/
3649
3361
  payload: string;
3650
3362
  /**
3651
- * The consistent method for generating the same set of accounts and wallets
3652
- * for a given private key *
3363
+ * The consistent method for generating the same set of accounts and wallets for a given
3364
+ * private key *
3653
3365
  */
3654
3366
  derivationPath: string;
3655
3367
  /** The status of the payload. **/
@@ -3680,8 +3392,8 @@ interface DeleteApiTokenOutput {
3680
3392
  /**
3681
3393
  * This object represents a Deposit made to a Lightspark node wallet.
3682
3394
  * This operation occurs for any L1 funding transaction to the wallet.
3683
- * You can retrieve this object to receive detailed information about the
3684
- * deposit. *
3395
+ * You can retrieve this object to receive detailed information about the deposit.
3396
+ * *
3685
3397
  */
3686
3398
  interface Deposit {
3687
3399
  /**
@@ -3698,8 +3410,8 @@ interface Deposit {
3698
3410
  /** The amount of money involved in this transaction. **/
3699
3411
  amount: CurrencyAmount;
3700
3412
  /**
3701
- * The height of the block that included this transaction.
3702
- * This will be zero for unconfirmed transactions.
3413
+ * The height of the block that included this transaction. This will be zero for unconfirmed
3414
+ * transactions.
3703
3415
  **/
3704
3416
  blockHeight: number;
3705
3417
  /** The Bitcoin blockchain addresses this transaction was sent to. **/
@@ -3710,25 +3422,19 @@ interface Deposit {
3710
3422
  typename: string;
3711
3423
  /** The date and time when this transaction was completed or failed. **/
3712
3424
  resolvedAt?: string | undefined;
3713
- /**
3714
- * The hash of this transaction, so it can be uniquely identified on the
3715
- * Lightning Network. *
3716
- */
3425
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
3717
3426
  transactionHash?: string | undefined;
3718
3427
  /**
3719
- * The fees that were paid by the wallet sending the transaction to commit it
3720
- * to the Bitcoin blockchain.
3428
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
3429
+ * blockchain.
3721
3430
  **/
3722
3431
  fees?: CurrencyAmount | undefined;
3723
3432
  /**
3724
- * The hash of the block that included this transaction.
3725
- * This will be null for unconfirmed transactions.
3433
+ * The hash of the block that included this transaction. This will be null for unconfirmed
3434
+ * transactions.
3726
3435
  **/
3727
3436
  blockHash?: string | undefined;
3728
- /**
3729
- * The number of blockchain confirmations for this transaction in real time.
3730
- * *
3731
- */
3437
+ /** The number of blockchain confirmations for this transaction in real time. **/
3732
3438
  numConfirmations?: number | undefined;
3733
3439
  }
3734
3440
  declare const getDepositQuery: (id: string) => Query<Deposit>;
@@ -3744,9 +3450,8 @@ interface FundNodeOutput {
3744
3450
 
3745
3451
  /**
3746
3452
  * This object represents a node that exists on the Lightning Network,
3747
- * including nodes not managed by Lightspark.
3748
- * You can retrieve this object to get publicly available information about any
3749
- * node 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.
3750
3455
  * *
3751
3456
  */
3752
3457
  declare class GraphNode implements Node, Entity {
@@ -3762,40 +3467,34 @@ declare class GraphNode implements Node, Entity {
3762
3467
  /** The Bitcoin Network this node is deployed in. **/
3763
3468
  readonly bitcoinNetwork: BitcoinNetwork;
3764
3469
  /**
3765
- * The name of this node in the network.
3766
- * It will be the most human-readable option possible,
3470
+ * The name of this node in the network. It will be the most human-readable option possible,
3767
3471
  * depending on the data available for this node.
3768
3472
  **/
3769
3473
  readonly displayName: string;
3770
3474
  /** The typename of the object **/
3771
3475
  readonly typename: string;
3772
3476
  /**
3773
- * A name that identifies the node.
3774
- * It has no importance in terms of operating the node,
3775
- * it is just a way to identify and search for commercial services or
3776
- * popular nodes. This alias can be changed at any time by the node
3777
- * 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.
3778
3480
  **/
3779
3481
  readonly alias?: string | undefined;
3780
3482
  /**
3781
- * A hexadecimal string that describes a color. For example "#000000" is
3782
- * black, "#FFFFFF" is white. It has no importance in terms of operating
3783
- * 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,
3784
3485
  * it is just a way to visually differentiate nodes.
3785
3486
  * That color can be changed at any time by the node operator.
3786
3487
  **/
3787
3488
  readonly color?: string | undefined;
3788
3489
  /**
3789
- * A summary metric used to capture how well positioned a node is to send,
3790
- * receive, or route transactions efficiently.
3791
- * Maximizing a node's conductivity helps a node’s transactions to be
3792
- * capital efficient. The value is an integer ranging between 0 and 10
3793
- * (bounds included).
3490
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
3491
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
3492
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
3794
3493
  **/
3795
3494
  readonly conductivity?: number | undefined;
3796
3495
  /**
3797
- * The public key of this node. It acts as a unique identifier of this node
3798
- * in the Lightning Network. *
3496
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
3497
+ * Network. *
3799
3498
  */
3800
3499
  readonly publicKey?: string | undefined;
3801
3500
  constructor(
@@ -3811,40 +3510,34 @@ declare class GraphNode implements Node, Entity {
3811
3510
  /** The Bitcoin Network this node is deployed in. **/
3812
3511
  bitcoinNetwork: BitcoinNetwork,
3813
3512
  /**
3814
- * The name of this node in the network.
3815
- * It will be the most human-readable option possible,
3513
+ * The name of this node in the network. It will be the most human-readable option possible,
3816
3514
  * depending on the data available for this node.
3817
3515
  **/
3818
3516
  displayName: string,
3819
3517
  /** The typename of the object **/
3820
3518
  typename: string,
3821
3519
  /**
3822
- * A name that identifies the node.
3823
- * It has no importance in terms of operating the node,
3824
- * it is just a way to identify and search for commercial services or
3825
- * popular nodes. This alias can be changed at any time by the node
3826
- * 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.
3827
3523
  **/
3828
3524
  alias?: string | undefined,
3829
3525
  /**
3830
- * A hexadecimal string that describes a color. For example "#000000" is
3831
- * black, "#FFFFFF" is white. It has no importance in terms of operating
3832
- * 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,
3833
3528
  * it is just a way to visually differentiate nodes.
3834
3529
  * That color can be changed at any time by the node operator.
3835
3530
  **/
3836
3531
  color?: string | undefined,
3837
3532
  /**
3838
- * A summary metric used to capture how well positioned a node is to send,
3839
- * receive, or route transactions efficiently.
3840
- * Maximizing a node's conductivity helps a node’s transactions to be
3841
- * capital efficient. The value is an integer ranging between 0 and 10
3842
- * (bounds included).
3533
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
3534
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
3535
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
3843
3536
  **/
3844
3537
  conductivity?: number | undefined,
3845
3538
  /**
3846
- * The public key of this node. It acts as a unique identifier of this node
3847
- * in the Lightning Network. *
3539
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
3540
+ * Network. *
3848
3541
  */
3849
3542
  publicKey?: string | undefined);
3850
3543
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
@@ -3876,8 +3569,8 @@ interface LightningFeeEstimateForInvoiceInput {
3876
3569
  /** The invoice you want to pay (as defined by the BOLT11 standard). **/
3877
3570
  encodedPaymentRequest: string;
3878
3571
  /**
3879
- * If the invoice does not specify a payment amount,
3880
- * then the amount that you wish to pay, expressed in msats.
3572
+ * If the invoice does not specify a payment amount, then the amount that you wish to pay,
3573
+ * expressed in msats.
3881
3574
  **/
3882
3575
  amountMsats?: number | undefined;
3883
3576
  }
@@ -3915,54 +3608,48 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3915
3608
  /** The Bitcoin Network this node is deployed in. **/
3916
3609
  readonly bitcoinNetwork: BitcoinNetwork;
3917
3610
  /**
3918
- * The name of this node in the network.
3919
- * It will be the most human-readable option possible,
3611
+ * The name of this node in the network. It will be the most human-readable option possible,
3920
3612
  * depending on the data available for this node.
3921
3613
  **/
3922
3614
  readonly displayName: string;
3923
3615
  /** The owner of this LightsparkNode. **/
3924
3616
  readonly ownerId: string;
3925
3617
  /**
3926
- * The utxos of the channels that are connected to this node.
3927
- * This is used in uma flow for pre-screening.
3618
+ * The utxos of the channels that are connected to this node. This is used in uma flow for
3619
+ * pre-screening.
3928
3620
  **/
3929
3621
  readonly umaPrescreeningUtxos: string[];
3930
3622
  /** The typename of the object **/
3931
3623
  readonly typename: string;
3932
3624
  /**
3933
- * A name that identifies the node.
3934
- * It has no importance in terms of operating the node,
3935
- * it is just a way to identify and search for commercial services or
3936
- * popular nodes. This alias can be changed at any time by the node
3937
- * 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.
3938
3628
  **/
3939
3629
  readonly alias?: string | undefined;
3940
3630
  /**
3941
- * A hexadecimal string that describes a color. For example "#000000" is
3942
- * black, "#FFFFFF" is white. It has no importance in terms of operating
3943
- * 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,
3944
3633
  * it is just a way to visually differentiate nodes.
3945
3634
  * That color can be changed at any time by the node operator.
3946
3635
  **/
3947
3636
  readonly color?: string | undefined;
3948
3637
  /**
3949
- * A summary metric used to capture how well positioned a node is to send,
3950
- * receive, or route transactions efficiently.
3951
- * Maximizing a node's conductivity helps a node’s transactions to be
3952
- * capital efficient. The value is an integer ranging between 0 and 10
3953
- * (bounds included).
3638
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
3639
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
3640
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
3954
3641
  **/
3955
3642
  readonly conductivity?: number | undefined;
3956
3643
  /**
3957
- * The public key of this node. It acts as a unique identifier of this node
3958
- * in the Lightning Network. *
3644
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
3645
+ * Network. *
3959
3646
  */
3960
3647
  readonly publicKey?: string | undefined;
3961
3648
  /** The current status of this node. **/
3962
3649
  readonly status?: LightsparkNodeStatus | undefined;
3963
3650
  /**
3964
- * The sum of the balance on the Bitcoin Network, channel balances,
3965
- * and commit fees on this node.
3651
+ * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
3652
+ * node.
3966
3653
  *
3967
3654
  * @deprecated Use `balances` instead.
3968
3655
  **/
@@ -3974,15 +3661,13 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3974
3661
  **/
3975
3662
  readonly totalLocalBalance?: CurrencyAmount | undefined;
3976
3663
  /**
3977
- * The sum of the channel balances (online only) that are available to send
3978
- * on this node.
3664
+ * The sum of the channel balances (online only) that are available to send on this node.
3979
3665
  *
3980
3666
  * @deprecated Use `balances` instead.
3981
3667
  **/
3982
3668
  readonly localBalance?: CurrencyAmount | undefined;
3983
3669
  /**
3984
- * The sum of the channel balances that are available to receive on this
3985
- * node.
3670
+ * The sum of the channel balances that are available to receive on this node.
3986
3671
  *
3987
3672
  * @deprecated Use `balances` instead.
3988
3673
  **/
@@ -3996,8 +3681,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3996
3681
  /** The balances that describe the funds in this node. **/
3997
3682
  readonly balances?: Balances | undefined;
3998
3683
  /**
3999
- * The private key client is using to sign a GraphQL request which will be
4000
- * verified at server side. *
3684
+ * The private key client is using to sign a GraphQL request which will be verified at server
3685
+ * side. *
4001
3686
  */
4002
3687
  readonly encryptedSigningPrivateKey?: Secret | undefined;
4003
3688
  constructor(
@@ -4013,54 +3698,48 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
4013
3698
  /** The Bitcoin Network this node is deployed in. **/
4014
3699
  bitcoinNetwork: BitcoinNetwork,
4015
3700
  /**
4016
- * The name of this node in the network.
4017
- * It will be the most human-readable option possible,
3701
+ * The name of this node in the network. It will be the most human-readable option possible,
4018
3702
  * depending on the data available for this node.
4019
3703
  **/
4020
3704
  displayName: string,
4021
3705
  /** The owner of this LightsparkNode. **/
4022
3706
  ownerId: string,
4023
3707
  /**
4024
- * The utxos of the channels that are connected to this node.
4025
- * This is used in uma flow for pre-screening.
3708
+ * The utxos of the channels that are connected to this node. This is used in uma flow for
3709
+ * pre-screening.
4026
3710
  **/
4027
3711
  umaPrescreeningUtxos: string[],
4028
3712
  /** The typename of the object **/
4029
3713
  typename: string,
4030
3714
  /**
4031
- * A name that identifies the node.
4032
- * It has no importance in terms of operating the node,
4033
- * it is just a way to identify and search for commercial services or
4034
- * popular nodes. This alias can be changed at any time by the node
4035
- * 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.
4036
3718
  **/
4037
3719
  alias?: string | undefined,
4038
3720
  /**
4039
- * A hexadecimal string that describes a color. For example "#000000" is
4040
- * black, "#FFFFFF" is white. It has no importance in terms of operating
4041
- * 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,
4042
3723
  * it is just a way to visually differentiate nodes.
4043
3724
  * That color can be changed at any time by the node operator.
4044
3725
  **/
4045
3726
  color?: string | undefined,
4046
3727
  /**
4047
- * A summary metric used to capture how well positioned a node is to send,
4048
- * receive, or route transactions efficiently.
4049
- * Maximizing a node's conductivity helps a node’s transactions to be
4050
- * capital efficient. The value is an integer ranging between 0 and 10
4051
- * (bounds included).
3728
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
3729
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
3730
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
4052
3731
  **/
4053
3732
  conductivity?: number | undefined,
4054
3733
  /**
4055
- * The public key of this node. It acts as a unique identifier of this node
4056
- * in the Lightning Network. *
3734
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
3735
+ * Network. *
4057
3736
  */
4058
3737
  publicKey?: string | undefined,
4059
3738
  /** The current status of this node. **/
4060
3739
  status?: LightsparkNodeStatus | undefined,
4061
3740
  /**
4062
- * The sum of the balance on the Bitcoin Network, channel balances,
4063
- * and commit fees on this node.
3741
+ * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
3742
+ * node.
4064
3743
  *
4065
3744
  * @deprecated Use `balances` instead.
4066
3745
  **/
@@ -4072,15 +3751,13 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
4072
3751
  **/
4073
3752
  totalLocalBalance?: CurrencyAmount | undefined,
4074
3753
  /**
4075
- * The sum of the channel balances (online only) that are available to send
4076
- * on this node.
3754
+ * The sum of the channel balances (online only) that are available to send on this node.
4077
3755
  *
4078
3756
  * @deprecated Use `balances` instead.
4079
3757
  **/
4080
3758
  localBalance?: CurrencyAmount | undefined,
4081
3759
  /**
4082
- * The sum of the channel balances that are available to receive on this
4083
- * node.
3760
+ * The sum of the channel balances that are available to receive on this node.
4084
3761
  *
4085
3762
  * @deprecated Use `balances` instead.
4086
3763
  **/
@@ -4094,8 +3771,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
4094
3771
  /** The balances that describe the funds in this node. **/
4095
3772
  balances?: Balances | undefined,
4096
3773
  /**
4097
- * The private key client is using to sign a GraphQL request which will be
4098
- * verified at server side. *
3774
+ * The private key client is using to sign a GraphQL request which will be verified at server
3775
+ * side. *
4099
3776
  */
4100
3777
  encryptedSigningPrivateKey?: Secret | undefined);
4101
3778
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
@@ -4141,54 +3818,48 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
4141
3818
  /** The Bitcoin Network this node is deployed in. **/
4142
3819
  readonly bitcoinNetwork: BitcoinNetwork;
4143
3820
  /**
4144
- * The name of this node in the network.
4145
- * It will be the most human-readable option possible,
3821
+ * The name of this node in the network. It will be the most human-readable option possible,
4146
3822
  * depending on the data available for this node.
4147
3823
  **/
4148
3824
  readonly displayName: string;
4149
3825
  /** The owner of this LightsparkNode. **/
4150
3826
  readonly ownerId: string;
4151
3827
  /**
4152
- * The utxos of the channels that are connected to this node.
4153
- * This is used in uma flow for pre-screening.
3828
+ * The utxos of the channels that are connected to this node. This is used in uma flow for
3829
+ * pre-screening.
4154
3830
  **/
4155
3831
  readonly umaPrescreeningUtxos: string[];
4156
3832
  /** The typename of the object **/
4157
3833
  readonly typename: string;
4158
3834
  /**
4159
- * A name that identifies the node.
4160
- * It has no importance in terms of operating the node,
4161
- * it is just a way to identify and search for commercial services or
4162
- * popular nodes. This alias can be changed at any time by the node
4163
- * 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.
4164
3838
  **/
4165
3839
  readonly alias?: string | undefined;
4166
3840
  /**
4167
- * A hexadecimal string that describes a color. For example "#000000" is
4168
- * black, "#FFFFFF" is white. It has no importance in terms of operating
4169
- * 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,
4170
3843
  * it is just a way to visually differentiate nodes.
4171
3844
  * That color can be changed at any time by the node operator.
4172
3845
  **/
4173
3846
  readonly color?: string | undefined;
4174
3847
  /**
4175
- * A summary metric used to capture how well positioned a node is to send,
4176
- * receive, or route transactions efficiently.
4177
- * Maximizing a node's conductivity helps a node’s transactions to be
4178
- * capital efficient. The value is an integer ranging between 0 and 10
4179
- * (bounds included).
3848
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
3849
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
3850
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
4180
3851
  **/
4181
3852
  readonly conductivity?: number | undefined;
4182
3853
  /**
4183
- * The public key of this node. It acts as a unique identifier of this node
4184
- * in the Lightning Network. *
3854
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
3855
+ * Network. *
4185
3856
  */
4186
3857
  readonly publicKey?: string | undefined;
4187
3858
  /** The current status of this node. **/
4188
3859
  readonly status?: LightsparkNodeStatus | undefined;
4189
3860
  /**
4190
- * The sum of the balance on the Bitcoin Network, channel balances,
4191
- * and commit fees on this node.
3861
+ * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
3862
+ * node.
4192
3863
  *
4193
3864
  * @deprecated Use `balances` instead.
4194
3865
  **/
@@ -4200,15 +3871,13 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
4200
3871
  **/
4201
3872
  readonly totalLocalBalance?: CurrencyAmount | undefined;
4202
3873
  /**
4203
- * The sum of the channel balances (online only) that are available to send
4204
- * on this node.
3874
+ * The sum of the channel balances (online only) that are available to send on this node.
4205
3875
  *
4206
3876
  * @deprecated Use `balances` instead.
4207
3877
  **/
4208
3878
  readonly localBalance?: CurrencyAmount | undefined;
4209
3879
  /**
4210
- * The sum of the channel balances that are available to receive on this
4211
- * node.
3880
+ * The sum of the channel balances that are available to receive on this node.
4212
3881
  *
4213
3882
  * @deprecated Use `balances` instead.
4214
3883
  **/
@@ -4234,54 +3903,48 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
4234
3903
  /** The Bitcoin Network this node is deployed in. **/
4235
3904
  bitcoinNetwork: BitcoinNetwork,
4236
3905
  /**
4237
- * The name of this node in the network.
4238
- * It will be the most human-readable option possible,
3906
+ * The name of this node in the network. It will be the most human-readable option possible,
4239
3907
  * depending on the data available for this node.
4240
3908
  **/
4241
3909
  displayName: string,
4242
3910
  /** The owner of this LightsparkNode. **/
4243
3911
  ownerId: string,
4244
3912
  /**
4245
- * The utxos of the channels that are connected to this node.
4246
- * This is used in uma flow for pre-screening.
3913
+ * The utxos of the channels that are connected to this node. This is used in uma flow for
3914
+ * pre-screening.
4247
3915
  **/
4248
3916
  umaPrescreeningUtxos: string[],
4249
3917
  /** The typename of the object **/
4250
3918
  typename: string,
4251
3919
  /**
4252
- * A name that identifies the node.
4253
- * It has no importance in terms of operating the node,
4254
- * it is just a way to identify and search for commercial services or
4255
- * popular nodes. This alias can be changed at any time by the node
4256
- * 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.
4257
3923
  **/
4258
3924
  alias?: string | undefined,
4259
3925
  /**
4260
- * A hexadecimal string that describes a color. For example "#000000" is
4261
- * black, "#FFFFFF" is white. It has no importance in terms of operating
4262
- * 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,
4263
3928
  * it is just a way to visually differentiate nodes.
4264
3929
  * That color can be changed at any time by the node operator.
4265
3930
  **/
4266
3931
  color?: string | undefined,
4267
3932
  /**
4268
- * A summary metric used to capture how well positioned a node is to send,
4269
- * receive, or route transactions efficiently.
4270
- * Maximizing a node's conductivity helps a node’s transactions to be
4271
- * capital efficient. The value is an integer ranging between 0 and 10
4272
- * (bounds included).
3933
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
3934
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
3935
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
4273
3936
  **/
4274
3937
  conductivity?: number | undefined,
4275
3938
  /**
4276
- * The public key of this node. It acts as a unique identifier of this node
4277
- * in the Lightning Network. *
3939
+ * The public key of this node. It acts as a unique identifier of this node in the Lightning
3940
+ * Network. *
4278
3941
  */
4279
3942
  publicKey?: string | undefined,
4280
3943
  /** The current status of this node. **/
4281
3944
  status?: LightsparkNodeStatus | undefined,
4282
3945
  /**
4283
- * The sum of the balance on the Bitcoin Network, channel balances,
4284
- * and commit fees on this node.
3946
+ * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this
3947
+ * node.
4285
3948
  *
4286
3949
  * @deprecated Use `balances` instead.
4287
3950
  **/
@@ -4293,15 +3956,13 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
4293
3956
  **/
4294
3957
  totalLocalBalance?: CurrencyAmount | undefined,
4295
3958
  /**
4296
- * The sum of the channel balances (online only) that are available to send
4297
- * on this node.
3959
+ * The sum of the channel balances (online only) that are available to send on this node.
4298
3960
  *
4299
3961
  * @deprecated Use `balances` instead.
4300
3962
  **/
4301
3963
  localBalance?: CurrencyAmount | undefined,
4302
3964
  /**
4303
- * The sum of the channel balances that are available to receive on this
4304
- * node.
3965
+ * The sum of the channel balances that are available to receive on this node.
4305
3966
  *
4306
3967
  * @deprecated Use `balances` instead.
4307
3968
  **/
@@ -4343,10 +4004,9 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
4343
4004
  }
4344
4005
 
4345
4006
  /**
4346
- * This object represents an L1 transaction that occurred on the Bitcoin
4347
- * Network. You can retrieve this object to receive information about a
4348
- * specific on-chain transaction made on the Lightning Network associated with
4349
- * your Lightspark Node.
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.
4350
4010
  * *
4351
4011
  */
4352
4012
  interface OnChainTransaction {
@@ -4364,8 +4024,8 @@ interface OnChainTransaction {
4364
4024
  /** The amount of money involved in this transaction. **/
4365
4025
  amount: CurrencyAmount;
4366
4026
  /**
4367
- * The height of the block that included this transaction.
4368
- * This will be zero for unconfirmed transactions.
4027
+ * The height of the block that included this transaction. This will be zero for unconfirmed
4028
+ * transactions.
4369
4029
  **/
4370
4030
  blockHeight: number;
4371
4031
  /** The Bitcoin blockchain addresses this transaction was sent to. **/
@@ -4374,25 +4034,19 @@ interface OnChainTransaction {
4374
4034
  typename: string;
4375
4035
  /** The date and time when this transaction was completed or failed. **/
4376
4036
  resolvedAt?: string | undefined;
4377
- /**
4378
- * The hash of this transaction, so it can be uniquely identified on the
4379
- * Lightning Network. *
4380
- */
4037
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
4381
4038
  transactionHash?: string | undefined;
4382
4039
  /**
4383
- * The fees that were paid by the wallet sending the transaction to commit it
4384
- * to the Bitcoin blockchain.
4040
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
4041
+ * blockchain.
4385
4042
  **/
4386
4043
  fees?: CurrencyAmount | undefined;
4387
4044
  /**
4388
- * The hash of the block that included this transaction.
4389
- * This will be null for unconfirmed transactions.
4045
+ * The hash of the block that included this transaction. This will be null for unconfirmed
4046
+ * transactions.
4390
4047
  **/
4391
4048
  blockHash?: string | undefined;
4392
- /**
4393
- * The number of blockchain confirmations for this transaction in real time.
4394
- * *
4395
- */
4049
+ /** The number of blockchain confirmations for this transaction in real time. **/
4396
4050
  numConfirmations?: number | undefined;
4397
4051
  }
4398
4052
  declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
@@ -4416,13 +4070,13 @@ interface PayInvoiceInput {
4416
4070
  /** The timeout in seconds that we will try to make the payment. **/
4417
4071
  timeoutSecs: number;
4418
4072
  /**
4419
- * The maximum amount of fees that you want to pay for this payment to be
4420
- * sent, expressed in msats. *
4073
+ * The maximum amount of fees that you want to pay for this payment to be sent, expressed in
4074
+ * msats. *
4421
4075
  */
4422
4076
  maximumFeesMsats: number;
4423
4077
  /**
4424
- * The amount you will pay for this invoice, expressed in msats.
4425
- * It should ONLY be set when the invoice amount is zero.
4078
+ * The amount you will pay for this invoice, expressed in msats. It should ONLY be set when the
4079
+ * invoice amount is zero.
4426
4080
  **/
4427
4081
  amountMsats?: number | undefined;
4428
4082
  }
@@ -4443,9 +4097,8 @@ interface PayUmaInvoiceInput {
4443
4097
  /** This is an enum indicating the direction of the payment. **/
4444
4098
  declare enum PaymentDirection {
4445
4099
  /**
4446
- * This is an enum value that represents values that could be added in the
4447
- * future. Clients should support unknown values as more of them could be
4448
- * added without notice.
4100
+ * This is an enum value that represents values that could be added in the future.
4101
+ * Clients should support unknown values as more of them could be added without notice.
4449
4102
  */
4450
4103
  FUTURE_VALUE = "FUTURE_VALUE",
4451
4104
  SENT = "SENT",
@@ -4455,8 +4108,8 @@ declare enum PaymentDirection {
4455
4108
  interface RegisterPaymentInput {
4456
4109
  /**
4457
4110
  * The compliance provider that is going to screen the node.
4458
- * You need to be a customer of the selected provider and store the API key
4459
- * on the Lightspark account setting page.
4111
+ * You need to be a customer of the selected provider and store the API key on the Lightspark
4112
+ * account setting page.
4460
4113
  **/
4461
4114
  provider: ComplianceProvider;
4462
4115
  /**
@@ -4466,15 +4119,11 @@ interface RegisterPaymentInput {
4466
4119
  paymentId: string;
4467
4120
  /**
4468
4121
  * The public key of the counterparty lightning node,
4469
- * which would be the public key of the recipient node if it is to register
4470
- * an outgoing payment, or the public key of the sender node if it is to
4471
- * register an incoming payment.
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.
4472
4124
  **/
4473
4125
  nodePubkey: string;
4474
- /**
4475
- * Indicates whether this payment is an OutgoingPayment or an
4476
- * IncomingPayment. *
4477
- */
4126
+ /** Indicates whether this payment is an OutgoingPayment or an IncomingPayment. **/
4478
4127
  direction: PaymentDirection;
4479
4128
  }
4480
4129
 
@@ -4508,15 +4157,11 @@ interface ReleasePaymentPreimageOutput {
4508
4157
  invoiceId: string;
4509
4158
  }
4510
4159
 
4511
- /**
4512
- * This is an enum of the potential sub-event types for Remote Signing webook
4513
- * events. *
4514
- */
4160
+ /** This is an enum of the potential sub-event types for Remote Signing webook events. **/
4515
4161
  declare enum RemoteSigningSubEventType {
4516
4162
  /**
4517
- * This is an enum value that represents values that could be added in the
4518
- * future. Clients should support unknown values as more of them could be
4519
- * added without notice.
4163
+ * This is an enum value that represents values that could be added in the future.
4164
+ * Clients should support unknown values as more of them could be added without notice.
4520
4165
  */
4521
4166
  FUTURE_VALUE = "FUTURE_VALUE",
4522
4167
  ECDH = "ECDH",
@@ -4549,15 +4194,14 @@ interface RequestWithdrawalOutput {
4549
4194
  }
4550
4195
 
4551
4196
  /**
4552
- * This is an enum of the potential risk ratings related to a transaction made
4553
- * over the Lightning Network. These risk ratings are returned from the
4554
- * CryptoSanctionScreeningProvider. *
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
+ * *
4555
4200
  */
4556
4201
  declare enum RiskRating {
4557
4202
  /**
4558
- * This is an enum value that represents values that could be added in the
4559
- * future. Clients should support unknown values as more of them could be
4560
- * added without notice.
4203
+ * This is an enum value that represents values that could be added in the future.
4204
+ * Clients should support unknown values as more of them could be added without notice.
4561
4205
  */
4562
4206
  FUTURE_VALUE = "FUTURE_VALUE",
4563
4207
  HIGH_RISK = "HIGH_RISK",
@@ -4566,11 +4210,10 @@ declare enum RiskRating {
4566
4210
  }
4567
4211
 
4568
4212
  /**
4569
- * This object represents a transaction that was forwarded through a Lightspark
4570
- * node on the Lightning Network, i.e., a routed transaction.
4571
- * You can retrieve this object to receive information about any transaction
4572
- * routed through your Lightspark Node.
4573
- * *
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. *
4574
4217
  */
4575
4218
  interface RoutingTransaction {
4576
4219
  /**
@@ -4590,10 +4233,7 @@ interface RoutingTransaction {
4590
4233
  typename: string;
4591
4234
  /** The date and time when this transaction was completed or failed. **/
4592
4235
  resolvedAt?: string | undefined;
4593
- /**
4594
- * The hash of this transaction, so it can be uniquely identified on the
4595
- * Lightning Network. *
4596
- */
4236
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
4597
4237
  transactionHash?: string | undefined;
4598
4238
  /** If known, the channel this transaction was received from. **/
4599
4239
  incomingChannelId?: string | undefined;
@@ -4601,14 +4241,11 @@ interface RoutingTransaction {
4601
4241
  outgoingChannelId?: string | undefined;
4602
4242
  /**
4603
4243
  * The fees collected by the node when routing this transaction.
4604
- * We subtract the outgoing amount to the incoming amount to determine how
4605
- * much fees were collected.
4244
+ * We subtract the outgoing amount to the incoming amount to determine how much fees were
4245
+ * collected.
4606
4246
  **/
4607
4247
  fees?: CurrencyAmount | undefined;
4608
- /**
4609
- * If applicable, user-facing error message describing why the routing
4610
- * failed. *
4611
- */
4248
+ /** If applicable, user-facing error message describing why the routing failed. **/
4612
4249
  failureMessage?: RichText | undefined;
4613
4250
  /** If applicable, the reason why the routing failed. **/
4614
4251
  failureReason?: RoutingTransactionFailureReason | undefined;
@@ -4618,8 +4255,8 @@ declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransacti
4618
4255
  interface ScreenNodeInput {
4619
4256
  /**
4620
4257
  * The compliance provider that is going to screen the node.
4621
- * You need to be a customer of the selected provider and store the API key
4622
- * on the Lightspark account setting page.
4258
+ * You need to be a customer of the selected provider and store the API key on the Lightspark
4259
+ * account setting page.
4623
4260
  **/
4624
4261
  provider: ComplianceProvider;
4625
4262
  /** The public key of the lightning node that needs to be screened. **/
@@ -4640,8 +4277,8 @@ interface SendPaymentInput {
4640
4277
  /** The amount you will send to the destination node, expressed in msats. **/
4641
4278
  amountMsats: number;
4642
4279
  /**
4643
- * The maximum amount of fees that you want to pay for this payment to be
4644
- * sent, expressed in msats. *
4280
+ * The maximum amount of fees that you want to pay for this payment to be sent, expressed in
4281
+ * msats. *
4645
4282
  */
4646
4283
  maximumFeesMsats: number;
4647
4284
  }
@@ -4658,8 +4295,8 @@ interface SetInvoicePaymentHashInput {
4658
4295
  paymentHash: string;
4659
4296
  /**
4660
4297
  * The 32-byte nonce used to generate the invoice preimage if applicable.
4661
- * It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help
4662
- * recover the raw preimage.
4298
+ * It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw
4299
+ * preimage.
4663
4300
  **/
4664
4301
  preimageNonce?: string | undefined;
4665
4302
  }
@@ -4727,14 +4364,13 @@ interface UpdateNodeSharedSecretOutput {
4727
4364
  }
4728
4365
 
4729
4366
  /**
4730
- * This is an enum of the potential event types that can be associated with
4731
- * your Lightspark wallets. *
4367
+ * This is an enum of the potential event types that can be associated with your Lightspark
4368
+ * wallets. *
4732
4369
  */
4733
4370
  declare enum WebhookEventType {
4734
4371
  /**
4735
- * This is an enum value that represents values that could be added in the
4736
- * future. Clients should support unknown values as more of them could be
4737
- * added without notice.
4372
+ * This is an enum value that represents values that could be added in the future.
4373
+ * Clients should support unknown values as more of them could be added without notice.
4738
4374
  */
4739
4375
  FUTURE_VALUE = "FUTURE_VALUE",
4740
4376
  PAYMENT_FINISHED = "PAYMENT_FINISHED",
@@ -4753,10 +4389,9 @@ declare enum WebhookEventType {
4753
4389
  }
4754
4390
 
4755
4391
  /**
4756
- * This object represents an L1 withdrawal from your Lightspark Node to any
4757
- * Bitcoin wallet. You can retrieve this object to receive detailed information
4758
- * about any L1 withdrawal associated with your Lightspark Node or account.
4759
- * *
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. *
4760
4395
  */
4761
4396
  interface Withdrawal {
4762
4397
  /**
@@ -4773,8 +4408,8 @@ interface Withdrawal {
4773
4408
  /** The amount of money involved in this transaction. **/
4774
4409
  amount: CurrencyAmount;
4775
4410
  /**
4776
- * The height of the block that included this transaction.
4777
- * This will be zero for unconfirmed transactions.
4411
+ * The height of the block that included this transaction. This will be zero for unconfirmed
4412
+ * transactions.
4778
4413
  **/
4779
4414
  blockHeight: number;
4780
4415
  /** The Bitcoin blockchain addresses this transaction was sent to. **/
@@ -4785,27 +4420,21 @@ interface Withdrawal {
4785
4420
  typename: string;
4786
4421
  /** The date and time when this transaction was completed or failed. **/
4787
4422
  resolvedAt?: string | undefined;
4788
- /**
4789
- * The hash of this transaction, so it can be uniquely identified on the
4790
- * Lightning Network. *
4791
- */
4423
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
4792
4424
  transactionHash?: string | undefined;
4793
4425
  /**
4794
- * The fees that were paid by the wallet sending the transaction to commit it
4795
- * to the Bitcoin blockchain.
4426
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
4427
+ * blockchain.
4796
4428
  **/
4797
4429
  fees?: CurrencyAmount | undefined;
4798
4430
  /**
4799
- * The hash of the block that included this transaction.
4800
- * This will be null for unconfirmed transactions.
4431
+ * The hash of the block that included this transaction. This will be null for unconfirmed
4432
+ * transactions.
4801
4433
  **/
4802
4434
  blockHash?: string | undefined;
4803
- /**
4804
- * The number of blockchain confirmations for this transaction in real time.
4805
- * *
4806
- */
4435
+ /** The number of blockchain confirmations for this transaction in real time. **/
4807
4436
  numConfirmations?: number | undefined;
4808
4437
  }
4809
4438
  declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
4810
4439
 
4811
- export { FeeEstimate as $, Account as A, Balances as B, Channel as C, CreateInvitationWithIncentivesOutput as D, CreateInvoiceInput as E, CreateInvoiceOutput as F, CreateLnurlInvoiceInput as G, CreateNodeWalletAddressInput as H, CreateNodeWalletAddressOutput as I, CreateTestModeInvoiceInput as J, CreateTestModeInvoiceOutput as K, LightsparkClient as L, CreateTestModePaymentInput as M, CreateTestModePaymentoutput as N, CreateUmaInvitationInput as O, CreateUmaInvitationOutput as P, CreateUmaInvoiceInput as Q, CurrencyAmount as R, CurrencyUnit as S, DeclineToSignMessagesInput as T, DeclineToSignMessagesOutput as U, DeleteApiTokenInput as V, WebhookEventType as W, DeleteApiTokenOutput as X, Deposit as Y, getDepositQuery as Z, Entity as _, AccountToApiTokensConnection as a, ReleasePaymentPreimageOutput as a$, FundNodeInput as a0, FundNodeOutput as a1, GraphNode as a2, Hop as a3, getHopQuery as a4, HtlcAttemptFailureCode as a5, IdAndSignature as a6, IncentivesIneligibilityReason as a7, IncentivesStatus as a8, IncomingPayment as a9, OnChainTransaction as aA, getOnChainTransactionQuery as aB, OutgoingPayment as aC, OutgoingPaymentAttempt as aD, OutgoingPaymentAttemptStatus as aE, OutgoingPaymentAttemptToHopsConnection as aF, OutgoingPaymentToAttemptsConnection as aG, OutgoingPaymentsForInvoiceQueryInput as aH, OutgoingPaymentsForInvoiceQueryOutput as aI, PageInfo as aJ, PayInvoiceInput as aK, PayInvoiceOutput as aL, PayUmaInvoiceInput as aM, PaymentDirection as aN, PaymentFailureReason as aO, PaymentRequest as aP, getPaymentRequestQuery as aQ, PaymentRequestData as aR, PaymentRequestStatus as aS, Permission as aT, PostTransactionData as aU, RegionCode as aV, RegisterPaymentInput as aW, RegisterPaymentOutput as aX, ReleaseChannelPerCommitmentSecretInput as aY, ReleaseChannelPerCommitmentSecretOutput as aZ, ReleasePaymentPreimageInput as a_, IncomingPaymentAttempt as aa, getIncomingPaymentAttemptQuery as ab, IncomingPaymentAttemptStatus as ac, IncomingPaymentToAttemptsConnection as ad, Invoice as ae, getInvoiceQuery as af, InvoiceData as ag, InvoiceType as ah, LightningFeeEstimateForInvoiceInput as ai, LightningFeeEstimateForNodeInput as aj, LightningFeeEstimateOutput as ak, LightningTransaction as al, getLightningTransactionQuery as am, LightsparkNode as an, getLightsparkNodeQuery as ao, LightsparkNodeOwner as ap, getLightsparkNodeOwnerQuery as aq, LightsparkNodeStatus as ar, LightsparkNodeToChannelsConnection as as, LightsparkNodeWithOSK as at, LightsparkNodeWithRemoteSigning as au, Node as av, getNodeQuery as aw, NodeAddress as ax, NodeAddressType as ay, NodeToAddressesConnection as az, AccountToChannelsConnection as b, RemoteSigningSubEventType as b0, RequestWithdrawalInput as b1, RequestWithdrawalOutput as b2, RichText as b3, RiskRating as b4, RoutingTransaction as b5, getRoutingTransactionQuery as b6, RoutingTransactionFailureReason as b7, ScreenNodeInput as b8, ScreenNodeOutput as b9, UpdateNodeSharedSecretOutput as bA, Wallet as bB, WalletStatus as bC, WalletToPaymentRequestsConnection as bD, WalletToTransactionsConnection as bE, Withdrawal as bF, getWithdrawalQuery as bG, WithdrawalMode as bH, WithdrawalRequest as bI, WithdrawalRequestStatus as bJ, WithdrawalRequestToChannelClosingTransactionsConnection as bK, WithdrawalRequestToChannelOpeningTransactionsConnection as bL, Secret as ba, SendPaymentInput as bb, SendPaymentOutput as bc, SetInvoicePaymentHashInput as bd, SetInvoicePaymentHashOutput as be, SignInvoiceInput as bf, SignInvoiceOutput as bg, SignMessagesInput as bh, SignMessagesOutput as bi, Signable as bj, getSignableQuery as bk, SignablePayload as bl, getSignablePayloadQuery as bm, SignablePayloadStatus as bn, SingleNodeDashboard as bo, Transaction as bp, getTransactionQuery as bq, TransactionFailures as br, TransactionStatus as bs, TransactionType as bt, TransactionUpdate as bu, UmaInvitation as bv, getUmaInvitationQuery as bw, UpdateChannelPerCommitmentPointInput as bx, UpdateChannelPerCommitmentPointOutput as by, UpdateNodeSharedSecretInput as bz, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BlockchainBalance as i, ChannelClosingTransaction as j, getChannelClosingTransactionQuery as k, ChannelFees as l, ChannelOpeningTransaction as m, getChannelOpeningTransactionQuery as n, ChannelSnapshot as o, ChannelStatus as p, ChannelToTransactionsConnection as q, ClaimUmaInvitationInput as r, ClaimUmaInvitationOutput as s, ClaimUmaInvitationWithIncentivesInput as t, ClaimUmaInvitationWithIncentivesOutput as u, ComplianceProvider as v, Connection as w, CreateApiTokenInput as x, CreateApiTokenOutput as y, CreateInvitationWithIncentivesInput as z };
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 };