@lightsparkdev/lightspark-sdk 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +17 -0
- package/dist/{chunk-5RDIWPBE.js → chunk-D32EWIPX.js} +3 -1
- package/dist/{chunk-VTPDR6P4.js → chunk-GLL4KTUT.js} +353 -15
- package/dist/env.cjs +3 -1
- package/dist/env.d.cts +17 -0
- package/dist/env.js +2 -2
- package/dist/{index-f040db9f.d.ts → index-eb604025.d.ts} +1377 -15
- package/dist/index.cjs +682 -94
- package/dist/index.d.cts +41 -0
- package/dist/index.d.ts +3 -3
- package/dist/index.js +290 -37
- package/dist/objects/index.cjs +345 -5
- package/dist/objects/index.d.cts +4 -0
- package/dist/objects/index.d.ts +1 -1
- package/dist/objects/index.js +10 -2
- package/dist/{text-encoding-MDIPJAHL.js → text-encoding-26SMKBAQ.js} +3 -1
- package/package.json +4 -4
- package/src/auth/AccountTokenAuthProvider.ts +15 -11
- package/src/client.ts +201 -7
- package/src/graphql/ClaimUmaInvitation.ts +21 -0
- package/src/graphql/ClaimUmaInvitationWithIncentives.ts +25 -0
- package/src/graphql/CreateUmaInvitation.ts +19 -0
- package/src/graphql/CreateUmaInvitationWithIncentives.ts +23 -0
- package/src/graphql/FetchUmaInvitation.ts +15 -0
- package/src/helpers.ts +3 -1
- package/src/objects/Account.ts +8 -0
- package/src/objects/AccountToChannelsConnection.ts +5 -0
- package/src/objects/Channel.ts +31 -0
- package/src/objects/ClaimUmaInvitationInput.ts +26 -0
- package/src/objects/ClaimUmaInvitationOutput.ts +30 -0
- package/src/objects/ClaimUmaInvitationWithIncentivesInput.ts +44 -0
- package/src/objects/ClaimUmaInvitationWithIncentivesOutput.ts +33 -0
- package/src/objects/CreateInvitationWithIncentivesInput.ts +37 -0
- package/src/objects/CreateInvitationWithIncentivesOutput.ts +32 -0
- package/src/objects/CreateUmaInvitationInput.ts +22 -0
- package/src/objects/CreateUmaInvitationOutput.ts +30 -0
- package/src/objects/Entity.ts +13 -0
- package/src/objects/GraphNode.ts +28 -0
- package/src/objects/IncentivesIneligibilityReason.ts +24 -0
- package/src/objects/IncentivesStatus.ts +18 -0
- package/src/objects/IncomingPayment.ts +17 -0
- package/src/objects/LightsparkNodeWithOSK.ts +61 -0
- package/src/objects/LightsparkNodeWithRemoteSigning.ts +60 -0
- package/src/objects/OutgoingPayment.ts +20 -0
- package/src/objects/OutgoingPaymentAttempt.ts +31 -0
- package/src/objects/RegionCode.ts +510 -0
- package/src/objects/UmaInvitation.ts +113 -0
- package/src/objects/Wallet.ts +12 -0
- package/src/objects/WebhookEventType.ts +4 -0
- package/src/objects/WithdrawalRequest.ts +17 -0
- package/src/objects/index.ts +15 -0
- package/src/tests/integration/constants.ts +10 -0
- package/src/tests/integration/general-regtest.test.ts +633 -0
- package/src/tests/serialization.test.ts +5 -2
- package/src/webhooks.ts +1 -1
- package/src/tests/integration/client.test.ts +0 -207
- /package/dist/{chunk-NIMBE7W3.js → chunk-BMTV3EA2.js} +0 -0
|
@@ -279,26 +279,107 @@ declare enum TransactionType {
|
|
|
279
279
|
|
|
280
280
|
/** This is an object representing a channel on the Lightning Network. You can retrieve this object to get detailed information on a specific Lightning Network channel. **/
|
|
281
281
|
declare class Channel implements Entity {
|
|
282
|
+
/**
|
|
283
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
284
|
+
* string.
|
|
285
|
+
**/
|
|
282
286
|
readonly id: string;
|
|
287
|
+
/** The date and time when the entity was first created. **/
|
|
283
288
|
readonly createdAt: string;
|
|
289
|
+
/** The date and time when the entity was last updated. **/
|
|
284
290
|
readonly updatedAt: string;
|
|
291
|
+
/** The local Lightspark node of the channel. **/
|
|
285
292
|
readonly localNodeId: string;
|
|
293
|
+
/** The typename of the object **/
|
|
286
294
|
readonly typename: string;
|
|
295
|
+
/** The transaction that funded the channel upon channel opening. **/
|
|
287
296
|
readonly fundingTransactionId?: string | undefined;
|
|
297
|
+
/**
|
|
298
|
+
* The total amount of funds in this channel, including the channel balance on the local node, the
|
|
299
|
+
* channel balance on the remote node and the on-chain fees to close the channel.
|
|
300
|
+
**/
|
|
288
301
|
readonly capacity?: CurrencyAmount | undefined;
|
|
302
|
+
/** The channel balance on the local node. **/
|
|
289
303
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
304
|
+
/** The channel balance on the local node that is currently allocated to in-progress payments. **/
|
|
290
305
|
readonly localUnsettledBalance?: CurrencyAmount | undefined;
|
|
306
|
+
/** The channel balance on the remote node. **/
|
|
291
307
|
readonly remoteBalance?: CurrencyAmount | undefined;
|
|
308
|
+
/** The channel balance on the remote node that is currently allocated to in-progress payments. **/
|
|
292
309
|
readonly remoteUnsettledBalance?: CurrencyAmount | undefined;
|
|
310
|
+
/** The channel balance that is currently allocated to in-progress payments. **/
|
|
293
311
|
readonly unsettledBalance?: CurrencyAmount | undefined;
|
|
312
|
+
/** The total balance in this channel, including the channel balance on both local and remote nodes. **/
|
|
294
313
|
readonly totalBalance?: CurrencyAmount | undefined;
|
|
314
|
+
/** The current status of this channel. **/
|
|
295
315
|
readonly status?: ChannelStatus | undefined;
|
|
316
|
+
/**
|
|
317
|
+
* The estimated time to wait for the channel's hash timelock contract to expire when force closing
|
|
318
|
+
* the channel. It is in unit of minutes.
|
|
319
|
+
**/
|
|
296
320
|
readonly estimatedForceClosureWaitMinutes?: number | undefined;
|
|
321
|
+
/** The amount to be paid in fees for the current set of commitment transactions. **/
|
|
297
322
|
readonly commitFee?: CurrencyAmount | undefined;
|
|
323
|
+
/** The fees charged for routing payments through this channel. **/
|
|
298
324
|
readonly fees?: ChannelFees | undefined;
|
|
325
|
+
/** If known, the remote node of the channel. **/
|
|
299
326
|
readonly remoteNodeId?: string | undefined;
|
|
327
|
+
/**
|
|
328
|
+
* The unique identifier of the channel on Lightning Network, which is the location in the chain that
|
|
329
|
+
* the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
|
|
330
|
+
**/
|
|
300
331
|
readonly shortChannelId?: string | undefined;
|
|
301
|
-
constructor(
|
|
332
|
+
constructor(
|
|
333
|
+
/**
|
|
334
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
335
|
+
* string.
|
|
336
|
+
**/
|
|
337
|
+
id: string,
|
|
338
|
+
/** The date and time when the entity was first created. **/
|
|
339
|
+
createdAt: string,
|
|
340
|
+
/** The date and time when the entity was last updated. **/
|
|
341
|
+
updatedAt: string,
|
|
342
|
+
/** The local Lightspark node of the channel. **/
|
|
343
|
+
localNodeId: string,
|
|
344
|
+
/** The typename of the object **/
|
|
345
|
+
typename: string,
|
|
346
|
+
/** The transaction that funded the channel upon channel opening. **/
|
|
347
|
+
fundingTransactionId?: string | undefined,
|
|
348
|
+
/**
|
|
349
|
+
* The total amount of funds in this channel, including the channel balance on the local node, the
|
|
350
|
+
* channel balance on the remote node and the on-chain fees to close the channel.
|
|
351
|
+
**/
|
|
352
|
+
capacity?: CurrencyAmount | undefined,
|
|
353
|
+
/** The channel balance on the local node. **/
|
|
354
|
+
localBalance?: CurrencyAmount | undefined,
|
|
355
|
+
/** The channel balance on the local node that is currently allocated to in-progress payments. **/
|
|
356
|
+
localUnsettledBalance?: CurrencyAmount | undefined,
|
|
357
|
+
/** The channel balance on the remote node. **/
|
|
358
|
+
remoteBalance?: CurrencyAmount | undefined,
|
|
359
|
+
/** The channel balance on the remote node that is currently allocated to in-progress payments. **/
|
|
360
|
+
remoteUnsettledBalance?: CurrencyAmount | undefined,
|
|
361
|
+
/** The channel balance that is currently allocated to in-progress payments. **/
|
|
362
|
+
unsettledBalance?: CurrencyAmount | undefined,
|
|
363
|
+
/** The total balance in this channel, including the channel balance on both local and remote nodes. **/
|
|
364
|
+
totalBalance?: CurrencyAmount | undefined,
|
|
365
|
+
/** The current status of this channel. **/
|
|
366
|
+
status?: ChannelStatus | undefined,
|
|
367
|
+
/**
|
|
368
|
+
* The estimated time to wait for the channel's hash timelock contract to expire when force closing
|
|
369
|
+
* the channel. It is in unit of minutes.
|
|
370
|
+
**/
|
|
371
|
+
estimatedForceClosureWaitMinutes?: number | undefined,
|
|
372
|
+
/** The amount to be paid in fees for the current set of commitment transactions. **/
|
|
373
|
+
commitFee?: CurrencyAmount | undefined,
|
|
374
|
+
/** The fees charged for routing payments through this channel. **/
|
|
375
|
+
fees?: ChannelFees | undefined,
|
|
376
|
+
/** If known, the remote node of the channel. **/
|
|
377
|
+
remoteNodeId?: string | undefined,
|
|
378
|
+
/**
|
|
379
|
+
* The unique identifier of the channel on Lightning Network, which is the location in the chain that
|
|
380
|
+
* the channel was confirmed. The format is <block-height>:<tx-index>:<tx-output>.
|
|
381
|
+
**/
|
|
382
|
+
shortChannelId?: string | undefined);
|
|
302
383
|
getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
|
|
303
384
|
getTransactions(client: LightsparkClient, types?: TransactionType[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<ChannelToTransactionsConnection>;
|
|
304
385
|
static getChannelQuery(id: string): Query<Channel>;
|
|
@@ -332,9 +413,21 @@ declare class Channel implements Entity {
|
|
|
332
413
|
}
|
|
333
414
|
|
|
334
415
|
declare class AccountToChannelsConnection {
|
|
416
|
+
/**
|
|
417
|
+
* The total count of objects in this connection, using the current filters. It is different from the
|
|
418
|
+
* number of objects returned in the current page (in the `entities` field).
|
|
419
|
+
**/
|
|
335
420
|
readonly count: number;
|
|
421
|
+
/** The channels for the current page of this connection. **/
|
|
336
422
|
readonly entities: Channel[];
|
|
337
|
-
constructor(
|
|
423
|
+
constructor(
|
|
424
|
+
/**
|
|
425
|
+
* The total count of objects in this connection, using the current filters. It is different from the
|
|
426
|
+
* number of objects returned in the current page (in the `entities` field).
|
|
427
|
+
**/
|
|
428
|
+
count: number,
|
|
429
|
+
/** The channels for the current page of this connection. **/
|
|
430
|
+
entities: Channel[]);
|
|
338
431
|
toJson(): {
|
|
339
432
|
account_to_channels_connection_count: number;
|
|
340
433
|
account_to_channels_connection_entities: {
|
|
@@ -741,16 +834,49 @@ interface WalletToTransactionsConnection {
|
|
|
741
834
|
|
|
742
835
|
/** 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. **/
|
|
743
836
|
declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
837
|
+
/**
|
|
838
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
839
|
+
* string.
|
|
840
|
+
**/
|
|
744
841
|
readonly id: string;
|
|
842
|
+
/** The date and time when the entity was first created. **/
|
|
745
843
|
readonly createdAt: string;
|
|
844
|
+
/** The date and time when the entity was last updated. **/
|
|
746
845
|
readonly updatedAt: string;
|
|
846
|
+
/** The unique identifier of this wallet, as provided by the Lightspark Customer during login. **/
|
|
747
847
|
readonly thirdPartyIdentifier: string;
|
|
848
|
+
/** The status of this wallet. **/
|
|
748
849
|
readonly status: WalletStatus;
|
|
850
|
+
/** The typename of the object **/
|
|
749
851
|
readonly typename: string;
|
|
852
|
+
/** The date and time when the wallet user last logged in. **/
|
|
750
853
|
readonly lastLoginAt?: string | undefined;
|
|
854
|
+
/** The balances that describe the funds in this wallet. **/
|
|
751
855
|
readonly balances?: Balances | undefined;
|
|
856
|
+
/** The account this wallet belongs to. **/
|
|
752
857
|
readonly accountId?: string | undefined;
|
|
753
|
-
constructor(
|
|
858
|
+
constructor(
|
|
859
|
+
/**
|
|
860
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
861
|
+
* string.
|
|
862
|
+
**/
|
|
863
|
+
id: string,
|
|
864
|
+
/** The date and time when the entity was first created. **/
|
|
865
|
+
createdAt: string,
|
|
866
|
+
/** The date and time when the entity was last updated. **/
|
|
867
|
+
updatedAt: string,
|
|
868
|
+
/** The unique identifier of this wallet, as provided by the Lightspark Customer during login. **/
|
|
869
|
+
thirdPartyIdentifier: string,
|
|
870
|
+
/** The status of this wallet. **/
|
|
871
|
+
status: WalletStatus,
|
|
872
|
+
/** The typename of the object **/
|
|
873
|
+
typename: string,
|
|
874
|
+
/** The date and time when the wallet user last logged in. **/
|
|
875
|
+
lastLoginAt?: string | undefined,
|
|
876
|
+
/** The balances that describe the funds in this wallet. **/
|
|
877
|
+
balances?: Balances | undefined,
|
|
878
|
+
/** The account this wallet belongs to. **/
|
|
879
|
+
accountId?: string | undefined);
|
|
754
880
|
getTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined, statuses?: TransactionStatus[] | undefined, types?: TransactionType[] | undefined): Promise<WalletToTransactionsConnection>;
|
|
755
881
|
getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<WalletToPaymentRequestsConnection>;
|
|
756
882
|
getTotalAmountReceived(client: LightsparkClient, createdAfterDate?: string | undefined, createdBeforeDate?: string | undefined): Promise<CurrencyAmount>;
|
|
@@ -824,12 +950,33 @@ interface TransactionFailures {
|
|
|
824
950
|
|
|
825
951
|
/** 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. **/
|
|
826
952
|
declare class Account implements LightsparkNodeOwner, Entity {
|
|
953
|
+
/**
|
|
954
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
955
|
+
* string.
|
|
956
|
+
**/
|
|
827
957
|
readonly id: string;
|
|
958
|
+
/** The date and time when the entity was first created. **/
|
|
828
959
|
readonly createdAt: string;
|
|
960
|
+
/** The date and time when the entity was last updated. **/
|
|
829
961
|
readonly updatedAt: string;
|
|
962
|
+
/** The typename of the object **/
|
|
830
963
|
readonly typename: string;
|
|
964
|
+
/** The name of this account. **/
|
|
831
965
|
readonly name?: string | undefined;
|
|
832
|
-
constructor(
|
|
966
|
+
constructor(
|
|
967
|
+
/**
|
|
968
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
969
|
+
* string.
|
|
970
|
+
**/
|
|
971
|
+
id: string,
|
|
972
|
+
/** The date and time when the entity was first created. **/
|
|
973
|
+
createdAt: string,
|
|
974
|
+
/** The date and time when the entity was last updated. **/
|
|
975
|
+
updatedAt: string,
|
|
976
|
+
/** The typename of the object **/
|
|
977
|
+
typename: string,
|
|
978
|
+
/** The name of this account. **/
|
|
979
|
+
name?: string | undefined);
|
|
833
980
|
getApiTokens(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<AccountToApiTokensConnection>;
|
|
834
981
|
getBlockchainBalance(client: LightsparkClient, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<BlockchainBalance | null>;
|
|
835
982
|
getConductivity(client: LightsparkClient, bitcoinNetworks?: BitcoinNetwork[] | undefined, nodeIds?: string[] | undefined): Promise<number>;
|
|
@@ -957,18 +1104,63 @@ interface PostTransactionData {
|
|
|
957
1104
|
|
|
958
1105
|
/** 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. **/
|
|
959
1106
|
declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
|
|
1107
|
+
/**
|
|
1108
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
1109
|
+
* string.
|
|
1110
|
+
**/
|
|
960
1111
|
readonly id: string;
|
|
1112
|
+
/** The date and time when this transaction was initiated. **/
|
|
961
1113
|
readonly createdAt: string;
|
|
1114
|
+
/** The date and time when the entity was last updated. **/
|
|
962
1115
|
readonly updatedAt: string;
|
|
1116
|
+
/** The current status of this transaction. **/
|
|
963
1117
|
readonly status: TransactionStatus;
|
|
1118
|
+
/** The amount of money involved in this transaction. **/
|
|
964
1119
|
readonly amount: CurrencyAmount;
|
|
1120
|
+
/** The recipient Lightspark node this payment was sent to. **/
|
|
965
1121
|
readonly destinationId: string;
|
|
1122
|
+
/** The typename of the object **/
|
|
966
1123
|
readonly typename: string;
|
|
1124
|
+
/** The date and time when this transaction was completed or failed. **/
|
|
967
1125
|
readonly resolvedAt?: string | undefined;
|
|
1126
|
+
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
968
1127
|
readonly transactionHash?: string | undefined;
|
|
1128
|
+
/**
|
|
1129
|
+
* The optional payment request for this incoming payment, which will be null if the payment is sent
|
|
1130
|
+
* through keysend.
|
|
1131
|
+
**/
|
|
969
1132
|
readonly paymentRequestId?: string | undefined;
|
|
1133
|
+
/** The post transaction data which can be used in KYT payment registration. **/
|
|
970
1134
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
971
|
-
constructor(
|
|
1135
|
+
constructor(
|
|
1136
|
+
/**
|
|
1137
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
1138
|
+
* string.
|
|
1139
|
+
**/
|
|
1140
|
+
id: string,
|
|
1141
|
+
/** The date and time when this transaction was initiated. **/
|
|
1142
|
+
createdAt: string,
|
|
1143
|
+
/** The date and time when the entity was last updated. **/
|
|
1144
|
+
updatedAt: string,
|
|
1145
|
+
/** The current status of this transaction. **/
|
|
1146
|
+
status: TransactionStatus,
|
|
1147
|
+
/** The amount of money involved in this transaction. **/
|
|
1148
|
+
amount: CurrencyAmount,
|
|
1149
|
+
/** The recipient Lightspark node this payment was sent to. **/
|
|
1150
|
+
destinationId: string,
|
|
1151
|
+
/** The typename of the object **/
|
|
1152
|
+
typename: string,
|
|
1153
|
+
/** The date and time when this transaction was completed or failed. **/
|
|
1154
|
+
resolvedAt?: string | undefined,
|
|
1155
|
+
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1156
|
+
transactionHash?: string | undefined,
|
|
1157
|
+
/**
|
|
1158
|
+
* The optional payment request for this incoming payment, which will be null if the payment is sent
|
|
1159
|
+
* through keysend.
|
|
1160
|
+
**/
|
|
1161
|
+
paymentRequestId?: string | undefined,
|
|
1162
|
+
/** The post transaction data which can be used in KYT payment registration. **/
|
|
1163
|
+
umaPostTransactionData?: PostTransactionData[] | undefined);
|
|
972
1164
|
getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
|
|
973
1165
|
static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
|
|
974
1166
|
toJson(): {
|
|
@@ -1196,19 +1388,87 @@ interface OutgoingPaymentAttemptToHopsConnection {
|
|
|
1196
1388
|
|
|
1197
1389
|
/** 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. **/
|
|
1198
1390
|
declare class OutgoingPaymentAttempt implements Entity {
|
|
1391
|
+
/**
|
|
1392
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
1393
|
+
* string.
|
|
1394
|
+
**/
|
|
1199
1395
|
readonly id: string;
|
|
1396
|
+
/** The date and time when the entity was first created. **/
|
|
1200
1397
|
readonly createdAt: string;
|
|
1398
|
+
/** The date and time when the entity was last updated. **/
|
|
1201
1399
|
readonly updatedAt: string;
|
|
1400
|
+
/** The status of an outgoing payment attempt. **/
|
|
1202
1401
|
readonly status: OutgoingPaymentAttemptStatus;
|
|
1402
|
+
/** The date and time when the attempt was initiated. **/
|
|
1403
|
+
readonly attemptedAt: string;
|
|
1404
|
+
/** The outgoing payment for this attempt. **/
|
|
1203
1405
|
readonly outgoingPaymentId: string;
|
|
1406
|
+
/** The typename of the object **/
|
|
1204
1407
|
readonly typename: string;
|
|
1408
|
+
/** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
|
|
1205
1409
|
readonly failureCode?: HtlcAttemptFailureCode | undefined;
|
|
1410
|
+
/**
|
|
1411
|
+
* If the payment attempt failed, then this contains the index of the hop at which the problem
|
|
1412
|
+
* occurred.
|
|
1413
|
+
**/
|
|
1206
1414
|
readonly failureSourceIndex?: number | undefined;
|
|
1415
|
+
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1207
1416
|
readonly resolvedAt?: string | undefined;
|
|
1417
|
+
/**
|
|
1418
|
+
* The total amount of funds required to complete a payment over this route. This value includes the
|
|
1419
|
+
* cumulative fees for each hop. As a result, the attempt extended to the first-hop in the route will
|
|
1420
|
+
* need to have at least this much value, otherwise the route will fail at an intermediate node due to
|
|
1421
|
+
* an insufficient amount.
|
|
1422
|
+
**/
|
|
1208
1423
|
readonly amount?: CurrencyAmount | undefined;
|
|
1424
|
+
/**
|
|
1425
|
+
* The sum of the fees paid at each hop within the route of this attempt. In the case of a one-hop
|
|
1426
|
+
* payment, this value will be zero as we don't need to pay a fee to ourselves.
|
|
1427
|
+
**/
|
|
1209
1428
|
readonly fees?: CurrencyAmount | undefined;
|
|
1429
|
+
/** The channel snapshot at the time the outgoing payment attempt was made. **/
|
|
1210
1430
|
readonly channelSnapshot?: ChannelSnapshot | undefined;
|
|
1211
|
-
constructor(
|
|
1431
|
+
constructor(
|
|
1432
|
+
/**
|
|
1433
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
1434
|
+
* string.
|
|
1435
|
+
**/
|
|
1436
|
+
id: string,
|
|
1437
|
+
/** The date and time when the entity was first created. **/
|
|
1438
|
+
createdAt: string,
|
|
1439
|
+
/** The date and time when the entity was last updated. **/
|
|
1440
|
+
updatedAt: string,
|
|
1441
|
+
/** The status of an outgoing payment attempt. **/
|
|
1442
|
+
status: OutgoingPaymentAttemptStatus,
|
|
1443
|
+
/** The date and time when the attempt was initiated. **/
|
|
1444
|
+
attemptedAt: string,
|
|
1445
|
+
/** The outgoing payment for this attempt. **/
|
|
1446
|
+
outgoingPaymentId: string,
|
|
1447
|
+
/** The typename of the object **/
|
|
1448
|
+
typename: string,
|
|
1449
|
+
/** If the payment attempt failed, then this contains the Bolt #4 failure code. **/
|
|
1450
|
+
failureCode?: HtlcAttemptFailureCode | undefined,
|
|
1451
|
+
/**
|
|
1452
|
+
* If the payment attempt failed, then this contains the index of the hop at which the problem
|
|
1453
|
+
* occurred.
|
|
1454
|
+
**/
|
|
1455
|
+
failureSourceIndex?: number | undefined,
|
|
1456
|
+
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1457
|
+
resolvedAt?: string | undefined,
|
|
1458
|
+
/**
|
|
1459
|
+
* The total amount of funds required to complete a payment over this route. This value includes the
|
|
1460
|
+
* cumulative fees for each hop. As a result, the attempt extended to the first-hop in the route will
|
|
1461
|
+
* need to have at least this much value, otherwise the route will fail at an intermediate node due to
|
|
1462
|
+
* an insufficient amount.
|
|
1463
|
+
**/
|
|
1464
|
+
amount?: CurrencyAmount | undefined,
|
|
1465
|
+
/**
|
|
1466
|
+
* The sum of the fees paid at each hop within the route of this attempt. In the case of a one-hop
|
|
1467
|
+
* payment, this value will be zero as we don't need to pay a fee to ourselves.
|
|
1468
|
+
**/
|
|
1469
|
+
fees?: CurrencyAmount | undefined,
|
|
1470
|
+
/** The channel snapshot at the time the outgoing payment attempt was made. **/
|
|
1471
|
+
channelSnapshot?: ChannelSnapshot | undefined);
|
|
1212
1472
|
getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
|
|
1213
1473
|
static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
|
|
1214
1474
|
toJson(): {
|
|
@@ -1219,6 +1479,7 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1219
1479
|
outgoing_payment_attempt_status: OutgoingPaymentAttemptStatus;
|
|
1220
1480
|
outgoing_payment_attempt_failure_code: HtlcAttemptFailureCode | undefined;
|
|
1221
1481
|
outgoing_payment_attempt_failure_source_index: number | undefined;
|
|
1482
|
+
outgoing_payment_attempt_attempted_at: string;
|
|
1222
1483
|
outgoing_payment_attempt_resolved_at: string | undefined;
|
|
1223
1484
|
outgoing_payment_attempt_amount: any;
|
|
1224
1485
|
outgoing_payment_attempt_fees: any;
|
|
@@ -1250,23 +1511,77 @@ interface RichText {
|
|
|
1250
1511
|
|
|
1251
1512
|
/** 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. **/
|
|
1252
1513
|
declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
|
|
1514
|
+
/**
|
|
1515
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
1516
|
+
* string.
|
|
1517
|
+
**/
|
|
1253
1518
|
readonly id: string;
|
|
1519
|
+
/** The date and time when this transaction was initiated. **/
|
|
1254
1520
|
readonly createdAt: string;
|
|
1521
|
+
/** The date and time when the entity was last updated. **/
|
|
1255
1522
|
readonly updatedAt: string;
|
|
1523
|
+
/** The current status of this transaction. **/
|
|
1256
1524
|
readonly status: TransactionStatus;
|
|
1525
|
+
/** The amount of money involved in this transaction. **/
|
|
1257
1526
|
readonly amount: CurrencyAmount;
|
|
1527
|
+
/** The Lightspark node this payment originated from. **/
|
|
1258
1528
|
readonly originId: string;
|
|
1529
|
+
/** The typename of the object **/
|
|
1259
1530
|
readonly typename: string;
|
|
1531
|
+
/** The date and time when this transaction was completed or failed. **/
|
|
1260
1532
|
readonly resolvedAt?: string | undefined;
|
|
1533
|
+
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1261
1534
|
readonly transactionHash?: string | undefined;
|
|
1535
|
+
/** If known, the final recipient node this payment was sent to. **/
|
|
1262
1536
|
readonly destinationId?: string | undefined;
|
|
1537
|
+
/** The fees paid by the sender node to send the payment. **/
|
|
1263
1538
|
readonly fees?: CurrencyAmount | undefined;
|
|
1539
|
+
/** The data of the payment request that was paid by this transaction, if known. **/
|
|
1264
1540
|
readonly paymentRequestData?: PaymentRequestData | undefined;
|
|
1541
|
+
/** If applicable, the reason why the payment failed. **/
|
|
1265
1542
|
readonly failureReason?: PaymentFailureReason | undefined;
|
|
1543
|
+
/** If applicable, user-facing error message describing why the payment failed. **/
|
|
1266
1544
|
readonly failureMessage?: RichText | undefined;
|
|
1545
|
+
/** The post transaction data which can be used in KYT payment registration. **/
|
|
1267
1546
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
1547
|
+
/** The preimage of the payment. **/
|
|
1268
1548
|
readonly paymentPreimage?: string | undefined;
|
|
1269
|
-
constructor(
|
|
1549
|
+
constructor(
|
|
1550
|
+
/**
|
|
1551
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
1552
|
+
* string.
|
|
1553
|
+
**/
|
|
1554
|
+
id: string,
|
|
1555
|
+
/** The date and time when this transaction was initiated. **/
|
|
1556
|
+
createdAt: string,
|
|
1557
|
+
/** The date and time when the entity was last updated. **/
|
|
1558
|
+
updatedAt: string,
|
|
1559
|
+
/** The current status of this transaction. **/
|
|
1560
|
+
status: TransactionStatus,
|
|
1561
|
+
/** The amount of money involved in this transaction. **/
|
|
1562
|
+
amount: CurrencyAmount,
|
|
1563
|
+
/** The Lightspark node this payment originated from. **/
|
|
1564
|
+
originId: string,
|
|
1565
|
+
/** The typename of the object **/
|
|
1566
|
+
typename: string,
|
|
1567
|
+
/** The date and time when this transaction was completed or failed. **/
|
|
1568
|
+
resolvedAt?: string | undefined,
|
|
1569
|
+
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1570
|
+
transactionHash?: string | undefined,
|
|
1571
|
+
/** If known, the final recipient node this payment was sent to. **/
|
|
1572
|
+
destinationId?: string | undefined,
|
|
1573
|
+
/** The fees paid by the sender node to send the payment. **/
|
|
1574
|
+
fees?: CurrencyAmount | undefined,
|
|
1575
|
+
/** The data of the payment request that was paid by this transaction, if known. **/
|
|
1576
|
+
paymentRequestData?: PaymentRequestData | undefined,
|
|
1577
|
+
/** If applicable, the reason why the payment failed. **/
|
|
1578
|
+
failureReason?: PaymentFailureReason | undefined,
|
|
1579
|
+
/** If applicable, user-facing error message describing why the payment failed. **/
|
|
1580
|
+
failureMessage?: RichText | undefined,
|
|
1581
|
+
/** The post transaction data which can be used in KYT payment registration. **/
|
|
1582
|
+
umaPostTransactionData?: PostTransactionData[] | undefined,
|
|
1583
|
+
/** The preimage of the payment. **/
|
|
1584
|
+
paymentPreimage?: string | undefined);
|
|
1270
1585
|
getAttempts(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentToAttemptsConnection>;
|
|
1271
1586
|
static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
|
|
1272
1587
|
toJson(): {
|
|
@@ -1293,6 +1608,513 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1293
1608
|
};
|
|
1294
1609
|
}
|
|
1295
1610
|
|
|
1611
|
+
/** The alpha-2 representation of a country, as defined by the ISO 3166-1 standard. **/
|
|
1612
|
+
declare enum RegionCode {
|
|
1613
|
+
/**
|
|
1614
|
+
* This is an enum value that represents values that could be added in the future.
|
|
1615
|
+
* Clients should support unknown values as more of them could be added without notice.
|
|
1616
|
+
*/
|
|
1617
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1618
|
+
/** The code representing the country of Afghanistan. **/
|
|
1619
|
+
AF = "AF",
|
|
1620
|
+
/** The code representing the country of Åland Islands. **/
|
|
1621
|
+
AX = "AX",
|
|
1622
|
+
/** The code representing the country of Albania. **/
|
|
1623
|
+
AL = "AL",
|
|
1624
|
+
/** The code representing the country of Algeria. **/
|
|
1625
|
+
DZ = "DZ",
|
|
1626
|
+
/** The code representing the country of American Samoa. **/
|
|
1627
|
+
AS = "AS",
|
|
1628
|
+
/** The code representing the country of Andorra. **/
|
|
1629
|
+
AD = "AD",
|
|
1630
|
+
/** The code representing the country of Angola. **/
|
|
1631
|
+
AO = "AO",
|
|
1632
|
+
/** The code representing the country of Anguilla. **/
|
|
1633
|
+
AI = "AI",
|
|
1634
|
+
/** The code representing the country of Antarctica. **/
|
|
1635
|
+
AQ = "AQ",
|
|
1636
|
+
/** The code representing the country of Antigua and Barbuda. **/
|
|
1637
|
+
AG = "AG",
|
|
1638
|
+
/** The code representing the country of Argentina. **/
|
|
1639
|
+
AR = "AR",
|
|
1640
|
+
/** The code representing the country of Armenia. **/
|
|
1641
|
+
AM = "AM",
|
|
1642
|
+
/** The code representing the country of Aruba. **/
|
|
1643
|
+
AW = "AW",
|
|
1644
|
+
/** The code representing the country of Australia. **/
|
|
1645
|
+
AU = "AU",
|
|
1646
|
+
/** The code representing the country of Austria. **/
|
|
1647
|
+
AT = "AT",
|
|
1648
|
+
/** The code representing the country of Azerbaijan. **/
|
|
1649
|
+
AZ = "AZ",
|
|
1650
|
+
/** The code representing the country of Bahamas. **/
|
|
1651
|
+
BS = "BS",
|
|
1652
|
+
/** The code representing the country of Bahrain. **/
|
|
1653
|
+
BH = "BH",
|
|
1654
|
+
/** The code representing the country of Bangladesh. **/
|
|
1655
|
+
BD = "BD",
|
|
1656
|
+
/** The code representing the country of Barbados. **/
|
|
1657
|
+
BB = "BB",
|
|
1658
|
+
/** The code representing the country of Belarus. **/
|
|
1659
|
+
BY = "BY",
|
|
1660
|
+
/** The code representing the country of Belgium. **/
|
|
1661
|
+
BE = "BE",
|
|
1662
|
+
/** The code representing the country of Belize. **/
|
|
1663
|
+
BZ = "BZ",
|
|
1664
|
+
/** The code representing the country of Benin. **/
|
|
1665
|
+
BJ = "BJ",
|
|
1666
|
+
/** The code representing the country of Bermuda. **/
|
|
1667
|
+
BM = "BM",
|
|
1668
|
+
/** The code representing the country of Bhutan. **/
|
|
1669
|
+
BT = "BT",
|
|
1670
|
+
/** The code representing the country of The Plurinational State of Bolivia. **/
|
|
1671
|
+
BO = "BO",
|
|
1672
|
+
/** The code representing the country of Bonaire, Sint Eustatius, and Saba. **/
|
|
1673
|
+
BQ = "BQ",
|
|
1674
|
+
/** The code representing the country of Bosnia and Herzegovina. **/
|
|
1675
|
+
BA = "BA",
|
|
1676
|
+
/** The code representing the country of Botswana. **/
|
|
1677
|
+
BW = "BW",
|
|
1678
|
+
/** The code representing the country of Bouvet Island. **/
|
|
1679
|
+
BV = "BV",
|
|
1680
|
+
/** The code representing the country of Brazil. **/
|
|
1681
|
+
BR = "BR",
|
|
1682
|
+
/** The code representing the country of British Indian Ocean Territory. **/
|
|
1683
|
+
IO = "IO",
|
|
1684
|
+
/** The code representing the country of Brunei Darussalam. **/
|
|
1685
|
+
BN = "BN",
|
|
1686
|
+
/** The code representing the country of Bulgaria. **/
|
|
1687
|
+
BG = "BG",
|
|
1688
|
+
/** The code representing the country of Burkina Faso. **/
|
|
1689
|
+
BF = "BF",
|
|
1690
|
+
/** The code representing the country of Burundi. **/
|
|
1691
|
+
BI = "BI",
|
|
1692
|
+
/** The code representing the country of Cambodia. **/
|
|
1693
|
+
KH = "KH",
|
|
1694
|
+
/** The code representing the country of Cameroon. **/
|
|
1695
|
+
CM = "CM",
|
|
1696
|
+
/** The code representing the country of Canada. **/
|
|
1697
|
+
CA = "CA",
|
|
1698
|
+
/** The code representing the country of Cape Verde. **/
|
|
1699
|
+
CV = "CV",
|
|
1700
|
+
/** The code representing the country of Cayman Islands. **/
|
|
1701
|
+
KY = "KY",
|
|
1702
|
+
/** The code representing the country of Central African Republic. **/
|
|
1703
|
+
CF = "CF",
|
|
1704
|
+
/** The code representing the country of Chad. **/
|
|
1705
|
+
TD = "TD",
|
|
1706
|
+
/** The code representing the country of Chile. **/
|
|
1707
|
+
CL = "CL",
|
|
1708
|
+
/** The code representing the country of China. **/
|
|
1709
|
+
CN = "CN",
|
|
1710
|
+
/** The code representing the country of Christmas Island. **/
|
|
1711
|
+
CX = "CX",
|
|
1712
|
+
/** The code representing the country of Cocos (Keeling) Islands. **/
|
|
1713
|
+
CC = "CC",
|
|
1714
|
+
/** The code representing the country of Colombia. **/
|
|
1715
|
+
CO = "CO",
|
|
1716
|
+
/** The code representing the country of Comoros. **/
|
|
1717
|
+
KM = "KM",
|
|
1718
|
+
/** The code representing the country of Congo. **/
|
|
1719
|
+
CG = "CG",
|
|
1720
|
+
/** The code representing the country of The Democratic Republic of the Congo. **/
|
|
1721
|
+
CD = "CD",
|
|
1722
|
+
/** The code representing the country of Cook Islands. **/
|
|
1723
|
+
CK = "CK",
|
|
1724
|
+
/** The code representing the country of Costa Rica. **/
|
|
1725
|
+
CR = "CR",
|
|
1726
|
+
/** The code representing the country of Côte d'Ivoire. **/
|
|
1727
|
+
CI = "CI",
|
|
1728
|
+
/** The code representing the country of Croatia. **/
|
|
1729
|
+
HR = "HR",
|
|
1730
|
+
/** The code representing the country of Cuba. **/
|
|
1731
|
+
CU = "CU",
|
|
1732
|
+
/** The code representing the country of Curaçao. **/
|
|
1733
|
+
CW = "CW",
|
|
1734
|
+
/** The code representing the country of Cyprus. **/
|
|
1735
|
+
CY = "CY",
|
|
1736
|
+
/** The code representing the country of Czech Republic. **/
|
|
1737
|
+
CZ = "CZ",
|
|
1738
|
+
/** The code representing the country of Denmark. **/
|
|
1739
|
+
DK = "DK",
|
|
1740
|
+
/** The code representing the country of Djibouti. **/
|
|
1741
|
+
DJ = "DJ",
|
|
1742
|
+
/** The code representing the country of Dominica. **/
|
|
1743
|
+
DM = "DM",
|
|
1744
|
+
/** The code representing the country of Dominican Republic. **/
|
|
1745
|
+
DO = "DO",
|
|
1746
|
+
/** The code representing the country of Ecuador. **/
|
|
1747
|
+
EC = "EC",
|
|
1748
|
+
/** The code representing the country of Egypt. **/
|
|
1749
|
+
EG = "EG",
|
|
1750
|
+
/** The code representing the country of El Salvador. **/
|
|
1751
|
+
SV = "SV",
|
|
1752
|
+
/** The code representing the country of Equatorial Guinea. **/
|
|
1753
|
+
GQ = "GQ",
|
|
1754
|
+
/** The code representing the country of Eritrea. **/
|
|
1755
|
+
ER = "ER",
|
|
1756
|
+
/** The code representing the country of Estonia. **/
|
|
1757
|
+
EE = "EE",
|
|
1758
|
+
/** The code representing the country of Ethiopia. **/
|
|
1759
|
+
ET = "ET",
|
|
1760
|
+
/** The code representing the country of Falkland Islands (Malvinas). **/
|
|
1761
|
+
FK = "FK",
|
|
1762
|
+
/** The code representing the country of Faroe Islands. **/
|
|
1763
|
+
FO = "FO",
|
|
1764
|
+
/** The code representing the country of Fiji. **/
|
|
1765
|
+
FJ = "FJ",
|
|
1766
|
+
/** The code representing the country of Finland. **/
|
|
1767
|
+
FI = "FI",
|
|
1768
|
+
/** The code representing the country of France. **/
|
|
1769
|
+
FR = "FR",
|
|
1770
|
+
/** The code representing the country of French Guiana. **/
|
|
1771
|
+
GF = "GF",
|
|
1772
|
+
/** The code representing the country of French Polynesia. **/
|
|
1773
|
+
PF = "PF",
|
|
1774
|
+
/** The code representing the country of French Southern Territories. **/
|
|
1775
|
+
TF = "TF",
|
|
1776
|
+
/** The code representing the country of Gabon. **/
|
|
1777
|
+
GA = "GA",
|
|
1778
|
+
/** The code representing the country of Gambia. **/
|
|
1779
|
+
GM = "GM",
|
|
1780
|
+
/** The code representing the country of Georgia. **/
|
|
1781
|
+
GE = "GE",
|
|
1782
|
+
/** The code representing the country of Germany. **/
|
|
1783
|
+
DE = "DE",
|
|
1784
|
+
/** The code representing the country of Ghana. **/
|
|
1785
|
+
GH = "GH",
|
|
1786
|
+
/** The code representing the country of Gibraltar. **/
|
|
1787
|
+
GI = "GI",
|
|
1788
|
+
/** The code representing the country of Greece. **/
|
|
1789
|
+
GR = "GR",
|
|
1790
|
+
/** The code representing the country of Greenland. **/
|
|
1791
|
+
GL = "GL",
|
|
1792
|
+
/** The code representing the country of Grenada. **/
|
|
1793
|
+
GD = "GD",
|
|
1794
|
+
/** The code representing the country of Guadeloupe. **/
|
|
1795
|
+
GP = "GP",
|
|
1796
|
+
/** The code representing the country of Guam. **/
|
|
1797
|
+
GU = "GU",
|
|
1798
|
+
/** The code representing the country of Guatemala. **/
|
|
1799
|
+
GT = "GT",
|
|
1800
|
+
/** The code representing the country of Guernsey. **/
|
|
1801
|
+
GG = "GG",
|
|
1802
|
+
/** The code representing the country of Guinea. **/
|
|
1803
|
+
GN = "GN",
|
|
1804
|
+
/** The code representing the country of Guinea-Bissau. **/
|
|
1805
|
+
GW = "GW",
|
|
1806
|
+
/** The code representing the country of Guyana. **/
|
|
1807
|
+
GY = "GY",
|
|
1808
|
+
/** The code representing the country of Haiti. **/
|
|
1809
|
+
HT = "HT",
|
|
1810
|
+
/** The code representing the country of Heard Island and McDonald Islands. **/
|
|
1811
|
+
HM = "HM",
|
|
1812
|
+
/** The code representing the country of Holy See (Vatican City State). **/
|
|
1813
|
+
VA = "VA",
|
|
1814
|
+
/** The code representing the country of Honduras. **/
|
|
1815
|
+
HN = "HN",
|
|
1816
|
+
/** The code representing the country of Hong Kong. **/
|
|
1817
|
+
HK = "HK",
|
|
1818
|
+
/** The code representing the country of Hungary. **/
|
|
1819
|
+
HU = "HU",
|
|
1820
|
+
/** The code representing the country of Iceland. **/
|
|
1821
|
+
IS = "IS",
|
|
1822
|
+
/** The code representing the country of India. **/
|
|
1823
|
+
IN = "IN",
|
|
1824
|
+
/** The code representing the country of Indonesia. **/
|
|
1825
|
+
ID = "ID",
|
|
1826
|
+
/** The code representing the country of Islamic Republic of Iran. **/
|
|
1827
|
+
IR = "IR",
|
|
1828
|
+
/** The code representing the country of Iraq. **/
|
|
1829
|
+
IQ = "IQ",
|
|
1830
|
+
/** The code representing the country of Ireland. **/
|
|
1831
|
+
IE = "IE",
|
|
1832
|
+
/** The code representing the country of Isle of Man. **/
|
|
1833
|
+
IM = "IM",
|
|
1834
|
+
/** The code representing the country of Israel. **/
|
|
1835
|
+
IL = "IL",
|
|
1836
|
+
/** The code representing the country of Italy. **/
|
|
1837
|
+
IT = "IT",
|
|
1838
|
+
/** The code representing the country of Jamaica. **/
|
|
1839
|
+
JM = "JM",
|
|
1840
|
+
/** The code representing the country of Japan. **/
|
|
1841
|
+
JP = "JP",
|
|
1842
|
+
/** The code representing the country of Jersey. **/
|
|
1843
|
+
JE = "JE",
|
|
1844
|
+
/** The code representing the country of Jordan. **/
|
|
1845
|
+
JO = "JO",
|
|
1846
|
+
/** The code representing the country of Kazakhstan. **/
|
|
1847
|
+
KZ = "KZ",
|
|
1848
|
+
/** The code representing the country of Kenya. **/
|
|
1849
|
+
KE = "KE",
|
|
1850
|
+
/** The code representing the country of Kiribati. **/
|
|
1851
|
+
KI = "KI",
|
|
1852
|
+
/** The code representing the country of Democratic People's Republic ofKorea. **/
|
|
1853
|
+
KP = "KP",
|
|
1854
|
+
/** The code representing the country of Republic of Korea. **/
|
|
1855
|
+
KR = "KR",
|
|
1856
|
+
/** The code representing the country of Kuwait. **/
|
|
1857
|
+
KW = "KW",
|
|
1858
|
+
/** The code representing the country of Kyrgyzstan. **/
|
|
1859
|
+
KG = "KG",
|
|
1860
|
+
/** The code representing the country of Lao People's Democratic Republic. **/
|
|
1861
|
+
LA = "LA",
|
|
1862
|
+
/** The code representing the country of Latvia. **/
|
|
1863
|
+
LV = "LV",
|
|
1864
|
+
/** The code representing the country of Lebanon. **/
|
|
1865
|
+
LB = "LB",
|
|
1866
|
+
/** The code representing the country of Lesotho. **/
|
|
1867
|
+
LS = "LS",
|
|
1868
|
+
/** The code representing the country of Liberia. **/
|
|
1869
|
+
LR = "LR",
|
|
1870
|
+
/** The code representing the country of Libya. **/
|
|
1871
|
+
LY = "LY",
|
|
1872
|
+
/** The code representing the country of Liechtenstein. **/
|
|
1873
|
+
LI = "LI",
|
|
1874
|
+
/** The code representing the country of Lithuania. **/
|
|
1875
|
+
LT = "LT",
|
|
1876
|
+
/** The code representing the country of Luxembourg. **/
|
|
1877
|
+
LU = "LU",
|
|
1878
|
+
/** The code representing the country of Macao. **/
|
|
1879
|
+
MO = "MO",
|
|
1880
|
+
/** The code representing the country of The Former Yugoslav Republic of Macedonia. **/
|
|
1881
|
+
MK = "MK",
|
|
1882
|
+
/** The code representing the country of Madagascar. **/
|
|
1883
|
+
MG = "MG",
|
|
1884
|
+
/** The code representing the country of Malawi. **/
|
|
1885
|
+
MW = "MW",
|
|
1886
|
+
/** The code representing the country of Malaysia. **/
|
|
1887
|
+
MY = "MY",
|
|
1888
|
+
/** The code representing the country of Maldives. **/
|
|
1889
|
+
MV = "MV",
|
|
1890
|
+
/** The code representing the country of Mali. **/
|
|
1891
|
+
ML = "ML",
|
|
1892
|
+
/** The code representing the country of Malta. **/
|
|
1893
|
+
MT = "MT",
|
|
1894
|
+
/** The code representing the country of Marshall Islands. **/
|
|
1895
|
+
MH = "MH",
|
|
1896
|
+
/** The code representing the country of Martinique. **/
|
|
1897
|
+
MQ = "MQ",
|
|
1898
|
+
/** The code representing the country of Mauritania. **/
|
|
1899
|
+
MR = "MR",
|
|
1900
|
+
/** The code representing the country of Mauritius. **/
|
|
1901
|
+
MU = "MU",
|
|
1902
|
+
/** The code representing the country of Mayotte. **/
|
|
1903
|
+
YT = "YT",
|
|
1904
|
+
/** The code representing the country of Mexico. **/
|
|
1905
|
+
MX = "MX",
|
|
1906
|
+
/** The code representing the country of Federated States ofMicronesia. **/
|
|
1907
|
+
FM = "FM",
|
|
1908
|
+
/** The code representing the country of Republic of Moldova. **/
|
|
1909
|
+
MD = "MD",
|
|
1910
|
+
/** The code representing the country of Monaco. **/
|
|
1911
|
+
MC = "MC",
|
|
1912
|
+
/** The code representing the country of Mongolia. **/
|
|
1913
|
+
MN = "MN",
|
|
1914
|
+
/** The code representing the country of Montenegro. **/
|
|
1915
|
+
ME = "ME",
|
|
1916
|
+
/** The code representing the country of Montserrat. **/
|
|
1917
|
+
MS = "MS",
|
|
1918
|
+
/** The code representing the country of Morocco. **/
|
|
1919
|
+
MA = "MA",
|
|
1920
|
+
/** The code representing the country of Mozambique. **/
|
|
1921
|
+
MZ = "MZ",
|
|
1922
|
+
/** The code representing the country of Myanmar. **/
|
|
1923
|
+
MM = "MM",
|
|
1924
|
+
/** The code representing the country of Namibia. **/
|
|
1925
|
+
NA = "NA",
|
|
1926
|
+
/** The code representing the country of Nauru. **/
|
|
1927
|
+
NR = "NR",
|
|
1928
|
+
/** The code representing the country of Nepal. **/
|
|
1929
|
+
NP = "NP",
|
|
1930
|
+
/** The code representing the country of Netherlands. **/
|
|
1931
|
+
NL = "NL",
|
|
1932
|
+
/** The code representing the country of New Caledonia. **/
|
|
1933
|
+
NC = "NC",
|
|
1934
|
+
/** The code representing the country of New Zealand. **/
|
|
1935
|
+
NZ = "NZ",
|
|
1936
|
+
/** The code representing the country of Nicaragua. **/
|
|
1937
|
+
NI = "NI",
|
|
1938
|
+
/** The code representing the country of Niger. **/
|
|
1939
|
+
NE = "NE",
|
|
1940
|
+
/** The code representing the country of Nigeria. **/
|
|
1941
|
+
NG = "NG",
|
|
1942
|
+
/** The code representing the country of Niue. **/
|
|
1943
|
+
NU = "NU",
|
|
1944
|
+
/** The code representing the country of Norfolk Island. **/
|
|
1945
|
+
NF = "NF",
|
|
1946
|
+
/** The code representing the country of Northern Mariana Islands. **/
|
|
1947
|
+
MP = "MP",
|
|
1948
|
+
/** The code representing the country of Norway. **/
|
|
1949
|
+
NO = "NO",
|
|
1950
|
+
/** The code representing the country of Oman. **/
|
|
1951
|
+
OM = "OM",
|
|
1952
|
+
/** The code representing the country of Pakistan. **/
|
|
1953
|
+
PK = "PK",
|
|
1954
|
+
/** The code representing the country of Palau. **/
|
|
1955
|
+
PW = "PW",
|
|
1956
|
+
/** The code representing the country of State of Palestine. **/
|
|
1957
|
+
PS = "PS",
|
|
1958
|
+
/** The code representing the country of Panama. **/
|
|
1959
|
+
PA = "PA",
|
|
1960
|
+
/** The code representing the country of Papua New Guinea. **/
|
|
1961
|
+
PG = "PG",
|
|
1962
|
+
/** The code representing the country of Paraguay. **/
|
|
1963
|
+
PY = "PY",
|
|
1964
|
+
/** The code representing the country of Peru. **/
|
|
1965
|
+
PE = "PE",
|
|
1966
|
+
/** The code representing the country of Philippines. **/
|
|
1967
|
+
PH = "PH",
|
|
1968
|
+
/** The code representing the country of Pitcairn. **/
|
|
1969
|
+
PN = "PN",
|
|
1970
|
+
/** The code representing the country of Poland. **/
|
|
1971
|
+
PL = "PL",
|
|
1972
|
+
/** The code representing the country of Portugal. **/
|
|
1973
|
+
PT = "PT",
|
|
1974
|
+
/** The code representing the country of Puerto Rico. **/
|
|
1975
|
+
PR = "PR",
|
|
1976
|
+
/** The code representing the country of Qatar. **/
|
|
1977
|
+
QA = "QA",
|
|
1978
|
+
/** The code representing the country of Réunion. **/
|
|
1979
|
+
RE = "RE",
|
|
1980
|
+
/** The code representing the country of Romania. **/
|
|
1981
|
+
RO = "RO",
|
|
1982
|
+
/** The code representing the country of Russian Federation. **/
|
|
1983
|
+
RU = "RU",
|
|
1984
|
+
/** The code representing the country of Rwanda. **/
|
|
1985
|
+
RW = "RW",
|
|
1986
|
+
/** The code representing the country of Saint Barthélemy. **/
|
|
1987
|
+
BL = "BL",
|
|
1988
|
+
/** The code representing the country of Saint Helena Ascension and Tristan da Cunha. **/
|
|
1989
|
+
SH = "SH",
|
|
1990
|
+
/** The code representing the country of Saint Kitts and Nevis. **/
|
|
1991
|
+
KN = "KN",
|
|
1992
|
+
/** The code representing the country of Saint Lucia. **/
|
|
1993
|
+
LC = "LC",
|
|
1994
|
+
/** The code representing the country of Saint Martin (French part). **/
|
|
1995
|
+
MF = "MF",
|
|
1996
|
+
/** The code representing the country of Saint Pierre and Miquelon. **/
|
|
1997
|
+
PM = "PM",
|
|
1998
|
+
/** The code representing the country of Saint Vincent and the Grenadines. **/
|
|
1999
|
+
VC = "VC",
|
|
2000
|
+
/** The code representing the country of Samoa. **/
|
|
2001
|
+
WS = "WS",
|
|
2002
|
+
/** The code representing the country of San Marino. **/
|
|
2003
|
+
SM = "SM",
|
|
2004
|
+
/** The code representing the country of Sao Tome and Principe. **/
|
|
2005
|
+
ST = "ST",
|
|
2006
|
+
/** The code representing the country of Saudi Arabia. **/
|
|
2007
|
+
SA = "SA",
|
|
2008
|
+
/** The code representing the country of Senegal. **/
|
|
2009
|
+
SN = "SN",
|
|
2010
|
+
/** The code representing the country of Serbia. **/
|
|
2011
|
+
RS = "RS",
|
|
2012
|
+
/** The code representing the country of Seychelles. **/
|
|
2013
|
+
SC = "SC",
|
|
2014
|
+
/** The code representing the country of Sierra Leone. **/
|
|
2015
|
+
SL = "SL",
|
|
2016
|
+
/** The code representing the country of Singapore. **/
|
|
2017
|
+
SG = "SG",
|
|
2018
|
+
/** The code representing the country of Sint Maarten (Dutch part). **/
|
|
2019
|
+
SX = "SX",
|
|
2020
|
+
/** The code representing the country of Slovakia. **/
|
|
2021
|
+
SK = "SK",
|
|
2022
|
+
/** The code representing the country of Slovenia. **/
|
|
2023
|
+
SI = "SI",
|
|
2024
|
+
/** The code representing the country of Solomon Islands. **/
|
|
2025
|
+
SB = "SB",
|
|
2026
|
+
/** The code representing the country of Somalia. **/
|
|
2027
|
+
SO = "SO",
|
|
2028
|
+
/** The code representing the country of South Africa. **/
|
|
2029
|
+
ZA = "ZA",
|
|
2030
|
+
/** The code representing the country of South Georgia and the South Sandwich Islands. **/
|
|
2031
|
+
GS = "GS",
|
|
2032
|
+
/** The code representing the country of South Sudan. **/
|
|
2033
|
+
SS = "SS",
|
|
2034
|
+
/** The code representing the country of Spain. **/
|
|
2035
|
+
ES = "ES",
|
|
2036
|
+
/** The code representing the country of Sri Lanka. **/
|
|
2037
|
+
LK = "LK",
|
|
2038
|
+
/** The code representing the country of Sudan. **/
|
|
2039
|
+
SD = "SD",
|
|
2040
|
+
/** The code representing the country of Suriname. **/
|
|
2041
|
+
SR = "SR",
|
|
2042
|
+
/** The code representing the country of Svalbard and Jan Mayen. **/
|
|
2043
|
+
SJ = "SJ",
|
|
2044
|
+
/** The code representing the country of Swaziland. **/
|
|
2045
|
+
SZ = "SZ",
|
|
2046
|
+
/** The code representing the country of Sweden. **/
|
|
2047
|
+
SE = "SE",
|
|
2048
|
+
/** The code representing the country of Switzerland. **/
|
|
2049
|
+
CH = "CH",
|
|
2050
|
+
/** The code representing the country of Syrian Arab Republic. **/
|
|
2051
|
+
SY = "SY",
|
|
2052
|
+
/** The code representing the country of Taiwan, Province of China. **/
|
|
2053
|
+
TW = "TW",
|
|
2054
|
+
/** The code representing the country of Tajikistan. **/
|
|
2055
|
+
TJ = "TJ",
|
|
2056
|
+
/** The code representing the country of United Republic of Tanzania. **/
|
|
2057
|
+
TZ = "TZ",
|
|
2058
|
+
/** The code representing the country of Thailand. **/
|
|
2059
|
+
TH = "TH",
|
|
2060
|
+
/** The code representing the country of Timor-Leste. **/
|
|
2061
|
+
TL = "TL",
|
|
2062
|
+
/** The code representing the country of Togo. **/
|
|
2063
|
+
TG = "TG",
|
|
2064
|
+
/** The code representing the country of Tokelau. **/
|
|
2065
|
+
TK = "TK",
|
|
2066
|
+
/** The code representing the country of Tonga. **/
|
|
2067
|
+
TO = "TO",
|
|
2068
|
+
/** The code representing the country of Trinidad and Tobago. **/
|
|
2069
|
+
TT = "TT",
|
|
2070
|
+
/** The code representing the country of Tunisia. **/
|
|
2071
|
+
TN = "TN",
|
|
2072
|
+
/** The code representing the country of Turkey. **/
|
|
2073
|
+
TR = "TR",
|
|
2074
|
+
/** The code representing the country of Turkmenistan. **/
|
|
2075
|
+
TM = "TM",
|
|
2076
|
+
/** The code representing the country of Turks and Caicos Islands. **/
|
|
2077
|
+
TC = "TC",
|
|
2078
|
+
/** The code representing the country of Tuvalu. **/
|
|
2079
|
+
TV = "TV",
|
|
2080
|
+
/** The code representing the country of Uganda. **/
|
|
2081
|
+
UG = "UG",
|
|
2082
|
+
/** The code representing the country of Ukraine. **/
|
|
2083
|
+
UA = "UA",
|
|
2084
|
+
/** The code representing the country of United Arab Emirates. **/
|
|
2085
|
+
AE = "AE",
|
|
2086
|
+
/** The code representing the country of United Kingdom. **/
|
|
2087
|
+
GB = "GB",
|
|
2088
|
+
/** The code representing the country of United States. **/
|
|
2089
|
+
US = "US",
|
|
2090
|
+
/** The code representing the country of United States Minor Outlying Islands. **/
|
|
2091
|
+
UM = "UM",
|
|
2092
|
+
/** The code representing the country of Uruguay. **/
|
|
2093
|
+
UY = "UY",
|
|
2094
|
+
/** The code representing the country of Uzbekistan. **/
|
|
2095
|
+
UZ = "UZ",
|
|
2096
|
+
/** The code representing the country of Vanuatu. **/
|
|
2097
|
+
VU = "VU",
|
|
2098
|
+
/** The code representing the country of Bolivarian Republic of Venezuela. **/
|
|
2099
|
+
VE = "VE",
|
|
2100
|
+
/** The code representing the country of Viet Nam. **/
|
|
2101
|
+
VN = "VN",
|
|
2102
|
+
/** The code representing the country of British Virgin Islands. **/
|
|
2103
|
+
VG = "VG",
|
|
2104
|
+
/** The code representing the country of U.S. Virgin Islands. **/
|
|
2105
|
+
VI = "VI",
|
|
2106
|
+
/** The code representing the country of Wallis and Futuna. **/
|
|
2107
|
+
WF = "WF",
|
|
2108
|
+
/** The code representing the country of Western Sahara. **/
|
|
2109
|
+
EH = "EH",
|
|
2110
|
+
/** The code representing the country of Yemen. **/
|
|
2111
|
+
YE = "YE",
|
|
2112
|
+
/** The code representing the country of Zambia. **/
|
|
2113
|
+
ZM = "ZM",
|
|
2114
|
+
/** The code representing the country of Zimbabwe. **/
|
|
2115
|
+
ZW = "ZW"
|
|
2116
|
+
}
|
|
2117
|
+
|
|
1296
2118
|
type SingleNodeDashboard = {
|
|
1297
2119
|
id: string;
|
|
1298
2120
|
displayName: string;
|
|
@@ -1338,6 +2160,70 @@ type TransactionUpdate = {
|
|
|
1338
2160
|
transactionHash?: string;
|
|
1339
2161
|
};
|
|
1340
2162
|
|
|
2163
|
+
/** Describes the reason for an invitation to not be eligible for incentives. **/
|
|
2164
|
+
declare enum IncentivesIneligibilityReason {
|
|
2165
|
+
/**
|
|
2166
|
+
* This is an enum value that represents values that could be added in the future.
|
|
2167
|
+
* Clients should support unknown values as more of them could be added without notice.
|
|
2168
|
+
*/
|
|
2169
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2170
|
+
/** This invitation is not eligible for incentives because it has been created outside of the incentives flow. **/
|
|
2171
|
+
DISABLED = "DISABLED",
|
|
2172
|
+
/** This invitation is not eligible for incentives because the sender is not eligible. **/
|
|
2173
|
+
SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
|
|
2174
|
+
/** This invitation is not eligible for incentives because the receiver is not eligible. **/
|
|
2175
|
+
RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
|
|
2176
|
+
/** This invitation is not eligible for incentives because the sending VASP is not part of the incentives program. **/
|
|
2177
|
+
SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
|
|
2178
|
+
/** This invitation is not eligible for incentives because the receiving VASP is not part of the incentives program. **/
|
|
2179
|
+
RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
|
|
2180
|
+
/** This invitation is not eligible for incentives because the sender and receiver are in the same region. **/
|
|
2181
|
+
NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
|
|
2182
|
+
}
|
|
2183
|
+
|
|
2184
|
+
/** Describes the status of the incentives for this invitation. **/
|
|
2185
|
+
declare enum IncentivesStatus {
|
|
2186
|
+
/**
|
|
2187
|
+
* This is an enum value that represents values that could be added in the future.
|
|
2188
|
+
* Clients should support unknown values as more of them could be added without notice.
|
|
2189
|
+
*/
|
|
2190
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2191
|
+
/** The invitation is eligible for incentives in its current state. When it is claimed, we will reassess. **/
|
|
2192
|
+
PENDING = "PENDING",
|
|
2193
|
+
/** The incentives have been validated. **/
|
|
2194
|
+
VALIDATED = "VALIDATED",
|
|
2195
|
+
/** This invitation is not eligible for incentives. A more detailed reason can be found in the `incentives_ineligibility_reason` field. **/
|
|
2196
|
+
INELIGIBLE = "INELIGIBLE"
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
/** This is an object representing an UMA.ME invitation. **/
|
|
2200
|
+
interface UmaInvitation {
|
|
2201
|
+
/**
|
|
2202
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
2203
|
+
* string.
|
|
2204
|
+
**/
|
|
2205
|
+
id: string;
|
|
2206
|
+
/** The date and time when the entity was first created. **/
|
|
2207
|
+
createdAt: string;
|
|
2208
|
+
/** The date and time when the entity was last updated. **/
|
|
2209
|
+
updatedAt: string;
|
|
2210
|
+
/** The code that uniquely identifies this invitation. **/
|
|
2211
|
+
code: string;
|
|
2212
|
+
/** The URL where this invitation can be claimed. **/
|
|
2213
|
+
url: string;
|
|
2214
|
+
/** The UMA of the user who created the invitation. **/
|
|
2215
|
+
inviterUma: string;
|
|
2216
|
+
/** The current status of the incentives that may be tied to this invitation. **/
|
|
2217
|
+
incentivesStatus: IncentivesStatus;
|
|
2218
|
+
/** The typename of the object **/
|
|
2219
|
+
typename: string;
|
|
2220
|
+
/** The UMA of the user who claimed the invitation. **/
|
|
2221
|
+
inviteeUma?: string | undefined;
|
|
2222
|
+
/** The reason why the invitation is not eligible for incentives, if applicable. **/
|
|
2223
|
+
incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
|
|
2224
|
+
}
|
|
2225
|
+
declare const getUmaInvitationQuery: (id: string) => Query<UmaInvitation>;
|
|
2226
|
+
|
|
1341
2227
|
/** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
|
|
1342
2228
|
declare enum WithdrawalMode {
|
|
1343
2229
|
/**
|
|
@@ -1478,18 +2364,63 @@ interface WithdrawalRequestToChannelOpeningTransactionsConnection {
|
|
|
1478
2364
|
|
|
1479
2365
|
/** 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. **/
|
|
1480
2366
|
declare class WithdrawalRequest implements Entity {
|
|
2367
|
+
/**
|
|
2368
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
2369
|
+
* string.
|
|
2370
|
+
**/
|
|
1481
2371
|
readonly id: string;
|
|
2372
|
+
/** The date and time when the entity was first created. **/
|
|
1482
2373
|
readonly createdAt: string;
|
|
2374
|
+
/** The date and time when the entity was last updated. **/
|
|
1483
2375
|
readonly updatedAt: string;
|
|
2376
|
+
/** The amount of money that should be withdrawn in this request. **/
|
|
1484
2377
|
readonly amount: CurrencyAmount;
|
|
2378
|
+
/** The bitcoin address where the funds should be sent. **/
|
|
1485
2379
|
readonly bitcoinAddress: string;
|
|
2380
|
+
/** The strategy that should be used to withdraw the funds from the account. **/
|
|
1486
2381
|
readonly withdrawalMode: WithdrawalMode;
|
|
2382
|
+
/** The current status of this withdrawal request. **/
|
|
1487
2383
|
readonly status: WithdrawalRequestStatus;
|
|
2384
|
+
/** The typename of the object **/
|
|
1488
2385
|
readonly typename: string;
|
|
2386
|
+
/**
|
|
2387
|
+
* If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount
|
|
2388
|
+
* for the withdrawal.
|
|
2389
|
+
**/
|
|
1489
2390
|
readonly estimatedAmount?: CurrencyAmount | undefined;
|
|
2391
|
+
/** The time at which this request was completed. **/
|
|
1490
2392
|
readonly completedAt?: string | undefined;
|
|
2393
|
+
/** The withdrawal transaction that has been generated by this request. **/
|
|
1491
2394
|
readonly withdrawalId?: string | undefined;
|
|
1492
|
-
constructor(
|
|
2395
|
+
constructor(
|
|
2396
|
+
/**
|
|
2397
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
2398
|
+
* string.
|
|
2399
|
+
**/
|
|
2400
|
+
id: string,
|
|
2401
|
+
/** The date and time when the entity was first created. **/
|
|
2402
|
+
createdAt: string,
|
|
2403
|
+
/** The date and time when the entity was last updated. **/
|
|
2404
|
+
updatedAt: string,
|
|
2405
|
+
/** The amount of money that should be withdrawn in this request. **/
|
|
2406
|
+
amount: CurrencyAmount,
|
|
2407
|
+
/** The bitcoin address where the funds should be sent. **/
|
|
2408
|
+
bitcoinAddress: string,
|
|
2409
|
+
/** The strategy that should be used to withdraw the funds from the account. **/
|
|
2410
|
+
withdrawalMode: WithdrawalMode,
|
|
2411
|
+
/** The current status of this withdrawal request. **/
|
|
2412
|
+
status: WithdrawalRequestStatus,
|
|
2413
|
+
/** The typename of the object **/
|
|
2414
|
+
typename: string,
|
|
2415
|
+
/**
|
|
2416
|
+
* If the requested amount is `-1` (i.e. everything), this field may contain an estimate of the amount
|
|
2417
|
+
* for the withdrawal.
|
|
2418
|
+
**/
|
|
2419
|
+
estimatedAmount?: CurrencyAmount | undefined,
|
|
2420
|
+
/** The time at which this request was completed. **/
|
|
2421
|
+
completedAt?: string | undefined,
|
|
2422
|
+
/** The withdrawal transaction that has been generated by this request. **/
|
|
2423
|
+
withdrawalId?: string | undefined);
|
|
1493
2424
|
getChannelClosingTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelClosingTransactionsConnection>;
|
|
1494
2425
|
getChannelOpeningTransactions(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToChannelOpeningTransactionsConnection>;
|
|
1495
2426
|
static getWithdrawalRequestQuery(id: string): Query<WithdrawalRequest>;
|
|
@@ -1565,7 +2496,8 @@ declare class LightsparkClient {
|
|
|
1565
2496
|
/**
|
|
1566
2497
|
* Constructs a new LightsparkClient.
|
|
1567
2498
|
*
|
|
1568
|
-
* @param authProvider The auth provider to use for authentication. Defaults to a stub auth provider.
|
|
2499
|
+
* @param authProvider The auth provider to use for authentication. Defaults to a stub auth provider.
|
|
2500
|
+
* For server-side
|
|
1569
2501
|
* use, you should use the `AccountTokenAuthProvider`.
|
|
1570
2502
|
* @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
|
|
1571
2503
|
* @param cryptoImpl The crypto implementation to use. Defaults to web and node compatible crypto.
|
|
@@ -1594,7 +2526,7 @@ declare class LightsparkClient {
|
|
|
1594
2526
|
*
|
|
1595
2527
|
* @param authProvider
|
|
1596
2528
|
*/
|
|
1597
|
-
setAuthProvider(authProvider: AuthProvider):
|
|
2529
|
+
setAuthProvider(authProvider: AuthProvider): void;
|
|
1598
2530
|
/**
|
|
1599
2531
|
* @returns Whether or not the client is authorized. This is useful for determining if the user is logged in or not.
|
|
1600
2532
|
*/
|
|
@@ -1777,7 +2709,7 @@ declare class LightsparkClient {
|
|
|
1777
2709
|
* @param transactionId The ID of the transaction to wait for
|
|
1778
2710
|
* @param pollTimeoutSecs The timeout in seconds that we will wait before throwing an exception
|
|
1779
2711
|
*/
|
|
1780
|
-
waitForTransactionComplete(transactionId: string, pollTimeoutSecs?: number): Promise<
|
|
2712
|
+
waitForTransactionComplete<T = Transaction>(transactionId: string, pollTimeoutSecs?: number): Promise<T>;
|
|
1781
2713
|
/**
|
|
1782
2714
|
* Sends a payment directly to a node on the Lightning Network through the public key of the node without an invoice.
|
|
1783
2715
|
*
|
|
@@ -1859,6 +2791,49 @@ declare class LightsparkClient {
|
|
|
1859
2791
|
* amount invoices.
|
|
1860
2792
|
*/
|
|
1861
2793
|
createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<IncomingPayment | null>;
|
|
2794
|
+
/**
|
|
2795
|
+
* Creates an UMA invitation. If you are part of the incentive program, you should use
|
|
2796
|
+
* [createUmaInvitationWithIncentives].
|
|
2797
|
+
*
|
|
2798
|
+
* @param inviterUma The UMA of the inviter.
|
|
2799
|
+
* @returns The invitation that was created.
|
|
2800
|
+
*/
|
|
2801
|
+
createUmaInvitation(inviterUma: string): Promise<UmaInvitation | null>;
|
|
2802
|
+
/**
|
|
2803
|
+
* Creates an UMA invitation as part of the incentive program.
|
|
2804
|
+
* @param inviterUma The UMA of the inviter.
|
|
2805
|
+
* @param inviterPhoneNumber The phone number of the inviter in E164 format.
|
|
2806
|
+
* @param inviterRegion The region of the inviter.
|
|
2807
|
+
* @returns The invitation that was created.
|
|
2808
|
+
*/
|
|
2809
|
+
createUmaInvitationWithIncentives(inviterUma: string, inviterPhoneNumber: string, inviterRegion: RegionCode): Promise<UmaInvitation | null>;
|
|
2810
|
+
/**
|
|
2811
|
+
* Claims an UMA invitation. If you are part of the incentive program, you should use
|
|
2812
|
+
* [claimUmaInvitationWithIncentives].
|
|
2813
|
+
*
|
|
2814
|
+
* @param invitationCode The invitation code to claim.
|
|
2815
|
+
* @param inviteeUma The UMA of the invitee.
|
|
2816
|
+
* @returns The invitation that was claimed.
|
|
2817
|
+
*/
|
|
2818
|
+
claimUmaInvitation(invitationCode: string, inviteeUma: string): Promise<UmaInvitation | null>;
|
|
2819
|
+
/**
|
|
2820
|
+
* Claims an UMA invitation as part of the incentive program.
|
|
2821
|
+
*
|
|
2822
|
+
* @param invitationCode The invitation code to claim.
|
|
2823
|
+
* @param inviteeUma The UMA of the invitee.
|
|
2824
|
+
* @param inviteePhoneNumber The phone number of the invitee in E164 format.
|
|
2825
|
+
* @param inviteeRegion The region of the invitee.
|
|
2826
|
+
* @returns The invitation that was claimed.
|
|
2827
|
+
*/
|
|
2828
|
+
claimUmaInvitationWithIncentives(invitationCode: string, inviteeUma: string, inviteePhoneNumber: string, inviteeRegion: RegionCode): Promise<UmaInvitation | null>;
|
|
2829
|
+
/**
|
|
2830
|
+
* Fetches an UMA invitation by its invitation code.
|
|
2831
|
+
*
|
|
2832
|
+
* @param invitationCode The code of the invitation to fetch.
|
|
2833
|
+
* @returns The invitation with the given code, or null if no invitation exists with that code.
|
|
2834
|
+
*/
|
|
2835
|
+
fetchUmaInvitation(invitationCode: string): Promise<UmaInvitation | null>;
|
|
2836
|
+
private hashPhoneNumber;
|
|
1862
2837
|
/**
|
|
1863
2838
|
* Executes a raw `Query` against the Lightspark API.
|
|
1864
2839
|
*
|
|
@@ -1871,6 +2846,26 @@ declare class LightsparkClient {
|
|
|
1871
2846
|
executeRawQuery<T>(query: Query<T>): Promise<T | null>;
|
|
1872
2847
|
}
|
|
1873
2848
|
|
|
2849
|
+
interface ClaimUmaInvitationInput {
|
|
2850
|
+
invitationCode: string;
|
|
2851
|
+
inviteeUma: string;
|
|
2852
|
+
}
|
|
2853
|
+
|
|
2854
|
+
interface ClaimUmaInvitationOutput {
|
|
2855
|
+
invitationId: string;
|
|
2856
|
+
}
|
|
2857
|
+
|
|
2858
|
+
interface ClaimUmaInvitationWithIncentivesInput {
|
|
2859
|
+
invitationCode: string;
|
|
2860
|
+
inviteeUma: string;
|
|
2861
|
+
inviteePhoneHash: string;
|
|
2862
|
+
inviteeRegion: RegionCode;
|
|
2863
|
+
}
|
|
2864
|
+
|
|
2865
|
+
interface ClaimUmaInvitationWithIncentivesOutput {
|
|
2866
|
+
invitationId: string;
|
|
2867
|
+
}
|
|
2868
|
+
|
|
1874
2869
|
/** This is an enum identifying a type of compliance provider. **/
|
|
1875
2870
|
declare enum ComplianceProvider {
|
|
1876
2871
|
/**
|
|
@@ -1900,6 +2895,16 @@ interface CreateApiTokenInput {
|
|
|
1900
2895
|
permissions: Permission[];
|
|
1901
2896
|
}
|
|
1902
2897
|
|
|
2898
|
+
interface CreateInvitationWithIncentivesInput {
|
|
2899
|
+
inviterUma: string;
|
|
2900
|
+
inviterPhoneHash: string;
|
|
2901
|
+
inviterRegion: RegionCode;
|
|
2902
|
+
}
|
|
2903
|
+
|
|
2904
|
+
interface CreateInvitationWithIncentivesOutput {
|
|
2905
|
+
invitationId: string;
|
|
2906
|
+
}
|
|
2907
|
+
|
|
1903
2908
|
interface CreateInvoiceInput {
|
|
1904
2909
|
/** The node from which to create the invoice. **/
|
|
1905
2910
|
nodeId: string;
|
|
@@ -1973,6 +2978,14 @@ interface CreateTestModePaymentoutput {
|
|
|
1973
2978
|
incomingPaymentId: string;
|
|
1974
2979
|
}
|
|
1975
2980
|
|
|
2981
|
+
interface CreateUmaInvitationInput {
|
|
2982
|
+
inviterUma: string;
|
|
2983
|
+
}
|
|
2984
|
+
|
|
2985
|
+
interface CreateUmaInvitationOutput {
|
|
2986
|
+
invitationId: string;
|
|
2987
|
+
}
|
|
2988
|
+
|
|
1976
2989
|
interface CreateUmaInvoiceInput {
|
|
1977
2990
|
nodeId: string;
|
|
1978
2991
|
amountMsats: number;
|
|
@@ -2092,17 +3105,83 @@ interface FundNodeOutput {
|
|
|
2092
3105
|
|
|
2093
3106
|
/** 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. **/
|
|
2094
3107
|
declare class GraphNode implements Node, Entity {
|
|
3108
|
+
/**
|
|
3109
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3110
|
+
* string.
|
|
3111
|
+
**/
|
|
2095
3112
|
readonly id: string;
|
|
3113
|
+
/** The date and time when the entity was first created. **/
|
|
2096
3114
|
readonly createdAt: string;
|
|
3115
|
+
/** The date and time when the entity was last updated. **/
|
|
2097
3116
|
readonly updatedAt: string;
|
|
3117
|
+
/** The Bitcoin Network this node is deployed in. **/
|
|
2098
3118
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3119
|
+
/**
|
|
3120
|
+
* The name of this node in the network. It will be the most human-readable option possible, depending
|
|
3121
|
+
* on the data available for this node.
|
|
3122
|
+
**/
|
|
2099
3123
|
readonly displayName: string;
|
|
3124
|
+
/** The typename of the object **/
|
|
2100
3125
|
readonly typename: string;
|
|
3126
|
+
/**
|
|
3127
|
+
* A name that identifies the node. It has no importance in terms of operating the node, it is just a
|
|
3128
|
+
* way to identify and search for commercial services or popular nodes. This alias can be changed at
|
|
3129
|
+
* any time by the node operator.
|
|
3130
|
+
**/
|
|
2101
3131
|
readonly alias?: string | undefined;
|
|
3132
|
+
/**
|
|
3133
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
|
|
3134
|
+
* has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
|
|
3135
|
+
* That color can be changed at any time by the node operator.
|
|
3136
|
+
**/
|
|
2102
3137
|
readonly color?: string | undefined;
|
|
3138
|
+
/**
|
|
3139
|
+
* A summary metric used to capture how well positioned a node is to send, receive, or route
|
|
3140
|
+
* transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
|
|
3141
|
+
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3142
|
+
**/
|
|
2103
3143
|
readonly conductivity?: number | undefined;
|
|
3144
|
+
/** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
|
|
2104
3145
|
readonly publicKey?: string | undefined;
|
|
2105
|
-
constructor(
|
|
3146
|
+
constructor(
|
|
3147
|
+
/**
|
|
3148
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3149
|
+
* string.
|
|
3150
|
+
**/
|
|
3151
|
+
id: string,
|
|
3152
|
+
/** The date and time when the entity was first created. **/
|
|
3153
|
+
createdAt: string,
|
|
3154
|
+
/** The date and time when the entity was last updated. **/
|
|
3155
|
+
updatedAt: string,
|
|
3156
|
+
/** The Bitcoin Network this node is deployed in. **/
|
|
3157
|
+
bitcoinNetwork: BitcoinNetwork,
|
|
3158
|
+
/**
|
|
3159
|
+
* The name of this node in the network. It will be the most human-readable option possible, depending
|
|
3160
|
+
* on the data available for this node.
|
|
3161
|
+
**/
|
|
3162
|
+
displayName: string,
|
|
3163
|
+
/** The typename of the object **/
|
|
3164
|
+
typename: string,
|
|
3165
|
+
/**
|
|
3166
|
+
* A name that identifies the node. It has no importance in terms of operating the node, it is just a
|
|
3167
|
+
* way to identify and search for commercial services or popular nodes. This alias can be changed at
|
|
3168
|
+
* any time by the node operator.
|
|
3169
|
+
**/
|
|
3170
|
+
alias?: string | undefined,
|
|
3171
|
+
/**
|
|
3172
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
|
|
3173
|
+
* has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
|
|
3174
|
+
* That color can be changed at any time by the node operator.
|
|
3175
|
+
**/
|
|
3176
|
+
color?: string | undefined,
|
|
3177
|
+
/**
|
|
3178
|
+
* A summary metric used to capture how well positioned a node is to send, receive, or route
|
|
3179
|
+
* transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
|
|
3180
|
+
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3181
|
+
**/
|
|
3182
|
+
conductivity?: number | undefined,
|
|
3183
|
+
/** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
|
|
3184
|
+
publicKey?: string | undefined);
|
|
2106
3185
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
2107
3186
|
static getGraphNodeQuery(id: string): Query<GraphNode>;
|
|
2108
3187
|
toJson(): {
|
|
@@ -2159,27 +3238,169 @@ interface Secret {
|
|
|
2159
3238
|
|
|
2160
3239
|
/** This is a Lightspark node with OSK. **/
|
|
2161
3240
|
declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
3241
|
+
/**
|
|
3242
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3243
|
+
* string.
|
|
3244
|
+
**/
|
|
2162
3245
|
readonly id: string;
|
|
3246
|
+
/** The date and time when the entity was first created. **/
|
|
2163
3247
|
readonly createdAt: string;
|
|
3248
|
+
/** The date and time when the entity was last updated. **/
|
|
2164
3249
|
readonly updatedAt: string;
|
|
3250
|
+
/** The Bitcoin Network this node is deployed in. **/
|
|
2165
3251
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3252
|
+
/**
|
|
3253
|
+
* The name of this node in the network. It will be the most human-readable option possible, depending
|
|
3254
|
+
* on the data available for this node.
|
|
3255
|
+
**/
|
|
2166
3256
|
readonly displayName: string;
|
|
3257
|
+
/** The owner of this LightsparkNode. **/
|
|
2167
3258
|
readonly ownerId: string;
|
|
3259
|
+
/**
|
|
3260
|
+
* The utxos of the channels that are connected to this node. This is used in uma flow for
|
|
3261
|
+
* pre-screening.
|
|
3262
|
+
**/
|
|
2168
3263
|
readonly umaPrescreeningUtxos: string[];
|
|
3264
|
+
/** The typename of the object **/
|
|
2169
3265
|
readonly typename: string;
|
|
3266
|
+
/**
|
|
3267
|
+
* A name that identifies the node. It has no importance in terms of operating the node, it is just a
|
|
3268
|
+
* way to identify and search for commercial services or popular nodes. This alias can be changed at
|
|
3269
|
+
* any time by the node operator.
|
|
3270
|
+
**/
|
|
2170
3271
|
readonly alias?: string | undefined;
|
|
3272
|
+
/**
|
|
3273
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
|
|
3274
|
+
* has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
|
|
3275
|
+
* That color can be changed at any time by the node operator.
|
|
3276
|
+
**/
|
|
2171
3277
|
readonly color?: string | undefined;
|
|
3278
|
+
/**
|
|
3279
|
+
* A summary metric used to capture how well positioned a node is to send, receive, or route
|
|
3280
|
+
* transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
|
|
3281
|
+
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3282
|
+
**/
|
|
2172
3283
|
readonly conductivity?: number | undefined;
|
|
3284
|
+
/** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
|
|
2173
3285
|
readonly publicKey?: string | undefined;
|
|
3286
|
+
/** The current status of this node. **/
|
|
2174
3287
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
3288
|
+
/**
|
|
3289
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
|
|
3290
|
+
*
|
|
3291
|
+
* @deprecated Use `balances` instead.
|
|
3292
|
+
**/
|
|
2175
3293
|
readonly totalBalance?: CurrencyAmount | undefined;
|
|
3294
|
+
/**
|
|
3295
|
+
* The total sum of the channel balances (online and offline) on this node.
|
|
3296
|
+
*
|
|
3297
|
+
* @deprecated Use `balances` instead.
|
|
3298
|
+
**/
|
|
2176
3299
|
readonly totalLocalBalance?: CurrencyAmount | undefined;
|
|
3300
|
+
/**
|
|
3301
|
+
* The sum of the channel balances (online only) that are available to send on this node.
|
|
3302
|
+
*
|
|
3303
|
+
* @deprecated Use `balances` instead.
|
|
3304
|
+
**/
|
|
2177
3305
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
3306
|
+
/**
|
|
3307
|
+
* The sum of the channel balances that are available to receive on this node.
|
|
3308
|
+
*
|
|
3309
|
+
* @deprecated Use `balances` instead.
|
|
3310
|
+
**/
|
|
2178
3311
|
readonly remoteBalance?: CurrencyAmount | undefined;
|
|
3312
|
+
/**
|
|
3313
|
+
* The details of the balance of this node on the Bitcoin Network.
|
|
3314
|
+
*
|
|
3315
|
+
* @deprecated Use `balances` instead.
|
|
3316
|
+
**/
|
|
2179
3317
|
readonly blockchainBalance?: BlockchainBalance | undefined;
|
|
3318
|
+
/** The balances that describe the funds in this node. **/
|
|
2180
3319
|
readonly balances?: Balances | undefined;
|
|
3320
|
+
/** The private key client is using to sign a GraphQL request which will be verified at server side. **/
|
|
2181
3321
|
readonly encryptedSigningPrivateKey?: Secret | undefined;
|
|
2182
|
-
constructor(
|
|
3322
|
+
constructor(
|
|
3323
|
+
/**
|
|
3324
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3325
|
+
* string.
|
|
3326
|
+
**/
|
|
3327
|
+
id: string,
|
|
3328
|
+
/** The date and time when the entity was first created. **/
|
|
3329
|
+
createdAt: string,
|
|
3330
|
+
/** The date and time when the entity was last updated. **/
|
|
3331
|
+
updatedAt: string,
|
|
3332
|
+
/** The Bitcoin Network this node is deployed in. **/
|
|
3333
|
+
bitcoinNetwork: BitcoinNetwork,
|
|
3334
|
+
/**
|
|
3335
|
+
* The name of this node in the network. It will be the most human-readable option possible, depending
|
|
3336
|
+
* on the data available for this node.
|
|
3337
|
+
**/
|
|
3338
|
+
displayName: string,
|
|
3339
|
+
/** The owner of this LightsparkNode. **/
|
|
3340
|
+
ownerId: string,
|
|
3341
|
+
/**
|
|
3342
|
+
* The utxos of the channels that are connected to this node. This is used in uma flow for
|
|
3343
|
+
* pre-screening.
|
|
3344
|
+
**/
|
|
3345
|
+
umaPrescreeningUtxos: string[],
|
|
3346
|
+
/** The typename of the object **/
|
|
3347
|
+
typename: string,
|
|
3348
|
+
/**
|
|
3349
|
+
* A name that identifies the node. It has no importance in terms of operating the node, it is just a
|
|
3350
|
+
* way to identify and search for commercial services or popular nodes. This alias can be changed at
|
|
3351
|
+
* any time by the node operator.
|
|
3352
|
+
**/
|
|
3353
|
+
alias?: string | undefined,
|
|
3354
|
+
/**
|
|
3355
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
|
|
3356
|
+
* has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
|
|
3357
|
+
* That color can be changed at any time by the node operator.
|
|
3358
|
+
**/
|
|
3359
|
+
color?: string | undefined,
|
|
3360
|
+
/**
|
|
3361
|
+
* A summary metric used to capture how well positioned a node is to send, receive, or route
|
|
3362
|
+
* transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
|
|
3363
|
+
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3364
|
+
**/
|
|
3365
|
+
conductivity?: number | undefined,
|
|
3366
|
+
/** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
|
|
3367
|
+
publicKey?: string | undefined,
|
|
3368
|
+
/** The current status of this node. **/
|
|
3369
|
+
status?: LightsparkNodeStatus | undefined,
|
|
3370
|
+
/**
|
|
3371
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
|
|
3372
|
+
*
|
|
3373
|
+
* @deprecated Use `balances` instead.
|
|
3374
|
+
**/
|
|
3375
|
+
totalBalance?: CurrencyAmount | undefined,
|
|
3376
|
+
/**
|
|
3377
|
+
* The total sum of the channel balances (online and offline) on this node.
|
|
3378
|
+
*
|
|
3379
|
+
* @deprecated Use `balances` instead.
|
|
3380
|
+
**/
|
|
3381
|
+
totalLocalBalance?: CurrencyAmount | undefined,
|
|
3382
|
+
/**
|
|
3383
|
+
* The sum of the channel balances (online only) that are available to send on this node.
|
|
3384
|
+
*
|
|
3385
|
+
* @deprecated Use `balances` instead.
|
|
3386
|
+
**/
|
|
3387
|
+
localBalance?: CurrencyAmount | undefined,
|
|
3388
|
+
/**
|
|
3389
|
+
* The sum of the channel balances that are available to receive on this node.
|
|
3390
|
+
*
|
|
3391
|
+
* @deprecated Use `balances` instead.
|
|
3392
|
+
**/
|
|
3393
|
+
remoteBalance?: CurrencyAmount | undefined,
|
|
3394
|
+
/**
|
|
3395
|
+
* The details of the balance of this node on the Bitcoin Network.
|
|
3396
|
+
*
|
|
3397
|
+
* @deprecated Use `balances` instead.
|
|
3398
|
+
**/
|
|
3399
|
+
blockchainBalance?: BlockchainBalance | undefined,
|
|
3400
|
+
/** The balances that describe the funds in this node. **/
|
|
3401
|
+
balances?: Balances | undefined,
|
|
3402
|
+
/** The private key client is using to sign a GraphQL request which will be verified at server side. **/
|
|
3403
|
+
encryptedSigningPrivateKey?: Secret | undefined);
|
|
2183
3404
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
2184
3405
|
getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
2185
3406
|
static getLightsparkNodeWithOSKQuery(id: string): Query<LightsparkNodeWithOSK>;
|
|
@@ -2211,26 +3432,165 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2211
3432
|
|
|
2212
3433
|
/** This is a Lightspark node with remote signing. **/
|
|
2213
3434
|
declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
|
|
3435
|
+
/**
|
|
3436
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3437
|
+
* string.
|
|
3438
|
+
**/
|
|
2214
3439
|
readonly id: string;
|
|
3440
|
+
/** The date and time when the entity was first created. **/
|
|
2215
3441
|
readonly createdAt: string;
|
|
3442
|
+
/** The date and time when the entity was last updated. **/
|
|
2216
3443
|
readonly updatedAt: string;
|
|
3444
|
+
/** The Bitcoin Network this node is deployed in. **/
|
|
2217
3445
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3446
|
+
/**
|
|
3447
|
+
* The name of this node in the network. It will be the most human-readable option possible, depending
|
|
3448
|
+
* on the data available for this node.
|
|
3449
|
+
**/
|
|
2218
3450
|
readonly displayName: string;
|
|
3451
|
+
/** The owner of this LightsparkNode. **/
|
|
2219
3452
|
readonly ownerId: string;
|
|
3453
|
+
/**
|
|
3454
|
+
* The utxos of the channels that are connected to this node. This is used in uma flow for
|
|
3455
|
+
* pre-screening.
|
|
3456
|
+
**/
|
|
2220
3457
|
readonly umaPrescreeningUtxos: string[];
|
|
3458
|
+
/** The typename of the object **/
|
|
2221
3459
|
readonly typename: string;
|
|
3460
|
+
/**
|
|
3461
|
+
* A name that identifies the node. It has no importance in terms of operating the node, it is just a
|
|
3462
|
+
* way to identify and search for commercial services or popular nodes. This alias can be changed at
|
|
3463
|
+
* any time by the node operator.
|
|
3464
|
+
**/
|
|
2222
3465
|
readonly alias?: string | undefined;
|
|
3466
|
+
/**
|
|
3467
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
|
|
3468
|
+
* has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
|
|
3469
|
+
* That color can be changed at any time by the node operator.
|
|
3470
|
+
**/
|
|
2223
3471
|
readonly color?: string | undefined;
|
|
3472
|
+
/**
|
|
3473
|
+
* A summary metric used to capture how well positioned a node is to send, receive, or route
|
|
3474
|
+
* transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
|
|
3475
|
+
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3476
|
+
**/
|
|
2224
3477
|
readonly conductivity?: number | undefined;
|
|
3478
|
+
/** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
|
|
2225
3479
|
readonly publicKey?: string | undefined;
|
|
3480
|
+
/** The current status of this node. **/
|
|
2226
3481
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
3482
|
+
/**
|
|
3483
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
|
|
3484
|
+
*
|
|
3485
|
+
* @deprecated Use `balances` instead.
|
|
3486
|
+
**/
|
|
2227
3487
|
readonly totalBalance?: CurrencyAmount | undefined;
|
|
3488
|
+
/**
|
|
3489
|
+
* The total sum of the channel balances (online and offline) on this node.
|
|
3490
|
+
*
|
|
3491
|
+
* @deprecated Use `balances` instead.
|
|
3492
|
+
**/
|
|
2228
3493
|
readonly totalLocalBalance?: CurrencyAmount | undefined;
|
|
3494
|
+
/**
|
|
3495
|
+
* The sum of the channel balances (online only) that are available to send on this node.
|
|
3496
|
+
*
|
|
3497
|
+
* @deprecated Use `balances` instead.
|
|
3498
|
+
**/
|
|
2229
3499
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
3500
|
+
/**
|
|
3501
|
+
* The sum of the channel balances that are available to receive on this node.
|
|
3502
|
+
*
|
|
3503
|
+
* @deprecated Use `balances` instead.
|
|
3504
|
+
**/
|
|
2230
3505
|
readonly remoteBalance?: CurrencyAmount | undefined;
|
|
3506
|
+
/**
|
|
3507
|
+
* The details of the balance of this node on the Bitcoin Network.
|
|
3508
|
+
*
|
|
3509
|
+
* @deprecated Use `balances` instead.
|
|
3510
|
+
**/
|
|
2231
3511
|
readonly blockchainBalance?: BlockchainBalance | undefined;
|
|
3512
|
+
/** The balances that describe the funds in this node. **/
|
|
2232
3513
|
readonly balances?: Balances | undefined;
|
|
2233
|
-
constructor(
|
|
3514
|
+
constructor(
|
|
3515
|
+
/**
|
|
3516
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3517
|
+
* string.
|
|
3518
|
+
**/
|
|
3519
|
+
id: string,
|
|
3520
|
+
/** The date and time when the entity was first created. **/
|
|
3521
|
+
createdAt: string,
|
|
3522
|
+
/** The date and time when the entity was last updated. **/
|
|
3523
|
+
updatedAt: string,
|
|
3524
|
+
/** The Bitcoin Network this node is deployed in. **/
|
|
3525
|
+
bitcoinNetwork: BitcoinNetwork,
|
|
3526
|
+
/**
|
|
3527
|
+
* The name of this node in the network. It will be the most human-readable option possible, depending
|
|
3528
|
+
* on the data available for this node.
|
|
3529
|
+
**/
|
|
3530
|
+
displayName: string,
|
|
3531
|
+
/** The owner of this LightsparkNode. **/
|
|
3532
|
+
ownerId: string,
|
|
3533
|
+
/**
|
|
3534
|
+
* The utxos of the channels that are connected to this node. This is used in uma flow for
|
|
3535
|
+
* pre-screening.
|
|
3536
|
+
**/
|
|
3537
|
+
umaPrescreeningUtxos: string[],
|
|
3538
|
+
/** The typename of the object **/
|
|
3539
|
+
typename: string,
|
|
3540
|
+
/**
|
|
3541
|
+
* A name that identifies the node. It has no importance in terms of operating the node, it is just a
|
|
3542
|
+
* way to identify and search for commercial services or popular nodes. This alias can be changed at
|
|
3543
|
+
* any time by the node operator.
|
|
3544
|
+
**/
|
|
3545
|
+
alias?: string | undefined,
|
|
3546
|
+
/**
|
|
3547
|
+
* A hexadecimal string that describes a color. For example "#000000" is black, "#FFFFFF" is white. It
|
|
3548
|
+
* has no importance in terms of operating the node, it is just a way to visually differentiate nodes.
|
|
3549
|
+
* That color can be changed at any time by the node operator.
|
|
3550
|
+
**/
|
|
3551
|
+
color?: string | undefined,
|
|
3552
|
+
/**
|
|
3553
|
+
* A summary metric used to capture how well positioned a node is to send, receive, or route
|
|
3554
|
+
* transactions efficiently. Maximizing a node's conductivity helps a node’s transactions to be
|
|
3555
|
+
* capital efficient. The value is an integer ranging between 0 and 10 (bounds included).
|
|
3556
|
+
**/
|
|
3557
|
+
conductivity?: number | undefined,
|
|
3558
|
+
/** The public key of this node. It acts as a unique identifier of this node in the Lightning Network. **/
|
|
3559
|
+
publicKey?: string | undefined,
|
|
3560
|
+
/** The current status of this node. **/
|
|
3561
|
+
status?: LightsparkNodeStatus | undefined,
|
|
3562
|
+
/**
|
|
3563
|
+
* The sum of the balance on the Bitcoin Network, channel balances, and commit fees on this node.
|
|
3564
|
+
*
|
|
3565
|
+
* @deprecated Use `balances` instead.
|
|
3566
|
+
**/
|
|
3567
|
+
totalBalance?: CurrencyAmount | undefined,
|
|
3568
|
+
/**
|
|
3569
|
+
* The total sum of the channel balances (online and offline) on this node.
|
|
3570
|
+
*
|
|
3571
|
+
* @deprecated Use `balances` instead.
|
|
3572
|
+
**/
|
|
3573
|
+
totalLocalBalance?: CurrencyAmount | undefined,
|
|
3574
|
+
/**
|
|
3575
|
+
* The sum of the channel balances (online only) that are available to send on this node.
|
|
3576
|
+
*
|
|
3577
|
+
* @deprecated Use `balances` instead.
|
|
3578
|
+
**/
|
|
3579
|
+
localBalance?: CurrencyAmount | undefined,
|
|
3580
|
+
/**
|
|
3581
|
+
* The sum of the channel balances that are available to receive on this node.
|
|
3582
|
+
*
|
|
3583
|
+
* @deprecated Use `balances` instead.
|
|
3584
|
+
**/
|
|
3585
|
+
remoteBalance?: CurrencyAmount | undefined,
|
|
3586
|
+
/**
|
|
3587
|
+
* The details of the balance of this node on the Bitcoin Network.
|
|
3588
|
+
*
|
|
3589
|
+
* @deprecated Use `balances` instead.
|
|
3590
|
+
**/
|
|
3591
|
+
blockchainBalance?: BlockchainBalance | undefined,
|
|
3592
|
+
/** The balances that describe the funds in this node. **/
|
|
3593
|
+
balances?: Balances | undefined);
|
|
2234
3594
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
2235
3595
|
getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
2236
3596
|
static getLightsparkNodeWithRemoteSigningQuery(id: string): Query<LightsparkNodeWithRemoteSigning>;
|
|
@@ -2603,9 +3963,11 @@ declare enum WebhookEventType {
|
|
|
2603
3963
|
*/
|
|
2604
3964
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2605
3965
|
PAYMENT_FINISHED = "PAYMENT_FINISHED",
|
|
3966
|
+
FORCE_CLOSURE = "FORCE_CLOSURE",
|
|
2606
3967
|
WITHDRAWAL_FINISHED = "WITHDRAWAL_FINISHED",
|
|
2607
3968
|
FUNDS_RECEIVED = "FUNDS_RECEIVED",
|
|
2608
3969
|
NODE_STATUS = "NODE_STATUS",
|
|
3970
|
+
UMA_INVITATION_CLAIMED = "UMA_INVITATION_CLAIMED",
|
|
2609
3971
|
WALLET_STATUS = "WALLET_STATUS",
|
|
2610
3972
|
WALLET_OUTGOING_PAYMENT_FINISHED = "WALLET_OUTGOING_PAYMENT_FINISHED",
|
|
2611
3973
|
WALLET_INCOMING_PAYMENT_FINISHED = "WALLET_INCOMING_PAYMENT_FINISHED",
|
|
@@ -2660,4 +4022,4 @@ interface Withdrawal {
|
|
|
2660
4022
|
}
|
|
2661
4023
|
declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
|
|
2662
4024
|
|
|
2663
|
-
export {
|
|
4025
|
+
export { FeeEstimate as $, Account as A, Balances as B, Channel as C, CreateInvitationWithIncentivesOutput as D, CreateInvoiceInput as E, CreateInvoiceOutput as F, CreateLnurlInvoiceInput as G, CreateNodeWalletAddressInput as H, CreateNodeWalletAddressOutput as I, CreateTestModeInvoiceInput as J, CreateTestModeInvoiceOutput as K, LightsparkClient as L, CreateTestModePaymentInput as M, CreateTestModePaymentoutput as N, CreateUmaInvitationInput as O, CreateUmaInvitationOutput as P, CreateUmaInvoiceInput as Q, CurrencyAmount as R, CurrencyUnit as S, DeclineToSignMessagesInput as T, DeclineToSignMessagesOutput as U, DeleteApiTokenInput as V, WebhookEventType as W, DeleteApiTokenOutput as X, Deposit as Y, getDepositQuery as Z, Entity as _, AccountToApiTokensConnection as a, ReleasePaymentPreimageOutput as a$, FundNodeInput as a0, FundNodeOutput as a1, GraphNode as a2, Hop as a3, getHopQuery as a4, HtlcAttemptFailureCode as a5, IdAndSignature as a6, IncentivesIneligibilityReason as a7, IncentivesStatus as a8, IncomingPayment as a9, OnChainTransaction as aA, getOnChainTransactionQuery as aB, OutgoingPayment as aC, OutgoingPaymentAttempt as aD, OutgoingPaymentAttemptStatus as aE, OutgoingPaymentAttemptToHopsConnection as aF, OutgoingPaymentsForInvoiceQueryInput as aG, OutgoingPaymentsForInvoiceQueryOutput as aH, OutgoingPaymentToAttemptsConnection as aI, PageInfo as aJ, PayInvoiceInput as aK, PayInvoiceOutput as aL, PaymentDirection as aM, PaymentFailureReason as aN, PaymentRequest as aO, getPaymentRequestQuery as aP, PaymentRequestData as aQ, PaymentRequestStatus as aR, PayUmaInvoiceInput as aS, Permission as aT, PostTransactionData as aU, RegionCode as aV, RegisterPaymentInput as aW, RegisterPaymentOutput as aX, ReleaseChannelPerCommitmentSecretInput as aY, ReleaseChannelPerCommitmentSecretOutput as aZ, ReleasePaymentPreimageInput as a_, IncomingPaymentAttempt as aa, getIncomingPaymentAttemptQuery as ab, IncomingPaymentAttemptStatus as ac, IncomingPaymentToAttemptsConnection as ad, Invoice as ae, getInvoiceQuery as af, InvoiceData as ag, InvoiceType as ah, LightningFeeEstimateForInvoiceInput as ai, LightningFeeEstimateForNodeInput as aj, LightningFeeEstimateOutput as ak, LightningTransaction as al, getLightningTransactionQuery as am, LightsparkNode as an, getLightsparkNodeQuery as ao, LightsparkNodeOwner as ap, getLightsparkNodeOwnerQuery as aq, LightsparkNodeStatus as ar, LightsparkNodeToChannelsConnection as as, LightsparkNodeWithOSK as at, LightsparkNodeWithRemoteSigning as au, Node as av, getNodeQuery as aw, NodeAddress as ax, NodeAddressType as ay, NodeToAddressesConnection as az, AccountToChannelsConnection as b, RemoteSigningSubEventType as b0, RequestWithdrawalInput as b1, RequestWithdrawalOutput as b2, RichText as b3, RiskRating as b4, RoutingTransaction as b5, getRoutingTransactionQuery as b6, RoutingTransactionFailureReason as b7, ScreenNodeInput as b8, ScreenNodeOutput as b9, UpdateNodeSharedSecretOutput as bA, Wallet as bB, WalletStatus as bC, WalletToPaymentRequestsConnection as bD, WalletToTransactionsConnection as bE, Withdrawal as bF, getWithdrawalQuery as bG, WithdrawalMode as bH, WithdrawalRequest as bI, WithdrawalRequestStatus as bJ, WithdrawalRequestToChannelClosingTransactionsConnection as bK, WithdrawalRequestToChannelOpeningTransactionsConnection as bL, Secret as ba, SendPaymentInput as bb, SendPaymentOutput as bc, SetInvoicePaymentHashInput as bd, SetInvoicePaymentHashOutput as be, Signable as bf, getSignableQuery as bg, SignablePayload as bh, getSignablePayloadQuery as bi, SignablePayloadStatus as bj, SignInvoiceInput as bk, SignInvoiceOutput as bl, SignMessagesInput as bm, SignMessagesOutput as bn, SingleNodeDashboard as bo, Transaction as bp, getTransactionQuery as bq, TransactionFailures as br, TransactionStatus as bs, TransactionType as bt, TransactionUpdate as bu, UmaInvitation as bv, getUmaInvitationQuery as bw, UpdateChannelPerCommitmentPointInput as bx, UpdateChannelPerCommitmentPointOutput as by, UpdateNodeSharedSecretInput as bz, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BlockchainBalance as i, ChannelClosingTransaction as j, getChannelClosingTransactionQuery as k, ChannelFees as l, ChannelOpeningTransaction as m, getChannelOpeningTransactionQuery as n, ChannelSnapshot as o, ChannelStatus as p, ChannelToTransactionsConnection as q, ClaimUmaInvitationInput as r, ClaimUmaInvitationOutput as s, ClaimUmaInvitationWithIncentivesInput as t, ClaimUmaInvitationWithIncentivesOutput as u, ComplianceProvider as v, Connection as w, CreateApiTokenInput as x, CreateApiTokenOutput as y, CreateInvitationWithIncentivesInput as z };
|