@lightsparkdev/lightspark-sdk 1.1.7 → 1.2.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 (121) hide show
  1. package/CHANGELOG.md +8 -0
  2. package/dist/{chunk-7UT6YX37.js → chunk-VTPDR6P4.js} +393 -275
  3. package/dist/{index-d31f4469.d.ts → index-f040db9f.d.ts} +678 -386
  4. package/dist/index.cjs +396 -278
  5. package/dist/index.d.ts +2 -2
  6. package/dist/index.js +7 -7
  7. package/dist/objects/index.cjs +395 -277
  8. package/dist/objects/index.d.ts +1 -1
  9. package/dist/objects/index.js +5 -5
  10. package/package.json +2 -2
  11. package/src/objects/Account.ts +13 -2
  12. package/src/objects/AccountToApiTokensConnection.ts +16 -5
  13. package/src/objects/AccountToChannelsConnection.ts +9 -0
  14. package/src/objects/AccountToNodesConnection.ts +19 -5
  15. package/src/objects/AccountToPaymentRequestsConnection.ts +21 -5
  16. package/src/objects/AccountToTransactionsConnection.ts +33 -9
  17. package/src/objects/AccountToWalletsConnection.ts +13 -4
  18. package/src/objects/ApiToken.ts +13 -3
  19. package/src/objects/Balances.ts +17 -3
  20. package/src/objects/BlockchainBalance.ts +34 -9
  21. package/src/objects/Channel.ts +61 -16
  22. package/src/objects/ChannelClosingTransaction.ts +81 -61
  23. package/src/objects/ChannelFees.ts +16 -5
  24. package/src/objects/ChannelOpeningTransaction.ts +81 -61
  25. package/src/objects/ChannelSnapshot.ts +32 -8
  26. package/src/objects/ChannelToTransactionsConnection.ts +26 -6
  27. package/src/objects/Connection.ts +205 -10
  28. package/src/objects/CreateApiTokenInput.ts +8 -2
  29. package/src/objects/CreateApiTokenOutput.ts +9 -3
  30. package/src/objects/CreateInvoiceInput.ts +14 -5
  31. package/src/objects/CreateInvoiceOutput.ts +7 -2
  32. package/src/objects/CreateLnurlInvoiceInput.ts +13 -3
  33. package/src/objects/CreateNodeWalletAddressInput.ts +9 -2
  34. package/src/objects/CreateNodeWalletAddressOutput.ts +10 -2
  35. package/src/objects/CreateTestModeInvoiceInput.ts +14 -4
  36. package/src/objects/CreateTestModeInvoiceOutput.ts +10 -2
  37. package/src/objects/CreateTestModePaymentInput.ts +12 -3
  38. package/src/objects/CreateTestModePaymentoutput.ts +12 -2
  39. package/src/objects/CreateUmaInvoiceInput.ts +13 -3
  40. package/src/objects/CurrencyAmount.ts +13 -2
  41. package/src/objects/DeclineToSignMessagesInput.ts +9 -2
  42. package/src/objects/DeclineToSignMessagesOutput.ts +15 -3
  43. package/src/objects/DeleteApiTokenInput.ts +7 -2
  44. package/src/objects/DeleteApiTokenOutput.ts +7 -2
  45. package/src/objects/Deposit.ts +77 -61
  46. package/src/objects/Entity.ts +2 -2
  47. package/src/objects/FeeEstimate.ts +12 -3
  48. package/src/objects/FundNodeInput.ts +9 -3
  49. package/src/objects/FundNodeOutput.ts +11 -3
  50. package/src/objects/GraphNode.ts +21 -5
  51. package/src/objects/Hop.ts +27 -9
  52. package/src/objects/IdAndSignature.ts +8 -2
  53. package/src/objects/IncomingPayment.ts +33 -7
  54. package/src/objects/IncomingPaymentAttempt.ts +21 -5
  55. package/src/objects/IncomingPaymentToAttemptsConnection.ts +21 -5
  56. package/src/objects/Invoice.ts +37 -24
  57. package/src/objects/InvoiceData.ts +21 -6
  58. package/src/objects/LightningFeeEstimateForInvoiceInput.ts +13 -3
  59. package/src/objects/LightningFeeEstimateForNodeInput.ts +12 -2
  60. package/src/objects/LightningFeeEstimateOutput.ts +15 -3
  61. package/src/objects/LightningTransaction.ts +117 -28
  62. package/src/objects/LightsparkNode.ts +250 -210
  63. package/src/objects/LightsparkNodeOwner.ts +35 -4
  64. package/src/objects/LightsparkNodeToChannelsConnection.ts +17 -4
  65. package/src/objects/LightsparkNodeWithOSK.ts +66 -17
  66. package/src/objects/LightsparkNodeWithRemoteSigning.ts +62 -15
  67. package/src/objects/Node.ts +209 -68
  68. package/src/objects/NodeAddress.ts +8 -2
  69. package/src/objects/NodeToAddressesConnection.ts +13 -3
  70. package/src/objects/OnChainTransaction.ts +156 -44
  71. package/src/objects/OutgoingPayment.ts +53 -14
  72. package/src/objects/OutgoingPaymentAttempt.ts +37 -8
  73. package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts +18 -5
  74. package/src/objects/OutgoingPaymentToAttemptsConnection.ts +17 -4
  75. package/src/objects/OutgoingPaymentsForInvoiceQueryInput.ts +12 -3
  76. package/src/objects/OutgoingPaymentsForInvoiceQueryOutput.ts +11 -2
  77. package/src/objects/PageInfo.ts +14 -6
  78. package/src/objects/PayInvoiceInput.ts +12 -3
  79. package/src/objects/PayInvoiceOutput.ts +7 -2
  80. package/src/objects/PayUmaInvoiceInput.ts +12 -3
  81. package/src/objects/PaymentRequest.ts +27 -5
  82. package/src/objects/PaymentRequestData.ts +27 -4
  83. package/src/objects/PostTransactionData.ts +12 -3
  84. package/src/objects/RegisterPaymentInput.ts +10 -2
  85. package/src/objects/RegisterPaymentOutput.ts +9 -2
  86. package/src/objects/ReleaseChannelPerCommitmentSecretInput.ts +13 -2
  87. package/src/objects/ReleaseChannelPerCommitmentSecretOutput.ts +9 -2
  88. package/src/objects/ReleasePaymentPreimageInput.ts +10 -2
  89. package/src/objects/ReleasePaymentPreimageOutput.ts +9 -2
  90. package/src/objects/RequestWithdrawalInput.ts +12 -2
  91. package/src/objects/RequestWithdrawalOutput.ts +9 -2
  92. package/src/objects/RichText.ts +7 -2
  93. package/src/objects/RoutingTransaction.ts +62 -41
  94. package/src/objects/ScreenNodeInput.ts +8 -2
  95. package/src/objects/ScreenNodeOutput.ts +7 -2
  96. package/src/objects/Secret.ts +8 -2
  97. package/src/objects/SendPaymentInput.ts +11 -2
  98. package/src/objects/SendPaymentOutput.ts +7 -2
  99. package/src/objects/SetInvoicePaymentHashInput.ts +12 -3
  100. package/src/objects/SetInvoicePaymentHashOutput.ts +9 -2
  101. package/src/objects/SignInvoiceInput.ts +9 -2
  102. package/src/objects/SignInvoiceOutput.ts +7 -2
  103. package/src/objects/SignMessagesInput.ts +13 -3
  104. package/src/objects/SignMessagesOutput.ts +13 -3
  105. package/src/objects/Signable.ts +10 -3
  106. package/src/objects/SignablePayload.ts +18 -5
  107. package/src/objects/Transaction.ts +206 -9
  108. package/src/objects/TransactionFailures.ts +11 -4
  109. package/src/objects/UpdateChannelPerCommitmentPointInput.ts +13 -2
  110. package/src/objects/UpdateChannelPerCommitmentPointOutput.ts +9 -2
  111. package/src/objects/UpdateNodeSharedSecretInput.ts +10 -2
  112. package/src/objects/UpdateNodeSharedSecretOutput.ts +9 -2
  113. package/src/objects/Wallet.ts +22 -5
  114. package/src/objects/WalletToPaymentRequestsConnection.ts +21 -5
  115. package/src/objects/WalletToTransactionsConnection.ts +16 -5
  116. package/src/objects/Withdrawal.ts +77 -61
  117. package/src/objects/WithdrawalRequest.ts +25 -4
  118. package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +19 -4
  119. package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +19 -4
  120. package/src/objects/index.ts +5 -2
  121. package/src/tests/serialization.test.ts +18 -0
@@ -26,7 +26,7 @@ declare enum CurrencyUnit {
26
26
  }
27
27
 
28
28
  /** This object represents the value and unit for an amount of currency. **/
29
- type CurrencyAmount = {
29
+ interface CurrencyAmount {
30
30
  /** The original numeric value for this CurrencyAmount. **/
31
31
  originalValue: number;
32
32
  /** The original unit of currency for this CurrencyAmount. **/
@@ -43,7 +43,7 @@ type CurrencyAmount = {
43
43
  * currency. For example, for USD, the value will be in cents.
44
44
  **/
45
45
  preferredCurrencyValueApprox: number;
46
- };
46
+ }
47
47
 
48
48
  declare enum LightsparkNodeStatus {
49
49
  /**
@@ -108,21 +108,6 @@ type AccountDashboard = {
108
108
  remoteBalance: Maybe<CurrencyAmount>;
109
109
  };
110
110
 
111
- /** This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID. **/
112
- type Entity = {
113
- /**
114
- * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
115
- * string.
116
- **/
117
- id: string;
118
- /** The date and time when the entity was first created. **/
119
- createdAt: string;
120
- /** The date and time when the entity was last updated. **/
121
- updatedAt: string;
122
- /** The typename of the object **/
123
- typename: string;
124
- };
125
-
126
111
  /** This is an enum of the potential permissions that a Lightspark user can have in regards to account management. **/
127
112
  declare enum Permission {
128
113
  /**
@@ -147,7 +132,7 @@ declare enum Permission {
147
132
  }
148
133
 
149
134
  /** This is an object representing a Lightspark API token, that can be used to authenticate this account when making API calls or using our SDKs. See the “Authentication” section of our API docs for more details on its usage. **/
150
- type ApiToken = Entity & {
135
+ interface ApiToken {
151
136
  /**
152
137
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
153
138
  * string.
@@ -171,30 +156,18 @@ type ApiToken = Entity & {
171
156
  permissions: Permission[];
172
157
  /** The typename of the object **/
173
158
  typename: string;
174
- };
159
+ }
175
160
  declare const getApiTokenQuery: (id: string) => Query<ApiToken>;
176
161
 
177
162
  /** This is an object representing information about a page returned by the Lightspark API. For more information, please see the “Pagination” section of our API docs for more information about its usage. **/
178
- type PageInfo = {
179
- hasNextPage?: boolean;
180
- hasPreviousPage?: boolean;
181
- startCursor?: string;
182
- endCursor?: string;
183
- };
184
-
185
- type Connection = {
186
- /**
187
- * The total count of objects in this connection, using the current filters. It is different from the
188
- * number of objects returned in the current page (in the `entities` field).
189
- **/
190
- count: number;
191
- /** An object that holds pagination information about the objects in this connection. **/
192
- pageInfo: PageInfo;
193
- /** The typename of the object **/
194
- typename: string;
195
- };
163
+ interface PageInfo {
164
+ hasNextPage?: boolean | undefined;
165
+ hasPreviousPage?: boolean | undefined;
166
+ startCursor?: string | undefined;
167
+ endCursor?: string | undefined;
168
+ }
196
169
 
197
- type AccountToApiTokensConnection = Connection & {
170
+ interface AccountToApiTokensConnection {
198
171
  /**
199
172
  * The total count of objects in this connection, using the current filters. It is different from the
200
173
  * number of objects returned in the current page (in the `entities` field).
@@ -206,13 +179,7 @@ type AccountToApiTokensConnection = Connection & {
206
179
  entities: ApiToken[];
207
180
  /** The typename of the object **/
208
181
  typename: string;
209
- };
210
-
211
- /** This represents the fee policies set for a channel on the Lightning Network. **/
212
- type ChannelFees = {
213
- baseFee?: CurrencyAmount;
214
- feeRatePerMil?: number;
215
- };
182
+ }
216
183
 
217
184
  /** This is an enum representing the status of a channel on the Lightning Network. **/
218
185
  declare enum ChannelStatus {
@@ -237,7 +204,13 @@ declare enum ChannelStatus {
237
204
  ERROR = "ERROR"
238
205
  }
239
206
 
240
- type ChannelToTransactionsConnection = {
207
+ /** This represents the fee policies set for a channel on the Lightning Network. **/
208
+ interface ChannelFees {
209
+ baseFee?: CurrencyAmount | undefined;
210
+ feeRatePerMil?: number | undefined;
211
+ }
212
+
213
+ interface ChannelToTransactionsConnection {
241
214
  /**
242
215
  * The total count of objects in this connection, using the current filters. It is different from the
243
216
  * number of objects returned in the current page (in the `entities` field).
@@ -247,18 +220,33 @@ type ChannelToTransactionsConnection = {
247
220
  * The average fee for the transactions that transited through this channel, according to the filters
248
221
  * and constraints of the connection.
249
222
  **/
250
- averageFee?: CurrencyAmount;
223
+ averageFee?: CurrencyAmount | undefined;
251
224
  /**
252
225
  * The total amount transacted for the transactions that transited through this channel, according to
253
226
  * the filters and constraints of the connection.
254
227
  **/
255
- totalAmountTransacted?: CurrencyAmount;
228
+ totalAmountTransacted?: CurrencyAmount | undefined;
256
229
  /**
257
230
  * The total amount of fees for the transactions that transited through this channel, according to the
258
231
  * filters and constraints of the connection.
259
232
  **/
260
- totalFees?: CurrencyAmount;
261
- };
233
+ totalFees?: CurrencyAmount | undefined;
234
+ }
235
+
236
+ /** This interface is used by all the entities in the Lightspark system. It defines a few core fields that are available everywhere. Any object that implements this interface can be queried using the `entity` query and its ID. **/
237
+ interface Entity {
238
+ /**
239
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
240
+ * string.
241
+ **/
242
+ id: string;
243
+ /** The date and time when the entity was first created. **/
244
+ createdAt: string;
245
+ /** The date and time when the entity was last updated. **/
246
+ updatedAt: string;
247
+ /** The typename of the object **/
248
+ typename: string;
249
+ }
262
250
 
263
251
  /** This is an enum of the potential types of transactions that can be associated with your Lightspark Node. **/
264
252
  declare enum TransactionType {
@@ -314,16 +302,73 @@ declare class Channel implements Entity {
314
302
  getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
315
303
  getTransactions(client: LightsparkClient, types?: TransactionType[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<ChannelToTransactionsConnection>;
316
304
  static getChannelQuery(id: string): Query<Channel>;
305
+ toJson(): {
306
+ __typename: string;
307
+ channel_id: string;
308
+ channel_created_at: string;
309
+ channel_updated_at: string;
310
+ channel_funding_transaction: {
311
+ id: string | undefined;
312
+ };
313
+ channel_capacity: any;
314
+ channel_local_balance: any;
315
+ channel_local_unsettled_balance: any;
316
+ channel_remote_balance: any;
317
+ channel_remote_unsettled_balance: any;
318
+ channel_unsettled_balance: any;
319
+ channel_total_balance: any;
320
+ channel_status: ChannelStatus | undefined;
321
+ channel_estimated_force_closure_wait_minutes: number | undefined;
322
+ channel_commit_fee: any;
323
+ channel_fees: any;
324
+ channel_remote_node: {
325
+ id: string | undefined;
326
+ };
327
+ channel_local_node: {
328
+ id: string;
329
+ };
330
+ channel_short_channel_id: string | undefined;
331
+ };
317
332
  }
318
333
 
319
334
  declare class AccountToChannelsConnection {
320
335
  readonly count: number;
321
336
  readonly entities: Channel[];
322
337
  constructor(count: number, entities: Channel[]);
338
+ toJson(): {
339
+ account_to_channels_connection_count: number;
340
+ account_to_channels_connection_entities: {
341
+ __typename: string;
342
+ channel_id: string;
343
+ channel_created_at: string;
344
+ channel_updated_at: string;
345
+ channel_funding_transaction: {
346
+ id: string | undefined;
347
+ };
348
+ channel_capacity: any;
349
+ channel_local_balance: any;
350
+ channel_local_unsettled_balance: any;
351
+ channel_remote_balance: any;
352
+ channel_remote_unsettled_balance: any;
353
+ channel_unsettled_balance: any;
354
+ channel_total_balance: any;
355
+ channel_status: ChannelStatus | undefined;
356
+ channel_estimated_force_closure_wait_minutes: number | undefined;
357
+ channel_commit_fee: any;
358
+ channel_fees: any;
359
+ channel_remote_node: {
360
+ id: string | undefined;
361
+ };
362
+ channel_local_node: {
363
+ id: string;
364
+ };
365
+ channel_short_channel_id: string | undefined;
366
+ }[];
367
+ };
323
368
  }
324
369
 
325
370
  /** This is an object representing the balance associated with your Lightspark account. You can retrieve this object to see your balance, which can be broken down into several different categorizations. **/
326
- type Balances = {
371
+ interface Balances {
327
372
  /**
328
373
  * This represents the balance that should be displayed when asked "how much do I own right now?". It
329
374
  * represents the amount currently owned, including things that may not be owned soon (e.g. in-flight
@@ -344,25 +389,25 @@ type Balances = {
344
389
  * likely succeed and therefore likely make your withdrawal fail).
345
390
  **/
346
391
  availableToWithdrawBalance: CurrencyAmount;
347
- };
392
+ }
348
393
 
349
394
  /** This is an object representing a detailed breakdown of the balance for a Lightspark Node. **/
350
- type BlockchainBalance = {
395
+ interface BlockchainBalance {
351
396
  /** The total wallet balance, including unconfirmed UTXOs. **/
352
- totalBalance?: CurrencyAmount;
397
+ totalBalance?: CurrencyAmount | undefined;
353
398
  /** The balance of confirmed UTXOs in the wallet. **/
354
- confirmedBalance?: CurrencyAmount;
399
+ confirmedBalance?: CurrencyAmount | undefined;
355
400
  /** The balance of unconfirmed UTXOs in the wallet. **/
356
- unconfirmedBalance?: CurrencyAmount;
401
+ unconfirmedBalance?: CurrencyAmount | undefined;
357
402
  /** The balance that's locked by an on-chain transaction. **/
358
- lockedBalance?: CurrencyAmount;
403
+ lockedBalance?: CurrencyAmount | undefined;
359
404
  /** Funds required to be held in reserve for channel bumping. **/
360
- requiredReserve?: CurrencyAmount;
405
+ requiredReserve?: CurrencyAmount | undefined;
361
406
  /** Funds available for creating channels or withdrawing. **/
362
- availableBalance?: CurrencyAmount;
363
- };
407
+ availableBalance?: CurrencyAmount | undefined;
408
+ }
364
409
 
365
- type LightsparkNodeToChannelsConnection = Connection & {
410
+ interface LightsparkNodeToChannelsConnection {
366
411
  /**
367
412
  * The total count of objects in this connection, using the current filters. It is different from the
368
413
  * number of objects returned in the current page (in the `entities` field).
@@ -374,18 +419,18 @@ type LightsparkNodeToChannelsConnection = Connection & {
374
419
  entities: Channel[];
375
420
  /** The typename of the object **/
376
421
  typename: string;
377
- };
422
+ }
378
423
 
379
424
  /** This object represents the address of a node on the Lightning Network. **/
380
- type NodeAddress = {
425
+ interface NodeAddress {
381
426
  /** The string representation of the address. **/
382
427
  address: string;
383
428
  /** The type, or protocol, of this address. **/
384
429
  type: NodeAddressType;
385
- };
430
+ }
386
431
 
387
432
  /** A connection between a node and the addresses it has announced for itself on Lightning Network. **/
388
- type NodeToAddressesConnection = {
433
+ interface NodeToAddressesConnection {
389
434
  /**
390
435
  * The total count of objects in this connection, using the current filters. It is different from the
391
436
  * number of objects returned in the current page (in the `entities` field).
@@ -393,54 +438,96 @@ type NodeToAddressesConnection = {
393
438
  count: number;
394
439
  /** The addresses for the current page of this connection. **/
395
440
  entities: NodeAddress[];
396
- };
397
-
398
- /** This object is an interface representing a Lightning Node on the Lightning Network, and could either be a Lightspark node or a node managed by a third party. **/
399
- declare class Node implements Entity {
400
- readonly id: string;
401
- readonly createdAt: string;
402
- readonly updatedAt: string;
403
- readonly bitcoinNetwork: BitcoinNetwork;
404
- readonly displayName: string;
405
- readonly typename: string;
406
- readonly alias?: string | undefined;
407
- readonly color?: string | undefined;
408
- readonly conductivity?: number | undefined;
409
- readonly publicKey?: string | undefined;
410
- constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined);
411
- getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
412
- static getNodeQuery(id: string): Query<Node>;
413
441
  }
414
442
 
415
443
  /** This is an object representing a node managed by Lightspark and owned by the current connected account. This object contains information about the node’s configuration, state, and metadata. **/
416
- declare class LightsparkNode implements Node {
417
- readonly id: string;
418
- readonly createdAt: string;
419
- readonly updatedAt: string;
420
- readonly bitcoinNetwork: BitcoinNetwork;
421
- readonly displayName: string;
422
- readonly ownerId: string;
423
- readonly umaPrescreeningUtxos: string[];
424
- readonly typename: string;
425
- readonly alias?: string | undefined;
426
- readonly color?: string | undefined;
427
- readonly conductivity?: number | undefined;
428
- readonly publicKey?: string | undefined;
429
- readonly status?: LightsparkNodeStatus | undefined;
430
- readonly totalBalance?: CurrencyAmount | undefined;
431
- readonly totalLocalBalance?: CurrencyAmount | undefined;
432
- readonly localBalance?: CurrencyAmount | undefined;
433
- readonly remoteBalance?: CurrencyAmount | undefined;
434
- readonly blockchainBalance?: BlockchainBalance | undefined;
435
- readonly balances?: Balances | undefined;
436
- constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, ownerId: string, umaPrescreeningUtxos: string[], typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined, status?: LightsparkNodeStatus | undefined, totalBalance?: CurrencyAmount | undefined, totalLocalBalance?: CurrencyAmount | undefined, localBalance?: CurrencyAmount | undefined, remoteBalance?: CurrencyAmount | undefined, blockchainBalance?: BlockchainBalance | undefined, balances?: Balances | undefined);
444
+ interface LightsparkNode {
445
+ /**
446
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
447
+ * string.
448
+ **/
449
+ id: string;
450
+ /** The date and time when the entity was first created. **/
451
+ createdAt: string;
452
+ /** The date and time when the entity was last updated. **/
453
+ updatedAt: string;
454
+ /** The Bitcoin Network this node is deployed in. **/
455
+ bitcoinNetwork: BitcoinNetwork;
456
+ /**
457
+ * The name of this node in the network. It will be the most human-readable option possible, depending
458
+ * on the data available for this node.
459
+ **/
460
+ displayName: string;
461
+ /** The owner of this LightsparkNode. **/
462
+ ownerId: string;
463
+ /**
464
+ * The utxos of the channels that are connected to this node. This is used in uma flow for
465
+ * pre-screening.
466
+ **/
467
+ umaPrescreeningUtxos: string[];
468
+ /** The typename of the object **/
469
+ typename: string;
470
+ /**
471
+ * A name that identifies the node. It has no importance in terms of operating the node, it is just a
472
+ * way to identify and search for commercial services or popular nodes. This alias can be changed at
473
+ * any time by the node operator.
474
+ **/
475
+ alias?: string | undefined;
476
+ /**
477
+ * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
478
+ * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
479
+ * That color can be changed at any time by the node operator.
480
+ **/
481
+ color?: string | undefined;
482
+ /**
483
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
484
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
485
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
486
+ **/
487
+ conductivity?: number | undefined;
488
+ /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
489
+ publicKey?: string | undefined;
490
+ /** The current status of this node. **/
491
+ status?: LightsparkNodeStatus | undefined;
492
+ /**
493
+ * The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
494
+ *
495
+ * @deprecated Use `balances` instead.
496
+ **/
497
+ totalBalance?: CurrencyAmount | undefined;
498
+ /**
499
+ * The total sum of the channel balances (online and offline) on this node.
500
+ *
501
+ * @deprecated Use `balances` instead.
502
+ **/
503
+ totalLocalBalance?: CurrencyAmount | undefined;
504
+ /**
505
+ * The sum of the channel balances (online only) that are available to send on this node.
506
+ *
507
+ * @deprecated Use `balances` instead.
508
+ **/
509
+ localBalance?: CurrencyAmount | undefined;
510
+ /**
511
+ * The sum of the channel balances that are available to receive on this node.
512
+ *
513
+ * @deprecated Use `balances` instead.
514
+ **/
515
+ remoteBalance?: CurrencyAmount | undefined;
516
+ /**
517
+ * The details of the balance of this node on the Bitcoin Network.
518
+ *
519
+ * @deprecated Use `balances` instead.
520
+ **/
521
+ blockchainBalance?: BlockchainBalance | undefined;
522
+ /** The balances that describe the funds in this node. **/
523
+ balances?: Balances | undefined;
437
524
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
438
525
  getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
439
- static getLightsparkNodeQuery(id: string): Query<LightsparkNode>;
440
526
  }
527
+ declare const getLightsparkNodeQuery: (id: string) => Query<LightsparkNode>;
441
528
 
442
529
  /** A connection between an account and the nodes it manages. **/
443
- type AccountToNodesConnection = Connection & {
530
+ interface AccountToNodesConnection {
444
531
  /**
445
532
  * The total count of objects in this connection, using the current filters. It is different from the
446
533
  * number of objects returned in the current page (in the `entities` field).
@@ -452,15 +539,15 @@ type AccountToNodesConnection = Connection & {
452
539
  entities: LightsparkNode[];
453
540
  /** The typename of the object **/
454
541
  typename: string;
455
- };
542
+ }
456
543
 
457
544
  /** This object is an interface of a payment request on the Lightning Network (i.e., a Lightning Invoice). It contains data related to parsing the payment details of a Lightning Invoice. **/
458
- type PaymentRequestData = {
545
+ interface PaymentRequestData {
459
546
  encodedPaymentRequest: string;
460
547
  bitcoinNetwork: BitcoinNetwork;
461
548
  /** The typename of the object **/
462
549
  typename: string;
463
- };
550
+ }
464
551
 
465
552
  /** This is an enum of the potential states that a payment request on the Lightning Network can take. **/
466
553
  declare enum PaymentRequestStatus {
@@ -474,7 +561,7 @@ declare enum PaymentRequestStatus {
474
561
  }
475
562
 
476
563
  /** This object contains information related to a payment request generated or received by a LightsparkNode. You can retrieve this object to receive payment information about a specific invoice. **/
477
- type PaymentRequest = Entity & {
564
+ interface PaymentRequest {
478
565
  /**
479
566
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
480
567
  * string.
@@ -490,10 +577,10 @@ type PaymentRequest = Entity & {
490
577
  status: PaymentRequestStatus;
491
578
  /** The typename of the object **/
492
579
  typename: string;
493
- };
580
+ }
494
581
  declare const getPaymentRequestQuery: (id: string) => Query<PaymentRequest>;
495
582
 
496
- type AccountToPaymentRequestsConnection = Connection & {
583
+ interface AccountToPaymentRequestsConnection {
497
584
  /**
498
585
  * The total count of objects in this connection, using the current filters. It is different from the
499
586
  * number of objects returned in the current page (in the `entities` field).
@@ -505,7 +592,7 @@ type AccountToPaymentRequestsConnection = Connection & {
505
592
  entities: PaymentRequest[];
506
593
  /** The typename of the object **/
507
594
  typename: string;
508
- };
595
+ }
509
596
 
510
597
  /** This is an enum of the potential statuses a transaction associated with your Lightspark Node can take. **/
511
598
  declare enum TransactionStatus {
@@ -529,7 +616,7 @@ declare enum TransactionStatus {
529
616
  }
530
617
 
531
618
  /** This object represents a payment transaction. The transaction can occur either on a Bitcoin Network, or over the Lightning Network. You can retrieve this object to receive specific information about a particular transaction tied to your Lightspark Node. **/
532
- type Transaction = Entity & {
619
+ interface Transaction {
533
620
  /**
534
621
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
535
622
  * string.
@@ -546,13 +633,13 @@ type Transaction = Entity & {
546
633
  /** The typename of the object **/
547
634
  typename: string;
548
635
  /** The date and time when this transaction was completed or failed. **/
549
- resolvedAt?: string;
636
+ resolvedAt?: string | undefined;
550
637
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
551
- transactionHash?: string;
552
- };
638
+ transactionHash?: string | undefined;
639
+ }
553
640
  declare const getTransactionQuery: (id: string) => Query<Transaction>;
554
641
 
555
- type AccountToTransactionsConnection = Connection & {
642
+ interface AccountToTransactionsConnection {
556
643
  /**
557
644
  * The total count of objects in this connection, using the current filters. It is different from the
558
645
  * number of objects returned in the current page (in the `entities` field).
@@ -568,21 +655,21 @@ type AccountToTransactionsConnection = Connection & {
568
655
  * Profit (or loss) generated by the transactions in this connection, with the set of filters and
569
656
  * constraints provided.
570
657
  **/
571
- profitLoss?: CurrencyAmount;
658
+ profitLoss?: CurrencyAmount | undefined;
572
659
  /**
573
660
  * Average fee earned for the transactions in this connection, with the set of filters and constraints
574
661
  * provided.
575
662
  **/
576
- averageFeeEarned?: CurrencyAmount;
663
+ averageFeeEarned?: CurrencyAmount | undefined;
577
664
  /**
578
665
  * Total amount transacted by the transactions in this connection, with the set of filters and
579
666
  * constraints provided.
580
667
  **/
581
- totalAmountTransacted?: CurrencyAmount;
582
- };
668
+ totalAmountTransacted?: CurrencyAmount | undefined;
669
+ }
583
670
 
584
671
  /** This is an object representing the owner of a LightsparkNode. **/
585
- type LightsparkNodeOwner = Entity & {
672
+ interface LightsparkNodeOwner {
586
673
  /**
587
674
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
588
675
  * string.
@@ -594,7 +681,7 @@ type LightsparkNodeOwner = Entity & {
594
681
  updatedAt: string;
595
682
  /** The typename of the object **/
596
683
  typename: string;
597
- };
684
+ }
598
685
  declare const getLightsparkNodeOwnerQuery: (id: string) => Query<LightsparkNodeOwner>;
599
686
 
600
687
  /** This is an enum of the potential statuses that your Lightspark wallet can take. **/
@@ -624,7 +711,7 @@ declare enum WalletStatus {
624
711
  TERMINATED = "TERMINATED"
625
712
  }
626
713
 
627
- type WalletToPaymentRequestsConnection = Connection & {
714
+ interface WalletToPaymentRequestsConnection {
628
715
  /**
629
716
  * The total count of objects in this connection, using the current filters. It is different from the
630
717
  * number of objects returned in the current page (in the `entities` field).
@@ -636,9 +723,9 @@ type WalletToPaymentRequestsConnection = Connection & {
636
723
  entities: PaymentRequest[];
637
724
  /** The typename of the object **/
638
725
  typename: string;
639
- };
726
+ }
640
727
 
641
- type WalletToTransactionsConnection = Connection & {
728
+ interface WalletToTransactionsConnection {
642
729
  /**
643
730
  * The total count of objects in this connection, using the current filters. It is different from the
644
731
  * number of objects returned in the current page (in the `entities` field).
@@ -650,10 +737,10 @@ type WalletToTransactionsConnection = Connection & {
650
737
  entities: Transaction[];
651
738
  /** The typename of the object **/
652
739
  typename: string;
653
- };
740
+ }
654
741
 
655
742
  /** This object represents a Lightspark Wallet, tied to your Lightspark account. Wallets can be used to send or receive funds over the Lightning Network. You can retrieve this object to receive information about a specific wallet tied to your Lightspark account. **/
656
- declare class Wallet implements LightsparkNodeOwner {
743
+ declare class Wallet implements LightsparkNodeOwner, Entity {
657
744
  readonly id: string;
658
745
  readonly createdAt: string;
659
746
  readonly updatedAt: string;
@@ -669,9 +756,22 @@ declare class Wallet implements LightsparkNodeOwner {
669
756
  getTotalAmountReceived(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
670
757
  getTotalAmountSent(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
671
758
  static getWalletQuery(id: string): Query<Wallet>;
759
+ toJson(): {
760
+ __typename: string;
761
+ wallet_id: string;
762
+ wallet_created_at: string;
763
+ wallet_updated_at: string;
764
+ wallet_last_login_at: string | undefined;
765
+ wallet_balances: any;
766
+ wallet_third_party_identifier: string;
767
+ wallet_account: {
768
+ id: string | undefined;
769
+ };
770
+ wallet_status: WalletStatus;
771
+ };
672
772
  }
673
773
 
674
- type AccountToWalletsConnection = Connection & {
774
+ interface AccountToWalletsConnection {
675
775
  /**
676
776
  * The total count of objects in this connection, using the current filters. It is different from the
677
777
  * number of objects returned in the current page (in the `entities` field).
@@ -683,7 +783,7 @@ type AccountToWalletsConnection = Connection & {
683
783
  entities: Wallet[];
684
784
  /** The typename of the object **/
685
785
  typename: string;
686
- };
786
+ }
687
787
 
688
788
  /** This is an enum of the potential reasons why an OutgoingPayment sent from a Lightspark Node may have failed. **/
689
789
  declare enum PaymentFailureReason {
@@ -717,13 +817,13 @@ declare enum RoutingTransactionFailureReason {
717
817
  }
718
818
 
719
819
  /** This object represents payment failures associated with your Lightspark Node. **/
720
- type TransactionFailures = {
721
- paymentFailures?: PaymentFailureReason[];
722
- routingTransactionFailures?: RoutingTransactionFailureReason[];
723
- };
820
+ interface TransactionFailures {
821
+ paymentFailures?: PaymentFailureReason[] | undefined;
822
+ routingTransactionFailures?: RoutingTransactionFailureReason[] | undefined;
823
+ }
724
824
 
725
825
  /** This is an object representing the connected Lightspark account. You can retrieve this object to see your account information and objects tied to your account. **/
726
- declare class Account implements LightsparkNodeOwner {
826
+ declare class Account implements LightsparkNodeOwner, Entity {
727
827
  readonly id: string;
728
828
  readonly createdAt: string;
729
829
  readonly updatedAt: string;
@@ -742,9 +842,16 @@ declare class Account implements LightsparkNodeOwner {
742
842
  getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined): Promise<AccountToPaymentRequestsConnection>;
743
843
  getWallets(client: LightsparkClient, first?: number | undefined, after?: string | undefined, thirdPartyIds?: string[] | undefined): Promise<AccountToWalletsConnection>;
744
844
  static getAccountQuery(): Query<Account>;
845
+ toJson(): {
846
+ __typename: string;
847
+ account_id: string;
848
+ account_created_at: string;
849
+ account_updated_at: string;
850
+ account_name: string | undefined;
851
+ };
745
852
  }
746
853
 
747
- type CreateApiTokenOutput = {
854
+ interface CreateApiTokenOutput {
748
855
  /** The API Token that has been created. **/
749
856
  apiToken: ApiToken;
750
857
  /**
@@ -753,13 +860,13 @@ type CreateApiTokenOutput = {
753
860
  * account.
754
861
  **/
755
862
  clientSecret: string;
756
- };
863
+ }
757
864
 
758
865
  /** This object represents the estimated L1 transaction fees for the Bitcoin network. Fee estimates are separated by potential confirmation speeds for settlement. **/
759
- type FeeEstimate = {
866
+ interface FeeEstimate {
760
867
  feeFast: CurrencyAmount;
761
868
  feeMin: CurrencyAmount;
762
- };
869
+ }
763
870
 
764
871
  /** This is an enum that enumerates all potential statuses for an incoming payment attempt. **/
765
872
  declare enum IncomingPaymentAttemptStatus {
@@ -775,7 +882,7 @@ declare enum IncomingPaymentAttemptStatus {
775
882
  }
776
883
 
777
884
  /** This object represents any attempted payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific incoming payment attempt. **/
778
- type IncomingPaymentAttempt = Entity & {
885
+ interface IncomingPaymentAttempt {
779
886
  /**
780
887
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
781
888
  * string.
@@ -794,12 +901,12 @@ type IncomingPaymentAttempt = Entity & {
794
901
  /** The typename of the object **/
795
902
  typename: string;
796
903
  /** The time the incoming payment attempt failed or succeeded. **/
797
- resolvedAt?: string;
798
- };
904
+ resolvedAt?: string | undefined;
905
+ }
799
906
  declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaymentAttempt>;
800
907
 
801
908
  /** The connection from incoming payment to all attempts. **/
802
- type IncomingPaymentToAttemptsConnection = Connection & {
909
+ interface IncomingPaymentToAttemptsConnection {
803
910
  /**
804
911
  * The total count of objects in this connection, using the current filters. It is different from the
805
912
  * number of objects returned in the current page (in the `entities` field).
@@ -811,10 +918,10 @@ type IncomingPaymentToAttemptsConnection = Connection & {
811
918
  entities: IncomingPaymentAttempt[];
812
919
  /** The typename of the object **/
813
920
  typename: string;
814
- };
921
+ }
815
922
 
816
923
  /** This is an object representing a transaction made over the Lightning Network. You can retrieve this object to receive information about a specific transaction made over Lightning for a Lightspark node. **/
817
- type LightningTransaction = Transaction & Entity & {
924
+ interface LightningTransaction {
818
925
  /**
819
926
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
820
927
  * string.
@@ -831,14 +938,14 @@ type LightningTransaction = Transaction & Entity & {
831
938
  /** The typename of the object **/
832
939
  typename: string;
833
940
  /** The date and time when this transaction was completed or failed. **/
834
- resolvedAt?: string;
941
+ resolvedAt?: string | undefined;
835
942
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
836
- transactionHash?: string;
837
- };
943
+ transactionHash?: string | undefined;
944
+ }
838
945
  declare const getLightningTransactionQuery: (id: string) => Query<LightningTransaction>;
839
946
 
840
947
  /** This object represents post-transaction data that could be used to register payment for KYT. **/
841
- type PostTransactionData = {
948
+ interface PostTransactionData {
842
949
  /**
843
950
  * The utxo of the channel over which the payment went through in the format of
844
951
  * <transaction_hash>:<output_index>.
@@ -846,10 +953,10 @@ type PostTransactionData = {
846
953
  utxo: string;
847
954
  /** The amount of funds transferred in the payment. **/
848
955
  amount: CurrencyAmount;
849
- };
956
+ }
850
957
 
851
958
  /** This object represents any payment sent to a Lightspark node on the Lightning Network. You can retrieve this object to receive payment related information about a specific payment received by a Lightspark node. **/
852
- declare class IncomingPayment implements LightningTransaction {
959
+ declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
853
960
  readonly id: string;
854
961
  readonly createdAt: string;
855
962
  readonly updatedAt: string;
@@ -864,10 +971,71 @@ declare class IncomingPayment implements LightningTransaction {
864
971
  constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, destinationId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, paymentRequestId?: string | undefined, umaPostTransactionData?: PostTransactionData[] | undefined);
865
972
  getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
866
973
  static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
974
+ toJson(): {
975
+ __typename: string;
976
+ incoming_payment_id: string;
977
+ incoming_payment_created_at: string;
978
+ incoming_payment_updated_at: string;
979
+ incoming_payment_status: TransactionStatus;
980
+ incoming_payment_resolved_at: string | undefined;
981
+ incoming_payment_amount: any;
982
+ incoming_payment_transaction_hash: string | undefined;
983
+ incoming_payment_destination: {
984
+ id: string;
985
+ };
986
+ incoming_payment_payment_request: {
987
+ id: string | undefined;
988
+ };
989
+ incoming_payment_uma_post_transaction_data: any[] | undefined;
990
+ };
867
991
  }
868
992
 
993
+ /** This object is an interface representing a Lightning Node on the Lightning Network, and could either be a Lightspark node or a node managed by a third party. **/
994
+ interface Node {
995
+ /**
996
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
997
+ * string.
998
+ **/
999
+ id: string;
1000
+ /** The date and time when the entity was first created. **/
1001
+ createdAt: string;
1002
+ /** The date and time when the entity was last updated. **/
1003
+ updatedAt: string;
1004
+ /** The Bitcoin Network this node is deployed in. **/
1005
+ bitcoinNetwork: BitcoinNetwork;
1006
+ /**
1007
+ * The name of this node in the network. It will be the most human-readable option possible, depending
1008
+ * on the data available for this node.
1009
+ **/
1010
+ displayName: string;
1011
+ /** The typename of the object **/
1012
+ typename: string;
1013
+ /**
1014
+ * A name that identifies the node. It has no importance in terms of operating the node, it is just a
1015
+ * way to identify and search for commercial services or popular nodes. This alias can be changed at
1016
+ * any time by the node operator.
1017
+ **/
1018
+ alias?: string | undefined;
1019
+ /**
1020
+ * A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
1021
+ * has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
1022
+ * That color can be changed at any time by the node operator.
1023
+ **/
1024
+ color?: string | undefined;
1025
+ /**
1026
+ * A summary metric used to capture how well positioned a node is to send, receive, or route
1027
+ * transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
1028
+ * capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
1029
+ **/
1030
+ conductivity?: number | undefined;
1031
+ /** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
1032
+ publicKey?: string | undefined;
1033
+ getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
1034
+ }
1035
+ declare const getNodeQuery: (id: string) => Query<Node>;
1036
+
869
1037
  /** This object represents the data associated with a BOLT #11 invoice. You can retrieve this object to receive the relevant data associated with a specific invoice. **/
870
- type InvoiceData = PaymentRequestData & {
1038
+ interface InvoiceData {
871
1039
  encodedPaymentRequest: string;
872
1040
  bitcoinNetwork: BitcoinNetwork;
873
1041
  /** The payment hash of this invoice. **/
@@ -886,11 +1054,11 @@ type InvoiceData = PaymentRequestData & {
886
1054
  /** The typename of the object **/
887
1055
  typename: string;
888
1056
  /** A short, UTF-8 encoded, description of the purpose of this invoice. **/
889
- memo?: string;
890
- };
1057
+ memo?: string | undefined;
1058
+ }
891
1059
 
892
1060
  /** 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. **/
893
- type Invoice = PaymentRequest & Entity & {
1061
+ interface Invoice {
894
1062
  /**
895
1063
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
896
1064
  * string.
@@ -907,8 +1075,8 @@ type Invoice = PaymentRequest & Entity & {
907
1075
  /** The typename of the object **/
908
1076
  typename: string;
909
1077
  /** The total amount that has been paid to this invoice. **/
910
- amountPaid?: CurrencyAmount;
911
- };
1078
+ amountPaid?: CurrencyAmount | undefined;
1079
+ }
912
1080
  declare const getInvoiceQuery: (id: string) => Query<Invoice>;
913
1081
 
914
1082
  /** This is an enum for potential invoice types. **/
@@ -924,15 +1092,15 @@ declare enum InvoiceType {
924
1092
  AMP = "AMP"
925
1093
  }
926
1094
 
927
- type ChannelSnapshot = {
1095
+ interface ChannelSnapshot {
928
1096
  channelId: string;
929
1097
  timestamp: string;
930
- localBalance?: CurrencyAmount;
931
- localUnsettledBalance?: CurrencyAmount;
932
- localChannelReserve?: CurrencyAmount;
933
- remoteBalance?: CurrencyAmount;
934
- remoteUnsettledBalance?: CurrencyAmount;
935
- };
1098
+ localBalance?: CurrencyAmount | undefined;
1099
+ localUnsettledBalance?: CurrencyAmount | undefined;
1100
+ localChannelReserve?: CurrencyAmount | undefined;
1101
+ remoteBalance?: CurrencyAmount | undefined;
1102
+ remoteUnsettledBalance?: CurrencyAmount | undefined;
1103
+ }
936
1104
 
937
1105
  /** This is an enum representing a particular reason why an htlc sent over the Lightning Network may have failed. **/
938
1106
  declare enum HtlcAttemptFailureCode {
@@ -984,7 +1152,7 @@ declare enum OutgoingPaymentAttemptStatus {
984
1152
  }
985
1153
 
986
1154
  /** This object represents a specific node that existed on a particular payment route. You can retrieve this object to get information about a node on a particular payment path and all payment-relevant information for that node. **/
987
- type Hop = Entity & {
1155
+ interface Hop {
988
1156
  /**
989
1157
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
990
1158
  * string.
@@ -999,20 +1167,20 @@ type Hop = Entity & {
999
1167
  /** The typename of the object **/
1000
1168
  typename: string;
1001
1169
  /** The destination node of the hop. **/
1002
- destinationId?: string;
1170
+ destinationId?: string | undefined;
1003
1171
  /** The public key of the node to which the hop is bound. **/
1004
- publicKey?: string;
1172
+ publicKey?: string | undefined;
1005
1173
  /** The amount that is to be forwarded to the destination node. **/
1006
- amountToForward?: CurrencyAmount;
1174
+ amountToForward?: CurrencyAmount | undefined;
1007
1175
  /** The fees to be collected by the source node for forwarding the payment over the hop. **/
1008
- fee?: CurrencyAmount;
1176
+ fee?: CurrencyAmount | undefined;
1009
1177
  /** The block height at which an unsettled HTLC is considered expired. **/
1010
- expiryBlockHeight?: number;
1011
- };
1178
+ expiryBlockHeight?: number | undefined;
1179
+ }
1012
1180
  declare const getHopQuery: (id: string) => Query<Hop>;
1013
1181
 
1014
1182
  /** The connection from an outgoing payment attempt to the list of sequential hops that define the path from sender node to recipient node. **/
1015
- type OutgoingPaymentAttemptToHopsConnection = Connection & {
1183
+ interface OutgoingPaymentAttemptToHopsConnection {
1016
1184
  /**
1017
1185
  * The total count of objects in this connection, using the current filters. It is different from the
1018
1186
  * number of objects returned in the current page (in the `entities` field).
@@ -1024,7 +1192,7 @@ type OutgoingPaymentAttemptToHopsConnection = Connection & {
1024
1192
  entities: Hop[];
1025
1193
  /** The typename of the object **/
1026
1194
  typename: string;
1027
- };
1195
+ }
1028
1196
 
1029
1197
  /** This object represents an attempted Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment attempt sent from your Lightspark Node on the Lightning Network, including any potential reasons the payment may have failed. **/
1030
1198
  declare class OutgoingPaymentAttempt implements Entity {
@@ -1043,10 +1211,26 @@ declare class OutgoingPaymentAttempt implements Entity {
1043
1211
  constructor(id: string, createdAt: string, updatedAt: string, status: OutgoingPaymentAttemptStatus, outgoingPaymentId: string, typename: string, failureCode?: HtlcAttemptFailureCode | undefined, failureSourceIndex?: number | undefined, resolvedAt?: string | undefined, amount?: CurrencyAmount | undefined, fees?: CurrencyAmount | undefined, channelSnapshot?: ChannelSnapshot | undefined);
1044
1212
  getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
1045
1213
  static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
1214
+ toJson(): {
1215
+ __typename: string;
1216
+ outgoing_payment_attempt_id: string;
1217
+ outgoing_payment_attempt_created_at: string;
1218
+ outgoing_payment_attempt_updated_at: string;
1219
+ outgoing_payment_attempt_status: OutgoingPaymentAttemptStatus;
1220
+ outgoing_payment_attempt_failure_code: HtlcAttemptFailureCode | undefined;
1221
+ outgoing_payment_attempt_failure_source_index: number | undefined;
1222
+ outgoing_payment_attempt_resolved_at: string | undefined;
1223
+ outgoing_payment_attempt_amount: any;
1224
+ outgoing_payment_attempt_fees: any;
1225
+ outgoing_payment_attempt_outgoing_payment: {
1226
+ id: string;
1227
+ };
1228
+ outgoing_payment_attempt_channel_snapshot: any;
1229
+ };
1046
1230
  }
1047
1231
 
1048
1232
  /** The connection from outgoing payment to all attempts. **/
1049
- type OutgoingPaymentToAttemptsConnection = Connection & {
1233
+ interface OutgoingPaymentToAttemptsConnection {
1050
1234
  /**
1051
1235
  * The total count of objects in this connection, using the current filters. It is different from the
1052
1236
  * number of objects returned in the current page (in the `entities` field).
@@ -1058,14 +1242,14 @@ type OutgoingPaymentToAttemptsConnection = Connection & {
1058
1242
  entities: OutgoingPaymentAttempt[];
1059
1243
  /** The typename of the object **/
1060
1244
  typename: string;
1061
- };
1245
+ }
1062
1246
 
1063
- type RichText = {
1247
+ interface RichText {
1064
1248
  text: string;
1065
- };
1249
+ }
1066
1250
 
1067
1251
  /** This object represents a Lightning Network payment sent from a Lightspark Node. You can retrieve this object to receive payment related information about any payment sent from your Lightspark Node on the Lightning Network. **/
1068
- declare class OutgoingPayment implements LightningTransaction {
1252
+ declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
1069
1253
  readonly id: string;
1070
1254
  readonly createdAt: string;
1071
1255
  readonly updatedAt: string;
@@ -1085,6 +1269,28 @@ declare class OutgoingPayment implements LightningTransaction {
1085
1269
  constructor(id: string, createdAt: string, updatedAt: string, status: TransactionStatus, amount: CurrencyAmount, originId: string, typename: string, resolvedAt?: string | undefined, transactionHash?: string | undefined, destinationId?: string | undefined, fees?: CurrencyAmount | undefined, paymentRequestData?: PaymentRequestData | undefined, failureReason?: PaymentFailureReason | undefined, failureMessage?: RichText | undefined, umaPostTransactionData?: PostTransactionData[] | undefined, paymentPreimage?: string | undefined);
1086
1270
  getAttempts(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentToAttemptsConnection>;
1087
1271
  static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
1272
+ toJson(): {
1273
+ __typename: string;
1274
+ outgoing_payment_id: string;
1275
+ outgoing_payment_created_at: string;
1276
+ outgoing_payment_updated_at: string;
1277
+ outgoing_payment_status: TransactionStatus;
1278
+ outgoing_payment_resolved_at: string | undefined;
1279
+ outgoing_payment_amount: any;
1280
+ outgoing_payment_transaction_hash: string | undefined;
1281
+ outgoing_payment_origin: {
1282
+ id: string;
1283
+ };
1284
+ outgoing_payment_destination: {
1285
+ id: string | undefined;
1286
+ };
1287
+ outgoing_payment_fees: any;
1288
+ outgoing_payment_payment_request_data: any;
1289
+ outgoing_payment_failure_reason: PaymentFailureReason | undefined;
1290
+ outgoing_payment_failure_message: any;
1291
+ outgoing_payment_uma_post_transaction_data: any[] | undefined;
1292
+ outgoing_payment_payment_preimage: string | undefined;
1293
+ };
1088
1294
  }
1089
1295
 
1090
1296
  type SingleNodeDashboard = {
@@ -1156,51 +1362,8 @@ declare enum WithdrawalRequestStatus {
1156
1362
  SUCCESSFUL = "SUCCESSFUL"
1157
1363
  }
1158
1364
 
1159
- /** This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve this object to receive information about a specific on-chain transaction made on the Lightning Network associated with your Lightspark Node. **/
1160
- type OnChainTransaction = Transaction & Entity & {
1161
- /**
1162
- * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
1163
- * string.
1164
- **/
1165
- id: string;
1166
- /** The date and time when this transaction was initiated. **/
1167
- createdAt: string;
1168
- /** The date and time when the entity was last updated. **/
1169
- updatedAt: string;
1170
- /** The current status of this transaction. **/
1171
- status: TransactionStatus;
1172
- /** The amount of money involved in this transaction. **/
1173
- amount: CurrencyAmount;
1174
- /**
1175
- * The height of the block that included this transaction. This will be zero for unconfirmed
1176
- * transactions.
1177
- **/
1178
- blockHeight: number;
1179
- /** The Bitcoin blockchain addresses this transaction was sent to. **/
1180
- destinationAddresses: string[];
1181
- /** The typename of the object **/
1182
- typename: string;
1183
- /** The date and time when this transaction was completed or failed. **/
1184
- resolvedAt?: string;
1185
- /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1186
- transactionHash?: string;
1187
- /**
1188
- * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
1189
- * blockchain.
1190
- **/
1191
- fees?: CurrencyAmount;
1192
- /**
1193
- * The hash of the block that included this transaction. This will be null for unconfirmed
1194
- * transactions.
1195
- **/
1196
- blockHash?: string;
1197
- /** The number of blockchain confirmations for this transaction in real time. **/
1198
- numConfirmations?: number;
1199
- };
1200
- declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
1201
-
1202
1365
  /** This is an object representing a transaction which closes a channel on the Lightning Network. This operation allocates balances back to the local and remote nodes. **/
1203
- type ChannelClosingTransaction = OnChainTransaction & Transaction & Entity & {
1366
+ interface ChannelClosingTransaction {
1204
1367
  /**
1205
1368
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
1206
1369
  * string.
@@ -1224,27 +1387,27 @@ type ChannelClosingTransaction = OnChainTransaction & Transaction & Entity & {
1224
1387
  /** The typename of the object **/
1225
1388
  typename: string;
1226
1389
  /** The date and time when this transaction was completed or failed. **/
1227
- resolvedAt?: string;
1390
+ resolvedAt?: string | undefined;
1228
1391
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1229
- transactionHash?: string;
1392
+ transactionHash?: string | undefined;
1230
1393
  /**
1231
1394
  * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
1232
1395
  * blockchain.
1233
1396
  **/
1234
- fees?: CurrencyAmount;
1397
+ fees?: CurrencyAmount | undefined;
1235
1398
  /**
1236
1399
  * The hash of the block that included this transaction. This will be null for unconfirmed
1237
1400
  * transactions.
1238
1401
  **/
1239
- blockHash?: string;
1402
+ blockHash?: string | undefined;
1240
1403
  /** The number of blockchain confirmations for this transaction in real time. **/
1241
- numConfirmations?: number;
1404
+ numConfirmations?: number | undefined;
1242
1405
  /** If known, the channel this transaction is closing. **/
1243
- channelId?: string;
1244
- };
1406
+ channelId?: string | undefined;
1407
+ }
1245
1408
  declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
1246
1409
 
1247
- type WithdrawalRequestToChannelClosingTransactionsConnection = {
1410
+ interface WithdrawalRequestToChannelClosingTransactionsConnection {
1248
1411
  /** An object that holds pagination information about the objects in this connection. **/
1249
1412
  pageInfo: PageInfo;
1250
1413
  /**
@@ -1254,10 +1417,10 @@ type WithdrawalRequestToChannelClosingTransactionsConnection = {
1254
1417
  count: number;
1255
1418
  /** The channel closing transactions for the current page of this connection. **/
1256
1419
  entities: ChannelClosingTransaction[];
1257
- };
1420
+ }
1258
1421
 
1259
1422
  /** This is an object representing a transaction which opens a channel on the Lightning Network. This object occurs only for channels funded by the local Lightspark node. **/
1260
- type ChannelOpeningTransaction = OnChainTransaction & Transaction & Entity & {
1423
+ interface ChannelOpeningTransaction {
1261
1424
  /**
1262
1425
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
1263
1426
  * string.
@@ -1281,27 +1444,27 @@ type ChannelOpeningTransaction = OnChainTransaction & Transaction & Entity & {
1281
1444
  /** The typename of the object **/
1282
1445
  typename: string;
1283
1446
  /** The date and time when this transaction was completed or failed. **/
1284
- resolvedAt?: string;
1447
+ resolvedAt?: string | undefined;
1285
1448
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1286
- transactionHash?: string;
1449
+ transactionHash?: string | undefined;
1287
1450
  /**
1288
1451
  * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
1289
1452
  * blockchain.
1290
1453
  **/
1291
- fees?: CurrencyAmount;
1454
+ fees?: CurrencyAmount | undefined;
1292
1455
  /**
1293
1456
  * The hash of the block that included this transaction. This will be null for unconfirmed
1294
1457
  * transactions.
1295
1458
  **/
1296
- blockHash?: string;
1459
+ blockHash?: string | undefined;
1297
1460
  /** The number of blockchain confirmations for this transaction in real time. **/
1298
- numConfirmations?: number;
1461
+ numConfirmations?: number | undefined;
1299
1462
  /** If known, the channel this transaction is opening. **/
1300
- channelId?: string;
1301
- };
1463
+ channelId?: string | undefined;
1464
+ }
1302
1465
  declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
1303
1466
 
1304
- type WithdrawalRequestToChannelOpeningTransactionsConnection = {
1467
+ interface WithdrawalRequestToChannelOpeningTransactionsConnection {
1305
1468
  /** An object that holds pagination information about the objects in this connection. **/
1306
1469
  pageInfo: PageInfo;
1307
1470
  /**
@@ -1311,7 +1474,7 @@ type WithdrawalRequestToChannelOpeningTransactionsConnection = {
1311
1474
  count: number;
1312
1475
  /** The channel opening transactions for the current page of this connection. **/
1313
1476
  entities: ChannelOpeningTransaction[];
1314
- };
1477
+ }
1315
1478
 
1316
1479
  /** This object represents a request made for an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any withdrawal request made from your Lightspark account. **/
1317
1480
  declare class WithdrawalRequest implements Entity {
@@ -1330,6 +1493,21 @@ declare class WithdrawalRequest implements Entity {
1330
1493
  getChannelClosingTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelClosingTransactionsConnection>;
1331
1494
  getChannelOpeningTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelOpeningTransactionsConnection>;
1332
1495
  static getWithdrawalRequestQuery(id: string): Query<WithdrawalRequest>;
1496
+ toJson(): {
1497
+ __typename: string;
1498
+ withdrawal_request_id: string;
1499
+ withdrawal_request_created_at: string;
1500
+ withdrawal_request_updated_at: string;
1501
+ withdrawal_request_amount: any;
1502
+ withdrawal_request_estimated_amount: any;
1503
+ withdrawal_request_bitcoin_address: string;
1504
+ withdrawal_request_withdrawal_mode: WithdrawalMode;
1505
+ withdrawal_request_status: WithdrawalRequestStatus;
1506
+ withdrawal_request_completed_at: string | undefined;
1507
+ withdrawal_request_withdrawal: {
1508
+ id: string | undefined;
1509
+ };
1510
+ };
1333
1511
  }
1334
1512
 
1335
1513
  /**
@@ -1703,29 +1881,41 @@ declare enum ComplianceProvider {
1703
1881
  CHAINALYSIS = "CHAINALYSIS"
1704
1882
  }
1705
1883
 
1706
- type CreateApiTokenInput = {
1884
+ interface Connection {
1885
+ /**
1886
+ * The total count of objects in this connection, using the current filters. It is different from the
1887
+ * number of objects returned in the current page (in the `entities` field).
1888
+ **/
1889
+ count: number;
1890
+ /** An object that holds pagination information about the objects in this connection. **/
1891
+ pageInfo: PageInfo;
1892
+ /** The typename of the object **/
1893
+ typename: string;
1894
+ }
1895
+
1896
+ interface CreateApiTokenInput {
1707
1897
  /** An arbitrary name that the user can choose to identify the API token in a list. **/
1708
1898
  name: string;
1709
1899
  /** List of permissions to grant to the API token **/
1710
1900
  permissions: Permission[];
1711
- };
1901
+ }
1712
1902
 
1713
- type CreateInvoiceInput = {
1903
+ interface CreateInvoiceInput {
1714
1904
  /** The node from which to create the invoice. **/
1715
1905
  nodeId: string;
1716
1906
  /** The amount for which the invoice should be created, in millisatoshis. **/
1717
1907
  amountMsats: number;
1718
- memo?: string;
1719
- invoiceType?: InvoiceType;
1908
+ memo?: string | undefined;
1909
+ invoiceType?: InvoiceType | undefined;
1720
1910
  /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
1721
- expirySecs?: number;
1722
- };
1911
+ expirySecs?: number | undefined;
1912
+ }
1723
1913
 
1724
- type CreateInvoiceOutput = {
1914
+ interface CreateInvoiceOutput {
1725
1915
  invoiceId: string;
1726
- };
1916
+ }
1727
1917
 
1728
- type CreateLnurlInvoiceInput = {
1918
+ interface CreateLnurlInvoiceInput {
1729
1919
  /** The node from which to create the invoice. **/
1730
1920
  nodeId: string;
1731
1921
  /** The amount for which the invoice should be created, in millisatoshis. **/
@@ -1736,30 +1926,30 @@ type CreateLnurlInvoiceInput = {
1736
1926
  **/
1737
1927
  metadataHash: string;
1738
1928
  /** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
1739
- expirySecs?: number;
1740
- };
1929
+ expirySecs?: number | undefined;
1930
+ }
1741
1931
 
1742
- type CreateNodeWalletAddressInput = {
1932
+ interface CreateNodeWalletAddressInput {
1743
1933
  nodeId: string;
1744
- };
1934
+ }
1745
1935
 
1746
- type CreateNodeWalletAddressOutput = {
1936
+ interface CreateNodeWalletAddressOutput {
1747
1937
  nodeId: string;
1748
1938
  walletAddress: string;
1749
- };
1939
+ }
1750
1940
 
1751
- type CreateTestModeInvoiceInput = {
1941
+ interface CreateTestModeInvoiceInput {
1752
1942
  localNodeId: string;
1753
1943
  amountMsats: number;
1754
- memo?: string;
1755
- invoiceType?: InvoiceType;
1756
- };
1944
+ memo?: string | undefined;
1945
+ invoiceType?: InvoiceType | undefined;
1946
+ }
1757
1947
 
1758
- type CreateTestModeInvoiceOutput = {
1948
+ interface CreateTestModeInvoiceOutput {
1759
1949
  encodedPaymentRequest: string;
1760
- };
1950
+ }
1761
1951
 
1762
- type CreateTestModePaymentInput = {
1952
+ interface CreateTestModePaymentInput {
1763
1953
  /** The node to where you want to send the payment. **/
1764
1954
  localNodeId: string;
1765
1955
  /** The invoice you want to be paid (as defined by the BOLT11 standard). **/
@@ -1768,11 +1958,11 @@ type CreateTestModePaymentInput = {
1768
1958
  * The amount you will be paid for this invoice, expressed in msats. It should ONLY be set when the
1769
1959
  * invoice amount is zero.
1770
1960
  **/
1771
- amountMsats?: number;
1772
- };
1961
+ amountMsats?: number | undefined;
1962
+ }
1773
1963
 
1774
1964
  /** This is an object identifying the output of a test mode payment. This object can be used to retrieve the associated payment made from a Test Mode Payment call. **/
1775
- type CreateTestModePaymentoutput = {
1965
+ interface CreateTestModePaymentoutput {
1776
1966
  /**
1777
1967
  * The payment that has been sent.
1778
1968
  *
@@ -1781,19 +1971,19 @@ type CreateTestModePaymentoutput = {
1781
1971
  paymentId: string;
1782
1972
  /** The payment that has been received. **/
1783
1973
  incomingPaymentId: string;
1784
- };
1974
+ }
1785
1975
 
1786
- type CreateUmaInvoiceInput = {
1976
+ interface CreateUmaInvoiceInput {
1787
1977
  nodeId: string;
1788
1978
  amountMsats: number;
1789
1979
  metadataHash: string;
1790
- expirySecs?: number;
1791
- };
1980
+ expirySecs?: number | undefined;
1981
+ }
1792
1982
 
1793
- type DeclineToSignMessagesInput = {
1983
+ interface DeclineToSignMessagesInput {
1794
1984
  /** List of payload ids to decline to sign because validation failed. **/
1795
1985
  payloadIds: string[];
1796
- };
1986
+ }
1797
1987
 
1798
1988
  declare enum SignablePayloadStatus {
1799
1989
  /**
@@ -1807,7 +1997,7 @@ declare enum SignablePayloadStatus {
1807
1997
  INVALID_SIGNATURE = "INVALID_SIGNATURE"
1808
1998
  }
1809
1999
 
1810
- type SignablePayload = Entity & {
2000
+ interface SignablePayload {
1811
2001
  /**
1812
2002
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
1813
2003
  * string.
@@ -1828,26 +2018,26 @@ type SignablePayload = Entity & {
1828
2018
  /** The typename of the object **/
1829
2019
  typename: string;
1830
2020
  /** The tweak value to add. **/
1831
- addTweak?: string;
2021
+ addTweak?: string | undefined;
1832
2022
  /** The tweak value to multiply. **/
1833
- mulTweak?: string;
1834
- };
2023
+ mulTweak?: string | undefined;
2024
+ }
1835
2025
  declare const getSignablePayloadQuery: (id: string) => Query<SignablePayload>;
1836
2026
 
1837
- type DeclineToSignMessagesOutput = {
2027
+ interface DeclineToSignMessagesOutput {
1838
2028
  declinedPayloads: SignablePayload[];
1839
- };
2029
+ }
1840
2030
 
1841
- type DeleteApiTokenInput = {
2031
+ interface DeleteApiTokenInput {
1842
2032
  apiTokenId: string;
1843
- };
2033
+ }
1844
2034
 
1845
- type DeleteApiTokenOutput = {
2035
+ interface DeleteApiTokenOutput {
1846
2036
  accountId: string;
1847
- };
2037
+ }
1848
2038
 
1849
2039
  /** This object represents a Deposit made to a Lightspark node wallet. This operation occurs for any L1 funding transaction to the wallet. You can retrieve this object to receive detailed information about the deposit. **/
1850
- type Deposit = OnChainTransaction & Transaction & Entity & {
2040
+ interface Deposit {
1851
2041
  /**
1852
2042
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
1853
2043
  * string.
@@ -1873,35 +2063,35 @@ type Deposit = OnChainTransaction & Transaction & Entity & {
1873
2063
  /** The typename of the object **/
1874
2064
  typename: string;
1875
2065
  /** The date and time when this transaction was completed or failed. **/
1876
- resolvedAt?: string;
2066
+ resolvedAt?: string | undefined;
1877
2067
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
1878
- transactionHash?: string;
2068
+ transactionHash?: string | undefined;
1879
2069
  /**
1880
2070
  * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
1881
2071
  * blockchain.
1882
2072
  **/
1883
- fees?: CurrencyAmount;
2073
+ fees?: CurrencyAmount | undefined;
1884
2074
  /**
1885
2075
  * The hash of the block that included this transaction. This will be null for unconfirmed
1886
2076
  * transactions.
1887
2077
  **/
1888
- blockHash?: string;
2078
+ blockHash?: string | undefined;
1889
2079
  /** The number of blockchain confirmations for this transaction in real time. **/
1890
- numConfirmations?: number;
1891
- };
2080
+ numConfirmations?: number | undefined;
2081
+ }
1892
2082
  declare const getDepositQuery: (id: string) => Query<Deposit>;
1893
2083
 
1894
- type FundNodeInput = {
2084
+ interface FundNodeInput {
1895
2085
  nodeId: string;
1896
- amountSats?: number;
1897
- };
2086
+ amountSats?: number | undefined;
2087
+ }
1898
2088
 
1899
- type FundNodeOutput = {
2089
+ interface FundNodeOutput {
1900
2090
  amount: CurrencyAmount;
1901
- };
2091
+ }
1902
2092
 
1903
2093
  /** This object represents a node that exists on the Lightning Network, including nodes not managed by Lightspark. You can retrieve this object to get publicly available information about any node on the Lightning Network. **/
1904
- declare class GraphNode implements Node {
2094
+ declare class GraphNode implements Node, Entity {
1905
2095
  readonly id: string;
1906
2096
  readonly createdAt: string;
1907
2097
  readonly updatedAt: string;
@@ -1915,16 +2105,28 @@ declare class GraphNode implements Node {
1915
2105
  constructor(id: string, createdAt: string, updatedAt: string, bitcoinNetwork: BitcoinNetwork, displayName: string, typename: string, alias?: string | undefined, color?: string | undefined, conductivity?: number | undefined, publicKey?: string | undefined);
1916
2106
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
1917
2107
  static getGraphNodeQuery(id: string): Query<GraphNode>;
2108
+ toJson(): {
2109
+ __typename: string;
2110
+ graph_node_id: string;
2111
+ graph_node_created_at: string;
2112
+ graph_node_updated_at: string;
2113
+ graph_node_alias: string | undefined;
2114
+ graph_node_bitcoin_network: BitcoinNetwork;
2115
+ graph_node_color: string | undefined;
2116
+ graph_node_conductivity: number | undefined;
2117
+ graph_node_display_name: string;
2118
+ graph_node_public_key: string | undefined;
2119
+ };
1918
2120
  }
1919
2121
 
1920
- type IdAndSignature = {
2122
+ interface IdAndSignature {
1921
2123
  /** The id of the message. **/
1922
2124
  id: string;
1923
2125
  /** The signature of the message. **/
1924
2126
  signature: string;
1925
- };
2127
+ }
1926
2128
 
1927
- type LightningFeeEstimateForInvoiceInput = {
2129
+ interface LightningFeeEstimateForInvoiceInput {
1928
2130
  /** The node from where you want to send the payment. **/
1929
2131
  nodeId: string;
1930
2132
  /** The invoice you want to pay (as defined by the BOLT11 standard). **/
@@ -1933,30 +2135,30 @@ type LightningFeeEstimateForInvoiceInput = {
1933
2135
  * If the invoice does not specify a payment amount, then the amount that you wish to pay, expressed
1934
2136
  * in msats.
1935
2137
  **/
1936
- amountMsats?: number;
1937
- };
2138
+ amountMsats?: number | undefined;
2139
+ }
1938
2140
 
1939
- type LightningFeeEstimateForNodeInput = {
2141
+ interface LightningFeeEstimateForNodeInput {
1940
2142
  /** The node from where you want to send the payment. **/
1941
2143
  nodeId: string;
1942
2144
  /** The public key of the node that you want to pay. **/
1943
2145
  destinationNodePublicKey: string;
1944
2146
  /** The payment amount expressed in msats. **/
1945
2147
  amountMsats: number;
1946
- };
2148
+ }
1947
2149
 
1948
- type LightningFeeEstimateOutput = {
2150
+ interface LightningFeeEstimateOutput {
1949
2151
  /** The estimated fees for the payment. **/
1950
2152
  feeEstimate: CurrencyAmount;
1951
- };
2153
+ }
1952
2154
 
1953
- type Secret = {
2155
+ interface Secret {
1954
2156
  encryptedValue: string;
1955
2157
  cipher: string;
1956
- };
2158
+ }
1957
2159
 
1958
2160
  /** This is a Lightspark node with OSK. **/
1959
- declare class LightsparkNodeWithOSK implements LightsparkNode {
2161
+ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
1960
2162
  readonly id: string;
1961
2163
  readonly createdAt: string;
1962
2164
  readonly updatedAt: string;
@@ -1981,10 +2183,34 @@ declare class LightsparkNodeWithOSK implements LightsparkNode {
1981
2183
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
1982
2184
  getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
1983
2185
  static getLightsparkNodeWithOSKQuery(id: string): Query<LightsparkNodeWithOSK>;
2186
+ toJson(): {
2187
+ __typename: string;
2188
+ lightspark_node_with_o_s_k_id: string;
2189
+ lightspark_node_with_o_s_k_created_at: string;
2190
+ lightspark_node_with_o_s_k_updated_at: string;
2191
+ lightspark_node_with_o_s_k_alias: string | undefined;
2192
+ lightspark_node_with_o_s_k_bitcoin_network: BitcoinNetwork;
2193
+ lightspark_node_with_o_s_k_color: string | undefined;
2194
+ lightspark_node_with_o_s_k_conductivity: number | undefined;
2195
+ lightspark_node_with_o_s_k_display_name: string;
2196
+ lightspark_node_with_o_s_k_public_key: string | undefined;
2197
+ lightspark_node_with_o_s_k_owner: {
2198
+ id: string;
2199
+ };
2200
+ lightspark_node_with_o_s_k_status: LightsparkNodeStatus | undefined;
2201
+ lightspark_node_with_o_s_k_total_balance: any;
2202
+ lightspark_node_with_o_s_k_total_local_balance: any;
2203
+ lightspark_node_with_o_s_k_local_balance: any;
2204
+ lightspark_node_with_o_s_k_remote_balance: any;
2205
+ lightspark_node_with_o_s_k_blockchain_balance: any;
2206
+ lightspark_node_with_o_s_k_uma_prescreening_utxos: string[];
2207
+ lightspark_node_with_o_s_k_balances: any;
2208
+ lightspark_node_with_o_s_k_encrypted_signing_private_key: any;
2209
+ };
1984
2210
  }
1985
2211
 
1986
2212
  /** This is a Lightspark node with remote signing. **/
1987
- declare class LightsparkNodeWithRemoteSigning implements LightsparkNode {
2213
+ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
1988
2214
  readonly id: string;
1989
2215
  readonly createdAt: string;
1990
2216
  readonly updatedAt: string;
@@ -2008,20 +2234,86 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode {
2008
2234
  getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
2009
2235
  getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
2010
2236
  static getLightsparkNodeWithRemoteSigningQuery(id: string): Query<LightsparkNodeWithRemoteSigning>;
2237
+ toJson(): {
2238
+ __typename: string;
2239
+ lightspark_node_with_remote_signing_id: string;
2240
+ lightspark_node_with_remote_signing_created_at: string;
2241
+ lightspark_node_with_remote_signing_updated_at: string;
2242
+ lightspark_node_with_remote_signing_alias: string | undefined;
2243
+ lightspark_node_with_remote_signing_bitcoin_network: BitcoinNetwork;
2244
+ lightspark_node_with_remote_signing_color: string | undefined;
2245
+ lightspark_node_with_remote_signing_conductivity: number | undefined;
2246
+ lightspark_node_with_remote_signing_display_name: string;
2247
+ lightspark_node_with_remote_signing_public_key: string | undefined;
2248
+ lightspark_node_with_remote_signing_owner: {
2249
+ id: string;
2250
+ };
2251
+ lightspark_node_with_remote_signing_status: LightsparkNodeStatus | undefined;
2252
+ lightspark_node_with_remote_signing_total_balance: any;
2253
+ lightspark_node_with_remote_signing_total_local_balance: any;
2254
+ lightspark_node_with_remote_signing_local_balance: any;
2255
+ lightspark_node_with_remote_signing_remote_balance: any;
2256
+ lightspark_node_with_remote_signing_blockchain_balance: any;
2257
+ lightspark_node_with_remote_signing_uma_prescreening_utxos: string[];
2258
+ lightspark_node_with_remote_signing_balances: any;
2259
+ };
2011
2260
  }
2012
2261
 
2013
- type OutgoingPaymentsForInvoiceQueryInput = {
2262
+ /** This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve this object to receive information about a specific on-chain transaction made on the Lightning Network associated with your Lightspark Node. **/
2263
+ interface OnChainTransaction {
2264
+ /**
2265
+ * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
2266
+ * string.
2267
+ **/
2268
+ id: string;
2269
+ /** The date and time when this transaction was initiated. **/
2270
+ createdAt: string;
2271
+ /** The date and time when the entity was last updated. **/
2272
+ updatedAt: string;
2273
+ /** The current status of this transaction. **/
2274
+ status: TransactionStatus;
2275
+ /** The amount of money involved in this transaction. **/
2276
+ amount: CurrencyAmount;
2277
+ /**
2278
+ * The height of the block that included this transaction. This will be zero for unconfirmed
2279
+ * transactions.
2280
+ **/
2281
+ blockHeight: number;
2282
+ /** The Bitcoin blockchain addresses this transaction was sent to. **/
2283
+ destinationAddresses: string[];
2284
+ /** The typename of the object **/
2285
+ typename: string;
2286
+ /** The date and time when this transaction was completed or failed. **/
2287
+ resolvedAt?: string | undefined;
2288
+ /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2289
+ transactionHash?: string | undefined;
2290
+ /**
2291
+ * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
2292
+ * blockchain.
2293
+ **/
2294
+ fees?: CurrencyAmount | undefined;
2295
+ /**
2296
+ * The hash of the block that included this transaction. This will be null for unconfirmed
2297
+ * transactions.
2298
+ **/
2299
+ blockHash?: string | undefined;
2300
+ /** The number of blockchain confirmations for this transaction in real time. **/
2301
+ numConfirmations?: number | undefined;
2302
+ }
2303
+ declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
2304
+
2305
+ interface OutgoingPaymentsForInvoiceQueryInput {
2014
2306
  /** The encoded invoice that the outgoing payments paid to. **/
2015
2307
  encodedInvoice: string;
2016
2308
  /** An optional filter to only query outgoing payments of given statuses. **/
2017
- statuses?: TransactionStatus[];
2018
- };
2309
+ statuses?: TransactionStatus[] | undefined;
2310
+ }
2019
2311
 
2020
- type OutgoingPaymentsForInvoiceQueryOutput = {
2312
+ interface OutgoingPaymentsForInvoiceQueryOutput {
2021
2313
  payments: OutgoingPayment[];
2022
- };
2314
+ }
2023
2315
 
2024
- type PayInvoiceInput = {
2316
+ interface PayInvoiceInput {
2025
2317
  /** The node from where you want to send the payment. **/
2026
2318
  nodeId: string;
2027
2319
  /** The invoice you want to pay (as defined by the BOLT11 standard). **/
@@ -2034,13 +2326,13 @@ type PayInvoiceInput = {
2034
2326
  * The amount you will pay for this invoice, expressed in msats. It should ONLY be set when the
2035
2327
  * invoice amount is zero.
2036
2328
  **/
2037
- amountMsats?: number;
2038
- };
2329
+ amountMsats?: number | undefined;
2330
+ }
2039
2331
 
2040
- type PayInvoiceOutput = {
2332
+ interface PayInvoiceOutput {
2041
2333
  /** The payment that has been sent. **/
2042
2334
  paymentId: string;
2043
- };
2335
+ }
2044
2336
 
2045
2337
  /** This is an enum indicating the direction of the payment. **/
2046
2338
  declare enum PaymentDirection {
@@ -2053,15 +2345,15 @@ declare enum PaymentDirection {
2053
2345
  RECEIVED = "RECEIVED"
2054
2346
  }
2055
2347
 
2056
- type PayUmaInvoiceInput = {
2348
+ interface PayUmaInvoiceInput {
2057
2349
  nodeId: string;
2058
2350
  encodedInvoice: string;
2059
2351
  timeoutSecs: number;
2060
2352
  maximumFeesMsats: number;
2061
- amountMsats?: number;
2062
- };
2353
+ amountMsats?: number | undefined;
2354
+ }
2063
2355
 
2064
- type RegisterPaymentInput = {
2356
+ interface RegisterPaymentInput {
2065
2357
  /**
2066
2358
  * The compliance provider that is going to screen the node. You need to be a customer of the selected
2067
2359
  * provider and store the API key on the Lightspark account setting page.
@@ -2080,37 +2372,37 @@ type RegisterPaymentInput = {
2080
2372
  nodePubkey: string;
2081
2373
  /** Indicates whether this payment is an OutgoingPayment or an IncomingPayment. **/
2082
2374
  direction: PaymentDirection;
2083
- };
2375
+ }
2084
2376
 
2085
- type RegisterPaymentOutput = {
2377
+ interface RegisterPaymentOutput {
2086
2378
  paymentId: string;
2087
- };
2379
+ }
2088
2380
 
2089
- type ReleaseChannelPerCommitmentSecretInput = {
2381
+ interface ReleaseChannelPerCommitmentSecretInput {
2090
2382
  /** The unique identifier of the channel. **/
2091
2383
  channelId: string;
2092
2384
  /** The per-commitment secret to be released. **/
2093
2385
  perCommitmentSecret: string;
2094
2386
  /** The index associated with the per-commitment secret. **/
2095
2387
  perCommitmentIndex: number;
2096
- };
2388
+ }
2097
2389
 
2098
- type ReleaseChannelPerCommitmentSecretOutput = {
2390
+ interface ReleaseChannelPerCommitmentSecretOutput {
2099
2391
  /** The channel object after the per-commitment secret release operation. **/
2100
2392
  channelId: string;
2101
- };
2393
+ }
2102
2394
 
2103
- type ReleasePaymentPreimageInput = {
2395
+ interface ReleasePaymentPreimageInput {
2104
2396
  /** The invoice the preimage belongs to. **/
2105
2397
  invoiceId: string;
2106
2398
  /** The preimage to release. **/
2107
2399
  paymentPreimage: string;
2108
- };
2400
+ }
2109
2401
 
2110
- type ReleasePaymentPreimageOutput = {
2402
+ interface ReleasePaymentPreimageOutput {
2111
2403
  /** The invoice of the transaction. **/
2112
2404
  invoiceId: string;
2113
- };
2405
+ }
2114
2406
 
2115
2407
  /** This is an enum of the potential sub-event types for Remote Signing webook events. **/
2116
2408
  declare enum RemoteSigningSubEventType {
@@ -2129,7 +2421,7 @@ declare enum RemoteSigningSubEventType {
2129
2421
  REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET = "REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET"
2130
2422
  }
2131
2423
 
2132
- type RequestWithdrawalInput = {
2424
+ interface RequestWithdrawalInput {
2133
2425
  /** The node from which you'd like to make the withdrawal. **/
2134
2426
  nodeId: string;
2135
2427
  /** The bitcoin address where the withdrawal should be sent. **/
@@ -2141,12 +2433,12 @@ type RequestWithdrawalInput = {
2141
2433
  amountSats: number;
2142
2434
  /** The strategy that should be used to withdraw the funds from this node. **/
2143
2435
  withdrawalMode: WithdrawalMode;
2144
- };
2436
+ }
2145
2437
 
2146
- type RequestWithdrawalOutput = {
2438
+ interface RequestWithdrawalOutput {
2147
2439
  /** The request that is created for this withdrawal. **/
2148
2440
  requestId: string;
2149
- };
2441
+ }
2150
2442
 
2151
2443
  /** This is an enum of the potential risk ratings related to a transaction made over the Lightning Network. These risk ratings are returned from the CryptoSanctionScreeningProvider. **/
2152
2444
  declare enum RiskRating {
@@ -2161,7 +2453,7 @@ declare enum RiskRating {
2161
2453
  }
2162
2454
 
2163
2455
  /** This object represents a transaction that was forwarded through a Lightspark node on the Lightning Network, i.e., a routed transaction. You can retrieve this object to receive information about any transaction routed through your Lightspark Node. **/
2164
- type RoutingTransaction = LightningTransaction & Transaction & Entity & {
2456
+ interface RoutingTransaction {
2165
2457
  /**
2166
2458
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
2167
2459
  * string.
@@ -2178,26 +2470,26 @@ type RoutingTransaction = LightningTransaction & Transaction & Entity & {
2178
2470
  /** The typename of the object **/
2179
2471
  typename: string;
2180
2472
  /** The date and time when this transaction was completed or failed. **/
2181
- resolvedAt?: string;
2473
+ resolvedAt?: string | undefined;
2182
2474
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2183
- transactionHash?: string;
2475
+ transactionHash?: string | undefined;
2184
2476
  /** If known, the channel this transaction was received from. **/
2185
- incomingChannelId?: string;
2477
+ incomingChannelId?: string | undefined;
2186
2478
  /** If known, the channel this transaction was forwarded to. **/
2187
- outgoingChannelId?: string;
2479
+ outgoingChannelId?: string | undefined;
2188
2480
  /**
2189
2481
  * The fees collected by the node when routing this transaction. We subtract the outgoing amount to
2190
2482
  * the incoming amount to determine how much fees were collected.
2191
2483
  **/
2192
- fees?: CurrencyAmount;
2484
+ fees?: CurrencyAmount | undefined;
2193
2485
  /** If applicable, user-facing error message describing why the routing failed. **/
2194
- failureMessage?: RichText;
2486
+ failureMessage?: RichText | undefined;
2195
2487
  /** If applicable, the reason why the routing failed. **/
2196
- failureReason?: RoutingTransactionFailureReason;
2197
- };
2488
+ failureReason?: RoutingTransactionFailureReason | undefined;
2489
+ }
2198
2490
  declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransaction>;
2199
2491
 
2200
- type ScreenNodeInput = {
2492
+ interface ScreenNodeInput {
2201
2493
  /**
2202
2494
  * The compliance provider that is going to screen the node. You need to be a customer of the selected
2203
2495
  * provider and store the API key on the Lightspark account setting page.
@@ -2205,13 +2497,13 @@ type ScreenNodeInput = {
2205
2497
  provider: ComplianceProvider;
2206
2498
  /** The public key of the lightning node that needs to be screened. **/
2207
2499
  nodePubkey: string;
2208
- };
2500
+ }
2209
2501
 
2210
- type ScreenNodeOutput = {
2502
+ interface ScreenNodeOutput {
2211
2503
  rating: RiskRating;
2212
- };
2504
+ }
2213
2505
 
2214
- type SendPaymentInput = {
2506
+ interface SendPaymentInput {
2215
2507
  /** The node from where you want to send the payment. **/
2216
2508
  nodeId: string;
2217
2509
  /** The public key of the destination node. **/
@@ -2222,14 +2514,14 @@ type SendPaymentInput = {
2222
2514
  amountMsats: number;
2223
2515
  /** The maximum amount of fees that you want to pay for this payment to be sent, expressed in msats. **/
2224
2516
  maximumFeesMsats: number;
2225
- };
2517
+ }
2226
2518
 
2227
- type SendPaymentOutput = {
2519
+ interface SendPaymentOutput {
2228
2520
  /** The payment that has been sent. **/
2229
2521
  paymentId: string;
2230
- };
2522
+ }
2231
2523
 
2232
- type SetInvoicePaymentHashInput = {
2524
+ interface SetInvoicePaymentHashInput {
2233
2525
  /** The invoice that needs to be updated. **/
2234
2526
  invoiceId: string;
2235
2527
  /** The 32-byte hash of the payment preimage. **/
@@ -2238,14 +2530,14 @@ type SetInvoicePaymentHashInput = {
2238
2530
  * The 32-byte nonce used to generate the invoice preimage if applicable. It will later be included in
2239
2531
  * RELEASE_PAYMENT_PREIMAGE webhook to help recover the raw preimage.
2240
2532
  **/
2241
- preimageNonce?: string;
2242
- };
2533
+ preimageNonce?: string | undefined;
2534
+ }
2243
2535
 
2244
- type SetInvoicePaymentHashOutput = {
2536
+ interface SetInvoicePaymentHashOutput {
2245
2537
  invoiceId: string;
2246
- };
2538
+ }
2247
2539
 
2248
- type Signable = Entity & {
2540
+ interface Signable {
2249
2541
  /**
2250
2542
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
2251
2543
  * string.
@@ -2257,51 +2549,51 @@ type Signable = Entity & {
2257
2549
  updatedAt: string;
2258
2550
  /** The typename of the object **/
2259
2551
  typename: string;
2260
- };
2552
+ }
2261
2553
  declare const getSignableQuery: (id: string) => Query<Signable>;
2262
2554
 
2263
- type SignInvoiceInput = {
2555
+ interface SignInvoiceInput {
2264
2556
  /** The unique identifier of the invoice to be signed. **/
2265
2557
  invoiceId: string;
2266
2558
  /** The cryptographic signature for the invoice. **/
2267
2559
  signature: string;
2268
2560
  /** The recovery identifier for the signature. **/
2269
2561
  recoveryId: number;
2270
- };
2562
+ }
2271
2563
 
2272
- type SignInvoiceOutput = {
2564
+ interface SignInvoiceOutput {
2273
2565
  /** The signed invoice object. **/
2274
2566
  invoiceId: string;
2275
- };
2567
+ }
2276
2568
 
2277
- type SignMessagesInput = {
2569
+ interface SignMessagesInput {
2278
2570
  /** The list of the message ids and signatures. **/
2279
2571
  signatures: IdAndSignature[];
2280
- };
2572
+ }
2281
2573
 
2282
- type SignMessagesOutput = {
2574
+ interface SignMessagesOutput {
2283
2575
  /** The list of signed payloads. **/
2284
2576
  signedPayloads: SignablePayload[];
2285
- };
2577
+ }
2286
2578
 
2287
- type UpdateChannelPerCommitmentPointInput = {
2579
+ interface UpdateChannelPerCommitmentPointInput {
2288
2580
  channelId: string;
2289
2581
  perCommitmentPoint: string;
2290
2582
  perCommitmentPointIndex: number;
2291
- };
2583
+ }
2292
2584
 
2293
- type UpdateChannelPerCommitmentPointOutput = {
2585
+ interface UpdateChannelPerCommitmentPointOutput {
2294
2586
  channelId: string;
2295
- };
2587
+ }
2296
2588
 
2297
- type UpdateNodeSharedSecretInput = {
2589
+ interface UpdateNodeSharedSecretInput {
2298
2590
  nodeId: string;
2299
2591
  sharedSecret: string;
2300
- };
2592
+ }
2301
2593
 
2302
- type UpdateNodeSharedSecretOutput = {
2594
+ interface UpdateNodeSharedSecretOutput {
2303
2595
  nodeId: string;
2304
- };
2596
+ }
2305
2597
 
2306
2598
  /** This is an enum of the potential event types that can be associated with your Lightspark wallets. **/
2307
2599
  declare enum WebhookEventType {
@@ -2324,7 +2616,7 @@ declare enum WebhookEventType {
2324
2616
  }
2325
2617
 
2326
2618
  /** This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can retrieve this object to receive detailed information about any L1 withdrawal associated with your Lightspark Node or account. **/
2327
- type Withdrawal = OnChainTransaction & Transaction & Entity & {
2619
+ interface Withdrawal {
2328
2620
  /**
2329
2621
  * The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
2330
2622
  * string.
@@ -2350,22 +2642,22 @@ type Withdrawal = OnChainTransaction & Transaction & Entity & {
2350
2642
  /** The typename of the object **/
2351
2643
  typename: string;
2352
2644
  /** The date and time when this transaction was completed or failed. **/
2353
- resolvedAt?: string;
2645
+ resolvedAt?: string | undefined;
2354
2646
  /** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
2355
- transactionHash?: string;
2647
+ transactionHash?: string | undefined;
2356
2648
  /**
2357
2649
  * The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
2358
2650
  * blockchain.
2359
2651
  **/
2360
- fees?: CurrencyAmount;
2652
+ fees?: CurrencyAmount | undefined;
2361
2653
  /**
2362
2654
  * The hash of the block that included this transaction. This will be null for unconfirmed
2363
2655
  * transactions.
2364
2656
  **/
2365
- blockHash?: string;
2657
+ blockHash?: string | undefined;
2366
2658
  /** The number of blockchain confirmations for this transaction in real time. **/
2367
- numConfirmations?: number;
2368
- };
2659
+ numConfirmations?: number | undefined;
2660
+ }
2369
2661
  declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
2370
2662
 
2371
- export { IncomingPayment as $, Account as A, Balances as B, Channel as C, CreateTestModeInvoiceInput as D, CreateTestModeInvoiceOutput as E, CreateTestModePaymentInput as F, CreateTestModePaymentoutput as G, CreateUmaInvoiceInput as H, CurrencyAmount as I, CurrencyUnit as J, DeclineToSignMessagesInput as K, LightsparkClient as L, DeclineToSignMessagesOutput as M, DeleteApiTokenInput as N, DeleteApiTokenOutput as O, Deposit as P, getDepositQuery as Q, Entity as R, FeeEstimate as S, FundNodeInput as T, FundNodeOutput as U, GraphNode as V, WebhookEventType as W, Hop as X, getHopQuery as Y, HtlcAttemptFailureCode as Z, IdAndSignature as _, AccountToApiTokensConnection as a, SendPaymentOutput as a$, IncomingPaymentAttempt as a0, getIncomingPaymentAttemptQuery as a1, IncomingPaymentAttemptStatus as a2, IncomingPaymentToAttemptsConnection as a3, Invoice as a4, getInvoiceQuery as a5, InvoiceData as a6, InvoiceType as a7, LightningFeeEstimateForInvoiceInput as a8, LightningFeeEstimateForNodeInput as a9, PaymentDirection as aA, PaymentFailureReason as aB, PaymentRequest as aC, getPaymentRequestQuery as aD, PaymentRequestData as aE, PaymentRequestStatus as aF, PayUmaInvoiceInput as aG, Permission as aH, PostTransactionData as aI, RegisterPaymentInput as aJ, RegisterPaymentOutput as aK, ReleaseChannelPerCommitmentSecretInput as aL, ReleaseChannelPerCommitmentSecretOutput as aM, ReleasePaymentPreimageInput as aN, ReleasePaymentPreimageOutput as aO, RemoteSigningSubEventType as aP, RequestWithdrawalInput as aQ, RequestWithdrawalOutput as aR, RichText as aS, RiskRating as aT, RoutingTransaction as aU, getRoutingTransactionQuery as aV, RoutingTransactionFailureReason as aW, ScreenNodeInput as aX, ScreenNodeOutput as aY, Secret as aZ, SendPaymentInput as a_, LightningFeeEstimateOutput as aa, LightningTransaction as ab, getLightningTransactionQuery as ac, LightsparkNode as ad, LightsparkNodeOwner as ae, getLightsparkNodeOwnerQuery as af, LightsparkNodeStatus as ag, LightsparkNodeToChannelsConnection as ah, LightsparkNodeWithOSK as ai, LightsparkNodeWithRemoteSigning as aj, Node as ak, NodeAddress as al, NodeAddressType as am, NodeToAddressesConnection as an, OnChainTransaction as ao, getOnChainTransactionQuery as ap, OutgoingPayment as aq, OutgoingPaymentAttempt as ar, OutgoingPaymentAttemptStatus as as, OutgoingPaymentAttemptToHopsConnection as at, OutgoingPaymentsForInvoiceQueryInput as au, OutgoingPaymentsForInvoiceQueryOutput as av, OutgoingPaymentToAttemptsConnection as aw, PageInfo as ax, PayInvoiceInput as ay, PayInvoiceOutput as az, AccountToChannelsConnection as b, SetInvoicePaymentHashInput as b0, SetInvoicePaymentHashOutput as b1, Signable as b2, getSignableQuery as b3, SignablePayload as b4, getSignablePayloadQuery as b5, SignablePayloadStatus as b6, SignInvoiceInput as b7, SignInvoiceOutput as b8, SignMessagesInput as b9, SignMessagesOutput as ba, SingleNodeDashboard as bb, Transaction as bc, getTransactionQuery as bd, TransactionFailures as be, TransactionStatus as bf, TransactionType as bg, TransactionUpdate as bh, UpdateChannelPerCommitmentPointInput as bi, UpdateChannelPerCommitmentPointOutput as bj, UpdateNodeSharedSecretInput as bk, UpdateNodeSharedSecretOutput as bl, Wallet as bm, WalletStatus as bn, WalletToPaymentRequestsConnection as bo, WalletToTransactionsConnection as bp, Withdrawal as bq, getWithdrawalQuery as br, WithdrawalMode as bs, WithdrawalRequest as bt, WithdrawalRequestStatus as bu, WithdrawalRequestToChannelClosingTransactionsConnection as bv, WithdrawalRequestToChannelOpeningTransactionsConnection as bw, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BlockchainBalance as i, ChannelClosingTransaction as j, getChannelClosingTransactionQuery as k, ChannelFees as l, ChannelOpeningTransaction as m, getChannelOpeningTransactionQuery as n, ChannelSnapshot as o, ChannelStatus as p, ChannelToTransactionsConnection as q, ComplianceProvider as r, Connection as s, CreateApiTokenInput as t, CreateApiTokenOutput as u, CreateInvoiceInput as v, CreateInvoiceOutput as w, CreateLnurlInvoiceInput as x, CreateNodeWalletAddressInput as y, CreateNodeWalletAddressOutput as z };
2663
+ export { IncomingPayment as $, Account as A, Balances as B, Channel as C, CreateTestModeInvoiceInput as D, CreateTestModeInvoiceOutput as E, CreateTestModePaymentInput as F, CreateTestModePaymentoutput as G, CreateUmaInvoiceInput as H, CurrencyAmount as I, CurrencyUnit as J, DeclineToSignMessagesInput as K, LightsparkClient as L, DeclineToSignMessagesOutput as M, DeleteApiTokenInput as N, DeleteApiTokenOutput as O, Deposit as P, getDepositQuery as Q, Entity as R, FeeEstimate as S, FundNodeInput as T, FundNodeOutput as U, GraphNode as V, WebhookEventType as W, Hop as X, getHopQuery as Y, HtlcAttemptFailureCode as Z, IdAndSignature as _, AccountToApiTokensConnection as a, Secret as a$, IncomingPaymentAttempt as a0, getIncomingPaymentAttemptQuery as a1, IncomingPaymentAttemptStatus as a2, IncomingPaymentToAttemptsConnection as a3, Invoice as a4, getInvoiceQuery as a5, InvoiceData as a6, InvoiceType as a7, LightningFeeEstimateForInvoiceInput as a8, LightningFeeEstimateForNodeInput as a9, PayInvoiceInput as aA, PayInvoiceOutput as aB, PaymentDirection as aC, PaymentFailureReason as aD, PaymentRequest as aE, getPaymentRequestQuery as aF, PaymentRequestData as aG, PaymentRequestStatus as aH, PayUmaInvoiceInput as aI, Permission as aJ, PostTransactionData as aK, RegisterPaymentInput as aL, RegisterPaymentOutput as aM, ReleaseChannelPerCommitmentSecretInput as aN, ReleaseChannelPerCommitmentSecretOutput as aO, ReleasePaymentPreimageInput as aP, ReleasePaymentPreimageOutput as aQ, RemoteSigningSubEventType as aR, RequestWithdrawalInput as aS, RequestWithdrawalOutput as aT, RichText as aU, RiskRating as aV, RoutingTransaction as aW, getRoutingTransactionQuery as aX, RoutingTransactionFailureReason as aY, ScreenNodeInput as aZ, ScreenNodeOutput as a_, LightningFeeEstimateOutput as aa, LightningTransaction as ab, getLightningTransactionQuery as ac, LightsparkNode as ad, getLightsparkNodeQuery as ae, LightsparkNodeOwner as af, getLightsparkNodeOwnerQuery as ag, LightsparkNodeStatus as ah, LightsparkNodeToChannelsConnection as ai, LightsparkNodeWithOSK as aj, LightsparkNodeWithRemoteSigning as ak, Node as al, getNodeQuery as am, NodeAddress as an, NodeAddressType as ao, NodeToAddressesConnection as ap, OnChainTransaction as aq, getOnChainTransactionQuery as ar, OutgoingPayment as as, OutgoingPaymentAttempt as at, OutgoingPaymentAttemptStatus as au, OutgoingPaymentAttemptToHopsConnection as av, OutgoingPaymentsForInvoiceQueryInput as aw, OutgoingPaymentsForInvoiceQueryOutput as ax, OutgoingPaymentToAttemptsConnection as ay, PageInfo as az, AccountToChannelsConnection as b, SendPaymentInput as b0, SendPaymentOutput as b1, SetInvoicePaymentHashInput as b2, SetInvoicePaymentHashOutput as b3, Signable as b4, getSignableQuery as b5, SignablePayload as b6, getSignablePayloadQuery as b7, SignablePayloadStatus as b8, SignInvoiceInput as b9, SignInvoiceOutput as ba, SignMessagesInput as bb, SignMessagesOutput as bc, SingleNodeDashboard as bd, Transaction as be, getTransactionQuery as bf, TransactionFailures as bg, TransactionStatus as bh, TransactionType as bi, TransactionUpdate as bj, UpdateChannelPerCommitmentPointInput as bk, UpdateChannelPerCommitmentPointOutput as bl, UpdateNodeSharedSecretInput as bm, UpdateNodeSharedSecretOutput as bn, Wallet as bo, WalletStatus as bp, WalletToPaymentRequestsConnection as bq, WalletToTransactionsConnection as br, Withdrawal as bs, getWithdrawalQuery as bt, WithdrawalMode as bu, WithdrawalRequest as bv, WithdrawalRequestStatus as bw, WithdrawalRequestToChannelClosingTransactionsConnection as bx, WithdrawalRequestToChannelOpeningTransactionsConnection as by, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BlockchainBalance as i, ChannelClosingTransaction as j, getChannelClosingTransactionQuery as k, ChannelFees as l, ChannelOpeningTransaction as m, getChannelOpeningTransactionQuery as n, ChannelSnapshot as o, ChannelStatus as p, ChannelToTransactionsConnection as q, ComplianceProvider as r, Connection as s, CreateApiTokenInput as t, CreateApiTokenOutput as u, CreateInvoiceInput as v, CreateInvoiceOutput as w, CreateLnurlInvoiceInput as x, CreateNodeWalletAddressInput as y, CreateNodeWalletAddressOutput as z };