@lightsparkdev/lightspark-sdk 1.5.14 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/dist/{chunk-FGFVWCTL.js → chunk-DSWMAFFH.js} +288 -144
- package/dist/{index-2b493387.d.ts → index-2f0cac65.d.ts} +270 -93
- package/dist/index.cjs +416 -143
- package/dist/index.d.cts +2 -2
- package/dist/index.d.ts +2 -2
- package/dist/index.js +136 -4
- package/dist/objects/index.cjs +279 -133
- package/dist/objects/index.d.cts +1 -1
- package/dist/objects/index.d.ts +1 -1
- package/dist/objects/index.js +5 -1
- package/package.json +1 -1
- package/src/client.ts +125 -1
- package/src/graphql/CreateUmaInvoice.ts +2 -0
- package/src/graphql/InvoiceForPaymentHash.ts +17 -0
- package/src/graphql/OutgoingPaymentsForPaymentHash.ts +21 -0
- package/src/graphql/PayUmaInvoice.ts +2 -0
- package/src/objects/Account.ts +15 -2
- package/src/objects/ChannelClosingTransaction.ts +1 -4
- package/src/objects/ChannelOpeningTransaction.ts +1 -4
- package/src/objects/Connection.ts +116 -0
- package/src/objects/CreateLnurlInvoiceInput.ts +6 -0
- package/src/objects/CreateUmaInvoiceInput.ts +4 -0
- package/src/objects/CurrencyUnit.ts +1 -1
- package/src/objects/Deposit.ts +1 -4
- package/src/objects/Entity.ts +11 -0
- package/src/objects/FailHtlcsInput.ts +27 -0
- package/src/objects/FailHtlcsOutput.ts +26 -0
- package/src/objects/InvoiceForPaymentHashInput.ts +23 -0
- package/src/objects/InvoiceForPaymentHashOutput.ts +30 -0
- package/src/objects/LightningTransaction.ts +3 -0
- package/src/objects/LightsparkNode.ts +3 -1
- package/src/objects/LightsparkNodeWithOSK.ts +8 -4
- package/src/objects/LightsparkNodeWithRemoteSigning.ts +8 -4
- package/src/objects/OnChainFeeTarget.ts +19 -0
- package/src/objects/OnChainTransaction.ts +1 -4
- package/src/objects/OutgoingPayment.ts +5 -0
- package/src/objects/OutgoingPaymentForIdempotencyKeyInput.ts +24 -0
- package/src/objects/OutgoingPaymentForIdempotencyKeyOutput.ts +33 -0
- package/src/objects/OutgoingPaymentsForInvoiceQueryOutput.ts +1 -0
- package/src/objects/OutgoingPaymentsForPaymentHashQueryInput.ts +34 -0
- package/src/objects/OutgoingPaymentsForPaymentHashQueryOutput.ts +37 -0
- package/src/objects/PayInvoiceInput.ts +8 -0
- package/src/objects/PayUmaInvoiceInput.ts +12 -0
- package/src/objects/PaymentFailureReason.ts +2 -0
- package/src/objects/RemoteSigningSubEventType.ts +2 -0
- package/src/objects/RequestInitiator.ts +15 -0
- package/src/objects/RequestWithdrawalInput.ts +29 -0
- package/src/objects/SendPaymentInput.ts +8 -0
- package/src/objects/Transaction.ts +3 -0
- package/src/objects/TransactionStatus.ts +2 -2
- package/src/objects/Wallet.ts +11 -0
- package/src/objects/WalletStatus.ts +2 -2
- package/src/objects/Withdrawal.ts +1 -4
- package/src/objects/WithdrawalRequest.ts +114 -11
- package/src/objects/WithdrawalRequestStatus.ts +2 -0
- package/src/objects/WithdrawalRequestToChannelClosingTransactionsConnection.ts +15 -10
- package/src/objects/WithdrawalRequestToChannelOpeningTransactionsConnection.ts +15 -10
- package/src/objects/WithdrawalRequestToWithdrawalsConnection.ts +47 -0
- package/src/objects/index.ts +11 -0
- package/src/tests/integration/general-regtest.test.ts +3 -0
- package/src/tests/uma-utils.test.ts +70 -0
|
@@ -44,7 +44,7 @@ declare enum CurrencyUnit {
|
|
|
44
44
|
*/
|
|
45
45
|
SATOSHI = "SATOSHI",
|
|
46
46
|
/**
|
|
47
|
-
* 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
|
|
47
|
+
* 0.001 Satoshi, or 10e-11 Bitcoin. We recommend using the Satoshi unit instead when possible.
|
|
48
48
|
*/
|
|
49
49
|
MILLISATOSHI = "MILLISATOSHI",
|
|
50
50
|
/** United States Dollar. **/
|
|
@@ -736,7 +736,7 @@ interface LightsparkNode {
|
|
|
736
736
|
/** The balances that describe the funds in this node. **/
|
|
737
737
|
balances?: Balances | undefined;
|
|
738
738
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
739
|
-
getChannels(client: LightsparkClient, first?: number | undefined,
|
|
739
|
+
getChannels(client: LightsparkClient, first?: number | undefined, after?: string | undefined, beforeDate?: string | undefined, afterDate?: string | undefined, statuses?: ChannelStatus[] | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
740
740
|
getDailyLiquidityForecasts(client: LightsparkClient, fromDate: string, toDate: string, direction: LightningPaymentDirection): Promise<LightsparkNodeToDailyLiquidityForecastsConnection>;
|
|
741
741
|
}
|
|
742
742
|
declare const getLightsparkNodeQuery: (id: string) => Query<LightsparkNode>;
|
|
@@ -829,14 +829,14 @@ declare enum TransactionStatus {
|
|
|
829
829
|
* Clients should support unknown values as more of them could be added without notice.
|
|
830
830
|
*/
|
|
831
831
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
832
|
-
/** Transaction succeeded
|
|
832
|
+
/** Transaction succeeded. **/
|
|
833
833
|
SUCCESS = "SUCCESS",
|
|
834
834
|
/** Transaction failed. **/
|
|
835
835
|
FAILED = "FAILED",
|
|
836
836
|
/** Transaction has been initiated and is currently in-flight. **/
|
|
837
837
|
PENDING = "PENDING",
|
|
838
838
|
/**
|
|
839
|
-
* For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
|
|
839
|
+
* For transaction type PAYMENT_REQUEST only. No payments have been made to a payment request.
|
|
840
840
|
*/
|
|
841
841
|
NOT_STARTED = "NOT_STARTED",
|
|
842
842
|
/** For transaction type PAYMENT_REQUEST only. A payment request has expired. **/
|
|
@@ -951,8 +951,8 @@ declare enum WalletStatus {
|
|
|
951
951
|
TERMINATING = "TERMINATING",
|
|
952
952
|
/**
|
|
953
953
|
* The wallet has been terminated and is not available in the Lightspark infrastructure anymore.
|
|
954
|
-
* It is not connected to the Lightning network and its funds can only be accessed using the
|
|
955
|
-
*
|
|
954
|
+
* It is not connected to the Lightning network and its funds can only be accessed using the Funds
|
|
955
|
+
* Recovery flow. *
|
|
956
956
|
*/
|
|
957
957
|
TERMINATED = "TERMINATED"
|
|
958
958
|
}
|
|
@@ -985,6 +985,16 @@ interface WalletToTransactionsConnection {
|
|
|
985
985
|
typename: string;
|
|
986
986
|
}
|
|
987
987
|
|
|
988
|
+
declare enum RequestInitiator {
|
|
989
|
+
/**
|
|
990
|
+
* This is an enum value that represents values that could be added in the future.
|
|
991
|
+
* Clients should support unknown values as more of them could be added without notice.
|
|
992
|
+
*/
|
|
993
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
994
|
+
CUSTOMER = "CUSTOMER",
|
|
995
|
+
LIGHTSPARK = "LIGHTSPARK"
|
|
996
|
+
}
|
|
997
|
+
|
|
988
998
|
/** This is an enum of the potential modes that your Bitcoin withdrawal can take. **/
|
|
989
999
|
declare enum WithdrawalMode {
|
|
990
1000
|
/**
|
|
@@ -1003,6 +1013,7 @@ declare enum WithdrawalRequestStatus {
|
|
|
1003
1013
|
* Clients should support unknown values as more of them could be added without notice.
|
|
1004
1014
|
*/
|
|
1005
1015
|
FUTURE_VALUE = "FUTURE_VALUE",
|
|
1016
|
+
CREATING = "CREATING",
|
|
1006
1017
|
CREATED = "CREATED",
|
|
1007
1018
|
FAILED = "FAILED",
|
|
1008
1019
|
IN_PROGRESS = "IN_PROGRESS",
|
|
@@ -1041,10 +1052,7 @@ interface ChannelClosingTransaction {
|
|
|
1041
1052
|
resolvedAt?: string | undefined;
|
|
1042
1053
|
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1043
1054
|
transactionHash?: string | undefined;
|
|
1044
|
-
/**
|
|
1045
|
-
* The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
|
|
1046
|
-
* blockchain.
|
|
1047
|
-
**/
|
|
1055
|
+
/** The fees that were paid by the node for this transaction. **/
|
|
1048
1056
|
fees?: CurrencyAmount | undefined;
|
|
1049
1057
|
/**
|
|
1050
1058
|
* The hash of the block that included this transaction. This will be null for unconfirmed
|
|
@@ -1059,15 +1067,17 @@ interface ChannelClosingTransaction {
|
|
|
1059
1067
|
declare const getChannelClosingTransactionQuery: (id: string) => Query<ChannelClosingTransaction>;
|
|
1060
1068
|
|
|
1061
1069
|
interface WithdrawalRequestToChannelClosingTransactionsConnection {
|
|
1062
|
-
/** An object that holds pagination information about the objects in this connection. **/
|
|
1063
|
-
pageInfo: PageInfo;
|
|
1064
1070
|
/**
|
|
1065
1071
|
* The total count of objects in this connection, using the current filters. It is different
|
|
1066
1072
|
* from the number of objects returned in the current page (in the `entities` field).
|
|
1067
1073
|
**/
|
|
1068
1074
|
count: number;
|
|
1075
|
+
/** An object that holds pagination information about the objects in this connection. **/
|
|
1076
|
+
pageInfo: PageInfo;
|
|
1069
1077
|
/** The channel closing transactions for the current page of this connection. **/
|
|
1070
1078
|
entities: ChannelClosingTransaction[];
|
|
1079
|
+
/** The typename of the object **/
|
|
1080
|
+
typename: string;
|
|
1071
1081
|
}
|
|
1072
1082
|
|
|
1073
1083
|
/**
|
|
@@ -1101,10 +1111,7 @@ interface ChannelOpeningTransaction {
|
|
|
1101
1111
|
resolvedAt?: string | undefined;
|
|
1102
1112
|
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1103
1113
|
transactionHash?: string | undefined;
|
|
1104
|
-
/**
|
|
1105
|
-
* The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
|
|
1106
|
-
* blockchain.
|
|
1107
|
-
**/
|
|
1114
|
+
/** The fees that were paid by the node for this transaction. **/
|
|
1108
1115
|
fees?: CurrencyAmount | undefined;
|
|
1109
1116
|
/**
|
|
1110
1117
|
* The hash of the block that included this transaction. This will be null for unconfirmed
|
|
@@ -1119,15 +1126,73 @@ interface ChannelOpeningTransaction {
|
|
|
1119
1126
|
declare const getChannelOpeningTransactionQuery: (id: string) => Query<ChannelOpeningTransaction>;
|
|
1120
1127
|
|
|
1121
1128
|
interface WithdrawalRequestToChannelOpeningTransactionsConnection {
|
|
1122
|
-
/** An object that holds pagination information about the objects in this connection. **/
|
|
1123
|
-
pageInfo: PageInfo;
|
|
1124
1129
|
/**
|
|
1125
1130
|
* The total count of objects in this connection, using the current filters. It is different
|
|
1126
1131
|
* from the number of objects returned in the current page (in the `entities` field).
|
|
1127
1132
|
**/
|
|
1128
1133
|
count: number;
|
|
1134
|
+
/** An object that holds pagination information about the objects in this connection. **/
|
|
1135
|
+
pageInfo: PageInfo;
|
|
1129
1136
|
/** The channel opening transactions for the current page of this connection. **/
|
|
1130
1137
|
entities: ChannelOpeningTransaction[];
|
|
1138
|
+
/** The typename of the object **/
|
|
1139
|
+
typename: string;
|
|
1140
|
+
}
|
|
1141
|
+
|
|
1142
|
+
/**
|
|
1143
|
+
* This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can
|
|
1144
|
+
* retrieve this object to receive detailed information about any L1 withdrawal associated with
|
|
1145
|
+
* your Lightspark Node or account. *
|
|
1146
|
+
*/
|
|
1147
|
+
interface Withdrawal {
|
|
1148
|
+
/**
|
|
1149
|
+
* The unique identifier of this entity across all Lightspark systems. Should be treated as an
|
|
1150
|
+
* opaque string.
|
|
1151
|
+
**/
|
|
1152
|
+
id: string;
|
|
1153
|
+
/** The date and time when this transaction was initiated. **/
|
|
1154
|
+
createdAt: string;
|
|
1155
|
+
/** The date and time when the entity was last updated. **/
|
|
1156
|
+
updatedAt: string;
|
|
1157
|
+
/** The current status of this transaction. **/
|
|
1158
|
+
status: TransactionStatus;
|
|
1159
|
+
/** The amount of money involved in this transaction. **/
|
|
1160
|
+
amount: CurrencyAmount;
|
|
1161
|
+
/**
|
|
1162
|
+
* The height of the block that included this transaction. This will be zero for unconfirmed
|
|
1163
|
+
* transactions.
|
|
1164
|
+
**/
|
|
1165
|
+
blockHeight: number;
|
|
1166
|
+
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
1167
|
+
destinationAddresses: string[];
|
|
1168
|
+
/** The Lightspark node this withdrawal originated from. **/
|
|
1169
|
+
originId: string;
|
|
1170
|
+
/** The typename of the object **/
|
|
1171
|
+
typename: string;
|
|
1172
|
+
/** The date and time when this transaction was completed or failed. **/
|
|
1173
|
+
resolvedAt?: string | undefined;
|
|
1174
|
+
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
1175
|
+
transactionHash?: string | undefined;
|
|
1176
|
+
/** The fees that were paid by the node for this transaction. **/
|
|
1177
|
+
fees?: CurrencyAmount | undefined;
|
|
1178
|
+
/**
|
|
1179
|
+
* The hash of the block that included this transaction. This will be null for unconfirmed
|
|
1180
|
+
* transactions.
|
|
1181
|
+
**/
|
|
1182
|
+
blockHash?: string | undefined;
|
|
1183
|
+
/** The number of blockchain confirmations for this transaction in real time. **/
|
|
1184
|
+
numConfirmations?: number | undefined;
|
|
1185
|
+
}
|
|
1186
|
+
declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
|
|
1187
|
+
|
|
1188
|
+
interface WithdrawalRequestToWithdrawalsConnection {
|
|
1189
|
+
/**
|
|
1190
|
+
* The total count of objects in this connection, using the current filters. It is different
|
|
1191
|
+
* from the number of objects returned in the current page (in the `entities` field).
|
|
1192
|
+
**/
|
|
1193
|
+
count: number;
|
|
1194
|
+
/** The withdrawals for the current page of this connection. **/
|
|
1195
|
+
entities: Withdrawal[];
|
|
1131
1196
|
}
|
|
1132
1197
|
|
|
1133
1198
|
/**
|
|
@@ -1158,10 +1223,16 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1158
1223
|
readonly amount: CurrencyAmount;
|
|
1159
1224
|
/** The bitcoin address where the funds should be sent. **/
|
|
1160
1225
|
readonly bitcoinAddress: string;
|
|
1161
|
-
/**
|
|
1226
|
+
/**
|
|
1227
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
1228
|
+
*
|
|
1229
|
+
* @deprecated It is always withdrawing from channels now.
|
|
1230
|
+
**/
|
|
1162
1231
|
readonly withdrawalMode: WithdrawalMode;
|
|
1163
1232
|
/** The current status of this withdrawal request. **/
|
|
1164
1233
|
readonly status: WithdrawalRequestStatus;
|
|
1234
|
+
/** The initiator of the withdrawal. **/
|
|
1235
|
+
readonly initiator: RequestInitiator;
|
|
1165
1236
|
/** The typename of the object **/
|
|
1166
1237
|
readonly typename: string;
|
|
1167
1238
|
/**
|
|
@@ -1169,12 +1240,26 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1169
1240
|
* amount for the withdrawal.
|
|
1170
1241
|
**/
|
|
1171
1242
|
readonly estimatedAmount?: CurrencyAmount | undefined;
|
|
1172
|
-
/**
|
|
1243
|
+
/**
|
|
1244
|
+
* The actual amount that is withdrawn to the bitcoin address. It will be set once the request
|
|
1245
|
+
* is completed.
|
|
1246
|
+
**/
|
|
1173
1247
|
readonly amountWithdrawn?: CurrencyAmount | undefined;
|
|
1248
|
+
/**
|
|
1249
|
+
* The total fees the node paid for the withdrawal. It will be set once the request is
|
|
1250
|
+
* completed. *
|
|
1251
|
+
*/
|
|
1252
|
+
readonly totalFees?: CurrencyAmount | undefined;
|
|
1174
1253
|
/** The time at which this request was completed. **/
|
|
1175
1254
|
readonly completedAt?: string | undefined;
|
|
1176
|
-
/**
|
|
1255
|
+
/**
|
|
1256
|
+
* The withdrawal transaction that has been generated by this request.
|
|
1257
|
+
*
|
|
1258
|
+
* @deprecated Use `withdrawals` instead.
|
|
1259
|
+
**/
|
|
1177
1260
|
readonly withdrawalId?: string | undefined;
|
|
1261
|
+
/** The idempotency key of the withdrawal request. **/
|
|
1262
|
+
readonly idempotencyKey?: string | undefined;
|
|
1178
1263
|
constructor(
|
|
1179
1264
|
/**
|
|
1180
1265
|
* The unique identifier of this entity across all Lightspark systems. Should be treated as an
|
|
@@ -1198,10 +1283,16 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1198
1283
|
amount: CurrencyAmount,
|
|
1199
1284
|
/** The bitcoin address where the funds should be sent. **/
|
|
1200
1285
|
bitcoinAddress: string,
|
|
1201
|
-
/**
|
|
1286
|
+
/**
|
|
1287
|
+
* The strategy that should be used to withdraw the funds from the account.
|
|
1288
|
+
*
|
|
1289
|
+
* @deprecated It is always withdrawing from channels now.
|
|
1290
|
+
**/
|
|
1202
1291
|
withdrawalMode: WithdrawalMode,
|
|
1203
1292
|
/** The current status of this withdrawal request. **/
|
|
1204
1293
|
status: WithdrawalRequestStatus,
|
|
1294
|
+
/** The initiator of the withdrawal. **/
|
|
1295
|
+
initiator: RequestInitiator,
|
|
1205
1296
|
/** The typename of the object **/
|
|
1206
1297
|
typename: string,
|
|
1207
1298
|
/**
|
|
@@ -1209,14 +1300,29 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1209
1300
|
* amount for the withdrawal.
|
|
1210
1301
|
**/
|
|
1211
1302
|
estimatedAmount?: CurrencyAmount | undefined,
|
|
1212
|
-
/**
|
|
1303
|
+
/**
|
|
1304
|
+
* The actual amount that is withdrawn to the bitcoin address. It will be set once the request
|
|
1305
|
+
* is completed.
|
|
1306
|
+
**/
|
|
1213
1307
|
amountWithdrawn?: CurrencyAmount | undefined,
|
|
1308
|
+
/**
|
|
1309
|
+
* The total fees the node paid for the withdrawal. It will be set once the request is
|
|
1310
|
+
* completed. *
|
|
1311
|
+
*/
|
|
1312
|
+
totalFees?: CurrencyAmount | undefined,
|
|
1214
1313
|
/** The time at which this request was completed. **/
|
|
1215
1314
|
completedAt?: string | undefined,
|
|
1216
|
-
/**
|
|
1217
|
-
|
|
1218
|
-
|
|
1219
|
-
|
|
1315
|
+
/**
|
|
1316
|
+
* The withdrawal transaction that has been generated by this request.
|
|
1317
|
+
*
|
|
1318
|
+
* @deprecated Use `withdrawals` instead.
|
|
1319
|
+
**/
|
|
1320
|
+
withdrawalId?: string | undefined,
|
|
1321
|
+
/** The idempotency key of the withdrawal request. **/
|
|
1322
|
+
idempotencyKey?: string | undefined);
|
|
1323
|
+
getChannelClosingTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<WithdrawalRequestToChannelClosingTransactionsConnection>;
|
|
1324
|
+
getChannelOpeningTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<WithdrawalRequestToChannelOpeningTransactionsConnection>;
|
|
1325
|
+
getWithdrawals(client: LightsparkClient, first?: number | undefined): Promise<WithdrawalRequestToWithdrawalsConnection>;
|
|
1220
1326
|
static getWithdrawalRequestQuery(id: string): Query<WithdrawalRequest>;
|
|
1221
1327
|
toJson(): {
|
|
1222
1328
|
__typename: string;
|
|
@@ -1227,6 +1333,7 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1227
1333
|
withdrawal_request_amount: any;
|
|
1228
1334
|
withdrawal_request_estimated_amount: any;
|
|
1229
1335
|
withdrawal_request_amount_withdrawn: any;
|
|
1336
|
+
withdrawal_request_total_fees: any;
|
|
1230
1337
|
withdrawal_request_bitcoin_address: string;
|
|
1231
1338
|
withdrawal_request_withdrawal_mode: WithdrawalMode;
|
|
1232
1339
|
withdrawal_request_status: WithdrawalRequestStatus;
|
|
@@ -1234,6 +1341,8 @@ declare class WithdrawalRequest implements Entity {
|
|
|
1234
1341
|
withdrawal_request_withdrawal: {
|
|
1235
1342
|
id: string | undefined;
|
|
1236
1343
|
};
|
|
1344
|
+
withdrawal_request_idempotency_key: string | undefined;
|
|
1345
|
+
withdrawal_request_initiator: RequestInitiator;
|
|
1237
1346
|
};
|
|
1238
1347
|
}
|
|
1239
1348
|
|
|
@@ -1374,7 +1483,8 @@ declare enum PaymentFailureReason {
|
|
|
1374
1483
|
SELF_PAYMENT = "SELF_PAYMENT",
|
|
1375
1484
|
INVOICE_EXPIRED = "INVOICE_EXPIRED",
|
|
1376
1485
|
INVOICE_CANCELLED = "INVOICE_CANCELLED",
|
|
1377
|
-
RISK_SCREENING_FAILED = "RISK_SCREENING_FAILED"
|
|
1486
|
+
RISK_SCREENING_FAILED = "RISK_SCREENING_FAILED",
|
|
1487
|
+
INSUFFICIENT_BALANCE_ON_SINGLE_PATH_INVOICE = "INSUFFICIENT_BALANCE_ON_SINGLE_PATH_INVOICE"
|
|
1378
1488
|
}
|
|
1379
1489
|
|
|
1380
1490
|
/**
|
|
@@ -1440,7 +1550,7 @@ declare class Account implements LightsparkNodeOwner, Entity {
|
|
|
1440
1550
|
getChannels(client: LightsparkClient, bitcoinNetwork: BitcoinNetwork, lightningNodeId?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, first?: number | undefined, after?: string | undefined): Promise<AccountToChannelsConnection>;
|
|
1441
1551
|
getTransactions(client: LightsparkClient, first?: number | undefined, after?: string | undefined, types?: TransactionType[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined, statuses?: TransactionStatus[] | undefined, excludeFailures?: TransactionFailures | undefined): Promise<AccountToTransactionsConnection>;
|
|
1442
1552
|
getPaymentRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, afterDate?: string | undefined, beforeDate?: string | undefined, bitcoinNetwork?: BitcoinNetwork | undefined, lightningNodeId?: string | undefined): Promise<AccountToPaymentRequestsConnection>;
|
|
1443
|
-
getWithdrawalRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, bitcoinNetworks?: BitcoinNetwork[] | undefined, statuses?: WithdrawalRequestStatus[] | undefined, nodeIds?: string[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<AccountToWithdrawalRequestsConnection>;
|
|
1553
|
+
getWithdrawalRequests(client: LightsparkClient, first?: number | undefined, after?: string | undefined, bitcoinNetworks?: BitcoinNetwork[] | undefined, statuses?: WithdrawalRequestStatus[] | undefined, nodeIds?: string[] | undefined, idempotencyKeys?: string[] | undefined, afterDate?: string | undefined, beforeDate?: string | undefined): Promise<AccountToWithdrawalRequestsConnection>;
|
|
1444
1554
|
getWallets(client: LightsparkClient, first?: number | undefined, after?: string | undefined, thirdPartyIds?: string[] | undefined): Promise<AccountToWalletsConnection>;
|
|
1445
1555
|
static getAccountQuery(): Query<Account>;
|
|
1446
1556
|
toJson(): {
|
|
@@ -2068,6 +2178,8 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
2068
2178
|
readonly umaPostTransactionData?: PostTransactionData[] | undefined;
|
|
2069
2179
|
/** The preimage of the payment. **/
|
|
2070
2180
|
readonly paymentPreimage?: string | undefined;
|
|
2181
|
+
/** The idempotency key of the payment. **/
|
|
2182
|
+
readonly idempotencyKey?: string | undefined;
|
|
2071
2183
|
constructor(
|
|
2072
2184
|
/**
|
|
2073
2185
|
* The unique identifier of this entity across all Lightspark systems. Should be treated as an
|
|
@@ -2110,7 +2222,9 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
2110
2222
|
/** The post transaction data which can be used in KYT payment registration. **/
|
|
2111
2223
|
umaPostTransactionData?: PostTransactionData[] | undefined,
|
|
2112
2224
|
/** The preimage of the payment. **/
|
|
2113
|
-
paymentPreimage?: string | undefined
|
|
2225
|
+
paymentPreimage?: string | undefined,
|
|
2226
|
+
/** The idempotency key of the payment. **/
|
|
2227
|
+
idempotencyKey?: string | undefined);
|
|
2114
2228
|
getAttempts(client: LightsparkClient, first?: number | undefined, after?: string | undefined): Promise<OutgoingPaymentToAttemptsConnection>;
|
|
2115
2229
|
static getOutgoingPaymentQuery(id: string): Query<OutgoingPayment>;
|
|
2116
2230
|
toJson(): {
|
|
@@ -2136,6 +2250,7 @@ declare class OutgoingPayment implements LightningTransaction, Transaction, Enti
|
|
|
2136
2250
|
outgoing_payment_uma_post_transaction_data: any[] | undefined;
|
|
2137
2251
|
outgoing_payment_payment_preimage: string | undefined;
|
|
2138
2252
|
outgoing_payment_is_internal_payment: boolean;
|
|
2253
|
+
outgoing_payment_idempotency_key: string | undefined;
|
|
2139
2254
|
};
|
|
2140
2255
|
}
|
|
2141
2256
|
|
|
@@ -2964,9 +3079,12 @@ declare class LightsparkClient {
|
|
|
2964
3079
|
* h-tag (SHA256 purpose of payment) of the resulting Bolt 11 invoice. See
|
|
2965
3080
|
* [this spec](https://github.com/lnurl/luds/blob/luds/06.md#pay-to-static-qrnfclink) for details.
|
|
2966
3081
|
* @param expirySecs The number of seconds until the invoice expires. Defaults to 3600 (1 hour).
|
|
3082
|
+
* @param signingPrivateKey The receiver's signing private key. Used to hash the receiver identifier.
|
|
3083
|
+
* @param receiverIdentifier Optional identifier of the receiver. If provided, this will be hashed using a
|
|
3084
|
+
* monthly-rotated seed and used for anonymized analysis.
|
|
2967
3085
|
* @returns An Invoice object representing the generated invoice.
|
|
2968
3086
|
*/
|
|
2969
|
-
createUmaInvoice(nodeId: string, amountMsats: number, metadata: string, expirySecs?: number | undefined): Promise<Invoice | undefined>;
|
|
3087
|
+
createUmaInvoice(nodeId: string, amountMsats: number, metadata: string, expirySecs?: number | undefined, signingPrivateKey?: Uint8Array | undefined, receiverIdentifier?: string | undefined): Promise<Invoice | undefined>;
|
|
2970
3088
|
/**
|
|
2971
3089
|
* Cancels an existing unpaid invoice and returns that invoice. Cancelled invoices cannot be paid.
|
|
2972
3090
|
*
|
|
@@ -3064,9 +3182,12 @@ declare class LightsparkClient {
|
|
|
3064
3182
|
* @param amountMsats The amount to pay in msats for a zero-amount invoice. Defaults to the full amount of the
|
|
3065
3183
|
* invoice. NOTE: This parameter can only be passed for a zero-amount
|
|
3066
3184
|
* invoice. Otherwise, the call will fail.
|
|
3185
|
+
* @param signingPrivateKey The sender's signing private key. Used to hash the sender identifier.
|
|
3186
|
+
* @param senderIdentifier Optional identifier of the sender. If provided, this will be hashed using a
|
|
3187
|
+
* monthly-rotated seed and used for anonymized analysis.
|
|
3067
3188
|
* @returns An `OutgoingPayment` object if the payment was successful, or undefined if the payment failed.
|
|
3068
3189
|
*/
|
|
3069
|
-
payUmaInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined): Promise<OutgoingPayment | undefined>;
|
|
3190
|
+
payUmaInvoice(payerNodeId: string, encodedInvoice: string, maximumFeesMsats: number, timeoutSecs?: number, amountMsats?: number | undefined, signingPrivateKey?: Uint8Array | undefined, senderIdentifier?: string | undefined): Promise<OutgoingPayment | undefined>;
|
|
3070
3191
|
/**
|
|
3071
3192
|
* Waits for a transaction to have a completed status, and returns the
|
|
3072
3193
|
* transaction.
|
|
@@ -3229,7 +3350,23 @@ declare class LightsparkClient {
|
|
|
3229
3350
|
* @returns The invitation with the given code, or null if no invitation exists with that code.
|
|
3230
3351
|
*/
|
|
3231
3352
|
fetchUmaInvitation(invitationCode: string): Promise<UmaInvitation | null>;
|
|
3353
|
+
/**
|
|
3354
|
+
* Fetches a created invoice by its payment hash.
|
|
3355
|
+
*
|
|
3356
|
+
* @param paymentHash
|
|
3357
|
+
* @returns The invoice if there is one corresponding to the payment hash, or null if no invoice exists with that payment hash.
|
|
3358
|
+
*/
|
|
3359
|
+
invoiceForPaymentHash(paymentHash: string): Promise<Invoice | null>;
|
|
3360
|
+
/**
|
|
3361
|
+
* Fetches outgoing payments for a given payment hash if there are any.
|
|
3362
|
+
*
|
|
3363
|
+
* @param paymentHash
|
|
3364
|
+
* @param statuses Filter to only include payments with the given statuses. If not provided, all statuses are included.
|
|
3365
|
+
*/
|
|
3366
|
+
outgoingPaymentsForPaymentHash(paymentHash: string, statuses?: TransactionStatus[] | undefined): Promise<OutgoingPayment[]>;
|
|
3232
3367
|
private hashPhoneNumber;
|
|
3368
|
+
hashUmaIdentifier(identifier: string, signingPrivateKey: Uint8Array): Promise<string>;
|
|
3369
|
+
getUtcDateTime(): Date;
|
|
3233
3370
|
/**
|
|
3234
3371
|
* Executes a raw `Query` against the Lightspark API.
|
|
3235
3372
|
*
|
|
@@ -3399,6 +3536,9 @@ interface CreateLnurlInvoiceInput {
|
|
|
3399
3536
|
metadataHash: string;
|
|
3400
3537
|
/** The expiry of the invoice in seconds. Default value is 86400 (1 day). **/
|
|
3401
3538
|
expirySecs?: number | undefined;
|
|
3539
|
+
/** An optional, monthly-rotated, unique hashed identifier corresponding to the receiver of the
|
|
3540
|
+
* payment. **/
|
|
3541
|
+
receiverHash?: string | undefined;
|
|
3402
3542
|
}
|
|
3403
3543
|
|
|
3404
3544
|
interface CreateNodeWalletAddressInput {
|
|
@@ -3480,6 +3620,7 @@ interface CreateUmaInvoiceInput {
|
|
|
3480
3620
|
amountMsats: number;
|
|
3481
3621
|
metadataHash: string;
|
|
3482
3622
|
expirySecs?: number | undefined;
|
|
3623
|
+
receiverHash?: string | undefined;
|
|
3483
3624
|
}
|
|
3484
3625
|
|
|
3485
3626
|
interface DeclineToSignMessagesInput {
|
|
@@ -3575,10 +3716,7 @@ interface Deposit {
|
|
|
3575
3716
|
resolvedAt?: string | undefined;
|
|
3576
3717
|
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
3577
3718
|
transactionHash?: string | undefined;
|
|
3578
|
-
/**
|
|
3579
|
-
* The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
|
|
3580
|
-
* blockchain.
|
|
3581
|
-
**/
|
|
3719
|
+
/** The fees that were paid by the node for this transaction. **/
|
|
3582
3720
|
fees?: CurrencyAmount | undefined;
|
|
3583
3721
|
/**
|
|
3584
3722
|
* The hash of the block that included this transaction. This will be null for unconfirmed
|
|
@@ -3590,6 +3728,20 @@ interface Deposit {
|
|
|
3590
3728
|
}
|
|
3591
3729
|
declare const getDepositQuery: (id: string) => Query<Deposit>;
|
|
3592
3730
|
|
|
3731
|
+
interface FailHtlcsInput {
|
|
3732
|
+
/** The id of invoice which the pending HTLCs that need to be failed are paying for. **/
|
|
3733
|
+
invoiceId: string;
|
|
3734
|
+
/**
|
|
3735
|
+
* Whether the invoice needs to be canceled after failing the htlcs. If yes, the invoice cannot
|
|
3736
|
+
* be paid anymore.
|
|
3737
|
+
**/
|
|
3738
|
+
cancelInvoice: boolean;
|
|
3739
|
+
}
|
|
3740
|
+
|
|
3741
|
+
interface FailHtlcsOutput {
|
|
3742
|
+
invoiceId: string;
|
|
3743
|
+
}
|
|
3744
|
+
|
|
3593
3745
|
interface FundNodeInput {
|
|
3594
3746
|
nodeId: string;
|
|
3595
3747
|
amountSats?: number | undefined;
|
|
@@ -3721,6 +3873,15 @@ interface IncomingPaymentsForInvoiceQueryOutput {
|
|
|
3721
3873
|
payments: IncomingPayment[];
|
|
3722
3874
|
}
|
|
3723
3875
|
|
|
3876
|
+
interface InvoiceForPaymentHashInput {
|
|
3877
|
+
/** The 32-byte hash of the payment preimage for which to fetch an invoice. **/
|
|
3878
|
+
paymentHash: string;
|
|
3879
|
+
}
|
|
3880
|
+
|
|
3881
|
+
interface InvoiceForPaymentHashOutput {
|
|
3882
|
+
invoiceId?: string | undefined;
|
|
3883
|
+
}
|
|
3884
|
+
|
|
3724
3885
|
interface LightningFeeEstimateForInvoiceInput {
|
|
3725
3886
|
/** The node from where you want to send the payment. **/
|
|
3726
3887
|
nodeId: string;
|
|
@@ -3932,7 +4093,7 @@ declare class LightsparkNodeWithOSK implements LightsparkNode, Node, Entity {
|
|
|
3932
4093
|
*/
|
|
3933
4094
|
encryptedSigningPrivateKey?: Secret | undefined);
|
|
3934
4095
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
3935
|
-
getChannels(client: LightsparkClient, first?: number | undefined,
|
|
4096
|
+
getChannels(client: LightsparkClient, first?: number | undefined, after?: string | undefined, beforeDate?: string | undefined, afterDate?: string | undefined, statuses?: ChannelStatus[] | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
3936
4097
|
getDailyLiquidityForecasts(client: LightsparkClient, fromDate: string, toDate: string, direction: LightningPaymentDirection): Promise<LightsparkNodeToDailyLiquidityForecastsConnection>;
|
|
3937
4098
|
static getLightsparkNodeWithOSKQuery(id: string): Query<LightsparkNodeWithOSK>;
|
|
3938
4099
|
toJson(): {
|
|
@@ -4131,7 +4292,7 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
4131
4292
|
/** The balances that describe the funds in this node. **/
|
|
4132
4293
|
balances?: Balances | undefined);
|
|
4133
4294
|
getAddresses(client: LightsparkClient, first?: number | undefined, types?: NodeAddressType[] | undefined): Promise<NodeToAddressesConnection>;
|
|
4134
|
-
getChannels(client: LightsparkClient, first?: number | undefined,
|
|
4295
|
+
getChannels(client: LightsparkClient, first?: number | undefined, after?: string | undefined, beforeDate?: string | undefined, afterDate?: string | undefined, statuses?: ChannelStatus[] | undefined): Promise<LightsparkNodeToChannelsConnection>;
|
|
4135
4296
|
getDailyLiquidityForecasts(client: LightsparkClient, fromDate: string, toDate: string, direction: LightningPaymentDirection): Promise<LightsparkNodeToDailyLiquidityForecastsConnection>;
|
|
4136
4297
|
static getLightsparkNodeWithRemoteSigningQuery(id: string): Query<LightsparkNodeWithRemoteSigning>;
|
|
4137
4298
|
toJson(): {
|
|
@@ -4159,6 +4320,22 @@ declare class LightsparkNodeWithRemoteSigning implements LightsparkNode, Node, E
|
|
|
4159
4320
|
};
|
|
4160
4321
|
}
|
|
4161
4322
|
|
|
4323
|
+
declare enum OnChainFeeTarget {
|
|
4324
|
+
/**
|
|
4325
|
+
* This is an enum value that represents values that could be added in the future.
|
|
4326
|
+
* Clients should support unknown values as more of them could be added without notice.
|
|
4327
|
+
*/
|
|
4328
|
+
FUTURE_VALUE = "FUTURE_VALUE",
|
|
4329
|
+
/** Transaction expected to be confirmed within 2 blocks. **/
|
|
4330
|
+
HIGH = "HIGH",
|
|
4331
|
+
/** Transaction expected to be confirmed within 6 blocks. **/
|
|
4332
|
+
MEDIUM = "MEDIUM",
|
|
4333
|
+
/** Transaction expected to be confirmed within 18 blocks. **/
|
|
4334
|
+
LOW = "LOW",
|
|
4335
|
+
/** Transaction expected to be confirmed within 50 blocks. **/
|
|
4336
|
+
BACKGROUND = "BACKGROUND"
|
|
4337
|
+
}
|
|
4338
|
+
|
|
4162
4339
|
/**
|
|
4163
4340
|
* This object represents an L1 transaction that occurred on the Bitcoin Network. You can retrieve
|
|
4164
4341
|
* this object to receive information about a specific on-chain transaction made on the Lightning
|
|
@@ -4191,10 +4368,7 @@ interface OnChainTransaction {
|
|
|
4191
4368
|
resolvedAt?: string | undefined;
|
|
4192
4369
|
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
4193
4370
|
transactionHash?: string | undefined;
|
|
4194
|
-
/**
|
|
4195
|
-
* The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
|
|
4196
|
-
* blockchain.
|
|
4197
|
-
**/
|
|
4371
|
+
/** The fees that were paid by the node for this transaction. **/
|
|
4198
4372
|
fees?: CurrencyAmount | undefined;
|
|
4199
4373
|
/**
|
|
4200
4374
|
* The hash of the block that included this transaction. This will be null for unconfirmed
|
|
@@ -4206,6 +4380,14 @@ interface OnChainTransaction {
|
|
|
4206
4380
|
}
|
|
4207
4381
|
declare const getOnChainTransactionQuery: (id: string) => Query<OnChainTransaction>;
|
|
4208
4382
|
|
|
4383
|
+
interface OutgoingPaymentForIdempotencyKeyInput {
|
|
4384
|
+
idempotencyKey: string;
|
|
4385
|
+
}
|
|
4386
|
+
|
|
4387
|
+
interface OutgoingPaymentForIdempotencyKeyOutput {
|
|
4388
|
+
paymentId?: string | undefined;
|
|
4389
|
+
}
|
|
4390
|
+
|
|
4209
4391
|
interface OutgoingPaymentsForInvoiceQueryInput {
|
|
4210
4392
|
/** The encoded invoice that the outgoing payments paid to. **/
|
|
4211
4393
|
encodedInvoice: string;
|
|
@@ -4217,6 +4399,17 @@ interface OutgoingPaymentsForInvoiceQueryOutput {
|
|
|
4217
4399
|
payments: OutgoingPayment[];
|
|
4218
4400
|
}
|
|
4219
4401
|
|
|
4402
|
+
interface OutgoingPaymentsForPaymentHashQueryInput {
|
|
4403
|
+
/** The 32-byte hash of the payment preimage for which to fetch payments **/
|
|
4404
|
+
paymentHash: string;
|
|
4405
|
+
/** An optional filter to only query outgoing payments of given statuses. **/
|
|
4406
|
+
statuses?: TransactionStatus[] | undefined;
|
|
4407
|
+
}
|
|
4408
|
+
|
|
4409
|
+
interface OutgoingPaymentsForPaymentHashQueryOutput {
|
|
4410
|
+
payments: OutgoingPayment[];
|
|
4411
|
+
}
|
|
4412
|
+
|
|
4220
4413
|
interface PayInvoiceInput {
|
|
4221
4414
|
/** The node from where you want to send the payment. **/
|
|
4222
4415
|
nodeId: string;
|
|
@@ -4234,6 +4427,11 @@ interface PayInvoiceInput {
|
|
|
4234
4427
|
* invoice amount is zero.
|
|
4235
4428
|
**/
|
|
4236
4429
|
amountMsats?: number | undefined;
|
|
4430
|
+
/**
|
|
4431
|
+
* The idempotency key of the request. The same result will be returned for the same
|
|
4432
|
+
* idempotency key. *
|
|
4433
|
+
*/
|
|
4434
|
+
idempotencyKey?: string | undefined;
|
|
4237
4435
|
}
|
|
4238
4436
|
|
|
4239
4437
|
interface PayInvoiceOutput {
|
|
@@ -4247,6 +4445,12 @@ interface PayUmaInvoiceInput {
|
|
|
4247
4445
|
timeoutSecs: number;
|
|
4248
4446
|
maximumFeesMsats: number;
|
|
4249
4447
|
amountMsats?: number | undefined;
|
|
4448
|
+
idempotencyKey?: string | undefined;
|
|
4449
|
+
/**
|
|
4450
|
+
* An optional, monthly-rotated, unique hashed identifier corresponding to the sender of the
|
|
4451
|
+
* payment. *
|
|
4452
|
+
*/
|
|
4453
|
+
senderHash?: string | undefined;
|
|
4250
4454
|
}
|
|
4251
4455
|
|
|
4252
4456
|
interface RegisterPaymentInput {
|
|
@@ -4314,7 +4518,8 @@ declare enum RemoteSigningSubEventType {
|
|
|
4314
4518
|
DERIVE_KEY_AND_SIGN = "DERIVE_KEY_AND_SIGN",
|
|
4315
4519
|
RELEASE_PAYMENT_PREIMAGE = "RELEASE_PAYMENT_PREIMAGE",
|
|
4316
4520
|
REQUEST_INVOICE_PAYMENT_HASH = "REQUEST_INVOICE_PAYMENT_HASH",
|
|
4317
|
-
REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET = "REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET"
|
|
4521
|
+
REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET = "REVEAL_COUNTERPARTY_PER_COMMITMENT_SECRET",
|
|
4522
|
+
VLS_MESSAGE = "VLS_MESSAGE"
|
|
4318
4523
|
}
|
|
4319
4524
|
|
|
4320
4525
|
interface RequestWithdrawalInput {
|
|
@@ -4329,6 +4534,22 @@ interface RequestWithdrawalInput {
|
|
|
4329
4534
|
amountSats: number;
|
|
4330
4535
|
/** The strategy that should be used to withdraw the funds from this node. **/
|
|
4331
4536
|
withdrawalMode: WithdrawalMode;
|
|
4537
|
+
/**
|
|
4538
|
+
* The idempotency key of the request. The same result will be returned for the same
|
|
4539
|
+
* idempotency key. *
|
|
4540
|
+
*/
|
|
4541
|
+
idempotencyKey?: string | undefined;
|
|
4542
|
+
/**
|
|
4543
|
+
* The target of the fee that should be used when crafting the L1 transaction. You should only
|
|
4544
|
+
* set `fee_target` or `sats_per_vbyte`. If neither of them is set, default value of MEDIUM
|
|
4545
|
+
* will be used as `fee_target`.
|
|
4546
|
+
**/
|
|
4547
|
+
feeTarget?: OnChainFeeTarget | undefined;
|
|
4548
|
+
/**
|
|
4549
|
+
* A manual fee rate set in sat/vbyte that should be used when crafting the L1 transaction. You
|
|
4550
|
+
* should only set `fee_target` or `sats_per_vbyte`
|
|
4551
|
+
**/
|
|
4552
|
+
satsPerVbyte?: number | undefined;
|
|
4332
4553
|
}
|
|
4333
4554
|
|
|
4334
4555
|
interface RequestWithdrawalOutput {
|
|
@@ -4420,6 +4641,11 @@ interface SendPaymentInput {
|
|
|
4420
4641
|
* msats. *
|
|
4421
4642
|
*/
|
|
4422
4643
|
maximumFeesMsats: number;
|
|
4644
|
+
/**
|
|
4645
|
+
* The idempotency key of the request. The same result will be returned for the same
|
|
4646
|
+
* idempotency key. *
|
|
4647
|
+
*/
|
|
4648
|
+
idempotencyKey?: string | undefined;
|
|
4423
4649
|
}
|
|
4424
4650
|
|
|
4425
4651
|
interface SendPaymentOutput {
|
|
@@ -4527,55 +4753,6 @@ declare enum WebhookEventType {
|
|
|
4527
4753
|
HIGH_BALANCE = "HIGH_BALANCE"
|
|
4528
4754
|
}
|
|
4529
4755
|
|
|
4530
|
-
/**
|
|
4531
|
-
* This object represents an L1 withdrawal from your Lightspark Node to any Bitcoin wallet. You can
|
|
4532
|
-
* retrieve this object to receive detailed information about any L1 withdrawal associated with
|
|
4533
|
-
* your Lightspark Node or account. *
|
|
4534
|
-
*/
|
|
4535
|
-
interface Withdrawal {
|
|
4536
|
-
/**
|
|
4537
|
-
* The unique identifier of this entity across all Lightspark systems. Should be treated as an
|
|
4538
|
-
* opaque string.
|
|
4539
|
-
**/
|
|
4540
|
-
id: string;
|
|
4541
|
-
/** The date and time when this transaction was initiated. **/
|
|
4542
|
-
createdAt: string;
|
|
4543
|
-
/** The date and time when the entity was last updated. **/
|
|
4544
|
-
updatedAt: string;
|
|
4545
|
-
/** The current status of this transaction. **/
|
|
4546
|
-
status: TransactionStatus;
|
|
4547
|
-
/** The amount of money involved in this transaction. **/
|
|
4548
|
-
amount: CurrencyAmount;
|
|
4549
|
-
/**
|
|
4550
|
-
* The height of the block that included this transaction. This will be zero for unconfirmed
|
|
4551
|
-
* transactions.
|
|
4552
|
-
**/
|
|
4553
|
-
blockHeight: number;
|
|
4554
|
-
/** The Bitcoin blockchain addresses this transaction was sent to. **/
|
|
4555
|
-
destinationAddresses: string[];
|
|
4556
|
-
/** The Lightspark node this withdrawal originated from. **/
|
|
4557
|
-
originId: string;
|
|
4558
|
-
/** The typename of the object **/
|
|
4559
|
-
typename: string;
|
|
4560
|
-
/** The date and time when this transaction was completed or failed. **/
|
|
4561
|
-
resolvedAt?: string | undefined;
|
|
4562
|
-
/** The hash of this transaction, so it can be uniquely identified on the Lightning Network. **/
|
|
4563
|
-
transactionHash?: string | undefined;
|
|
4564
|
-
/**
|
|
4565
|
-
* The fees that were paid by the wallet sending the transaction to commit it to the Bitcoin
|
|
4566
|
-
* blockchain.
|
|
4567
|
-
**/
|
|
4568
|
-
fees?: CurrencyAmount | undefined;
|
|
4569
|
-
/**
|
|
4570
|
-
* The hash of the block that included this transaction. This will be null for unconfirmed
|
|
4571
|
-
* transactions.
|
|
4572
|
-
**/
|
|
4573
|
-
blockHash?: string | undefined;
|
|
4574
|
-
/** The number of blockchain confirmations for this transaction in real time. **/
|
|
4575
|
-
numConfirmations?: number | undefined;
|
|
4576
|
-
}
|
|
4577
|
-
declare const getWithdrawalQuery: (id: string) => Query<Withdrawal>;
|
|
4578
|
-
|
|
4579
4756
|
interface WithdrawalFeeEstimateInput {
|
|
4580
4757
|
/** The node from which you'd like to make the withdrawal. **/
|
|
4581
4758
|
nodeId: string;
|
|
@@ -4593,4 +4770,4 @@ interface WithdrawalFeeEstimateOutput {
|
|
|
4593
4770
|
feeEstimate: CurrencyAmount;
|
|
4594
4771
|
}
|
|
4595
4772
|
|
|
4596
|
-
export { DeclineToSignMessagesInput as $, Account as A, Balances as B, CancelInvoiceInput as C, ClaimUmaInvitationWithIncentivesOutput as D, ComplianceProvider as E, Connection as F, CreateApiTokenInput as G, CreateApiTokenOutput as H, CreateInvitationWithIncentivesInput as I, CreateInvitationWithIncentivesOutput as J, CreateInvoiceInput as K, LightsparkClient as L, CreateInvoiceOutput as M, CreateLnurlInvoiceInput as N, CreateNodeWalletAddressInput as O, CreateNodeWalletAddressOutput as P, CreateTestModeInvoiceInput as Q, CreateTestModeInvoiceOutput as R, CreateTestModePaymentInput as S, CreateTestModePaymentoutput as T, CreateUmaInvitationInput as U, CreateUmaInvitationOutput as V, WebhookEventType as W, CreateUmaInvoiceInput as X, CurrencyAmount as Y, CurrencyUnit as Z, DailyLiquidityForecast as _, AccountToApiTokensConnection as a,
|
|
4773
|
+
export { DeclineToSignMessagesInput as $, Account as A, Balances as B, CancelInvoiceInput as C, ClaimUmaInvitationWithIncentivesOutput as D, ComplianceProvider as E, Connection as F, CreateApiTokenInput as G, CreateApiTokenOutput as H, CreateInvitationWithIncentivesInput as I, CreateInvitationWithIncentivesOutput as J, CreateInvoiceInput as K, LightsparkClient as L, CreateInvoiceOutput as M, CreateLnurlInvoiceInput as N, CreateNodeWalletAddressInput as O, CreateNodeWalletAddressOutput as P, CreateTestModeInvoiceInput as Q, CreateTestModeInvoiceOutput as R, CreateTestModePaymentInput as S, CreateTestModePaymentoutput as T, CreateUmaInvitationInput as U, CreateUmaInvitationOutput as V, WebhookEventType as W, CreateUmaInvoiceInput as X, CurrencyAmount as Y, CurrencyUnit as Z, DailyLiquidityForecast as _, AccountToApiTokensConnection as a, OutgoingPaymentsForInvoiceQueryOutput as a$, DeclineToSignMessagesOutput as a0, DeleteApiTokenInput as a1, DeleteApiTokenOutput as a2, Deposit as a3, getDepositQuery as a4, Entity as a5, FailHtlcsInput as a6, FailHtlcsOutput as a7, FeeEstimate as a8, FundNodeInput as a9, getLightningTransactionQuery as aA, LightsparkNode as aB, getLightsparkNodeQuery as aC, LightsparkNodeOwner as aD, getLightsparkNodeOwnerQuery as aE, LightsparkNodeStatus as aF, LightsparkNodeToChannelsConnection as aG, LightsparkNodeToDailyLiquidityForecastsConnection as aH, LightsparkNodeWithOSK as aI, LightsparkNodeWithRemoteSigning as aJ, MultiSigAddressValidationParameters as aK, Node as aL, getNodeQuery as aM, NodeAddress as aN, NodeAddressType as aO, NodeToAddressesConnection as aP, OnChainFeeTarget as aQ, OnChainTransaction as aR, getOnChainTransactionQuery as aS, OutgoingPayment as aT, OutgoingPaymentAttempt as aU, OutgoingPaymentAttemptStatus as aV, OutgoingPaymentAttemptToHopsConnection as aW, OutgoingPaymentForIdempotencyKeyInput as aX, OutgoingPaymentForIdempotencyKeyOutput as aY, OutgoingPaymentToAttemptsConnection as aZ, OutgoingPaymentsForInvoiceQueryInput as a_, FundNodeOutput as aa, GraphNode as ab, Hop as ac, getHopQuery as ad, HtlcAttemptFailureCode as ae, IdAndSignature as af, IncentivesIneligibilityReason as ag, IncentivesStatus as ah, IncomingPayment as ai, IncomingPaymentAttempt as aj, getIncomingPaymentAttemptQuery as ak, IncomingPaymentAttemptStatus as al, IncomingPaymentToAttemptsConnection as am, IncomingPaymentsForInvoiceQueryInput as an, IncomingPaymentsForInvoiceQueryOutput as ao, Invoice as ap, getInvoiceQuery as aq, InvoiceData as ar, InvoiceForPaymentHashInput as as, InvoiceForPaymentHashOutput as at, InvoiceType as au, LightningFeeEstimateForInvoiceInput as av, LightningFeeEstimateForNodeInput as aw, LightningFeeEstimateOutput as ax, LightningPaymentDirection as ay, LightningTransaction as az, AccountToChannelsConnection as b, WalletToWithdrawalRequestsConnection as b$, OutgoingPaymentsForPaymentHashQueryInput as b0, OutgoingPaymentsForPaymentHashQueryOutput as b1, PageInfo as b2, PayInvoiceInput as b3, PayInvoiceOutput as b4, PayUmaInvoiceInput as b5, PaymentDirection as b6, PaymentFailureReason as b7, PaymentRequest as b8, getPaymentRequestQuery as b9, SetInvoicePaymentHashOutput as bA, SignInvoiceInput as bB, SignInvoiceOutput as bC, SignMessagesInput as bD, SignMessagesOutput as bE, Signable as bF, getSignableQuery as bG, SignablePayload as bH, getSignablePayloadQuery as bI, SignablePayloadStatus as bJ, SingleNodeDashboard as bK, Transaction as bL, getTransactionQuery as bM, TransactionFailures as bN, TransactionStatus as bO, TransactionType as bP, TransactionUpdate as bQ, UmaInvitation as bR, getUmaInvitationQuery as bS, UpdateChannelPerCommitmentPointInput as bT, UpdateChannelPerCommitmentPointOutput as bU, UpdateNodeSharedSecretInput as bV, UpdateNodeSharedSecretOutput as bW, Wallet as bX, WalletStatus as bY, WalletToPaymentRequestsConnection as bZ, WalletToTransactionsConnection as b_, PaymentRequestData as ba, PaymentRequestStatus as bb, Permission as bc, PostTransactionData as bd, RegionCode as be, RegisterPaymentInput as bf, RegisterPaymentOutput as bg, ReleaseChannelPerCommitmentSecretInput as bh, ReleaseChannelPerCommitmentSecretOutput as bi, ReleasePaymentPreimageInput as bj, ReleasePaymentPreimageOutput as bk, RemoteSigningSubEventType as bl, RequestInitiator as bm, RequestWithdrawalInput as bn, RequestWithdrawalOutput as bo, RichText as bp, RiskRating as bq, RoutingTransaction as br, getRoutingTransactionQuery as bs, RoutingTransactionFailureReason as bt, ScreenNodeInput as bu, ScreenNodeOutput as bv, Secret as bw, SendPaymentInput as bx, SendPaymentOutput as by, SetInvoicePaymentHashInput as bz, AccountToNodesConnection as c, Withdrawal as c0, getWithdrawalQuery as c1, WithdrawalFeeEstimateInput as c2, WithdrawalFeeEstimateOutput as c3, WithdrawalMode as c4, WithdrawalRequest as c5, WithdrawalRequestStatus as c6, WithdrawalRequestToChannelClosingTransactionsConnection as c7, WithdrawalRequestToChannelOpeningTransactionsConnection as c8, WithdrawalRequestToWithdrawalsConnection as c9, AccountToPaymentRequestsConnection as d, AccountToTransactionsConnection as e, AccountToWalletsConnection as f, AccountToWithdrawalRequestsConnection as g, ApiToken as h, getApiTokenQuery as i, AuditLogActor as j, getAuditLogActorQuery as k, BlockchainBalance as l, CancelInvoiceOutput as m, Channel as n, ChannelClosingTransaction as o, getChannelClosingTransactionQuery as p, ChannelFees as q, ChannelOpeningTransaction as r, getChannelOpeningTransactionQuery as s, ChannelSnapshot as t, getChannelSnapshotQuery as u, ChannelStatus as v, ChannelToTransactionsConnection as w, ClaimUmaInvitationInput as x, ClaimUmaInvitationOutput as y, ClaimUmaInvitationWithIncentivesInput as z };
|