@lightsparkdev/lightspark-sdk 1.2.1 → 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 +14 -0
- package/dist/{BitcoinNetwork-a816c0be.d.ts → BitcoinNetwork-37e9f091.d.ts} +8 -3
- package/dist/{chunk-VTPDR6P4.js → chunk-NCPWHRFO.js} +353 -15
- package/dist/env.d.cts +1 -1
- package/dist/env.d.ts +1 -1
- package/dist/{index-5acc6526.d.ts → index-449c9f58.d.ts} +2089 -644
- package/dist/index.cjs +1082 -470
- package/dist/index.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/dist/index.js +584 -302
- package/dist/objects/index.cjs +345 -5
- package/dist/objects/index.d.cts +2 -2
- package/dist/objects/index.d.ts +2 -2
- package/dist/objects/index.js +9 -1
- package/package.json +4 -4
- package/src/NodeKeyLoaderCache.ts +4 -3
- package/src/SigningKeyLoader.ts +12 -7
- package/src/client.ts +287 -60
- package/src/env.ts +3 -1
- package/src/graphql/ClaimUmaInvitation.ts +21 -0
- package/src/graphql/ClaimUmaInvitationWithIncentives.ts +25 -0
- package/src/graphql/CreateUmaInvitation.ts +19 -0
- package/src/graphql/CreateUmaInvitationWithIncentives.ts +23 -0
- package/src/graphql/FetchUmaInvitation.ts +15 -0
- package/src/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/ClaimUmaInvitationInput.ts +26 -0
- package/src/objects/ClaimUmaInvitationOutput.ts +30 -0
- package/src/objects/ClaimUmaInvitationWithIncentivesInput.ts +44 -0
- package/src/objects/ClaimUmaInvitationWithIncentivesOutput.ts +33 -0
- package/src/objects/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/CreateInvitationWithIncentivesInput.ts +37 -0
- package/src/objects/CreateInvitationWithIncentivesOutput.ts +32 -0
- package/src/objects/CreateLnurlInvoiceInput.ts +3 -2
- package/src/objects/CreateTestModePaymentInput.ts +2 -2
- package/src/objects/CreateTestModePaymentoutput.ts +5 -1
- package/src/objects/CreateUmaInvitationInput.ts +22 -0
- package/src/objects/CreateUmaInvitationOutput.ts +30 -0
- 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 +21 -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 +48 -0
- package/src/objects/IncentivesStatus.ts +28 -0
- 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 +25 -7
- package/src/objects/OutgoingPaymentAttempt.ts +34 -14
- 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 +541 -0
- 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 +119 -0
- 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 +11 -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 +21 -6
- package/src/tests/integration/constants.ts +0 -3
- package/src/tests/integration/general-regtest.test.ts +178 -197
|
@@ -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,84 +1801,111 @@ 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
|
-
/** The date and time when the
|
|
1818
|
+
/** The date and time when the entity was first created. **/
|
|
1397
1819
|
readonly createdAt: string;
|
|
1398
1820
|
/** The date and time when the entity was last updated. **/
|
|
1399
1821
|
readonly updatedAt: string;
|
|
1400
1822
|
/** The status of an outgoing payment attempt. **/
|
|
1401
1823
|
readonly status: OutgoingPaymentAttemptStatus;
|
|
1824
|
+
/** The date and time when the attempt was initiated. **/
|
|
1825
|
+
readonly attemptedAt: string;
|
|
1402
1826
|
/** The outgoing payment for this attempt. **/
|
|
1403
1827
|
readonly outgoingPaymentId: string;
|
|
1404
1828
|
/** The typename of the object **/
|
|
1405
1829
|
readonly typename: string;
|
|
1406
|
-
/**
|
|
1830
|
+
/**
|
|
1831
|
+
* If the payment attempt failed, then this contains the Bolt #4 failure
|
|
1832
|
+
* code. *
|
|
1833
|
+
*/
|
|
1407
1834
|
readonly failureCode?: HtlcAttemptFailureCode | undefined;
|
|
1408
1835
|
/**
|
|
1409
|
-
* If the payment attempt failed, then this contains the index of the hop
|
|
1410
|
-
* occurred.
|
|
1836
|
+
* If the payment attempt failed, then this contains the index of the hop
|
|
1837
|
+
* at which the problem occurred.
|
|
1411
1838
|
**/
|
|
1412
1839
|
readonly failureSourceIndex?: number | undefined;
|
|
1413
1840
|
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1414
1841
|
readonly resolvedAt?: string | undefined;
|
|
1415
1842
|
/**
|
|
1416
|
-
* The total amount of funds required to complete a payment over this route.
|
|
1417
|
-
* cumulative fees for each hop. As a result,
|
|
1418
|
-
*
|
|
1419
|
-
* 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.
|
|
1420
1848
|
**/
|
|
1421
1849
|
readonly amount?: CurrencyAmount | undefined;
|
|
1422
1850
|
/**
|
|
1423
|
-
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1424
|
-
*
|
|
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.
|
|
1425
1854
|
**/
|
|
1426
1855
|
readonly fees?: CurrencyAmount | undefined;
|
|
1427
|
-
/**
|
|
1856
|
+
/**
|
|
1857
|
+
* The channel snapshot at the time the outgoing payment attempt was made.
|
|
1858
|
+
* *
|
|
1859
|
+
*/
|
|
1428
1860
|
readonly channelSnapshot?: ChannelSnapshot | undefined;
|
|
1429
1861
|
constructor(
|
|
1430
1862
|
/**
|
|
1431
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1432
|
-
* string.
|
|
1863
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1864
|
+
* Should be treated as an opaque string.
|
|
1433
1865
|
**/
|
|
1434
1866
|
id: string,
|
|
1435
|
-
/** The date and time when the
|
|
1867
|
+
/** The date and time when the entity was first created. **/
|
|
1436
1868
|
createdAt: string,
|
|
1437
1869
|
/** The date and time when the entity was last updated. **/
|
|
1438
1870
|
updatedAt: string,
|
|
1439
1871
|
/** The status of an outgoing payment attempt. **/
|
|
1440
1872
|
status: OutgoingPaymentAttemptStatus,
|
|
1873
|
+
/** The date and time when the attempt was initiated. **/
|
|
1874
|
+
attemptedAt: string,
|
|
1441
1875
|
/** The outgoing payment for this attempt. **/
|
|
1442
1876
|
outgoingPaymentId: string,
|
|
1443
1877
|
/** The typename of the object **/
|
|
1444
1878
|
typename: string,
|
|
1445
|
-
/**
|
|
1879
|
+
/**
|
|
1880
|
+
* If the payment attempt failed, then this contains the Bolt #4 failure
|
|
1881
|
+
* code. *
|
|
1882
|
+
*/
|
|
1446
1883
|
failureCode?: HtlcAttemptFailureCode | undefined,
|
|
1447
1884
|
/**
|
|
1448
|
-
* If the payment attempt failed, then this contains the index of the hop
|
|
1449
|
-
* occurred.
|
|
1885
|
+
* If the payment attempt failed, then this contains the index of the hop
|
|
1886
|
+
* at which the problem occurred.
|
|
1450
1887
|
**/
|
|
1451
1888
|
failureSourceIndex?: number | undefined,
|
|
1452
1889
|
/** The time the outgoing payment attempt failed or succeeded. **/
|
|
1453
1890
|
resolvedAt?: string | undefined,
|
|
1454
1891
|
/**
|
|
1455
|
-
* The total amount of funds required to complete a payment over this route.
|
|
1456
|
-
* cumulative fees for each hop. As a result,
|
|
1457
|
-
*
|
|
1458
|
-
* 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.
|
|
1459
1897
|
**/
|
|
1460
1898
|
amount?: CurrencyAmount | undefined,
|
|
1461
1899
|
/**
|
|
1462
|
-
* The sum of the fees paid at each hop within the route of this attempt.
|
|
1463
|
-
*
|
|
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.
|
|
1464
1903
|
**/
|
|
1465
1904
|
fees?: CurrencyAmount | undefined,
|
|
1466
|
-
/**
|
|
1905
|
+
/**
|
|
1906
|
+
* The channel snapshot at the time the outgoing payment attempt was made.
|
|
1907
|
+
* *
|
|
1908
|
+
*/
|
|
1467
1909
|
channelSnapshot?: ChannelSnapshot | undefined);
|
|
1468
1910
|
getHops(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentAttemptToHopsConnection>;
|
|
1469
1911
|
static getOutgoingPaymentAttemptQuery(id: string): Query<OutgoingPaymentAttempt>;
|
|
@@ -1475,6 +1917,7 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1475
1917
|
outgoing_payment_attempt_status: OutgoingPaymentAttemptStatus;
|
|
1476
1918
|
outgoing_payment_attempt_failure_code: HtlcAttemptFailureCode | undefined;
|
|
1477
1919
|
outgoing_payment_attempt_failure_source_index: number | undefined;
|
|
1920
|
+
outgoing_payment_attempt_attempted_at: string;
|
|
1478
1921
|
outgoing_payment_attempt_resolved_at: string | undefined;
|
|
1479
1922
|
outgoing_payment_attempt_amount: any;
|
|
1480
1923
|
outgoing_payment_attempt_fees: any;
|
|
@@ -1488,11 +1931,15 @@ declare class OutgoingPaymentAttempt implements Entity {
|
|
|
1488
1931
|
/** The connection from outgoing payment to all attempts. **/
|
|
1489
1932
|
interface OutgoingPaymentToAttemptsConnection {
|
|
1490
1933
|
/**
|
|
1491
|
-
* The total count of objects in this connection, using the current filters.
|
|
1492
|
-
* 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).
|
|
1493
1937
|
**/
|
|
1494
1938
|
count: number;
|
|
1495
|
-
/**
|
|
1939
|
+
/**
|
|
1940
|
+
* An object that holds pagination information about the objects in this
|
|
1941
|
+
* connection. *
|
|
1942
|
+
*/
|
|
1496
1943
|
pageInfo: PageInfo;
|
|
1497
1944
|
/** The attempts for the current page of this connection. **/
|
|
1498
1945
|
entities: OutgoingPaymentAttempt[];
|
|
@@ -1504,11 +1951,16 @@ interface RichText {
|
|
|
1504
1951
|
text: string;
|
|
1505
1952
|
}
|
|
1506
1953
|
|
|
1507
|
-
/**
|
|
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
|
+
*/
|
|
1508
1960
|
declare class OutgoingPayment implements LightningTransaction, Transaction, Entity {
|
|
1509
1961
|
/**
|
|
1510
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1511
|
-
* string.
|
|
1962
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
1963
|
+
* Should be treated as an opaque string.
|
|
1512
1964
|
**/
|
|
1513
1965
|
readonly id: string;
|
|
1514
1966
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1525,26 +1977,38 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1525
1977
|
readonly typename: string;
|
|
1526
1978
|
/** The date and time when this transaction was completed or failed. **/
|
|
1527
1979
|
readonly resolvedAt?: string | undefined;
|
|
1528
|
-
/**
|
|
1980
|
+
/**
|
|
1981
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
1982
|
+
* Lightning Network. *
|
|
1983
|
+
*/
|
|
1529
1984
|
readonly transactionHash?: string | undefined;
|
|
1530
1985
|
/** If known, the final recipient node this payment was sent to. **/
|
|
1531
1986
|
readonly destinationId?: string | undefined;
|
|
1532
1987
|
/** The fees paid by the sender node to send the payment. **/
|
|
1533
1988
|
readonly fees?: CurrencyAmount | undefined;
|
|
1534
|
-
/**
|
|
1989
|
+
/**
|
|
1990
|
+
* The data of the payment request that was paid by this transaction, if
|
|
1991
|
+
* known. *
|
|
1992
|
+
*/
|
|
1535
1993
|
readonly paymentRequestData?: PaymentRequestData | undefined;
|
|
1536
1994
|
/** If applicable, the reason why the payment failed. **/
|
|
1537
1995
|
readonly failureReason?: PaymentFailureReason | undefined;
|
|
1538
|
-
/**
|
|
1996
|
+
/**
|
|
1997
|
+
* If applicable, user-facing error message describing why the payment
|
|
1998
|
+
* failed. *
|
|
1999
|
+
*/
|
|
1539
2000
|
readonly failureMessage?: RichText | undefined;
|
|
1540
|
-
/**
|
|
2001
|
+
/**
|
|
2002
|
+
* The post transaction data which can be used in KYT payment registration.
|
|
2003
|
+
* *
|
|
2004
|
+
*/
|
|
1541
2005
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
1542
2006
|
/** The preimage of the payment. **/
|
|
1543
2007
|
readonly paymentPreimage?: string | undefined;
|
|
1544
2008
|
constructor(
|
|
1545
2009
|
/**
|
|
1546
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1547
|
-
* string.
|
|
2010
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2011
|
+
* Should be treated as an opaque string.
|
|
1548
2012
|
**/
|
|
1549
2013
|
id: string,
|
|
1550
2014
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1561,19 +2025,31 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1561
2025
|
typename: string,
|
|
1562
2026
|
/** The date and time when this transaction was completed or failed. **/
|
|
1563
2027
|
resolvedAt?: string | undefined,
|
|
1564
|
-
/**
|
|
2028
|
+
/**
|
|
2029
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2030
|
+
* Lightning Network. *
|
|
2031
|
+
*/
|
|
1565
2032
|
transactionHash?: string | undefined,
|
|
1566
2033
|
/** If known, the final recipient node this payment was sent to. **/
|
|
1567
2034
|
destinationId?: string | undefined,
|
|
1568
2035
|
/** The fees paid by the sender node to send the payment. **/
|
|
1569
2036
|
fees?: CurrencyAmount | undefined,
|
|
1570
|
-
/**
|
|
2037
|
+
/**
|
|
2038
|
+
* The data of the payment request that was paid by this transaction, if
|
|
2039
|
+
* known. *
|
|
2040
|
+
*/
|
|
1571
2041
|
paymentRequestData?: PaymentRequestData | undefined,
|
|
1572
2042
|
/** If applicable, the reason why the payment failed. **/
|
|
1573
2043
|
failureReason?: PaymentFailureReason | undefined,
|
|
1574
|
-
/**
|
|
2044
|
+
/**
|
|
2045
|
+
* If applicable, user-facing error message describing why the payment
|
|
2046
|
+
* failed. *
|
|
2047
|
+
*/
|
|
1575
2048
|
failureMessage?: RichText | undefined,
|
|
1576
|
-
/**
|
|
2049
|
+
/**
|
|
2050
|
+
* The post transaction data which can be used in KYT payment registration.
|
|
2051
|
+
* *
|
|
2052
|
+
*/
|
|
1577
2053
|
umaPostTransactionData?: PostTransactionData[] | undefined,
|
|
1578
2054
|
/** The preimage of the payment. **/
|
|
1579
2055
|
paymentPreimage?: string | undefined);
|
|
@@ -1603,6 +2079,544 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
1603
2079
|
};
|
|
1604
2080
|
}
|
|
1605
2081
|
|
|
2082
|
+
/**
|
|
2083
|
+
* The alpha-2 representation of a country, as defined by the ISO 3166-1
|
|
2084
|
+
* standard. *
|
|
2085
|
+
*/
|
|
2086
|
+
declare enum RegionCode {
|
|
2087
|
+
/**
|
|
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.
|
|
2091
|
+
*/
|
|
2092
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2093
|
+
/** The code representing the country of Afghanistan. **/
|
|
2094
|
+
AF = "AF",
|
|
2095
|
+
/** The code representing the country of Åland Islands. **/
|
|
2096
|
+
AX = "AX",
|
|
2097
|
+
/** The code representing the country of Albania. **/
|
|
2098
|
+
AL = "AL",
|
|
2099
|
+
/** The code representing the country of Algeria. **/
|
|
2100
|
+
DZ = "DZ",
|
|
2101
|
+
/** The code representing the country of American Samoa. **/
|
|
2102
|
+
AS = "AS",
|
|
2103
|
+
/** The code representing the country of Andorra. **/
|
|
2104
|
+
AD = "AD",
|
|
2105
|
+
/** The code representing the country of Angola. **/
|
|
2106
|
+
AO = "AO",
|
|
2107
|
+
/** The code representing the country of Anguilla. **/
|
|
2108
|
+
AI = "AI",
|
|
2109
|
+
/** The code representing the country of Antarctica. **/
|
|
2110
|
+
AQ = "AQ",
|
|
2111
|
+
/** The code representing the country of Antigua and Barbuda. **/
|
|
2112
|
+
AG = "AG",
|
|
2113
|
+
/** The code representing the country of Argentina. **/
|
|
2114
|
+
AR = "AR",
|
|
2115
|
+
/** The code representing the country of Armenia. **/
|
|
2116
|
+
AM = "AM",
|
|
2117
|
+
/** The code representing the country of Aruba. **/
|
|
2118
|
+
AW = "AW",
|
|
2119
|
+
/** The code representing the country of Australia. **/
|
|
2120
|
+
AU = "AU",
|
|
2121
|
+
/** The code representing the country of Austria. **/
|
|
2122
|
+
AT = "AT",
|
|
2123
|
+
/** The code representing the country of Azerbaijan. **/
|
|
2124
|
+
AZ = "AZ",
|
|
2125
|
+
/** The code representing the country of Bahamas. **/
|
|
2126
|
+
BS = "BS",
|
|
2127
|
+
/** The code representing the country of Bahrain. **/
|
|
2128
|
+
BH = "BH",
|
|
2129
|
+
/** The code representing the country of Bangladesh. **/
|
|
2130
|
+
BD = "BD",
|
|
2131
|
+
/** The code representing the country of Barbados. **/
|
|
2132
|
+
BB = "BB",
|
|
2133
|
+
/** The code representing the country of Belarus. **/
|
|
2134
|
+
BY = "BY",
|
|
2135
|
+
/** The code representing the country of Belgium. **/
|
|
2136
|
+
BE = "BE",
|
|
2137
|
+
/** The code representing the country of Belize. **/
|
|
2138
|
+
BZ = "BZ",
|
|
2139
|
+
/** The code representing the country of Benin. **/
|
|
2140
|
+
BJ = "BJ",
|
|
2141
|
+
/** The code representing the country of Bermuda. **/
|
|
2142
|
+
BM = "BM",
|
|
2143
|
+
/** The code representing the country of Bhutan. **/
|
|
2144
|
+
BT = "BT",
|
|
2145
|
+
/**
|
|
2146
|
+
* The code representing the country of The Plurinational State of Bolivia.
|
|
2147
|
+
* *
|
|
2148
|
+
*/
|
|
2149
|
+
BO = "BO",
|
|
2150
|
+
/**
|
|
2151
|
+
* The code representing the country of Bonaire, Sint Eustatius, and Saba.
|
|
2152
|
+
* *
|
|
2153
|
+
*/
|
|
2154
|
+
BQ = "BQ",
|
|
2155
|
+
/** The code representing the country of Bosnia and Herzegovina. **/
|
|
2156
|
+
BA = "BA",
|
|
2157
|
+
/** The code representing the country of Botswana. **/
|
|
2158
|
+
BW = "BW",
|
|
2159
|
+
/** The code representing the country of Bouvet Island. **/
|
|
2160
|
+
BV = "BV",
|
|
2161
|
+
/** The code representing the country of Brazil. **/
|
|
2162
|
+
BR = "BR",
|
|
2163
|
+
/** The code representing the country of British Indian Ocean Territory. **/
|
|
2164
|
+
IO = "IO",
|
|
2165
|
+
/** The code representing the country of Brunei Darussalam. **/
|
|
2166
|
+
BN = "BN",
|
|
2167
|
+
/** The code representing the country of Bulgaria. **/
|
|
2168
|
+
BG = "BG",
|
|
2169
|
+
/** The code representing the country of Burkina Faso. **/
|
|
2170
|
+
BF = "BF",
|
|
2171
|
+
/** The code representing the country of Burundi. **/
|
|
2172
|
+
BI = "BI",
|
|
2173
|
+
/** The code representing the country of Cambodia. **/
|
|
2174
|
+
KH = "KH",
|
|
2175
|
+
/** The code representing the country of Cameroon. **/
|
|
2176
|
+
CM = "CM",
|
|
2177
|
+
/** The code representing the country of Canada. **/
|
|
2178
|
+
CA = "CA",
|
|
2179
|
+
/** The code representing the country of Cape Verde. **/
|
|
2180
|
+
CV = "CV",
|
|
2181
|
+
/** The code representing the country of Cayman Islands. **/
|
|
2182
|
+
KY = "KY",
|
|
2183
|
+
/** The code representing the country of Central African Republic. **/
|
|
2184
|
+
CF = "CF",
|
|
2185
|
+
/** The code representing the country of Chad. **/
|
|
2186
|
+
TD = "TD",
|
|
2187
|
+
/** The code representing the country of Chile. **/
|
|
2188
|
+
CL = "CL",
|
|
2189
|
+
/** The code representing the country of China. **/
|
|
2190
|
+
CN = "CN",
|
|
2191
|
+
/** The code representing the country of Christmas Island. **/
|
|
2192
|
+
CX = "CX",
|
|
2193
|
+
/** The code representing the country of Cocos (Keeling) Islands. **/
|
|
2194
|
+
CC = "CC",
|
|
2195
|
+
/** The code representing the country of Colombia. **/
|
|
2196
|
+
CO = "CO",
|
|
2197
|
+
/** The code representing the country of Comoros. **/
|
|
2198
|
+
KM = "KM",
|
|
2199
|
+
/** The code representing the country of Congo. **/
|
|
2200
|
+
CG = "CG",
|
|
2201
|
+
/**
|
|
2202
|
+
* The code representing the country of The Democratic Republic of the Congo.
|
|
2203
|
+
* *
|
|
2204
|
+
*/
|
|
2205
|
+
CD = "CD",
|
|
2206
|
+
/** The code representing the country of Cook Islands. **/
|
|
2207
|
+
CK = "CK",
|
|
2208
|
+
/** The code representing the country of Costa Rica. **/
|
|
2209
|
+
CR = "CR",
|
|
2210
|
+
/** The code representing the country of Côte d'Ivoire. **/
|
|
2211
|
+
CI = "CI",
|
|
2212
|
+
/** The code representing the country of Croatia. **/
|
|
2213
|
+
HR = "HR",
|
|
2214
|
+
/** The code representing the country of Cuba. **/
|
|
2215
|
+
CU = "CU",
|
|
2216
|
+
/** The code representing the country of Curaçao. **/
|
|
2217
|
+
CW = "CW",
|
|
2218
|
+
/** The code representing the country of Cyprus. **/
|
|
2219
|
+
CY = "CY",
|
|
2220
|
+
/** The code representing the country of Czech Republic. **/
|
|
2221
|
+
CZ = "CZ",
|
|
2222
|
+
/** The code representing the country of Denmark. **/
|
|
2223
|
+
DK = "DK",
|
|
2224
|
+
/** The code representing the country of Djibouti. **/
|
|
2225
|
+
DJ = "DJ",
|
|
2226
|
+
/** The code representing the country of Dominica. **/
|
|
2227
|
+
DM = "DM",
|
|
2228
|
+
/** The code representing the country of Dominican Republic. **/
|
|
2229
|
+
DO = "DO",
|
|
2230
|
+
/** The code representing the country of Ecuador. **/
|
|
2231
|
+
EC = "EC",
|
|
2232
|
+
/** The code representing the country of Egypt. **/
|
|
2233
|
+
EG = "EG",
|
|
2234
|
+
/** The code representing the country of El Salvador. **/
|
|
2235
|
+
SV = "SV",
|
|
2236
|
+
/** The code representing the country of Equatorial Guinea. **/
|
|
2237
|
+
GQ = "GQ",
|
|
2238
|
+
/** The code representing the country of Eritrea. **/
|
|
2239
|
+
ER = "ER",
|
|
2240
|
+
/** The code representing the country of Estonia. **/
|
|
2241
|
+
EE = "EE",
|
|
2242
|
+
/** The code representing the country of Ethiopia. **/
|
|
2243
|
+
ET = "ET",
|
|
2244
|
+
/** The code representing the country of Falkland Islands (Malvinas). **/
|
|
2245
|
+
FK = "FK",
|
|
2246
|
+
/** The code representing the country of Faroe Islands. **/
|
|
2247
|
+
FO = "FO",
|
|
2248
|
+
/** The code representing the country of Fiji. **/
|
|
2249
|
+
FJ = "FJ",
|
|
2250
|
+
/** The code representing the country of Finland. **/
|
|
2251
|
+
FI = "FI",
|
|
2252
|
+
/** The code representing the country of France. **/
|
|
2253
|
+
FR = "FR",
|
|
2254
|
+
/** The code representing the country of French Guiana. **/
|
|
2255
|
+
GF = "GF",
|
|
2256
|
+
/** The code representing the country of French Polynesia. **/
|
|
2257
|
+
PF = "PF",
|
|
2258
|
+
/** The code representing the country of French Southern Territories. **/
|
|
2259
|
+
TF = "TF",
|
|
2260
|
+
/** The code representing the country of Gabon. **/
|
|
2261
|
+
GA = "GA",
|
|
2262
|
+
/** The code representing the country of Gambia. **/
|
|
2263
|
+
GM = "GM",
|
|
2264
|
+
/** The code representing the country of Georgia. **/
|
|
2265
|
+
GE = "GE",
|
|
2266
|
+
/** The code representing the country of Germany. **/
|
|
2267
|
+
DE = "DE",
|
|
2268
|
+
/** The code representing the country of Ghana. **/
|
|
2269
|
+
GH = "GH",
|
|
2270
|
+
/** The code representing the country of Gibraltar. **/
|
|
2271
|
+
GI = "GI",
|
|
2272
|
+
/** The code representing the country of Greece. **/
|
|
2273
|
+
GR = "GR",
|
|
2274
|
+
/** The code representing the country of Greenland. **/
|
|
2275
|
+
GL = "GL",
|
|
2276
|
+
/** The code representing the country of Grenada. **/
|
|
2277
|
+
GD = "GD",
|
|
2278
|
+
/** The code representing the country of Guadeloupe. **/
|
|
2279
|
+
GP = "GP",
|
|
2280
|
+
/** The code representing the country of Guam. **/
|
|
2281
|
+
GU = "GU",
|
|
2282
|
+
/** The code representing the country of Guatemala. **/
|
|
2283
|
+
GT = "GT",
|
|
2284
|
+
/** The code representing the country of Guernsey. **/
|
|
2285
|
+
GG = "GG",
|
|
2286
|
+
/** The code representing the country of Guinea. **/
|
|
2287
|
+
GN = "GN",
|
|
2288
|
+
/** The code representing the country of Guinea-Bissau. **/
|
|
2289
|
+
GW = "GW",
|
|
2290
|
+
/** The code representing the country of Guyana. **/
|
|
2291
|
+
GY = "GY",
|
|
2292
|
+
/** The code representing the country of Haiti. **/
|
|
2293
|
+
HT = "HT",
|
|
2294
|
+
/**
|
|
2295
|
+
* The code representing the country of Heard Island and McDonald Islands.
|
|
2296
|
+
* *
|
|
2297
|
+
*/
|
|
2298
|
+
HM = "HM",
|
|
2299
|
+
/** The code representing the country of Holy See (Vatican City State). **/
|
|
2300
|
+
VA = "VA",
|
|
2301
|
+
/** The code representing the country of Honduras. **/
|
|
2302
|
+
HN = "HN",
|
|
2303
|
+
/** The code representing the country of Hong Kong. **/
|
|
2304
|
+
HK = "HK",
|
|
2305
|
+
/** The code representing the country of Hungary. **/
|
|
2306
|
+
HU = "HU",
|
|
2307
|
+
/** The code representing the country of Iceland. **/
|
|
2308
|
+
IS = "IS",
|
|
2309
|
+
/** The code representing the country of India. **/
|
|
2310
|
+
IN = "IN",
|
|
2311
|
+
/** The code representing the country of Indonesia. **/
|
|
2312
|
+
ID = "ID",
|
|
2313
|
+
/** The code representing the country of Islamic Republic of Iran. **/
|
|
2314
|
+
IR = "IR",
|
|
2315
|
+
/** The code representing the country of Iraq. **/
|
|
2316
|
+
IQ = "IQ",
|
|
2317
|
+
/** The code representing the country of Ireland. **/
|
|
2318
|
+
IE = "IE",
|
|
2319
|
+
/** The code representing the country of Isle of Man. **/
|
|
2320
|
+
IM = "IM",
|
|
2321
|
+
/** The code representing the country of Israel. **/
|
|
2322
|
+
IL = "IL",
|
|
2323
|
+
/** The code representing the country of Italy. **/
|
|
2324
|
+
IT = "IT",
|
|
2325
|
+
/** The code representing the country of Jamaica. **/
|
|
2326
|
+
JM = "JM",
|
|
2327
|
+
/** The code representing the country of Japan. **/
|
|
2328
|
+
JP = "JP",
|
|
2329
|
+
/** The code representing the country of Jersey. **/
|
|
2330
|
+
JE = "JE",
|
|
2331
|
+
/** The code representing the country of Jordan. **/
|
|
2332
|
+
JO = "JO",
|
|
2333
|
+
/** The code representing the country of Kazakhstan. **/
|
|
2334
|
+
KZ = "KZ",
|
|
2335
|
+
/** The code representing the country of Kenya. **/
|
|
2336
|
+
KE = "KE",
|
|
2337
|
+
/** The code representing the country of Kiribati. **/
|
|
2338
|
+
KI = "KI",
|
|
2339
|
+
/**
|
|
2340
|
+
* The code representing the country of Democratic People's Republic ofKorea.
|
|
2341
|
+
* *
|
|
2342
|
+
*/
|
|
2343
|
+
KP = "KP",
|
|
2344
|
+
/** The code representing the country of Republic of Korea. **/
|
|
2345
|
+
KR = "KR",
|
|
2346
|
+
/** The code representing the country of Kuwait. **/
|
|
2347
|
+
KW = "KW",
|
|
2348
|
+
/** The code representing the country of Kyrgyzstan. **/
|
|
2349
|
+
KG = "KG",
|
|
2350
|
+
/** The code representing the country of Lao People's Democratic Republic. **/
|
|
2351
|
+
LA = "LA",
|
|
2352
|
+
/** The code representing the country of Latvia. **/
|
|
2353
|
+
LV = "LV",
|
|
2354
|
+
/** The code representing the country of Lebanon. **/
|
|
2355
|
+
LB = "LB",
|
|
2356
|
+
/** The code representing the country of Lesotho. **/
|
|
2357
|
+
LS = "LS",
|
|
2358
|
+
/** The code representing the country of Liberia. **/
|
|
2359
|
+
LR = "LR",
|
|
2360
|
+
/** The code representing the country of Libya. **/
|
|
2361
|
+
LY = "LY",
|
|
2362
|
+
/** The code representing the country of Liechtenstein. **/
|
|
2363
|
+
LI = "LI",
|
|
2364
|
+
/** The code representing the country of Lithuania. **/
|
|
2365
|
+
LT = "LT",
|
|
2366
|
+
/** The code representing the country of Luxembourg. **/
|
|
2367
|
+
LU = "LU",
|
|
2368
|
+
/** The code representing the country of Macao. **/
|
|
2369
|
+
MO = "MO",
|
|
2370
|
+
/**
|
|
2371
|
+
* The code representing the country of The Former Yugoslav Republic of
|
|
2372
|
+
* Macedonia. *
|
|
2373
|
+
*/
|
|
2374
|
+
MK = "MK",
|
|
2375
|
+
/** The code representing the country of Madagascar. **/
|
|
2376
|
+
MG = "MG",
|
|
2377
|
+
/** The code representing the country of Malawi. **/
|
|
2378
|
+
MW = "MW",
|
|
2379
|
+
/** The code representing the country of Malaysia. **/
|
|
2380
|
+
MY = "MY",
|
|
2381
|
+
/** The code representing the country of Maldives. **/
|
|
2382
|
+
MV = "MV",
|
|
2383
|
+
/** The code representing the country of Mali. **/
|
|
2384
|
+
ML = "ML",
|
|
2385
|
+
/** The code representing the country of Malta. **/
|
|
2386
|
+
MT = "MT",
|
|
2387
|
+
/** The code representing the country of Marshall Islands. **/
|
|
2388
|
+
MH = "MH",
|
|
2389
|
+
/** The code representing the country of Martinique. **/
|
|
2390
|
+
MQ = "MQ",
|
|
2391
|
+
/** The code representing the country of Mauritania. **/
|
|
2392
|
+
MR = "MR",
|
|
2393
|
+
/** The code representing the country of Mauritius. **/
|
|
2394
|
+
MU = "MU",
|
|
2395
|
+
/** The code representing the country of Mayotte. **/
|
|
2396
|
+
YT = "YT",
|
|
2397
|
+
/** The code representing the country of Mexico. **/
|
|
2398
|
+
MX = "MX",
|
|
2399
|
+
/** The code representing the country of Federated States ofMicronesia. **/
|
|
2400
|
+
FM = "FM",
|
|
2401
|
+
/** The code representing the country of Republic of Moldova. **/
|
|
2402
|
+
MD = "MD",
|
|
2403
|
+
/** The code representing the country of Monaco. **/
|
|
2404
|
+
MC = "MC",
|
|
2405
|
+
/** The code representing the country of Mongolia. **/
|
|
2406
|
+
MN = "MN",
|
|
2407
|
+
/** The code representing the country of Montenegro. **/
|
|
2408
|
+
ME = "ME",
|
|
2409
|
+
/** The code representing the country of Montserrat. **/
|
|
2410
|
+
MS = "MS",
|
|
2411
|
+
/** The code representing the country of Morocco. **/
|
|
2412
|
+
MA = "MA",
|
|
2413
|
+
/** The code representing the country of Mozambique. **/
|
|
2414
|
+
MZ = "MZ",
|
|
2415
|
+
/** The code representing the country of Myanmar. **/
|
|
2416
|
+
MM = "MM",
|
|
2417
|
+
/** The code representing the country of Namibia. **/
|
|
2418
|
+
NA = "NA",
|
|
2419
|
+
/** The code representing the country of Nauru. **/
|
|
2420
|
+
NR = "NR",
|
|
2421
|
+
/** The code representing the country of Nepal. **/
|
|
2422
|
+
NP = "NP",
|
|
2423
|
+
/** The code representing the country of Netherlands. **/
|
|
2424
|
+
NL = "NL",
|
|
2425
|
+
/** The code representing the country of New Caledonia. **/
|
|
2426
|
+
NC = "NC",
|
|
2427
|
+
/** The code representing the country of New Zealand. **/
|
|
2428
|
+
NZ = "NZ",
|
|
2429
|
+
/** The code representing the country of Nicaragua. **/
|
|
2430
|
+
NI = "NI",
|
|
2431
|
+
/** The code representing the country of Niger. **/
|
|
2432
|
+
NE = "NE",
|
|
2433
|
+
/** The code representing the country of Nigeria. **/
|
|
2434
|
+
NG = "NG",
|
|
2435
|
+
/** The code representing the country of Niue. **/
|
|
2436
|
+
NU = "NU",
|
|
2437
|
+
/** The code representing the country of Norfolk Island. **/
|
|
2438
|
+
NF = "NF",
|
|
2439
|
+
/** The code representing the country of Northern Mariana Islands. **/
|
|
2440
|
+
MP = "MP",
|
|
2441
|
+
/** The code representing the country of Norway. **/
|
|
2442
|
+
NO = "NO",
|
|
2443
|
+
/** The code representing the country of Oman. **/
|
|
2444
|
+
OM = "OM",
|
|
2445
|
+
/** The code representing the country of Pakistan. **/
|
|
2446
|
+
PK = "PK",
|
|
2447
|
+
/** The code representing the country of Palau. **/
|
|
2448
|
+
PW = "PW",
|
|
2449
|
+
/** The code representing the country of State of Palestine. **/
|
|
2450
|
+
PS = "PS",
|
|
2451
|
+
/** The code representing the country of Panama. **/
|
|
2452
|
+
PA = "PA",
|
|
2453
|
+
/** The code representing the country of Papua New Guinea. **/
|
|
2454
|
+
PG = "PG",
|
|
2455
|
+
/** The code representing the country of Paraguay. **/
|
|
2456
|
+
PY = "PY",
|
|
2457
|
+
/** The code representing the country of Peru. **/
|
|
2458
|
+
PE = "PE",
|
|
2459
|
+
/** The code representing the country of Philippines. **/
|
|
2460
|
+
PH = "PH",
|
|
2461
|
+
/** The code representing the country of Pitcairn. **/
|
|
2462
|
+
PN = "PN",
|
|
2463
|
+
/** The code representing the country of Poland. **/
|
|
2464
|
+
PL = "PL",
|
|
2465
|
+
/** The code representing the country of Portugal. **/
|
|
2466
|
+
PT = "PT",
|
|
2467
|
+
/** The code representing the country of Puerto Rico. **/
|
|
2468
|
+
PR = "PR",
|
|
2469
|
+
/** The code representing the country of Qatar. **/
|
|
2470
|
+
QA = "QA",
|
|
2471
|
+
/** The code representing the country of Réunion. **/
|
|
2472
|
+
RE = "RE",
|
|
2473
|
+
/** The code representing the country of Romania. **/
|
|
2474
|
+
RO = "RO",
|
|
2475
|
+
/** The code representing the country of Russian Federation. **/
|
|
2476
|
+
RU = "RU",
|
|
2477
|
+
/** The code representing the country of Rwanda. **/
|
|
2478
|
+
RW = "RW",
|
|
2479
|
+
/** The code representing the country of Saint Barthélemy. **/
|
|
2480
|
+
BL = "BL",
|
|
2481
|
+
/**
|
|
2482
|
+
* The code representing the country of Saint Helena Ascension and Tristan
|
|
2483
|
+
* da Cunha. *
|
|
2484
|
+
*/
|
|
2485
|
+
SH = "SH",
|
|
2486
|
+
/** The code representing the country of Saint Kitts and Nevis. **/
|
|
2487
|
+
KN = "KN",
|
|
2488
|
+
/** The code representing the country of Saint Lucia. **/
|
|
2489
|
+
LC = "LC",
|
|
2490
|
+
/** The code representing the country of Saint Martin (French part). **/
|
|
2491
|
+
MF = "MF",
|
|
2492
|
+
/** The code representing the country of Saint Pierre and Miquelon. **/
|
|
2493
|
+
PM = "PM",
|
|
2494
|
+
/** The code representing the country of Saint Vincent and the Grenadines. **/
|
|
2495
|
+
VC = "VC",
|
|
2496
|
+
/** The code representing the country of Samoa. **/
|
|
2497
|
+
WS = "WS",
|
|
2498
|
+
/** The code representing the country of San Marino. **/
|
|
2499
|
+
SM = "SM",
|
|
2500
|
+
/** The code representing the country of Sao Tome and Principe. **/
|
|
2501
|
+
ST = "ST",
|
|
2502
|
+
/** The code representing the country of Saudi Arabia. **/
|
|
2503
|
+
SA = "SA",
|
|
2504
|
+
/** The code representing the country of Senegal. **/
|
|
2505
|
+
SN = "SN",
|
|
2506
|
+
/** The code representing the country of Serbia. **/
|
|
2507
|
+
RS = "RS",
|
|
2508
|
+
/** The code representing the country of Seychelles. **/
|
|
2509
|
+
SC = "SC",
|
|
2510
|
+
/** The code representing the country of Sierra Leone. **/
|
|
2511
|
+
SL = "SL",
|
|
2512
|
+
/** The code representing the country of Singapore. **/
|
|
2513
|
+
SG = "SG",
|
|
2514
|
+
/** The code representing the country of Sint Maarten (Dutch part). **/
|
|
2515
|
+
SX = "SX",
|
|
2516
|
+
/** The code representing the country of Slovakia. **/
|
|
2517
|
+
SK = "SK",
|
|
2518
|
+
/** The code representing the country of Slovenia. **/
|
|
2519
|
+
SI = "SI",
|
|
2520
|
+
/** The code representing the country of Solomon Islands. **/
|
|
2521
|
+
SB = "SB",
|
|
2522
|
+
/** The code representing the country of Somalia. **/
|
|
2523
|
+
SO = "SO",
|
|
2524
|
+
/** The code representing the country of South Africa. **/
|
|
2525
|
+
ZA = "ZA",
|
|
2526
|
+
/**
|
|
2527
|
+
* The code representing the country of South Georgia and the South Sandwich
|
|
2528
|
+
* Islands. *
|
|
2529
|
+
*/
|
|
2530
|
+
GS = "GS",
|
|
2531
|
+
/** The code representing the country of South Sudan. **/
|
|
2532
|
+
SS = "SS",
|
|
2533
|
+
/** The code representing the country of Spain. **/
|
|
2534
|
+
ES = "ES",
|
|
2535
|
+
/** The code representing the country of Sri Lanka. **/
|
|
2536
|
+
LK = "LK",
|
|
2537
|
+
/** The code representing the country of Sudan. **/
|
|
2538
|
+
SD = "SD",
|
|
2539
|
+
/** The code representing the country of Suriname. **/
|
|
2540
|
+
SR = "SR",
|
|
2541
|
+
/** The code representing the country of Svalbard and Jan Mayen. **/
|
|
2542
|
+
SJ = "SJ",
|
|
2543
|
+
/** The code representing the country of Swaziland. **/
|
|
2544
|
+
SZ = "SZ",
|
|
2545
|
+
/** The code representing the country of Sweden. **/
|
|
2546
|
+
SE = "SE",
|
|
2547
|
+
/** The code representing the country of Switzerland. **/
|
|
2548
|
+
CH = "CH",
|
|
2549
|
+
/** The code representing the country of Syrian Arab Republic. **/
|
|
2550
|
+
SY = "SY",
|
|
2551
|
+
/** The code representing the country of Taiwan, Province of China. **/
|
|
2552
|
+
TW = "TW",
|
|
2553
|
+
/** The code representing the country of Tajikistan. **/
|
|
2554
|
+
TJ = "TJ",
|
|
2555
|
+
/** The code representing the country of United Republic of Tanzania. **/
|
|
2556
|
+
TZ = "TZ",
|
|
2557
|
+
/** The code representing the country of Thailand. **/
|
|
2558
|
+
TH = "TH",
|
|
2559
|
+
/** The code representing the country of Timor-Leste. **/
|
|
2560
|
+
TL = "TL",
|
|
2561
|
+
/** The code representing the country of Togo. **/
|
|
2562
|
+
TG = "TG",
|
|
2563
|
+
/** The code representing the country of Tokelau. **/
|
|
2564
|
+
TK = "TK",
|
|
2565
|
+
/** The code representing the country of Tonga. **/
|
|
2566
|
+
TO = "TO",
|
|
2567
|
+
/** The code representing the country of Trinidad and Tobago. **/
|
|
2568
|
+
TT = "TT",
|
|
2569
|
+
/** The code representing the country of Tunisia. **/
|
|
2570
|
+
TN = "TN",
|
|
2571
|
+
/** The code representing the country of Turkey. **/
|
|
2572
|
+
TR = "TR",
|
|
2573
|
+
/** The code representing the country of Turkmenistan. **/
|
|
2574
|
+
TM = "TM",
|
|
2575
|
+
/** The code representing the country of Turks and Caicos Islands. **/
|
|
2576
|
+
TC = "TC",
|
|
2577
|
+
/** The code representing the country of Tuvalu. **/
|
|
2578
|
+
TV = "TV",
|
|
2579
|
+
/** The code representing the country of Uganda. **/
|
|
2580
|
+
UG = "UG",
|
|
2581
|
+
/** The code representing the country of Ukraine. **/
|
|
2582
|
+
UA = "UA",
|
|
2583
|
+
/** The code representing the country of United Arab Emirates. **/
|
|
2584
|
+
AE = "AE",
|
|
2585
|
+
/** The code representing the country of United Kingdom. **/
|
|
2586
|
+
GB = "GB",
|
|
2587
|
+
/** The code representing the country of United States. **/
|
|
2588
|
+
US = "US",
|
|
2589
|
+
/**
|
|
2590
|
+
* The code representing the country of United States Minor Outlying Islands.
|
|
2591
|
+
* *
|
|
2592
|
+
*/
|
|
2593
|
+
UM = "UM",
|
|
2594
|
+
/** The code representing the country of Uruguay. **/
|
|
2595
|
+
UY = "UY",
|
|
2596
|
+
/** The code representing the country of Uzbekistan. **/
|
|
2597
|
+
UZ = "UZ",
|
|
2598
|
+
/** The code representing the country of Vanuatu. **/
|
|
2599
|
+
VU = "VU",
|
|
2600
|
+
/** The code representing the country of Bolivarian Republic of Venezuela. **/
|
|
2601
|
+
VE = "VE",
|
|
2602
|
+
/** The code representing the country of Viet Nam. **/
|
|
2603
|
+
VN = "VN",
|
|
2604
|
+
/** The code representing the country of British Virgin Islands. **/
|
|
2605
|
+
VG = "VG",
|
|
2606
|
+
/** The code representing the country of U.S. Virgin Islands. **/
|
|
2607
|
+
VI = "VI",
|
|
2608
|
+
/** The code representing the country of Wallis and Futuna. **/
|
|
2609
|
+
WF = "WF",
|
|
2610
|
+
/** The code representing the country of Western Sahara. **/
|
|
2611
|
+
EH = "EH",
|
|
2612
|
+
/** The code representing the country of Yemen. **/
|
|
2613
|
+
YE = "YE",
|
|
2614
|
+
/** The code representing the country of Zambia. **/
|
|
2615
|
+
ZM = "ZM",
|
|
2616
|
+
/** The code representing the country of Zimbabwe. **/
|
|
2617
|
+
ZW = "ZW"
|
|
2618
|
+
}
|
|
2619
|
+
|
|
1606
2620
|
type SingleNodeDashboard = {
|
|
1607
2621
|
id: string;
|
|
1608
2622
|
displayName: string;
|
|
@@ -1628,8 +2642,8 @@ type SingleNodeDashboard = {
|
|
|
1628
2642
|
|
|
1629
2643
|
type TransactionUpdate = {
|
|
1630
2644
|
/**
|
|
1631
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1632
|
-
* string.
|
|
2645
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2646
|
+
* Should be treated as an opaque string.
|
|
1633
2647
|
**/
|
|
1634
2648
|
id: string;
|
|
1635
2649
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1644,15 +2658,126 @@ type TransactionUpdate = {
|
|
|
1644
2658
|
typename: string;
|
|
1645
2659
|
/** The date and time when this transaction was completed or failed. **/
|
|
1646
2660
|
resolvedAt?: string;
|
|
1647
|
-
/**
|
|
2661
|
+
/**
|
|
2662
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2663
|
+
* Lightning Network. *
|
|
2664
|
+
*/
|
|
1648
2665
|
transactionHash?: string;
|
|
1649
2666
|
};
|
|
1650
2667
|
|
|
1651
|
-
/**
|
|
2668
|
+
/**
|
|
2669
|
+
* Describes the reason for an invitation to not be eligible for incentives.
|
|
2670
|
+
* *
|
|
2671
|
+
*/
|
|
2672
|
+
declare enum IncentivesIneligibilityReason {
|
|
2673
|
+
/**
|
|
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.
|
|
2677
|
+
*/
|
|
2678
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2679
|
+
/**
|
|
2680
|
+
* This invitation is not eligible for incentives because it has been created
|
|
2681
|
+
* outside of the incentives flow. *
|
|
2682
|
+
*/
|
|
2683
|
+
DISABLED = "DISABLED",
|
|
2684
|
+
/**
|
|
2685
|
+
* This invitation is not eligible for incentives because the sender is not
|
|
2686
|
+
* eligible. *
|
|
2687
|
+
*/
|
|
2688
|
+
SENDER_NOT_ELIGIBLE = "SENDER_NOT_ELIGIBLE",
|
|
2689
|
+
/**
|
|
2690
|
+
* This invitation is not eligible for incentives because the receiver is not
|
|
2691
|
+
* eligible. *
|
|
2692
|
+
*/
|
|
2693
|
+
RECEIVER_NOT_ELIGIBLE = "RECEIVER_NOT_ELIGIBLE",
|
|
2694
|
+
/**
|
|
2695
|
+
* This invitation is not eligible for incentives because the sending VASP is
|
|
2696
|
+
* not part of the incentives program.
|
|
2697
|
+
* *
|
|
2698
|
+
*/
|
|
2699
|
+
SENDING_VASP_NOT_ELIGIBLE = "SENDING_VASP_NOT_ELIGIBLE",
|
|
2700
|
+
/**
|
|
2701
|
+
* This invitation is not eligible for incentives because the receiving VASP
|
|
2702
|
+
* is not part of the incentives program.
|
|
2703
|
+
* *
|
|
2704
|
+
*/
|
|
2705
|
+
RECEIVING_VASP_NOT_ELIGIBLE = "RECEIVING_VASP_NOT_ELIGIBLE",
|
|
2706
|
+
/**
|
|
2707
|
+
* This invitation is not eligible for incentives because the sender and
|
|
2708
|
+
* receiver are in the same region. *
|
|
2709
|
+
*/
|
|
2710
|
+
NOT_CROSS_BORDER = "NOT_CROSS_BORDER"
|
|
2711
|
+
}
|
|
2712
|
+
|
|
2713
|
+
/** Describes the status of the incentives for this invitation. **/
|
|
2714
|
+
declare enum IncentivesStatus {
|
|
2715
|
+
/**
|
|
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.
|
|
2719
|
+
*/
|
|
2720
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2721
|
+
/**
|
|
2722
|
+
* The invitation is eligible for incentives in its current state.
|
|
2723
|
+
* When it is claimed, we will reassess.
|
|
2724
|
+
* *
|
|
2725
|
+
*/
|
|
2726
|
+
PENDING = "PENDING",
|
|
2727
|
+
/** The incentives have been validated. **/
|
|
2728
|
+
VALIDATED = "VALIDATED",
|
|
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
|
+
*/
|
|
2735
|
+
INELIGIBLE = "INELIGIBLE"
|
|
2736
|
+
}
|
|
2737
|
+
|
|
2738
|
+
/** This is an object representing an UMA.ME invitation. **/
|
|
2739
|
+
interface UmaInvitation {
|
|
2740
|
+
/**
|
|
2741
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2742
|
+
* Should be treated as an opaque string.
|
|
2743
|
+
**/
|
|
2744
|
+
id: string;
|
|
2745
|
+
/** The date and time when the entity was first created. **/
|
|
2746
|
+
createdAt: string;
|
|
2747
|
+
/** The date and time when the entity was last updated. **/
|
|
2748
|
+
updatedAt: string;
|
|
2749
|
+
/** The code that uniquely identifies this invitation. **/
|
|
2750
|
+
code: string;
|
|
2751
|
+
/** The URL where this invitation can be claimed. **/
|
|
2752
|
+
url: string;
|
|
2753
|
+
/** The UMA of the user who created the invitation. **/
|
|
2754
|
+
inviterUma: string;
|
|
2755
|
+
/**
|
|
2756
|
+
* The current status of the incentives that may be tied to this invitation.
|
|
2757
|
+
* *
|
|
2758
|
+
*/
|
|
2759
|
+
incentivesStatus: IncentivesStatus;
|
|
2760
|
+
/** The typename of the object **/
|
|
2761
|
+
typename: string;
|
|
2762
|
+
/** The UMA of the user who claimed the invitation. **/
|
|
2763
|
+
inviteeUma?: string | undefined;
|
|
2764
|
+
/**
|
|
2765
|
+
* The reason why the invitation is not eligible for incentives, if
|
|
2766
|
+
* applicable. *
|
|
2767
|
+
*/
|
|
2768
|
+
incentivesIneligibilityReason?: IncentivesIneligibilityReason | undefined;
|
|
2769
|
+
}
|
|
2770
|
+
declare const getUmaInvitationQuery: (id: string) => Query<UmaInvitation>;
|
|
2771
|
+
|
|
2772
|
+
/**
|
|
2773
|
+
* This is an enum of the potential modes that your Bitcoin withdrawal can
|
|
2774
|
+
* take. *
|
|
2775
|
+
*/
|
|
1652
2776
|
declare enum WithdrawalMode {
|
|
1653
2777
|
/**
|
|
1654
|
-
* This is an enum value that represents values that could be added in the
|
|
1655
|
-
* 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.
|
|
1656
2781
|
*/
|
|
1657
2782
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1658
2783
|
WALLET_ONLY = "WALLET_ONLY",
|
|
@@ -1662,8 +2787,9 @@ declare enum WithdrawalMode {
|
|
|
1662
2787
|
/** This is an enum of the potential statuses that a Withdrawal can take. **/
|
|
1663
2788
|
declare enum WithdrawalRequestStatus {
|
|
1664
2789
|
/**
|
|
1665
|
-
* This is an enum value that represents values that could be added in the
|
|
1666
|
-
* 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.
|
|
1667
2793
|
*/
|
|
1668
2794
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1669
2795
|
CREATED = "CREATED",
|
|
@@ -1672,11 +2798,16 @@ declare enum WithdrawalRequestStatus {
|
|
|
1672
2798
|
SUCCESSFUL = "SUCCESSFUL"
|
|
1673
2799
|
}
|
|
1674
2800
|
|
|
1675
|
-
/**
|
|
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
|
+
*/
|
|
1676
2807
|
interface ChannelClosingTransaction {
|
|
1677
2808
|
/**
|
|
1678
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1679
|
-
* string.
|
|
2809
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2810
|
+
* Should be treated as an opaque string.
|
|
1680
2811
|
**/
|
|
1681
2812
|
id: string;
|
|
1682
2813
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1688,8 +2819,8 @@ interface ChannelClosingTransaction {
|
|
|
1688
2819
|
/** The amount of money involved in this transaction. **/
|
|
1689
2820
|
amount: CurrencyAmount;
|
|
1690
2821
|
/**
|
|
1691
|
-
* The height of the block that included this transaction.
|
|
1692
|
-
* transactions.
|
|
2822
|
+
* The height of the block that included this transaction.
|
|
2823
|
+
* This will be zero for unconfirmed transactions.
|
|
1693
2824
|
**/
|
|
1694
2825
|
blockHeight: number;
|
|
1695
2826
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -1698,19 +2829,25 @@ interface ChannelClosingTransaction {
|
|
|
1698
2829
|
typename: string;
|
|
1699
2830
|
/** The date and time when this transaction was completed or failed. **/
|
|
1700
2831
|
resolvedAt?: string | undefined;
|
|
1701
|
-
/**
|
|
2832
|
+
/**
|
|
2833
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2834
|
+
* Lightning Network. *
|
|
2835
|
+
*/
|
|
1702
2836
|
transactionHash?: string | undefined;
|
|
1703
2837
|
/**
|
|
1704
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
1705
|
-
* blockchain.
|
|
2838
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2839
|
+
* to the Bitcoin blockchain.
|
|
1706
2840
|
**/
|
|
1707
2841
|
fees?: CurrencyAmount | undefined;
|
|
1708
2842
|
/**
|
|
1709
|
-
* The hash of the block that included this transaction.
|
|
1710
|
-
* transactions.
|
|
2843
|
+
* The hash of the block that included this transaction.
|
|
2844
|
+
* This will be null for unconfirmed transactions.
|
|
1711
2845
|
**/
|
|
1712
2846
|
blockHash?: string | undefined;
|
|
1713
|
-
/**
|
|
2847
|
+
/**
|
|
2848
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
2849
|
+
* *
|
|
2850
|
+
*/
|
|
1714
2851
|
numConfirmations?: number | undefined;
|
|
1715
2852
|
/** If known, the channel this transaction is closing. **/
|
|
1716
2853
|
channelId?: string | undefined;
|
|
@@ -1718,22 +2855,34 @@ interface ChannelClosingTransaction {
|
|
|
1718
2855
|
declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
|
|
1719
2856
|
|
|
1720
2857
|
interface WithdrawalRequestToChannelClosingTransactionsConnection {
|
|
1721
|
-
/**
|
|
2858
|
+
/**
|
|
2859
|
+
* An object that holds pagination information about the objects in this
|
|
2860
|
+
* connection. *
|
|
2861
|
+
*/
|
|
1722
2862
|
pageInfo: PageInfo;
|
|
1723
2863
|
/**
|
|
1724
|
-
* The total count of objects in this connection, using the current filters.
|
|
1725
|
-
* 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).
|
|
1726
2867
|
**/
|
|
1727
2868
|
count: number;
|
|
1728
|
-
/**
|
|
2869
|
+
/**
|
|
2870
|
+
* The channel closing transactions for the current page of this connection.
|
|
2871
|
+
* *
|
|
2872
|
+
*/
|
|
1729
2873
|
entities: ChannelClosingTransaction[];
|
|
1730
2874
|
}
|
|
1731
2875
|
|
|
1732
|
-
/**
|
|
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
|
+
*/
|
|
1733
2882
|
interface ChannelOpeningTransaction {
|
|
1734
2883
|
/**
|
|
1735
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1736
|
-
* string.
|
|
2884
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2885
|
+
* Should be treated as an opaque string.
|
|
1737
2886
|
**/
|
|
1738
2887
|
id: string;
|
|
1739
2888
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -1745,8 +2894,8 @@ interface ChannelOpeningTransaction {
|
|
|
1745
2894
|
/** The amount of money involved in this transaction. **/
|
|
1746
2895
|
amount: CurrencyAmount;
|
|
1747
2896
|
/**
|
|
1748
|
-
* The height of the block that included this transaction.
|
|
1749
|
-
* transactions.
|
|
2897
|
+
* The height of the block that included this transaction.
|
|
2898
|
+
* This will be zero for unconfirmed transactions.
|
|
1750
2899
|
**/
|
|
1751
2900
|
blockHeight: number;
|
|
1752
2901
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -1755,19 +2904,25 @@ interface ChannelOpeningTransaction {
|
|
|
1755
2904
|
typename: string;
|
|
1756
2905
|
/** The date and time when this transaction was completed or failed. **/
|
|
1757
2906
|
resolvedAt?: string | undefined;
|
|
1758
|
-
/**
|
|
2907
|
+
/**
|
|
2908
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
2909
|
+
* Lightning Network. *
|
|
2910
|
+
*/
|
|
1759
2911
|
transactionHash?: string | undefined;
|
|
1760
2912
|
/**
|
|
1761
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
1762
|
-
* blockchain.
|
|
2913
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2914
|
+
* to the Bitcoin blockchain.
|
|
1763
2915
|
**/
|
|
1764
2916
|
fees?: CurrencyAmount | undefined;
|
|
1765
2917
|
/**
|
|
1766
|
-
* The hash of the block that included this transaction.
|
|
1767
|
-
* transactions.
|
|
2918
|
+
* The hash of the block that included this transaction.
|
|
2919
|
+
* This will be null for unconfirmed transactions.
|
|
1768
2920
|
**/
|
|
1769
2921
|
blockHash?: string | undefined;
|
|
1770
|
-
/**
|
|
2922
|
+
/**
|
|
2923
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
2924
|
+
* *
|
|
2925
|
+
*/
|
|
1771
2926
|
numConfirmations?: number | undefined;
|
|
1772
2927
|
/** If known, the channel this transaction is opening. **/
|
|
1773
2928
|
channelId?: string | undefined;
|
|
@@ -1775,22 +2930,35 @@ interface ChannelOpeningTransaction {
|
|
|
1775
2930
|
declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
|
|
1776
2931
|
|
|
1777
2932
|
interface WithdrawalRequestToChannelOpeningTransactionsConnection {
|
|
1778
|
-
/**
|
|
2933
|
+
/**
|
|
2934
|
+
* An object that holds pagination information about the objects in this
|
|
2935
|
+
* connection. *
|
|
2936
|
+
*/
|
|
1779
2937
|
pageInfo: PageInfo;
|
|
1780
2938
|
/**
|
|
1781
|
-
* The total count of objects in this connection, using the current filters.
|
|
1782
|
-
* 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).
|
|
1783
2942
|
**/
|
|
1784
2943
|
count: number;
|
|
1785
|
-
/**
|
|
2944
|
+
/**
|
|
2945
|
+
* The channel opening transactions for the current page of this connection.
|
|
2946
|
+
* *
|
|
2947
|
+
*/
|
|
1786
2948
|
entities: ChannelOpeningTransaction[];
|
|
1787
2949
|
}
|
|
1788
2950
|
|
|
1789
|
-
/**
|
|
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
|
+
*/
|
|
1790
2958
|
declare class WithdrawalRequest implements Entity {
|
|
1791
2959
|
/**
|
|
1792
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1793
|
-
* string.
|
|
2960
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2961
|
+
* Should be treated as an opaque string.
|
|
1794
2962
|
**/
|
|
1795
2963
|
readonly id: string;
|
|
1796
2964
|
/** The date and time when the entity was first created. **/
|
|
@@ -1801,15 +2969,18 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1801
2969
|
readonly amount: CurrencyAmount;
|
|
1802
2970
|
/** The bitcoin address where the funds should be sent. **/
|
|
1803
2971
|
readonly bitcoinAddress: string;
|
|
1804
|
-
/**
|
|
2972
|
+
/**
|
|
2973
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
2974
|
+
* *
|
|
2975
|
+
*/
|
|
1805
2976
|
readonly withdrawalMode: WithdrawalMode;
|
|
1806
2977
|
/** The current status of this withdrawal request. **/
|
|
1807
2978
|
readonly status: WithdrawalRequestStatus;
|
|
1808
2979
|
/** The typename of the object **/
|
|
1809
2980
|
readonly typename: string;
|
|
1810
2981
|
/**
|
|
1811
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
1812
|
-
* 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.
|
|
1813
2984
|
**/
|
|
1814
2985
|
readonly estimatedAmount?: CurrencyAmount | undefined;
|
|
1815
2986
|
/** The time at which this request was completed. **/
|
|
@@ -1818,8 +2989,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1818
2989
|
readonly withdrawalId?: string | undefined;
|
|
1819
2990
|
constructor(
|
|
1820
2991
|
/**
|
|
1821
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
1822
|
-
* string.
|
|
2992
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
2993
|
+
* Should be treated as an opaque string.
|
|
1823
2994
|
**/
|
|
1824
2995
|
id: string,
|
|
1825
2996
|
/** The date and time when the entity was first created. **/
|
|
@@ -1830,15 +3001,18 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1830
3001
|
amount: CurrencyAmount,
|
|
1831
3002
|
/** The bitcoin address where the funds should be sent. **/
|
|
1832
3003
|
bitcoinAddress: string,
|
|
1833
|
-
/**
|
|
3004
|
+
/**
|
|
3005
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
3006
|
+
* *
|
|
3007
|
+
*/
|
|
1834
3008
|
withdrawalMode: WithdrawalMode,
|
|
1835
3009
|
/** The current status of this withdrawal request. **/
|
|
1836
3010
|
status: WithdrawalRequestStatus,
|
|
1837
3011
|
/** The typename of the object **/
|
|
1838
3012
|
typename: string,
|
|
1839
3013
|
/**
|
|
1840
|
-
* If the requested amount is `-1` (i.e. everything),
|
|
1841
|
-
* 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.
|
|
1842
3016
|
**/
|
|
1843
3017
|
estimatedAmount?: CurrencyAmount | undefined,
|
|
1844
3018
|
/** The time at which this request was completed. **/
|
|
@@ -1866,28 +3040,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1866
3040
|
}
|
|
1867
3041
|
|
|
1868
3042
|
/**
|
|
1869
|
-
*
|
|
1870
|
-
|
|
1871
|
-
type SigningKeyLoaderArgs = NodeIdAndPasswordSigningKeyLoaderArgs | MasterSeedSigningKeyLoaderArgs;
|
|
1872
|
-
/**
|
|
1873
|
-
* Args for creating a new SigningKeyLoader from a node ID and password.
|
|
1874
|
-
* This cannot be used if you are using remote signing. It is used to recover an RSA operation signing key using
|
|
1875
|
-
* the password you chose when setting up your node. For REGTEST nodes, the password is "1234!@#$".
|
|
1876
|
-
*/
|
|
1877
|
-
interface NodeIdAndPasswordSigningKeyLoaderArgs {
|
|
1878
|
-
password: string;
|
|
1879
|
-
}
|
|
1880
|
-
/**
|
|
1881
|
-
* Args for creating a new SigningKeyLoader from a master seed and network.
|
|
1882
|
-
* This should be used if you are using remote signing, rather than an RSA operation signing key.
|
|
1883
|
-
*/
|
|
1884
|
-
interface MasterSeedSigningKeyLoaderArgs {
|
|
1885
|
-
masterSeed: Uint8Array;
|
|
1886
|
-
network: BitcoinNetwork;
|
|
1887
|
-
}
|
|
1888
|
-
|
|
1889
|
-
/**
|
|
1890
|
-
* 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.
|
|
1891
3045
|
*
|
|
1892
3046
|
* ```ts
|
|
1893
3047
|
* const lightsparkClient = new LightsparkClient(
|
|
@@ -1925,27 +3079,32 @@ declare class LightsparkClient {
|
|
|
1925
3079
|
* use, you should use the `AccountTokenAuthProvider`.
|
|
1926
3080
|
* @param serverUrl The base URL of the server to connect to. Defaults to lightspark production.
|
|
1927
3081
|
* @param cryptoImpl The crypto implementation to use. Defaults to web and node compatible crypto.
|
|
1928
|
-
* For React Native, you should use the `ReactNativeCrypto`
|
|
3082
|
+
* For React Native, you should use the `ReactNativeCrypto`
|
|
3083
|
+
* implementation from `@lightsparkdev/react-native`.
|
|
1929
3084
|
*/
|
|
1930
3085
|
constructor(authProvider?: AuthProvider, serverUrl?: string, cryptoImpl?: CryptoInterface);
|
|
1931
3086
|
/**
|
|
1932
|
-
* Sets the key loader for a node. This unlocks client operations that
|
|
1933
|
-
* Passing in [NodeIdAndPasswordSigningKeyLoaderArgs]
|
|
1934
|
-
*
|
|
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.
|
|
1935
3092
|
*
|
|
1936
3093
|
* @param nodeId The ID of the node the key is for
|
|
1937
3094
|
* @param loader The loader for the key
|
|
1938
3095
|
*/
|
|
1939
3096
|
loadNodeSigningKey(nodeId: string, loaderArgs: SigningKeyLoaderArgs): Promise<boolean>;
|
|
1940
3097
|
/**
|
|
1941
|
-
* 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].
|
|
1942
3100
|
*
|
|
1943
3101
|
* @param nodeId The ID of the node the key is for
|
|
1944
3102
|
* @returns The signing key for the node
|
|
1945
3103
|
*/
|
|
1946
3104
|
getNodeSigningKey(nodeId: string): Promise<SigningKey | undefined>;
|
|
1947
3105
|
/**
|
|
1948
|
-
* 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
|
|
1949
3108
|
* multiple accounts or waiting for the user to log in.
|
|
1950
3109
|
*
|
|
1951
3110
|
* @param authProvider
|
|
@@ -1981,15 +3140,16 @@ declare class LightsparkClient {
|
|
|
1981
3140
|
*/
|
|
1982
3141
|
getRecentPaymentRequests(nodeId: string, numTransactions?: number, bitcoinNetwork?: BitcoinNetwork, afterDate?: Maybe<string>): Promise<Transaction[]>;
|
|
1983
3142
|
/**
|
|
1984
|
-
* 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.
|
|
1985
3145
|
*
|
|
1986
3146
|
* @param nodeIds The node IDs for which to listen to transactions.
|
|
1987
3147
|
* @returns A zen-observable that emits transaction updates for the given node IDs.
|
|
1988
3148
|
*/
|
|
1989
3149
|
listenToTransactions(nodeIds: string[]): Observable<TransactionUpdate | undefined>;
|
|
1990
3150
|
/**
|
|
1991
|
-
* Retrieves a dashboard of basic info for the authenticated account.
|
|
1992
|
-
* included.
|
|
3151
|
+
* Retrieves a dashboard of basic info for the authenticated account.
|
|
3152
|
+
* See `AccountDashboard` for which info is included.
|
|
1993
3153
|
*
|
|
1994
3154
|
* @param nodeIds The node IDs to include in the dashboard. Defaults to undefined (all nodes).
|
|
1995
3155
|
* @param bitcoinNetwork The bitcoin network to include in the dashboard. Defaults to MAINNET.
|
|
@@ -1998,8 +3158,8 @@ declare class LightsparkClient {
|
|
|
1998
3158
|
*/
|
|
1999
3159
|
getAccountDashboard(nodeIds?: string[] | undefined, bitcoinNetwork?: BitcoinNetwork): Promise<AccountDashboard>;
|
|
2000
3160
|
/**
|
|
2001
|
-
* Gets a basic dashboard for a single node, including recent transactions.
|
|
2002
|
-
* included.
|
|
3161
|
+
* Gets a basic dashboard for a single node, including recent transactions.
|
|
3162
|
+
* See `SingleNodeDashboard` for which info is included.
|
|
2003
3163
|
*
|
|
2004
3164
|
* @param nodeId The node ID for which to get a dashboard.
|
|
2005
3165
|
* @param bitcoinNetwork The bitcoin network for which to get a dashboard. Defaults to MAINNET.
|
|
@@ -2011,7 +3171,8 @@ declare class LightsparkClient {
|
|
|
2011
3171
|
/**
|
|
2012
3172
|
* Creates an invoice for the given node.
|
|
2013
3173
|
*
|
|
2014
|
-
* 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].
|
|
2015
3176
|
*
|
|
2016
3177
|
* @param nodeId The node ID for which to create an invoice.
|
|
2017
3178
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2024,11 +3185,13 @@ declare class LightsparkClient {
|
|
|
2024
3185
|
*/
|
|
2025
3186
|
createInvoice(nodeId: string, amountMsats: number, memo: string, type?: InvoiceType | undefined, expirySecs?: number | undefined): Promise<string | undefined>;
|
|
2026
3187
|
/**
|
|
2027
|
-
* Generates a Lightning Invoice (follows the Bolt 11 specification) to
|
|
2028
|
-
* 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,
|
|
2029
3191
|
* with [createInvoice] preferred in the general case.
|
|
2030
3192
|
*
|
|
2031
|
-
* 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].
|
|
2032
3195
|
*
|
|
2033
3196
|
* @param nodeId The node ID for which to create an invoice.
|
|
2034
3197
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2040,10 +3203,12 @@ declare class LightsparkClient {
|
|
|
2040
3203
|
*/
|
|
2041
3204
|
createLnurlInvoice(nodeId: string, amountMsats: number, metadata: string, expirySecs?: number | undefined): Promise<Invoice | undefined>;
|
|
2042
3205
|
/**
|
|
2043
|
-
* Creates a new invoice for the UMA protocol.
|
|
2044
|
-
*
|
|
2045
|
-
*
|
|
2046
|
-
*
|
|
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.
|
|
2047
3212
|
*
|
|
2048
3213
|
* @param nodeId The node ID for which to create an invoice.
|
|
2049
3214
|
* @param amountMsats The amount of the invoice in msats. You can create a zero-amount invoice to accept any payment amount.
|
|
@@ -2062,7 +3227,8 @@ declare class LightsparkClient {
|
|
|
2062
3227
|
*/
|
|
2063
3228
|
decodeInvoice(encodedInvoice: string): Promise<InvoiceData>;
|
|
2064
3229
|
/**
|
|
2065
|
-
* 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.
|
|
2066
3232
|
*
|
|
2067
3233
|
* @param bitcoinNetwork The bitcoin network for which to get a fee estimate. Defaults to MAINNET.
|
|
2068
3234
|
* @returns A fee estimate for the given bitcoin network including a minimum fee rate, and a max-speed fee rate.
|
|
@@ -2079,7 +3245,8 @@ declare class LightsparkClient {
|
|
|
2079
3245
|
*/
|
|
2080
3246
|
getLightningFeeEstimateForInvoice(nodeId: string, encodedPaymentRequest: string, amountMsats?: number | undefined): Promise<CurrencyAmount>;
|
|
2081
3247
|
/**
|
|
2082
|
-
* 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.
|
|
2083
3250
|
*
|
|
2084
3251
|
* @param nodeId The node from where you want to send the payment.
|
|
2085
3252
|
* @param destinationNodePublicKey The public key of the node that you want to pay.
|
|
@@ -2097,70 +3264,86 @@ declare class LightsparkClient {
|
|
|
2097
3264
|
/**
|
|
2098
3265
|
* Sends a lightning payment for a given invoice.
|
|
2099
3266
|
*
|
|
2100
|
-
* Test mode note: For test mode, you can use the [createTestModeInvoice]
|
|
2101
|
-
* 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.
|
|
2102
3269
|
*
|
|
2103
3270
|
* @param payerNodeId The ID of the node that will pay the invoice.
|
|
2104
3271
|
* @param encodedInvoice The encoded invoice to pay.
|
|
2105
3272
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2106
|
-
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2107
|
-
*
|
|
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.
|
|
2108
3277
|
* @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
|
|
2109
3278
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
2110
|
-
* 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.
|
|
2111
3281
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2112
3282
|
*/
|
|
2113
3283
|
payInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
2114
3284
|
/**
|
|
2115
|
-
* sends an UMA payment to a node on the Lightning Network,
|
|
2116
|
-
* (as defined by the BOLT11 specification) that you
|
|
2117
|
-
*
|
|
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.
|
|
2118
3290
|
*
|
|
2119
3291
|
* @param payerNodeId The ID of the node that will pay the invoice.
|
|
2120
3292
|
* @param encodedInvoice The encoded invoice to pay.
|
|
2121
3293
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2122
|
-
* As guidance, a maximum fee of 16 basis points should make almost all
|
|
2123
|
-
*
|
|
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.
|
|
2124
3298
|
* @param timeoutSecs A timeout for the payment in seconds. Defaults to 60 seconds.
|
|
2125
3299
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
2126
|
-
* 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.
|
|
2127
3302
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2128
3303
|
*/
|
|
2129
3304
|
payUmaInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
2130
3305
|
/**
|
|
2131
|
-
* 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.
|
|
2132
3308
|
*
|
|
2133
3309
|
* @param transactionId The ID of the transaction to wait for
|
|
2134
3310
|
* @param pollTimeoutSecs The timeout in seconds that we will wait before throwing an exception
|
|
2135
3311
|
*/
|
|
2136
3312
|
waitForTransactionComplete<T = Transaction>(transactionId: string, pollTimeoutSecs?: number): Promise<T>;
|
|
2137
3313
|
/**
|
|
2138
|
-
* 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.
|
|
2139
3316
|
*
|
|
2140
3317
|
* @param payerNodeId The ID of the node that will send the payment.
|
|
2141
3318
|
* @param destinationPublicKey The public key of the destination node.
|
|
2142
3319
|
* @param timeoutSecs The timeout in seconds that we will try to make the payment.
|
|
2143
3320
|
* @param amountMsats The amount to pay in msats.
|
|
2144
3321
|
* @param maximumFeesMsats Maximum fees (in msats) to pay for the payment. This parameter is required.
|
|
2145
|
-
* As guidance, a maximum fee of 15 basis points should make almost all
|
|
2146
|
-
*
|
|
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.
|
|
2147
3326
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
2148
3327
|
*/
|
|
2149
3328
|
sendPayment(payerNodeId: string, destinationPublicKey: string, timeoutSecs: number | undefined, amountMsats: number, maximumFeesMsats: number): Promise<OutgoingPayment | undefined>;
|
|
2150
3329
|
/**
|
|
2151
|
-
* 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.
|
|
2152
3332
|
*
|
|
2153
3333
|
* @param nodeId The ID of the node to create a wallet address for.
|
|
2154
3334
|
* @returns A string containing the wallet address for the given node.
|
|
2155
3335
|
*/
|
|
2156
3336
|
createNodeWalletAddress(nodeId: string): Promise<string>;
|
|
2157
3337
|
/**
|
|
2158
|
-
* 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.
|
|
2159
3340
|
*
|
|
2160
|
-
* Depending on the chosen mode, it will first take the funds from the
|
|
2161
|
-
*
|
|
2162
|
-
*
|
|
2163
|
-
*
|
|
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.
|
|
2164
3347
|
*
|
|
2165
3348
|
* @param nodeId The ID of the node from which to withdraw funds.
|
|
2166
3349
|
* @param amountSats The amount of funds to withdraw in satoshis.
|
|
@@ -2169,9 +3352,10 @@ declare class LightsparkClient {
|
|
|
2169
3352
|
*/
|
|
2170
3353
|
requestWithdrawal(nodeId: string, amountSats: number, bitcoinAddress: string, mode: WithdrawalMode): Promise<WithdrawalRequest>;
|
|
2171
3354
|
/**
|
|
2172
|
-
* Adds funds to a Lightspark node on the REGTEST network.
|
|
2173
|
-
*
|
|
2174
|
-
*
|
|
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.
|
|
2175
3359
|
*
|
|
2176
3360
|
* @param nodeId The ID of the node to fund. Must be a REGTEST node.
|
|
2177
3361
|
* @param amountSats The amount of funds to add to the node in satoshis. Defaults to 10,000,000 SATOSHI.
|
|
@@ -2179,8 +3363,8 @@ declare class LightsparkClient {
|
|
|
2179
3363
|
*/
|
|
2180
3364
|
fundNode(nodeId: string, amountSats?: number | undefined): Promise<CurrencyAmount>;
|
|
2181
3365
|
/**
|
|
2182
|
-
* Creates a new API token that can be used to authenticate requests for this
|
|
2183
|
-
* 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.
|
|
2184
3368
|
*
|
|
2185
3369
|
* @param name Creates a new API token that can be used to authenticate requests for this account when using the
|
|
2186
3370
|
* Lightspark APIs and SDKs.
|
|
@@ -2196,8 +3380,9 @@ declare class LightsparkClient {
|
|
|
2196
3380
|
*/
|
|
2197
3381
|
deleteApiToken(id: string): Promise<void>;
|
|
2198
3382
|
/**
|
|
2199
|
-
* In test mode, generates a Lightning Invoice which can be paid by a local
|
|
2200
|
-
* 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].
|
|
2201
3386
|
*
|
|
2202
3387
|
* @param localNodeId The ID of the node that will pay the invoice.
|
|
2203
3388
|
* @param amountMsats The amount to pay in milli-satoshis.
|
|
@@ -2206,8 +3391,9 @@ declare class LightsparkClient {
|
|
|
2206
3391
|
*/
|
|
2207
3392
|
createTestModeInvoice(localNodeId: string, amountMsats: number, memo?: string | undefined, invoiceType?: InvoiceType): Promise<string | null>;
|
|
2208
3393
|
/**
|
|
2209
|
-
* In test mode, simulates a payment of a Lightning Invoice from another
|
|
2210
|
-
* 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].
|
|
2211
3397
|
*
|
|
2212
3398
|
* @param localNodeId The ID of the node that will receive the payment.
|
|
2213
3399
|
* @param encodedInvoice The encoded invoice to pay.
|
|
@@ -2215,10 +3401,54 @@ declare class LightsparkClient {
|
|
|
2215
3401
|
* amount invoices.
|
|
2216
3402
|
*/
|
|
2217
3403
|
createTestModePayment(localNodeId: string, encodedInvoice: string, amountMsats?: number | undefined): Promise<IncomingPayment | null>;
|
|
3404
|
+
/**
|
|
3405
|
+
* Creates an UMA invitation. If you are part of the incentive program,
|
|
3406
|
+
* you should use [createUmaInvitationWithIncentives].
|
|
3407
|
+
*
|
|
3408
|
+
* @param inviterUma The UMA of the inviter.
|
|
3409
|
+
* @returns The invitation that was created.
|
|
3410
|
+
*/
|
|
3411
|
+
createUmaInvitation(inviterUma: string): Promise<UmaInvitation | null>;
|
|
3412
|
+
/**
|
|
3413
|
+
* Creates an UMA invitation as part of the incentive program.
|
|
3414
|
+
* @param inviterUma The UMA of the inviter.
|
|
3415
|
+
* @param inviterPhoneNumber The phone number of the inviter in E164 format.
|
|
3416
|
+
* @param inviterRegion The region of the inviter.
|
|
3417
|
+
* @returns The invitation that was created.
|
|
3418
|
+
*/
|
|
3419
|
+
createUmaInvitationWithIncentives(inviterUma: string, inviterPhoneNumber: string, inviterRegion: RegionCode): Promise<UmaInvitation | null>;
|
|
3420
|
+
/**
|
|
3421
|
+
* Claims an UMA invitation. If you are part of the incentive program,
|
|
3422
|
+
* you should use [claimUmaInvitationWithIncentives].
|
|
3423
|
+
*
|
|
3424
|
+
* @param invitationCode The invitation code to claim.
|
|
3425
|
+
* @param inviteeUma The UMA of the invitee.
|
|
3426
|
+
* @returns The invitation that was claimed.
|
|
3427
|
+
*/
|
|
3428
|
+
claimUmaInvitation(invitationCode: string, inviteeUma: string): Promise<UmaInvitation | null>;
|
|
3429
|
+
/**
|
|
3430
|
+
* Claims an UMA invitation as part of the incentive program.
|
|
3431
|
+
*
|
|
3432
|
+
* @param invitationCode The invitation code to claim.
|
|
3433
|
+
* @param inviteeUma The UMA of the invitee.
|
|
3434
|
+
* @param inviteePhoneNumber The phone number of the invitee in E164 format.
|
|
3435
|
+
* @param inviteeRegion The region of the invitee.
|
|
3436
|
+
* @returns The invitation that was claimed.
|
|
3437
|
+
*/
|
|
3438
|
+
claimUmaInvitationWithIncentives(invitationCode: string, inviteeUma: string, inviteePhoneNumber: string, inviteeRegion: RegionCode): Promise<UmaInvitation | null>;
|
|
3439
|
+
/**
|
|
3440
|
+
* Fetches an UMA invitation by its invitation code.
|
|
3441
|
+
*
|
|
3442
|
+
* @param invitationCode The code of the invitation to fetch.
|
|
3443
|
+
* @returns The invitation with the given code, or null if no invitation exists with that code.
|
|
3444
|
+
*/
|
|
3445
|
+
fetchUmaInvitation(invitationCode: string): Promise<UmaInvitation | null>;
|
|
3446
|
+
private hashPhoneNumber;
|
|
2218
3447
|
/**
|
|
2219
3448
|
* Executes a raw `Query` against the Lightspark API.
|
|
2220
3449
|
*
|
|
2221
|
-
* 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
|
|
2222
3452
|
* complex fields from objects.
|
|
2223
3453
|
*
|
|
2224
3454
|
* @param query The `Query` to execute.
|
|
@@ -2227,11 +3457,32 @@ declare class LightsparkClient {
|
|
|
2227
3457
|
executeRawQuery<T>(query: Query<T>): Promise<T | null>;
|
|
2228
3458
|
}
|
|
2229
3459
|
|
|
3460
|
+
interface ClaimUmaInvitationInput {
|
|
3461
|
+
invitationCode: string;
|
|
3462
|
+
inviteeUma: string;
|
|
3463
|
+
}
|
|
3464
|
+
|
|
3465
|
+
interface ClaimUmaInvitationOutput {
|
|
3466
|
+
invitationId: string;
|
|
3467
|
+
}
|
|
3468
|
+
|
|
3469
|
+
interface ClaimUmaInvitationWithIncentivesInput {
|
|
3470
|
+
invitationCode: string;
|
|
3471
|
+
inviteeUma: string;
|
|
3472
|
+
inviteePhoneHash: string;
|
|
3473
|
+
inviteeRegion: RegionCode;
|
|
3474
|
+
}
|
|
3475
|
+
|
|
3476
|
+
interface ClaimUmaInvitationWithIncentivesOutput {
|
|
3477
|
+
invitationId: string;
|
|
3478
|
+
}
|
|
3479
|
+
|
|
2230
3480
|
/** This is an enum identifying a type of compliance provider. **/
|
|
2231
3481
|
declare enum ComplianceProvider {
|
|
2232
3482
|
/**
|
|
2233
|
-
* This is an enum value that represents values that could be added in the
|
|
2234
|
-
* 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.
|
|
2235
3486
|
*/
|
|
2236
3487
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2237
3488
|
CHAINALYSIS = "CHAINALYSIS"
|
|
@@ -2239,23 +3490,40 @@ declare enum ComplianceProvider {
|
|
|
2239
3490
|
|
|
2240
3491
|
interface Connection {
|
|
2241
3492
|
/**
|
|
2242
|
-
* The total count of objects in this connection, using the current filters.
|
|
2243
|
-
* 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).
|
|
2244
3496
|
**/
|
|
2245
3497
|
count: number;
|
|
2246
|
-
/**
|
|
3498
|
+
/**
|
|
3499
|
+
* An object that holds pagination information about the objects in this
|
|
3500
|
+
* connection. *
|
|
3501
|
+
*/
|
|
2247
3502
|
pageInfo: PageInfo;
|
|
2248
3503
|
/** The typename of the object **/
|
|
2249
3504
|
typename: string;
|
|
2250
3505
|
}
|
|
2251
3506
|
|
|
2252
3507
|
interface CreateApiTokenInput {
|
|
2253
|
-
/**
|
|
3508
|
+
/**
|
|
3509
|
+
* An arbitrary name that the user can choose to identify the API token in a
|
|
3510
|
+
* list. *
|
|
3511
|
+
*/
|
|
2254
3512
|
name: string;
|
|
2255
3513
|
/** List of permissions to grant to the API token **/
|
|
2256
3514
|
permissions: Permission[];
|
|
2257
3515
|
}
|
|
2258
3516
|
|
|
3517
|
+
interface CreateInvitationWithIncentivesInput {
|
|
3518
|
+
inviterUma: string;
|
|
3519
|
+
inviterPhoneHash: string;
|
|
3520
|
+
inviterRegion: RegionCode;
|
|
3521
|
+
}
|
|
3522
|
+
|
|
3523
|
+
interface CreateInvitationWithIncentivesOutput {
|
|
3524
|
+
invitationId: string;
|
|
3525
|
+
}
|
|
3526
|
+
|
|
2259
3527
|
interface CreateInvoiceInput {
|
|
2260
3528
|
/** The node from which to create the invoice. **/
|
|
2261
3529
|
nodeId: string;
|
|
@@ -2277,8 +3545,9 @@ interface CreateLnurlInvoiceInput {
|
|
|
2277
3545
|
/** The amount for which the invoice should be created, in millisatoshis. **/
|
|
2278
3546
|
amountMsats: number;
|
|
2279
3547
|
/**
|
|
2280
|
-
* The SHA256 hash of the LNURL metadata payload.
|
|
2281
|
-
*
|
|
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.
|
|
2282
3551
|
**/
|
|
2283
3552
|
metadataHash: string;
|
|
2284
3553
|
/** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
|
|
@@ -2311,13 +3580,17 @@ interface CreateTestModePaymentInput {
|
|
|
2311
3580
|
/** The invoice you want to be paid (as defined by the BOLT11 standard). **/
|
|
2312
3581
|
encodedInvoice: string;
|
|
2313
3582
|
/**
|
|
2314
|
-
* The amount you will be paid for this invoice, expressed in msats.
|
|
2315
|
-
* 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.
|
|
2316
3585
|
**/
|
|
2317
3586
|
amountMsats?: number | undefined;
|
|
2318
3587
|
}
|
|
2319
3588
|
|
|
2320
|
-
/**
|
|
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
|
+
*/
|
|
2321
3594
|
interface CreateTestModePaymentoutput {
|
|
2322
3595
|
/**
|
|
2323
3596
|
* The payment that has been sent.
|
|
@@ -2329,6 +3602,14 @@ interface CreateTestModePaymentoutput {
|
|
|
2329
3602
|
incomingPaymentId: string;
|
|
2330
3603
|
}
|
|
2331
3604
|
|
|
3605
|
+
interface CreateUmaInvitationInput {
|
|
3606
|
+
inviterUma: string;
|
|
3607
|
+
}
|
|
3608
|
+
|
|
3609
|
+
interface CreateUmaInvitationOutput {
|
|
3610
|
+
invitationId: string;
|
|
3611
|
+
}
|
|
3612
|
+
|
|
2332
3613
|
interface CreateUmaInvoiceInput {
|
|
2333
3614
|
nodeId: string;
|
|
2334
3615
|
amountMsats: number;
|
|
@@ -2343,8 +3624,9 @@ interface DeclineToSignMessagesInput {
|
|
|
2343
3624
|
|
|
2344
3625
|
declare enum SignablePayloadStatus {
|
|
2345
3626
|
/**
|
|
2346
|
-
* This is an enum value that represents values that could be added in the
|
|
2347
|
-
* 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.
|
|
2348
3630
|
*/
|
|
2349
3631
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
2350
3632
|
CREATED = "CREATED",
|
|
@@ -2355,8 +3637,8 @@ declare enum SignablePayloadStatus {
|
|
|
2355
3637
|
|
|
2356
3638
|
interface SignablePayload {
|
|
2357
3639
|
/**
|
|
2358
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2359
|
-
* string.
|
|
3640
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3641
|
+
* Should be treated as an opaque string.
|
|
2360
3642
|
**/
|
|
2361
3643
|
id: string;
|
|
2362
3644
|
/** The date and time when the entity was first created. **/
|
|
@@ -2365,7 +3647,10 @@ interface SignablePayload {
|
|
|
2365
3647
|
updatedAt: string;
|
|
2366
3648
|
/** The payload that needs to be signed. **/
|
|
2367
3649
|
payload: string;
|
|
2368
|
-
/**
|
|
3650
|
+
/**
|
|
3651
|
+
* The consistent method for generating the same set of accounts and wallets
|
|
3652
|
+
* for a given private key *
|
|
3653
|
+
*/
|
|
2369
3654
|
derivationPath: string;
|
|
2370
3655
|
/** The status of the payload. **/
|
|
2371
3656
|
status: SignablePayloadStatus;
|
|
@@ -2392,11 +3677,16 @@ interface DeleteApiTokenOutput {
|
|
|
2392
3677
|
accountId: string;
|
|
2393
3678
|
}
|
|
2394
3679
|
|
|
2395
|
-
/**
|
|
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
|
+
*/
|
|
2396
3686
|
interface Deposit {
|
|
2397
3687
|
/**
|
|
2398
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2399
|
-
* string.
|
|
3688
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3689
|
+
* Should be treated as an opaque string.
|
|
2400
3690
|
**/
|
|
2401
3691
|
id: string;
|
|
2402
3692
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2408,8 +3698,8 @@ interface Deposit {
|
|
|
2408
3698
|
/** The amount of money involved in this transaction. **/
|
|
2409
3699
|
amount: CurrencyAmount;
|
|
2410
3700
|
/**
|
|
2411
|
-
* The height of the block that included this transaction.
|
|
2412
|
-
* transactions.
|
|
3701
|
+
* The height of the block that included this transaction.
|
|
3702
|
+
* This will be zero for unconfirmed transactions.
|
|
2413
3703
|
**/
|
|
2414
3704
|
blockHeight: number;
|
|
2415
3705
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -2420,19 +3710,25 @@ interface Deposit {
|
|
|
2420
3710
|
typename: string;
|
|
2421
3711
|
/** The date and time when this transaction was completed or failed. **/
|
|
2422
3712
|
resolvedAt?: string | undefined;
|
|
2423
|
-
/**
|
|
3713
|
+
/**
|
|
3714
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
3715
|
+
* Lightning Network. *
|
|
3716
|
+
*/
|
|
2424
3717
|
transactionHash?: string | undefined;
|
|
2425
3718
|
/**
|
|
2426
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2427
|
-
* blockchain.
|
|
3719
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
3720
|
+
* to the Bitcoin blockchain.
|
|
2428
3721
|
**/
|
|
2429
3722
|
fees?: CurrencyAmount | undefined;
|
|
2430
3723
|
/**
|
|
2431
|
-
* The hash of the block that included this transaction.
|
|
2432
|
-
* transactions.
|
|
3724
|
+
* The hash of the block that included this transaction.
|
|
3725
|
+
* This will be null for unconfirmed transactions.
|
|
2433
3726
|
**/
|
|
2434
3727
|
blockHash?: string | undefined;
|
|
2435
|
-
/**
|
|
3728
|
+
/**
|
|
3729
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
3730
|
+
* *
|
|
3731
|
+
*/
|
|
2436
3732
|
numConfirmations?: number | undefined;
|
|
2437
3733
|
}
|
|
2438
3734
|
declare const getDepositQuery: (id: string) => Query<Deposit>;
|
|
@@ -2446,11 +3742,17 @@ interface FundNodeOutput {
|
|
|
2446
3742
|
amount: CurrencyAmount;
|
|
2447
3743
|
}
|
|
2448
3744
|
|
|
2449
|
-
/**
|
|
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
|
+
*/
|
|
2450
3752
|
declare class GraphNode implements Node, Entity {
|
|
2451
3753
|
/**
|
|
2452
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2453
|
-
* string.
|
|
3754
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3755
|
+
* Should be treated as an opaque string.
|
|
2454
3756
|
**/
|
|
2455
3757
|
readonly id: string;
|
|
2456
3758
|
/** The date and time when the entity was first created. **/
|
|
@@ -2460,36 +3762,46 @@ declare class GraphNode implements Node, Entity {
|
|
|
2460
3762
|
/** The Bitcoin Network this node is deployed in. **/
|
|
2461
3763
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
2462
3764
|
/**
|
|
2463
|
-
* The name of this node in the network.
|
|
2464
|
-
*
|
|
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.
|
|
2465
3768
|
**/
|
|
2466
3769
|
readonly displayName: string;
|
|
2467
3770
|
/** The typename of the object **/
|
|
2468
3771
|
readonly typename: string;
|
|
2469
3772
|
/**
|
|
2470
|
-
* A name that identifies the node.
|
|
2471
|
-
*
|
|
2472
|
-
*
|
|
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.
|
|
2473
3778
|
**/
|
|
2474
3779
|
readonly alias?: string | undefined;
|
|
2475
3780
|
/**
|
|
2476
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
2477
|
-
* 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.
|
|
2478
3785
|
* That color can be changed at any time by the node operator.
|
|
2479
3786
|
**/
|
|
2480
3787
|
readonly color?: string | undefined;
|
|
2481
3788
|
/**
|
|
2482
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
2483
|
-
*
|
|
2484
|
-
*
|
|
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).
|
|
2485
3794
|
**/
|
|
2486
3795
|
readonly conductivity?: number | undefined;
|
|
2487
|
-
/**
|
|
3796
|
+
/**
|
|
3797
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
3798
|
+
* in the Lightning Network. *
|
|
3799
|
+
*/
|
|
2488
3800
|
readonly publicKey?: string | undefined;
|
|
2489
3801
|
constructor(
|
|
2490
3802
|
/**
|
|
2491
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2492
|
-
* string.
|
|
3803
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3804
|
+
* Should be treated as an opaque string.
|
|
2493
3805
|
**/
|
|
2494
3806
|
id: string,
|
|
2495
3807
|
/** The date and time when the entity was first created. **/
|
|
@@ -2499,31 +3811,41 @@ declare class GraphNode implements Node, Entity {
|
|
|
2499
3811
|
/** The Bitcoin Network this node is deployed in. **/
|
|
2500
3812
|
bitcoinNetwork: BitcoinNetwork,
|
|
2501
3813
|
/**
|
|
2502
|
-
* The name of this node in the network.
|
|
2503
|
-
*
|
|
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.
|
|
2504
3817
|
**/
|
|
2505
3818
|
displayName: string,
|
|
2506
3819
|
/** The typename of the object **/
|
|
2507
3820
|
typename: string,
|
|
2508
3821
|
/**
|
|
2509
|
-
* A name that identifies the node.
|
|
2510
|
-
*
|
|
2511
|
-
*
|
|
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.
|
|
2512
3827
|
**/
|
|
2513
3828
|
alias?: string | undefined,
|
|
2514
3829
|
/**
|
|
2515
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
2516
|
-
* 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.
|
|
2517
3834
|
* That color can be changed at any time by the node operator.
|
|
2518
3835
|
**/
|
|
2519
3836
|
color?: string | undefined,
|
|
2520
3837
|
/**
|
|
2521
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
2522
|
-
*
|
|
2523
|
-
*
|
|
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).
|
|
2524
3843
|
**/
|
|
2525
3844
|
conductivity?: number | undefined,
|
|
2526
|
-
/**
|
|
3845
|
+
/**
|
|
3846
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
3847
|
+
* in the Lightning Network. *
|
|
3848
|
+
*/
|
|
2527
3849
|
publicKey?: string | undefined);
|
|
2528
3850
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
2529
3851
|
static getGraphNodeQuery(id: string): Query<GraphNode>;
|
|
@@ -2554,8 +3876,8 @@ interface LightningFeeEstimateForInvoiceInput {
|
|
|
2554
3876
|
/** The invoice you want to pay (as defined by the BOLT11 standard). **/
|
|
2555
3877
|
encodedPaymentRequest: string;
|
|
2556
3878
|
/**
|
|
2557
|
-
* If the invoice does not specify a payment amount,
|
|
2558
|
-
* in msats.
|
|
3879
|
+
* If the invoice does not specify a payment amount,
|
|
3880
|
+
* then the amount that you wish to pay, expressed in msats.
|
|
2559
3881
|
**/
|
|
2560
3882
|
amountMsats?: number | undefined;
|
|
2561
3883
|
}
|
|
@@ -2582,8 +3904,8 @@ interface Secret {
|
|
|
2582
3904
|
/** This is a Lightspark node with OSK. **/
|
|
2583
3905
|
declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
2584
3906
|
/**
|
|
2585
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2586
|
-
* string.
|
|
3907
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
3908
|
+
* Should be treated as an opaque string.
|
|
2587
3909
|
**/
|
|
2588
3910
|
readonly id: string;
|
|
2589
3911
|
/** The date and time when the entity was first created. **/
|
|
@@ -2593,43 +3915,54 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2593
3915
|
/** The Bitcoin Network this node is deployed in. **/
|
|
2594
3916
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
2595
3917
|
/**
|
|
2596
|
-
* The name of this node in the network.
|
|
2597
|
-
*
|
|
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.
|
|
2598
3921
|
**/
|
|
2599
3922
|
readonly displayName: string;
|
|
2600
3923
|
/** The owner of this LightsparkNode. **/
|
|
2601
3924
|
readonly ownerId: string;
|
|
2602
3925
|
/**
|
|
2603
|
-
* The utxos of the channels that are connected to this node.
|
|
2604
|
-
* pre-screening.
|
|
3926
|
+
* The utxos of the channels that are connected to this node.
|
|
3927
|
+
* This is used in uma flow for pre-screening.
|
|
2605
3928
|
**/
|
|
2606
3929
|
readonly umaPrescreeningUtxos: string[];
|
|
2607
3930
|
/** The typename of the object **/
|
|
2608
3931
|
readonly typename: string;
|
|
2609
3932
|
/**
|
|
2610
|
-
* A name that identifies the node.
|
|
2611
|
-
*
|
|
2612
|
-
*
|
|
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.
|
|
2613
3938
|
**/
|
|
2614
3939
|
readonly alias?: string | undefined;
|
|
2615
3940
|
/**
|
|
2616
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
2617
|
-
* 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.
|
|
2618
3945
|
* That color can be changed at any time by the node operator.
|
|
2619
3946
|
**/
|
|
2620
3947
|
readonly color?: string | undefined;
|
|
2621
3948
|
/**
|
|
2622
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
2623
|
-
*
|
|
2624
|
-
*
|
|
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).
|
|
2625
3954
|
**/
|
|
2626
3955
|
readonly conductivity?: number | undefined;
|
|
2627
|
-
/**
|
|
3956
|
+
/**
|
|
3957
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
3958
|
+
* in the Lightning Network. *
|
|
3959
|
+
*/
|
|
2628
3960
|
readonly publicKey?: string | undefined;
|
|
2629
3961
|
/** The current status of this node. **/
|
|
2630
3962
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
2631
3963
|
/**
|
|
2632
|
-
* 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.
|
|
2633
3966
|
*
|
|
2634
3967
|
* @deprecated Use `balances` instead.
|
|
2635
3968
|
**/
|
|
@@ -2641,13 +3974,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2641
3974
|
**/
|
|
2642
3975
|
readonly totalLocalBalance?: CurrencyAmount | undefined;
|
|
2643
3976
|
/**
|
|
2644
|
-
* 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.
|
|
2645
3979
|
*
|
|
2646
3980
|
* @deprecated Use `balances` instead.
|
|
2647
3981
|
**/
|
|
2648
3982
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
2649
3983
|
/**
|
|
2650
|
-
* 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.
|
|
2651
3986
|
*
|
|
2652
3987
|
* @deprecated Use `balances` instead.
|
|
2653
3988
|
**/
|
|
@@ -2660,12 +3995,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2660
3995
|
readonly blockchainBalance?: BlockchainBalance | undefined;
|
|
2661
3996
|
/** The balances that describe the funds in this node. **/
|
|
2662
3997
|
readonly balances?: Balances | undefined;
|
|
2663
|
-
/**
|
|
3998
|
+
/**
|
|
3999
|
+
* The private key client is using to sign a GraphQL request which will be
|
|
4000
|
+
* verified at server side. *
|
|
4001
|
+
*/
|
|
2664
4002
|
readonly encryptedSigningPrivateKey?: Secret | undefined;
|
|
2665
4003
|
constructor(
|
|
2666
4004
|
/**
|
|
2667
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2668
|
-
* string.
|
|
4005
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4006
|
+
* Should be treated as an opaque string.
|
|
2669
4007
|
**/
|
|
2670
4008
|
id: string,
|
|
2671
4009
|
/** The date and time when the entity was first created. **/
|
|
@@ -2675,43 +4013,54 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2675
4013
|
/** The Bitcoin Network this node is deployed in. **/
|
|
2676
4014
|
bitcoinNetwork: BitcoinNetwork,
|
|
2677
4015
|
/**
|
|
2678
|
-
* The name of this node in the network.
|
|
2679
|
-
*
|
|
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.
|
|
2680
4019
|
**/
|
|
2681
4020
|
displayName: string,
|
|
2682
4021
|
/** The owner of this LightsparkNode. **/
|
|
2683
4022
|
ownerId: string,
|
|
2684
4023
|
/**
|
|
2685
|
-
* The utxos of the channels that are connected to this node.
|
|
2686
|
-
* pre-screening.
|
|
4024
|
+
* The utxos of the channels that are connected to this node.
|
|
4025
|
+
* This is used in uma flow for pre-screening.
|
|
2687
4026
|
**/
|
|
2688
4027
|
umaPrescreeningUtxos: string[],
|
|
2689
4028
|
/** The typename of the object **/
|
|
2690
4029
|
typename: string,
|
|
2691
4030
|
/**
|
|
2692
|
-
* A name that identifies the node.
|
|
2693
|
-
*
|
|
2694
|
-
*
|
|
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.
|
|
2695
4036
|
**/
|
|
2696
4037
|
alias?: string | undefined,
|
|
2697
4038
|
/**
|
|
2698
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
2699
|
-
* 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.
|
|
2700
4043
|
* That color can be changed at any time by the node operator.
|
|
2701
4044
|
**/
|
|
2702
4045
|
color?: string | undefined,
|
|
2703
4046
|
/**
|
|
2704
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
2705
|
-
*
|
|
2706
|
-
*
|
|
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).
|
|
2707
4052
|
**/
|
|
2708
4053
|
conductivity?: number | undefined,
|
|
2709
|
-
/**
|
|
4054
|
+
/**
|
|
4055
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
4056
|
+
* in the Lightning Network. *
|
|
4057
|
+
*/
|
|
2710
4058
|
publicKey?: string | undefined,
|
|
2711
4059
|
/** The current status of this node. **/
|
|
2712
4060
|
status?: LightsparkNodeStatus | undefined,
|
|
2713
4061
|
/**
|
|
2714
|
-
* 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.
|
|
2715
4064
|
*
|
|
2716
4065
|
* @deprecated Use `balances` instead.
|
|
2717
4066
|
**/
|
|
@@ -2723,13 +4072,15 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2723
4072
|
**/
|
|
2724
4073
|
totalLocalBalance?: CurrencyAmount | undefined,
|
|
2725
4074
|
/**
|
|
2726
|
-
* 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.
|
|
2727
4077
|
*
|
|
2728
4078
|
* @deprecated Use `balances` instead.
|
|
2729
4079
|
**/
|
|
2730
4080
|
localBalance?: CurrencyAmount | undefined,
|
|
2731
4081
|
/**
|
|
2732
|
-
* 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.
|
|
2733
4084
|
*
|
|
2734
4085
|
* @deprecated Use `balances` instead.
|
|
2735
4086
|
**/
|
|
@@ -2742,7 +4093,10 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2742
4093
|
blockchainBalance?: BlockchainBalance | undefined,
|
|
2743
4094
|
/** The balances that describe the funds in this node. **/
|
|
2744
4095
|
balances?: Balances | undefined,
|
|
2745
|
-
/**
|
|
4096
|
+
/**
|
|
4097
|
+
* The private key client is using to sign a GraphQL request which will be
|
|
4098
|
+
* verified at server side. *
|
|
4099
|
+
*/
|
|
2746
4100
|
encryptedSigningPrivateKey?: Secret | undefined);
|
|
2747
4101
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
2748
4102
|
getChannels(client: LightsparkClient, first?: number | undefined, statuses?: ChannelStatus[] | undefined, after?: string | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
@@ -2776,8 +4130,8 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
2776
4130
|
/** This is a Lightspark node with remote signing. **/
|
|
2777
4131
|
declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, Entity {
|
|
2778
4132
|
/**
|
|
2779
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2780
|
-
* string.
|
|
4133
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4134
|
+
* Should be treated as an opaque string.
|
|
2781
4135
|
**/
|
|
2782
4136
|
readonly id: string;
|
|
2783
4137
|
/** The date and time when the entity was first created. **/
|
|
@@ -2787,43 +4141,54 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
2787
4141
|
/** The Bitcoin Network this node is deployed in. **/
|
|
2788
4142
|
readonly bitcoinNetwork: BitcoinNetwork;
|
|
2789
4143
|
/**
|
|
2790
|
-
* The name of this node in the network.
|
|
2791
|
-
*
|
|
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.
|
|
2792
4147
|
**/
|
|
2793
4148
|
readonly displayName: string;
|
|
2794
4149
|
/** The owner of this LightsparkNode. **/
|
|
2795
4150
|
readonly ownerId: string;
|
|
2796
4151
|
/**
|
|
2797
|
-
* The utxos of the channels that are connected to this node.
|
|
2798
|
-
* pre-screening.
|
|
4152
|
+
* The utxos of the channels that are connected to this node.
|
|
4153
|
+
* This is used in uma flow for pre-screening.
|
|
2799
4154
|
**/
|
|
2800
4155
|
readonly umaPrescreeningUtxos: string[];
|
|
2801
4156
|
/** The typename of the object **/
|
|
2802
4157
|
readonly typename: string;
|
|
2803
4158
|
/**
|
|
2804
|
-
* A name that identifies the node.
|
|
2805
|
-
*
|
|
2806
|
-
*
|
|
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.
|
|
2807
4164
|
**/
|
|
2808
4165
|
readonly alias?: string | undefined;
|
|
2809
4166
|
/**
|
|
2810
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
2811
|
-
* 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.
|
|
2812
4171
|
* That color can be changed at any time by the node operator.
|
|
2813
4172
|
**/
|
|
2814
4173
|
readonly color?: string | undefined;
|
|
2815
4174
|
/**
|
|
2816
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
2817
|
-
*
|
|
2818
|
-
*
|
|
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).
|
|
2819
4180
|
**/
|
|
2820
4181
|
readonly conductivity?: number | undefined;
|
|
2821
|
-
/**
|
|
4182
|
+
/**
|
|
4183
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
4184
|
+
* in the Lightning Network. *
|
|
4185
|
+
*/
|
|
2822
4186
|
readonly publicKey?: string | undefined;
|
|
2823
4187
|
/** The current status of this node. **/
|
|
2824
4188
|
readonly status?: LightsparkNodeStatus | undefined;
|
|
2825
4189
|
/**
|
|
2826
|
-
* 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.
|
|
2827
4192
|
*
|
|
2828
4193
|
* @deprecated Use `balances` instead.
|
|
2829
4194
|
**/
|
|
@@ -2835,13 +4200,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
2835
4200
|
**/
|
|
2836
4201
|
readonly totalLocalBalance?: CurrencyAmount | undefined;
|
|
2837
4202
|
/**
|
|
2838
|
-
* 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.
|
|
2839
4205
|
*
|
|
2840
4206
|
* @deprecated Use `balances` instead.
|
|
2841
4207
|
**/
|
|
2842
4208
|
readonly localBalance?: CurrencyAmount | undefined;
|
|
2843
4209
|
/**
|
|
2844
|
-
* 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.
|
|
2845
4212
|
*
|
|
2846
4213
|
* @deprecated Use `balances` instead.
|
|
2847
4214
|
**/
|
|
@@ -2856,8 +4223,8 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
2856
4223
|
readonly balances?: Balances | undefined;
|
|
2857
4224
|
constructor(
|
|
2858
4225
|
/**
|
|
2859
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2860
|
-
* string.
|
|
4226
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4227
|
+
* Should be treated as an opaque string.
|
|
2861
4228
|
**/
|
|
2862
4229
|
id: string,
|
|
2863
4230
|
/** The date and time when the entity was first created. **/
|
|
@@ -2867,43 +4234,54 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
2867
4234
|
/** The Bitcoin Network this node is deployed in. **/
|
|
2868
4235
|
bitcoinNetwork: BitcoinNetwork,
|
|
2869
4236
|
/**
|
|
2870
|
-
* The name of this node in the network.
|
|
2871
|
-
*
|
|
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.
|
|
2872
4240
|
**/
|
|
2873
4241
|
displayName: string,
|
|
2874
4242
|
/** The owner of this LightsparkNode. **/
|
|
2875
4243
|
ownerId: string,
|
|
2876
4244
|
/**
|
|
2877
|
-
* The utxos of the channels that are connected to this node.
|
|
2878
|
-
* pre-screening.
|
|
4245
|
+
* The utxos of the channels that are connected to this node.
|
|
4246
|
+
* This is used in uma flow for pre-screening.
|
|
2879
4247
|
**/
|
|
2880
4248
|
umaPrescreeningUtxos: string[],
|
|
2881
4249
|
/** The typename of the object **/
|
|
2882
4250
|
typename: string,
|
|
2883
4251
|
/**
|
|
2884
|
-
* A name that identifies the node.
|
|
2885
|
-
*
|
|
2886
|
-
*
|
|
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.
|
|
2887
4257
|
**/
|
|
2888
4258
|
alias?: string | undefined,
|
|
2889
4259
|
/**
|
|
2890
|
-
* A hexadecimal string that describes a color. For example "#000000" is
|
|
2891
|
-
* 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.
|
|
2892
4264
|
* That color can be changed at any time by the node operator.
|
|
2893
4265
|
**/
|
|
2894
4266
|
color?: string | undefined,
|
|
2895
4267
|
/**
|
|
2896
|
-
* A summary metric used to capture how well positioned a node is to send,
|
|
2897
|
-
*
|
|
2898
|
-
*
|
|
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).
|
|
2899
4273
|
**/
|
|
2900
4274
|
conductivity?: number | undefined,
|
|
2901
|
-
/**
|
|
4275
|
+
/**
|
|
4276
|
+
* The public key of this node. It acts as a unique identifier of this node
|
|
4277
|
+
* in the Lightning Network. *
|
|
4278
|
+
*/
|
|
2902
4279
|
publicKey?: string | undefined,
|
|
2903
4280
|
/** The current status of this node. **/
|
|
2904
4281
|
status?: LightsparkNodeStatus | undefined,
|
|
2905
4282
|
/**
|
|
2906
|
-
* 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.
|
|
2907
4285
|
*
|
|
2908
4286
|
* @deprecated Use `balances` instead.
|
|
2909
4287
|
**/
|
|
@@ -2915,13 +4293,15 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
2915
4293
|
**/
|
|
2916
4294
|
totalLocalBalance?: CurrencyAmount | undefined,
|
|
2917
4295
|
/**
|
|
2918
|
-
* 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.
|
|
2919
4298
|
*
|
|
2920
4299
|
* @deprecated Use `balances` instead.
|
|
2921
4300
|
**/
|
|
2922
4301
|
localBalance?: CurrencyAmount | undefined,
|
|
2923
4302
|
/**
|
|
2924
|
-
* 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.
|
|
2925
4305
|
*
|
|
2926
4306
|
* @deprecated Use `balances` instead.
|
|
2927
4307
|
**/
|
|
@@ -2962,11 +4342,17 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
2962
4342
|
};
|
|
2963
4343
|
}
|
|
2964
4344
|
|
|
2965
|
-
/**
|
|
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
|
+
*/
|
|
2966
4352
|
interface OnChainTransaction {
|
|
2967
4353
|
/**
|
|
2968
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
2969
|
-
* string.
|
|
4354
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4355
|
+
* Should be treated as an opaque string.
|
|
2970
4356
|
**/
|
|
2971
4357
|
id: string;
|
|
2972
4358
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -2978,8 +4364,8 @@ interface OnChainTransaction {
|
|
|
2978
4364
|
/** The amount of money involved in this transaction. **/
|
|
2979
4365
|
amount: CurrencyAmount;
|
|
2980
4366
|
/**
|
|
2981
|
-
* The height of the block that included this transaction.
|
|
2982
|
-
* transactions.
|
|
4367
|
+
* The height of the block that included this transaction.
|
|
4368
|
+
* This will be zero for unconfirmed transactions.
|
|
2983
4369
|
**/
|
|
2984
4370
|
blockHeight: number;
|
|
2985
4371
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -2988,19 +4374,25 @@ interface OnChainTransaction {
|
|
|
2988
4374
|
typename: string;
|
|
2989
4375
|
/** The date and time when this transaction was completed or failed. **/
|
|
2990
4376
|
resolvedAt?: string | undefined;
|
|
2991
|
-
/**
|
|
4377
|
+
/**
|
|
4378
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
4379
|
+
* Lightning Network. *
|
|
4380
|
+
*/
|
|
2992
4381
|
transactionHash?: string | undefined;
|
|
2993
4382
|
/**
|
|
2994
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
2995
|
-
* blockchain.
|
|
4383
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
4384
|
+
* to the Bitcoin blockchain.
|
|
2996
4385
|
**/
|
|
2997
4386
|
fees?: CurrencyAmount | undefined;
|
|
2998
4387
|
/**
|
|
2999
|
-
* The hash of the block that included this transaction.
|
|
3000
|
-
* transactions.
|
|
4388
|
+
* The hash of the block that included this transaction.
|
|
4389
|
+
* This will be null for unconfirmed transactions.
|
|
3001
4390
|
**/
|
|
3002
4391
|
blockHash?: string | undefined;
|
|
3003
|
-
/**
|
|
4392
|
+
/**
|
|
4393
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
4394
|
+
* *
|
|
4395
|
+
*/
|
|
3004
4396
|
numConfirmations?: number | undefined;
|
|
3005
4397
|
}
|
|
3006
4398
|
declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
|
|
@@ -3023,11 +4415,14 @@ interface PayInvoiceInput {
|
|
|
3023
4415
|
encodedInvoice: string;
|
|
3024
4416
|
/** The timeout in seconds that we will try to make the payment. **/
|
|
3025
4417
|
timeoutSecs: number;
|
|
3026
|
-
/**
|
|
4418
|
+
/**
|
|
4419
|
+
* The maximum amount of fees that you want to pay for this payment to be
|
|
4420
|
+
* sent, expressed in msats. *
|
|
4421
|
+
*/
|
|
3027
4422
|
maximumFeesMsats: number;
|
|
3028
4423
|
/**
|
|
3029
|
-
* The amount you will pay for this invoice, expressed in msats.
|
|
3030
|
-
* 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.
|
|
3031
4426
|
**/
|
|
3032
4427
|
amountMsats?: number | undefined;
|
|
3033
4428
|
}
|
|
@@ -3037,43 +4432,49 @@ interface PayInvoiceOutput {
|
|
|
3037
4432
|
paymentId: string;
|
|
3038
4433
|
}
|
|
3039
4434
|
|
|
4435
|
+
interface PayUmaInvoiceInput {
|
|
4436
|
+
nodeId: string;
|
|
4437
|
+
encodedInvoice: string;
|
|
4438
|
+
timeoutSecs: number;
|
|
4439
|
+
maximumFeesMsats: number;
|
|
4440
|
+
amountMsats?: number | undefined;
|
|
4441
|
+
}
|
|
4442
|
+
|
|
3040
4443
|
/** This is an enum indicating the direction of the payment. **/
|
|
3041
4444
|
declare enum PaymentDirection {
|
|
3042
4445
|
/**
|
|
3043
|
-
* This is an enum value that represents values that could be added in the
|
|
3044
|
-
* 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.
|
|
3045
4449
|
*/
|
|
3046
4450
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3047
4451
|
SENT = "SENT",
|
|
3048
4452
|
RECEIVED = "RECEIVED"
|
|
3049
4453
|
}
|
|
3050
4454
|
|
|
3051
|
-
interface PayUmaInvoiceInput {
|
|
3052
|
-
nodeId: string;
|
|
3053
|
-
encodedInvoice: string;
|
|
3054
|
-
timeoutSecs: number;
|
|
3055
|
-
maximumFeesMsats: number;
|
|
3056
|
-
amountMsats?: number | undefined;
|
|
3057
|
-
}
|
|
3058
|
-
|
|
3059
4455
|
interface RegisterPaymentInput {
|
|
3060
4456
|
/**
|
|
3061
|
-
* The compliance provider that is going to screen the node.
|
|
3062
|
-
*
|
|
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.
|
|
3063
4460
|
**/
|
|
3064
4461
|
provider: ComplianceProvider;
|
|
3065
4462
|
/**
|
|
3066
|
-
* The Lightspark ID of the lightning payment you want to register.
|
|
3067
|
-
* 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.
|
|
3068
4465
|
**/
|
|
3069
4466
|
paymentId: string;
|
|
3070
4467
|
/**
|
|
3071
|
-
* The public key of the counterparty lightning node,
|
|
3072
|
-
*
|
|
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
|
|
3073
4471
|
* register an incoming payment.
|
|
3074
4472
|
**/
|
|
3075
4473
|
nodePubkey: string;
|
|
3076
|
-
/**
|
|
4474
|
+
/**
|
|
4475
|
+
* Indicates whether this payment is an OutgoingPayment or an
|
|
4476
|
+
* IncomingPayment. *
|
|
4477
|
+
*/
|
|
3077
4478
|
direction: PaymentDirection;
|
|
3078
4479
|
}
|
|
3079
4480
|
|
|
@@ -3107,11 +4508,15 @@ interface ReleasePaymentPreimageOutput {
|
|
|
3107
4508
|
invoiceId: string;
|
|
3108
4509
|
}
|
|
3109
4510
|
|
|
3110
|
-
/**
|
|
4511
|
+
/**
|
|
4512
|
+
* This is an enum of the potential sub-event types for Remote Signing webook
|
|
4513
|
+
* events. *
|
|
4514
|
+
*/
|
|
3111
4515
|
declare enum RemoteSigningSubEventType {
|
|
3112
4516
|
/**
|
|
3113
|
-
* This is an enum value that represents values that could be added in the
|
|
3114
|
-
* 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.
|
|
3115
4520
|
*/
|
|
3116
4521
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3117
4522
|
ECDH = "ECDH",
|
|
@@ -3130,8 +4535,8 @@ interface RequestWithdrawalInput {
|
|
|
3130
4535
|
/** The bitcoin address where the withdrawal should be sent. **/
|
|
3131
4536
|
bitcoinAddress: string;
|
|
3132
4537
|
/**
|
|
3133
|
-
* The amount you want to withdraw from this node in Satoshis.
|
|
3134
|
-
* 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.
|
|
3135
4540
|
**/
|
|
3136
4541
|
amountSats: number;
|
|
3137
4542
|
/** The strategy that should be used to withdraw the funds from this node. **/
|
|
@@ -3143,11 +4548,16 @@ interface RequestWithdrawalOutput {
|
|
|
3143
4548
|
requestId: string;
|
|
3144
4549
|
}
|
|
3145
4550
|
|
|
3146
|
-
/**
|
|
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
|
+
*/
|
|
3147
4556
|
declare enum RiskRating {
|
|
3148
4557
|
/**
|
|
3149
|
-
* This is an enum value that represents values that could be added in the
|
|
3150
|
-
* 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.
|
|
3151
4561
|
*/
|
|
3152
4562
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3153
4563
|
HIGH_RISK = "HIGH_RISK",
|
|
@@ -3155,11 +4565,17 @@ declare enum RiskRating {
|
|
|
3155
4565
|
UNKNOWN = "UNKNOWN"
|
|
3156
4566
|
}
|
|
3157
4567
|
|
|
3158
|
-
/**
|
|
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
|
+
*/
|
|
3159
4575
|
interface RoutingTransaction {
|
|
3160
4576
|
/**
|
|
3161
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3162
|
-
* string.
|
|
4577
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4578
|
+
* Should be treated as an opaque string.
|
|
3163
4579
|
**/
|
|
3164
4580
|
id: string;
|
|
3165
4581
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3174,18 +4590,25 @@ interface RoutingTransaction {
|
|
|
3174
4590
|
typename: string;
|
|
3175
4591
|
/** The date and time when this transaction was completed or failed. **/
|
|
3176
4592
|
resolvedAt?: string | undefined;
|
|
3177
|
-
/**
|
|
4593
|
+
/**
|
|
4594
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
4595
|
+
* Lightning Network. *
|
|
4596
|
+
*/
|
|
3178
4597
|
transactionHash?: string | undefined;
|
|
3179
4598
|
/** If known, the channel this transaction was received from. **/
|
|
3180
4599
|
incomingChannelId?: string | undefined;
|
|
3181
4600
|
/** If known, the channel this transaction was forwarded to. **/
|
|
3182
4601
|
outgoingChannelId?: string | undefined;
|
|
3183
4602
|
/**
|
|
3184
|
-
* The fees collected by the node when routing this transaction.
|
|
3185
|
-
* 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.
|
|
3186
4606
|
**/
|
|
3187
4607
|
fees?: CurrencyAmount | undefined;
|
|
3188
|
-
/**
|
|
4608
|
+
/**
|
|
4609
|
+
* If applicable, user-facing error message describing why the routing
|
|
4610
|
+
* failed. *
|
|
4611
|
+
*/
|
|
3189
4612
|
failureMessage?: RichText | undefined;
|
|
3190
4613
|
/** If applicable, the reason why the routing failed. **/
|
|
3191
4614
|
failureReason?: RoutingTransactionFailureReason | undefined;
|
|
@@ -3194,8 +4617,9 @@ declare const getRoutingTransactionQuery: (id: string) => Query<RoutingTransacti
|
|
|
3194
4617
|
|
|
3195
4618
|
interface ScreenNodeInput {
|
|
3196
4619
|
/**
|
|
3197
|
-
* The compliance provider that is going to screen the node.
|
|
3198
|
-
*
|
|
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.
|
|
3199
4623
|
**/
|
|
3200
4624
|
provider: ComplianceProvider;
|
|
3201
4625
|
/** The public key of the lightning node that needs to be screened. **/
|
|
@@ -3215,7 +4639,10 @@ interface SendPaymentInput {
|
|
|
3215
4639
|
timeoutSecs: number;
|
|
3216
4640
|
/** The amount you will send to the destination node, expressed in msats. **/
|
|
3217
4641
|
amountMsats: number;
|
|
3218
|
-
/**
|
|
4642
|
+
/**
|
|
4643
|
+
* The maximum amount of fees that you want to pay for this payment to be
|
|
4644
|
+
* sent, expressed in msats. *
|
|
4645
|
+
*/
|
|
3219
4646
|
maximumFeesMsats: number;
|
|
3220
4647
|
}
|
|
3221
4648
|
|
|
@@ -3230,8 +4657,9 @@ interface SetInvoicePaymentHashInput {
|
|
|
3230
4657
|
/** The 32-byte hash of the payment preimage. **/
|
|
3231
4658
|
paymentHash: string;
|
|
3232
4659
|
/**
|
|
3233
|
-
* The 32-byte nonce used to generate the invoice preimage if applicable.
|
|
3234
|
-
* 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.
|
|
3235
4663
|
**/
|
|
3236
4664
|
preimageNonce?: string | undefined;
|
|
3237
4665
|
}
|
|
@@ -3240,21 +4668,6 @@ interface SetInvoicePaymentHashOutput {
|
|
|
3240
4668
|
invoiceId: string;
|
|
3241
4669
|
}
|
|
3242
4670
|
|
|
3243
|
-
interface Signable {
|
|
3244
|
-
/**
|
|
3245
|
-
* The unique identifier of this entity across all Lightspark systems. Should be treated as an opaque
|
|
3246
|
-
* string.
|
|
3247
|
-
**/
|
|
3248
|
-
id: string;
|
|
3249
|
-
/** The date and time when the entity was first created. **/
|
|
3250
|
-
createdAt: string;
|
|
3251
|
-
/** The date and time when the entity was last updated. **/
|
|
3252
|
-
updatedAt: string;
|
|
3253
|
-
/** The typename of the object **/
|
|
3254
|
-
typename: string;
|
|
3255
|
-
}
|
|
3256
|
-
declare const getSignableQuery: (id: string) => Query<Signable>;
|
|
3257
|
-
|
|
3258
4671
|
interface SignInvoiceInput {
|
|
3259
4672
|
/** The unique identifier of the invoice to be signed. **/
|
|
3260
4673
|
invoiceId: string;
|
|
@@ -3279,6 +4692,21 @@ interface SignMessagesOutput {
|
|
|
3279
4692
|
signedPayloads: SignablePayload[];
|
|
3280
4693
|
}
|
|
3281
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
|
+
|
|
3282
4710
|
interface UpdateChannelPerCommitmentPointInput {
|
|
3283
4711
|
channelId: string;
|
|
3284
4712
|
perCommitmentPoint: string;
|
|
@@ -3298,17 +4726,23 @@ interface UpdateNodeSharedSecretOutput {
|
|
|
3298
4726
|
nodeId: string;
|
|
3299
4727
|
}
|
|
3300
4728
|
|
|
3301
|
-
/**
|
|
4729
|
+
/**
|
|
4730
|
+
* This is an enum of the potential event types that can be associated with
|
|
4731
|
+
* your Lightspark wallets. *
|
|
4732
|
+
*/
|
|
3302
4733
|
declare enum WebhookEventType {
|
|
3303
4734
|
/**
|
|
3304
|
-
* This is an enum value that represents values that could be added in the
|
|
3305
|
-
* 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.
|
|
3306
4738
|
*/
|
|
3307
4739
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
3308
4740
|
PAYMENT_FINISHED = "PAYMENT_FINISHED",
|
|
4741
|
+
FORCE_CLOSURE = "FORCE_CLOSURE",
|
|
3309
4742
|
WITHDRAWAL_FINISHED = "WITHDRAWAL_FINISHED",
|
|
3310
4743
|
FUNDS_RECEIVED = "FUNDS_RECEIVED",
|
|
3311
4744
|
NODE_STATUS = "NODE_STATUS",
|
|
4745
|
+
UMA_INVITATION_CLAIMED = "UMA_INVITATION_CLAIMED",
|
|
3312
4746
|
WALLET_STATUS = "WALLET_STATUS",
|
|
3313
4747
|
WALLET_OUTGOING_PAYMENT_FINISHED = "WALLET_OUTGOING_PAYMENT_FINISHED",
|
|
3314
4748
|
WALLET_INCOMING_PAYMENT_FINISHED = "WALLET_INCOMING_PAYMENT_FINISHED",
|
|
@@ -3318,11 +4752,16 @@ declare enum WebhookEventType {
|
|
|
3318
4752
|
LOW_BALANCE = "LOW_BALANCE"
|
|
3319
4753
|
}
|
|
3320
4754
|
|
|
3321
|
-
/**
|
|
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
|
+
*/
|
|
3322
4761
|
interface Withdrawal {
|
|
3323
4762
|
/**
|
|
3324
|
-
* The unique identifier of this entity across all Lightspark systems.
|
|
3325
|
-
* string.
|
|
4763
|
+
* The unique identifier of this entity across all Lightspark systems.
|
|
4764
|
+
* Should be treated as an opaque string.
|
|
3326
4765
|
**/
|
|
3327
4766
|
id: string;
|
|
3328
4767
|
/** The date and time when this transaction was initiated. **/
|
|
@@ -3334,8 +4773,8 @@ interface Withdrawal {
|
|
|
3334
4773
|
/** The amount of money involved in this transaction. **/
|
|
3335
4774
|
amount: CurrencyAmount;
|
|
3336
4775
|
/**
|
|
3337
|
-
* The height of the block that included this transaction.
|
|
3338
|
-
* transactions.
|
|
4776
|
+
* The height of the block that included this transaction.
|
|
4777
|
+
* This will be zero for unconfirmed transactions.
|
|
3339
4778
|
**/
|
|
3340
4779
|
blockHeight: number;
|
|
3341
4780
|
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
@@ -3346,21 +4785,27 @@ interface Withdrawal {
|
|
|
3346
4785
|
typename: string;
|
|
3347
4786
|
/** The date and time when this transaction was completed or failed. **/
|
|
3348
4787
|
resolvedAt?: string | undefined;
|
|
3349
|
-
/**
|
|
4788
|
+
/**
|
|
4789
|
+
* The hash of this transaction, so it can be uniquely identified on the
|
|
4790
|
+
* Lightning Network. *
|
|
4791
|
+
*/
|
|
3350
4792
|
transactionHash?: string | undefined;
|
|
3351
4793
|
/**
|
|
3352
|
-
* The fees that were paid by the wallet sending the transaction to commit it
|
|
3353
|
-
* blockchain.
|
|
4794
|
+
* The fees that were paid by the wallet sending the transaction to commit it
|
|
4795
|
+
* to the Bitcoin blockchain.
|
|
3354
4796
|
**/
|
|
3355
4797
|
fees?: CurrencyAmount | undefined;
|
|
3356
4798
|
/**
|
|
3357
|
-
* The hash of the block that included this transaction.
|
|
3358
|
-
* transactions.
|
|
4799
|
+
* The hash of the block that included this transaction.
|
|
4800
|
+
* This will be null for unconfirmed transactions.
|
|
3359
4801
|
**/
|
|
3360
4802
|
blockHash?: string | undefined;
|
|
3361
|
-
/**
|
|
4803
|
+
/**
|
|
4804
|
+
* The number of blockchain confirmations for this transaction in real time.
|
|
4805
|
+
* *
|
|
4806
|
+
*/
|
|
3362
4807
|
numConfirmations?: number | undefined;
|
|
3363
4808
|
}
|
|
3364
4809
|
declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
|
|
3365
4810
|
|
|
3366
|
-
export {
|
|
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 };
|