@lightsparkdev/lightspark-sdk 1.2.2 → 1.2.3
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 +8 -0
- package/dist/{BitcoinNetwork-a816c0be.d.ts → BitcoinNetwork-37e9f091.d.ts} +8 -3
- package/dist/env.d.cts +1 -1
- package/dist/env.d.ts +1 -1
- package/dist/{index-eb604025.d.ts → index-449c9f58.d.ts} +1461 -675
- package/dist/index.cjs +341 -307
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +323 -289
- package/dist/objects/index.d.cts +2 -2
- package/dist/objects/index.d.ts +2 -2
- package/dist/objects/index.js +1 -1
- package/package.json +4 -4
- package/src/NodeKeyLoaderCache.ts +4 -3
- package/src/SigningKeyLoader.ts +12 -7
- package/src/client.ts +99 -65
- package/src/env.ts +3 -1
- package/src/objects/Account.ts +7 -3
- package/src/objects/AccountToApiTokensConnection.ts +7 -3
- package/src/objects/AccountToChannelsConnection.ts +3 -2
- package/src/objects/AccountToNodesConnection.ts +7 -3
- package/src/objects/AccountToPaymentRequestsConnection.ts +7 -3
- package/src/objects/AccountToTransactionsConnection.ts +13 -9
- package/src/objects/AccountToWalletsConnection.ts +7 -3
- package/src/objects/ApiToken.ts +13 -7
- package/src/objects/Balances.ts +22 -12
- package/src/objects/BitcoinNetwork.ts +8 -3
- package/src/objects/BlockchainBalance.ts +4 -1
- package/src/objects/Channel.ts +37 -14
- package/src/objects/ChannelClosingTransaction.ts +22 -11
- package/src/objects/ChannelFees.ts +4 -1
- package/src/objects/ChannelOpeningTransaction.ts +22 -11
- package/src/objects/ChannelStatus.ts +33 -8
- package/src/objects/ChannelToTransactionsConnection.ts +9 -8
- package/src/objects/ComplianceProvider.ts +3 -2
- package/src/objects/Connection.ts +7 -3
- package/src/objects/CreateApiTokenInput.ts +4 -1
- package/src/objects/CreateApiTokenOutput.ts +3 -3
- package/src/objects/CreateLnurlInvoiceInput.ts +3 -2
- package/src/objects/CreateTestModePaymentInput.ts +2 -2
- package/src/objects/CreateTestModePaymentoutput.ts +5 -1
- package/src/objects/CurrencyAmount.ts +6 -4
- package/src/objects/CurrencyUnit.ts +36 -9
- package/src/objects/Deposit.ts +22 -11
- package/src/objects/Entity.ts +8 -3
- package/src/objects/FeeEstimate.ts +5 -1
- package/src/objects/GraphNode.ts +30 -14
- package/src/objects/Hop.ts +12 -4
- package/src/objects/HtlcAttemptFailureCode.ts +7 -3
- package/src/objects/IncentivesIneligibilityReason.ts +33 -9
- package/src/objects/IncentivesStatus.ts +14 -4
- package/src/objects/IncomingPayment.ts +18 -7
- package/src/objects/IncomingPaymentAttempt.ts +8 -3
- package/src/objects/IncomingPaymentAttemptStatus.ts +7 -3
- package/src/objects/IncomingPaymentToAttemptsConnection.ts +7 -3
- package/src/objects/Invoice.ts +2 -2
- package/src/objects/InvoiceData.ts +7 -3
- package/src/objects/InvoiceType.ts +3 -2
- package/src/objects/LightningFeeEstimateForInvoiceInput.ts +2 -2
- package/src/objects/LightningTransaction.ts +12 -4
- package/src/objects/LightsparkNode.ts +33 -18
- package/src/objects/LightsparkNodeOwner.ts +2 -2
- package/src/objects/LightsparkNodeStatus.ts +3 -2
- package/src/objects/LightsparkNodeToChannelsConnection.ts +7 -3
- package/src/objects/LightsparkNodeWithOSK.ts +35 -19
- package/src/objects/LightsparkNodeWithRemoteSigning.ts +31 -18
- package/src/objects/Node.ts +28 -14
- package/src/objects/NodeAddressType.ts +7 -3
- package/src/objects/NodeToAddressesConnection.ts +7 -3
- package/src/objects/OnChainTransaction.ts +23 -11
- package/src/objects/OutgoingPayment.ts +24 -7
- package/src/objects/OutgoingPaymentAttempt.ts +28 -13
- package/src/objects/OutgoingPaymentAttemptStatus.ts +7 -3
- package/src/objects/OutgoingPaymentAttemptToHopsConnection.ts +12 -4
- package/src/objects/OutgoingPaymentToAttemptsConnection.ts +7 -3
- package/src/objects/PageInfo.ts +6 -1
- package/src/objects/PayInvoiceInput.ts +6 -3
- package/src/objects/PaymentDirection.ts +3 -2
- package/src/objects/PaymentFailureReason.ts +7 -3
- package/src/objects/PaymentRequest.ts +8 -3
- package/src/objects/PaymentRequestData.ts +5 -1
- package/src/objects/PaymentRequestStatus.ts +7 -3
- package/src/objects/Permission.ts +7 -3
- package/src/objects/PostTransactionData.ts +6 -3
- package/src/objects/RegionCode.ts +43 -12
- package/src/objects/RegisterPaymentInput.ts +12 -7
- package/src/objects/RemoteSigningSubEventType.ts +7 -3
- package/src/objects/RequestWithdrawalInput.ts +2 -2
- package/src/objects/RiskRating.ts +8 -3
- package/src/objects/RoutingTransaction.ts +20 -7
- package/src/objects/RoutingTransactionFailureReason.ts +8 -3
- package/src/objects/ScreenNodeInput.ts +3 -2
- package/src/objects/SendPaymentInput.ts +4 -1
- package/src/objects/SetInvoicePaymentHashInput.ts +3 -2
- package/src/objects/Signable.ts +2 -2
- package/src/objects/SignablePayload.ts +6 -3
- package/src/objects/SignablePayloadStatus.ts +3 -2
- package/src/objects/Transaction.ts +14 -4
- package/src/objects/TransactionFailures.ts +4 -1
- package/src/objects/TransactionStatus.ts +16 -5
- package/src/objects/TransactionType.ts +30 -8
- package/src/objects/TransactionUpdate.ts +6 -3
- package/src/objects/UmaInvitation.ts +10 -4
- package/src/objects/Wallet.ts +13 -4
- package/src/objects/WalletStatus.ts +36 -9
- package/src/objects/WalletToPaymentRequestsConnection.ts +7 -3
- package/src/objects/WalletToTransactionsConnection.ts +7 -3
- package/src/objects/WebhookEventType.ts +7 -3
- package/src/objects/Withdrawal.ts +22 -11
- package/src/objects/WithdrawalMode.ts +7 -3
- package/src/objects/WithdrawalRequest.ts +15 -6
- package/src/objects/WithdrawalRequestStatus.ts +3 -2
- package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +11 -4
- package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +11 -4
- package/src/objects/index.ts +6 -6
- package/src/tests/integration/general-regtest.test.ts +1 -1
- /package/dist/{chunk-GLL4KTUT.js → chunk-NCPWHRFO.js} +0 -0
|
@@ -1,27 +1,78 @@
|
|
|
1
1
|
import { Maybe, Query, AuthProvider, CryptoInterface, SigningKey, KeyOrAliasType } from '@lightsparkdev/core';
|
|
2
2
|
import Observable from 'zen-observable';
|
|
3
|
-
import { B as BitcoinNetwork } from './BitcoinNetwork-
|
|
3
|
+
import { B as BitcoinNetwork } from './BitcoinNetwork-37e9f091.js';
|
|
4
4
|
|
|
5
|
-
/**
|
|
5
|
+
/**
|
|
6
|
+
* Args for creating a new SigningKeyLoader. Must be one of the sub types.
|
|
7
|
+
*/
|
|
8
|
+
type SigningKeyLoaderArgs = NodeIdAndPasswordSigningKeyLoaderArgs | MasterSeedSigningKeyLoaderArgs;
|
|
9
|
+
/**
|
|
10
|
+
* Args for creating a new SigningKeyLoader from a node ID and password.
|
|
11
|
+
* This cannot be used if you are using remote signing.
|
|
12
|
+
* It is used to recover an RSA operation signing key using the password you
|
|
13
|
+
* chose when setting up your node. For REGTEST nodes, the password is
|
|
14
|
+
* "1234!@#$".
|
|
15
|
+
*/
|
|
16
|
+
interface NodeIdAndPasswordSigningKeyLoaderArgs {
|
|
17
|
+
password: string;
|
|
18
|
+
}
|
|
19
|
+
/**
|
|
20
|
+
* Args for creating a new SigningKeyLoader from a master seed and network.
|
|
21
|
+
* This should be used if you are using remote signing,
|
|
22
|
+
* rather than an RSA operation signing key.
|
|
23
|
+
*/
|
|
24
|
+
interface MasterSeedSigningKeyLoaderArgs {
|
|
25
|
+
masterSeed: Uint8Array;
|
|
26
|
+
network: BitcoinNetwork;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
* This enum identifies the unit of currency associated with a CurrencyAmount.
|
|
31
|
+
* *
|
|
32
|
+
*/
|
|
6
33
|
declare enum CurrencyUnit {
|
|
7
34
|
/**
|
|
8
|
-
* This is an enum value that represents values that could be added in the
|
|
9
|
-
* Clients should support unknown values as more of them could be
|
|
35
|
+
* This is an enum value that represents values that could be added in the
|
|
36
|
+
* future. Clients should support unknown values as more of them could be
|
|
37
|
+
* added without notice.
|
|
10
38
|
*/
|
|
11
39
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
12
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* Bitcoin is the cryptocurrency native to the Bitcoin network.
|
|
42
|
+
* It is used as the native medium for value transfer for the Lightning
|
|
43
|
+
* Network. *
|
|
44
|
+
*/
|
|
13
45
|
BITCOIN = "BITCOIN",
|
|
14
|
-
/**
|
|
46
|
+
/**
|
|
47
|
+
* 0.00000001 (10e-8) Bitcoin or one hundred millionth of a Bitcoin.
|
|
48
|
+
* This is the unit most commonly used in Lightning transactions.
|
|
49
|
+
* *
|
|
50
|
+
*/
|
|
15
51
|
SATOSHI = "SATOSHI",
|
|
16
|
-
/**
|
|
52
|
+
/**
|
|
53
|
+
* 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit
|
|
54
|
+
* instead when possible. *
|
|
55
|
+
*/
|
|
17
56
|
MILLISATOSHI = "MILLISATOSHI",
|
|
18
57
|
/** United States Dollar. **/
|
|
19
58
|
USD = "USD",
|
|
20
|
-
/**
|
|
59
|
+
/**
|
|
60
|
+
* 0.000000001 (10e-9) Bitcoin or a billionth of a Bitcoin.
|
|
61
|
+
* We recommend using the Satoshi unit instead when possible.
|
|
62
|
+
* *
|
|
63
|
+
*/
|
|
21
64
|
NANOBITCOIN = "NANOBITCOIN",
|
|
22
|
-
/**
|
|
65
|
+
/**
|
|
66
|
+
* 0.000001 (10e-6) Bitcoin or a millionth of a Bitcoin.
|
|
67
|
+
* We recommend using the Satoshi unit instead when possible.
|
|
68
|
+
* *
|
|
69
|
+
*/
|
|
23
70
|
MICROBITCOIN = "MICROBITCOIN",
|
|
24
|
-
/**
|
|
71
|
+
/**
|
|
72
|
+
* 0.001 (10e-3) Bitcoin or a thousandth of a Bitcoin.
|
|
73
|
+
* We recommend using the Satoshi unit instead when possible.
|
|
74
|
+
* *
|
|
75
|
+
*/
|
|
25
76
|
MILLIBITCOIN = "MILLIBITCOIN"
|
|
26
77
|
}
|
|
27
78
|
|
|
@@ -34,21 +85,24 @@ interface CurrencyAmount {
|
|
|
34
85
|
/** The unit of user's preferred currency. **/
|
|
35
86
|
preferredCurrencyUnit: CurrencyUnit;
|
|
36
87
|
/**
|
|
37
|
-
* The rounded numeric value for this CurrencyAmount in the very base level
|
|
38
|
-
* currency. For example, for USD, the value will be in
|
|
88
|
+
* The rounded numeric value for this CurrencyAmount in the very base level
|
|
89
|
+
* of user's preferred currency. For example, for USD, the value will be in
|
|
90
|
+
* cents.
|
|
39
91
|
**/
|
|
40
92
|
preferredCurrencyValueRounded: number;
|
|
41
93
|
/**
|
|
42
|
-
* The approximate float value for this CurrencyAmount in the very base level
|
|
43
|
-
* currency. For example, for USD, the value will be in
|
|
94
|
+
* The approximate float value for this CurrencyAmount in the very base level
|
|
95
|
+
* of user's preferred currency. For example, for USD, the value will be in
|
|
96
|
+
* cents.
|
|
44
97
|
**/
|
|
45
98
|
preferredCurrencyValueApprox: number;
|
|
46
99
|
}
|
|
47
100
|
|
|
48
101
|
declare enum LightsparkNodeStatus {
|
|
49
102
|
/**
|
|
50
|
-
* This is an enum value that represents values that could be added in the
|
|
51
|
-
* Clients should support unknown values as more of them could be
|
|
103
|
+
* This is an enum value that represents values that could be added in the
|
|
104
|
+
* future. Clients should support unknown values as more of them could be
|
|
105
|
+
* added without notice.
|
|
52
106
|
*/
|
|
53
107
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
54
108
|
CREATED = "CREATED",
|
|
@@ -63,11 +117,15 @@ declare enum LightsparkNodeStatus {
|
|
|
63
117
|
FAILED_TO_DEPLOY = "FAILED_TO_DEPLOY"
|
|
64
118
|
}
|
|
65
119
|
|
|
66
|
-
/**
|
|
120
|
+
/**
|
|
121
|
+
* This is an enum of the potential types of addresses that a node on the
|
|
122
|
+
* Lightning Network can have. *
|
|
123
|
+
*/
|
|
67
124
|
declare enum NodeAddressType {
|
|
68
125
|
/**
|
|
69
|
-
* This is an enum value that represents values that could be added in the
|
|
70
|
-
* Clients should support unknown values as more of them could be
|
|
126
|
+
* This is an enum value that represents values that could be added in the
|
|
127
|
+
* future. Clients should support unknown values as more of them could be
|
|
128
|
+
* added without notice.
|
|
71
129
|
*/
|
|
72
130
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
73
131
|
IPV4 = "IPV4",
|
|
@@ -108,11 +166,15 @@ type AccountDashboard = {
|
|
|
108
166
|
remoteBalance: Maybe<CurrencyAmount>;
|
|
109
167
|
};
|
|
110
168
|
|
|
111
|
-
/**
|
|
169
|
+
/**
|
|
170
|
+
* This is an enum of the potential permissions that a Lightspark user can have
|
|
171
|
+
* in regards to account management. *
|
|
172
|
+
*/
|
|
112
173
|
declare enum Permission {
|
|
113
174
|
/**
|
|
114
|
-
* This is an enum value that represents values that could be added in the
|
|
115
|
-
* Clients should support unknown values as more of them could be
|
|
175
|
+
* This is an enum value that represents values that could be added in the
|
|
176
|
+
* future. Clients should support unknown values as more of them could be
|
|
177
|
+
* added without notice.
|
|
116
178
|
*/
|
|
117
179
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
118
180
|
ALL = "ALL",
|
|
@@ -131,11 +193,16 @@ declare enum Permission {
|
|
|
131
193
|
ACCOUNT_MANAGE = "ACCOUNT_MANAGE"
|
|
132
194
|
}
|
|
133
195
|
|
|
134
|
-
/**
|
|
196
|
+
/**
|
|
197
|
+
* This is an object representing a Lightspark API token,
|
|
198
|
+
* that can be used to authenticate this account when making API calls or using
|
|
199
|
+
* our SDKs. See the “Authentication” section of our API docs for more details
|
|
200
|
+
* on its usage. *
|
|
201
|
+
*/
|
|
135
202
|
interface ApiToken {
|
|
136
203
|
/**
|
|
137
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
138
|
-
* string.
|
|
204
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
205
|
+
* Should be treated as an opaque string.
|
|
139
206
|
**/
|
|
140
207
|
id: string;
|
|
141
208
|
/** The date and time when the entity was first created. **/
|
|
@@ -143,13 +210,14 @@ interface ApiToken {
|
|
|
143
210
|
/** The date and time when the entity was last updated. **/
|
|
144
211
|
updatedAt: string;
|
|
145
212
|
/**
|
|
146
|
-
* An opaque identifier that should be used as a client_id (or username) in
|
|
147
|
-
* Authentication scheme when issuing requests against the
|
|
213
|
+
* An opaque identifier that should be used as a client_id (or username) in
|
|
214
|
+
* the HTTP Basic Authentication scheme when issuing requests against the
|
|
215
|
+
* Lightspark API.
|
|
148
216
|
**/
|
|
149
217
|
clientId: string;
|
|
150
218
|
/**
|
|
151
|
-
* An arbitrary name chosen by the creator of the token to help identify the
|
|
152
|
-
* tokens that have been created for the account.
|
|
219
|
+
* An arbitrary name chosen by the creator of the token to help identify the
|
|
220
|
+
* token in the list of tokens that have been created for the account.
|
|
153
221
|
**/
|
|
154
222
|
name: string;
|
|
155
223
|
/** A list of permissions granted to the token. **/
|
|
@@ -159,7 +227,12 @@ interface ApiToken {
|
|
|
159
227
|
}
|
|
160
228
|
declare const getApiTokenQuery: (id: string) => Query<ApiToken>;
|
|
161
229
|
|
|
162
|
-
/**
|
|
230
|
+
/**
|
|
231
|
+
* This is an object representing information about a page returned by the
|
|
232
|
+
* Lightspark API. For more information,
|
|
233
|
+
* please see the “Pagination” section of our API docs for more information
|
|
234
|
+
* about its usage. *
|
|
235
|
+
*/
|
|
163
236
|
interface PageInfo {
|
|
164
237
|
hasNextPage?: boolean | undefined;
|
|
165
238
|
hasPreviousPage?: boolean | undefined;
|
|
@@ -169,11 +242,15 @@ interface PageInfo {
|
|
|
169
242
|
|
|
170
243
|
interface AccountToApiTokensConnection {
|
|
171
244
|
/**
|
|
172
|
-
* The total count of objects in this connection, using the current filters.
|
|
173
|
-
* number of objects returned in the current page
|
|
245
|
+
* The total count of objects in this connection, using the current filters.
|
|
246
|
+
* It is different from the number of objects returned in the current page
|
|
247
|
+
* (in the `entities` field).
|
|
174
248
|
**/
|
|
175
249
|
count: number;
|
|
176
|
-
/**
|
|
250
|
+
/**
|
|
251
|
+
* An object that holds pagination information about the objects in this
|
|
252
|
+
* connection. *
|
|
253
|
+
*/
|
|
177
254
|
pageInfo: PageInfo;
|
|
178
255
|
/** The API tokens for the current page of this connection. **/
|
|
179
256
|
entities: ApiToken[];
|
|
@@ -181,30 +258,58 @@ interface AccountToApiTokensConnection {
|
|
|
181
258
|
typename: string;
|
|
182
259
|
}
|
|
183
260
|
|
|
184
|
-
/**
|
|
261
|
+
/**
|
|
262
|
+
* This is an enum representing the status of a channel on the Lightning
|
|
263
|
+
* Network. *
|
|
264
|
+
*/
|
|
185
265
|
declare enum ChannelStatus {
|
|
186
266
|
/**
|
|
187
|
-
* This is an enum value that represents values that could be added in the
|
|
188
|
-
* Clients should support unknown values as more of them could be
|
|
267
|
+
* This is an enum value that represents values that could be added in the
|
|
268
|
+
* future. Clients should support unknown values as more of them could be
|
|
269
|
+
* added without notice.
|
|
189
270
|
*/
|
|
190
271
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
191
272
|
/** The channel is online and ready to send and receive funds. **/
|
|
192
273
|
OK = "OK",
|
|
193
|
-
/**
|
|
274
|
+
/**
|
|
275
|
+
* The channel has been created, but the Bitcoin transaction that initiates
|
|
276
|
+
* it still needs to be confirmed on the Bitcoin blockchain.
|
|
277
|
+
* *
|
|
278
|
+
*/
|
|
194
279
|
PENDING = "PENDING",
|
|
195
280
|
/** The channel is not available, likely because the peer is not online. **/
|
|
196
281
|
OFFLINE = "OFFLINE",
|
|
197
|
-
/**
|
|
282
|
+
/**
|
|
283
|
+
* The channel is behaving properly, but its remote balance is much higher
|
|
284
|
+
* than its local balance so it is not balanced properly for sending funds
|
|
285
|
+
* out.
|
|
286
|
+
* *
|
|
287
|
+
*/
|
|
198
288
|
UNBALANCED_FOR_SEND = "UNBALANCED_FOR_SEND",
|
|
199
|
-
/**
|
|
289
|
+
/**
|
|
290
|
+
* The channel is behaving properly, but its remote balance is much lower
|
|
291
|
+
* than its local balance so it is not balanced properly for receiving funds.
|
|
292
|
+
* *
|
|
293
|
+
*/
|
|
200
294
|
UNBALANCED_FOR_RECEIVE = "UNBALANCED_FOR_RECEIVE",
|
|
201
|
-
/**
|
|
295
|
+
/**
|
|
296
|
+
* The channel has been closed. Information about the channel is still
|
|
297
|
+
* available for historical purposes but the channel cannot be used anymore.
|
|
298
|
+
* *
|
|
299
|
+
*/
|
|
202
300
|
CLOSED = "CLOSED",
|
|
203
|
-
/**
|
|
301
|
+
/**
|
|
302
|
+
* Something unexpected happened and we cannot determine the status of this
|
|
303
|
+
* channel. Please try again later or contact the support.
|
|
304
|
+
* *
|
|
305
|
+
*/
|
|
204
306
|
ERROR = "ERROR"
|
|
205
307
|
}
|
|
206
308
|
|
|
207
|
-
/**
|
|
309
|
+
/**
|
|
310
|
+
* This represents the fee policies set for a channel on the Lightning Network.
|
|
311
|
+
* *
|
|
312
|
+
*/
|
|
208
313
|
interface ChannelFees {
|
|
209
314
|
baseFee?: CurrencyAmount | undefined;
|
|
210
315
|
feeRatePerMil?: number | undefined;
|
|
@@ -212,32 +317,38 @@ interface ChannelFees {
|
|
|
212
317
|
|
|
213
318
|
interface ChannelToTransactionsConnection {
|
|
214
319
|
/**
|
|
215
|
-
* The total count of objects in this connection, using the current filters.
|
|
216
|
-
* number of objects returned in the current page
|
|
320
|
+
* The total count of objects in this connection, using the current filters.
|
|
321
|
+
* It is different from the number of objects returned in the current page
|
|
322
|
+
* (in the `entities` field).
|
|
217
323
|
**/
|
|
218
324
|
count: number;
|
|
219
325
|
/**
|
|
220
|
-
* The average fee for the transactions that transited through this channel,
|
|
221
|
-
* and constraints of the connection.
|
|
326
|
+
* The average fee for the transactions that transited through this channel,
|
|
327
|
+
* according to the filters and constraints of the connection.
|
|
222
328
|
**/
|
|
223
329
|
averageFee?: CurrencyAmount | undefined;
|
|
224
330
|
/**
|
|
225
|
-
* The total amount transacted for the transactions that transited through
|
|
226
|
-
* the filters and constraints of the connection.
|
|
331
|
+
* The total amount transacted for the transactions that transited through
|
|
332
|
+
* this channel, according to the filters and constraints of the connection.
|
|
227
333
|
**/
|
|
228
334
|
totalAmountTransacted?: CurrencyAmount | undefined;
|
|
229
335
|
/**
|
|
230
|
-
* The total amount of fees for the transactions that transited through this
|
|
231
|
-
* filters and constraints of the connection.
|
|
336
|
+
* The total amount of fees for the transactions that transited through this
|
|
337
|
+
* channel, according to the filters and constraints of the connection.
|
|
232
338
|
**/
|
|
233
339
|
totalFees?: CurrencyAmount | undefined;
|
|
234
340
|
}
|
|
235
341
|
|
|
236
|
-
/**
|
|
342
|
+
/**
|
|
343
|
+
* This interface is used by all the entities in the Lightspark system.
|
|
344
|
+
* It defines a few core fields that are available everywhere.
|
|
345
|
+
* Any object that implements this interface can be queried using the `entity`
|
|
346
|
+
* query and its ID. *
|
|
347
|
+
*/
|
|
237
348
|
interface Entity {
|
|
238
349
|
/**
|
|
239
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
240
|
-
* string.
|
|
350
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
351
|
+
* Should be treated as an opaque string.
|
|
241
352
|
**/
|
|
242
353
|
id: string;
|
|
243
354
|
/** The date and time when the entity was first created. **/
|
|
@@ -248,40 +359,66 @@ interface Entity {
|
|
|
248
359
|
typename: string;
|
|
249
360
|
}
|
|
250
361
|
|
|
251
|
-
/**
|
|
362
|
+
/**
|
|
363
|
+
* This is an enum of the potential types of transactions that can be
|
|
364
|
+
* associated with your Lightspark Node.
|
|
365
|
+
* *
|
|
366
|
+
*/
|
|
252
367
|
declare enum TransactionType {
|
|
253
368
|
/**
|
|
254
|
-
* This is an enum value that represents values that could be added in the
|
|
255
|
-
* Clients should support unknown values as more of them could be
|
|
369
|
+
* This is an enum value that represents values that could be added in the
|
|
370
|
+
* future. Clients should support unknown values as more of them could be
|
|
371
|
+
* added without notice.
|
|
256
372
|
*/
|
|
257
373
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
258
374
|
/** Transactions initiated from a Lightspark node on Lightning Network. **/
|
|
259
375
|
OUTGOING_PAYMENT = "OUTGOING_PAYMENT",
|
|
260
376
|
/** Transactions received by a Lightspark node on Lightning Network. **/
|
|
261
377
|
INCOMING_PAYMENT = "INCOMING_PAYMENT",
|
|
262
|
-
/**
|
|
378
|
+
/**
|
|
379
|
+
* Transactions that forwarded payments through Lightspark nodes on Lightning
|
|
380
|
+
* Network. *
|
|
381
|
+
*/
|
|
263
382
|
ROUTED = "ROUTED",
|
|
264
|
-
/**
|
|
383
|
+
/**
|
|
384
|
+
* Transactions on the Bitcoin blockchain to withdraw funds from a Lightspark
|
|
385
|
+
* node to a Bitcoin wallet. *
|
|
386
|
+
*/
|
|
265
387
|
L1_WITHDRAW = "L1_WITHDRAW",
|
|
266
388
|
/** Transactions on Bitcoin blockchain to fund a Lightspark node's wallet. **/
|
|
267
389
|
L1_DEPOSIT = "L1_DEPOSIT",
|
|
268
|
-
/**
|
|
390
|
+
/**
|
|
391
|
+
* Transactions on Bitcoin blockchain to open a channel on Lightning Network
|
|
392
|
+
* funded by the local Lightspark node.
|
|
393
|
+
* *
|
|
394
|
+
*/
|
|
269
395
|
CHANNEL_OPEN = "CHANNEL_OPEN",
|
|
270
|
-
/**
|
|
396
|
+
/**
|
|
397
|
+
* Transactions on Bitcoin blockchain to close a channel on Lightning Network
|
|
398
|
+
* where the balances are allocated back to local and remote nodes.
|
|
399
|
+
* *
|
|
400
|
+
*/
|
|
271
401
|
CHANNEL_CLOSE = "CHANNEL_CLOSE",
|
|
272
402
|
/** Transactions initiated from a Lightspark node on Lightning Network. **/
|
|
273
403
|
PAYMENT = "PAYMENT",
|
|
274
404
|
/** Payment requests from a Lightspark node on Lightning Network **/
|
|
275
405
|
PAYMENT_REQUEST = "PAYMENT_REQUEST",
|
|
276
|
-
/**
|
|
406
|
+
/**
|
|
407
|
+
* Transactions that forwarded payments through Lightspark nodes on Lightning
|
|
408
|
+
* Network. *
|
|
409
|
+
*/
|
|
277
410
|
ROUTE = "ROUTE"
|
|
278
411
|
}
|
|
279
412
|
|
|
280
|
-
/**
|
|
413
|
+
/**
|
|
414
|
+
* This is an object representing a channel on the Lightning Network.
|
|
415
|
+
* You can retrieve this object to get detailed information on a specific
|
|
416
|
+
* Lightning Network channel. *
|
|
417
|
+
*/
|
|
281
418
|
declare class Channel implements Entity {
|
|
282
419
|
/**
|
|
283
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
284
|
-
* string.
|
|
420
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
421
|
+
* Should be treated as an opaque string.
|
|
285
422
|
**/
|
|
286
423
|
readonly id: string;
|
|
287
424
|
/** The date and time when the entity was first created. **/
|
|
@@ -295,44 +432,63 @@ declare class Channel implements Entity {
|
|
|
295
432
|
/** The transaction that funded the channel upon channel opening. **/
|
|
296
433
|
readonly fundingTransactionId?: string | undefined;
|
|
297
434
|
/**
|
|
298
|
-
* The total amount of funds in this channel,
|
|
299
|
-
* channel balance on the
|
|
435
|
+
* The total amount of funds in this channel,
|
|
436
|
+
* including the channel balance on the local node,
|
|
437
|
+
* the channel balance on the remote node and the on-chain fees to close
|
|
438
|
+
* the channel.
|
|
300
439
|
**/
|
|
301
440
|
readonly capacity?: CurrencyAmount | undefined;
|
|
302
441
|
/** The channel balance on the local node. **/
|
|
303
442
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
304
|
-
/**
|
|
443
|
+
/**
|
|
444
|
+
* The channel balance on the local node that is currently allocated to
|
|
445
|
+
* in-progress payments. *
|
|
446
|
+
*/
|
|
305
447
|
readonly localUnsettledBalance?: CurrencyAmount | undefined;
|
|
306
448
|
/** The channel balance on the remote node. **/
|
|
307
449
|
readonly remoteBalance?: CurrencyAmount | undefined;
|
|
308
|
-
/**
|
|
450
|
+
/**
|
|
451
|
+
* The channel balance on the remote node that is currently allocated to
|
|
452
|
+
* in-progress payments. *
|
|
453
|
+
*/
|
|
309
454
|
readonly remoteUnsettledBalance?: CurrencyAmount | undefined;
|
|
310
|
-
/**
|
|
455
|
+
/**
|
|
456
|
+
* The channel balance that is currently allocated to in-progress payments.
|
|
457
|
+
* *
|
|
458
|
+
*/
|
|
311
459
|
readonly unsettledBalance?: CurrencyAmount | undefined;
|
|
312
|
-
/**
|
|
460
|
+
/**
|
|
461
|
+
* The total balance in this channel,
|
|
462
|
+
* including the channel balance on both local and remote nodes.
|
|
463
|
+
* *
|
|
464
|
+
*/
|
|
313
465
|
readonly totalBalance?: CurrencyAmount | undefined;
|
|
314
466
|
/** The current status of this channel. **/
|
|
315
467
|
readonly status?: ChannelStatus | undefined;
|
|
316
468
|
/**
|
|
317
|
-
* The estimated time to wait for the channel's hash timelock contract to
|
|
318
|
-
* the channel. It is in unit of minutes.
|
|
469
|
+
* The estimated time to wait for the channel's hash timelock contract to
|
|
470
|
+
* expire when force closing the channel. It is in unit of minutes.
|
|
319
471
|
**/
|
|
320
472
|
readonly estimatedForceClosureWaitMinutes?: number | undefined;
|
|
321
|
-
/**
|
|
473
|
+
/**
|
|
474
|
+
* The amount to be paid in fees for the current set of commitment
|
|
475
|
+
* transactions. *
|
|
476
|
+
*/
|
|
322
477
|
readonly commitFee?: CurrencyAmount | undefined;
|
|
323
478
|
/** The fees charged for routing payments through this channel. **/
|
|
324
479
|
readonly fees?: ChannelFees | undefined;
|
|
325
480
|
/** If known, the remote node of the channel. **/
|
|
326
481
|
readonly remoteNodeId?: string | undefined;
|
|
327
482
|
/**
|
|
328
|
-
* The unique identifier of the channel on Lightning Network,
|
|
329
|
-
* the channel was confirmed.
|
|
483
|
+
* The unique identifier of the channel on Lightning Network,
|
|
484
|
+
* which is the location in the chain that the channel was confirmed.
|
|
485
|
+
* The format is <block-height>:<tx-index>:<tx-output>.
|
|
330
486
|
**/
|
|
331
487
|
readonly shortChannelId?: string | undefined;
|
|
332
488
|
constructor(
|
|
333
489
|
/**
|
|
334
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
335
|
-
* string.
|
|
490
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
491
|
+
* Should be treated as an opaque string.
|
|
336
492
|
**/
|
|
337
493
|
id: string,
|
|
338
494
|
/** The date and time when the entity was first created. **/
|
|
@@ -346,38 +502,57 @@ declare class Channel implements Entity {
|
|
|
346
502
|
/** The transaction that funded the channel upon channel opening. **/
|
|
347
503
|
fundingTransactionId?: string | undefined,
|
|
348
504
|
/**
|
|
349
|
-
* The total amount of funds in this channel,
|
|
350
|
-
* channel balance on the
|
|
505
|
+
* The total amount of funds in this channel,
|
|
506
|
+
* including the channel balance on the local node,
|
|
507
|
+
* the channel balance on the remote node and the on-chain fees to close
|
|
508
|
+
* the channel.
|
|
351
509
|
**/
|
|
352
510
|
capacity?: CurrencyAmount | undefined,
|
|
353
511
|
/** The channel balance on the local node. **/
|
|
354
512
|
localBalance?: CurrencyAmount | undefined,
|
|
355
|
-
/**
|
|
513
|
+
/**
|
|
514
|
+
* The channel balance on the local node that is currently allocated to
|
|
515
|
+
* in-progress payments. *
|
|
516
|
+
*/
|
|
356
517
|
localUnsettledBalance?: CurrencyAmount | undefined,
|
|
357
518
|
/** The channel balance on the remote node. **/
|
|
358
519
|
remoteBalance?: CurrencyAmount | undefined,
|
|
359
|
-
/**
|
|
520
|
+
/**
|
|
521
|
+
* The channel balance on the remote node that is currently allocated to
|
|
522
|
+
* in-progress payments. *
|
|
523
|
+
*/
|
|
360
524
|
remoteUnsettledBalance?: CurrencyAmount | undefined,
|
|
361
|
-
/**
|
|
525
|
+
/**
|
|
526
|
+
* The channel balance that is currently allocated to in-progress payments.
|
|
527
|
+
* *
|
|
528
|
+
*/
|
|
362
529
|
unsettledBalance?: CurrencyAmount | undefined,
|
|
363
|
-
/**
|
|
530
|
+
/**
|
|
531
|
+
* The total balance in this channel,
|
|
532
|
+
* including the channel balance on both local and remote nodes.
|
|
533
|
+
* *
|
|
534
|
+
*/
|
|
364
535
|
totalBalance?: CurrencyAmount | undefined,
|
|
365
536
|
/** The current status of this channel. **/
|
|
366
537
|
status?: ChannelStatus | undefined,
|
|
367
538
|
/**
|
|
368
|
-
* The estimated time to wait for the channel's hash timelock contract to
|
|
369
|
-
* the channel. It is in unit of minutes.
|
|
539
|
+
* The estimated time to wait for the channel's hash timelock contract to
|
|
540
|
+
* expire when force closing the channel. It is in unit of minutes.
|
|
370
541
|
**/
|
|
371
542
|
estimatedForceClosureWaitMinutes?: number | undefined,
|
|
372
|
-
/**
|
|
543
|
+
/**
|
|
544
|
+
* The amount to be paid in fees for the current set of commitment
|
|
545
|
+
* transactions. *
|
|
546
|
+
*/
|
|
373
547
|
commitFee?: CurrencyAmount | undefined,
|
|
374
548
|
/** The fees charged for routing payments through this channel. **/
|
|
375
549
|
fees?: ChannelFees | undefined,
|
|
376
550
|
/** If known, the remote node of the channel. **/
|
|
377
551
|
remoteNodeId?: string | undefined,
|
|
378
552
|
/**
|
|
379
|
-
* The unique identifier of the channel on Lightning Network,
|
|
380
|
-
* the channel was confirmed.
|
|
553
|
+
* The unique identifier of the channel on Lightning Network,
|
|
554
|
+
* which is the location in the chain that the channel was confirmed.
|
|
555
|
+
* The format is <block-height>:<tx-index>:<tx-output>.
|
|
381
556
|
**/
|
|
382
557
|
shortChannelId?: string | undefined);
|
|
383
558
|
getUptimePercentage(client: LightsparkClient, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<number>;
|
|
@@ -414,16 +589,18 @@ declare class Channel implements Entity {
|
|
|
414
589
|
|
|
415
590
|
declare class AccountToChannelsConnection {
|
|
416
591
|
/**
|
|
417
|
-
* The total count of objects in this connection, using the current
|
|
418
|
-
*
|
|
592
|
+
* The total count of objects in this connection, using the current
|
|
593
|
+
* filters. It is different from the number of objects returned in the
|
|
594
|
+
* current page (in the `entities` field).
|
|
419
595
|
**/
|
|
420
596
|
readonly count: number;
|
|
421
597
|
/** The channels for the current page of this connection. **/
|
|
422
598
|
readonly entities: Channel[];
|
|
423
599
|
constructor(
|
|
424
600
|
/**
|
|
425
|
-
* The total count of objects in this connection, using the current
|
|
426
|
-
*
|
|
601
|
+
* The total count of objects in this connection, using the current
|
|
602
|
+
* filters. It is different from the number of objects returned in the
|
|
603
|
+
* current page (in the `entities` field).
|
|
427
604
|
**/
|
|
428
605
|
count: number,
|
|
429
606
|
/** The channels for the current page of this connection. **/
|
|
@@ -460,31 +637,44 @@ declare class AccountToChannelsConnection {
|
|
|
460
637
|
};
|
|
461
638
|
}
|
|
462
639
|
|
|
463
|
-
/**
|
|
640
|
+
/**
|
|
641
|
+
* This is an object representing the balance associated with your Lightspark
|
|
642
|
+
* account. You can retrieve this object to see your balance,
|
|
643
|
+
* which can be broken down into several different categorizations.
|
|
644
|
+
* *
|
|
645
|
+
*/
|
|
464
646
|
interface Balances {
|
|
465
647
|
/**
|
|
466
|
-
* This represents the balance that should be displayed when asked "how much
|
|
467
|
-
*
|
|
468
|
-
*
|
|
469
|
-
*
|
|
648
|
+
* This represents the balance that should be displayed when asked "how much
|
|
649
|
+
* do I own right now?". It represents the amount currently owned,
|
|
650
|
+
* including things that may not be owned soon (e.g. in-flight outgoing
|
|
651
|
+
* payments, in-flight withdrawals, commit fees, etc.).
|
|
652
|
+
* It really is a snapshot of what is officially owned at this instant.
|
|
470
653
|
**/
|
|
471
654
|
ownedBalance: CurrencyAmount;
|
|
472
655
|
/**
|
|
473
|
-
* This represents the balance that should be displayed when asked "how much
|
|
474
|
-
*
|
|
475
|
-
*
|
|
656
|
+
* This represents the balance that should be displayed when asked "how much
|
|
657
|
+
* can I send on Lightning right now?".
|
|
658
|
+
* It represents the amount currently available to be sent on the Lightning
|
|
659
|
+
* network. We remove from the balance all the funds that are temporarily
|
|
660
|
+
* locked (e.g. channel reserves).
|
|
476
661
|
**/
|
|
477
662
|
availableToSendBalance: CurrencyAmount;
|
|
478
663
|
/**
|
|
479
|
-
* This represents the balance that should be displayed when asked "how much
|
|
480
|
-
* the Bitcoin network right now?".
|
|
481
|
-
*
|
|
482
|
-
*
|
|
664
|
+
* This represents the balance that should be displayed when asked "how much
|
|
665
|
+
* money can I withdraw on the Bitcoin network right now?".
|
|
666
|
+
* It represents the amount currently available to withdraw and is usually
|
|
667
|
+
* equal to the `owned_balance` but it does not include in-flight operations
|
|
668
|
+
* (which would likely succeed and therefore likely make your withdrawal
|
|
669
|
+
* fail).
|
|
483
670
|
**/
|
|
484
671
|
availableToWithdrawBalance: CurrencyAmount;
|
|
485
672
|
}
|
|
486
673
|
|
|
487
|
-
/**
|
|
674
|
+
/**
|
|
675
|
+
* This is an object representing a detailed breakdown of the balance for a
|
|
676
|
+
* Lightspark Node. *
|
|
677
|
+
*/
|
|
488
678
|
interface BlockchainBalance {
|
|
489
679
|
/** The total wallet balance, including unconfirmed UTXOs. **/
|
|
490
680
|
totalBalance?: CurrencyAmount | undefined;
|
|
@@ -502,11 +692,15 @@ interface BlockchainBalance {
|
|
|
502
692
|
|
|
503
693
|
interface LightsparkNodeToChannelsConnection {
|
|
504
694
|
/**
|
|
505
|
-
* The total count of objects in this connection, using the current filters.
|
|
506
|
-
* number of objects returned in the current page
|
|
695
|
+
* The total count of objects in this connection, using the current filters.
|
|
696
|
+
* It is different from the number of objects returned in the current page
|
|
697
|
+
* (in the `entities` field).
|
|
507
698
|
**/
|
|
508
699
|
count: number;
|
|
509
|
-
/**
|
|
700
|
+
/**
|
|
701
|
+
* An object that holds pagination information about the objects in this
|
|
702
|
+
* connection. *
|
|
703
|
+
*/
|
|
510
704
|
pageInfo: PageInfo;
|
|
511
705
|
/** The channels for the current page of this connection. **/
|
|
512
706
|
entities: Channel[];
|
|
@@ -522,22 +716,30 @@ interface NodeAddress {
|
|
|
522
716
|
type: NodeAddressType;
|
|
523
717
|
}
|
|
524
718
|
|
|
525
|
-
/**
|
|
719
|
+
/**
|
|
720
|
+
* A connection between a node and the addresses it has announced for itself on
|
|
721
|
+
* Lightning Network. *
|
|
722
|
+
*/
|
|
526
723
|
interface NodeToAddressesConnection {
|
|
527
724
|
/**
|
|
528
|
-
* The total count of objects in this connection, using the current filters.
|
|
529
|
-
* number of objects returned in the current page
|
|
725
|
+
* The total count of objects in this connection, using the current filters.
|
|
726
|
+
* It is different from the number of objects returned in the current page
|
|
727
|
+
* (in the `entities` field).
|
|
530
728
|
**/
|
|
531
729
|
count: number;
|
|
532
730
|
/** The addresses for the current page of this connection. **/
|
|
533
731
|
entities: NodeAddress[];
|
|
534
732
|
}
|
|
535
733
|
|
|
536
|
-
/**
|
|
734
|
+
/**
|
|
735
|
+
* This is an object representing a node managed by Lightspark and owned by the
|
|
736
|
+
* current connected account. This object contains information about the node’s
|
|
737
|
+
* configuration, state, and metadata. *
|
|
738
|
+
*/
|
|
537
739
|
interface LightsparkNode {
|
|
538
740
|
/**
|
|
539
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
540
|
-
* string.
|
|
741
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
742
|
+
* Should be treated as an opaque string.
|
|
541
743
|
**/
|
|
542
744
|
id: string;
|
|
543
745
|
/** The date and time when the entity was first created. **/
|
|
@@ -547,43 +749,53 @@ interface LightsparkNode {
|
|
|
547
749
|
/** The Bitcoin Network this node is deployed in. **/
|
|
548
750
|
bitcoinNetwork: BitcoinNetwork;
|
|
549
751
|
/**
|
|
550
|
-
* The name of this node in the network.
|
|
551
|
-
*
|
|
752
|
+
* The name of this node in the network.
|
|
753
|
+
* It will be the most human-readable option possible,
|
|
754
|
+
* depending on the data available for this node.
|
|
552
755
|
**/
|
|
553
756
|
displayName: string;
|
|
554
757
|
/** The owner of this LightsparkNode. **/
|
|
555
758
|
ownerId: string;
|
|
556
759
|
/**
|
|
557
|
-
* The utxos of the channels that are connected to this node.
|
|
558
|
-
* pre-screening.
|
|
760
|
+
* The utxos of the channels that are connected to this node.
|
|
761
|
+
* This is used in uma flow for pre-screening.
|
|
559
762
|
**/
|
|
560
763
|
umaPrescreeningUtxos: string[];
|
|
561
764
|
/** The typename of the object **/
|
|
562
765
|
typename: string;
|
|
563
766
|
/**
|
|
564
|
-
* A name that identifies the node. It has no importance in terms of
|
|
565
|
-
* way to identify and search for commercial
|
|
566
|
-
* any time by the
|
|
767
|
+
* A name that identifies the node. It has no importance in terms of
|
|
768
|
+
* operating the node, it is just a way to identify and search for commercial
|
|
769
|
+
* services or popular nodes. This alias can be changed at any time by the
|
|
770
|
+
* node operator.
|
|
567
771
|
**/
|
|
568
772
|
alias?: string | undefined;
|
|
569
773
|
/**
|
|
570
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
571
|
-
* has no importance in terms of operating the
|
|
774
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
775
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating the
|
|
776
|
+
* node,
|
|
777
|
+
* it is just a way to visually differentiate nodes.
|
|
572
778
|
* That color can be changed at any time by the node operator.
|
|
573
779
|
**/
|
|
574
780
|
color?: string | undefined;
|
|
575
781
|
/**
|
|
576
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
577
|
-
*
|
|
578
|
-
*
|
|
782
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
783
|
+
* receive, or route transactions efficiently.
|
|
784
|
+
* Maximizing a node's conductivity helps a node’s transactions to be capital
|
|
785
|
+
* efficient. The value is an integer ranging between 0 and 10 (bounds
|
|
786
|
+
* included).
|
|
579
787
|
**/
|
|
580
788
|
conductivity?: number | undefined;
|
|
581
|
-
/**
|
|
789
|
+
/**
|
|
790
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
791
|
+
* in the Lightning Network. *
|
|
792
|
+
*/
|
|
582
793
|
publicKey?: string | undefined;
|
|
583
794
|
/** The current status of this node. **/
|
|
584
795
|
status?: LightsparkNodeStatus | undefined;
|
|
585
796
|
/**
|
|
586
|
-
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
797
|
+
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
798
|
+
* and commit fees on this node.
|
|
587
799
|
*
|
|
588
800
|
* @deprecated Use `balances` instead.
|
|
589
801
|
**/
|
|
@@ -595,7 +807,8 @@ interface LightsparkNode {
|
|
|
595
807
|
**/
|
|
596
808
|
totalLocalBalance?: CurrencyAmount | undefined;
|
|
597
809
|
/**
|
|
598
|
-
* The sum of the channel balances (online only) that are available to send
|
|
810
|
+
* The sum of the channel balances (online only) that are available to send
|
|
811
|
+
* on this node.
|
|
599
812
|
*
|
|
600
813
|
* @deprecated Use `balances` instead.
|
|
601
814
|
**/
|
|
@@ -622,11 +835,15 @@ declare const getLightsparkNodeQuery: (id: string) => Query<LightsparkNode>;
|
|
|
622
835
|
/** A connection between an account and the nodes it manages. **/
|
|
623
836
|
interface AccountToNodesConnection {
|
|
624
837
|
/**
|
|
625
|
-
* The total count of objects in this connection, using the current filters.
|
|
626
|
-
* number of objects returned in the current page
|
|
838
|
+
* The total count of objects in this connection, using the current filters.
|
|
839
|
+
* It is different from the number of objects returned in the current page
|
|
840
|
+
* (in the `entities` field).
|
|
627
841
|
**/
|
|
628
842
|
count: number;
|
|
629
|
-
/**
|
|
843
|
+
/**
|
|
844
|
+
* An object that holds pagination information about the objects in this
|
|
845
|
+
* connection. *
|
|
846
|
+
*/
|
|
630
847
|
pageInfo: PageInfo;
|
|
631
848
|
/** The nodes for the current page of this connection. **/
|
|
632
849
|
entities: LightsparkNode[];
|
|
@@ -634,7 +851,11 @@ interface AccountToNodesConnection {
|
|
|
634
851
|
typename: string;
|
|
635
852
|
}
|
|
636
853
|
|
|
637
|
-
/**
|
|
854
|
+
/**
|
|
855
|
+
* This object is an interface of a payment request on the Lightning Network
|
|
856
|
+
* (i.e., a Lightning Invoice). It contains data related to parsing the payment
|
|
857
|
+
* details of a Lightning Invoice. *
|
|
858
|
+
*/
|
|
638
859
|
interface PaymentRequestData {
|
|
639
860
|
encodedPaymentRequest: string;
|
|
640
861
|
bitcoinNetwork: BitcoinNetwork;
|
|
@@ -642,22 +863,31 @@ interface PaymentRequestData {
|
|
|
642
863
|
typename: string;
|
|
643
864
|
}
|
|
644
865
|
|
|
645
|
-
/**
|
|
866
|
+
/**
|
|
867
|
+
* This is an enum of the potential states that a payment request on the
|
|
868
|
+
* Lightning Network can take. *
|
|
869
|
+
*/
|
|
646
870
|
declare enum PaymentRequestStatus {
|
|
647
871
|
/**
|
|
648
|
-
* This is an enum value that represents values that could be added in the
|
|
649
|
-
* Clients should support unknown values as more of them could be
|
|
872
|
+
* This is an enum value that represents values that could be added in the
|
|
873
|
+
* future. Clients should support unknown values as more of them could be
|
|
874
|
+
* added without notice.
|
|
650
875
|
*/
|
|
651
876
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
652
877
|
OPEN = "OPEN",
|
|
653
878
|
CLOSED = "CLOSED"
|
|
654
879
|
}
|
|
655
880
|
|
|
656
|
-
/**
|
|
881
|
+
/**
|
|
882
|
+
* This object contains information related to a payment request generated or
|
|
883
|
+
* received by a LightsparkNode. You can retrieve this object to receive
|
|
884
|
+
* payment information about a specific invoice.
|
|
885
|
+
* *
|
|
886
|
+
*/
|
|
657
887
|
interface PaymentRequest {
|
|
658
888
|
/**
|
|
659
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
660
|
-
* string.
|
|
889
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
890
|
+
* Should be treated as an opaque string.
|
|
661
891
|
**/
|
|
662
892
|
id: string;
|
|
663
893
|
/** The date and time when the entity was first created. **/
|
|
@@ -675,11 +905,15 @@ declare const getPaymentRequestQuery: (id: string) => Query<PaymentRequest>;
|
|
|
675
905
|
|
|
676
906
|
interface AccountToPaymentRequestsConnection {
|
|
677
907
|
/**
|
|
678
|
-
* The total count of objects in this connection, using the current filters.
|
|
679
|
-
* number of objects returned in the current page
|
|
908
|
+
* The total count of objects in this connection, using the current filters.
|
|
909
|
+
* It is different from the number of objects returned in the current page
|
|
910
|
+
* (in the `entities` field).
|
|
680
911
|
**/
|
|
681
912
|
count: number;
|
|
682
|
-
/**
|
|
913
|
+
/**
|
|
914
|
+
* An object that holds pagination information about the objects in this
|
|
915
|
+
* connection. *
|
|
916
|
+
*/
|
|
683
917
|
pageInfo: PageInfo;
|
|
684
918
|
/** The payment requests for the current page of this connection. **/
|
|
685
919
|
entities: PaymentRequest[];
|
|
@@ -687,11 +921,15 @@ interface AccountToPaymentRequestsConnection {
|
|
|
687
921
|
typename: string;
|
|
688
922
|
}
|
|
689
923
|
|
|
690
|
-
/**
|
|
924
|
+
/**
|
|
925
|
+
* This is an enum of the potential statuses a transaction associated with your
|
|
926
|
+
* Lightspark Node can take. *
|
|
927
|
+
*/
|
|
691
928
|
declare enum TransactionStatus {
|
|
692
929
|
/**
|
|
693
|
-
* This is an enum value that represents values that could be added in the
|
|
694
|
-
* Clients should support unknown values as more of them could be
|
|
930
|
+
* This is an enum value that represents values that could be added in the
|
|
931
|
+
* future. Clients should support unknown values as more of them could be
|
|
932
|
+
* added without notice.
|
|
695
933
|
*/
|
|
696
934
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
697
935
|
/** Transaction succeeded.. **/
|
|
@@ -700,19 +938,33 @@ declare enum TransactionStatus {
|
|
|
700
938
|
FAILED = "FAILED",
|
|
701
939
|
/** Transaction has been initiated and is currently in-flight. **/
|
|
702
940
|
PENDING = "PENDING",
|
|
703
|
-
/**
|
|
941
|
+
/**
|
|
942
|
+
* For transaction type PAYMENT_REQUEST only.
|
|
943
|
+
* No payments have been made to a payment request.
|
|
944
|
+
* *
|
|
945
|
+
*/
|
|
704
946
|
NOT_STARTED = "NOT_STARTED",
|
|
705
|
-
/**
|
|
947
|
+
/**
|
|
948
|
+
* For transaction type PAYMENT_REQUEST only. A payment request has expired.
|
|
949
|
+
* *
|
|
950
|
+
*/
|
|
706
951
|
EXPIRED = "EXPIRED",
|
|
707
952
|
/** For transaction type PAYMENT_REQUEST only. **/
|
|
708
953
|
CANCELLED = "CANCELLED"
|
|
709
954
|
}
|
|
710
955
|
|
|
711
|
-
/**
|
|
956
|
+
/**
|
|
957
|
+
* This object represents a payment transaction.
|
|
958
|
+
* The transaction can occur either on a Bitcoin Network,
|
|
959
|
+
* or over the Lightning Network. You can retrieve this object to receive
|
|
960
|
+
* specific information about a particular transaction tied to your Lightspark
|
|
961
|
+
* Node.
|
|
962
|
+
* *
|
|
963
|
+
*/
|
|
712
964
|
interface Transaction {
|
|
713
965
|
/**
|
|
714
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
715
|
-
* string.
|
|
966
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
967
|
+
* Should be treated as an opaque string.
|
|
716
968
|
**/
|
|
717
969
|
id: string;
|
|
718
970
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -727,36 +979,43 @@ interface Transaction {
|
|
|
727
979
|
typename: string;
|
|
728
980
|
/** The date and time when this transaction was completed or failed. **/
|
|
729
981
|
resolvedAt?: string | undefined;
|
|
730
|
-
/**
|
|
982
|
+
/**
|
|
983
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
984
|
+
* Lightning Network. *
|
|
985
|
+
*/
|
|
731
986
|
transactionHash?: string | undefined;
|
|
732
987
|
}
|
|
733
988
|
declare const getTransactionQuery: (id: string) => Query<Transaction>;
|
|
734
989
|
|
|
735
990
|
interface AccountToTransactionsConnection {
|
|
736
991
|
/**
|
|
737
|
-
* The total count of objects in this connection, using the current filters.
|
|
738
|
-
* number of objects returned in the current page
|
|
992
|
+
* The total count of objects in this connection, using the current filters.
|
|
993
|
+
* It is different from the number of objects returned in the current page
|
|
994
|
+
* (in the `entities` field).
|
|
739
995
|
**/
|
|
740
996
|
count: number;
|
|
741
|
-
/**
|
|
997
|
+
/**
|
|
998
|
+
* An object that holds pagination information about the objects in this
|
|
999
|
+
* connection. *
|
|
1000
|
+
*/
|
|
742
1001
|
pageInfo: PageInfo;
|
|
743
1002
|
/** The transactions for the current page of this connection. **/
|
|
744
1003
|
entities: Transaction[];
|
|
745
1004
|
/** The typename of the object **/
|
|
746
1005
|
typename: string;
|
|
747
1006
|
/**
|
|
748
|
-
* Profit (or loss) generated by the transactions in this connection,
|
|
749
|
-
* constraints provided.
|
|
1007
|
+
* Profit (or loss) generated by the transactions in this connection,
|
|
1008
|
+
* with the set of filters and constraints provided.
|
|
750
1009
|
**/
|
|
751
1010
|
profitLoss?: CurrencyAmount | undefined;
|
|
752
1011
|
/**
|
|
753
|
-
* Average fee earned for the transactions in this connection,
|
|
754
|
-
* provided.
|
|
1012
|
+
* Average fee earned for the transactions in this connection,
|
|
1013
|
+
* with the set of filters and constraints provided.
|
|
755
1014
|
**/
|
|
756
1015
|
averageFeeEarned?: CurrencyAmount | undefined;
|
|
757
1016
|
/**
|
|
758
|
-
* Total amount transacted by the transactions in this connection,
|
|
759
|
-
* constraints provided.
|
|
1017
|
+
* Total amount transacted by the transactions in this connection,
|
|
1018
|
+
* with the set of filters and constraints provided.
|
|
760
1019
|
**/
|
|
761
1020
|
totalAmountTransacted?: CurrencyAmount | undefined;
|
|
762
1021
|
}
|
|
@@ -764,8 +1023,8 @@ interface AccountToTransactionsConnection {
|
|
|
764
1023
|
/** This is an object representing the owner of a LightsparkNode. **/
|
|
765
1024
|
interface LightsparkNodeOwner {
|
|
766
1025
|
/**
|
|
767
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
768
|
-
* string.
|
|
1026
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1027
|
+
* Should be treated as an opaque string.
|
|
769
1028
|
**/
|
|
770
1029
|
id: string;
|
|
771
1030
|
/** The date and time when the entity was first created. **/
|
|
@@ -777,40 +1036,71 @@ interface LightsparkNodeOwner {
|
|
|
777
1036
|
}
|
|
778
1037
|
declare const getLightsparkNodeOwnerQuery: (id: string) => Query<LightsparkNodeOwner>;
|
|
779
1038
|
|
|
780
|
-
/**
|
|
1039
|
+
/**
|
|
1040
|
+
* This is an enum of the potential statuses that your Lightspark wallet can
|
|
1041
|
+
* take. *
|
|
1042
|
+
*/
|
|
781
1043
|
declare enum WalletStatus {
|
|
782
1044
|
/**
|
|
783
|
-
* This is an enum value that represents values that could be added in the
|
|
784
|
-
* Clients should support unknown values as more of them could be
|
|
1045
|
+
* This is an enum value that represents values that could be added in the
|
|
1046
|
+
* future. Clients should support unknown values as more of them could be
|
|
1047
|
+
* added without notice.
|
|
785
1048
|
*/
|
|
786
1049
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
787
|
-
/**
|
|
1050
|
+
/**
|
|
1051
|
+
* The wallet has not been set up yet and is ready to be deployed.
|
|
1052
|
+
* This is the default status after the first login.
|
|
1053
|
+
* *
|
|
1054
|
+
*/
|
|
788
1055
|
NOT_SETUP = "NOT_SETUP",
|
|
789
|
-
/**
|
|
1056
|
+
/**
|
|
1057
|
+
* The wallet is currently being deployed in the Lightspark infrastructure.
|
|
1058
|
+
* *
|
|
1059
|
+
*/
|
|
790
1060
|
DEPLOYING = "DEPLOYING",
|
|
791
|
-
/**
|
|
1061
|
+
/**
|
|
1062
|
+
* The wallet has been deployed in the Lightspark infrastructure and is ready
|
|
1063
|
+
* to be initialized. *
|
|
1064
|
+
*/
|
|
792
1065
|
DEPLOYED = "DEPLOYED",
|
|
793
1066
|
/** The wallet is currently being initialized. **/
|
|
794
1067
|
INITIALIZING = "INITIALIZING",
|
|
795
1068
|
/** The wallet is available and ready to be used. **/
|
|
796
1069
|
READY = "READY",
|
|
797
|
-
/**
|
|
1070
|
+
/**
|
|
1071
|
+
* The wallet is temporarily available,
|
|
1072
|
+
* due to a transient issue or a scheduled maintenance.
|
|
1073
|
+
* *
|
|
1074
|
+
*/
|
|
798
1075
|
UNAVAILABLE = "UNAVAILABLE",
|
|
799
|
-
/**
|
|
1076
|
+
/**
|
|
1077
|
+
* The wallet had an unrecoverable failure.
|
|
1078
|
+
* This status is not expected to happend and will be investigated by the
|
|
1079
|
+
* Lightspark team. *
|
|
1080
|
+
*/
|
|
800
1081
|
FAILED = "FAILED",
|
|
801
1082
|
/** The wallet is being terminated. **/
|
|
802
1083
|
TERMINATING = "TERMINATING",
|
|
803
|
-
/**
|
|
1084
|
+
/**
|
|
1085
|
+
* The wallet has been terminated and is not available in the Lightspark
|
|
1086
|
+
* infrastructure anymore. It is not connected to the Lightning network and
|
|
1087
|
+
* its funds can only be accessed using the Funds Recovery flow.
|
|
1088
|
+
* *
|
|
1089
|
+
*/
|
|
804
1090
|
TERMINATED = "TERMINATED"
|
|
805
1091
|
}
|
|
806
1092
|
|
|
807
1093
|
interface WalletToPaymentRequestsConnection {
|
|
808
1094
|
/**
|
|
809
|
-
* The total count of objects in this connection, using the current filters.
|
|
810
|
-
* number of objects returned in the current page
|
|
1095
|
+
* The total count of objects in this connection, using the current filters.
|
|
1096
|
+
* It is different from the number of objects returned in the current page
|
|
1097
|
+
* (in the `entities` field).
|
|
811
1098
|
**/
|
|
812
1099
|
count: number;
|
|
813
|
-
/**
|
|
1100
|
+
/**
|
|
1101
|
+
* An object that holds pagination information about the objects in this
|
|
1102
|
+
* connection. *
|
|
1103
|
+
*/
|
|
814
1104
|
pageInfo: PageInfo;
|
|
815
1105
|
/** The payment requests for the current page of this connection. **/
|
|
816
1106
|
entities: PaymentRequest[];
|
|
@@ -820,11 +1110,15 @@ interface WalletToPaymentRequestsConnection {
|
|
|
820
1110
|
|
|
821
1111
|
interface WalletToTransactionsConnection {
|
|
822
1112
|
/**
|
|
823
|
-
* The total count of objects in this connection, using the current filters.
|
|
824
|
-
* number of objects returned in the current page
|
|
1113
|
+
* The total count of objects in this connection, using the current filters.
|
|
1114
|
+
* It is different from the number of objects returned in the current page
|
|
1115
|
+
* (in the `entities` field).
|
|
825
1116
|
**/
|
|
826
1117
|
count: number;
|
|
827
|
-
/**
|
|
1118
|
+
/**
|
|
1119
|
+
* An object that holds pagination information about the objects in this
|
|
1120
|
+
* connection. *
|
|
1121
|
+
*/
|
|
828
1122
|
pageInfo: PageInfo;
|
|
829
1123
|
/** The transactions for the current page of this connection. **/
|
|
830
1124
|
entities: Transaction[];
|
|
@@ -832,18 +1126,27 @@ interface WalletToTransactionsConnection {
|
|
|
832
1126
|
typename: string;
|
|
833
1127
|
}
|
|
834
1128
|
|
|
835
|
-
/**
|
|
1129
|
+
/**
|
|
1130
|
+
* This object represents a Lightspark Wallet, tied to your Lightspark account.
|
|
1131
|
+
* Wallets can be used to send or receive funds over the Lightning Network.
|
|
1132
|
+
* You can retrieve this object to receive information about a specific wallet
|
|
1133
|
+
* tied to your Lightspark account. *
|
|
1134
|
+
*/
|
|
836
1135
|
declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
837
1136
|
/**
|
|
838
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
839
|
-
* string.
|
|
1137
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1138
|
+
* Should be treated as an opaque string.
|
|
840
1139
|
**/
|
|
841
1140
|
readonly id: string;
|
|
842
1141
|
/** The date and time when the entity was first created. **/
|
|
843
1142
|
readonly createdAt: string;
|
|
844
1143
|
/** The date and time when the entity was last updated. **/
|
|
845
1144
|
readonly updatedAt: string;
|
|
846
|
-
/**
|
|
1145
|
+
/**
|
|
1146
|
+
* The unique identifier of this wallet,
|
|
1147
|
+
* as provided by the Lightspark Customer during login.
|
|
1148
|
+
* *
|
|
1149
|
+
*/
|
|
847
1150
|
readonly thirdPartyIdentifier: string;
|
|
848
1151
|
/** The status of this wallet. **/
|
|
849
1152
|
readonly status: WalletStatus;
|
|
@@ -857,15 +1160,19 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
|
857
1160
|
readonly accountId?: string | undefined;
|
|
858
1161
|
constructor(
|
|
859
1162
|
/**
|
|
860
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
861
|
-
* string.
|
|
1163
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1164
|
+
* Should be treated as an opaque string.
|
|
862
1165
|
**/
|
|
863
1166
|
id: string,
|
|
864
1167
|
/** The date and time when the entity was first created. **/
|
|
865
1168
|
createdAt: string,
|
|
866
1169
|
/** The date and time when the entity was last updated. **/
|
|
867
1170
|
updatedAt: string,
|
|
868
|
-
/**
|
|
1171
|
+
/**
|
|
1172
|
+
* The unique identifier of this wallet,
|
|
1173
|
+
* as provided by the Lightspark Customer during login.
|
|
1174
|
+
* *
|
|
1175
|
+
*/
|
|
869
1176
|
thirdPartyIdentifier: string,
|
|
870
1177
|
/** The status of this wallet. **/
|
|
871
1178
|
status: WalletStatus,
|
|
@@ -899,11 +1206,15 @@ declare class Wallet implements LightsparkNodeOwner, Entity {
|
|
|
899
1206
|
|
|
900
1207
|
interface AccountToWalletsConnection {
|
|
901
1208
|
/**
|
|
902
|
-
* The total count of objects in this connection, using the current filters.
|
|
903
|
-
* number of objects returned in the current page
|
|
1209
|
+
* The total count of objects in this connection, using the current filters.
|
|
1210
|
+
* It is different from the number of objects returned in the current page
|
|
1211
|
+
* (in the `entities` field).
|
|
904
1212
|
**/
|
|
905
1213
|
count: number;
|
|
906
|
-
/**
|
|
1214
|
+
/**
|
|
1215
|
+
* An object that holds pagination information about the objects in this
|
|
1216
|
+
* connection. *
|
|
1217
|
+
*/
|
|
907
1218
|
pageInfo: PageInfo;
|
|
908
1219
|
/** The wallets for the current page of this connection. **/
|
|
909
1220
|
entities: Wallet[];
|
|
@@ -911,11 +1222,15 @@ interface AccountToWalletsConnection {
|
|
|
911
1222
|
typename: string;
|
|
912
1223
|
}
|
|
913
1224
|
|
|
914
|
-
/**
|
|
1225
|
+
/**
|
|
1226
|
+
* This is an enum of the potential reasons why an OutgoingPayment sent from a
|
|
1227
|
+
* Lightspark Node may have failed. *
|
|
1228
|
+
*/
|
|
915
1229
|
declare enum PaymentFailureReason {
|
|
916
1230
|
/**
|
|
917
|
-
* This is an enum value that represents values that could be added in the
|
|
918
|
-
* Clients should support unknown values as more of them could be
|
|
1231
|
+
* This is an enum value that represents values that could be added in the
|
|
1232
|
+
* future. Clients should support unknown values as more of them could be
|
|
1233
|
+
* added without notice.
|
|
919
1234
|
*/
|
|
920
1235
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
921
1236
|
NONE = "NONE",
|
|
@@ -930,11 +1245,16 @@ declare enum PaymentFailureReason {
|
|
|
930
1245
|
RISK_SCREENING_FAILED = "RISK_SCREENING_FAILED"
|
|
931
1246
|
}
|
|
932
1247
|
|
|
933
|
-
/**
|
|
1248
|
+
/**
|
|
1249
|
+
* This is an enum of the potential reasons that an attempted routed
|
|
1250
|
+
* transaction through a Lightspark node may have failed.
|
|
1251
|
+
* *
|
|
1252
|
+
*/
|
|
934
1253
|
declare enum RoutingTransactionFailureReason {
|
|
935
1254
|
/**
|
|
936
|
-
* This is an enum value that represents values that could be added in the
|
|
937
|
-
* Clients should support unknown values as more of them could be
|
|
1255
|
+
* This is an enum value that represents values that could be added in the
|
|
1256
|
+
* future. Clients should support unknown values as more of them could be
|
|
1257
|
+
* added without notice.
|
|
938
1258
|
*/
|
|
939
1259
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
940
1260
|
INCOMING_LINK_FAILURE = "INCOMING_LINK_FAILURE",
|
|
@@ -942,17 +1262,24 @@ declare enum RoutingTransactionFailureReason {
|
|
|
942
1262
|
FORWARDING_FAILURE = "FORWARDING_FAILURE"
|
|
943
1263
|
}
|
|
944
1264
|
|
|
945
|
-
/**
|
|
1265
|
+
/**
|
|
1266
|
+
* This object represents payment failures associated with your Lightspark
|
|
1267
|
+
* Node. *
|
|
1268
|
+
*/
|
|
946
1269
|
interface TransactionFailures {
|
|
947
1270
|
paymentFailures?: PaymentFailureReason[] | undefined;
|
|
948
1271
|
routingTransactionFailures?: RoutingTransactionFailureReason[] | undefined;
|
|
949
1272
|
}
|
|
950
1273
|
|
|
951
|
-
/**
|
|
1274
|
+
/**
|
|
1275
|
+
* This is an object representing the connected Lightspark account.
|
|
1276
|
+
* You can retrieve this object to see your account information and objects
|
|
1277
|
+
* tied to your account. *
|
|
1278
|
+
*/
|
|
952
1279
|
declare class Account implements LightsparkNodeOwner, Entity {
|
|
953
1280
|
/**
|
|
954
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
955
|
-
* string.
|
|
1281
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1282
|
+
* Should be treated as an opaque string.
|
|
956
1283
|
**/
|
|
957
1284
|
readonly id: string;
|
|
958
1285
|
/** The date and time when the entity was first created. **/
|
|
@@ -965,8 +1292,8 @@ declare class Account implements LightsparkNodeOwner, Entity {
|
|
|
965
1292
|
readonly name?: string | undefined;
|
|
966
1293
|
constructor(
|
|
967
1294
|
/**
|
|
968
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
969
|
-
* string.
|
|
1295
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1296
|
+
* Should be treated as an opaque string.
|
|
970
1297
|
**/
|
|
971
1298
|
id: string,
|
|
972
1299
|
/** The date and time when the entity was first created. **/
|
|
@@ -1002,24 +1329,32 @@ interface CreateApiTokenOutput {
|
|
|
1002
1329
|
/** The API Token that has been created. **/
|
|
1003
1330
|
apiToken: ApiToken;
|
|
1004
1331
|
/**
|
|
1005
|
-
* The secret that should be used to authenticate against our API.
|
|
1006
|
-
* never be available again after this.
|
|
1007
|
-
* account.
|
|
1332
|
+
* The secret that should be used to authenticate against our API.
|
|
1333
|
+
* This secret is not stored and will never be available again after this.
|
|
1334
|
+
* You must keep this secret secure as it grants access to your account.
|
|
1008
1335
|
**/
|
|
1009
1336
|
clientSecret: string;
|
|
1010
1337
|
}
|
|
1011
1338
|
|
|
1012
|
-
/**
|
|
1339
|
+
/**
|
|
1340
|
+
* This object represents the estimated L1 transaction fees for the Bitcoin
|
|
1341
|
+
* network. Fee estimates are separated by potential confirmation speeds for
|
|
1342
|
+
* settlement. *
|
|
1343
|
+
*/
|
|
1013
1344
|
interface FeeEstimate {
|
|
1014
1345
|
feeFast: CurrencyAmount;
|
|
1015
1346
|
feeMin: CurrencyAmount;
|
|
1016
1347
|
}
|
|
1017
1348
|
|
|
1018
|
-
/**
|
|
1349
|
+
/**
|
|
1350
|
+
* This is an enum that enumerates all potential statuses for an incoming
|
|
1351
|
+
* payment attempt. *
|
|
1352
|
+
*/
|
|
1019
1353
|
declare enum IncomingPaymentAttemptStatus {
|
|
1020
1354
|
/**
|
|
1021
|
-
* This is an enum value that represents values that could be added in the
|
|
1022
|
-
* Clients should support unknown values as more of them could be
|
|
1355
|
+
* This is an enum value that represents values that could be added in the
|
|
1356
|
+
* future. Clients should support unknown values as more of them could be
|
|
1357
|
+
* added without notice.
|
|
1023
1358
|
*/
|
|
1024
1359
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1025
1360
|
ACCEPTED = "ACCEPTED",
|
|
@@ -1028,11 +1363,16 @@ declare enum IncomingPaymentAttemptStatus {
|
|
|
1028
1363
|
UNKNOWN = "UNKNOWN"
|
|
1029
1364
|
}
|
|
1030
1365
|
|
|
1031
|
-
/**
|
|
1366
|
+
/**
|
|
1367
|
+
* This object represents any attempted payment sent to a Lightspark node on
|
|
1368
|
+
* the Lightning Network. You can retrieve this object to receive payment
|
|
1369
|
+
* related information about a specific incoming payment attempt.
|
|
1370
|
+
* *
|
|
1371
|
+
*/
|
|
1032
1372
|
interface IncomingPaymentAttempt {
|
|
1033
1373
|
/**
|
|
1034
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1035
|
-
* string.
|
|
1374
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1375
|
+
* Should be treated as an opaque string.
|
|
1036
1376
|
**/
|
|
1037
1377
|
id: string;
|
|
1038
1378
|
/** The date and time when the entity was first created. **/
|
|
@@ -1055,11 +1395,15 @@ declare const getIncomingPaymentAttemptQuery: (id: string) => Query<IncomingPaym
|
|
|
1055
1395
|
/** The connection from incoming payment to all attempts. **/
|
|
1056
1396
|
interface IncomingPaymentToAttemptsConnection {
|
|
1057
1397
|
/**
|
|
1058
|
-
* The total count of objects in this connection, using the current filters.
|
|
1059
|
-
* number of objects returned in the current page
|
|
1398
|
+
* The total count of objects in this connection, using the current filters.
|
|
1399
|
+
* It is different from the number of objects returned in the current page
|
|
1400
|
+
* (in the `entities` field).
|
|
1060
1401
|
**/
|
|
1061
1402
|
count: number;
|
|
1062
|
-
/**
|
|
1403
|
+
/**
|
|
1404
|
+
* An object that holds pagination information about the objects in this
|
|
1405
|
+
* connection. *
|
|
1406
|
+
*/
|
|
1063
1407
|
pageInfo: PageInfo;
|
|
1064
1408
|
/** The incoming payment attempts for the current page of this connection. **/
|
|
1065
1409
|
entities: IncomingPaymentAttempt[];
|
|
@@ -1067,11 +1411,16 @@ interface IncomingPaymentToAttemptsConnection {
|
|
|
1067
1411
|
typename: string;
|
|
1068
1412
|
}
|
|
1069
1413
|
|
|
1070
|
-
/**
|
|
1414
|
+
/**
|
|
1415
|
+
* This is an object representing a transaction made over the Lightning
|
|
1416
|
+
* Network. You can retrieve this object to receive information about a
|
|
1417
|
+
* specific transaction made over Lightning for a Lightspark node.
|
|
1418
|
+
* *
|
|
1419
|
+
*/
|
|
1071
1420
|
interface LightningTransaction {
|
|
1072
1421
|
/**
|
|
1073
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1074
|
-
* string.
|
|
1422
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1423
|
+
* Should be treated as an opaque string.
|
|
1075
1424
|
**/
|
|
1076
1425
|
id: string;
|
|
1077
1426
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1086,27 +1435,38 @@ interface LightningTransaction {
|
|
|
1086
1435
|
typename: string;
|
|
1087
1436
|
/** The date and time when this transaction was completed or failed. **/
|
|
1088
1437
|
resolvedAt?: string | undefined;
|
|
1089
|
-
/**
|
|
1438
|
+
/**
|
|
1439
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
1440
|
+
* Lightning Network. *
|
|
1441
|
+
*/
|
|
1090
1442
|
transactionHash?: string | undefined;
|
|
1091
1443
|
}
|
|
1092
1444
|
declare const getLightningTransactionQuery: (id: string) => Query<LightningTransaction>;
|
|
1093
1445
|
|
|
1094
|
-
/**
|
|
1446
|
+
/**
|
|
1447
|
+
* This object represents post-transaction data that could be used to register
|
|
1448
|
+
* payment for KYT. *
|
|
1449
|
+
*/
|
|
1095
1450
|
interface PostTransactionData {
|
|
1096
1451
|
/**
|
|
1097
|
-
* The utxo of the channel over which the payment went through in the format
|
|
1098
|
-
* <transaction_hash>:<output_index>.
|
|
1452
|
+
* The utxo of the channel over which the payment went through in the format
|
|
1453
|
+
* of <transaction_hash>:<output_index>.
|
|
1099
1454
|
**/
|
|
1100
1455
|
utxo: string;
|
|
1101
1456
|
/** The amount of funds transferred in the payment. **/
|
|
1102
1457
|
amount: CurrencyAmount;
|
|
1103
1458
|
}
|
|
1104
1459
|
|
|
1105
|
-
/**
|
|
1460
|
+
/**
|
|
1461
|
+
* This object represents any payment sent to a Lightspark node on the
|
|
1462
|
+
* Lightning Network. You can retrieve this object to receive payment related
|
|
1463
|
+
* information about a specific payment received by a Lightspark node.
|
|
1464
|
+
* *
|
|
1465
|
+
*/
|
|
1106
1466
|
declare class IncomingPayment implements LightningTransaction, Transaction, Entity {
|
|
1107
1467
|
/**
|
|
1108
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1109
|
-
* string.
|
|
1468
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1469
|
+
* Should be treated as an opaque string.
|
|
1110
1470
|
**/
|
|
1111
1471
|
readonly id: string;
|
|
1112
1472
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1123,19 +1483,25 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1123
1483
|
readonly typename: string;
|
|
1124
1484
|
/** The date and time when this transaction was completed or failed. **/
|
|
1125
1485
|
readonly resolvedAt?: string | undefined;
|
|
1126
|
-
/**
|
|
1486
|
+
/**
|
|
1487
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
1488
|
+
* Lightning Network. *
|
|
1489
|
+
*/
|
|
1127
1490
|
readonly transactionHash?: string | undefined;
|
|
1128
1491
|
/**
|
|
1129
|
-
* The optional payment request for this incoming payment,
|
|
1130
|
-
* through keysend.
|
|
1492
|
+
* The optional payment request for this incoming payment,
|
|
1493
|
+
* which will be null if the payment is sent through keysend.
|
|
1131
1494
|
**/
|
|
1132
1495
|
readonly paymentRequestId?: string | undefined;
|
|
1133
|
-
/**
|
|
1496
|
+
/**
|
|
1497
|
+
* The post transaction data which can be used in KYT payment registration.
|
|
1498
|
+
* *
|
|
1499
|
+
*/
|
|
1134
1500
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
1135
1501
|
constructor(
|
|
1136
1502
|
/**
|
|
1137
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1138
|
-
* string.
|
|
1503
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1504
|
+
* Should be treated as an opaque string.
|
|
1139
1505
|
**/
|
|
1140
1506
|
id: string,
|
|
1141
1507
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1152,14 +1518,20 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1152
1518
|
typename: string,
|
|
1153
1519
|
/** The date and time when this transaction was completed or failed. **/
|
|
1154
1520
|
resolvedAt?: string | undefined,
|
|
1155
|
-
/**
|
|
1521
|
+
/**
|
|
1522
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
1523
|
+
* Lightning Network. *
|
|
1524
|
+
*/
|
|
1156
1525
|
transactionHash?: string | undefined,
|
|
1157
1526
|
/**
|
|
1158
|
-
* The optional payment request for this incoming payment,
|
|
1159
|
-
* through keysend.
|
|
1527
|
+
* The optional payment request for this incoming payment,
|
|
1528
|
+
* which will be null if the payment is sent through keysend.
|
|
1160
1529
|
**/
|
|
1161
1530
|
paymentRequestId?: string | undefined,
|
|
1162
|
-
/**
|
|
1531
|
+
/**
|
|
1532
|
+
* The post transaction data which can be used in KYT payment registration.
|
|
1533
|
+
* *
|
|
1534
|
+
*/
|
|
1163
1535
|
umaPostTransactionData?: PostTransactionData[] | undefined);
|
|
1164
1536
|
getAttempts(client: LightsparkClient, first?: number | undefined, statuses?: IncomingPaymentAttemptStatus[] | undefined, after?: string | undefined): Promise<IncomingPaymentToAttemptsConnection>;
|
|
1165
1537
|
static getIncomingPaymentQuery(id: string): Query<IncomingPayment>;
|
|
@@ -1182,11 +1554,16 @@ declare class IncomingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1182
1554
|
};
|
|
1183
1555
|
}
|
|
1184
1556
|
|
|
1185
|
-
/**
|
|
1557
|
+
/**
|
|
1558
|
+
* This object is an interface representing a Lightning Node on the Lightning
|
|
1559
|
+
* Network, and could either be a Lightspark node or a node managed by a third
|
|
1560
|
+
* party.
|
|
1561
|
+
* *
|
|
1562
|
+
*/
|
|
1186
1563
|
interface Node {
|
|
1187
1564
|
/**
|
|
1188
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1189
|
-
* string.
|
|
1565
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1566
|
+
* Should be treated as an opaque string.
|
|
1190
1567
|
**/
|
|
1191
1568
|
id: string;
|
|
1192
1569
|
/** The date and time when the entity was first created. **/
|
|
@@ -1196,45 +1573,58 @@ interface Node {
|
|
|
1196
1573
|
/** The Bitcoin Network this node is deployed in. **/
|
|
1197
1574
|
bitcoinNetwork: BitcoinNetwork;
|
|
1198
1575
|
/**
|
|
1199
|
-
* The name of this node in the network.
|
|
1200
|
-
*
|
|
1576
|
+
* The name of this node in the network.
|
|
1577
|
+
* It will be the most human-readable option possible,
|
|
1578
|
+
* depending on the data available for this node.
|
|
1201
1579
|
**/
|
|
1202
1580
|
displayName: string;
|
|
1203
1581
|
/** The typename of the object **/
|
|
1204
1582
|
typename: string;
|
|
1205
1583
|
/**
|
|
1206
|
-
* A name that identifies the node. It has no importance in terms of
|
|
1207
|
-
* way to identify and search for commercial
|
|
1208
|
-
* any time by the
|
|
1584
|
+
* A name that identifies the node. It has no importance in terms of
|
|
1585
|
+
* operating the node, it is just a way to identify and search for commercial
|
|
1586
|
+
* services or popular nodes. This alias can be changed at any time by the
|
|
1587
|
+
* node operator.
|
|
1209
1588
|
**/
|
|
1210
1589
|
alias?: string | undefined;
|
|
1211
1590
|
/**
|
|
1212
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
1213
|
-
* has no importance in terms of operating the
|
|
1591
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
1592
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating the
|
|
1593
|
+
* node,
|
|
1594
|
+
* it is just a way to visually differentiate nodes.
|
|
1214
1595
|
* That color can be changed at any time by the node operator.
|
|
1215
1596
|
**/
|
|
1216
1597
|
color?: string | undefined;
|
|
1217
1598
|
/**
|
|
1218
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
1219
|
-
*
|
|
1220
|
-
*
|
|
1599
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
1600
|
+
* receive, or route transactions efficiently.
|
|
1601
|
+
* Maximizing a node's conductivity helps a node’s transactions to be capital
|
|
1602
|
+
* efficient. The value is an integer ranging between 0 and 10 (bounds
|
|
1603
|
+
* included).
|
|
1221
1604
|
**/
|
|
1222
1605
|
conductivity?: number | undefined;
|
|
1223
|
-
/**
|
|
1606
|
+
/**
|
|
1607
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
1608
|
+
* in the Lightning Network. *
|
|
1609
|
+
*/
|
|
1224
1610
|
publicKey?: string | undefined;
|
|
1225
1611
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
1226
1612
|
}
|
|
1227
1613
|
declare const getNodeQuery: (id: string) => Query<Node>;
|
|
1228
1614
|
|
|
1229
|
-
/**
|
|
1615
|
+
/**
|
|
1616
|
+
* This object represents the data associated with a BOLT #11 invoice.
|
|
1617
|
+
* You can retrieve this object to receive the relevant data associated with a
|
|
1618
|
+
* specific invoice. *
|
|
1619
|
+
*/
|
|
1230
1620
|
interface InvoiceData {
|
|
1231
1621
|
encodedPaymentRequest: string;
|
|
1232
1622
|
bitcoinNetwork: BitcoinNetwork;
|
|
1233
1623
|
/** The payment hash of this invoice. **/
|
|
1234
1624
|
paymentHash: string;
|
|
1235
1625
|
/**
|
|
1236
|
-
* The requested amount in this invoice. If it is equal to 0,
|
|
1237
|
-
* send.
|
|
1626
|
+
* The requested amount in this invoice. If it is equal to 0,
|
|
1627
|
+
* the sender should choose the amount to send.
|
|
1238
1628
|
**/
|
|
1239
1629
|
amount: CurrencyAmount;
|
|
1240
1630
|
/** The date and time when this invoice was created. **/
|
|
@@ -1252,8 +1642,8 @@ interface InvoiceData {
|
|
|
1252
1642
|
/** This object represents a BOLT #11 invoice (https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) created by a Lightspark Node. You can retrieve this object to receive relevant payment information for a specific invoice generated by a Lightspark node. **/
|
|
1253
1643
|
interface Invoice {
|
|
1254
1644
|
/**
|
|
1255
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1256
|
-
* string.
|
|
1645
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1646
|
+
* Should be treated as an opaque string.
|
|
1257
1647
|
**/
|
|
1258
1648
|
id: string;
|
|
1259
1649
|
/** The date and time when the entity was first created. **/
|
|
@@ -1274,8 +1664,9 @@ declare const getInvoiceQuery: (id: string) => Query<Invoice>;
|
|
|
1274
1664
|
/** This is an enum for potential invoice types. **/
|
|
1275
1665
|
declare enum InvoiceType {
|
|
1276
1666
|
/**
|
|
1277
|
-
* This is an enum value that represents values that could be added in the
|
|
1278
|
-
* Clients should support unknown values as more of them could be
|
|
1667
|
+
* This is an enum value that represents values that could be added in the
|
|
1668
|
+
* future. Clients should support unknown values as more of them could be
|
|
1669
|
+
* added without notice.
|
|
1279
1670
|
*/
|
|
1280
1671
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1281
1672
|
/** A standard Bolt 11 invoice. **/
|
|
@@ -1294,11 +1685,15 @@ interface ChannelSnapshot {
|
|
|
1294
1685
|
remoteUnsettledBalance?: CurrencyAmount | undefined;
|
|
1295
1686
|
}
|
|
1296
1687
|
|
|
1297
|
-
/**
|
|
1688
|
+
/**
|
|
1689
|
+
* This is an enum representing a particular reason why an htlc sent over the
|
|
1690
|
+
* Lightning Network may have failed. *
|
|
1691
|
+
*/
|
|
1298
1692
|
declare enum HtlcAttemptFailureCode {
|
|
1299
1693
|
/**
|
|
1300
|
-
* This is an enum value that represents values that could be added in the
|
|
1301
|
-
* Clients should support unknown values as more of them could be
|
|
1694
|
+
* This is an enum value that represents values that could be added in the
|
|
1695
|
+
* future. Clients should support unknown values as more of them could be
|
|
1696
|
+
* added without notice.
|
|
1302
1697
|
*/
|
|
1303
1698
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1304
1699
|
INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS = "INCORRECT_OR_UNKNOWN_PAYMENT_DETAILS",
|
|
@@ -1331,11 +1726,15 @@ declare enum HtlcAttemptFailureCode {
|
|
|
1331
1726
|
UNREADABLE_FAILURE = "UNREADABLE_FAILURE"
|
|
1332
1727
|
}
|
|
1333
1728
|
|
|
1334
|
-
/**
|
|
1729
|
+
/**
|
|
1730
|
+
* This is an enum of all potential statuses of a payment attempt made from a
|
|
1731
|
+
* Lightspark Node. *
|
|
1732
|
+
*/
|
|
1335
1733
|
declare enum OutgoingPaymentAttemptStatus {
|
|
1336
1734
|
/**
|
|
1337
|
-
* This is an enum value that represents values that could be added in the
|
|
1338
|
-
* Clients should support unknown values as more of them could be
|
|
1735
|
+
* This is an enum value that represents values that could be added in the
|
|
1736
|
+
* future. Clients should support unknown values as more of them could be
|
|
1737
|
+
* added without notice.
|
|
1339
1738
|
*/
|
|
1340
1739
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1341
1740
|
IN_FLIGHT = "IN_FLIGHT",
|
|
@@ -1343,11 +1742,16 @@ declare enum OutgoingPaymentAttemptStatus {
|
|
|
1343
1742
|
FAILED = "FAILED"
|
|
1344
1743
|
}
|
|
1345
1744
|
|
|
1346
|
-
/**
|
|
1745
|
+
/**
|
|
1746
|
+
* This object represents a specific node that existed on a particular payment
|
|
1747
|
+
* route. You can retrieve this object to get information about a node on a
|
|
1748
|
+
* particular payment path and all payment-relevant information for that node.
|
|
1749
|
+
* *
|
|
1750
|
+
*/
|
|
1347
1751
|
interface Hop {
|
|
1348
1752
|
/**
|
|
1349
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1350
|
-
* string.
|
|
1753
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1754
|
+
* Should be treated as an opaque string.
|
|
1351
1755
|
**/
|
|
1352
1756
|
id: string;
|
|
1353
1757
|
/** The date and time when the entity was first created. **/
|
|
@@ -1364,21 +1768,32 @@ interface Hop {
|
|
|
1364
1768
|
publicKey?: string | undefined;
|
|
1365
1769
|
/** The amount that is to be forwarded to the destination node. **/
|
|
1366
1770
|
amountToForward?: CurrencyAmount | undefined;
|
|
1367
|
-
/**
|
|
1771
|
+
/**
|
|
1772
|
+
* The fees to be collected by the source node for forwarding the payment
|
|
1773
|
+
* over the hop. *
|
|
1774
|
+
*/
|
|
1368
1775
|
fee?: CurrencyAmount | undefined;
|
|
1369
1776
|
/** The block height at which an unsettled HTLC is considered expired. **/
|
|
1370
1777
|
expiryBlockHeight?: number | undefined;
|
|
1371
1778
|
}
|
|
1372
1779
|
declare const getHopQuery: (id: string) => Query<Hop>;
|
|
1373
1780
|
|
|
1374
|
-
/**
|
|
1781
|
+
/**
|
|
1782
|
+
* The connection from an outgoing payment attempt to the list of sequential
|
|
1783
|
+
* hops that define the path from sender node to recipient node.
|
|
1784
|
+
* *
|
|
1785
|
+
*/
|
|
1375
1786
|
interface OutgoingPaymentAttemptToHopsConnection {
|
|
1376
1787
|
/**
|
|
1377
|
-
* The total count of objects in this connection, using the current filters.
|
|
1378
|
-
* number of objects returned in the current page
|
|
1788
|
+
* The total count of objects in this connection, using the current filters.
|
|
1789
|
+
* It is different from the number of objects returned in the current page
|
|
1790
|
+
* (in the `entities` field).
|
|
1379
1791
|
**/
|
|
1380
1792
|
count: number;
|
|
1381
|
-
/**
|
|
1793
|
+
/**
|
|
1794
|
+
* An object that holds pagination information about the objects in this
|
|
1795
|
+
* connection. *
|
|
1796
|
+
*/
|
|
1382
1797
|
pageInfo: PageInfo;
|
|
1383
1798
|
/** The hops for the current page of this connection. **/
|
|
1384
1799
|
entities: Hop[];
|
|
@@ -1386,11 +1801,18 @@ interface OutgoingPaymentAttemptToHopsConnection {
|
|
|
1386
1801
|
typename: string;
|
|
1387
1802
|
}
|
|
1388
1803
|
|
|
1389
|
-
/**
|
|
1804
|
+
/**
|
|
1805
|
+
* This object represents an attempted Lightning Network payment sent from a
|
|
1806
|
+
* Lightspark Node. You can retrieve this object to receive payment related
|
|
1807
|
+
* information about any payment attempt sent from your Lightspark Node on the
|
|
1808
|
+
* Lightning Network,
|
|
1809
|
+
* including any potential reasons the payment may have failed.
|
|
1810
|
+
* *
|
|
1811
|
+
*/
|
|
1390
1812
|
declare class OutgoingPaymentAttempt implements Entity {
|
|
1391
1813
|
/**
|
|
1392
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1393
|
-
* string.
|
|
1814
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1815
|
+
* Should be treated as an opaque string.
|
|
1394
1816
|
**/
|
|
1395
1817
|
readonly id: string;
|
|
1396
1818
|
/** The date and time when the entity was first created. **/
|
|
@@ -1405,33 +1827,41 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1405
1827
|
readonly outgoingPaymentId: string;
|
|
1406
1828
|
/** The typename of the object **/
|
|
1407
1829
|
readonly typename: string;
|
|
1408
|
-
/**
|
|
1830
|
+
/**
|
|
1831
|
+
* If the payment attempt failed, then this contains the Bolt #4 failure
|
|
1832
|
+
* code. *
|
|
1833
|
+
*/
|
|
1409
1834
|
readonly failureCode?: HtlcAttemptFailureCode | undefined;
|
|
1410
1835
|
/**
|
|
1411
|
-
* If the payment attempt failed, then this contains the index of the hop
|
|
1412
|
-
* occurred.
|
|
1836
|
+
* If the payment attempt failed, then this contains the index of the hop
|
|
1837
|
+
* at which the problem occurred.
|
|
1413
1838
|
**/
|
|
1414
1839
|
readonly failureSourceIndex?: number | undefined;
|
|
1415
1840
|
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1416
1841
|
readonly resolvedAt?: string | undefined;
|
|
1417
1842
|
/**
|
|
1418
|
-
* The total amount of funds required to complete a payment over this route.
|
|
1419
|
-
* cumulative fees for each hop. As a result,
|
|
1420
|
-
*
|
|
1421
|
-
* an
|
|
1843
|
+
* The total amount of funds required to complete a payment over this route.
|
|
1844
|
+
* This value includes the cumulative fees for each hop. As a result,
|
|
1845
|
+
* the attempt extended to the first-hop in the route will need to have at
|
|
1846
|
+
* least this much value, otherwise the route will fail at an intermediate
|
|
1847
|
+
* node due to an insufficient amount.
|
|
1422
1848
|
**/
|
|
1423
1849
|
readonly amount?: CurrencyAmount | undefined;
|
|
1424
1850
|
/**
|
|
1425
|
-
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1426
|
-
*
|
|
1851
|
+
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1852
|
+
* In the case of a one-hop payment,
|
|
1853
|
+
* this value will be zero as we don't need to pay a fee to ourselves.
|
|
1427
1854
|
**/
|
|
1428
1855
|
readonly fees?: CurrencyAmount | undefined;
|
|
1429
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* The channel snapshot at the time the outgoing payment attempt was made.
|
|
1858
|
+
* *
|
|
1859
|
+
*/
|
|
1430
1860
|
readonly channelSnapshot?: ChannelSnapshot | undefined;
|
|
1431
1861
|
constructor(
|
|
1432
1862
|
/**
|
|
1433
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1434
|
-
* string.
|
|
1863
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1864
|
+
* Should be treated as an opaque string.
|
|
1435
1865
|
**/
|
|
1436
1866
|
id: string,
|
|
1437
1867
|
/** The date and time when the entity was first created. **/
|
|
@@ -1446,28 +1876,36 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1446
1876
|
outgoingPaymentId: string,
|
|
1447
1877
|
/** The typename of the object **/
|
|
1448
1878
|
typename: string,
|
|
1449
|
-
/**
|
|
1879
|
+
/**
|
|
1880
|
+
* If the payment attempt failed, then this contains the Bolt #4 failure
|
|
1881
|
+
* code. *
|
|
1882
|
+
*/
|
|
1450
1883
|
failureCode?: HtlcAttemptFailureCode | undefined,
|
|
1451
1884
|
/**
|
|
1452
|
-
* If the payment attempt failed, then this contains the index of the hop
|
|
1453
|
-
* occurred.
|
|
1885
|
+
* If the payment attempt failed, then this contains the index of the hop
|
|
1886
|
+
* at which the problem occurred.
|
|
1454
1887
|
**/
|
|
1455
1888
|
failureSourceIndex?: number | undefined,
|
|
1456
1889
|
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1457
1890
|
resolvedAt?: string | undefined,
|
|
1458
1891
|
/**
|
|
1459
|
-
* The total amount of funds required to complete a payment over this route.
|
|
1460
|
-
* cumulative fees for each hop. As a result,
|
|
1461
|
-
*
|
|
1462
|
-
* an
|
|
1892
|
+
* The total amount of funds required to complete a payment over this route.
|
|
1893
|
+
* This value includes the cumulative fees for each hop. As a result,
|
|
1894
|
+
* the attempt extended to the first-hop in the route will need to have at
|
|
1895
|
+
* least this much value, otherwise the route will fail at an intermediate
|
|
1896
|
+
* node due to an insufficient amount.
|
|
1463
1897
|
**/
|
|
1464
1898
|
amount?: CurrencyAmount | undefined,
|
|
1465
1899
|
/**
|
|
1466
|
-
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1467
|
-
*
|
|
1900
|
+
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1901
|
+
* In the case of a one-hop payment,
|
|
1902
|
+
* this value will be zero as we don't need to pay a fee to ourselves.
|
|
1468
1903
|
**/
|
|
1469
1904
|
fees?: CurrencyAmount | undefined,
|
|
1470
|
-
/**
|
|
1905
|
+
/**
|
|
1906
|
+
* The channel snapshot at the time the outgoing payment attempt was made.
|
|
1907
|
+
* *
|
|
1908
|
+
*/
|
|
1471
1909
|
channelSnapshot?: ChannelSnapshot | undefined);
|
|
1472
1910
|
getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
|
|
1473
1911
|
static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
|
|
@@ -1493,11 +1931,15 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1493
1931
|
/** The connection from outgoing payment to all attempts. **/
|
|
1494
1932
|
interface OutgoingPaymentToAttemptsConnection {
|
|
1495
1933
|
/**
|
|
1496
|
-
* The total count of objects in this connection, using the current filters.
|
|
1497
|
-
* number of objects returned in the current page
|
|
1934
|
+
* The total count of objects in this connection, using the current filters.
|
|
1935
|
+
* It is different from the number of objects returned in the current page
|
|
1936
|
+
* (in the `entities` field).
|
|
1498
1937
|
**/
|
|
1499
1938
|
count: number;
|
|
1500
|
-
/**
|
|
1939
|
+
/**
|
|
1940
|
+
* An object that holds pagination information about the objects in this
|
|
1941
|
+
* connection. *
|
|
1942
|
+
*/
|
|
1501
1943
|
pageInfo: PageInfo;
|
|
1502
1944
|
/** The attempts for the current page of this connection. **/
|
|
1503
1945
|
entities: OutgoingPaymentAttempt[];
|
|
@@ -1509,11 +1951,16 @@ interface RichText {
|
|
|
1509
1951
|
text: string;
|
|
1510
1952
|
}
|
|
1511
1953
|
|
|
1512
|
-
/**
|
|
1954
|
+
/**
|
|
1955
|
+
* This object represents a Lightning Network payment sent from a Lightspark
|
|
1956
|
+
* Node. You can retrieve this object to receive payment related information
|
|
1957
|
+
* about any payment sent from your Lightspark Node on the Lightning Network.
|
|
1958
|
+
* *
|
|
1959
|
+
*/
|
|
1513
1960
|
declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
|
|
1514
1961
|
/**
|
|
1515
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1516
|
-
* string.
|
|
1962
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1963
|
+
* Should be treated as an opaque string.
|
|
1517
1964
|
**/
|
|
1518
1965
|
readonly id: string;
|
|
1519
1966
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1530,26 +1977,38 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1530
1977
|
readonly typename: string;
|
|
1531
1978
|
/** The date and time when this transaction was completed or failed. **/
|
|
1532
1979
|
readonly resolvedAt?: string | undefined;
|
|
1533
|
-
/**
|
|
1980
|
+
/**
|
|
1981
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
1982
|
+
* Lightning Network. *
|
|
1983
|
+
*/
|
|
1534
1984
|
readonly transactionHash?: string | undefined;
|
|
1535
1985
|
/** If known, the final recipient node this payment was sent to. **/
|
|
1536
1986
|
readonly destinationId?: string | undefined;
|
|
1537
1987
|
/** The fees paid by the sender node to send the payment. **/
|
|
1538
1988
|
readonly fees?: CurrencyAmount | undefined;
|
|
1539
|
-
/**
|
|
1989
|
+
/**
|
|
1990
|
+
* The data of the payment request that was paid by this transaction, if
|
|
1991
|
+
* known. *
|
|
1992
|
+
*/
|
|
1540
1993
|
readonly paymentRequestData?: PaymentRequestData | undefined;
|
|
1541
1994
|
/** If applicable, the reason why the payment failed. **/
|
|
1542
1995
|
readonly failureReason?: PaymentFailureReason | undefined;
|
|
1543
|
-
/**
|
|
1996
|
+
/**
|
|
1997
|
+
* If applicable, user-facing error message describing why the payment
|
|
1998
|
+
* failed. *
|
|
1999
|
+
*/
|
|
1544
2000
|
readonly failureMessage?: RichText | undefined;
|
|
1545
|
-
/**
|
|
2001
|
+
/**
|
|
2002
|
+
* The post transaction data which can be used in KYT payment registration.
|
|
2003
|
+
* *
|
|
2004
|
+
*/
|
|
1546
2005
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
1547
2006
|
/** The preimage of the payment. **/
|
|
1548
2007
|
readonly paymentPreimage?: string | undefined;
|
|
1549
2008
|
constructor(
|
|
1550
2009
|
/**
|
|
1551
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1552
|
-
* string.
|
|
2010
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2011
|
+
* Should be treated as an opaque string.
|
|
1553
2012
|
**/
|
|
1554
2013
|
id: string,
|
|
1555
2014
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1566,19 +2025,31 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1566
2025
|
typename: string,
|
|
1567
2026
|
/** The date and time when this transaction was completed or failed. **/
|
|
1568
2027
|
resolvedAt?: string | undefined,
|
|
1569
|
-
/**
|
|
2028
|
+
/**
|
|
2029
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2030
|
+
* Lightning Network. *
|
|
2031
|
+
*/
|
|
1570
2032
|
transactionHash?: string | undefined,
|
|
1571
2033
|
/** If known, the final recipient node this payment was sent to. **/
|
|
1572
2034
|
destinationId?: string | undefined,
|
|
1573
2035
|
/** The fees paid by the sender node to send the payment. **/
|
|
1574
2036
|
fees?: CurrencyAmount | undefined,
|
|
1575
|
-
/**
|
|
2037
|
+
/**
|
|
2038
|
+
* The data of the payment request that was paid by this transaction, if
|
|
2039
|
+
* known. *
|
|
2040
|
+
*/
|
|
1576
2041
|
paymentRequestData?: PaymentRequestData | undefined,
|
|
1577
2042
|
/** If applicable, the reason why the payment failed. **/
|
|
1578
2043
|
failureReason?: PaymentFailureReason | undefined,
|
|
1579
|
-
/**
|
|
2044
|
+
/**
|
|
2045
|
+
* If applicable, user-facing error message describing why the payment
|
|
2046
|
+
* failed. *
|
|
2047
|
+
*/
|
|
1580
2048
|
failureMessage?: RichText | undefined,
|
|
1581
|
-
/**
|
|
2049
|
+
/**
|
|
2050
|
+
* The post transaction data which can be used in KYT payment registration.
|
|
2051
|
+
* *
|
|
2052
|
+
*/
|
|
1582
2053
|
umaPostTransactionData?: PostTransactionData[] | undefined,
|
|
1583
2054
|
/** The preimage of the payment. **/
|
|
1584
2055
|
paymentPreimage?: string | undefined);
|
|
@@ -1608,11 +2079,15 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1608
2079
|
};
|
|
1609
2080
|
}
|
|
1610
2081
|
|
|
1611
|
-
/**
|
|
2082
|
+
/**
|
|
2083
|
+
* The alpha-2 representation of a country, as defined by the ISO 3166-1
|
|
2084
|
+
* standard. *
|
|
2085
|
+
*/
|
|
1612
2086
|
declare enum RegionCode {
|
|
1613
2087
|
/**
|
|
1614
|
-
* This is an enum value that represents values that could be added in the
|
|
1615
|
-
* Clients should support unknown values as more of them could be
|
|
2088
|
+
* This is an enum value that represents values that could be added in the
|
|
2089
|
+
* future. Clients should support unknown values as more of them could be
|
|
2090
|
+
* added without notice.
|
|
1616
2091
|
*/
|
|
1617
2092
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1618
2093
|
/** The code representing the country of Afghanistan. **/
|
|
@@ -1667,9 +2142,15 @@ declare enum RegionCode {
|
|
|
1667
2142
|
BM = "BM",
|
|
1668
2143
|
/** The code representing the country of Bhutan. **/
|
|
1669
2144
|
BT = "BT",
|
|
1670
|
-
/**
|
|
2145
|
+
/**
|
|
2146
|
+
* The code representing the country of The Plurinational State of Bolivia.
|
|
2147
|
+
* *
|
|
2148
|
+
*/
|
|
1671
2149
|
BO = "BO",
|
|
1672
|
-
/**
|
|
2150
|
+
/**
|
|
2151
|
+
* The code representing the country of Bonaire, Sint Eustatius, and Saba.
|
|
2152
|
+
* *
|
|
2153
|
+
*/
|
|
1673
2154
|
BQ = "BQ",
|
|
1674
2155
|
/** The code representing the country of Bosnia and Herzegovina. **/
|
|
1675
2156
|
BA = "BA",
|
|
@@ -1717,7 +2198,10 @@ declare enum RegionCode {
|
|
|
1717
2198
|
KM = "KM",
|
|
1718
2199
|
/** The code representing the country of Congo. **/
|
|
1719
2200
|
CG = "CG",
|
|
1720
|
-
/**
|
|
2201
|
+
/**
|
|
2202
|
+
* The code representing the country of The Democratic Republic of the Congo.
|
|
2203
|
+
* *
|
|
2204
|
+
*/
|
|
1721
2205
|
CD = "CD",
|
|
1722
2206
|
/** The code representing the country of Cook Islands. **/
|
|
1723
2207
|
CK = "CK",
|
|
@@ -1807,7 +2291,10 @@ declare enum RegionCode {
|
|
|
1807
2291
|
GY = "GY",
|
|
1808
2292
|
/** The code representing the country of Haiti. **/
|
|
1809
2293
|
HT = "HT",
|
|
1810
|
-
/**
|
|
2294
|
+
/**
|
|
2295
|
+
* The code representing the country of Heard Island and McDonald Islands.
|
|
2296
|
+
* *
|
|
2297
|
+
*/
|
|
1811
2298
|
HM = "HM",
|
|
1812
2299
|
/** The code representing the country of Holy See (Vatican City State). **/
|
|
1813
2300
|
VA = "VA",
|
|
@@ -1849,7 +2336,10 @@ declare enum RegionCode {
|
|
|
1849
2336
|
KE = "KE",
|
|
1850
2337
|
/** The code representing the country of Kiribati. **/
|
|
1851
2338
|
KI = "KI",
|
|
1852
|
-
/**
|
|
2339
|
+
/**
|
|
2340
|
+
* The code representing the country of Democratic People's Republic ofKorea.
|
|
2341
|
+
* *
|
|
2342
|
+
*/
|
|
1853
2343
|
KP = "KP",
|
|
1854
2344
|
/** The code representing the country of Republic of Korea. **/
|
|
1855
2345
|
KR = "KR",
|
|
@@ -1877,7 +2367,10 @@ declare enum RegionCode {
|
|
|
1877
2367
|
LU = "LU",
|
|
1878
2368
|
/** The code representing the country of Macao. **/
|
|
1879
2369
|
MO = "MO",
|
|
1880
|
-
/**
|
|
2370
|
+
/**
|
|
2371
|
+
* The code representing the country of The Former Yugoslav Republic of
|
|
2372
|
+
* Macedonia. *
|
|
2373
|
+
*/
|
|
1881
2374
|
MK = "MK",
|
|
1882
2375
|
/** The code representing the country of Madagascar. **/
|
|
1883
2376
|
MG = "MG",
|
|
@@ -1985,7 +2478,10 @@ declare enum RegionCode {
|
|
|
1985
2478
|
RW = "RW",
|
|
1986
2479
|
/** The code representing the country of Saint Barthélemy. **/
|
|
1987
2480
|
BL = "BL",
|
|
1988
|
-
/**
|
|
2481
|
+
/**
|
|
2482
|
+
* The code representing the country of Saint Helena Ascension and Tristan
|
|
2483
|
+
* da Cunha. *
|
|
2484
|
+
*/
|
|
1989
2485
|
SH = "SH",
|
|
1990
2486
|
/** The code representing the country of Saint Kitts and Nevis. **/
|
|
1991
2487
|
KN = "KN",
|
|
@@ -2027,7 +2523,10 @@ declare enum RegionCode {
|
|
|
2027
2523
|
SO = "SO",
|
|
2028
2524
|
/** The code representing the country of South Africa. **/
|
|
2029
2525
|
ZA = "ZA",
|
|
2030
|
-
/**
|
|
2526
|
+
/**
|
|
2527
|
+
* The code representing the country of South Georgia and the South Sandwich
|
|
2528
|
+
* Islands. *
|
|
2529
|
+
*/
|
|
2031
2530
|
GS = "GS",
|
|
2032
2531
|
/** The code representing the country of South Sudan. **/
|
|
2033
2532
|
SS = "SS",
|
|
@@ -2087,7 +2586,10 @@ declare enum RegionCode {
|
|
|
2087
2586
|
GB = "GB",
|
|
2088
2587
|
/** The code representing the country of United States. **/
|
|
2089
2588
|
US = "US",
|
|
2090
|
-
/**
|
|
2589
|
+
/**
|
|
2590
|
+
* The code representing the country of United States Minor Outlying Islands.
|
|
2591
|
+
* *
|
|
2592
|
+
*/
|
|
2091
2593
|
UM = "UM",
|
|
2092
2594
|
/** The code representing the country of Uruguay. **/
|
|
2093
2595
|
UY = "UY",
|
|
@@ -2140,8 +2642,8 @@ type SingleNodeDashboard = {
|
|
|
2140
2642
|
|
|
2141
2643
|
type TransactionUpdate = {
|
|
2142
2644
|
/**
|
|
2143
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2144
|
-
* string.
|
|
2645
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2646
|
+
* Should be treated as an opaque string.
|
|
2145
2647
|
**/
|
|
2146
2648
|
id: string;
|
|
2147
2649
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2156,51 +2658,88 @@ type TransactionUpdate = {
|
|
|
2156
2658
|
typename: string;
|
|
2157
2659
|
/** The date and time when this transaction was completed or failed. **/
|
|
2158
2660
|
resolvedAt?: string;
|
|
2159
|
-
/**
|
|
2661
|
+
/**
|
|
2662
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2663
|
+
* Lightning Network. *
|
|
2664
|
+
*/
|
|
2160
2665
|
transactionHash?: string;
|
|
2161
2666
|
};
|
|
2162
2667
|
|
|
2163
|
-
/**
|
|
2668
|
+
/**
|
|
2669
|
+
* Describes the reason for an invitation to not be eligible for incentives.
|
|
2670
|
+
* *
|
|
2671
|
+
*/
|
|
2164
2672
|
declare enum IncentivesIneligibilityReason {
|
|
2165
2673
|
/**
|
|
2166
|
-
* This is an enum value that represents values that could be added in the
|
|
2167
|
-
* Clients should support unknown values as more of them could be
|
|
2674
|
+
* This is an enum value that represents values that could be added in the
|
|
2675
|
+
* future. Clients should support unknown values as more of them could be
|
|
2676
|
+
* added without notice.
|
|
2168
2677
|
*/
|
|
2169
2678
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2170
|
-
/**
|
|
2679
|
+
/**
|
|
2680
|
+
* This invitation is not eligible for incentives because it has been created
|
|
2681
|
+
* outside of the incentives flow. *
|
|
2682
|
+
*/
|
|
2171
2683
|
DISABLED = "DISABLED",
|
|
2172
|
-
/**
|
|
2684
|
+
/**
|
|
2685
|
+
* This invitation is not eligible for incentives because the sender is not
|
|
2686
|
+
* eligible. *
|
|
2687
|
+
*/
|
|
2173
2688
|
SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
|
|
2174
|
-
/**
|
|
2689
|
+
/**
|
|
2690
|
+
* This invitation is not eligible for incentives because the receiver is not
|
|
2691
|
+
* eligible. *
|
|
2692
|
+
*/
|
|
2175
2693
|
RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
|
|
2176
|
-
/**
|
|
2694
|
+
/**
|
|
2695
|
+
* This invitation is not eligible for incentives because the sending VASP is
|
|
2696
|
+
* not part of the incentives program.
|
|
2697
|
+
* *
|
|
2698
|
+
*/
|
|
2177
2699
|
SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
|
|
2178
|
-
/**
|
|
2700
|
+
/**
|
|
2701
|
+
* This invitation is not eligible for incentives because the receiving VASP
|
|
2702
|
+
* is not part of the incentives program.
|
|
2703
|
+
* *
|
|
2704
|
+
*/
|
|
2179
2705
|
RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
|
|
2180
|
-
/**
|
|
2706
|
+
/**
|
|
2707
|
+
* This invitation is not eligible for incentives because the sender and
|
|
2708
|
+
* receiver are in the same region. *
|
|
2709
|
+
*/
|
|
2181
2710
|
NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
|
|
2182
2711
|
}
|
|
2183
2712
|
|
|
2184
2713
|
/** Describes the status of the incentives for this invitation. **/
|
|
2185
2714
|
declare enum IncentivesStatus {
|
|
2186
2715
|
/**
|
|
2187
|
-
* This is an enum value that represents values that could be added in the
|
|
2188
|
-
* Clients should support unknown values as more of them could be
|
|
2716
|
+
* This is an enum value that represents values that could be added in the
|
|
2717
|
+
* future. Clients should support unknown values as more of them could be
|
|
2718
|
+
* added without notice.
|
|
2189
2719
|
*/
|
|
2190
2720
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2191
|
-
/**
|
|
2721
|
+
/**
|
|
2722
|
+
* The invitation is eligible for incentives in its current state.
|
|
2723
|
+
* When it is claimed, we will reassess.
|
|
2724
|
+
* *
|
|
2725
|
+
*/
|
|
2192
2726
|
PENDING = "PENDING",
|
|
2193
2727
|
/** The incentives have been validated. **/
|
|
2194
2728
|
VALIDATED = "VALIDATED",
|
|
2195
|
-
/**
|
|
2729
|
+
/**
|
|
2730
|
+
* This invitation is not eligible for incentives.
|
|
2731
|
+
* A more detailed reason can be found in the
|
|
2732
|
+
* `incentives_ineligibility_reason` field.
|
|
2733
|
+
* *
|
|
2734
|
+
*/
|
|
2196
2735
|
INELIGIBLE = "INELIGIBLE"
|
|
2197
2736
|
}
|
|
2198
2737
|
|
|
2199
2738
|
/** This is an object representing an UMA.ME invitation. **/
|
|
2200
2739
|
interface UmaInvitation {
|
|
2201
2740
|
/**
|
|
2202
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2203
|
-
* string.
|
|
2741
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2742
|
+
* Should be treated as an opaque string.
|
|
2204
2743
|
**/
|
|
2205
2744
|
id: string;
|
|
2206
2745
|
/** The date and time when the entity was first created. **/
|
|
@@ -2213,22 +2752,32 @@ interface UmaInvitation {
|
|
|
2213
2752
|
url: string;
|
|
2214
2753
|
/** The UMA of the user who created the invitation. **/
|
|
2215
2754
|
inviterUma: string;
|
|
2216
|
-
/**
|
|
2755
|
+
/**
|
|
2756
|
+
* The current status of the incentives that may be tied to this invitation.
|
|
2757
|
+
* *
|
|
2758
|
+
*/
|
|
2217
2759
|
incentivesStatus: IncentivesStatus;
|
|
2218
2760
|
/** The typename of the object **/
|
|
2219
2761
|
typename: string;
|
|
2220
2762
|
/** The UMA of the user who claimed the invitation. **/
|
|
2221
2763
|
inviteeUma?: string | undefined;
|
|
2222
|
-
/**
|
|
2764
|
+
/**
|
|
2765
|
+
* The reason why the invitation is not eligible for incentives, if
|
|
2766
|
+
* applicable. *
|
|
2767
|
+
*/
|
|
2223
2768
|
incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
|
|
2224
2769
|
}
|
|
2225
2770
|
declare const getUmaInvitationQuery: (id: string) => Query<UmaInvitation>;
|
|
2226
2771
|
|
|
2227
|
-
/**
|
|
2772
|
+
/**
|
|
2773
|
+
* This is an enum of the potential modes that your Bitcoin withdrawal can
|
|
2774
|
+
* take. *
|
|
2775
|
+
*/
|
|
2228
2776
|
declare enum WithdrawalMode {
|
|
2229
2777
|
/**
|
|
2230
|
-
* This is an enum value that represents values that could be added in the
|
|
2231
|
-
* Clients should support unknown values as more of them could be
|
|
2778
|
+
* This is an enum value that represents values that could be added in the
|
|
2779
|
+
* future. Clients should support unknown values as more of them could be
|
|
2780
|
+
* added without notice.
|
|
2232
2781
|
*/
|
|
2233
2782
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2234
2783
|
WALLET_ONLY = "WALLET_ONLY",
|
|
@@ -2238,8 +2787,9 @@ declare enum WithdrawalMode {
|
|
|
2238
2787
|
/** This is an enum of the potential statuses that a Withdrawal can take. **/
|
|
2239
2788
|
declare enum WithdrawalRequestStatus {
|
|
2240
2789
|
/**
|
|
2241
|
-
* This is an enum value that represents values that could be added in the
|
|
2242
|
-
* Clients should support unknown values as more of them could be
|
|
2790
|
+
* This is an enum value that represents values that could be added in the
|
|
2791
|
+
* future. Clients should support unknown values as more of them could be
|
|
2792
|
+
* added without notice.
|
|
2243
2793
|
*/
|
|
2244
2794
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2245
2795
|
CREATED = "CREATED",
|
|
@@ -2248,11 +2798,16 @@ declare enum WithdrawalRequestStatus {
|
|
|
2248
2798
|
SUCCESSFUL = "SUCCESSFUL"
|
|
2249
2799
|
}
|
|
2250
2800
|
|
|
2251
|
-
/**
|
|
2801
|
+
/**
|
|
2802
|
+
* This is an object representing a transaction which closes a channel on the
|
|
2803
|
+
* Lightning Network. This operation allocates balances back to the local and
|
|
2804
|
+
* remote nodes.
|
|
2805
|
+
* *
|
|
2806
|
+
*/
|
|
2252
2807
|
interface ChannelClosingTransaction {
|
|
2253
2808
|
/**
|
|
2254
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2255
|
-
* string.
|
|
2809
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2810
|
+
* Should be treated as an opaque string.
|
|
2256
2811
|
**/
|
|
2257
2812
|
id: string;
|
|
2258
2813
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2264,8 +2819,8 @@ interface ChannelClosingTransaction {
|
|
|
2264
2819
|
/** The amount of money involved in this transaction. **/
|
|
2265
2820
|
amount: CurrencyAmount;
|
|
2266
2821
|
/**
|
|
2267
|
-
* The height of the block that included this transaction.
|
|
2268
|
-
* transactions.
|
|
2822
|
+
* The height of the block that included this transaction.
|
|
2823
|
+
* This will be zero for unconfirmed transactions.
|
|
2269
2824
|
**/
|
|
2270
2825
|
blockHeight: number;
|
|
2271
2826
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -2274,19 +2829,25 @@ interface ChannelClosingTransaction {
|
|
|
2274
2829
|
typename: string;
|
|
2275
2830
|
/** The date and time when this transaction was completed or failed. **/
|
|
2276
2831
|
resolvedAt?: string | undefined;
|
|
2277
|
-
/**
|
|
2832
|
+
/**
|
|
2833
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2834
|
+
* Lightning Network. *
|
|
2835
|
+
*/
|
|
2278
2836
|
transactionHash?: string | undefined;
|
|
2279
2837
|
/**
|
|
2280
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2281
|
-
* blockchain.
|
|
2838
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2839
|
+
* to the Bitcoin blockchain.
|
|
2282
2840
|
**/
|
|
2283
2841
|
fees?: CurrencyAmount | undefined;
|
|
2284
2842
|
/**
|
|
2285
|
-
* The hash of the block that included this transaction.
|
|
2286
|
-
* transactions.
|
|
2843
|
+
* The hash of the block that included this transaction.
|
|
2844
|
+
* This will be null for unconfirmed transactions.
|
|
2287
2845
|
**/
|
|
2288
2846
|
blockHash?: string | undefined;
|
|
2289
|
-
/**
|
|
2847
|
+
/**
|
|
2848
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
2849
|
+
* *
|
|
2850
|
+
*/
|
|
2290
2851
|
numConfirmations?: number | undefined;
|
|
2291
2852
|
/** If known, the channel this transaction is closing. **/
|
|
2292
2853
|
channelId?: string | undefined;
|
|
@@ -2294,22 +2855,34 @@ interface ChannelClosingTransaction {
|
|
|
2294
2855
|
declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
|
|
2295
2856
|
|
|
2296
2857
|
interface WithdrawalRequestToChannelClosingTransactionsConnection {
|
|
2297
|
-
/**
|
|
2858
|
+
/**
|
|
2859
|
+
* An object that holds pagination information about the objects in this
|
|
2860
|
+
* connection. *
|
|
2861
|
+
*/
|
|
2298
2862
|
pageInfo: PageInfo;
|
|
2299
2863
|
/**
|
|
2300
|
-
* The total count of objects in this connection, using the current filters.
|
|
2301
|
-
* number of objects returned in the current page
|
|
2864
|
+
* The total count of objects in this connection, using the current filters.
|
|
2865
|
+
* It is different from the number of objects returned in the current page
|
|
2866
|
+
* (in the `entities` field).
|
|
2302
2867
|
**/
|
|
2303
2868
|
count: number;
|
|
2304
|
-
/**
|
|
2869
|
+
/**
|
|
2870
|
+
* The channel closing transactions for the current page of this connection.
|
|
2871
|
+
* *
|
|
2872
|
+
*/
|
|
2305
2873
|
entities: ChannelClosingTransaction[];
|
|
2306
2874
|
}
|
|
2307
2875
|
|
|
2308
|
-
/**
|
|
2876
|
+
/**
|
|
2877
|
+
* This is an object representing a transaction which opens a channel on the
|
|
2878
|
+
* Lightning Network. This object occurs only for channels funded by the local
|
|
2879
|
+
* Lightspark node.
|
|
2880
|
+
* *
|
|
2881
|
+
*/
|
|
2309
2882
|
interface ChannelOpeningTransaction {
|
|
2310
2883
|
/**
|
|
2311
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2312
|
-
* string.
|
|
2884
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2885
|
+
* Should be treated as an opaque string.
|
|
2313
2886
|
**/
|
|
2314
2887
|
id: string;
|
|
2315
2888
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2321,8 +2894,8 @@ interface ChannelOpeningTransaction {
|
|
|
2321
2894
|
/** The amount of money involved in this transaction. **/
|
|
2322
2895
|
amount: CurrencyAmount;
|
|
2323
2896
|
/**
|
|
2324
|
-
* The height of the block that included this transaction.
|
|
2325
|
-
* transactions.
|
|
2897
|
+
* The height of the block that included this transaction.
|
|
2898
|
+
* This will be zero for unconfirmed transactions.
|
|
2326
2899
|
**/
|
|
2327
2900
|
blockHeight: number;
|
|
2328
2901
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -2331,19 +2904,25 @@ interface ChannelOpeningTransaction {
|
|
|
2331
2904
|
typename: string;
|
|
2332
2905
|
/** The date and time when this transaction was completed or failed. **/
|
|
2333
2906
|
resolvedAt?: string | undefined;
|
|
2334
|
-
/**
|
|
2907
|
+
/**
|
|
2908
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2909
|
+
* Lightning Network. *
|
|
2910
|
+
*/
|
|
2335
2911
|
transactionHash?: string | undefined;
|
|
2336
2912
|
/**
|
|
2337
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2338
|
-
* blockchain.
|
|
2913
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2914
|
+
* to the Bitcoin blockchain.
|
|
2339
2915
|
**/
|
|
2340
2916
|
fees?: CurrencyAmount | undefined;
|
|
2341
2917
|
/**
|
|
2342
|
-
* The hash of the block that included this transaction.
|
|
2343
|
-
* transactions.
|
|
2918
|
+
* The hash of the block that included this transaction.
|
|
2919
|
+
* This will be null for unconfirmed transactions.
|
|
2344
2920
|
**/
|
|
2345
2921
|
blockHash?: string | undefined;
|
|
2346
|
-
/**
|
|
2922
|
+
/**
|
|
2923
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
2924
|
+
* *
|
|
2925
|
+
*/
|
|
2347
2926
|
numConfirmations?: number | undefined;
|
|
2348
2927
|
/** If known, the channel this transaction is opening. **/
|
|
2349
2928
|
channelId?: string | undefined;
|
|
@@ -2351,22 +2930,35 @@ interface ChannelOpeningTransaction {
|
|
|
2351
2930
|
declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
|
|
2352
2931
|
|
|
2353
2932
|
interface WithdrawalRequestToChannelOpeningTransactionsConnection {
|
|
2354
|
-
/**
|
|
2933
|
+
/**
|
|
2934
|
+
* An object that holds pagination information about the objects in this
|
|
2935
|
+
* connection. *
|
|
2936
|
+
*/
|
|
2355
2937
|
pageInfo: PageInfo;
|
|
2356
2938
|
/**
|
|
2357
|
-
* The total count of objects in this connection, using the current filters.
|
|
2358
|
-
* number of objects returned in the current page
|
|
2939
|
+
* The total count of objects in this connection, using the current filters.
|
|
2940
|
+
* It is different from the number of objects returned in the current page
|
|
2941
|
+
* (in the `entities` field).
|
|
2359
2942
|
**/
|
|
2360
2943
|
count: number;
|
|
2361
|
-
/**
|
|
2944
|
+
/**
|
|
2945
|
+
* The channel opening transactions for the current page of this connection.
|
|
2946
|
+
* *
|
|
2947
|
+
*/
|
|
2362
2948
|
entities: ChannelOpeningTransaction[];
|
|
2363
2949
|
}
|
|
2364
2950
|
|
|
2365
|
-
/**
|
|
2951
|
+
/**
|
|
2952
|
+
* This object represents a request made for an L1 withdrawal from your
|
|
2953
|
+
* Lightspark Node to any Bitcoin wallet.
|
|
2954
|
+
* You can retrieve this object to receive detailed information about any
|
|
2955
|
+
* withdrawal request made from your Lightspark account.
|
|
2956
|
+
* *
|
|
2957
|
+
*/
|
|
2366
2958
|
declare class WithdrawalRequest implements Entity {
|
|
2367
2959
|
/**
|
|
2368
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2369
|
-
* string.
|
|
2960
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2961
|
+
* Should be treated as an opaque string.
|
|
2370
2962
|
**/
|
|
2371
2963
|
readonly id: string;
|
|
2372
2964
|
/** The date and time when the entity was first created. **/
|
|
@@ -2377,15 +2969,18 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2377
2969
|
readonly amount: CurrencyAmount;
|
|
2378
2970
|
/** The bitcoin address where the funds should be sent. **/
|
|
2379
2971
|
readonly bitcoinAddress: string;
|
|
2380
|
-
/**
|
|
2972
|
+
/**
|
|
2973
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
2974
|
+
* *
|
|
2975
|
+
*/
|
|
2381
2976
|
readonly withdrawalMode: WithdrawalMode;
|
|
2382
2977
|
/** The current status of this withdrawal request. **/
|
|
2383
2978
|
readonly status: WithdrawalRequestStatus;
|
|
2384
2979
|
/** The typename of the object **/
|
|
2385
2980
|
readonly typename: string;
|
|
2386
2981
|
/**
|
|
2387
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
2388
|
-
* for the withdrawal.
|
|
2982
|
+
* If the requested amount is `-1` (i.e. everything),
|
|
2983
|
+
* this field may contain an estimate of the amount for the withdrawal.
|
|
2389
2984
|
**/
|
|
2390
2985
|
readonly estimatedAmount?: CurrencyAmount | undefined;
|
|
2391
2986
|
/** The time at which this request was completed. **/
|
|
@@ -2394,8 +2989,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2394
2989
|
readonly withdrawalId?: string | undefined;
|
|
2395
2990
|
constructor(
|
|
2396
2991
|
/**
|
|
2397
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2398
|
-
* string.
|
|
2992
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2993
|
+
* Should be treated as an opaque string.
|
|
2399
2994
|
**/
|
|
2400
2995
|
id: string,
|
|
2401
2996
|
/** The date and time when the entity was first created. **/
|
|
@@ -2406,15 +3001,18 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2406
3001
|
amount: CurrencyAmount,
|
|
2407
3002
|
/** The bitcoin address where the funds should be sent. **/
|
|
2408
3003
|
bitcoinAddress: string,
|
|
2409
|
-
/**
|
|
3004
|
+
/**
|
|
3005
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
3006
|
+
* *
|
|
3007
|
+
*/
|
|
2410
3008
|
withdrawalMode: WithdrawalMode,
|
|
2411
3009
|
/** The current status of this withdrawal request. **/
|
|
2412
3010
|
status: WithdrawalRequestStatus,
|
|
2413
3011
|
/** The typename of the object **/
|
|
2414
3012
|
typename: string,
|
|
2415
3013
|
/**
|
|
2416
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
2417
|
-
* for the withdrawal.
|
|
3014
|
+
* If the requested amount is `-1` (i.e. everything),
|
|
3015
|
+
* this field may contain an estimate of the amount for the withdrawal.
|
|
2418
3016
|
**/
|
|
2419
3017
|
estimatedAmount?: CurrencyAmount | undefined,
|
|
2420
3018
|
/** The time at which this request was completed. **/
|
|
@@ -2442,28 +3040,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
2442
3040
|
}
|
|
2443
3041
|
|
|
2444
3042
|
/**
|
|
2445
|
-
*
|
|
2446
|
-
|
|
2447
|
-
type SigningKeyLoaderArgs = NodeIdAndPasswordSigningKeyLoaderArgs | MasterSeedSigningKeyLoaderArgs;
|
|
2448
|
-
/**
|
|
2449
|
-
* Args for creating a new SigningKeyLoader from a node ID and password.
|
|
2450
|
-
* This cannot be used if you are using remote signing. It is used to recover an RSA operation signing key using
|
|
2451
|
-
* the password you chose when setting up your node. For REGTEST nodes, the password is "1234!@#$".
|
|
2452
|
-
*/
|
|
2453
|
-
interface NodeIdAndPasswordSigningKeyLoaderArgs {
|
|
2454
|
-
password: string;
|
|
2455
|
-
}
|
|
2456
|
-
/**
|
|
2457
|
-
* Args for creating a new SigningKeyLoader from a master seed and network.
|
|
2458
|
-
* This should be used if you are using remote signing, rather than an RSA operation signing key.
|
|
2459
|
-
*/
|
|
2460
|
-
interface MasterSeedSigningKeyLoaderArgs {
|
|
2461
|
-
masterSeed: Uint8Array;
|
|
2462
|
-
network: BitcoinNetwork;
|
|
2463
|
-
}
|
|
2464
|
-
|
|
2465
|
-
/**
|
|
2466
|
-
* The LightsparkClient is the main entrypoint for interacting with the Lightspark API.
|
|
3043
|
+
* The LightsparkClient is the main entrypoint for interacting with the
|
|
3044
|
+
* Lightspark API.
|
|
2467
3045
|
*
|
|
2468
3046
|
* ```ts
|
|
2469
3047
|
* const lightsparkClient = new LightsparkClient(
|
|
@@ -2501,27 +3079,32 @@ declare class LightsparkClient {
|
|
|
2501
3079
|
* use, you should use the `AccountTokenAuthProvider`.
|
|
2502
3080
|
* @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
|
|
2503
3081
|
* @param cryptoImpl The crypto implementation to use. Defaults to web and node compatible crypto.
|
|
2504
|
-
* For React Native, you should use the `ReactNativeCrypto`
|
|
3082
|
+
* For React Native, you should use the `ReactNativeCrypto`
|
|
3083
|
+
* implementation from `@lightsparkdev/react-native`.
|
|
2505
3084
|
*/
|
|
2506
3085
|
constructor(authProvider?: AuthProvider, serverUrl?: string, cryptoImpl?: CryptoInterface);
|
|
2507
3086
|
/**
|
|
2508
|
-
* Sets the key loader for a node. This unlocks client operations that
|
|
2509
|
-
* Passing in [NodeIdAndPasswordSigningKeyLoaderArgs]
|
|
2510
|
-
*
|
|
3087
|
+
* Sets the key loader for a node. This unlocks client operations that
|
|
3088
|
+
* require a private key. Passing in [NodeIdAndPasswordSigningKeyLoaderArgs]
|
|
3089
|
+
* loads the RSA key for an OSK node.
|
|
3090
|
+
* Passing in [MasterSeedSigningKeyLoaderArgs] loads the Secp256k1 key for a
|
|
3091
|
+
* remote signing node.
|
|
2511
3092
|
*
|
|
2512
3093
|
* @param nodeId The ID of the node the key is for
|
|
2513
3094
|
* @param loader The loader for the key
|
|
2514
3095
|
*/
|
|
2515
3096
|
loadNodeSigningKey(nodeId: string, loaderArgs: SigningKeyLoaderArgs): Promise<boolean>;
|
|
2516
3097
|
/**
|
|
2517
|
-
* Gets the signing key for a node. Must have previously called
|
|
3098
|
+
* Gets the signing key for a node. Must have previously called
|
|
3099
|
+
* [loadNodeSigningKey].
|
|
2518
3100
|
*
|
|
2519
3101
|
* @param nodeId The ID of the node the key is for
|
|
2520
3102
|
* @returns The signing key for the node
|
|
2521
3103
|
*/
|
|
2522
3104
|
getNodeSigningKey(nodeId: string): Promise<SigningKey | undefined>;
|
|
2523
3105
|
/**
|
|
2524
|
-
* Sets the auth provider for the client.
|
|
3106
|
+
* Sets the auth provider for the client.
|
|
3107
|
+
* This is useful for switching between auth providers if you are using
|
|
2525
3108
|
* multiple accounts or waiting for the user to log in.
|
|
2526
3109
|
*
|
|
2527
3110
|
* @param authProvider
|
|
@@ -2557,15 +3140,16 @@ declare class LightsparkClient {
|
|
|
2557
3140
|
*/
|
|
2558
3141
|
getRecentPaymentRequests(nodeId: string, numTransactions?: number, bitcoinNetwork?: BitcoinNetwork, afterDate?: Maybe<string>): Promise<Transaction[]>;
|
|
2559
3142
|
/**
|
|
2560
|
-
* Starts listening for new transactions or updates to existing transactions
|
|
3143
|
+
* Starts listening for new transactions or updates to existing transactions
|
|
3144
|
+
* for a list of nodes.
|
|
2561
3145
|
*
|
|
2562
3146
|
* @param nodeIds The node IDs for which to listen to transactions.
|
|
2563
3147
|
* @returns A zen-observable that emits transaction updates for the given node IDs.
|
|
2564
3148
|
*/
|
|
2565
3149
|
listenToTransactions(nodeIds: string[]): Observable<TransactionUpdate | undefined>;
|
|
2566
3150
|
/**
|
|
2567
|
-
* Retrieves a dashboard of basic info for the authenticated account.
|
|
2568
|
-
* included.
|
|
3151
|
+
* Retrieves a dashboard of basic info for the authenticated account.
|
|
3152
|
+
* See `AccountDashboard` for which info is included.
|
|
2569
3153
|
*
|
|
2570
3154
|
* @param nodeIds The node IDs to include in the dashboard. Defaults to undefined (all nodes).
|
|
2571
3155
|
* @param bitcoinNetwork The bitcoin network to include in the dashboard. Defaults to MAINNET.
|
|
@@ -2574,8 +3158,8 @@ declare class LightsparkClient {
|
|
|
2574
3158
|
*/
|
|
2575
3159
|
getAccountDashboard(nodeIds?: string[] | undefined, bitcoinNetwork?: BitcoinNetwork): Promise<AccountDashboard>;
|
|
2576
3160
|
/**
|
|
2577
|
-
* Gets a basic dashboard for a single node, including recent transactions.
|
|
2578
|
-
* included.
|
|
3161
|
+
* Gets a basic dashboard for a single node, including recent transactions.
|
|
3162
|
+
* See `SingleNodeDashboard` for which info is included.
|
|
2579
3163
|
*
|
|
2580
3164
|
* @param nodeId The node ID for which to get a dashboard.
|
|
2581
3165
|
* @param bitcoinNetwork The bitcoin network for which to get a dashboard. Defaults to MAINNET.
|
|
@@ -2587,7 +3171,8 @@ declare class LightsparkClient {
|
|
|
2587
3171
|
/**
|
|
2588
3172
|
* Creates an invoice for the given node.
|
|
2589
3173
|
*
|
|
2590
|
-
* Test mode note: You can simulate a payment of this invoice in test move
|
|
3174
|
+
* Test mode note: You can simulate a payment of this invoice in test move
|
|
3175
|
+
* using [createTestModePayment].
|
|
2591
3176
|
*
|
|
2592
3177
|
* @param nodeId The node ID for which to create an invoice.
|
|
2593
3178
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2600,11 +3185,13 @@ declare class LightsparkClient {
|
|
|
2600
3185
|
*/
|
|
2601
3186
|
createInvoice(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined): Promise<string | undefined>;
|
|
2602
3187
|
/**
|
|
2603
|
-
* Generates a Lightning Invoice (follows the Bolt 11 specification) to
|
|
2604
|
-
* from another Lightning Node.
|
|
3188
|
+
* Generates a Lightning Invoice (follows the Bolt 11 specification) to
|
|
3189
|
+
* request a payment from another Lightning Node.
|
|
3190
|
+
* This should only be used for generating invoices for LNURLs,
|
|
2605
3191
|
* with [createInvoice] preferred in the general case.
|
|
2606
3192
|
*
|
|
2607
|
-
* Test mode note: You can simulate a payment of this invoice in test move
|
|
3193
|
+
* Test mode note: You can simulate a payment of this invoice in test move
|
|
3194
|
+
* using [createTestModePayment].
|
|
2608
3195
|
*
|
|
2609
3196
|
* @param nodeId The node ID for which to create an invoice.
|
|
2610
3197
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2616,10 +3203,12 @@ declare class LightsparkClient {
|
|
|
2616
3203
|
*/
|
|
2617
3204
|
createLnurlInvoice(nodeId: string, amountMsats: number, metadata: string, expirySecs?: number | undefined): Promise<Invoice | undefined>;
|
|
2618
3205
|
/**
|
|
2619
|
-
* Creates a new invoice for the UMA protocol.
|
|
2620
|
-
*
|
|
2621
|
-
*
|
|
2622
|
-
*
|
|
3206
|
+
* Creates a new invoice for the UMA protocol.
|
|
3207
|
+
* The metadata is hashed and included in the invoice.
|
|
3208
|
+
* This API generates a Lightning Invoice (follows the Bolt 11 specification)
|
|
3209
|
+
* to request a payment from another Lightning Node.
|
|
3210
|
+
* This should only be used for generating invoices for UMA,
|
|
3211
|
+
* with `createInvoice` preferred in the general case.
|
|
2623
3212
|
*
|
|
2624
3213
|
* @param nodeId The node ID for which to create an invoice.
|
|
2625
3214
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2638,7 +3227,8 @@ declare class LightsparkClient {
|
|
|
2638
3227
|
*/
|
|
2639
3228
|
decodeInvoice(encodedInvoice: string): Promise<InvoiceData>;
|
|
2640
3229
|
/**
|
|
2641
|
-
* Gets an estimate of the fee for sending a payment over the given bitcoin
|
|
3230
|
+
* Gets an estimate of the fee for sending a payment over the given bitcoin
|
|
3231
|
+
* network.
|
|
2642
3232
|
*
|
|
2643
3233
|
* @param bitcoinNetwork The bitcoin network for which to get a fee estimate. Defaults to MAINNET.
|
|
2644
3234
|
* @returns A fee estimate for the given bitcoin network including a minimum fee rate, and a max-speed fee rate.
|
|
@@ -2655,7 +3245,8 @@ declare class LightsparkClient {
|
|
|
2655
3245
|
*/
|
|
2656
3246
|
getLightningFeeEstimateForInvoice(nodeId: string, encodedPaymentRequest: string, amountMsats?: number | undefined): Promise<CurrencyAmount>;
|
|
2657
3247
|
/**
|
|
2658
|
-
* Returns an estimate of the fees that will be paid to send a payment to
|
|
3248
|
+
* Returns an estimate of the fees that will be paid to send a payment to
|
|
3249
|
+
* another Lightning node.
|
|
2659
3250
|
*
|
|
2660
3251
|
* @param nodeId The node from where you want to send the payment.
|
|
2661
3252
|
* @param destinationNodePublicKey The public key of the node that you want to pay.
|
|
@@ -2673,70 +3264,86 @@ declare class LightsparkClient {
|
|
|
2673
3264
|
/**
|
|
2674
3265
|
* Sends a lightning payment for a given invoice.
|
|
2675
3266
|
*
|
|
2676
|
-
* Test mode note: For test mode, you can use the [createTestModeInvoice]
|
|
2677
|
-
* pay in test mode.
|
|
3267
|
+
* Test mode note: For test mode, you can use the [createTestModeInvoice]
|
|
3268
|
+
* function to create an invoice you can pay in test mode.
|
|
2678
3269
|
*
|
|
2679
3270
|
* @param payerNodeId The ID of the node that will pay the invoice.
|
|
2680
3271
|
* @param encodedInvoice The encoded invoice to pay.
|
|
2681
3272
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2682
|
-
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2683
|
-
*
|
|
3273
|
+
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
3274
|
+
* transactions succeed. For example,
|
|
3275
|
+
* for a transaction between 10k sats and 100k sats,
|
|
3276
|
+
* this would mean a fee limit of 16 to 160 sats.
|
|
2684
3277
|
* @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
|
|
2685
3278
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
2686
|
-
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3279
|
+
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3280
|
+
* invoice. Otherwise, the call will fail.
|
|
2687
3281
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2688
3282
|
*/
|
|
2689
3283
|
payInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
2690
3284
|
/**
|
|
2691
|
-
* sends an UMA payment to a node on the Lightning Network,
|
|
2692
|
-
* (as defined by the BOLT11 specification) that you
|
|
2693
|
-
*
|
|
3285
|
+
* sends an UMA payment to a node on the Lightning Network,
|
|
3286
|
+
* based on the invoice (as defined by the BOLT11 specification) that you
|
|
3287
|
+
* provide.
|
|
3288
|
+
* This should only be used for paying UMA invoices,
|
|
3289
|
+
* with `payInvoice` preferred in the general case.
|
|
2694
3290
|
*
|
|
2695
3291
|
* @param payerNodeId The ID of the node that will pay the invoice.
|
|
2696
3292
|
* @param encodedInvoice The encoded invoice to pay.
|
|
2697
3293
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2698
|
-
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2699
|
-
*
|
|
3294
|
+
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
3295
|
+
* transactions succeed. For example,
|
|
3296
|
+
* for a transaction between 10k sats and 100k sats,
|
|
3297
|
+
* this would mean a fee limit of 16 to 160 sats.
|
|
2700
3298
|
* @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
|
|
2701
3299
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
2702
|
-
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3300
|
+
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3301
|
+
* invoice. Otherwise, the call will fail.
|
|
2703
3302
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2704
3303
|
*/
|
|
2705
3304
|
payUmaInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
2706
3305
|
/**
|
|
2707
|
-
* Waits for a transaction to have a completed status, and returns the
|
|
3306
|
+
* Waits for a transaction to have a completed status, and returns the
|
|
3307
|
+
* transaction.
|
|
2708
3308
|
*
|
|
2709
3309
|
* @param transactionId The ID of the transaction to wait for
|
|
2710
3310
|
* @param pollTimeoutSecs The timeout in seconds that we will wait before throwing an exception
|
|
2711
3311
|
*/
|
|
2712
3312
|
waitForTransactionComplete<T = Transaction>(transactionId: string, pollTimeoutSecs?: number): Promise<T>;
|
|
2713
3313
|
/**
|
|
2714
|
-
* Sends a payment directly to a node on the Lightning Network through the
|
|
3314
|
+
* Sends a payment directly to a node on the Lightning Network through the
|
|
3315
|
+
* public key of the node without an invoice.
|
|
2715
3316
|
*
|
|
2716
3317
|
* @param payerNodeId The ID of the node that will send the payment.
|
|
2717
3318
|
* @param destinationPublicKey The public key of the destination node.
|
|
2718
3319
|
* @param timeoutSecs The timeout in seconds that we will try to make the payment.
|
|
2719
3320
|
* @param amountMsats The amount to pay in msats.
|
|
2720
3321
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2721
|
-
* As guidance, a maximum fee of 15 basis points should make almost all
|
|
2722
|
-
*
|
|
3322
|
+
* As guidance, a maximum fee of 15 basis points should make almost all
|
|
3323
|
+
* transactions succeed. For example,
|
|
3324
|
+
* for a transaction between 10k sats and 100k sats,
|
|
3325
|
+
* this would mean a fee limit of 15 to 150 sats.
|
|
2723
3326
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2724
3327
|
*/
|
|
2725
3328
|
sendPayment(payerNodeId: string, destinationPublicKey: string, timeoutSecs: number | undefined, amountMsats: number, maximumFeesMsats: number): Promise<OutgoingPayment | undefined>;
|
|
2726
3329
|
/**
|
|
2727
|
-
* Creates an L1 Bitcoin wallet address for a given node which can be used to
|
|
3330
|
+
* Creates an L1 Bitcoin wallet address for a given node which can be used to
|
|
3331
|
+
* deposit or withdraw funds.
|
|
2728
3332
|
*
|
|
2729
3333
|
* @param nodeId The ID of the node to create a wallet address for.
|
|
2730
3334
|
* @returns A string containing the wallet address for the given node.
|
|
2731
3335
|
*/
|
|
2732
3336
|
createNodeWalletAddress(nodeId: string): Promise<string>;
|
|
2733
3337
|
/**
|
|
2734
|
-
* Withdraws funds from the account and sends it to the requested bitcoin
|
|
3338
|
+
* Withdraws funds from the account and sends it to the requested bitcoin
|
|
3339
|
+
* address.
|
|
2735
3340
|
*
|
|
2736
|
-
* Depending on the chosen mode, it will first take the funds from the
|
|
2737
|
-
*
|
|
2738
|
-
*
|
|
2739
|
-
*
|
|
3341
|
+
* Depending on the chosen mode, it will first take the funds from the
|
|
3342
|
+
* wallet, and if applicable, close channels appropriately to recover enough
|
|
3343
|
+
* funds and reopen channels with the remaining funds.
|
|
3344
|
+
* The process is asynchronous and may take up to a few minutes.
|
|
3345
|
+
* You can check the progress by polling the `WithdrawalRequest` that is
|
|
3346
|
+
* created, or by subscribing to a webhook.
|
|
2740
3347
|
*
|
|
2741
3348
|
* @param nodeId The ID of the node from which to withdraw funds.
|
|
2742
3349
|
* @param amountSats The amount of funds to withdraw in satoshis.
|
|
@@ -2745,9 +3352,10 @@ declare class LightsparkClient {
|
|
|
2745
3352
|
*/
|
|
2746
3353
|
requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode): Promise<WithdrawalRequest>;
|
|
2747
3354
|
/**
|
|
2748
|
-
* Adds funds to a Lightspark node on the REGTEST network.
|
|
2749
|
-
*
|
|
2750
|
-
*
|
|
3355
|
+
* Adds funds to a Lightspark node on the REGTEST network.
|
|
3356
|
+
* If the amount is not specified, 10,000,000 SATOSHI will be added.
|
|
3357
|
+
* This API only functions for nodes created on the REGTEST network and will
|
|
3358
|
+
* return an error when called for any non-REGTEST node.
|
|
2751
3359
|
*
|
|
2752
3360
|
* @param nodeId The ID of the node to fund. Must be a REGTEST node.
|
|
2753
3361
|
* @param amountSats The amount of funds to add to the node in satoshis. Defaults to 10,000,000 SATOSHI.
|
|
@@ -2755,8 +3363,8 @@ declare class LightsparkClient {
|
|
|
2755
3363
|
*/
|
|
2756
3364
|
fundNode(nodeId: string, amountSats?: number | undefined): Promise<CurrencyAmount>;
|
|
2757
3365
|
/**
|
|
2758
|
-
* Creates a new API token that can be used to authenticate requests for this
|
|
2759
|
-
* and SDKs.
|
|
3366
|
+
* Creates a new API token that can be used to authenticate requests for this
|
|
3367
|
+
* account when using the Lightspark APIs and SDKs.
|
|
2760
3368
|
*
|
|
2761
3369
|
* @param name Creates a new API token that can be used to authenticate requests for this account when using the
|
|
2762
3370
|
* Lightspark APIs and SDKs.
|
|
@@ -2772,8 +3380,9 @@ declare class LightsparkClient {
|
|
|
2772
3380
|
*/
|
|
2773
3381
|
deleteApiToken(id: string): Promise<void>;
|
|
2774
3382
|
/**
|
|
2775
|
-
* In test mode, generates a Lightning Invoice which can be paid by a local
|
|
2776
|
-
* This call is only valid in test mode.
|
|
3383
|
+
* In test mode, generates a Lightning Invoice which can be paid by a local
|
|
3384
|
+
* node. This call is only valid in test mode.
|
|
3385
|
+
* You can then pay the invoice using [payInvoice].
|
|
2777
3386
|
*
|
|
2778
3387
|
* @param localNodeId The ID of the node that will pay the invoice.
|
|
2779
3388
|
* @param amountMsats The amount to pay in milli-satoshis.
|
|
@@ -2782,8 +3391,9 @@ declare class LightsparkClient {
|
|
|
2782
3391
|
*/
|
|
2783
3392
|
createTestModeInvoice(localNodeId: string, amountMsats: number, memo?: string | undefined, invoiceType?: InvoiceType): Promise<string | null>;
|
|
2784
3393
|
/**
|
|
2785
|
-
* In test mode, simulates a payment of a Lightning Invoice from another
|
|
2786
|
-
* This can only be used in test mode and should be used with invoices
|
|
3394
|
+
* In test mode, simulates a payment of a Lightning Invoice from another
|
|
3395
|
+
* node. This can only be used in test mode and should be used with invoices
|
|
3396
|
+
* generated by [createInvoice].
|
|
2787
3397
|
*
|
|
2788
3398
|
* @param localNodeId The ID of the node that will receive the payment.
|
|
2789
3399
|
* @param encodedInvoice The encoded invoice to pay.
|
|
@@ -2792,8 +3402,8 @@ declare class LightsparkClient {
|
|
|
2792
3402
|
*/
|
|
2793
3403
|
createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<IncomingPayment | null>;
|
|
2794
3404
|
/**
|
|
2795
|
-
* Creates an UMA invitation. If you are part of the incentive program,
|
|
2796
|
-
* [createUmaInvitationWithIncentives].
|
|
3405
|
+
* Creates an UMA invitation. If you are part of the incentive program,
|
|
3406
|
+
* you should use [createUmaInvitationWithIncentives].
|
|
2797
3407
|
*
|
|
2798
3408
|
* @param inviterUma The UMA of the inviter.
|
|
2799
3409
|
* @returns The invitation that was created.
|
|
@@ -2808,8 +3418,8 @@ declare class LightsparkClient {
|
|
|
2808
3418
|
*/
|
|
2809
3419
|
createUmaInvitationWithIncentives(inviterUma: string, inviterPhoneNumber: string, inviterRegion: RegionCode): Promise<UmaInvitation | null>;
|
|
2810
3420
|
/**
|
|
2811
|
-
* Claims an UMA invitation. If you are part of the incentive program,
|
|
2812
|
-
* [claimUmaInvitationWithIncentives].
|
|
3421
|
+
* Claims an UMA invitation. If you are part of the incentive program,
|
|
3422
|
+
* you should use [claimUmaInvitationWithIncentives].
|
|
2813
3423
|
*
|
|
2814
3424
|
* @param invitationCode The invitation code to claim.
|
|
2815
3425
|
* @param inviteeUma The UMA of the invitee.
|
|
@@ -2837,7 +3447,8 @@ declare class LightsparkClient {
|
|
|
2837
3447
|
/**
|
|
2838
3448
|
* Executes a raw `Query` against the Lightspark API.
|
|
2839
3449
|
*
|
|
2840
|
-
* This generally should not be used directly,
|
|
3450
|
+
* This generally should not be used directly,
|
|
3451
|
+
* but is exposed for advanced use cases and for internal use to retrieve
|
|
2841
3452
|
* complex fields from objects.
|
|
2842
3453
|
*
|
|
2843
3454
|
* @param query The `Query` to execute.
|
|
@@ -2869,8 +3480,9 @@ interface ClaimUmaInvitationWithIncentivesOutput {
|
|
|
2869
3480
|
/** This is an enum identifying a type of compliance provider. **/
|
|
2870
3481
|
declare enum ComplianceProvider {
|
|
2871
3482
|
/**
|
|
2872
|
-
* This is an enum value that represents values that could be added in the
|
|
2873
|
-
* Clients should support unknown values as more of them could be
|
|
3483
|
+
* This is an enum value that represents values that could be added in the
|
|
3484
|
+
* future. Clients should support unknown values as more of them could be
|
|
3485
|
+
* added without notice.
|
|
2874
3486
|
*/
|
|
2875
3487
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2876
3488
|
CHAINALYSIS = "CHAINALYSIS"
|
|
@@ -2878,18 +3490,25 @@ declare enum ComplianceProvider {
|
|
|
2878
3490
|
|
|
2879
3491
|
interface Connection {
|
|
2880
3492
|
/**
|
|
2881
|
-
* The total count of objects in this connection, using the current filters.
|
|
2882
|
-
* number of objects returned in the current page
|
|
3493
|
+
* The total count of objects in this connection, using the current filters.
|
|
3494
|
+
* It is different from the number of objects returned in the current page
|
|
3495
|
+
* (in the `entities` field).
|
|
2883
3496
|
**/
|
|
2884
3497
|
count: number;
|
|
2885
|
-
/**
|
|
3498
|
+
/**
|
|
3499
|
+
* An object that holds pagination information about the objects in this
|
|
3500
|
+
* connection. *
|
|
3501
|
+
*/
|
|
2886
3502
|
pageInfo: PageInfo;
|
|
2887
3503
|
/** The typename of the object **/
|
|
2888
3504
|
typename: string;
|
|
2889
3505
|
}
|
|
2890
3506
|
|
|
2891
3507
|
interface CreateApiTokenInput {
|
|
2892
|
-
/**
|
|
3508
|
+
/**
|
|
3509
|
+
* An arbitrary name that the user can choose to identify the API token in a
|
|
3510
|
+
* list. *
|
|
3511
|
+
*/
|
|
2893
3512
|
name: string;
|
|
2894
3513
|
/** List of permissions to grant to the API token **/
|
|
2895
3514
|
permissions: Permission[];
|
|
@@ -2926,8 +3545,9 @@ interface CreateLnurlInvoiceInput {
|
|
|
2926
3545
|
/** The amount for which the invoice should be created, in millisatoshis. **/
|
|
2927
3546
|
amountMsats: number;
|
|
2928
3547
|
/**
|
|
2929
|
-
* The SHA256 hash of the LNURL metadata payload.
|
|
2930
|
-
*
|
|
3548
|
+
* The SHA256 hash of the LNURL metadata payload.
|
|
3549
|
+
* This will be present in the h-tag (SHA256 purpose of payment) of the
|
|
3550
|
+
* resulting Bolt 11 invoice.
|
|
2931
3551
|
**/
|
|
2932
3552
|
metadataHash: string;
|
|
2933
3553
|
/** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
|
|
@@ -2960,13 +3580,17 @@ interface CreateTestModePaymentInput {
|
|
|
2960
3580
|
/** The invoice you want to be paid (as defined by the BOLT11 standard). **/
|
|
2961
3581
|
encodedInvoice: string;
|
|
2962
3582
|
/**
|
|
2963
|
-
* The amount you will be paid for this invoice, expressed in msats.
|
|
2964
|
-
* invoice amount is zero.
|
|
3583
|
+
* The amount you will be paid for this invoice, expressed in msats.
|
|
3584
|
+
* It should ONLY be set when the invoice amount is zero.
|
|
2965
3585
|
**/
|
|
2966
3586
|
amountMsats?: number | undefined;
|
|
2967
3587
|
}
|
|
2968
3588
|
|
|
2969
|
-
/**
|
|
3589
|
+
/**
|
|
3590
|
+
* This is an object identifying the output of a test mode payment.
|
|
3591
|
+
* This object can be used to retrieve the associated payment made from a Test
|
|
3592
|
+
* Mode Payment call. *
|
|
3593
|
+
*/
|
|
2970
3594
|
interface CreateTestModePaymentoutput {
|
|
2971
3595
|
/**
|
|
2972
3596
|
* The payment that has been sent.
|
|
@@ -3000,8 +3624,9 @@ interface DeclineToSignMessagesInput {
|
|
|
3000
3624
|
|
|
3001
3625
|
declare enum SignablePayloadStatus {
|
|
3002
3626
|
/**
|
|
3003
|
-
* This is an enum value that represents values that could be added in the
|
|
3004
|
-
* Clients should support unknown values as more of them could be
|
|
3627
|
+
* This is an enum value that represents values that could be added in the
|
|
3628
|
+
* future. Clients should support unknown values as more of them could be
|
|
3629
|
+
* added without notice.
|
|
3005
3630
|
*/
|
|
3006
3631
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3007
3632
|
CREATED = "CREATED",
|
|
@@ -3012,8 +3637,8 @@ declare enum SignablePayloadStatus {
|
|
|
3012
3637
|
|
|
3013
3638
|
interface SignablePayload {
|
|
3014
3639
|
/**
|
|
3015
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3016
|
-
* string.
|
|
3640
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3641
|
+
* Should be treated as an opaque string.
|
|
3017
3642
|
**/
|
|
3018
3643
|
id: string;
|
|
3019
3644
|
/** The date and time when the entity was first created. **/
|
|
@@ -3022,7 +3647,10 @@ interface SignablePayload {
|
|
|
3022
3647
|
updatedAt: string;
|
|
3023
3648
|
/** The payload that needs to be signed. **/
|
|
3024
3649
|
payload: string;
|
|
3025
|
-
/**
|
|
3650
|
+
/**
|
|
3651
|
+
* The consistent method for generating the same set of accounts and wallets
|
|
3652
|
+
* for a given private key *
|
|
3653
|
+
*/
|
|
3026
3654
|
derivationPath: string;
|
|
3027
3655
|
/** The status of the payload. **/
|
|
3028
3656
|
status: SignablePayloadStatus;
|
|
@@ -3049,11 +3677,16 @@ interface DeleteApiTokenOutput {
|
|
|
3049
3677
|
accountId: string;
|
|
3050
3678
|
}
|
|
3051
3679
|
|
|
3052
|
-
/**
|
|
3680
|
+
/**
|
|
3681
|
+
* This object represents a Deposit made to a Lightspark node wallet.
|
|
3682
|
+
* This operation occurs for any L1 funding transaction to the wallet.
|
|
3683
|
+
* You can retrieve this object to receive detailed information about the
|
|
3684
|
+
* deposit. *
|
|
3685
|
+
*/
|
|
3053
3686
|
interface Deposit {
|
|
3054
3687
|
/**
|
|
3055
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3056
|
-
* string.
|
|
3688
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3689
|
+
* Should be treated as an opaque string.
|
|
3057
3690
|
**/
|
|
3058
3691
|
id: string;
|
|
3059
3692
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3065,8 +3698,8 @@ interface Deposit {
|
|
|
3065
3698
|
/** The amount of money involved in this transaction. **/
|
|
3066
3699
|
amount: CurrencyAmount;
|
|
3067
3700
|
/**
|
|
3068
|
-
* The height of the block that included this transaction.
|
|
3069
|
-
* transactions.
|
|
3701
|
+
* The height of the block that included this transaction.
|
|
3702
|
+
* This will be zero for unconfirmed transactions.
|
|
3070
3703
|
**/
|
|
3071
3704
|
blockHeight: number;
|
|
3072
3705
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -3077,19 +3710,25 @@ interface Deposit {
|
|
|
3077
3710
|
typename: string;
|
|
3078
3711
|
/** The date and time when this transaction was completed or failed. **/
|
|
3079
3712
|
resolvedAt?: string | undefined;
|
|
3080
|
-
/**
|
|
3713
|
+
/**
|
|
3714
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
3715
|
+
* Lightning Network. *
|
|
3716
|
+
*/
|
|
3081
3717
|
transactionHash?: string | undefined;
|
|
3082
3718
|
/**
|
|
3083
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
3084
|
-
* blockchain.
|
|
3719
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
3720
|
+
* to the Bitcoin blockchain.
|
|
3085
3721
|
**/
|
|
3086
3722
|
fees?: CurrencyAmount | undefined;
|
|
3087
3723
|
/**
|
|
3088
|
-
* The hash of the block that included this transaction.
|
|
3089
|
-
* transactions.
|
|
3724
|
+
* The hash of the block that included this transaction.
|
|
3725
|
+
* This will be null for unconfirmed transactions.
|
|
3090
3726
|
**/
|
|
3091
3727
|
blockHash?: string | undefined;
|
|
3092
|
-
/**
|
|
3728
|
+
/**
|
|
3729
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
3730
|
+
* *
|
|
3731
|
+
*/
|
|
3093
3732
|
numConfirmations?: number | undefined;
|
|
3094
3733
|
}
|
|
3095
3734
|
declare const getDepositQuery: (id: string) => Query<Deposit>;
|
|
@@ -3103,11 +3742,17 @@ interface FundNodeOutput {
|
|
|
3103
3742
|
amount: CurrencyAmount;
|
|
3104
3743
|
}
|
|
3105
3744
|
|
|
3106
|
-
/**
|
|
3745
|
+
/**
|
|
3746
|
+
* This object represents a node that exists on the Lightning Network,
|
|
3747
|
+
* including nodes not managed by Lightspark.
|
|
3748
|
+
* You can retrieve this object to get publicly available information about any
|
|
3749
|
+
* node on the Lightning Network.
|
|
3750
|
+
* *
|
|
3751
|
+
*/
|
|
3107
3752
|
declare class GraphNode implements Node, Entity {
|
|
3108
3753
|
/**
|
|
3109
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3110
|
-
* string.
|
|
3754
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3755
|
+
* Should be treated as an opaque string.
|
|
3111
3756
|
**/
|
|
3112
3757
|
readonly id: string;
|
|
3113
3758
|
/** The date and time when the entity was first created. **/
|
|
@@ -3117,36 +3762,46 @@ declare class GraphNode implements Node, Entity {
|
|
|
3117
3762
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3118
3763
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3119
3764
|
/**
|
|
3120
|
-
* The name of this node in the network.
|
|
3121
|
-
*
|
|
3765
|
+
* The name of this node in the network.
|
|
3766
|
+
* It will be the most human-readable option possible,
|
|
3767
|
+
* depending on the data available for this node.
|
|
3122
3768
|
**/
|
|
3123
3769
|
readonly displayName: string;
|
|
3124
3770
|
/** The typename of the object **/
|
|
3125
3771
|
readonly typename: string;
|
|
3126
3772
|
/**
|
|
3127
|
-
* A name that identifies the node.
|
|
3128
|
-
*
|
|
3129
|
-
*
|
|
3773
|
+
* A name that identifies the node.
|
|
3774
|
+
* It has no importance in terms of operating the node,
|
|
3775
|
+
* it is just a way to identify and search for commercial services or
|
|
3776
|
+
* popular nodes. This alias can be changed at any time by the node
|
|
3777
|
+
* operator.
|
|
3130
3778
|
**/
|
|
3131
3779
|
readonly alias?: string | undefined;
|
|
3132
3780
|
/**
|
|
3133
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3134
|
-
* has no importance in terms of operating
|
|
3781
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3782
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating
|
|
3783
|
+
* the node,
|
|
3784
|
+
* it is just a way to visually differentiate nodes.
|
|
3135
3785
|
* That color can be changed at any time by the node operator.
|
|
3136
3786
|
**/
|
|
3137
3787
|
readonly color?: string | undefined;
|
|
3138
3788
|
/**
|
|
3139
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
3140
|
-
*
|
|
3141
|
-
*
|
|
3789
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
3790
|
+
* receive, or route transactions efficiently.
|
|
3791
|
+
* Maximizing a node's conductivity helps a node’s transactions to be
|
|
3792
|
+
* capital efficient. The value is an integer ranging between 0 and 10
|
|
3793
|
+
* (bounds included).
|
|
3142
3794
|
**/
|
|
3143
3795
|
readonly conductivity?: number | undefined;
|
|
3144
|
-
/**
|
|
3796
|
+
/**
|
|
3797
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
3798
|
+
* in the Lightning Network. *
|
|
3799
|
+
*/
|
|
3145
3800
|
readonly publicKey?: string | undefined;
|
|
3146
3801
|
constructor(
|
|
3147
3802
|
/**
|
|
3148
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3149
|
-
* string.
|
|
3803
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3804
|
+
* Should be treated as an opaque string.
|
|
3150
3805
|
**/
|
|
3151
3806
|
id: string,
|
|
3152
3807
|
/** The date and time when the entity was first created. **/
|
|
@@ -3156,31 +3811,41 @@ declare class GraphNode implements Node, Entity {
|
|
|
3156
3811
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3157
3812
|
bitcoinNetwork: BitcoinNetwork,
|
|
3158
3813
|
/**
|
|
3159
|
-
* The name of this node in the network.
|
|
3160
|
-
*
|
|
3814
|
+
* The name of this node in the network.
|
|
3815
|
+
* It will be the most human-readable option possible,
|
|
3816
|
+
* depending on the data available for this node.
|
|
3161
3817
|
**/
|
|
3162
3818
|
displayName: string,
|
|
3163
3819
|
/** The typename of the object **/
|
|
3164
3820
|
typename: string,
|
|
3165
3821
|
/**
|
|
3166
|
-
* A name that identifies the node.
|
|
3167
|
-
*
|
|
3168
|
-
*
|
|
3822
|
+
* A name that identifies the node.
|
|
3823
|
+
* It has no importance in terms of operating the node,
|
|
3824
|
+
* it is just a way to identify and search for commercial services or
|
|
3825
|
+
* popular nodes. This alias can be changed at any time by the node
|
|
3826
|
+
* operator.
|
|
3169
3827
|
**/
|
|
3170
3828
|
alias?: string | undefined,
|
|
3171
3829
|
/**
|
|
3172
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3173
|
-
* has no importance in terms of operating
|
|
3830
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3831
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating
|
|
3832
|
+
* the node,
|
|
3833
|
+
* it is just a way to visually differentiate nodes.
|
|
3174
3834
|
* That color can be changed at any time by the node operator.
|
|
3175
3835
|
**/
|
|
3176
3836
|
color?: string | undefined,
|
|
3177
3837
|
/**
|
|
3178
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
3179
|
-
*
|
|
3180
|
-
*
|
|
3838
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
3839
|
+
* receive, or route transactions efficiently.
|
|
3840
|
+
* Maximizing a node's conductivity helps a node’s transactions to be
|
|
3841
|
+
* capital efficient. The value is an integer ranging between 0 and 10
|
|
3842
|
+
* (bounds included).
|
|
3181
3843
|
**/
|
|
3182
3844
|
conductivity?: number | undefined,
|
|
3183
|
-
/**
|
|
3845
|
+
/**
|
|
3846
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
3847
|
+
* in the Lightning Network. *
|
|
3848
|
+
*/
|
|
3184
3849
|
publicKey?: string | undefined);
|
|
3185
3850
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
3186
3851
|
static getGraphNodeQuery(id: string): Query<GraphNode>;
|
|
@@ -3211,8 +3876,8 @@ interface LightningFeeEstimateForInvoiceInput {
|
|
|
3211
3876
|
/** The invoice you want to pay (as defined by the BOLT11 standard). **/
|
|
3212
3877
|
encodedPaymentRequest: string;
|
|
3213
3878
|
/**
|
|
3214
|
-
* If the invoice does not specify a payment amount,
|
|
3215
|
-
* in msats.
|
|
3879
|
+
* If the invoice does not specify a payment amount,
|
|
3880
|
+
* then the amount that you wish to pay, expressed in msats.
|
|
3216
3881
|
**/
|
|
3217
3882
|
amountMsats?: number | undefined;
|
|
3218
3883
|
}
|
|
@@ -3239,8 +3904,8 @@ interface Secret {
|
|
|
3239
3904
|
/** This is a Lightspark node with OSK. **/
|
|
3240
3905
|
declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
3241
3906
|
/**
|
|
3242
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3243
|
-
* string.
|
|
3907
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3908
|
+
* Should be treated as an opaque string.
|
|
3244
3909
|
**/
|
|
3245
3910
|
readonly id: string;
|
|
3246
3911
|
/** The date and time when the entity was first created. **/
|
|
@@ -3250,43 +3915,54 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3250
3915
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3251
3916
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3252
3917
|
/**
|
|
3253
|
-
* The name of this node in the network.
|
|
3254
|
-
*
|
|
3918
|
+
* The name of this node in the network.
|
|
3919
|
+
* It will be the most human-readable option possible,
|
|
3920
|
+
* depending on the data available for this node.
|
|
3255
3921
|
**/
|
|
3256
3922
|
readonly displayName: string;
|
|
3257
3923
|
/** The owner of this LightsparkNode. **/
|
|
3258
3924
|
readonly ownerId: string;
|
|
3259
3925
|
/**
|
|
3260
|
-
* The utxos of the channels that are connected to this node.
|
|
3261
|
-
* pre-screening.
|
|
3926
|
+
* The utxos of the channels that are connected to this node.
|
|
3927
|
+
* This is used in uma flow for pre-screening.
|
|
3262
3928
|
**/
|
|
3263
3929
|
readonly umaPrescreeningUtxos: string[];
|
|
3264
3930
|
/** The typename of the object **/
|
|
3265
3931
|
readonly typename: string;
|
|
3266
3932
|
/**
|
|
3267
|
-
* A name that identifies the node.
|
|
3268
|
-
*
|
|
3269
|
-
*
|
|
3933
|
+
* A name that identifies the node.
|
|
3934
|
+
* It has no importance in terms of operating the node,
|
|
3935
|
+
* it is just a way to identify and search for commercial services or
|
|
3936
|
+
* popular nodes. This alias can be changed at any time by the node
|
|
3937
|
+
* operator.
|
|
3270
3938
|
**/
|
|
3271
3939
|
readonly alias?: string | undefined;
|
|
3272
3940
|
/**
|
|
3273
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3274
|
-
* has no importance in terms of operating
|
|
3941
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3942
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating
|
|
3943
|
+
* the node,
|
|
3944
|
+
* it is just a way to visually differentiate nodes.
|
|
3275
3945
|
* That color can be changed at any time by the node operator.
|
|
3276
3946
|
**/
|
|
3277
3947
|
readonly color?: string | undefined;
|
|
3278
3948
|
/**
|
|
3279
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
3280
|
-
*
|
|
3281
|
-
*
|
|
3949
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
3950
|
+
* receive, or route transactions efficiently.
|
|
3951
|
+
* Maximizing a node's conductivity helps a node’s transactions to be
|
|
3952
|
+
* capital efficient. The value is an integer ranging between 0 and 10
|
|
3953
|
+
* (bounds included).
|
|
3282
3954
|
**/
|
|
3283
3955
|
readonly conductivity?: number | undefined;
|
|
3284
|
-
/**
|
|
3956
|
+
/**
|
|
3957
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
3958
|
+
* in the Lightning Network. *
|
|
3959
|
+
*/
|
|
3285
3960
|
readonly publicKey?: string | undefined;
|
|
3286
3961
|
/** The current status of this node. **/
|
|
3287
3962
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
3288
3963
|
/**
|
|
3289
|
-
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
3964
|
+
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
3965
|
+
* and commit fees on this node.
|
|
3290
3966
|
*
|
|
3291
3967
|
* @deprecated Use `balances` instead.
|
|
3292
3968
|
**/
|
|
@@ -3298,13 +3974,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3298
3974
|
**/
|
|
3299
3975
|
readonly totalLocalBalance?: CurrencyAmount | undefined;
|
|
3300
3976
|
/**
|
|
3301
|
-
* The sum of the channel balances (online only) that are available to send
|
|
3977
|
+
* The sum of the channel balances (online only) that are available to send
|
|
3978
|
+
* on this node.
|
|
3302
3979
|
*
|
|
3303
3980
|
* @deprecated Use `balances` instead.
|
|
3304
3981
|
**/
|
|
3305
3982
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
3306
3983
|
/**
|
|
3307
|
-
* The sum of the channel balances that are available to receive on this
|
|
3984
|
+
* The sum of the channel balances that are available to receive on this
|
|
3985
|
+
* node.
|
|
3308
3986
|
*
|
|
3309
3987
|
* @deprecated Use `balances` instead.
|
|
3310
3988
|
**/
|
|
@@ -3317,12 +3995,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3317
3995
|
readonly blockchainBalance?: BlockchainBalance | undefined;
|
|
3318
3996
|
/** The balances that describe the funds in this node. **/
|
|
3319
3997
|
readonly balances?: Balances | undefined;
|
|
3320
|
-
/**
|
|
3998
|
+
/**
|
|
3999
|
+
* The private key client is using to sign a GraphQL request which will be
|
|
4000
|
+
* verified at server side. *
|
|
4001
|
+
*/
|
|
3321
4002
|
readonly encryptedSigningPrivateKey?: Secret | undefined;
|
|
3322
4003
|
constructor(
|
|
3323
4004
|
/**
|
|
3324
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3325
|
-
* string.
|
|
4005
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4006
|
+
* Should be treated as an opaque string.
|
|
3326
4007
|
**/
|
|
3327
4008
|
id: string,
|
|
3328
4009
|
/** The date and time when the entity was first created. **/
|
|
@@ -3332,43 +4013,54 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3332
4013
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3333
4014
|
bitcoinNetwork: BitcoinNetwork,
|
|
3334
4015
|
/**
|
|
3335
|
-
* The name of this node in the network.
|
|
3336
|
-
*
|
|
4016
|
+
* The name of this node in the network.
|
|
4017
|
+
* It will be the most human-readable option possible,
|
|
4018
|
+
* depending on the data available for this node.
|
|
3337
4019
|
**/
|
|
3338
4020
|
displayName: string,
|
|
3339
4021
|
/** The owner of this LightsparkNode. **/
|
|
3340
4022
|
ownerId: string,
|
|
3341
4023
|
/**
|
|
3342
|
-
* The utxos of the channels that are connected to this node.
|
|
3343
|
-
* pre-screening.
|
|
4024
|
+
* The utxos of the channels that are connected to this node.
|
|
4025
|
+
* This is used in uma flow for pre-screening.
|
|
3344
4026
|
**/
|
|
3345
4027
|
umaPrescreeningUtxos: string[],
|
|
3346
4028
|
/** The typename of the object **/
|
|
3347
4029
|
typename: string,
|
|
3348
4030
|
/**
|
|
3349
|
-
* A name that identifies the node.
|
|
3350
|
-
*
|
|
3351
|
-
*
|
|
4031
|
+
* A name that identifies the node.
|
|
4032
|
+
* It has no importance in terms of operating the node,
|
|
4033
|
+
* it is just a way to identify and search for commercial services or
|
|
4034
|
+
* popular nodes. This alias can be changed at any time by the node
|
|
4035
|
+
* operator.
|
|
3352
4036
|
**/
|
|
3353
4037
|
alias?: string | undefined,
|
|
3354
4038
|
/**
|
|
3355
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3356
|
-
* has no importance in terms of operating
|
|
4039
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
4040
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating
|
|
4041
|
+
* the node,
|
|
4042
|
+
* it is just a way to visually differentiate nodes.
|
|
3357
4043
|
* That color can be changed at any time by the node operator.
|
|
3358
4044
|
**/
|
|
3359
4045
|
color?: string | undefined,
|
|
3360
4046
|
/**
|
|
3361
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
3362
|
-
*
|
|
3363
|
-
*
|
|
4047
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
4048
|
+
* receive, or route transactions efficiently.
|
|
4049
|
+
* Maximizing a node's conductivity helps a node’s transactions to be
|
|
4050
|
+
* capital efficient. The value is an integer ranging between 0 and 10
|
|
4051
|
+
* (bounds included).
|
|
3364
4052
|
**/
|
|
3365
4053
|
conductivity?: number | undefined,
|
|
3366
|
-
/**
|
|
4054
|
+
/**
|
|
4055
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
4056
|
+
* in the Lightning Network. *
|
|
4057
|
+
*/
|
|
3367
4058
|
publicKey?: string | undefined,
|
|
3368
4059
|
/** The current status of this node. **/
|
|
3369
4060
|
status?: LightsparkNodeStatus | undefined,
|
|
3370
4061
|
/**
|
|
3371
|
-
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
4062
|
+
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
4063
|
+
* and commit fees on this node.
|
|
3372
4064
|
*
|
|
3373
4065
|
* @deprecated Use `balances` instead.
|
|
3374
4066
|
**/
|
|
@@ -3380,13 +4072,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3380
4072
|
**/
|
|
3381
4073
|
totalLocalBalance?: CurrencyAmount | undefined,
|
|
3382
4074
|
/**
|
|
3383
|
-
* The sum of the channel balances (online only) that are available to send
|
|
4075
|
+
* The sum of the channel balances (online only) that are available to send
|
|
4076
|
+
* on this node.
|
|
3384
4077
|
*
|
|
3385
4078
|
* @deprecated Use `balances` instead.
|
|
3386
4079
|
**/
|
|
3387
4080
|
localBalance?: CurrencyAmount | undefined,
|
|
3388
4081
|
/**
|
|
3389
|
-
* The sum of the channel balances that are available to receive on this
|
|
4082
|
+
* The sum of the channel balances that are available to receive on this
|
|
4083
|
+
* node.
|
|
3390
4084
|
*
|
|
3391
4085
|
* @deprecated Use `balances` instead.
|
|
3392
4086
|
**/
|
|
@@ -3399,7 +4093,10 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3399
4093
|
blockchainBalance?: BlockchainBalance | undefined,
|
|
3400
4094
|
/** The balances that describe the funds in this node. **/
|
|
3401
4095
|
balances?: Balances | undefined,
|
|
3402
|
-
/**
|
|
4096
|
+
/**
|
|
4097
|
+
* The private key client is using to sign a GraphQL request which will be
|
|
4098
|
+
* verified at server side. *
|
|
4099
|
+
*/
|
|
3403
4100
|
encryptedSigningPrivateKey?: Secret | undefined);
|
|
3404
4101
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
3405
4102
|
getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
@@ -3433,8 +4130,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3433
4130
|
/** This is a Lightspark node with remote signing. **/
|
|
3434
4131
|
declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
|
|
3435
4132
|
/**
|
|
3436
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3437
|
-
* string.
|
|
4133
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4134
|
+
* Should be treated as an opaque string.
|
|
3438
4135
|
**/
|
|
3439
4136
|
readonly id: string;
|
|
3440
4137
|
/** The date and time when the entity was first created. **/
|
|
@@ -3444,43 +4141,54 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3444
4141
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3445
4142
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
3446
4143
|
/**
|
|
3447
|
-
* The name of this node in the network.
|
|
3448
|
-
*
|
|
4144
|
+
* The name of this node in the network.
|
|
4145
|
+
* It will be the most human-readable option possible,
|
|
4146
|
+
* depending on the data available for this node.
|
|
3449
4147
|
**/
|
|
3450
4148
|
readonly displayName: string;
|
|
3451
4149
|
/** The owner of this LightsparkNode. **/
|
|
3452
4150
|
readonly ownerId: string;
|
|
3453
4151
|
/**
|
|
3454
|
-
* The utxos of the channels that are connected to this node.
|
|
3455
|
-
* pre-screening.
|
|
4152
|
+
* The utxos of the channels that are connected to this node.
|
|
4153
|
+
* This is used in uma flow for pre-screening.
|
|
3456
4154
|
**/
|
|
3457
4155
|
readonly umaPrescreeningUtxos: string[];
|
|
3458
4156
|
/** The typename of the object **/
|
|
3459
4157
|
readonly typename: string;
|
|
3460
4158
|
/**
|
|
3461
|
-
* A name that identifies the node.
|
|
3462
|
-
*
|
|
3463
|
-
*
|
|
4159
|
+
* A name that identifies the node.
|
|
4160
|
+
* It has no importance in terms of operating the node,
|
|
4161
|
+
* it is just a way to identify and search for commercial services or
|
|
4162
|
+
* popular nodes. This alias can be changed at any time by the node
|
|
4163
|
+
* operator.
|
|
3464
4164
|
**/
|
|
3465
4165
|
readonly alias?: string | undefined;
|
|
3466
4166
|
/**
|
|
3467
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3468
|
-
* has no importance in terms of operating
|
|
4167
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
4168
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating
|
|
4169
|
+
* the node,
|
|
4170
|
+
* it is just a way to visually differentiate nodes.
|
|
3469
4171
|
* That color can be changed at any time by the node operator.
|
|
3470
4172
|
**/
|
|
3471
4173
|
readonly color?: string | undefined;
|
|
3472
4174
|
/**
|
|
3473
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
3474
|
-
*
|
|
3475
|
-
*
|
|
4175
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
4176
|
+
* receive, or route transactions efficiently.
|
|
4177
|
+
* Maximizing a node's conductivity helps a node’s transactions to be
|
|
4178
|
+
* capital efficient. The value is an integer ranging between 0 and 10
|
|
4179
|
+
* (bounds included).
|
|
3476
4180
|
**/
|
|
3477
4181
|
readonly conductivity?: number | undefined;
|
|
3478
|
-
/**
|
|
4182
|
+
/**
|
|
4183
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
4184
|
+
* in the Lightning Network. *
|
|
4185
|
+
*/
|
|
3479
4186
|
readonly publicKey?: string | undefined;
|
|
3480
4187
|
/** The current status of this node. **/
|
|
3481
4188
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
3482
4189
|
/**
|
|
3483
|
-
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
4190
|
+
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
4191
|
+
* and commit fees on this node.
|
|
3484
4192
|
*
|
|
3485
4193
|
* @deprecated Use `balances` instead.
|
|
3486
4194
|
**/
|
|
@@ -3492,13 +4200,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3492
4200
|
**/
|
|
3493
4201
|
readonly totalLocalBalance?: CurrencyAmount | undefined;
|
|
3494
4202
|
/**
|
|
3495
|
-
* The sum of the channel balances (online only) that are available to send
|
|
4203
|
+
* The sum of the channel balances (online only) that are available to send
|
|
4204
|
+
* on this node.
|
|
3496
4205
|
*
|
|
3497
4206
|
* @deprecated Use `balances` instead.
|
|
3498
4207
|
**/
|
|
3499
4208
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
3500
4209
|
/**
|
|
3501
|
-
* The sum of the channel balances that are available to receive on this
|
|
4210
|
+
* The sum of the channel balances that are available to receive on this
|
|
4211
|
+
* node.
|
|
3502
4212
|
*
|
|
3503
4213
|
* @deprecated Use `balances` instead.
|
|
3504
4214
|
**/
|
|
@@ -3513,8 +4223,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3513
4223
|
readonly balances?: Balances | undefined;
|
|
3514
4224
|
constructor(
|
|
3515
4225
|
/**
|
|
3516
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3517
|
-
* string.
|
|
4226
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4227
|
+
* Should be treated as an opaque string.
|
|
3518
4228
|
**/
|
|
3519
4229
|
id: string,
|
|
3520
4230
|
/** The date and time when the entity was first created. **/
|
|
@@ -3524,43 +4234,54 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3524
4234
|
/** The Bitcoin Network this node is deployed in. **/
|
|
3525
4235
|
bitcoinNetwork: BitcoinNetwork,
|
|
3526
4236
|
/**
|
|
3527
|
-
* The name of this node in the network.
|
|
3528
|
-
*
|
|
4237
|
+
* The name of this node in the network.
|
|
4238
|
+
* It will be the most human-readable option possible,
|
|
4239
|
+
* depending on the data available for this node.
|
|
3529
4240
|
**/
|
|
3530
4241
|
displayName: string,
|
|
3531
4242
|
/** The owner of this LightsparkNode. **/
|
|
3532
4243
|
ownerId: string,
|
|
3533
4244
|
/**
|
|
3534
|
-
* The utxos of the channels that are connected to this node.
|
|
3535
|
-
* pre-screening.
|
|
4245
|
+
* The utxos of the channels that are connected to this node.
|
|
4246
|
+
* This is used in uma flow for pre-screening.
|
|
3536
4247
|
**/
|
|
3537
4248
|
umaPrescreeningUtxos: string[],
|
|
3538
4249
|
/** The typename of the object **/
|
|
3539
4250
|
typename: string,
|
|
3540
4251
|
/**
|
|
3541
|
-
* A name that identifies the node.
|
|
3542
|
-
*
|
|
3543
|
-
*
|
|
4252
|
+
* A name that identifies the node.
|
|
4253
|
+
* It has no importance in terms of operating the node,
|
|
4254
|
+
* it is just a way to identify and search for commercial services or
|
|
4255
|
+
* popular nodes. This alias can be changed at any time by the node
|
|
4256
|
+
* operator.
|
|
3544
4257
|
**/
|
|
3545
4258
|
alias?: string | undefined,
|
|
3546
4259
|
/**
|
|
3547
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
3548
|
-
* has no importance in terms of operating
|
|
4260
|
+
* A hexadecimal string that describes a color. For example "#000000" is
|
|
4261
|
+
* black, "#FFFFFF" is white. It has no importance in terms of operating
|
|
4262
|
+
* the node,
|
|
4263
|
+
* it is just a way to visually differentiate nodes.
|
|
3549
4264
|
* That color can be changed at any time by the node operator.
|
|
3550
4265
|
**/
|
|
3551
4266
|
color?: string | undefined,
|
|
3552
4267
|
/**
|
|
3553
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
3554
|
-
*
|
|
3555
|
-
*
|
|
4268
|
+
* A summary metric used to capture how well positioned a node is to send,
|
|
4269
|
+
* receive, or route transactions efficiently.
|
|
4270
|
+
* Maximizing a node's conductivity helps a node’s transactions to be
|
|
4271
|
+
* capital efficient. The value is an integer ranging between 0 and 10
|
|
4272
|
+
* (bounds included).
|
|
3556
4273
|
**/
|
|
3557
4274
|
conductivity?: number | undefined,
|
|
3558
|
-
/**
|
|
4275
|
+
/**
|
|
4276
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
4277
|
+
* in the Lightning Network. *
|
|
4278
|
+
*/
|
|
3559
4279
|
publicKey?: string | undefined,
|
|
3560
4280
|
/** The current status of this node. **/
|
|
3561
4281
|
status?: LightsparkNodeStatus | undefined,
|
|
3562
4282
|
/**
|
|
3563
|
-
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
4283
|
+
* The sum of the balance on the Bitcoin Network, channel balances,
|
|
4284
|
+
* and commit fees on this node.
|
|
3564
4285
|
*
|
|
3565
4286
|
* @deprecated Use `balances` instead.
|
|
3566
4287
|
**/
|
|
@@ -3572,13 +4293,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3572
4293
|
**/
|
|
3573
4294
|
totalLocalBalance?: CurrencyAmount | undefined,
|
|
3574
4295
|
/**
|
|
3575
|
-
* The sum of the channel balances (online only) that are available to send
|
|
4296
|
+
* The sum of the channel balances (online only) that are available to send
|
|
4297
|
+
* on this node.
|
|
3576
4298
|
*
|
|
3577
4299
|
* @deprecated Use `balances` instead.
|
|
3578
4300
|
**/
|
|
3579
4301
|
localBalance?: CurrencyAmount | undefined,
|
|
3580
4302
|
/**
|
|
3581
|
-
* The sum of the channel balances that are available to receive on this
|
|
4303
|
+
* The sum of the channel balances that are available to receive on this
|
|
4304
|
+
* node.
|
|
3582
4305
|
*
|
|
3583
4306
|
* @deprecated Use `balances` instead.
|
|
3584
4307
|
**/
|
|
@@ -3619,11 +4342,17 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
3619
4342
|
};
|
|
3620
4343
|
}
|
|
3621
4344
|
|
|
3622
|
-
/**
|
|
4345
|
+
/**
|
|
4346
|
+
* This object represents an L1 transaction that occurred on the Bitcoin
|
|
4347
|
+
* Network. You can retrieve this object to receive information about a
|
|
4348
|
+
* specific on-chain transaction made on the Lightning Network associated with
|
|
4349
|
+
* your Lightspark Node.
|
|
4350
|
+
* *
|
|
4351
|
+
*/
|
|
3623
4352
|
interface OnChainTransaction {
|
|
3624
4353
|
/**
|
|
3625
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3626
|
-
* string.
|
|
4354
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4355
|
+
* Should be treated as an opaque string.
|
|
3627
4356
|
**/
|
|
3628
4357
|
id: string;
|
|
3629
4358
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3635,8 +4364,8 @@ interface OnChainTransaction {
|
|
|
3635
4364
|
/** The amount of money involved in this transaction. **/
|
|
3636
4365
|
amount: CurrencyAmount;
|
|
3637
4366
|
/**
|
|
3638
|
-
* The height of the block that included this transaction.
|
|
3639
|
-
* transactions.
|
|
4367
|
+
* The height of the block that included this transaction.
|
|
4368
|
+
* This will be zero for unconfirmed transactions.
|
|
3640
4369
|
**/
|
|
3641
4370
|
blockHeight: number;
|
|
3642
4371
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -3645,19 +4374,25 @@ interface OnChainTransaction {
|
|
|
3645
4374
|
typename: string;
|
|
3646
4375
|
/** The date and time when this transaction was completed or failed. **/
|
|
3647
4376
|
resolvedAt?: string | undefined;
|
|
3648
|
-
/**
|
|
4377
|
+
/**
|
|
4378
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
4379
|
+
* Lightning Network. *
|
|
4380
|
+
*/
|
|
3649
4381
|
transactionHash?: string | undefined;
|
|
3650
4382
|
/**
|
|
3651
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
3652
|
-
* blockchain.
|
|
4383
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
4384
|
+
* to the Bitcoin blockchain.
|
|
3653
4385
|
**/
|
|
3654
4386
|
fees?: CurrencyAmount | undefined;
|
|
3655
4387
|
/**
|
|
3656
|
-
* The hash of the block that included this transaction.
|
|
3657
|
-
* transactions.
|
|
4388
|
+
* The hash of the block that included this transaction.
|
|
4389
|
+
* This will be null for unconfirmed transactions.
|
|
3658
4390
|
**/
|
|
3659
4391
|
blockHash?: string | undefined;
|
|
3660
|
-
/**
|
|
4392
|
+
/**
|
|
4393
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
4394
|
+
* *
|
|
4395
|
+
*/
|
|
3661
4396
|
numConfirmations?: number | undefined;
|
|
3662
4397
|
}
|
|
3663
4398
|
declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
|
|
@@ -3680,11 +4415,14 @@ interface PayInvoiceInput {
|
|
|
3680
4415
|
encodedInvoice: string;
|
|
3681
4416
|
/** The timeout in seconds that we will try to make the payment. **/
|
|
3682
4417
|
timeoutSecs: number;
|
|
3683
|
-
/**
|
|
4418
|
+
/**
|
|
4419
|
+
* The maximum amount of fees that you want to pay for this payment to be
|
|
4420
|
+
* sent, expressed in msats. *
|
|
4421
|
+
*/
|
|
3684
4422
|
maximumFeesMsats: number;
|
|
3685
4423
|
/**
|
|
3686
|
-
* The amount you will pay for this invoice, expressed in msats.
|
|
3687
|
-
* invoice amount is zero.
|
|
4424
|
+
* The amount you will pay for this invoice, expressed in msats.
|
|
4425
|
+
* It should ONLY be set when the invoice amount is zero.
|
|
3688
4426
|
**/
|
|
3689
4427
|
amountMsats?: number | undefined;
|
|
3690
4428
|
}
|
|
@@ -3694,43 +4432,49 @@ interface PayInvoiceOutput {
|
|
|
3694
4432
|
paymentId: string;
|
|
3695
4433
|
}
|
|
3696
4434
|
|
|
4435
|
+
interface PayUmaInvoiceInput {
|
|
4436
|
+
nodeId: string;
|
|
4437
|
+
encodedInvoice: string;
|
|
4438
|
+
timeoutSecs: number;
|
|
4439
|
+
maximumFeesMsats: number;
|
|
4440
|
+
amountMsats?: number | undefined;
|
|
4441
|
+
}
|
|
4442
|
+
|
|
3697
4443
|
/** This is an enum indicating the direction of the payment. **/
|
|
3698
4444
|
declare enum PaymentDirection {
|
|
3699
4445
|
/**
|
|
3700
|
-
* This is an enum value that represents values that could be added in the
|
|
3701
|
-
* Clients should support unknown values as more of them could be
|
|
4446
|
+
* This is an enum value that represents values that could be added in the
|
|
4447
|
+
* future. Clients should support unknown values as more of them could be
|
|
4448
|
+
* added without notice.
|
|
3702
4449
|
*/
|
|
3703
4450
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3704
4451
|
SENT = "SENT",
|
|
3705
4452
|
RECEIVED = "RECEIVED"
|
|
3706
4453
|
}
|
|
3707
4454
|
|
|
3708
|
-
interface PayUmaInvoiceInput {
|
|
3709
|
-
nodeId: string;
|
|
3710
|
-
encodedInvoice: string;
|
|
3711
|
-
timeoutSecs: number;
|
|
3712
|
-
maximumFeesMsats: number;
|
|
3713
|
-
amountMsats?: number | undefined;
|
|
3714
|
-
}
|
|
3715
|
-
|
|
3716
4455
|
interface RegisterPaymentInput {
|
|
3717
4456
|
/**
|
|
3718
|
-
* The compliance provider that is going to screen the node.
|
|
3719
|
-
*
|
|
4457
|
+
* The compliance provider that is going to screen the node.
|
|
4458
|
+
* You need to be a customer of the selected provider and store the API key
|
|
4459
|
+
* on the Lightspark account setting page.
|
|
3720
4460
|
**/
|
|
3721
4461
|
provider: ComplianceProvider;
|
|
3722
4462
|
/**
|
|
3723
|
-
* The Lightspark ID of the lightning payment you want to register.
|
|
3724
|
-
* OutgoingPayment or an IncomingPayment.
|
|
4463
|
+
* The Lightspark ID of the lightning payment you want to register.
|
|
4464
|
+
* It can be the id of either an OutgoingPayment or an IncomingPayment.
|
|
3725
4465
|
**/
|
|
3726
4466
|
paymentId: string;
|
|
3727
4467
|
/**
|
|
3728
|
-
* The public key of the counterparty lightning node,
|
|
3729
|
-
*
|
|
4468
|
+
* The public key of the counterparty lightning node,
|
|
4469
|
+
* which would be the public key of the recipient node if it is to register
|
|
4470
|
+
* an outgoing payment, or the public key of the sender node if it is to
|
|
3730
4471
|
* register an incoming payment.
|
|
3731
4472
|
**/
|
|
3732
4473
|
nodePubkey: string;
|
|
3733
|
-
/**
|
|
4474
|
+
/**
|
|
4475
|
+
* Indicates whether this payment is an OutgoingPayment or an
|
|
4476
|
+
* IncomingPayment. *
|
|
4477
|
+
*/
|
|
3734
4478
|
direction: PaymentDirection;
|
|
3735
4479
|
}
|
|
3736
4480
|
|
|
@@ -3764,11 +4508,15 @@ interface ReleasePaymentPreimageOutput {
|
|
|
3764
4508
|
invoiceId: string;
|
|
3765
4509
|
}
|
|
3766
4510
|
|
|
3767
|
-
/**
|
|
4511
|
+
/**
|
|
4512
|
+
* This is an enum of the potential sub-event types for Remote Signing webook
|
|
4513
|
+
* events. *
|
|
4514
|
+
*/
|
|
3768
4515
|
declare enum RemoteSigningSubEventType {
|
|
3769
4516
|
/**
|
|
3770
|
-
* This is an enum value that represents values that could be added in the
|
|
3771
|
-
* Clients should support unknown values as more of them could be
|
|
4517
|
+
* This is an enum value that represents values that could be added in the
|
|
4518
|
+
* future. Clients should support unknown values as more of them could be
|
|
4519
|
+
* added without notice.
|
|
3772
4520
|
*/
|
|
3773
4521
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3774
4522
|
ECDH = "ECDH",
|
|
@@ -3787,8 +4535,8 @@ interface RequestWithdrawalInput {
|
|
|
3787
4535
|
/** The bitcoin address where the withdrawal should be sent. **/
|
|
3788
4536
|
bitcoinAddress: string;
|
|
3789
4537
|
/**
|
|
3790
|
-
* The amount you want to withdraw from this node in Satoshis.
|
|
3791
|
-
* all funds from this node.
|
|
4538
|
+
* The amount you want to withdraw from this node in Satoshis.
|
|
4539
|
+
* Use the special value -1 to withdrawal all funds from this node.
|
|
3792
4540
|
**/
|
|
3793
4541
|
amountSats: number;
|
|
3794
4542
|
/** The strategy that should be used to withdraw the funds from this node. **/
|
|
@@ -3800,11 +4548,16 @@ interface RequestWithdrawalOutput {
|
|
|
3800
4548
|
requestId: string;
|
|
3801
4549
|
}
|
|
3802
4550
|
|
|
3803
|
-
/**
|
|
4551
|
+
/**
|
|
4552
|
+
* This is an enum of the potential risk ratings related to a transaction made
|
|
4553
|
+
* over the Lightning Network. These risk ratings are returned from the
|
|
4554
|
+
* CryptoSanctionScreeningProvider. *
|
|
4555
|
+
*/
|
|
3804
4556
|
declare enum RiskRating {
|
|
3805
4557
|
/**
|
|
3806
|
-
* This is an enum value that represents values that could be added in the
|
|
3807
|
-
* Clients should support unknown values as more of them could be
|
|
4558
|
+
* This is an enum value that represents values that could be added in the
|
|
4559
|
+
* future. Clients should support unknown values as more of them could be
|
|
4560
|
+
* added without notice.
|
|
3808
4561
|
*/
|
|
3809
4562
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3810
4563
|
HIGH_RISK = "HIGH_RISK",
|
|
@@ -3812,11 +4565,17 @@ declare enum RiskRating {
|
|
|
3812
4565
|
UNKNOWN = "UNKNOWN"
|
|
3813
4566
|
}
|
|
3814
4567
|
|
|
3815
|
-
/**
|
|
4568
|
+
/**
|
|
4569
|
+
* This object represents a transaction that was forwarded through a Lightspark
|
|
4570
|
+
* node on the Lightning Network, i.e., a routed transaction.
|
|
4571
|
+
* You can retrieve this object to receive information about any transaction
|
|
4572
|
+
* routed through your Lightspark Node.
|
|
4573
|
+
* *
|
|
4574
|
+
*/
|
|
3816
4575
|
interface RoutingTransaction {
|
|
3817
4576
|
/**
|
|
3818
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3819
|
-
* string.
|
|
4577
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4578
|
+
* Should be treated as an opaque string.
|
|
3820
4579
|
**/
|
|
3821
4580
|
id: string;
|
|
3822
4581
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3831,18 +4590,25 @@ interface RoutingTransaction {
|
|
|
3831
4590
|
typename: string;
|
|
3832
4591
|
/** The date and time when this transaction was completed or failed. **/
|
|
3833
4592
|
resolvedAt?: string | undefined;
|
|
3834
|
-
/**
|
|
4593
|
+
/**
|
|
4594
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
4595
|
+
* Lightning Network. *
|
|
4596
|
+
*/
|
|
3835
4597
|
transactionHash?: string | undefined;
|
|
3836
4598
|
/** If known, the channel this transaction was received from. **/
|
|
3837
4599
|
incomingChannelId?: string | undefined;
|
|
3838
4600
|
/** If known, the channel this transaction was forwarded to. **/
|
|
3839
4601
|
outgoingChannelId?: string | undefined;
|
|
3840
4602
|
/**
|
|
3841
|
-
* The fees collected by the node when routing this transaction.
|
|
3842
|
-
* the
|
|
4603
|
+
* The fees collected by the node when routing this transaction.
|
|
4604
|
+
* We subtract the outgoing amount to the incoming amount to determine how
|
|
4605
|
+
* much fees were collected.
|
|
3843
4606
|
**/
|
|
3844
4607
|
fees?: CurrencyAmount | undefined;
|
|
3845
|
-
/**
|
|
4608
|
+
/**
|
|
4609
|
+
* If applicable, user-facing error message describing why the routing
|
|
4610
|
+
* failed. *
|
|
4611
|
+
*/
|
|
3846
4612
|
failureMessage?: RichText | undefined;
|
|
3847
4613
|
/** If applicable, the reason why the routing failed. **/
|
|
3848
4614
|
failureReason?: RoutingTransactionFailureReason | undefined;
|
|
@@ -3851,8 +4617,9 @@ declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransacti
|
|
|
3851
4617
|
|
|
3852
4618
|
interface ScreenNodeInput {
|
|
3853
4619
|
/**
|
|
3854
|
-
* The compliance provider that is going to screen the node.
|
|
3855
|
-
*
|
|
4620
|
+
* The compliance provider that is going to screen the node.
|
|
4621
|
+
* You need to be a customer of the selected provider and store the API key
|
|
4622
|
+
* on the Lightspark account setting page.
|
|
3856
4623
|
**/
|
|
3857
4624
|
provider: ComplianceProvider;
|
|
3858
4625
|
/** The public key of the lightning node that needs to be screened. **/
|
|
@@ -3872,7 +4639,10 @@ interface SendPaymentInput {
|
|
|
3872
4639
|
timeoutSecs: number;
|
|
3873
4640
|
/** The amount you will send to the destination node, expressed in msats. **/
|
|
3874
4641
|
amountMsats: number;
|
|
3875
|
-
/**
|
|
4642
|
+
/**
|
|
4643
|
+
* The maximum amount of fees that you want to pay for this payment to be
|
|
4644
|
+
* sent, expressed in msats. *
|
|
4645
|
+
*/
|
|
3876
4646
|
maximumFeesMsats: number;
|
|
3877
4647
|
}
|
|
3878
4648
|
|
|
@@ -3887,8 +4657,9 @@ interface SetInvoicePaymentHashInput {
|
|
|
3887
4657
|
/** The 32-byte hash of the payment preimage. **/
|
|
3888
4658
|
paymentHash: string;
|
|
3889
4659
|
/**
|
|
3890
|
-
* The 32-byte nonce used to generate the invoice preimage if applicable.
|
|
3891
|
-
* RELEASE_PAYMENT_PREIMAGE webhook to help
|
|
4660
|
+
* The 32-byte nonce used to generate the invoice preimage if applicable.
|
|
4661
|
+
* It will later be included in RELEASE_PAYMENT_PREIMAGE webhook to help
|
|
4662
|
+
* recover the raw preimage.
|
|
3892
4663
|
**/
|
|
3893
4664
|
preimageNonce?: string | undefined;
|
|
3894
4665
|
}
|
|
@@ -3897,21 +4668,6 @@ interface SetInvoicePaymentHashOutput {
|
|
|
3897
4668
|
invoiceId: string;
|
|
3898
4669
|
}
|
|
3899
4670
|
|
|
3900
|
-
interface Signable {
|
|
3901
|
-
/**
|
|
3902
|
-
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3903
|
-
* string.
|
|
3904
|
-
**/
|
|
3905
|
-
id: string;
|
|
3906
|
-
/** The date and time when the entity was first created. **/
|
|
3907
|
-
createdAt: string;
|
|
3908
|
-
/** The date and time when the entity was last updated. **/
|
|
3909
|
-
updatedAt: string;
|
|
3910
|
-
/** The typename of the object **/
|
|
3911
|
-
typename: string;
|
|
3912
|
-
}
|
|
3913
|
-
declare const getSignableQuery: (id: string) => Query<Signable>;
|
|
3914
|
-
|
|
3915
4671
|
interface SignInvoiceInput {
|
|
3916
4672
|
/** The unique identifier of the invoice to be signed. **/
|
|
3917
4673
|
invoiceId: string;
|
|
@@ -3936,6 +4692,21 @@ interface SignMessagesOutput {
|
|
|
3936
4692
|
signedPayloads: SignablePayload[];
|
|
3937
4693
|
}
|
|
3938
4694
|
|
|
4695
|
+
interface Signable {
|
|
4696
|
+
/**
|
|
4697
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4698
|
+
* Should be treated as an opaque string.
|
|
4699
|
+
**/
|
|
4700
|
+
id: string;
|
|
4701
|
+
/** The date and time when the entity was first created. **/
|
|
4702
|
+
createdAt: string;
|
|
4703
|
+
/** The date and time when the entity was last updated. **/
|
|
4704
|
+
updatedAt: string;
|
|
4705
|
+
/** The typename of the object **/
|
|
4706
|
+
typename: string;
|
|
4707
|
+
}
|
|
4708
|
+
declare const getSignableQuery: (id: string) => Query<Signable>;
|
|
4709
|
+
|
|
3939
4710
|
interface UpdateChannelPerCommitmentPointInput {
|
|
3940
4711
|
channelId: string;
|
|
3941
4712
|
perCommitmentPoint: string;
|
|
@@ -3955,11 +4726,15 @@ interface UpdateNodeSharedSecretOutput {
|
|
|
3955
4726
|
nodeId: string;
|
|
3956
4727
|
}
|
|
3957
4728
|
|
|
3958
|
-
/**
|
|
4729
|
+
/**
|
|
4730
|
+
* This is an enum of the potential event types that can be associated with
|
|
4731
|
+
* your Lightspark wallets. *
|
|
4732
|
+
*/
|
|
3959
4733
|
declare enum WebhookEventType {
|
|
3960
4734
|
/**
|
|
3961
|
-
* This is an enum value that represents values that could be added in the
|
|
3962
|
-
* Clients should support unknown values as more of them could be
|
|
4735
|
+
* This is an enum value that represents values that could be added in the
|
|
4736
|
+
* future. Clients should support unknown values as more of them could be
|
|
4737
|
+
* added without notice.
|
|
3963
4738
|
*/
|
|
3964
4739
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3965
4740
|
PAYMENT_FINISHED = "PAYMENT_FINISHED",
|
|
@@ -3977,11 +4752,16 @@ declare enum WebhookEventType {
|
|
|
3977
4752
|
LOW_BALANCE = "LOW_BALANCE"
|
|
3978
4753
|
}
|
|
3979
4754
|
|
|
3980
|
-
/**
|
|
4755
|
+
/**
|
|
4756
|
+
* This object represents an L1 withdrawal from your Lightspark Node to any
|
|
4757
|
+
* Bitcoin wallet. You can retrieve this object to receive detailed information
|
|
4758
|
+
* about any L1 withdrawal associated with your Lightspark Node or account.
|
|
4759
|
+
* *
|
|
4760
|
+
*/
|
|
3981
4761
|
interface Withdrawal {
|
|
3982
4762
|
/**
|
|
3983
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3984
|
-
* string.
|
|
4763
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4764
|
+
* Should be treated as an opaque string.
|
|
3985
4765
|
**/
|
|
3986
4766
|
id: string;
|
|
3987
4767
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3993,8 +4773,8 @@ interface Withdrawal {
|
|
|
3993
4773
|
/** The amount of money involved in this transaction. **/
|
|
3994
4774
|
amount: CurrencyAmount;
|
|
3995
4775
|
/**
|
|
3996
|
-
* The height of the block that included this transaction.
|
|
3997
|
-
* transactions.
|
|
4776
|
+
* The height of the block that included this transaction.
|
|
4777
|
+
* This will be zero for unconfirmed transactions.
|
|
3998
4778
|
**/
|
|
3999
4779
|
blockHeight: number;
|
|
4000
4780
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -4005,21 +4785,27 @@ interface Withdrawal {
|
|
|
4005
4785
|
typename: string;
|
|
4006
4786
|
/** The date and time when this transaction was completed or failed. **/
|
|
4007
4787
|
resolvedAt?: string | undefined;
|
|
4008
|
-
/**
|
|
4788
|
+
/**
|
|
4789
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
4790
|
+
* Lightning Network. *
|
|
4791
|
+
*/
|
|
4009
4792
|
transactionHash?: string | undefined;
|
|
4010
4793
|
/**
|
|
4011
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
4012
|
-
* blockchain.
|
|
4794
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
4795
|
+
* to the Bitcoin blockchain.
|
|
4013
4796
|
**/
|
|
4014
4797
|
fees?: CurrencyAmount | undefined;
|
|
4015
4798
|
/**
|
|
4016
|
-
* The hash of the block that included this transaction.
|
|
4017
|
-
* transactions.
|
|
4799
|
+
* The hash of the block that included this transaction.
|
|
4800
|
+
* This will be null for unconfirmed transactions.
|
|
4018
4801
|
**/
|
|
4019
4802
|
blockHash?: string | undefined;
|
|
4020
|
-
/**
|
|
4803
|
+
/**
|
|
4804
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
4805
|
+
* *
|
|
4806
|
+
*/
|
|
4021
4807
|
numConfirmations?: number | undefined;
|
|
4022
4808
|
}
|
|
4023
4809
|
declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
|
|
4024
4810
|
|
|
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,
|
|
4811
|
+
export { FeeEstimate as $, Account as A, Balances as B, Channel as C, CreateInvitationWithIncentivesOutput as D, CreateInvoiceInput as E, CreateInvoiceOutput as F, CreateLnurlInvoiceInput as G, CreateNodeWalletAddressInput as H, CreateNodeWalletAddressOutput as I, CreateTestModeInvoiceInput as J, CreateTestModeInvoiceOutput as K, LightsparkClient as L, CreateTestModePaymentInput as M, CreateTestModePaymentoutput as N, CreateUmaInvitationInput as O, CreateUmaInvitationOutput as P, CreateUmaInvoiceInput as Q, CurrencyAmount as R, CurrencyUnit as S, DeclineToSignMessagesInput as T, DeclineToSignMessagesOutput as U, DeleteApiTokenInput as V, WebhookEventType as W, DeleteApiTokenOutput as X, Deposit as Y, getDepositQuery as Z, Entity as _, AccountToApiTokensConnection as a, ReleasePaymentPreimageOutput as a$, FundNodeInput as a0, FundNodeOutput as a1, GraphNode as a2, Hop as a3, getHopQuery as a4, HtlcAttemptFailureCode as a5, IdAndSignature as a6, IncentivesIneligibilityReason as a7, IncentivesStatus as a8, IncomingPayment as a9, OnChainTransaction as aA, getOnChainTransactionQuery as aB, OutgoingPayment as aC, OutgoingPaymentAttempt as aD, OutgoingPaymentAttemptStatus as aE, OutgoingPaymentAttemptToHopsConnection as aF, OutgoingPaymentToAttemptsConnection as aG, OutgoingPaymentsForInvoiceQueryInput as aH, OutgoingPaymentsForInvoiceQueryOutput as aI, PageInfo as aJ, PayInvoiceInput as aK, PayInvoiceOutput as aL, PayUmaInvoiceInput as aM, PaymentDirection as aN, PaymentFailureReason as aO, PaymentRequest as aP, getPaymentRequestQuery as aQ, PaymentRequestData as aR, PaymentRequestStatus as aS, Permission as aT, PostTransactionData as aU, RegionCode as aV, RegisterPaymentInput as aW, RegisterPaymentOutput as aX, ReleaseChannelPerCommitmentSecretInput as aY, ReleaseChannelPerCommitmentSecretOutput as aZ, ReleasePaymentPreimageInput as a_, IncomingPaymentAttempt as aa, getIncomingPaymentAttemptQuery as ab, IncomingPaymentAttemptStatus as ac, IncomingPaymentToAttemptsConnection as ad, Invoice as ae, getInvoiceQuery as af, InvoiceData as ag, InvoiceType as ah, LightningFeeEstimateForInvoiceInput as ai, LightningFeeEstimateForNodeInput as aj, LightningFeeEstimateOutput as ak, LightningTransaction as al, getLightningTransactionQuery as am, LightsparkNode as an, getLightsparkNodeQuery as ao, LightsparkNodeOwner as ap, getLightsparkNodeOwnerQuery as aq, LightsparkNodeStatus as ar, LightsparkNodeToChannelsConnection as as, LightsparkNodeWithOSK as at, LightsparkNodeWithRemoteSigning as au, Node as av, getNodeQuery as aw, NodeAddress as ax, NodeAddressType as ay, NodeToAddressesConnection as az, AccountToChannelsConnection as b, RemoteSigningSubEventType as b0, RequestWithdrawalInput as b1, RequestWithdrawalOutput as b2, RichText as b3, RiskRating as b4, RoutingTransaction as b5, getRoutingTransactionQuery as b6, RoutingTransactionFailureReason as b7, ScreenNodeInput as b8, ScreenNodeOutput as b9, UpdateNodeSharedSecretOutput as bA, Wallet as bB, WalletStatus as bC, WalletToPaymentRequestsConnection as bD, WalletToTransactionsConnection as bE, Withdrawal as bF, getWithdrawalQuery as bG, WithdrawalMode as bH, WithdrawalRequest as bI, WithdrawalRequestStatus as bJ, WithdrawalRequestToChannelClosingTransactionsConnection as bK, WithdrawalRequestToChannelOpeningTransactionsConnection as bL, Secret as ba, SendPaymentInput as bb, SendPaymentOutput as bc, SetInvoicePaymentHashInput as bd, SetInvoicePaymentHashOutput as be, SignInvoiceInput as bf, SignInvoiceOutput as bg, SignMessagesInput as bh, SignMessagesOutput as bi, Signable as bj, getSignableQuery as bk, SignablePayload as bl, getSignablePayloadQuery as bm, SignablePayloadStatus as bn, SingleNodeDashboard as bo, Transaction as bp, getTransactionQuery as bq, TransactionFailures as br, TransactionStatus as bs, TransactionType as bt, TransactionUpdate as bu, UmaInvitation as bv, getUmaInvitationQuery as bw, UpdateChannelPerCommitmentPointInput as bx, UpdateChannelPerCommitmentPointOutput as by, UpdateNodeSharedSecretInput as bz, AccountToNodesConnection as c, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, ApiToken as g, getApiTokenQuery as h, BlockchainBalance as i, ChannelClosingTransaction as j, getChannelClosingTransactionQuery as k, ChannelFees as l, ChannelOpeningTransaction as m, getChannelOpeningTransactionQuery as n, ChannelSnapshot as o, ChannelStatus as p, ChannelToTransactionsConnection as q, ClaimUmaInvitationInput as r, ClaimUmaInvitationOutput as s, ClaimUmaInvitationWithIncentivesInput as t, ClaimUmaInvitationWithIncentivesOutput as u, ComplianceProvider as v, Connection as w, CreateApiTokenInput as x, CreateApiTokenOutput as y, CreateInvitationWithIncentivesInput as z };
|