@lightsparkdev/lightspark-sdk 1.3.1 → 1.4.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 (88) hide show
  1. package/CHANGELOG.md +7 -0
  2. package/dist/{BitcoinNetwork-972b1d01.d.ts → BitcoinNetwork-4f6ea015.d.ts} +2 -2
  3. package/dist/{chunk-Y55D3PD4.js → chunk-LCDROGA5.js} +938 -725
  4. package/dist/env.d.cts +1 -1
  5. package/dist/env.d.ts +1 -1
  6. package/dist/{index-a5028d74.d.ts → index-6f544cad.d.ts} +711 -714
  7. package/dist/index.cjs +309 -2
  8. package/dist/index.d.cts +3 -3
  9. package/dist/index.d.ts +3 -3
  10. package/dist/index.js +96 -2
  11. package/dist/objects/index.cjs +1339 -1126
  12. package/dist/objects/index.d.cts +2 -2
  13. package/dist/objects/index.d.ts +2 -2
  14. package/dist/objects/index.js +1 -1
  15. package/package.json +1 -1
  16. package/src/client.ts +77 -1
  17. package/src/graphql/RegisterPayment.ts +21 -0
  18. package/src/graphql/ScreenNode.ts +15 -0
  19. package/src/objects/Account.ts +98 -5
  20. package/src/objects/AccountToApiTokensConnection.ts +2 -3
  21. package/src/objects/AccountToChannelsConnection.ts +2 -3
  22. package/src/objects/AccountToNodesConnection.ts +2 -3
  23. package/src/objects/AccountToPaymentRequestsConnection.ts +2 -3
  24. package/src/objects/AccountToTransactionsConnection.ts +6 -7
  25. package/src/objects/AccountToWalletsConnection.ts +2 -3
  26. package/src/objects/AccountToWithdrawalRequestsConnection.ts +71 -0
  27. package/src/objects/ApiToken.ts +5 -6
  28. package/src/objects/Balances.ts +9 -12
  29. package/src/objects/BitcoinNetwork.ts +2 -2
  30. package/src/objects/Channel.ts +7 -10
  31. package/src/objects/ChannelClosingTransaction.ts +3 -4
  32. package/src/objects/ChannelOpeningTransaction.ts +3 -4
  33. package/src/objects/ChannelStatus.ts +5 -9
  34. package/src/objects/ChannelToTransactionsConnection.ts +6 -7
  35. package/src/objects/Connection.ts +85 -3
  36. package/src/objects/CreateApiTokenOutput.ts +3 -3
  37. package/src/objects/CreateLnurlInvoiceInput.ts +2 -3
  38. package/src/objects/CreateTestModePaymentInput.ts +2 -2
  39. package/src/objects/CreateTestModePaymentoutput.ts +2 -3
  40. package/src/objects/CurrencyUnit.ts +11 -17
  41. package/src/objects/Deposit.ts +5 -6
  42. package/src/objects/Entity.ts +21 -6
  43. package/src/objects/FeeEstimate.ts +2 -3
  44. package/src/objects/GraphNode.ts +10 -12
  45. package/src/objects/Hop.ts +5 -6
  46. package/src/objects/IncentivesStatus.ts +2 -3
  47. package/src/objects/IncomingPayment.ts +7 -7
  48. package/src/objects/IncomingPaymentAttempt.ts +2 -2
  49. package/src/objects/IncomingPaymentToAttemptsConnection.ts +2 -3
  50. package/src/objects/Invoice.ts +2 -2
  51. package/src/objects/InvoiceData.ts +4 -5
  52. package/src/objects/LightningTransaction.ts +5 -5
  53. package/src/objects/LightsparkNode.ts +8 -10
  54. package/src/objects/LightsparkNodeOwner.ts +2 -2
  55. package/src/objects/LightsparkNodeToChannelsConnection.ts +2 -3
  56. package/src/objects/LightsparkNodeWithOSK.ts +7 -8
  57. package/src/objects/LightsparkNodeWithRemoteSigning.ts +7 -8
  58. package/src/objects/Node.ts +9 -11
  59. package/src/objects/NodeToAddressesConnection.ts +2 -3
  60. package/src/objects/OnChainTransaction.ts +5 -6
  61. package/src/objects/OutgoingPayment.ts +5 -6
  62. package/src/objects/OutgoingPaymentAttempt.ts +12 -14
  63. package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts +2 -3
  64. package/src/objects/OutgoingPaymentToAttemptsConnection.ts +2 -3
  65. package/src/objects/PageInfo.ts +3 -3
  66. package/src/objects/PaymentRequest.ts +2 -2
  67. package/src/objects/PaymentRequestData.ts +1 -2
  68. package/src/objects/RegisterPaymentInput.ts +7 -8
  69. package/src/objects/RequestWithdrawalInput.ts +2 -2
  70. package/src/objects/RiskRating.ts +1 -2
  71. package/src/objects/RoutingTransaction.ts +6 -8
  72. package/src/objects/ScreenNodeInput.ts +2 -3
  73. package/src/objects/SetInvoicePaymentHashInput.ts +2 -3
  74. package/src/objects/Signable.ts +2 -2
  75. package/src/objects/SignablePayload.ts +2 -2
  76. package/src/objects/Transaction.ts +3 -4
  77. package/src/objects/TransactionStatus.ts +1 -2
  78. package/src/objects/UmaInvitation.ts +2 -2
  79. package/src/objects/Wallet.ts +97 -8
  80. package/src/objects/WalletStatus.ts +5 -7
  81. package/src/objects/WalletToPaymentRequestsConnection.ts +2 -3
  82. package/src/objects/WalletToTransactionsConnection.ts +2 -3
  83. package/src/objects/WalletToWithdrawalRequestsConnection.ts +70 -0
  84. package/src/objects/Withdrawal.ts +5 -5
  85. package/src/objects/WithdrawalRequest.ts +43 -7
  86. package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +2 -3
  87. package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +2 -3
  88. package/src/objects/index.ts +2 -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-972b1d01.js';
3
+ import { B as BitcoinNetwork } from './BitcoinNetwork-4f6ea015.js';
4
4
 
5
5
  /**
6
6
  * Args for creating a new SigningKeyLoader. Must be one of the sub types.
@@ -34,40 +34,34 @@ declare enum CurrencyUnit {
34
34
  */
35
35
  FUTURE_VALUE = "FUTURE_VALUE",
36
36
  /**
37
- * Bitcoin is the cryptocurrency native to the Bitcoin network.
38
- * It is used as the native medium for value transfer for the Lightning Network.
39
- * *
37
+ * Bitcoin is the cryptocurrency native to the Bitcoin network. It is used as the native medium
38
+ * for value transfer for the Lightning Network. *
40
39
  */
41
40
  BITCOIN = "BITCOIN",
42
41
  /**
43
- * 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin.
44
- * This is the unit most commonly used in Lightning transactions.
45
- * *
42
+ * 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin. This is the unit most
43
+ * commonly used in Lightning transactions. *
46
44
  */
47
45
  SATOSHI = "SATOSHI",
48
46
  /**
49
- * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
50
- * *
47
+ * 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible. *
51
48
  */
52
49
  MILLISATOSHI = "MILLISATOSHI",
53
50
  /** United States Dollar. **/
54
51
  USD = "USD",
55
52
  /**
56
- * 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin.
57
- * We recommend using the Satoshi unit instead when possible.
58
- * *
53
+ * 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin. We recommend using the Satoshi unit
54
+ * instead when possible. *
59
55
  */
60
56
  NANOBITCOIN = "NANOBITCOIN",
61
57
  /**
62
- * 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin.
63
- * We recommend using the Satoshi unit instead when possible.
64
- * *
58
+ * 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin. We recommend using the Satoshi unit
59
+ * instead when possible. *
65
60
  */
66
61
  MICROBITCOIN = "MICROBITCOIN",
67
62
  /**
68
- * 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin.
69
- * We recommend using the Satoshi unit instead when possible.
70
- * *
63
+ * 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin. We recommend using the Satoshi unit instead
64
+ * when possible. *
71
65
  */
72
66
  MILLIBITCOIN = "MILLIBITCOIN"
73
67
  }
@@ -185,15 +179,14 @@ declare enum Permission {
185
179
  }
186
180
 
187
181
  /**
188
- * This is an object representing a Lightspark API token,
189
- * that can be used to authenticate this account when making API calls or using our SDKs.
190
- * See the “Authentication” section of our API docs for more details on its usage.
191
- * *
182
+ * This is an object representing a Lightspark API token, that can be used to authenticate this
183
+ * account when making API calls or using our SDKs. See the “Authentication” section of our API
184
+ * docs for more details on its usage. *
192
185
  */
193
186
  interface ApiToken {
194
187
  /**
195
- * The unique identifier of this entity across all Lightspark systems.
196
- * Should be treated as an opaque string.
188
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
189
+ * opaque string.
197
190
  **/
198
191
  id: string;
199
192
  /** The date and time when the entity was first created. **/
@@ -218,9 +211,9 @@ interface ApiToken {
218
211
  declare const getApiTokenQuery: (id: string) => Query<ApiToken>;
219
212
 
220
213
  /**
221
- * This is an object representing information about a page returned by the Lightspark API.
222
- * For more information, please see the “Pagination” section of our API docs for more information
223
- * about its usage. *
214
+ * This is an object representing information about a page returned by the Lightspark API. For more
215
+ * information, please see the “Pagination” section of our API docs for more information about its
216
+ * usage. *
224
217
  */
225
218
  interface PageInfo {
226
219
  hasNextPage?: boolean | undefined;
@@ -231,9 +224,8 @@ interface PageInfo {
231
224
 
232
225
  interface AccountToApiTokensConnection {
233
226
  /**
234
- * The total count of objects in this connection, using the current filters.
235
- * It is different from the number of objects returned in the current page (in the `entities`
236
- * field).
227
+ * The total count of objects in this connection, using the current filters. It is different
228
+ * from the number of objects returned in the current page (in the `entities` field).
237
229
  **/
238
230
  count: number;
239
231
  /** An object that holds pagination information about the objects in this connection. **/
@@ -262,26 +254,22 @@ declare enum ChannelStatus {
262
254
  OFFLINE = "OFFLINE",
263
255
  /**
264
256
  * The channel is behaving properly, but its remote balance is much higher than its local balance
265
- * so it is not balanced properly for sending funds out.
266
- * *
257
+ * so it is not balanced properly for sending funds out. *
267
258
  */
268
259
  UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
269
260
  /**
270
261
  * The channel is behaving properly, but its remote balance is much lower than its local balance
271
- * so it is not balanced properly for receiving funds.
272
- * *
262
+ * so it is not balanced properly for receiving funds. *
273
263
  */
274
264
  UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
275
265
  /**
276
266
  * The channel has been closed. Information about the channel is still available for historical
277
- * purposes but the channel cannot be used anymore.
278
- * *
267
+ * purposes but the channel cannot be used anymore. *
279
268
  */
280
269
  CLOSED = "CLOSED",
281
270
  /**
282
- * Something unexpected happened and we cannot determine the status of this channel.
283
- * Please try again later or contact the support.
284
- * *
271
+ * Something unexpected happened and we cannot determine the status of this channel. Please try
272
+ * again later or contact the support. *
285
273
  */
286
274
  ERROR = "ERROR"
287
275
  }
@@ -294,14 +282,13 @@ interface ChannelFees {
294
282
 
295
283
  interface ChannelToTransactionsConnection {
296
284
  /**
297
- * The total count of objects in this connection, using the current filters.
298
- * It is different from the number of objects returned in the current page (in the `entities`
299
- * field).
285
+ * The total count of objects in this connection, using the current filters. It is different
286
+ * from the number of objects returned in the current page (in the `entities` field).
300
287
  **/
301
288
  count: number;
302
289
  /**
303
- * The average fee for the transactions that transited through this channel,
304
- * according to the filters and constraints of the connection.
290
+ * The average fee for the transactions that transited through this channel, according to the
291
+ * filters and constraints of the connection.
305
292
  **/
306
293
  averageFee?: CurrencyAmount | undefined;
307
294
  /**
@@ -310,22 +297,21 @@ interface ChannelToTransactionsConnection {
310
297
  **/
311
298
  totalAmountTransacted?: CurrencyAmount | undefined;
312
299
  /**
313
- * The total amount of fees for the transactions that transited through this channel,
314
- * according to the filters and constraints of the connection.
300
+ * The total amount of fees for the transactions that transited through this channel, according
301
+ * to the filters and constraints of the connection.
315
302
  **/
316
303
  totalFees?: CurrencyAmount | undefined;
317
304
  }
318
305
 
319
306
  /**
320
- * This interface is used by all the entities in the Lightspark system.
321
- * It defines a few core fields that are available everywhere.
322
- * Any object that implements this interface can be queried using the `entity` query and its ID.
323
- * *
307
+ * This interface is used by all the entities in the Lightspark system. It defines a few core
308
+ * fields that are available everywhere. Any object that implements this interface can be queried
309
+ * using the `entity` query and its ID. *
324
310
  */
325
311
  interface Entity {
326
312
  /**
327
- * The unique identifier of this entity across all Lightspark systems.
328
- * Should be treated as an opaque string.
313
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
314
+ * opaque string.
329
315
  **/
330
316
  id: string;
331
317
  /** The date and time when the entity was first created. **/
@@ -378,14 +364,13 @@ declare enum TransactionType {
378
364
  }
379
365
 
380
366
  /**
381
- * This is an object representing a channel on the Lightning Network.
382
- * You can retrieve this object to get detailed information on a specific Lightning Network
383
- * channel. *
367
+ * This is an object representing a channel on the Lightning Network. You can retrieve this object
368
+ * to get detailed information on a specific Lightning Network channel. *
384
369
  */
385
370
  declare class Channel implements Entity {
386
371
  /**
387
- * The unique identifier of this entity across all Lightspark systems.
388
- * Should be treated as an opaque string.
372
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
373
+ * opaque string.
389
374
  **/
390
375
  readonly id: string;
391
376
  /** The date and time when the entity was first created. **/
@@ -406,8 +391,7 @@ declare class Channel implements Entity {
406
391
  /** The channel balance on the local node. **/
407
392
  readonly localBalance?: CurrencyAmount | undefined;
408
393
  /**
409
- * The channel balance on the local node that is currently allocated to in-progress payments.
410
- * *
394
+ * The channel balance on the local node that is currently allocated to in-progress payments. *
411
395
  */
412
396
  readonly localUnsettledBalance?: CurrencyAmount | undefined;
413
397
  /** The channel balance on the remote node. **/
@@ -438,15 +422,14 @@ declare class Channel implements Entity {
438
422
  /** If known, the remote node of the channel. **/
439
423
  readonly remoteNodeId?: string | undefined;
440
424
  /**
441
- * The unique identifier of the channel on Lightning Network,
442
- * which is the location in the chain that the channel was confirmed. The format is
443
- * <block-height>:<tx-index>:<tx-output>.
425
+ * The unique identifier of the channel on Lightning Network, which is the location in the
426
+ * chain that the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
444
427
  **/
445
428
  readonly shortChannelId?: string | undefined;
446
429
  constructor(
447
430
  /**
448
- * The unique identifier of this entity across all Lightspark systems.
449
- * Should be treated as an opaque string.
431
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
432
+ * opaque string.
450
433
  **/
451
434
  id: string,
452
435
  /** The date and time when the entity was first created. **/
@@ -467,8 +450,7 @@ declare class Channel implements Entity {
467
450
  /** The channel balance on the local node. **/
468
451
  localBalance?: CurrencyAmount | undefined,
469
452
  /**
470
- * The channel balance on the local node that is currently allocated to in-progress payments.
471
- * *
453
+ * The channel balance on the local node that is currently allocated to in-progress payments. *
472
454
  */
473
455
  localUnsettledBalance?: CurrencyAmount | undefined,
474
456
  /** The channel balance on the remote node. **/
@@ -499,9 +481,8 @@ declare class Channel implements Entity {
499
481
  /** If known, the remote node of the channel. **/
500
482
  remoteNodeId?: string | undefined,
501
483
  /**
502
- * The unique identifier of the channel on Lightning Network,
503
- * which is the location in the chain that the channel was confirmed. The format is
504
- * <block-height>:<tx-index>:<tx-output>.
484
+ * The unique identifier of the channel on Lightning Network, which is the location in the
485
+ * chain that the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
505
486
  **/
506
487
  shortChannelId?: string | undefined);
507
488
  getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
@@ -538,18 +519,16 @@ declare class Channel implements Entity {
538
519
 
539
520
  declare class AccountToChannelsConnection {
540
521
  /**
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).
522
+ * The total count of objects in this connection, using the current filters. It is different
523
+ * from the number of objects returned in the current page (in the `entities` field).
544
524
  **/
545
525
  readonly count: number;
546
526
  /** The channels for the current page of this connection. **/
547
527
  readonly entities: Channel[];
548
528
  constructor(
549
529
  /**
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).
530
+ * The total count of objects in this connection, using the current filters. It is different
531
+ * from the number of objects returned in the current page (in the `entities` field).
553
532
  **/
554
533
  count: number,
555
534
  /** The channels for the current page of this connection. **/
@@ -587,18 +566,16 @@ declare class AccountToChannelsConnection {
587
566
  }
588
567
 
589
568
  /**
590
- * This is an object representing the balance associated with your Lightspark account.
591
- * You can retrieve this object to see your balance,
592
- * which can be broken down into several different categorizations.
593
- * *
569
+ * This is an object representing the balance associated with your Lightspark account. You can
570
+ * retrieve this object to see your balance, which can be broken down into several different
571
+ * categorizations. *
594
572
  */
595
573
  interface Balances {
596
574
  /**
597
575
  * 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.
576
+ * now?". It represents the amount currently owned, including things that may not be owned soon
577
+ * (e.g. in-flight outgoing payments, in-flight withdrawals, commit fees, etc.). It really is a
578
+ * snapshot of what is officially owned at this instant.
602
579
  **/
603
580
  ownedBalance: CurrencyAmount;
604
581
  /**
@@ -610,10 +587,9 @@ interface Balances {
610
587
  availableToSendBalance: CurrencyAmount;
611
588
  /**
612
589
  * 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).
590
+ * withdraw on the Bitcoin network right now?". It represents the amount currently available to
591
+ * withdraw and is usually equal to the `owned_balance` but it does not include in-flight
592
+ * operations (which would likely succeed and therefore likely make your withdrawal fail).
617
593
  **/
618
594
  availableToWithdrawBalance: CurrencyAmount;
619
595
  }
@@ -636,9 +612,8 @@ interface BlockchainBalance {
636
612
 
637
613
  interface LightsparkNodeToChannelsConnection {
638
614
  /**
639
- * The total count of objects in this connection, using the current filters.
640
- * It is different from the number of objects returned in the current page (in the `entities`
641
- * field).
615
+ * The total count of objects in this connection, using the current filters. It is different
616
+ * from the number of objects returned in the current page (in the `entities` field).
642
617
  **/
643
618
  count: number;
644
619
  /** An object that holds pagination information about the objects in this connection. **/
@@ -663,9 +638,8 @@ interface NodeAddress {
663
638
  */
664
639
  interface NodeToAddressesConnection {
665
640
  /**
666
- * The total count of objects in this connection, using the current filters.
667
- * It is different from the number of objects returned in the current page (in the `entities`
668
- * field).
641
+ * The total count of objects in this connection, using the current filters. It is different
642
+ * from the number of objects returned in the current page (in the `entities` field).
669
643
  **/
670
644
  count: number;
671
645
  /** The addresses for the current page of this connection. **/
@@ -674,13 +648,12 @@ interface NodeToAddressesConnection {
674
648
 
675
649
  /**
676
650
  * 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
- * *
651
+ * account. This object contains information about the node’s configuration, state, and metadata. *
679
652
  */
680
653
  interface LightsparkNode {
681
654
  /**
682
- * The unique identifier of this entity across all Lightspark systems.
683
- * Should be treated as an opaque string.
655
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
656
+ * opaque string.
684
657
  **/
685
658
  id: string;
686
659
  /** The date and time when the entity was first created. **/
@@ -704,16 +677,15 @@ interface LightsparkNode {
704
677
  /** The typename of the object **/
705
678
  typename: string;
706
679
  /**
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.
680
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
681
+ * just a way to identify and search for commercial services or popular nodes. This alias can
682
+ * be changed at any time by the node operator.
710
683
  **/
711
684
  alias?: string | undefined;
712
685
  /**
713
686
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
714
- * white. It has no importance in terms of operating the node,
715
- * it is just a way to visually differentiate nodes.
716
- * That color can be changed at any time by the node operator.
687
+ * white. It has no importance in terms of operating the node, it is just a way to visually
688
+ * differentiate nodes. That color can be changed at any time by the node operator.
717
689
  **/
718
690
  color?: string | undefined;
719
691
  /**
@@ -770,9 +742,8 @@ declare const getLightsparkNodeQuery: (id: string) => Query<LightsparkNode>;
770
742
  /** A connection between an account and the nodes it manages. **/
771
743
  interface AccountToNodesConnection {
772
744
  /**
773
- * The total count of objects in this connection, using the current filters.
774
- * It is different from the number of objects returned in the current page (in the `entities`
775
- * field).
745
+ * The total count of objects in this connection, using the current filters. It is different
746
+ * from the number of objects returned in the current page (in the `entities` field).
776
747
  **/
777
748
  count: number;
778
749
  /** An object that holds pagination information about the objects in this connection. **/
@@ -785,8 +756,7 @@ interface AccountToNodesConnection {
785
756
 
786
757
  /**
787
758
  * 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
- * *
759
+ * Invoice). It contains data related to parsing the payment details of a Lightning Invoice. *
790
760
  */
791
761
  interface PaymentRequestData {
792
762
  encodedPaymentRequest: string;
@@ -816,8 +786,8 @@ declare enum PaymentRequestStatus {
816
786
  */
817
787
  interface PaymentRequest {
818
788
  /**
819
- * The unique identifier of this entity across all Lightspark systems.
820
- * Should be treated as an opaque string.
789
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
790
+ * opaque string.
821
791
  **/
822
792
  id: string;
823
793
  /** The date and time when the entity was first created. **/
@@ -835,9 +805,8 @@ declare const getPaymentRequestQuery: (id: string) => Query<PaymentRequest>;
835
805
 
836
806
  interface AccountToPaymentRequestsConnection {
837
807
  /**
838
- * The total count of objects in this connection, using the current filters.
839
- * It is different from the number of objects returned in the current page (in the `entities`
840
- * field).
808
+ * The total count of objects in this connection, using the current filters. It is different
809
+ * from the number of objects returned in the current page (in the `entities` field).
841
810
  **/
842
811
  count: number;
843
812
  /** An object that holds pagination information about the objects in this connection. **/
@@ -865,8 +834,7 @@ declare enum TransactionStatus {
865
834
  /** Transaction has been initiated and is currently in-flight. **/
866
835
  PENDING = "PENDING",
867
836
  /**
868
- * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
869
- * *
837
+ * For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request. *
870
838
  */
871
839
  NOT_STARTED = "NOT_STARTED",
872
840
  /** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/
@@ -878,13 +846,12 @@ declare enum TransactionStatus {
878
846
  /**
879
847
  * This object represents a payment transaction. The transaction can occur either on a Bitcoin
880
848
  * Network, or over the Lightning Network. You can retrieve this object to receive specific
881
- * information about a particular transaction tied to your Lightspark Node.
882
- * *
849
+ * information about a particular transaction tied to your Lightspark Node. *
883
850
  */
884
851
  interface Transaction {
885
852
  /**
886
- * The unique identifier of this entity across all Lightspark systems.
887
- * Should be treated as an opaque string.
853
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
854
+ * opaque string.
888
855
  **/
889
856
  id: string;
890
857
  /** The date and time when this transaction was initiated. **/
@@ -906,9 +873,8 @@ declare const getTransactionQuery: (id: string) => Query<Transaction>;
906
873
 
907
874
  interface AccountToTransactionsConnection {
908
875
  /**
909
- * The total count of objects in this connection, using the current filters.
910
- * It is different from the number of objects returned in the current page (in the `entities`
911
- * field).
876
+ * The total count of objects in this connection, using the current filters. It is different
877
+ * from the number of objects returned in the current page (in the `entities` field).
912
878
  **/
913
879
  count: number;
914
880
  /** An object that holds pagination information about the objects in this connection. **/
@@ -918,13 +884,13 @@ interface AccountToTransactionsConnection {
918
884
  /** The typename of the object **/
919
885
  typename: string;
920
886
  /**
921
- * Profit (or loss) generated by the transactions in this connection,
922
- * with the set of filters and constraints provided.
887
+ * Profit (or loss) generated by the transactions in this connection, with the set of filters
888
+ * and constraints provided.
923
889
  **/
924
890
  profitLoss?: CurrencyAmount | undefined;
925
891
  /**
926
- * Average fee earned for the transactions in this connection,
927
- * with the set of filters and constraints provided.
892
+ * Average fee earned for the transactions in this connection, with the set of filters and
893
+ * constraints provided.
928
894
  **/
929
895
  averageFeeEarned?: CurrencyAmount | undefined;
930
896
  /**
@@ -937,8 +903,8 @@ interface AccountToTransactionsConnection {
937
903
  /** This is an object representing the owner of a LightsparkNode. **/
938
904
  interface LightsparkNodeOwner {
939
905
  /**
940
- * The unique identifier of this entity across all Lightspark systems.
941
- * Should be treated as an opaque string.
906
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
907
+ * opaque string.
942
908
  **/
943
909
  id: string;
944
910
  /** The date and time when the entity was first created. **/
@@ -958,16 +924,14 @@ declare enum WalletStatus {
958
924
  */
959
925
  FUTURE_VALUE = "FUTURE_VALUE",
960
926
  /**
961
- * The wallet has not been set up yet and is ready to be deployed.
962
- * This is the default status after the first login.
963
- * *
927
+ * The wallet has not been set up yet and is ready to be deployed. This is the default status
928
+ * after the first login. *
964
929
  */
965
930
  NOT_SETUP = "NOT_SETUP",
966
931
  /** The wallet is currently being deployed in the Lightspark infrastructure. **/
967
932
  DEPLOYING = "DEPLOYING",
968
933
  /**
969
- * The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized.
970
- * *
934
+ * The wallet has been deployed in the Lightspark infrastructure and is ready to be initialized. *
971
935
  */
972
936
  DEPLOYED = "DEPLOYED",
973
937
  /** The wallet is currently being initialized. **/
@@ -985,17 +949,16 @@ declare enum WalletStatus {
985
949
  TERMINATING = "TERMINATING",
986
950
  /**
987
951
  * 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. *
952
+ * It is not connected to the Lightning network and its funds can only be accessed using the
953
+ * Funds Recovery flow. *
990
954
  */
991
955
  TERMINATED = "TERMINATED"
992
956
  }
993
957
 
994
958
  interface WalletToPaymentRequestsConnection {
995
959
  /**
996
- * The total count of objects in this connection, using the current filters.
997
- * It is different from the number of objects returned in the current page (in the `entities`
998
- * field).
960
+ * The total count of objects in this connection, using the current filters. It is different
961
+ * from the number of objects returned in the current page (in the `entities` field).
999
962
  **/
1000
963
  count: number;
1001
964
  /** An object that holds pagination information about the objects in this connection. **/
@@ -1008,9 +971,8 @@ interface WalletToPaymentRequestsConnection {
1008
971
 
1009
972
  interface WalletToTransactionsConnection {
1010
973
  /**
1011
- * The total count of objects in this connection, using the current filters.
1012
- * It is different from the number of objects returned in the current page (in the `entities`
1013
- * field).
974
+ * The total count of objects in this connection, using the current filters. It is different
975
+ * from the number of objects returned in the current page (in the `entities` field).
1014
976
  **/
1015
977
  count: number;
1016
978
  /** An object that holds pagination information about the objects in this connection. **/
@@ -1021,16 +983,280 @@ interface WalletToTransactionsConnection {
1021
983
  typename: string;
1022
984
  }
1023
985
 
986
+ /** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
987
+ declare enum WithdrawalMode {
988
+ /**
989
+ * This is an enum value that represents values that could be added in the future.
990
+ * Clients should support unknown values as more of them could be added without notice.
991
+ */
992
+ FUTURE_VALUE = "FUTURE_VALUE",
993
+ WALLET_ONLY = "WALLET_ONLY",
994
+ WALLET_THEN_CHANNELS = "WALLET_THEN_CHANNELS"
995
+ }
996
+
997
+ /** This is an enum of the potential statuses that a Withdrawal can take. **/
998
+ declare enum WithdrawalRequestStatus {
999
+ /**
1000
+ * This is an enum value that represents values that could be added in the future.
1001
+ * Clients should support unknown values as more of them could be added without notice.
1002
+ */
1003
+ FUTURE_VALUE = "FUTURE_VALUE",
1004
+ CREATED = "CREATED",
1005
+ FAILED = "FAILED",
1006
+ IN_PROGRESS = "IN_PROGRESS",
1007
+ SUCCESSFUL = "SUCCESSFUL"
1008
+ }
1009
+
1010
+ /**
1011
+ * This is an object representing a transaction which closes a channel on the Lightning Network.
1012
+ * This operation allocates balances back to the local and remote nodes. *
1013
+ */
1014
+ interface ChannelClosingTransaction {
1015
+ /**
1016
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1017
+ * opaque string.
1018
+ **/
1019
+ id: string;
1020
+ /** The date and time when this transaction was initiated. **/
1021
+ createdAt: string;
1022
+ /** The date and time when the entity was last updated. **/
1023
+ updatedAt: string;
1024
+ /** The current status of this transaction. **/
1025
+ status: TransactionStatus;
1026
+ /** The amount of money involved in this transaction. **/
1027
+ amount: CurrencyAmount;
1028
+ /**
1029
+ * The height of the block that included this transaction. This will be zero for unconfirmed
1030
+ * transactions.
1031
+ **/
1032
+ blockHeight: number;
1033
+ /** The Bitcoin blockchain addresses this transaction was sent to. **/
1034
+ destinationAddresses: string[];
1035
+ /** The typename of the object **/
1036
+ typename: string;
1037
+ /** The date and time when this transaction was completed or failed. **/
1038
+ resolvedAt?: string | undefined;
1039
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1040
+ transactionHash?: string | undefined;
1041
+ /**
1042
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
1043
+ * blockchain.
1044
+ **/
1045
+ fees?: CurrencyAmount | undefined;
1046
+ /**
1047
+ * The hash of the block that included this transaction. This will be null for unconfirmed
1048
+ * transactions.
1049
+ **/
1050
+ blockHash?: string | undefined;
1051
+ /** The number of blockchain confirmations for this transaction in real time. **/
1052
+ numConfirmations?: number | undefined;
1053
+ /** If known, the channel this transaction is closing. **/
1054
+ channelId?: string | undefined;
1055
+ }
1056
+ declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
1057
+
1058
+ interface WithdrawalRequestToChannelClosingTransactionsConnection {
1059
+ /** An object that holds pagination information about the objects in this connection. **/
1060
+ pageInfo: PageInfo;
1061
+ /**
1062
+ * The total count of objects in this connection, using the current filters. It is different
1063
+ * from the number of objects returned in the current page (in the `entities` field).
1064
+ **/
1065
+ count: number;
1066
+ /** The channel closing transactions for the current page of this connection. **/
1067
+ entities: ChannelClosingTransaction[];
1068
+ }
1069
+
1024
1070
  /**
1025
- * This object represents a Lightspark Wallet, tied to your Lightspark account.
1026
- * Wallets can be used to send or receive funds over the Lightning Network.
1027
- * You can retrieve this object to receive information about a specific wallet tied to your
1028
- * Lightspark account. *
1071
+ * This is an object representing a transaction which opens a channel on the Lightning Network.
1072
+ * This object occurs only for channels funded by the local Lightspark node. *
1073
+ */
1074
+ interface ChannelOpeningTransaction {
1075
+ /**
1076
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1077
+ * opaque string.
1078
+ **/
1079
+ id: string;
1080
+ /** The date and time when this transaction was initiated. **/
1081
+ createdAt: string;
1082
+ /** The date and time when the entity was last updated. **/
1083
+ updatedAt: string;
1084
+ /** The current status of this transaction. **/
1085
+ status: TransactionStatus;
1086
+ /** The amount of money involved in this transaction. **/
1087
+ amount: CurrencyAmount;
1088
+ /**
1089
+ * The height of the block that included this transaction. This will be zero for unconfirmed
1090
+ * transactions.
1091
+ **/
1092
+ blockHeight: number;
1093
+ /** The Bitcoin blockchain addresses this transaction was sent to. **/
1094
+ destinationAddresses: string[];
1095
+ /** The typename of the object **/
1096
+ typename: string;
1097
+ /** The date and time when this transaction was completed or failed. **/
1098
+ resolvedAt?: string | undefined;
1099
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1100
+ transactionHash?: string | undefined;
1101
+ /**
1102
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
1103
+ * blockchain.
1104
+ **/
1105
+ fees?: CurrencyAmount | undefined;
1106
+ /**
1107
+ * The hash of the block that included this transaction. This will be null for unconfirmed
1108
+ * transactions.
1109
+ **/
1110
+ blockHash?: string | undefined;
1111
+ /** The number of blockchain confirmations for this transaction in real time. **/
1112
+ numConfirmations?: number | undefined;
1113
+ /** If known, the channel this transaction is opening. **/
1114
+ channelId?: string | undefined;
1115
+ }
1116
+ declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
1117
+
1118
+ interface WithdrawalRequestToChannelOpeningTransactionsConnection {
1119
+ /** An object that holds pagination information about the objects in this connection. **/
1120
+ pageInfo: PageInfo;
1121
+ /**
1122
+ * The total count of objects in this connection, using the current filters. It is different
1123
+ * from the number of objects returned in the current page (in the `entities` field).
1124
+ **/
1125
+ count: number;
1126
+ /** The channel opening transactions for the current page of this connection. **/
1127
+ entities: ChannelOpeningTransaction[];
1128
+ }
1129
+
1130
+ /**
1131
+ * This object represents a request made for an L1 withdrawal from your Lightspark Node to any
1132
+ * Bitcoin wallet. You can retrieve this object to receive detailed information about any
1133
+ * withdrawal request made from your Lightspark account. *
1134
+ */
1135
+ declare class WithdrawalRequest implements Entity {
1136
+ /**
1137
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1138
+ * opaque string.
1139
+ **/
1140
+ readonly id: string;
1141
+ /** The date and time when the entity was first created. **/
1142
+ readonly createdAt: string;
1143
+ /** The date and time when the entity was last updated. **/
1144
+ readonly updatedAt: string;
1145
+ /**
1146
+ * The requested amount of money to be withdrawn. If the requested amount is -1, it means to
1147
+ * withdraw all.
1148
+ **/
1149
+ readonly requestedAmount: CurrencyAmount;
1150
+ /**
1151
+ * The amount of money that should be withdrawn in this request.
1152
+ *
1153
+ * @deprecated Use `requested_amount` instead
1154
+ **/
1155
+ readonly amount: CurrencyAmount;
1156
+ /** The bitcoin address where the funds should be sent. **/
1157
+ readonly bitcoinAddress: string;
1158
+ /** The strategy that should be used to withdraw the funds from the account. **/
1159
+ readonly withdrawalMode: WithdrawalMode;
1160
+ /** The current status of this withdrawal request. **/
1161
+ readonly status: WithdrawalRequestStatus;
1162
+ /** The typename of the object **/
1163
+ readonly typename: string;
1164
+ /**
1165
+ * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the
1166
+ * amount for the withdrawal.
1167
+ **/
1168
+ readonly estimatedAmount?: CurrencyAmount | undefined;
1169
+ /** The actual amount that is withdrawn. It will be set once the request is completed. **/
1170
+ readonly amountWithdrawn?: CurrencyAmount | undefined;
1171
+ /** The time at which this request was completed. **/
1172
+ readonly completedAt?: string | undefined;
1173
+ /** The withdrawal transaction that has been generated by this request. **/
1174
+ readonly withdrawalId?: string | undefined;
1175
+ constructor(
1176
+ /**
1177
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1178
+ * opaque string.
1179
+ **/
1180
+ id: string,
1181
+ /** The date and time when the entity was first created. **/
1182
+ createdAt: string,
1183
+ /** The date and time when the entity was last updated. **/
1184
+ updatedAt: string,
1185
+ /**
1186
+ * The requested amount of money to be withdrawn. If the requested amount is -1, it means to
1187
+ * withdraw all.
1188
+ **/
1189
+ requestedAmount: CurrencyAmount,
1190
+ /**
1191
+ * The amount of money that should be withdrawn in this request.
1192
+ *
1193
+ * @deprecated Use `requested_amount` instead
1194
+ **/
1195
+ amount: CurrencyAmount,
1196
+ /** The bitcoin address where the funds should be sent. **/
1197
+ bitcoinAddress: string,
1198
+ /** The strategy that should be used to withdraw the funds from the account. **/
1199
+ withdrawalMode: WithdrawalMode,
1200
+ /** The current status of this withdrawal request. **/
1201
+ status: WithdrawalRequestStatus,
1202
+ /** The typename of the object **/
1203
+ typename: string,
1204
+ /**
1205
+ * If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the
1206
+ * amount for the withdrawal.
1207
+ **/
1208
+ estimatedAmount?: CurrencyAmount | undefined,
1209
+ /** The actual amount that is withdrawn. It will be set once the request is completed. **/
1210
+ amountWithdrawn?: CurrencyAmount | undefined,
1211
+ /** The time at which this request was completed. **/
1212
+ completedAt?: string | undefined,
1213
+ /** The withdrawal transaction that has been generated by this request. **/
1214
+ withdrawalId?: string | undefined);
1215
+ getChannelClosingTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelClosingTransactionsConnection>;
1216
+ getChannelOpeningTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelOpeningTransactionsConnection>;
1217
+ static getWithdrawalRequestQuery(id: string): Query<WithdrawalRequest>;
1218
+ toJson(): {
1219
+ __typename: string;
1220
+ withdrawal_request_id: string;
1221
+ withdrawal_request_created_at: string;
1222
+ withdrawal_request_updated_at: string;
1223
+ withdrawal_request_requested_amount: any;
1224
+ withdrawal_request_amount: any;
1225
+ withdrawal_request_estimated_amount: any;
1226
+ withdrawal_request_amount_withdrawn: any;
1227
+ withdrawal_request_bitcoin_address: string;
1228
+ withdrawal_request_withdrawal_mode: WithdrawalMode;
1229
+ withdrawal_request_status: WithdrawalRequestStatus;
1230
+ withdrawal_request_completed_at: string | undefined;
1231
+ withdrawal_request_withdrawal: {
1232
+ id: string | undefined;
1233
+ };
1234
+ };
1235
+ }
1236
+
1237
+ interface WalletToWithdrawalRequestsConnection {
1238
+ /**
1239
+ * The total count of objects in this connection, using the current filters. It is different
1240
+ * from the number of objects returned in the current page (in the `entities` field).
1241
+ **/
1242
+ count: number;
1243
+ /** An object that holds pagination information about the objects in this connection. **/
1244
+ pageInfo: PageInfo;
1245
+ /** The withdrawal requests for the current page of this connection. **/
1246
+ entities: WithdrawalRequest[];
1247
+ /** The typename of the object **/
1248
+ typename: string;
1249
+ }
1250
+
1251
+ /**
1252
+ * This object represents a Lightspark Wallet, tied to your Lightspark account. Wallets can be used
1253
+ * to send or receive funds over the Lightning Network. You can retrieve this object to receive
1254
+ * information about a specific wallet tied to your Lightspark account. *
1029
1255
  */
1030
1256
  declare class Wallet implements LightsparkNodeOwner, Entity {
1031
1257
  /**
1032
- * The unique identifier of this entity across all Lightspark systems.
1033
- * Should be treated as an opaque string.
1258
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1259
+ * opaque string.
1034
1260
  **/
1035
1261
  readonly id: string;
1036
1262
  /** The date and time when the entity was first created. **/
@@ -1038,8 +1264,7 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1038
1264
  /** The date and time when the entity was last updated. **/
1039
1265
  readonly updatedAt: string;
1040
1266
  /**
1041
- * The unique identifier of this wallet, as provided by the Lightspark Customer during login.
1042
- * *
1267
+ * The unique identifier of this wallet, as provided by the Lightspark Customer during login. *
1043
1268
  */
1044
1269
  readonly thirdPartyIdentifier: string;
1045
1270
  /** The status of this wallet. **/
@@ -1054,8 +1279,8 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1054
1279
  readonly accountId?: string | undefined;
1055
1280
  constructor(
1056
1281
  /**
1057
- * The unique identifier of this entity across all Lightspark systems.
1058
- * Should be treated as an opaque string.
1282
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1283
+ * opaque string.
1059
1284
  **/
1060
1285
  id: string,
1061
1286
  /** The date and time when the entity was first created. **/
@@ -1063,8 +1288,7 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1063
1288
  /** The date and time when the entity was last updated. **/
1064
1289
  updatedAt: string,
1065
1290
  /**
1066
- * The unique identifier of this wallet, as provided by the Lightspark Customer during login.
1067
- * *
1291
+ * The unique identifier of this wallet, as provided by the Lightspark Customer during login. *
1068
1292
  */
1069
1293
  thirdPartyIdentifier: string,
1070
1294
  /** The status of this wallet. **/
@@ -1080,6 +1304,7 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1080
1304
  getTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined, statuses?: TransactionStatus[] | undefined, types?: TransactionType[] | undefined): Promise<WalletToTransactionsConnection>;
1081
1305
  getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<WalletToPaymentRequestsConnection>;
1082
1306
  getTotalAmountReceived(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
1307
+ getWithdrawalRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, statuses?: WithdrawalRequestStatus[] | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<WalletToWithdrawalRequestsConnection>;
1083
1308
  getTotalAmountSent(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
1084
1309
  static getWalletQuery(id: string): Query<Wallet>;
1085
1310
  toJson(): {
@@ -1099,9 +1324,8 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
1099
1324
 
1100
1325
  interface AccountToWalletsConnection {
1101
1326
  /**
1102
- * The total count of objects in this connection, using the current filters.
1103
- * It is different from the number of objects returned in the current page (in the `entities`
1104
- * field).
1327
+ * The total count of objects in this connection, using the current filters. It is different
1328
+ * from the number of objects returned in the current page (in the `entities` field).
1105
1329
  **/
1106
1330
  count: number;
1107
1331
  /** An object that holds pagination information about the objects in this connection. **/
@@ -1112,6 +1336,21 @@ interface AccountToWalletsConnection {
1112
1336
  typename: string;
1113
1337
  }
1114
1338
 
1339
+ /** A connection between an account and its past and present withdrawal requests. **/
1340
+ interface AccountToWithdrawalRequestsConnection {
1341
+ /**
1342
+ * The total count of objects in this connection, using the current filters. It is different
1343
+ * from the number of objects returned in the current page (in the `entities` field).
1344
+ **/
1345
+ count: number;
1346
+ /** An object that holds pagination information about the objects in this connection. **/
1347
+ pageInfo: PageInfo;
1348
+ /** The withdrawal requests for the current page of this connection. **/
1349
+ entities: WithdrawalRequest[];
1350
+ /** The typename of the object **/
1351
+ typename: string;
1352
+ }
1353
+
1115
1354
  /**
1116
1355
  * This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may
1117
1356
  * have failed. *
@@ -1156,14 +1395,13 @@ interface TransactionFailures {
1156
1395
  }
1157
1396
 
1158
1397
  /**
1159
- * This is an object representing the connected Lightspark account.
1160
- * You can retrieve this object to see your account information and objects tied to your account.
1161
- * *
1398
+ * This is an object representing the connected Lightspark account. You can retrieve this object to
1399
+ * see your account information and objects tied to your account. *
1162
1400
  */
1163
1401
  declare class Account implements LightsparkNodeOwner, Entity {
1164
1402
  /**
1165
- * The unique identifier of this entity across all Lightspark systems.
1166
- * Should be treated as an opaque string.
1403
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1404
+ * opaque string.
1167
1405
  **/
1168
1406
  readonly id: string;
1169
1407
  /** The date and time when the entity was first created. **/
@@ -1176,8 +1414,8 @@ declare class Account implements LightsparkNodeOwner, Entity {
1176
1414
  readonly name?: string | undefined;
1177
1415
  constructor(
1178
1416
  /**
1179
- * The unique identifier of this entity across all Lightspark systems.
1180
- * Should be treated as an opaque string.
1417
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1418
+ * opaque string.
1181
1419
  **/
1182
1420
  id: string,
1183
1421
  /** The date and time when the entity was first created. **/
@@ -1198,6 +1436,7 @@ declare class Account implements LightsparkNodeOwner, Entity {
1198
1436
  getChannels(client: LightsparkClient, bitcoinNetwork: BitcoinNetwork, lightningNodeId?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, first?: number | undefined): Promise<AccountToChannelsConnection>;
1199
1437
  getTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined, types?: TransactionType[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined, statuses?: TransactionStatus[] | undefined, excludeFailures?: TransactionFailures | undefined): Promise<AccountToTransactionsConnection>;
1200
1438
  getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined): Promise<AccountToPaymentRequestsConnection>;
1439
+ getWithdrawalRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, bitcoinNetworks?: BitcoinNetwork[] | undefined, statuses?: WithdrawalRequestStatus[] | undefined, nodeIds?: string[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<AccountToWithdrawalRequestsConnection>;
1201
1440
  getWallets(client: LightsparkClient, first?: number | undefined, after?: string | undefined, thirdPartyIds?: string[] | undefined): Promise<AccountToWalletsConnection>;
1202
1441
  static getAccountQuery(): Query<Account>;
1203
1442
  toJson(): {
@@ -1209,21 +1448,30 @@ declare class Account implements LightsparkNodeOwner, Entity {
1209
1448
  };
1210
1449
  }
1211
1450
 
1451
+ /** This is an enum identifying a type of compliance provider. **/
1452
+ declare enum ComplianceProvider {
1453
+ /**
1454
+ * This is an enum value that represents values that could be added in the future.
1455
+ * Clients should support unknown values as more of them could be added without notice.
1456
+ */
1457
+ FUTURE_VALUE = "FUTURE_VALUE",
1458
+ CHAINALYSIS = "CHAINALYSIS"
1459
+ }
1460
+
1212
1461
  interface CreateApiTokenOutput {
1213
1462
  /** The API Token that has been created. **/
1214
1463
  apiToken: ApiToken;
1215
1464
  /**
1216
- * The secret that should be used to authenticate against our API.
1217
- * This secret is not stored and will never be available again after this.
1218
- * You must keep this secret secure as it grants access to your account.
1465
+ * The secret that should be used to authenticate against our API. This secret is not stored
1466
+ * and will never be available again after this. You must keep this secret secure as it grants
1467
+ * access to your account.
1219
1468
  **/
1220
1469
  clientSecret: string;
1221
1470
  }
1222
1471
 
1223
1472
  /**
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
- * *
1473
+ * This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates
1474
+ * are separated by potential confirmation speeds for settlement. *
1227
1475
  */
1228
1476
  interface FeeEstimate {
1229
1477
  feeFast: CurrencyAmount;
@@ -1250,8 +1498,8 @@ declare enum IncomingPaymentAttemptStatus {
1250
1498
  */
1251
1499
  interface IncomingPaymentAttempt {
1252
1500
  /**
1253
- * The unique identifier of this entity across all Lightspark systems.
1254
- * Should be treated as an opaque string.
1501
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1502
+ * opaque string.
1255
1503
  **/
1256
1504
  id: string;
1257
1505
  /** The date and time when the entity was first created. **/
@@ -1274,9 +1522,8 @@ declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaym
1274
1522
  /** The connection from incoming payment to all attempts. **/
1275
1523
  interface IncomingPaymentToAttemptsConnection {
1276
1524
  /**
1277
- * The total count of objects in this connection, using the current filters.
1278
- * It is different from the number of objects returned in the current page (in the `entities`
1279
- * field).
1525
+ * The total count of objects in this connection, using the current filters. It is different
1526
+ * from the number of objects returned in the current page (in the `entities` field).
1280
1527
  **/
1281
1528
  count: number;
1282
1529
  /** An object that holds pagination information about the objects in this connection. **/
@@ -1288,14 +1535,14 @@ interface IncomingPaymentToAttemptsConnection {
1288
1535
  }
1289
1536
 
1290
1537
  /**
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. *
1538
+ * This is an object representing a transaction made over the Lightning Network. You can retrieve
1539
+ * this object to receive information about a specific transaction made over Lightning for a
1540
+ * Lightspark node. *
1294
1541
  */
1295
1542
  interface LightningTransaction {
1296
1543
  /**
1297
- * The unique identifier of this entity across all Lightspark systems.
1298
- * Should be treated as an opaque string.
1544
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1545
+ * opaque string.
1299
1546
  **/
1300
1547
  id: string;
1301
1548
  /** The date and time when this transaction was initiated. **/
@@ -1327,14 +1574,14 @@ interface PostTransactionData {
1327
1574
  }
1328
1575
 
1329
1576
  /**
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. *
1577
+ * This object represents any payment sent to a Lightspark node on the Lightning Network. You can
1578
+ * retrieve this object to receive payment related information about a specific payment received by
1579
+ * a Lightspark node. *
1333
1580
  */
1334
1581
  declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
1335
1582
  /**
1336
- * The unique identifier of this entity across all Lightspark systems.
1337
- * Should be treated as an opaque string.
1583
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1584
+ * opaque string.
1338
1585
  **/
1339
1586
  readonly id: string;
1340
1587
  /** The date and time when this transaction was initiated. **/
@@ -1354,16 +1601,16 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
1354
1601
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1355
1602
  readonly transactionHash?: string | undefined;
1356
1603
  /**
1357
- * The optional payment request for this incoming payment,
1358
- * which will be null if the payment is sent through keysend.
1604
+ * The optional payment request for this incoming payment, which will be null if the payment is
1605
+ * sent through keysend.
1359
1606
  **/
1360
1607
  readonly paymentRequestId?: string | undefined;
1361
1608
  /** The post transaction data which can be used in KYT payment registration. **/
1362
1609
  readonly umaPostTransactionData?: PostTransactionData[] | undefined;
1363
1610
  constructor(
1364
1611
  /**
1365
- * The unique identifier of this entity across all Lightspark systems.
1366
- * Should be treated as an opaque string.
1612
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1613
+ * opaque string.
1367
1614
  **/
1368
1615
  id: string,
1369
1616
  /** The date and time when this transaction was initiated. **/
@@ -1383,8 +1630,8 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
1383
1630
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1384
1631
  transactionHash?: string | undefined,
1385
1632
  /**
1386
- * The optional payment request for this incoming payment,
1387
- * which will be null if the payment is sent through keysend.
1633
+ * The optional payment request for this incoming payment, which will be null if the payment is
1634
+ * sent through keysend.
1388
1635
  **/
1389
1636
  paymentRequestId?: string | undefined,
1390
1637
  /** The post transaction data which can be used in KYT payment registration. **/
@@ -1411,14 +1658,13 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
1411
1658
  }
1412
1659
 
1413
1660
  /**
1414
- * This object is an interface representing a Lightning Node on the Lightning Network,
1415
- * and could either be a Lightspark node or a node managed by a third party.
1416
- * *
1661
+ * This object is an interface representing a Lightning Node on the Lightning Network, and could
1662
+ * either be a Lightspark node or a node managed by a third party. *
1417
1663
  */
1418
1664
  interface Node {
1419
1665
  /**
1420
- * The unique identifier of this entity across all Lightspark systems.
1421
- * Should be treated as an opaque string.
1666
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1667
+ * opaque string.
1422
1668
  **/
1423
1669
  id: string;
1424
1670
  /** The date and time when the entity was first created. **/
@@ -1435,16 +1681,15 @@ interface Node {
1435
1681
  /** The typename of the object **/
1436
1682
  typename: string;
1437
1683
  /**
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.
1684
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
1685
+ * just a way to identify and search for commercial services or popular nodes. This alias can
1686
+ * be changed at any time by the node operator.
1441
1687
  **/
1442
1688
  alias?: string | undefined;
1443
1689
  /**
1444
1690
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
1445
- * white. It has no importance in terms of operating the node,
1446
- * it is just a way to visually differentiate nodes.
1447
- * That color can be changed at any time by the node operator.
1691
+ * white. It has no importance in terms of operating the node, it is just a way to visually
1692
+ * differentiate nodes. That color can be changed at any time by the node operator.
1448
1693
  **/
1449
1694
  color?: string | undefined;
1450
1695
  /**
@@ -1463,9 +1708,8 @@ interface Node {
1463
1708
  declare const getNodeQuery: (id: string) => Query<Node>;
1464
1709
 
1465
1710
  /**
1466
- * This object represents the data associated with a BOLT #11 invoice.
1467
- * You can retrieve this object to receive the relevant data associated with a specific invoice.
1468
- * *
1711
+ * This object represents the data associated with a BOLT #11 invoice. You can retrieve this object
1712
+ * to receive the relevant data associated with a specific invoice. *
1469
1713
  */
1470
1714
  interface InvoiceData {
1471
1715
  encodedPaymentRequest: string;
@@ -1473,8 +1717,8 @@ interface InvoiceData {
1473
1717
  /** The payment hash of this invoice. **/
1474
1718
  paymentHash: string;
1475
1719
  /**
1476
- * The requested amount in this invoice. If it is equal to 0,
1477
- * the sender should choose the amount to send.
1720
+ * The requested amount in this invoice. If it is equal to 0, the sender should choose the
1721
+ * amount to send.
1478
1722
  **/
1479
1723
  amount: CurrencyAmount;
1480
1724
  /** The date and time when this invoice was created. **/
@@ -1492,8 +1736,8 @@ interface InvoiceData {
1492
1736
  /** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node. **/
1493
1737
  interface Invoice {
1494
1738
  /**
1495
- * The unique identifier of this entity across all Lightspark systems.
1496
- * Should be treated as an opaque string.
1739
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1740
+ * opaque string.
1497
1741
  **/
1498
1742
  id: string;
1499
1743
  /** The date and time when the entity was first created. **/
@@ -1587,15 +1831,14 @@ declare enum OutgoingPaymentAttemptStatus {
1587
1831
  }
1588
1832
 
1589
1833
  /**
1590
- * This object represents a specific node that existed on a particular payment route.
1591
- * You can retrieve this object to get information about a node on a particular payment path and
1592
- * all payment-relevant information for that node.
1593
- * *
1834
+ * This object represents a specific node that existed on a particular payment route. You can
1835
+ * retrieve this object to get information about a node on a particular payment path and all
1836
+ * payment-relevant information for that node. *
1594
1837
  */
1595
1838
  interface Hop {
1596
1839
  /**
1597
- * The unique identifier of this entity across all Lightspark systems.
1598
- * Should be treated as an opaque string.
1840
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1841
+ * opaque string.
1599
1842
  **/
1600
1843
  id: string;
1601
1844
  /** The date and time when the entity was first created. **/
@@ -1625,9 +1868,8 @@ declare const getHopQuery: (id: string) => Query<Hop>;
1625
1868
  */
1626
1869
  interface OutgoingPaymentAttemptToHopsConnection {
1627
1870
  /**
1628
- * The total count of objects in this connection, using the current filters.
1629
- * It is different from the number of objects returned in the current page (in the `entities`
1630
- * field).
1871
+ * The total count of objects in this connection, using the current filters. It is different
1872
+ * from the number of objects returned in the current page (in the `entities` field).
1631
1873
  **/
1632
1874
  count: number;
1633
1875
  /** An object that holds pagination information about the objects in this connection. **/
@@ -1639,16 +1881,15 @@ interface OutgoingPaymentAttemptToHopsConnection {
1639
1881
  }
1640
1882
 
1641
1883
  /**
1642
- * This object represents an attempted Lightning Network payment sent from a Lightspark Node.
1643
- * You can retrieve this object to receive payment related information about any payment attempt
1644
- * sent from your Lightspark Node on the Lightning Network,
1645
- * including any potential reasons the payment may have failed.
1646
- * *
1884
+ * This object represents an attempted Lightning Network payment sent from a Lightspark Node. You
1885
+ * can retrieve this object to receive payment related information about any payment attempt sent
1886
+ * from your Lightspark Node on the Lightning Network, including any potential reasons the payment
1887
+ * may have failed. *
1647
1888
  */
1648
1889
  declare class OutgoingPaymentAttempt implements Entity {
1649
1890
  /**
1650
- * The unique identifier of this entity across all Lightspark systems.
1651
- * Should be treated as an opaque string.
1891
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1892
+ * opaque string.
1652
1893
  **/
1653
1894
  readonly id: string;
1654
1895
  /** The date and time when the entity was first created. **/
@@ -1673,24 +1914,23 @@ declare class OutgoingPaymentAttempt implements Entity {
1673
1914
  /** The time the outgoing payment attempt failed or succeeded. **/
1674
1915
  readonly resolvedAt?: string | undefined;
1675
1916
  /**
1676
- * The total amount of funds required to complete a payment over this route.
1677
- * This value includes the cumulative fees for each hop. As a result,
1678
- * the attempt extended to the first-hop in the route will need to have at least this much
1679
- * value, otherwise the route will fail at an intermediate node due to an insufficient amount.
1917
+ * The total amount of funds required to complete a payment over this route. This value
1918
+ * includes the cumulative fees for each hop. As a result, the attempt extended to the
1919
+ * first-hop in the route will need to have at least this much value, otherwise the route will
1920
+ * fail at an intermediate node due to an insufficient amount.
1680
1921
  **/
1681
1922
  readonly amount?: CurrencyAmount | undefined;
1682
1923
  /**
1683
- * The sum of the fees paid at each hop within the route of this attempt.
1684
- * In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to
1685
- * ourselves.
1924
+ * The sum of the fees paid at each hop within the route of this attempt. In the case of a
1925
+ * one-hop payment, this value will be zero as we don't need to pay a fee to ourselves.
1686
1926
  **/
1687
1927
  readonly fees?: CurrencyAmount | undefined;
1688
1928
  /** The channel snapshot at the time the outgoing payment attempt was made. **/
1689
1929
  readonly channelSnapshot?: ChannelSnapshot | undefined;
1690
1930
  constructor(
1691
1931
  /**
1692
- * The unique identifier of this entity across all Lightspark systems.
1693
- * Should be treated as an opaque string.
1932
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
1933
+ * opaque string.
1694
1934
  **/
1695
1935
  id: string,
1696
1936
  /** The date and time when the entity was first created. **/
@@ -1715,16 +1955,15 @@ declare class OutgoingPaymentAttempt implements Entity {
1715
1955
  /** The time the outgoing payment attempt failed or succeeded. **/
1716
1956
  resolvedAt?: string | undefined,
1717
1957
  /**
1718
- * The total amount of funds required to complete a payment over this route.
1719
- * This value includes the cumulative fees for each hop. As a result,
1720
- * the attempt extended to the first-hop in the route will need to have at least this much
1721
- * value, otherwise the route will fail at an intermediate node due to an insufficient amount.
1958
+ * The total amount of funds required to complete a payment over this route. This value
1959
+ * includes the cumulative fees for each hop. As a result, the attempt extended to the
1960
+ * first-hop in the route will need to have at least this much value, otherwise the route will
1961
+ * fail at an intermediate node due to an insufficient amount.
1722
1962
  **/
1723
1963
  amount?: CurrencyAmount | undefined,
1724
1964
  /**
1725
- * The sum of the fees paid at each hop within the route of this attempt.
1726
- * In the case of a one-hop payment, this value will be zero as we don't need to pay a fee to
1727
- * ourselves.
1965
+ * The sum of the fees paid at each hop within the route of this attempt. In the case of a
1966
+ * one-hop payment, this value will be zero as we don't need to pay a fee to ourselves.
1728
1967
  **/
1729
1968
  fees?: CurrencyAmount | undefined,
1730
1969
  /** The channel snapshot at the time the outgoing payment attempt was made. **/
@@ -1753,9 +1992,8 @@ declare class OutgoingPaymentAttempt implements Entity {
1753
1992
  /** The connection from outgoing payment to all attempts. **/
1754
1993
  interface OutgoingPaymentToAttemptsConnection {
1755
1994
  /**
1756
- * The total count of objects in this connection, using the current filters.
1757
- * It is different from the number of objects returned in the current page (in the `entities`
1758
- * field).
1995
+ * The total count of objects in this connection, using the current filters. It is different
1996
+ * from the number of objects returned in the current page (in the `entities` field).
1759
1997
  **/
1760
1998
  count: number;
1761
1999
  /** An object that holds pagination information about the objects in this connection. **/
@@ -1771,15 +2009,14 @@ interface RichText {
1771
2009
  }
1772
2010
 
1773
2011
  /**
1774
- * This object represents a Lightning Network payment sent from a Lightspark Node.
1775
- * You can retrieve this object to receive payment related information about any payment sent from
1776
- * your Lightspark Node on the Lightning Network.
1777
- * *
2012
+ * This object represents a Lightning Network payment sent from a Lightspark Node. You can retrieve
2013
+ * this object to receive payment related information about any payment sent from your Lightspark
2014
+ * Node on the Lightning Network. *
1778
2015
  */
1779
2016
  declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
1780
2017
  /**
1781
- * The unique identifier of this entity across all Lightspark systems.
1782
- * Should be treated as an opaque string.
2018
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
2019
+ * opaque string.
1783
2020
  **/
1784
2021
  readonly id: string;
1785
2022
  /** The date and time when this transaction was initiated. **/
@@ -1814,8 +2051,8 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
1814
2051
  readonly paymentPreimage?: string | undefined;
1815
2052
  constructor(
1816
2053
  /**
1817
- * The unique identifier of this entity across all Lightspark systems.
1818
- * Should be treated as an opaque string.
2054
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
2055
+ * opaque string.
1819
2056
  **/
1820
2057
  id: string,
1821
2058
  /** The date and time when this transaction was initiated. **/
@@ -1874,6 +2111,17 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
1874
2111
  };
1875
2112
  }
1876
2113
 
2114
+ /** This is an enum indicating the direction of the payment. **/
2115
+ declare enum PaymentDirection {
2116
+ /**
2117
+ * This is an enum value that represents values that could be added in the future.
2118
+ * Clients should support unknown values as more of them could be added without notice.
2119
+ */
2120
+ FUTURE_VALUE = "FUTURE_VALUE",
2121
+ SENT = "SENT",
2122
+ RECEIVED = "RECEIVED"
2123
+ }
2124
+
1877
2125
  /** The alpha-2 representation of a country, as defined by the ISO 3166-1 standard. **/
1878
2126
  declare enum RegionCode {
1879
2127
  /**
@@ -2382,228 +2630,29 @@ declare enum RegionCode {
2382
2630
  }
2383
2631
 
2384
2632
  type SingleNodeDashboard = {
2385
- id: string;
2386
- displayName: string;
2387
- color: Maybe<string>;
2388
- publicKey: Maybe<string>;
2389
- status: Maybe<LightsparkNodeStatus>;
2390
- addresses: {
2391
- address: string;
2392
- type: NodeAddressType;
2393
- }[];
2394
- totalBalance: Maybe<CurrencyAmount>;
2395
- totalLocalBalance: Maybe<CurrencyAmount>;
2396
- onlineLocalBalance: Maybe<CurrencyAmount>;
2397
- remoteBalance: Maybe<CurrencyAmount>;
2398
- blockchainBalance: {
2399
- availableBalance: Maybe<CurrencyAmount>;
2400
- totalBalance: Maybe<CurrencyAmount>;
2401
- confirmedBalance: Maybe<CurrencyAmount>;
2402
- unconfirmedBalance: Maybe<CurrencyAmount>;
2403
- } | null;
2404
- recentTransactions: Transaction[];
2405
- };
2406
-
2407
- type TransactionUpdate = {
2408
- /**
2409
- * The unique identifier of this entity across all Lightspark systems.
2410
- * Should be treated as an opaque string.
2411
- **/
2412
- id: string;
2413
- /** The date and time when this transaction was initiated. **/
2414
- createdAt: string;
2415
- /** The date and time when the entity was last updated. **/
2416
- updatedAt: string;
2417
- /** The current status of this transaction. **/
2418
- status: TransactionStatus;
2419
- /** The amount of money involved in this transaction. **/
2420
- amount: CurrencyAmount;
2421
- /** The typename of the object **/
2422
- typename: string;
2423
- /** The date and time when this transaction was completed or failed. **/
2424
- resolvedAt?: string;
2425
- /**
2426
- * The hash of this transaction, so it can be uniquely identified on the
2427
- * Lightning Network. *
2428
- */
2429
- transactionHash?: string;
2430
- };
2431
-
2432
- /** Describes the reason for an invitation to not be eligible for incentives. **/
2433
- declare enum IncentivesIneligibilityReason {
2434
- /**
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.
2437
- */
2438
- FUTURE_VALUE = "FUTURE_VALUE",
2439
- /**
2440
- * This invitation is not eligible for incentives because it has been created outside of the
2441
- * incentives flow. *
2442
- */
2443
- DISABLED = "DISABLED",
2444
- /** This invitation is not eligible for incentives because the sender is not eligible. **/
2445
- SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
2446
- /** This invitation is not eligible for incentives because the receiver is not eligible. **/
2447
- RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
2448
- /**
2449
- * This invitation is not eligible for incentives because the sending VASP is not part of the
2450
- * incentives program. *
2451
- */
2452
- SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
2453
- /**
2454
- * This invitation is not eligible for incentives because the receiving VASP is not part of the
2455
- * incentives program. *
2456
- */
2457
- RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
2458
- /**
2459
- * This invitation is not eligible for incentives because the sender and receiver are in the same
2460
- * region. *
2461
- */
2462
- NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
2463
- }
2464
-
2465
- /** Describes the status of the incentives for this invitation. **/
2466
- declare enum IncentivesStatus {
2467
- /**
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.
2470
- */
2471
- FUTURE_VALUE = "FUTURE_VALUE",
2472
- /**
2473
- * The invitation is eligible for incentives in its current state. When it is claimed, we will
2474
- * reassess. *
2475
- */
2476
- PENDING = "PENDING",
2477
- /** The incentives have been validated. **/
2478
- VALIDATED = "VALIDATED",
2479
- /**
2480
- * This invitation is not eligible for incentives.
2481
- * A more detailed reason can be found in the `incentives_ineligibility_reason` field.
2482
- * *
2483
- */
2484
- INELIGIBLE = "INELIGIBLE"
2485
- }
2486
-
2487
- /** This is an object representing an UMA.ME invitation. **/
2488
- interface UmaInvitation {
2489
- /**
2490
- * The unique identifier of this entity across all Lightspark systems.
2491
- * Should be treated as an opaque string.
2492
- **/
2493
- id: string;
2494
- /** The date and time when the entity was first created. **/
2495
- createdAt: string;
2496
- /** The date and time when the entity was last updated. **/
2497
- updatedAt: string;
2498
- /** The code that uniquely identifies this invitation. **/
2499
- code: string;
2500
- /** The URL where this invitation can be claimed. **/
2501
- url: string;
2502
- /** The UMA of the user who created the invitation. **/
2503
- inviterUma: string;
2504
- /** The current status of the incentives that may be tied to this invitation. **/
2505
- incentivesStatus: IncentivesStatus;
2506
- /** The typename of the object **/
2507
- typename: string;
2508
- /** The UMA of the user who claimed the invitation. **/
2509
- inviteeUma?: string | undefined;
2510
- /** The reason why the invitation is not eligible for incentives, if applicable. **/
2511
- incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
2512
- }
2513
- declare const getUmaInvitationQuery: (id: string) => Query<UmaInvitation>;
2514
-
2515
- /** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
2516
- declare enum WithdrawalMode {
2517
- /**
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.
2520
- */
2521
- FUTURE_VALUE = "FUTURE_VALUE",
2522
- WALLET_ONLY = "WALLET_ONLY",
2523
- WALLET_THEN_CHANNELS = "WALLET_THEN_CHANNELS"
2524
- }
2525
-
2526
- /** This is an enum of the potential statuses that a Withdrawal can take. **/
2527
- declare enum WithdrawalRequestStatus {
2528
- /**
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.
2531
- */
2532
- FUTURE_VALUE = "FUTURE_VALUE",
2533
- CREATED = "CREATED",
2534
- FAILED = "FAILED",
2535
- IN_PROGRESS = "IN_PROGRESS",
2536
- SUCCESSFUL = "SUCCESSFUL"
2537
- }
2538
-
2539
- /**
2540
- * This is an object representing a transaction which closes a channel on the Lightning Network.
2541
- * This operation allocates balances back to the local and remote nodes.
2542
- * *
2543
- */
2544
- interface ChannelClosingTransaction {
2545
- /**
2546
- * The unique identifier of this entity across all Lightspark systems.
2547
- * Should be treated as an opaque string.
2548
- **/
2549
- id: string;
2550
- /** The date and time when this transaction was initiated. **/
2551
- createdAt: string;
2552
- /** The date and time when the entity was last updated. **/
2553
- updatedAt: string;
2554
- /** The current status of this transaction. **/
2555
- status: TransactionStatus;
2556
- /** The amount of money involved in this transaction. **/
2557
- amount: CurrencyAmount;
2558
- /**
2559
- * The height of the block that included this transaction. This will be zero for unconfirmed
2560
- * transactions.
2561
- **/
2562
- blockHeight: number;
2563
- /** The Bitcoin blockchain addresses this transaction was sent to. **/
2564
- destinationAddresses: string[];
2565
- /** The typename of the object **/
2566
- typename: string;
2567
- /** The date and time when this transaction was completed or failed. **/
2568
- resolvedAt?: string | undefined;
2569
- /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2570
- transactionHash?: string | undefined;
2571
- /**
2572
- * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
2573
- * blockchain.
2574
- **/
2575
- fees?: CurrencyAmount | undefined;
2576
- /**
2577
- * The hash of the block that included this transaction. This will be null for unconfirmed
2578
- * transactions.
2579
- **/
2580
- blockHash?: string | undefined;
2581
- /** The number of blockchain confirmations for this transaction in real time. **/
2582
- numConfirmations?: number | undefined;
2583
- /** If known, the channel this transaction is closing. **/
2584
- channelId?: string | undefined;
2585
- }
2586
- declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
2587
-
2588
- interface WithdrawalRequestToChannelClosingTransactionsConnection {
2589
- /** An object that holds pagination information about the objects in this connection. **/
2590
- pageInfo: PageInfo;
2591
- /**
2592
- * The total count of objects in this connection, using the current filters.
2593
- * It is different from the number of objects returned in the current page (in the `entities`
2594
- * field).
2595
- **/
2596
- count: number;
2597
- /** The channel closing transactions for the current page of this connection. **/
2598
- entities: ChannelClosingTransaction[];
2599
- }
2633
+ id: string;
2634
+ displayName: string;
2635
+ color: Maybe<string>;
2636
+ publicKey: Maybe<string>;
2637
+ status: Maybe<LightsparkNodeStatus>;
2638
+ addresses: {
2639
+ address: string;
2640
+ type: NodeAddressType;
2641
+ }[];
2642
+ totalBalance: Maybe<CurrencyAmount>;
2643
+ totalLocalBalance: Maybe<CurrencyAmount>;
2644
+ onlineLocalBalance: Maybe<CurrencyAmount>;
2645
+ remoteBalance: Maybe<CurrencyAmount>;
2646
+ blockchainBalance: {
2647
+ availableBalance: Maybe<CurrencyAmount>;
2648
+ totalBalance: Maybe<CurrencyAmount>;
2649
+ confirmedBalance: Maybe<CurrencyAmount>;
2650
+ unconfirmedBalance: Maybe<CurrencyAmount>;
2651
+ } | null;
2652
+ recentTransactions: Transaction[];
2653
+ };
2600
2654
 
2601
- /**
2602
- * This is an object representing a transaction which opens a channel on the Lightning Network.
2603
- * This object occurs only for channels funded by the local Lightspark node.
2604
- * *
2605
- */
2606
- interface ChannelOpeningTransaction {
2655
+ type TransactionUpdate = {
2607
2656
  /**
2608
2657
  * The unique identifier of this entity across all Lightspark systems.
2609
2658
  * Should be treated as an opaque string.
@@ -2617,132 +2666,98 @@ interface ChannelOpeningTransaction {
2617
2666
  status: TransactionStatus;
2618
2667
  /** The amount of money involved in this transaction. **/
2619
2668
  amount: CurrencyAmount;
2620
- /**
2621
- * The height of the block that included this transaction. This will be zero for unconfirmed
2622
- * transactions.
2623
- **/
2624
- blockHeight: number;
2625
- /** The Bitcoin blockchain addresses this transaction was sent to. **/
2626
- destinationAddresses: string[];
2627
2669
  /** The typename of the object **/
2628
2670
  typename: string;
2629
2671
  /** The date and time when this transaction was completed or failed. **/
2630
- resolvedAt?: string | undefined;
2631
- /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2632
- transactionHash?: string | undefined;
2633
- /**
2634
- * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
2635
- * blockchain.
2636
- **/
2637
- fees?: CurrencyAmount | undefined;
2672
+ resolvedAt?: string;
2638
2673
  /**
2639
- * The hash of the block that included this transaction. This will be null for unconfirmed
2640
- * transactions.
2641
- **/
2642
- blockHash?: string | undefined;
2643
- /** The number of blockchain confirmations for this transaction in real time. **/
2644
- numConfirmations?: number | undefined;
2645
- /** If known, the channel this transaction is opening. **/
2646
- channelId?: string | undefined;
2647
- }
2648
- declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
2674
+ * The hash of this transaction, so it can be uniquely identified on the
2675
+ * Lightning Network. *
2676
+ */
2677
+ transactionHash?: string;
2678
+ };
2649
2679
 
2650
- interface WithdrawalRequestToChannelOpeningTransactionsConnection {
2651
- /** An object that holds pagination information about the objects in this connection. **/
2652
- pageInfo: PageInfo;
2680
+ /** Describes the reason for an invitation to not be eligible for incentives. **/
2681
+ declare enum IncentivesIneligibilityReason {
2653
2682
  /**
2654
- * The total count of objects in this connection, using the current filters.
2655
- * It is different from the number of objects returned in the current page (in the `entities`
2656
- * field).
2657
- **/
2658
- count: number;
2659
- /** The channel opening transactions for the current page of this connection. **/
2660
- entities: ChannelOpeningTransaction[];
2683
+ * This is an enum value that represents values that could be added in the future.
2684
+ * Clients should support unknown values as more of them could be added without notice.
2685
+ */
2686
+ FUTURE_VALUE = "FUTURE_VALUE",
2687
+ /**
2688
+ * This invitation is not eligible for incentives because it has been created outside of the
2689
+ * incentives flow. *
2690
+ */
2691
+ DISABLED = "DISABLED",
2692
+ /** This invitation is not eligible for incentives because the sender is not eligible. **/
2693
+ SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
2694
+ /** This invitation is not eligible for incentives because the receiver is not eligible. **/
2695
+ RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
2696
+ /**
2697
+ * This invitation is not eligible for incentives because the sending VASP is not part of the
2698
+ * incentives program. *
2699
+ */
2700
+ SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
2701
+ /**
2702
+ * This invitation is not eligible for incentives because the receiving VASP is not part of the
2703
+ * incentives program. *
2704
+ */
2705
+ RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
2706
+ /**
2707
+ * This invitation is not eligible for incentives because the sender and receiver are in the same
2708
+ * region. *
2709
+ */
2710
+ NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
2661
2711
  }
2662
2712
 
2663
- /**
2664
- * This object represents a request made for an L1 withdrawal from your Lightspark Node to any
2665
- * Bitcoin wallet. You can retrieve this object to receive detailed information about any
2666
- * withdrawal request made from your Lightspark account.
2667
- * *
2668
- */
2669
- declare class WithdrawalRequest implements Entity {
2713
+ /** Describes the status of the incentives for this invitation. **/
2714
+ declare enum IncentivesStatus {
2670
2715
  /**
2671
- * The unique identifier of this entity across all Lightspark systems.
2672
- * Should be treated as an opaque string.
2673
- **/
2674
- readonly id: string;
2675
- /** The date and time when the entity was first created. **/
2676
- readonly createdAt: string;
2677
- /** The date and time when the entity was last updated. **/
2678
- readonly updatedAt: string;
2679
- /** The amount of money that should be withdrawn in this request. **/
2680
- readonly amount: CurrencyAmount;
2681
- /** The bitcoin address where the funds should be sent. **/
2682
- readonly bitcoinAddress: string;
2683
- /** The strategy that should be used to withdraw the funds from the account. **/
2684
- readonly withdrawalMode: WithdrawalMode;
2685
- /** The current status of this withdrawal request. **/
2686
- readonly status: WithdrawalRequestStatus;
2687
- /** The typename of the object **/
2688
- readonly typename: string;
2716
+ * This is an enum value that represents values that could be added in the future.
2717
+ * Clients should support unknown values as more of them could be added without notice.
2718
+ */
2719
+ FUTURE_VALUE = "FUTURE_VALUE",
2689
2720
  /**
2690
- * If the requested amount is `-1` (i.e. everything),
2691
- * this field may contain an estimate of the amount for the withdrawal.
2692
- **/
2693
- readonly estimatedAmount?: CurrencyAmount | undefined;
2694
- /** The time at which this request was completed. **/
2695
- readonly completedAt?: string | undefined;
2696
- /** The withdrawal transaction that has been generated by this request. **/
2697
- readonly withdrawalId?: string | undefined;
2698
- constructor(
2721
+ * The invitation is eligible for incentives in its current state. When it is claimed, we will
2722
+ * reassess. *
2723
+ */
2724
+ PENDING = "PENDING",
2725
+ /** The incentives have been validated. **/
2726
+ VALIDATED = "VALIDATED",
2699
2727
  /**
2700
- * The unique identifier of this entity across all Lightspark systems.
2701
- * Should be treated as an opaque string.
2728
+ * This invitation is not eligible for incentives. A more detailed reason can be found in the
2729
+ * `incentives_ineligibility_reason` field. *
2730
+ */
2731
+ INELIGIBLE = "INELIGIBLE"
2732
+ }
2733
+
2734
+ /** This is an object representing an UMA.ME invitation. **/
2735
+ interface UmaInvitation {
2736
+ /**
2737
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
2738
+ * opaque string.
2702
2739
  **/
2703
- id: string,
2740
+ id: string;
2704
2741
  /** The date and time when the entity was first created. **/
2705
- createdAt: string,
2742
+ createdAt: string;
2706
2743
  /** The date and time when the entity was last updated. **/
2707
- updatedAt: string,
2708
- /** The amount of money that should be withdrawn in this request. **/
2709
- amount: CurrencyAmount,
2710
- /** The bitcoin address where the funds should be sent. **/
2711
- bitcoinAddress: string,
2712
- /** The strategy that should be used to withdraw the funds from the account. **/
2713
- withdrawalMode: WithdrawalMode,
2714
- /** The current status of this withdrawal request. **/
2715
- status: WithdrawalRequestStatus,
2744
+ updatedAt: string;
2745
+ /** The code that uniquely identifies this invitation. **/
2746
+ code: string;
2747
+ /** The URL where this invitation can be claimed. **/
2748
+ url: string;
2749
+ /** The UMA of the user who created the invitation. **/
2750
+ inviterUma: string;
2751
+ /** The current status of the incentives that may be tied to this invitation. **/
2752
+ incentivesStatus: IncentivesStatus;
2716
2753
  /** The typename of the object **/
2717
- typename: string,
2718
- /**
2719
- * If the requested amount is `-1` (i.e. everything),
2720
- * this field may contain an estimate of the amount for the withdrawal.
2721
- **/
2722
- estimatedAmount?: CurrencyAmount | undefined,
2723
- /** The time at which this request was completed. **/
2724
- completedAt?: string | undefined,
2725
- /** The withdrawal transaction that has been generated by this request. **/
2726
- withdrawalId?: string | undefined);
2727
- getChannelClosingTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelClosingTransactionsConnection>;
2728
- getChannelOpeningTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelOpeningTransactionsConnection>;
2729
- static getWithdrawalRequestQuery(id: string): Query<WithdrawalRequest>;
2730
- toJson(): {
2731
- __typename: string;
2732
- withdrawal_request_id: string;
2733
- withdrawal_request_created_at: string;
2734
- withdrawal_request_updated_at: string;
2735
- withdrawal_request_amount: any;
2736
- withdrawal_request_estimated_amount: any;
2737
- withdrawal_request_bitcoin_address: string;
2738
- withdrawal_request_withdrawal_mode: WithdrawalMode;
2739
- withdrawal_request_status: WithdrawalRequestStatus;
2740
- withdrawal_request_completed_at: string | undefined;
2741
- withdrawal_request_withdrawal: {
2742
- id: string | undefined;
2743
- };
2744
- };
2754
+ typename: string;
2755
+ /** The UMA of the user who claimed the invitation. **/
2756
+ inviteeUma?: string | undefined;
2757
+ /** The reason why the invitation is not eligible for incentives, if applicable. **/
2758
+ incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
2745
2759
  }
2760
+ declare const getUmaInvitationQuery: (id: string) => Query<UmaInvitation>;
2746
2761
 
2747
2762
  /**
2748
2763
  * The LightsparkClient is the main entrypoint for interacting with the
@@ -3113,6 +3128,27 @@ declare class LightsparkClient {
3113
3128
  * amount invoices.
3114
3129
  */
3115
3130
  createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<IncomingPayment | null>;
3131
+ /**
3132
+ * Performs sanction screening on a lightning node against a given compliance provider.
3133
+ *
3134
+ * @param complianceProvider The provider that you want to use to perform the screening. You must have a valid
3135
+ * API token for the provider set in your Lightspark account settings.
3136
+ * @param nodePubKey The public key of the node that needs to be screened.
3137
+ * @returns A RiskRating for the node.
3138
+ */
3139
+ screenNode(complianceProvider: ComplianceProvider, nodePubKey: string): Promise<RiskRating | null>;
3140
+ /**
3141
+ * Registers a succeeded payment with a compliance provider for monitoring.
3142
+ *
3143
+ * @param complianceProvider The provider that you want to use to register the payment. You must have
3144
+ * a valid API token for the provider set in your Lightspark account settings.
3145
+ * @param paymentId The unique ID of the payment
3146
+ * @param nodePubKey The public key of the counterparty node which is the recipient node if the
3147
+ * payment is an outgoing payment and the sender node if the payment is an incoming payment.
3148
+ * @param paymentDirection Indicates whether the payment is an incoming or outgoing payment.
3149
+ * @returns The ID of the payment that was registered.
3150
+ */
3151
+ registerPayment(complianceProvider: ComplianceProvider, paymentId: string, nodePubKey: string, paymentDirection: PaymentDirection): Promise<string | null>;
3116
3152
  /**
3117
3153
  * Creates an UMA invitation. If you are part of the incentive program,
3118
3154
  * you should use [createUmaInvitationWithIncentives].
@@ -3197,21 +3233,10 @@ interface ClaimUmaInvitationWithIncentivesOutput {
3197
3233
  invitationId: string;
3198
3234
  }
3199
3235
 
3200
- /** This is an enum identifying a type of compliance provider. **/
3201
- declare enum ComplianceProvider {
3202
- /**
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.
3205
- */
3206
- FUTURE_VALUE = "FUTURE_VALUE",
3207
- CHAINALYSIS = "CHAINALYSIS"
3208
- }
3209
-
3210
3236
  interface Connection {
3211
3237
  /**
3212
- * The total count of objects in this connection, using the current filters.
3213
- * It is different from the number of objects returned in the current page (in the `entities`
3214
- * field).
3238
+ * The total count of objects in this connection, using the current filters. It is different
3239
+ * from the number of objects returned in the current page (in the `entities` field).
3215
3240
  **/
3216
3241
  count: number;
3217
3242
  /** An object that holds pagination information about the objects in this connection. **/
@@ -3258,9 +3283,8 @@ interface CreateLnurlInvoiceInput {
3258
3283
  /** The amount for which the invoice should be created, in millisatoshis. **/
3259
3284
  amountMsats: number;
3260
3285
  /**
3261
- * The SHA256 hash of the LNURL metadata payload.
3262
- * This will be present in the h-tag (SHA256 purpose of payment) of the resulting Bolt 11
3263
- * invoice.
3286
+ * The SHA256 hash of the LNURL metadata payload. This will be present in the h-tag (SHA256
3287
+ * purpose of payment) of the resulting Bolt 11 invoice.
3264
3288
  **/
3265
3289
  metadataHash: string;
3266
3290
  /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
@@ -3293,16 +3317,15 @@ interface CreateTestModePaymentInput {
3293
3317
  /** The invoice you want to be paid (as defined by the BOLT11 standard). **/
3294
3318
  encodedInvoice: string;
3295
3319
  /**
3296
- * The amount you will be paid for this invoice, expressed in msats.
3297
- * It should ONLY be set when the invoice amount is zero.
3320
+ * The amount you will be paid for this invoice, expressed in msats. It should ONLY be set when
3321
+ * the invoice amount is zero.
3298
3322
  **/
3299
3323
  amountMsats?: number | undefined;
3300
3324
  }
3301
3325
 
3302
3326
  /**
3303
- * This is an object identifying the output of a test mode payment.
3304
- * This object can be used to retrieve the associated payment made from a Test Mode Payment call.
3305
- * *
3327
+ * This is an object identifying the output of a test mode payment. This object can be used to
3328
+ * retrieve the associated payment made from a Test Mode Payment call. *
3306
3329
  */
3307
3330
  interface CreateTestModePaymentoutput {
3308
3331
  /**
@@ -3349,8 +3372,8 @@ declare enum SignablePayloadStatus {
3349
3372
 
3350
3373
  interface SignablePayload {
3351
3374
  /**
3352
- * The unique identifier of this entity across all Lightspark systems.
3353
- * Should be treated as an opaque string.
3375
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3376
+ * opaque string.
3354
3377
  **/
3355
3378
  id: string;
3356
3379
  /** The date and time when the entity was first created. **/
@@ -3390,15 +3413,14 @@ interface DeleteApiTokenOutput {
3390
3413
  }
3391
3414
 
3392
3415
  /**
3393
- * This object represents a Deposit made to a Lightspark node wallet.
3394
- * This operation occurs for any L1 funding transaction to the wallet.
3395
- * You can retrieve this object to receive detailed information about the deposit.
3396
- * *
3416
+ * This object represents a Deposit made to a Lightspark node wallet. This operation occurs for any
3417
+ * L1 funding transaction to the wallet. You can retrieve this object to receive detailed
3418
+ * information about the deposit. *
3397
3419
  */
3398
3420
  interface Deposit {
3399
3421
  /**
3400
- * The unique identifier of this entity across all Lightspark systems.
3401
- * Should be treated as an opaque string.
3422
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3423
+ * opaque string.
3402
3424
  **/
3403
3425
  id: string;
3404
3426
  /** The date and time when this transaction was initiated. **/
@@ -3449,15 +3471,14 @@ interface FundNodeOutput {
3449
3471
  }
3450
3472
 
3451
3473
  /**
3452
- * This object represents a node that exists on the Lightning Network,
3453
- * including nodes not managed by Lightspark. You can retrieve this object to get publicly
3454
- * available information about any node on the Lightning Network.
3455
- * *
3474
+ * This object represents a node that exists on the Lightning Network, including nodes not managed
3475
+ * by Lightspark. You can retrieve this object to get publicly available information about any node
3476
+ * on the Lightning Network. *
3456
3477
  */
3457
3478
  declare class GraphNode implements Node, Entity {
3458
3479
  /**
3459
- * The unique identifier of this entity across all Lightspark systems.
3460
- * Should be treated as an opaque string.
3480
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3481
+ * opaque string.
3461
3482
  **/
3462
3483
  readonly id: string;
3463
3484
  /** The date and time when the entity was first created. **/
@@ -3474,16 +3495,15 @@ declare class GraphNode implements Node, Entity {
3474
3495
  /** The typename of the object **/
3475
3496
  readonly typename: string;
3476
3497
  /**
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.
3498
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
3499
+ * just a way to identify and search for commercial services or popular nodes. This alias can
3500
+ * be changed at any time by the node operator.
3480
3501
  **/
3481
3502
  readonly alias?: string | undefined;
3482
3503
  /**
3483
3504
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
3484
- * white. It has no importance in terms of operating the node,
3485
- * it is just a way to visually differentiate nodes.
3486
- * That color can be changed at any time by the node operator.
3505
+ * white. It has no importance in terms of operating the node, it is just a way to visually
3506
+ * differentiate nodes. That color can be changed at any time by the node operator.
3487
3507
  **/
3488
3508
  readonly color?: string | undefined;
3489
3509
  /**
@@ -3499,8 +3519,8 @@ declare class GraphNode implements Node, Entity {
3499
3519
  readonly publicKey?: string | undefined;
3500
3520
  constructor(
3501
3521
  /**
3502
- * The unique identifier of this entity across all Lightspark systems.
3503
- * Should be treated as an opaque string.
3522
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3523
+ * opaque string.
3504
3524
  **/
3505
3525
  id: string,
3506
3526
  /** The date and time when the entity was first created. **/
@@ -3517,16 +3537,15 @@ declare class GraphNode implements Node, Entity {
3517
3537
  /** The typename of the object **/
3518
3538
  typename: string,
3519
3539
  /**
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.
3540
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
3541
+ * just a way to identify and search for commercial services or popular nodes. This alias can
3542
+ * be changed at any time by the node operator.
3523
3543
  **/
3524
3544
  alias?: string | undefined,
3525
3545
  /**
3526
3546
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
3527
- * white. It has no importance in terms of operating the node,
3528
- * it is just a way to visually differentiate nodes.
3529
- * That color can be changed at any time by the node operator.
3547
+ * white. It has no importance in terms of operating the node, it is just a way to visually
3548
+ * differentiate nodes. That color can be changed at any time by the node operator.
3530
3549
  **/
3531
3550
  color?: string | undefined,
3532
3551
  /**
@@ -3597,8 +3616,8 @@ interface Secret {
3597
3616
  /** This is a Lightspark node with OSK. **/
3598
3617
  declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3599
3618
  /**
3600
- * The unique identifier of this entity across all Lightspark systems.
3601
- * Should be treated as an opaque string.
3619
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3620
+ * opaque string.
3602
3621
  **/
3603
3622
  readonly id: string;
3604
3623
  /** The date and time when the entity was first created. **/
@@ -3622,16 +3641,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3622
3641
  /** The typename of the object **/
3623
3642
  readonly typename: string;
3624
3643
  /**
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.
3644
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
3645
+ * just a way to identify and search for commercial services or popular nodes. This alias can
3646
+ * be changed at any time by the node operator.
3628
3647
  **/
3629
3648
  readonly alias?: string | undefined;
3630
3649
  /**
3631
3650
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
3632
- * white. It has no importance in terms of operating the node,
3633
- * it is just a way to visually differentiate nodes.
3634
- * That color can be changed at any time by the node operator.
3651
+ * white. It has no importance in terms of operating the node, it is just a way to visually
3652
+ * differentiate nodes. That color can be changed at any time by the node operator.
3635
3653
  **/
3636
3654
  readonly color?: string | undefined;
3637
3655
  /**
@@ -3687,8 +3705,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3687
3705
  readonly encryptedSigningPrivateKey?: Secret | undefined;
3688
3706
  constructor(
3689
3707
  /**
3690
- * The unique identifier of this entity across all Lightspark systems.
3691
- * Should be treated as an opaque string.
3708
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3709
+ * opaque string.
3692
3710
  **/
3693
3711
  id: string,
3694
3712
  /** The date and time when the entity was first created. **/
@@ -3712,16 +3730,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3712
3730
  /** The typename of the object **/
3713
3731
  typename: string,
3714
3732
  /**
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.
3733
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
3734
+ * just a way to identify and search for commercial services or popular nodes. This alias can
3735
+ * be changed at any time by the node operator.
3718
3736
  **/
3719
3737
  alias?: string | undefined,
3720
3738
  /**
3721
3739
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
3722
- * white. It has no importance in terms of operating the node,
3723
- * it is just a way to visually differentiate nodes.
3724
- * That color can be changed at any time by the node operator.
3740
+ * white. It has no importance in terms of operating the node, it is just a way to visually
3741
+ * differentiate nodes. That color can be changed at any time by the node operator.
3725
3742
  **/
3726
3743
  color?: string | undefined,
3727
3744
  /**
@@ -3807,8 +3824,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
3807
3824
  /** This is a Lightspark node with remote signing. **/
3808
3825
  declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
3809
3826
  /**
3810
- * The unique identifier of this entity across all Lightspark systems.
3811
- * Should be treated as an opaque string.
3827
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3828
+ * opaque string.
3812
3829
  **/
3813
3830
  readonly id: string;
3814
3831
  /** The date and time when the entity was first created. **/
@@ -3832,16 +3849,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
3832
3849
  /** The typename of the object **/
3833
3850
  readonly typename: string;
3834
3851
  /**
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.
3852
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
3853
+ * just a way to identify and search for commercial services or popular nodes. This alias can
3854
+ * be changed at any time by the node operator.
3838
3855
  **/
3839
3856
  readonly alias?: string | undefined;
3840
3857
  /**
3841
3858
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
3842
- * white. It has no importance in terms of operating the node,
3843
- * it is just a way to visually differentiate nodes.
3844
- * That color can be changed at any time by the node operator.
3859
+ * white. It has no importance in terms of operating the node, it is just a way to visually
3860
+ * differentiate nodes. That color can be changed at any time by the node operator.
3845
3861
  **/
3846
3862
  readonly color?: string | undefined;
3847
3863
  /**
@@ -3892,8 +3908,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
3892
3908
  readonly balances?: Balances | undefined;
3893
3909
  constructor(
3894
3910
  /**
3895
- * The unique identifier of this entity across all Lightspark systems.
3896
- * Should be treated as an opaque string.
3911
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
3912
+ * opaque string.
3897
3913
  **/
3898
3914
  id: string,
3899
3915
  /** The date and time when the entity was first created. **/
@@ -3917,16 +3933,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
3917
3933
  /** The typename of the object **/
3918
3934
  typename: string,
3919
3935
  /**
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.
3936
+ * A name that identifies the node. It has no importance in terms of operating the node, it is
3937
+ * just a way to identify and search for commercial services or popular nodes. This alias can
3938
+ * be changed at any time by the node operator.
3923
3939
  **/
3924
3940
  alias?: string | undefined,
3925
3941
  /**
3926
3942
  * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is
3927
- * white. It has no importance in terms of operating the node,
3928
- * it is just a way to visually differentiate nodes.
3929
- * That color can be changed at any time by the node operator.
3943
+ * white. It has no importance in terms of operating the node, it is just a way to visually
3944
+ * differentiate nodes. That color can be changed at any time by the node operator.
3930
3945
  **/
3931
3946
  color?: string | undefined,
3932
3947
  /**
@@ -4004,15 +4019,14 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
4004
4019
  }
4005
4020
 
4006
4021
  /**
4007
- * This object represents an L1 transaction that occurred on the Bitcoin Network.
4008
- * You can retrieve this object to receive information about a specific on-chain transaction made
4009
- * on the Lightning Network associated with your Lightspark Node.
4010
- * *
4022
+ * This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve
4023
+ * this object to receive information about a specific on-chain transaction made on the Lightning
4024
+ * Network associated with your Lightspark Node. *
4011
4025
  */
4012
4026
  interface OnChainTransaction {
4013
4027
  /**
4014
- * The unique identifier of this entity across all Lightspark systems.
4015
- * Should be treated as an opaque string.
4028
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
4029
+ * opaque string.
4016
4030
  **/
4017
4031
  id: string;
4018
4032
  /** The date and time when this transaction was initiated. **/
@@ -4094,33 +4108,21 @@ interface PayUmaInvoiceInput {
4094
4108
  amountMsats?: number | undefined;
4095
4109
  }
4096
4110
 
4097
- /** This is an enum indicating the direction of the payment. **/
4098
- declare enum PaymentDirection {
4099
- /**
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.
4102
- */
4103
- FUTURE_VALUE = "FUTURE_VALUE",
4104
- SENT = "SENT",
4105
- RECEIVED = "RECEIVED"
4106
- }
4107
-
4108
4111
  interface RegisterPaymentInput {
4109
4112
  /**
4110
- * The compliance provider that is going to screen the node.
4111
- * You need to be a customer of the selected provider and store the API key on the Lightspark
4112
- * account setting page.
4113
+ * The compliance provider that is going to screen the node. You need to be a customer of the
4114
+ * selected provider and store the API key on the Lightspark account setting page.
4113
4115
  **/
4114
4116
  provider: ComplianceProvider;
4115
4117
  /**
4116
- * The Lightspark ID of the lightning payment you want to register.
4117
- * It can be the id of either an OutgoingPayment or an IncomingPayment.
4118
+ * The Lightspark ID of the lightning payment you want to register. It can be the id of either
4119
+ * an OutgoingPayment or an IncomingPayment.
4118
4120
  **/
4119
4121
  paymentId: string;
4120
4122
  /**
4121
- * The public key of the counterparty lightning node,
4122
- * which would be the public key of the recipient node if it is to register an outgoing
4123
- * payment, or the public key of the sender node if it is to register an incoming payment.
4123
+ * The public key of the counterparty lightning node, which would be the public key of the
4124
+ * recipient node if it is to register an outgoing payment, or the public key of the sender
4125
+ * node if it is to register an incoming payment.
4124
4126
  **/
4125
4127
  nodePubkey: string;
4126
4128
  /** Indicates whether this payment is an OutgoingPayment or an IncomingPayment. **/
@@ -4180,8 +4182,8 @@ interface RequestWithdrawalInput {
4180
4182
  /** The bitcoin address where the withdrawal should be sent. **/
4181
4183
  bitcoinAddress: string;
4182
4184
  /**
4183
- * The amount you want to withdraw from this node in Satoshis.
4184
- * Use the special value -1 to withdrawal all funds from this node.
4185
+ * The amount you want to withdraw from this node in Satoshis. Use the special value -1 to
4186
+ * withdrawal all funds from this node.
4185
4187
  **/
4186
4188
  amountSats: number;
4187
4189
  /** The strategy that should be used to withdraw the funds from this node. **/
@@ -4195,8 +4197,7 @@ interface RequestWithdrawalOutput {
4195
4197
 
4196
4198
  /**
4197
4199
  * This is an enum of the potential risk ratings related to a transaction made over the Lightning
4198
- * Network. These risk ratings are returned from the CryptoSanctionScreeningProvider.
4199
- * *
4200
+ * Network. These risk ratings are returned from the CryptoSanctionScreeningProvider. *
4200
4201
  */
4201
4202
  declare enum RiskRating {
4202
4203
  /**
@@ -4211,14 +4212,13 @@ declare enum RiskRating {
4211
4212
 
4212
4213
  /**
4213
4214
  * 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. *
4215
+ * Lightning Network, i.e., a routed transaction. You can retrieve this object to receive
4216
+ * information about any transaction routed through your Lightspark Node. *
4217
4217
  */
4218
4218
  interface RoutingTransaction {
4219
4219
  /**
4220
- * The unique identifier of this entity across all Lightspark systems.
4221
- * Should be treated as an opaque string.
4220
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
4221
+ * opaque string.
4222
4222
  **/
4223
4223
  id: string;
4224
4224
  /** The date and time when this transaction was initiated. **/
@@ -4240,9 +4240,8 @@ interface RoutingTransaction {
4240
4240
  /** If known, the channel this transaction was forwarded to. **/
4241
4241
  outgoingChannelId?: string | undefined;
4242
4242
  /**
4243
- * The fees collected by the node when routing this transaction.
4244
- * We subtract the outgoing amount to the incoming amount to determine how much fees were
4245
- * collected.
4243
+ * The fees collected by the node when routing this transaction. We subtract the outgoing
4244
+ * amount to the incoming amount to determine how much fees were collected.
4246
4245
  **/
4247
4246
  fees?: CurrencyAmount | undefined;
4248
4247
  /** If applicable, user-facing error message describing why the routing failed. **/
@@ -4254,9 +4253,8 @@ declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransacti
4254
4253
 
4255
4254
  interface ScreenNodeInput {
4256
4255
  /**
4257
- * The compliance provider that is going to screen the node.
4258
- * You need to be a customer of the selected provider and store the API key on the Lightspark
4259
- * account setting page.
4256
+ * The compliance provider that is going to screen the node. You need to be a customer of the
4257
+ * selected provider and store the API key on the Lightspark account setting page.
4260
4258
  **/
4261
4259
  provider: ComplianceProvider;
4262
4260
  /** The public key of the lightning node that needs to be screened. **/
@@ -4294,9 +4292,8 @@ interface SetInvoicePaymentHashInput {
4294
4292
  /** The 32-byte hash of the payment preimage. **/
4295
4293
  paymentHash: string;
4296
4294
  /**
4297
- * The 32-byte nonce used to generate the invoice preimage if applicable.
4298
- * It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw
4299
- * preimage.
4295
+ * The 32-byte nonce used to generate the invoice preimage if applicable. It will later be
4296
+ * included in RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw preimage.
4300
4297
  **/
4301
4298
  preimageNonce?: string | undefined;
4302
4299
  }
@@ -4331,8 +4328,8 @@ interface SignMessagesOutput {
4331
4328
 
4332
4329
  interface Signable {
4333
4330
  /**
4334
- * The unique identifier of this entity across all Lightspark systems.
4335
- * Should be treated as an opaque string.
4331
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
4332
+ * opaque string.
4336
4333
  **/
4337
4334
  id: string;
4338
4335
  /** The date and time when the entity was first created. **/
@@ -4389,14 +4386,14 @@ declare enum WebhookEventType {
4389
4386
  }
4390
4387
 
4391
4388
  /**
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. *
4389
+ * This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can
4390
+ * retrieve this object to receive detailed information about any L1 withdrawal associated with
4391
+ * your Lightspark Node or account. *
4395
4392
  */
4396
4393
  interface Withdrawal {
4397
4394
  /**
4398
- * The unique identifier of this entity across all Lightspark systems.
4399
- * Should be treated as an opaque string.
4395
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an
4396
+ * opaque string.
4400
4397
  **/
4401
4398
  id: string;
4402
4399
  /** The date and time when this transaction was initiated. **/
@@ -4437,4 +4434,4 @@ interface Withdrawal {
4437
4434
  }
4438
4435
  declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
4439
4436
 
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 };
4437
+ export { Deposit as $, Account as A, Balances as B, CancelInvoiceInput as C, CreateApiTokenInput as D, CreateApiTokenOutput as E, CreateInvitationWithIncentivesInput as F, CreateInvitationWithIncentivesOutput as G, CreateInvoiceInput as H, CreateInvoiceOutput as I, CreateLnurlInvoiceInput as J, CreateNodeWalletAddressInput as K, LightsparkClient as L, CreateNodeWalletAddressOutput as M, CreateTestModeInvoiceInput as N, CreateTestModeInvoiceOutput as O, CreateTestModePaymentInput as P, CreateTestModePaymentoutput as Q, CreateUmaInvitationInput as R, CreateUmaInvitationOutput as S, CreateUmaInvoiceInput as T, CurrencyAmount as U, CurrencyUnit as V, WebhookEventType as W, DeclineToSignMessagesInput as X, DeclineToSignMessagesOutput as Y, DeleteApiTokenInput as Z, DeleteApiTokenOutput as _, AccountToApiTokensConnection as a, ReleaseChannelPerCommitmentSecretInput as a$, getDepositQuery as a0, Entity as a1, FeeEstimate as a2, FundNodeInput as a3, FundNodeOutput as a4, GraphNode as a5, Hop as a6, getHopQuery as a7, HtlcAttemptFailureCode as a8, IdAndSignature as a9, NodeAddress as aA, NodeAddressType as aB, NodeToAddressesConnection as aC, OnChainTransaction as aD, getOnChainTransactionQuery as aE, OutgoingPayment as aF, OutgoingPaymentAttempt as aG, OutgoingPaymentAttemptStatus as aH, OutgoingPaymentAttemptToHopsConnection as aI, OutgoingPaymentToAttemptsConnection as aJ, OutgoingPaymentsForInvoiceQueryInput as aK, OutgoingPaymentsForInvoiceQueryOutput as aL, PageInfo as aM, PayInvoiceInput as aN, PayInvoiceOutput as aO, PayUmaInvoiceInput as aP, PaymentDirection as aQ, PaymentFailureReason as aR, PaymentRequest as aS, getPaymentRequestQuery as aT, PaymentRequestData as aU, PaymentRequestStatus as aV, Permission as aW, PostTransactionData as aX, RegionCode as aY, RegisterPaymentInput as aZ, RegisterPaymentOutput as a_, IncentivesIneligibilityReason as aa, IncentivesStatus as ab, IncomingPayment as ac, IncomingPaymentAttempt as ad, getIncomingPaymentAttemptQuery as ae, IncomingPaymentAttemptStatus as af, IncomingPaymentToAttemptsConnection as ag, Invoice as ah, getInvoiceQuery as ai, InvoiceData as aj, InvoiceType as ak, LightningFeeEstimateForInvoiceInput as al, LightningFeeEstimateForNodeInput as am, LightningFeeEstimateOutput as an, LightningTransaction as ao, getLightningTransactionQuery as ap, LightsparkNode as aq, getLightsparkNodeQuery as ar, LightsparkNodeOwner as as, getLightsparkNodeOwnerQuery as at, LightsparkNodeStatus as au, LightsparkNodeToChannelsConnection as av, LightsparkNodeWithOSK as aw, LightsparkNodeWithRemoteSigning as ax, Node as ay, getNodeQuery as az, AccountToChannelsConnection as b, ReleaseChannelPerCommitmentSecretOutput as b0, ReleasePaymentPreimageInput as b1, ReleasePaymentPreimageOutput as b2, RemoteSigningSubEventType as b3, RequestWithdrawalInput as b4, RequestWithdrawalOutput as b5, RichText as b6, RiskRating as b7, RoutingTransaction as b8, getRoutingTransactionQuery as b9, UpdateChannelPerCommitmentPointInput as bA, UpdateChannelPerCommitmentPointOutput as bB, UpdateNodeSharedSecretInput as bC, UpdateNodeSharedSecretOutput as bD, Wallet as bE, WalletStatus as bF, WalletToPaymentRequestsConnection as bG, WalletToTransactionsConnection as bH, WalletToWithdrawalRequestsConnection as bI, Withdrawal as bJ, getWithdrawalQuery as bK, WithdrawalMode as bL, WithdrawalRequest as bM, WithdrawalRequestStatus as bN, WithdrawalRequestToChannelClosingTransactionsConnection as bO, WithdrawalRequestToChannelOpeningTransactionsConnection as bP, RoutingTransactionFailureReason as ba, ScreenNodeInput as bb, ScreenNodeOutput as bc, Secret as bd, SendPaymentInput as be, SendPaymentOutput as bf, SetInvoicePaymentHashInput as bg, SetInvoicePaymentHashOutput as bh, SignInvoiceInput as bi, SignInvoiceOutput as bj, SignMessagesInput as bk, SignMessagesOutput as bl, Signable as bm, getSignableQuery as bn, SignablePayload as bo, getSignablePayloadQuery as bp, SignablePayloadStatus as bq, SingleNodeDashboard as br, Transaction as bs, getTransactionQuery as bt, TransactionFailures as bu, TransactionStatus as bv, TransactionType as bw, TransactionUpdate as bx, UmaInvitation as by, getUmaInvitationQuery as bz, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, AccountToWithdrawalRequestsConnection as g, ApiToken as h, getApiTokenQuery as i, BlockchainBalance as j, CancelInvoiceOutput as k, Channel as l, ChannelClosingTransaction as m, getChannelClosingTransactionQuery as n, ChannelFees as o, ChannelOpeningTransaction as p, getChannelOpeningTransactionQuery as q, ChannelSnapshot as r, ChannelStatus as s, ChannelToTransactionsConnection as t, ClaimUmaInvitationInput as u, ClaimUmaInvitationOutput as v, ClaimUmaInvitationWithIncentivesInput as w, ClaimUmaInvitationWithIncentivesOutput as x, ComplianceProvider as y, Connection as z };