@breeztech/breez-sdk-spark-react-native 0.4.2 → 0.5.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.
@@ -583,6 +583,50 @@ export declare const ClaimDepositResponse: Readonly<{
583
583
  */
584
584
  defaults: () => Partial<ClaimDepositResponse>;
585
585
  }>;
586
+ export type ClaimHtlcPaymentRequest = {
587
+ preimage: string;
588
+ };
589
+ /**
590
+ * Generated factory for {@link ClaimHtlcPaymentRequest} record objects.
591
+ */
592
+ export declare const ClaimHtlcPaymentRequest: Readonly<{
593
+ /**
594
+ * Create a frozen instance of {@link ClaimHtlcPaymentRequest}, with defaults specified
595
+ * in Rust, in the {@link breez_sdk_spark} crate.
596
+ */
597
+ create: (partial: Partial<ClaimHtlcPaymentRequest> & Required<Omit<ClaimHtlcPaymentRequest, never>>) => ClaimHtlcPaymentRequest;
598
+ /**
599
+ * Create a frozen instance of {@link ClaimHtlcPaymentRequest}, with defaults specified
600
+ * in Rust, in the {@link breez_sdk_spark} crate.
601
+ */
602
+ new: (partial: Partial<ClaimHtlcPaymentRequest> & Required<Omit<ClaimHtlcPaymentRequest, never>>) => ClaimHtlcPaymentRequest;
603
+ /**
604
+ * Defaults specified in the {@link breez_sdk_spark} crate.
605
+ */
606
+ defaults: () => Partial<ClaimHtlcPaymentRequest>;
607
+ }>;
608
+ export type ClaimHtlcPaymentResponse = {
609
+ payment: Payment;
610
+ };
611
+ /**
612
+ * Generated factory for {@link ClaimHtlcPaymentResponse} record objects.
613
+ */
614
+ export declare const ClaimHtlcPaymentResponse: Readonly<{
615
+ /**
616
+ * Create a frozen instance of {@link ClaimHtlcPaymentResponse}, with defaults specified
617
+ * in Rust, in the {@link breez_sdk_spark} crate.
618
+ */
619
+ create: (partial: Partial<ClaimHtlcPaymentResponse> & Required<Omit<ClaimHtlcPaymentResponse, never>>) => ClaimHtlcPaymentResponse;
620
+ /**
621
+ * Create a frozen instance of {@link ClaimHtlcPaymentResponse}, with defaults specified
622
+ * in Rust, in the {@link breez_sdk_spark} crate.
623
+ */
624
+ new: (partial: Partial<ClaimHtlcPaymentResponse> & Required<Omit<ClaimHtlcPaymentResponse, never>>) => ClaimHtlcPaymentResponse;
625
+ /**
626
+ * Defaults specified in the {@link breez_sdk_spark} crate.
627
+ */
628
+ defaults: () => Partial<ClaimHtlcPaymentResponse>;
629
+ }>;
586
630
  export type Config = {
587
631
  apiKey: string | undefined;
588
632
  network: Network;
@@ -1159,6 +1203,10 @@ export type ListPaymentsRequest = {
1159
1203
  typeFilter: Array<PaymentType> | undefined;
1160
1204
  statusFilter: Array<PaymentStatus> | undefined;
1161
1205
  assetFilter: AssetFilter | undefined;
1206
+ /**
1207
+ * Only include payments with specific Spark HTLC statuses
1208
+ */
1209
+ sparkHtlcStatusFilter: Array<SparkHtlcStatus> | undefined;
1162
1210
  /**
1163
1211
  * Only include payments created after this timestamp (inclusive)
1164
1212
  */
@@ -1185,12 +1233,12 @@ export declare const ListPaymentsRequest: Readonly<{
1185
1233
  * Create a frozen instance of {@link ListPaymentsRequest}, with defaults specified
1186
1234
  * in Rust, in the {@link breez_sdk_spark} crate.
1187
1235
  */
1188
- create: (partial: Partial<ListPaymentsRequest> & Required<Omit<ListPaymentsRequest, "typeFilter" | "statusFilter" | "assetFilter" | "fromTimestamp" | "toTimestamp" | "offset" | "limit" | "sortAscending">>) => ListPaymentsRequest;
1236
+ create: (partial: Partial<ListPaymentsRequest> & Required<Omit<ListPaymentsRequest, "typeFilter" | "statusFilter" | "assetFilter" | "sparkHtlcStatusFilter" | "fromTimestamp" | "toTimestamp" | "offset" | "limit" | "sortAscending">>) => ListPaymentsRequest;
1189
1237
  /**
1190
1238
  * Create a frozen instance of {@link ListPaymentsRequest}, with defaults specified
1191
1239
  * in Rust, in the {@link breez_sdk_spark} crate.
1192
1240
  */
1193
- new: (partial: Partial<ListPaymentsRequest> & Required<Omit<ListPaymentsRequest, "typeFilter" | "statusFilter" | "assetFilter" | "fromTimestamp" | "toTimestamp" | "offset" | "limit" | "sortAscending">>) => ListPaymentsRequest;
1241
+ new: (partial: Partial<ListPaymentsRequest> & Required<Omit<ListPaymentsRequest, "typeFilter" | "statusFilter" | "assetFilter" | "sparkHtlcStatusFilter" | "fromTimestamp" | "toTimestamp" | "offset" | "limit" | "sortAscending">>) => ListPaymentsRequest;
1194
1242
  /**
1195
1243
  * Defaults specified in the {@link breez_sdk_spark} crate.
1196
1244
  */
@@ -1267,7 +1315,7 @@ export declare const ListUnclaimedDepositsResponse: Readonly<{
1267
1315
  defaults: () => Partial<ListUnclaimedDepositsResponse>;
1268
1316
  }>;
1269
1317
  /**
1270
- * Wrapped in a [`LnurlAuth`], this is the result of [`parse`] when given a LNURL-auth endpoint.
1318
+ * Wrapped in a [`InputType::LnurlAuth`], this is the result of [`parse`](breez_sdk_common::input::parse) when given a LNURL-auth endpoint.
1271
1319
  *
1272
1320
  * It represents the endpoint's parameters for the LNURL workflow.
1273
1321
  *
@@ -1344,6 +1392,12 @@ export declare const LnurlPayInfo: Readonly<{
1344
1392
  }>;
1345
1393
  export type LnurlPayRequest = {
1346
1394
  prepareResponse: PrepareLnurlPayResponse;
1395
+ /**
1396
+ * If set, providing the same idempotency key for multiple requests will ensure that only one
1397
+ * payment is made. If an idempotency key is re-used, the same payment will be returned.
1398
+ * The idempotency key must be a valid UUID.
1399
+ */
1400
+ idempotencyKey: string | undefined;
1347
1401
  };
1348
1402
  /**
1349
1403
  * Generated factory for {@link LnurlPayRequest} record objects.
@@ -1353,12 +1407,12 @@ export declare const LnurlPayRequest: Readonly<{
1353
1407
  * Create a frozen instance of {@link LnurlPayRequest}, with defaults specified
1354
1408
  * in Rust, in the {@link breez_sdk_spark} crate.
1355
1409
  */
1356
- create: (partial: Partial<LnurlPayRequest> & Required<Omit<LnurlPayRequest, never>>) => LnurlPayRequest;
1410
+ create: (partial: Partial<LnurlPayRequest> & Required<Omit<LnurlPayRequest, "idempotencyKey">>) => LnurlPayRequest;
1357
1411
  /**
1358
1412
  * Create a frozen instance of {@link LnurlPayRequest}, with defaults specified
1359
1413
  * in Rust, in the {@link breez_sdk_spark} crate.
1360
1414
  */
1361
- new: (partial: Partial<LnurlPayRequest> & Required<Omit<LnurlPayRequest, never>>) => LnurlPayRequest;
1415
+ new: (partial: Partial<LnurlPayRequest> & Required<Omit<LnurlPayRequest, "idempotencyKey">>) => LnurlPayRequest;
1362
1416
  /**
1363
1417
  * Defaults specified in the {@link breez_sdk_spark} crate.
1364
1418
  */
@@ -2044,6 +2098,32 @@ export declare const ReceivePaymentResponse: Readonly<{
2044
2098
  */
2045
2099
  defaults: () => Partial<ReceivePaymentResponse>;
2046
2100
  }>;
2101
+ export type RecommendedFees = {
2102
+ fastestFee: bigint;
2103
+ halfHourFee: bigint;
2104
+ hourFee: bigint;
2105
+ economyFee: bigint;
2106
+ minimumFee: bigint;
2107
+ };
2108
+ /**
2109
+ * Generated factory for {@link RecommendedFees} record objects.
2110
+ */
2111
+ export declare const RecommendedFees: Readonly<{
2112
+ /**
2113
+ * Create a frozen instance of {@link RecommendedFees}, with defaults specified
2114
+ * in Rust, in the {@link breez_sdk_spark} crate.
2115
+ */
2116
+ create: (partial: Partial<RecommendedFees> & Required<Omit<RecommendedFees, never>>) => RecommendedFees;
2117
+ /**
2118
+ * Create a frozen instance of {@link RecommendedFees}, with defaults specified
2119
+ * in Rust, in the {@link breez_sdk_spark} crate.
2120
+ */
2121
+ new: (partial: Partial<RecommendedFees> & Required<Omit<RecommendedFees, never>>) => RecommendedFees;
2122
+ /**
2123
+ * Defaults specified in the {@link breez_sdk_spark} crate.
2124
+ */
2125
+ defaults: () => Partial<RecommendedFees>;
2126
+ }>;
2047
2127
  export type Record = {
2048
2128
  id: RecordId;
2049
2129
  revision: bigint;
@@ -2263,6 +2343,13 @@ export declare const SendOnchainSpeedFeeQuote: Readonly<{
2263
2343
  export type SendPaymentRequest = {
2264
2344
  prepareResponse: PrepareSendPaymentResponse;
2265
2345
  options: SendPaymentOptions | undefined;
2346
+ /**
2347
+ * The optional idempotency key for all Spark based transfers (excludes token payments).
2348
+ * If set, providing the same idempotency key for multiple requests will ensure that only one
2349
+ * payment is made. If an idempotency key is re-used, the same payment will be returned.
2350
+ * The idempotency key must be a valid UUID.
2351
+ */
2352
+ idempotencyKey: string | undefined;
2266
2353
  };
2267
2354
  /**
2268
2355
  * Generated factory for {@link SendPaymentRequest} record objects.
@@ -2272,12 +2359,12 @@ export declare const SendPaymentRequest: Readonly<{
2272
2359
  * Create a frozen instance of {@link SendPaymentRequest}, with defaults specified
2273
2360
  * in Rust, in the {@link breez_sdk_spark} crate.
2274
2361
  */
2275
- create: (partial: Partial<SendPaymentRequest> & Required<Omit<SendPaymentRequest, "options">>) => SendPaymentRequest;
2362
+ create: (partial: Partial<SendPaymentRequest> & Required<Omit<SendPaymentRequest, "idempotencyKey" | "options">>) => SendPaymentRequest;
2276
2363
  /**
2277
2364
  * Create a frozen instance of {@link SendPaymentRequest}, with defaults specified
2278
2365
  * in Rust, in the {@link breez_sdk_spark} crate.
2279
2366
  */
2280
- new: (partial: Partial<SendPaymentRequest> & Required<Omit<SendPaymentRequest, "options">>) => SendPaymentRequest;
2367
+ new: (partial: Partial<SendPaymentRequest> & Required<Omit<SendPaymentRequest, "idempotencyKey" | "options">>) => SendPaymentRequest;
2281
2368
  /**
2282
2369
  * Defaults specified in the {@link breez_sdk_spark} crate.
2283
2370
  */
@@ -2412,6 +2499,73 @@ export declare const SparkAddressDetails: Readonly<{
2412
2499
  */
2413
2500
  defaults: () => Partial<SparkAddressDetails>;
2414
2501
  }>;
2502
+ export type SparkHtlcDetails = {
2503
+ /**
2504
+ * The payment hash of the HTLC
2505
+ */
2506
+ paymentHash: string;
2507
+ /**
2508
+ * The preimage of the HTLC. Empty until receiver has released it.
2509
+ */
2510
+ preimage: string | undefined;
2511
+ /**
2512
+ * The expiry time of the HTLC in seconds since the Unix epoch
2513
+ */
2514
+ expiryTime: bigint;
2515
+ /**
2516
+ * The HTLC status
2517
+ */
2518
+ status: SparkHtlcStatus;
2519
+ };
2520
+ /**
2521
+ * Generated factory for {@link SparkHtlcDetails} record objects.
2522
+ */
2523
+ export declare const SparkHtlcDetails: Readonly<{
2524
+ /**
2525
+ * Create a frozen instance of {@link SparkHtlcDetails}, with defaults specified
2526
+ * in Rust, in the {@link breez_sdk_spark} crate.
2527
+ */
2528
+ create: (partial: Partial<SparkHtlcDetails> & Required<Omit<SparkHtlcDetails, never>>) => SparkHtlcDetails;
2529
+ /**
2530
+ * Create a frozen instance of {@link SparkHtlcDetails}, with defaults specified
2531
+ * in Rust, in the {@link breez_sdk_spark} crate.
2532
+ */
2533
+ new: (partial: Partial<SparkHtlcDetails> & Required<Omit<SparkHtlcDetails, never>>) => SparkHtlcDetails;
2534
+ /**
2535
+ * Defaults specified in the {@link breez_sdk_spark} crate.
2536
+ */
2537
+ defaults: () => Partial<SparkHtlcDetails>;
2538
+ }>;
2539
+ export type SparkHtlcOptions = {
2540
+ /**
2541
+ * The payment hash of the HTLC. The receiver will need to provide the associated preimage to claim it.
2542
+ */
2543
+ paymentHash: string;
2544
+ /**
2545
+ * The duration of the HTLC in seconds.
2546
+ * After this time, the HTLC will be returned.
2547
+ */
2548
+ expiryDurationSecs: bigint;
2549
+ };
2550
+ /**
2551
+ * Generated factory for {@link SparkHtlcOptions} record objects.
2552
+ */
2553
+ export declare const SparkHtlcOptions: Readonly<{
2554
+ /**
2555
+ * Create a frozen instance of {@link SparkHtlcOptions}, with defaults specified
2556
+ * in Rust, in the {@link breez_sdk_spark} crate.
2557
+ */
2558
+ create: (partial: Partial<SparkHtlcOptions> & Required<Omit<SparkHtlcOptions, never>>) => SparkHtlcOptions;
2559
+ /**
2560
+ * Create a frozen instance of {@link SparkHtlcOptions}, with defaults specified
2561
+ * in Rust, in the {@link breez_sdk_spark} crate.
2562
+ */
2563
+ new: (partial: Partial<SparkHtlcOptions> & Required<Omit<SparkHtlcOptions, never>>) => SparkHtlcOptions;
2564
+ /**
2565
+ * Defaults specified in the {@link breez_sdk_spark} crate.
2566
+ */
2567
+ defaults: () => Partial<SparkHtlcOptions>;
2568
+ }>;
2415
2569
  export type SparkInvoiceDetails = {
2416
2570
  /**
2417
2571
  * The raw invoice string
@@ -2819,50 +2973,6 @@ export declare const Utxo: Readonly<{
2819
2973
  */
2820
2974
  defaults: () => Partial<Utxo>;
2821
2975
  }>;
2822
- export type WaitForPaymentRequest = {
2823
- identifier: WaitForPaymentIdentifier;
2824
- };
2825
- /**
2826
- * Generated factory for {@link WaitForPaymentRequest} record objects.
2827
- */
2828
- export declare const WaitForPaymentRequest: Readonly<{
2829
- /**
2830
- * Create a frozen instance of {@link WaitForPaymentRequest}, with defaults specified
2831
- * in Rust, in the {@link breez_sdk_spark} crate.
2832
- */
2833
- create: (partial: Partial<WaitForPaymentRequest> & Required<Omit<WaitForPaymentRequest, never>>) => WaitForPaymentRequest;
2834
- /**
2835
- * Create a frozen instance of {@link WaitForPaymentRequest}, with defaults specified
2836
- * in Rust, in the {@link breez_sdk_spark} crate.
2837
- */
2838
- new: (partial: Partial<WaitForPaymentRequest> & Required<Omit<WaitForPaymentRequest, never>>) => WaitForPaymentRequest;
2839
- /**
2840
- * Defaults specified in the {@link breez_sdk_spark} crate.
2841
- */
2842
- defaults: () => Partial<WaitForPaymentRequest>;
2843
- }>;
2844
- export type WaitForPaymentResponse = {
2845
- payment: Payment;
2846
- };
2847
- /**
2848
- * Generated factory for {@link WaitForPaymentResponse} record objects.
2849
- */
2850
- export declare const WaitForPaymentResponse: Readonly<{
2851
- /**
2852
- * Create a frozen instance of {@link WaitForPaymentResponse}, with defaults specified
2853
- * in Rust, in the {@link breez_sdk_spark} crate.
2854
- */
2855
- create: (partial: Partial<WaitForPaymentResponse> & Required<Omit<WaitForPaymentResponse, never>>) => WaitForPaymentResponse;
2856
- /**
2857
- * Create a frozen instance of {@link WaitForPaymentResponse}, with defaults specified
2858
- * in Rust, in the {@link breez_sdk_spark} crate.
2859
- */
2860
- new: (partial: Partial<WaitForPaymentResponse> & Required<Omit<WaitForPaymentResponse, never>>) => WaitForPaymentResponse;
2861
- /**
2862
- * Defaults specified in the {@link breez_sdk_spark} crate.
2863
- */
2864
- defaults: () => Partial<WaitForPaymentResponse>;
2865
- }>;
2866
2976
  /**
2867
2977
  * Typealias from the type name used in the UDL file to the custom type. This
2868
2978
  * is needed because the UDL type name is used in function/method signatures.
@@ -3152,6 +3262,10 @@ export declare enum BitcoinNetwork {
3152
3262
  Signet = 3,
3153
3263
  Regtest = 4
3154
3264
  }
3265
+ export declare enum ChainApiType {
3266
+ Esplora = 0,
3267
+ MempoolSpace = 1
3268
+ }
3155
3269
  export declare enum ChainServiceError_Tags {
3156
3270
  InvalidAddress = "InvalidAddress",
3157
3271
  ServiceConnectivity = "ServiceConnectivity",
@@ -4062,10 +4176,14 @@ export declare const PaymentDetails: Readonly<{
4062
4176
  /**
4063
4177
  * The invoice details if the payment fulfilled a spark invoice
4064
4178
  */ invoiceDetails: SparkInvoicePaymentDetails | undefined;
4179
+ /**
4180
+ * The HTLC transfer details if the payment fulfilled an HTLC transfer
4181
+ */ htlcDetails: SparkHtlcDetails | undefined;
4065
4182
  }): {
4066
4183
  readonly tag: PaymentDetails_Tags.Spark;
4067
4184
  readonly inner: Readonly<{
4068
4185
  invoiceDetails: SparkInvoicePaymentDetails | undefined;
4186
+ htlcDetails: SparkHtlcDetails | undefined;
4069
4187
  }>;
4070
4188
  /**
4071
4189
  * @private
@@ -4077,10 +4195,14 @@ export declare const PaymentDetails: Readonly<{
4077
4195
  /**
4078
4196
  * The invoice details if the payment fulfilled a spark invoice
4079
4197
  */ invoiceDetails: SparkInvoicePaymentDetails | undefined;
4198
+ /**
4199
+ * The HTLC transfer details if the payment fulfilled an HTLC transfer
4200
+ */ htlcDetails: SparkHtlcDetails | undefined;
4080
4201
  }): {
4081
4202
  readonly tag: PaymentDetails_Tags.Spark;
4082
4203
  readonly inner: Readonly<{
4083
4204
  invoiceDetails: SparkInvoicePaymentDetails | undefined;
4205
+ htlcDetails: SparkHtlcDetails | undefined;
4084
4206
  }>;
4085
4207
  /**
4086
4208
  * @private
@@ -4092,6 +4214,7 @@ export declare const PaymentDetails: Readonly<{
4092
4214
  readonly tag: PaymentDetails_Tags.Spark;
4093
4215
  readonly inner: Readonly<{
4094
4216
  invoiceDetails: SparkInvoicePaymentDetails | undefined;
4217
+ htlcDetails: SparkHtlcDetails | undefined;
4095
4218
  }>;
4096
4219
  /**
4097
4220
  * @private
@@ -6303,7 +6426,8 @@ export declare const SendPaymentMethod: Readonly<{
6303
6426
  export type SendPaymentMethod = InstanceType<(typeof SendPaymentMethod)[keyof Omit<typeof SendPaymentMethod, 'instanceOf'>]>;
6304
6427
  export declare enum SendPaymentOptions_Tags {
6305
6428
  BitcoinAddress = "BitcoinAddress",
6306
- Bolt11Invoice = "Bolt11Invoice"
6429
+ Bolt11Invoice = "Bolt11Invoice",
6430
+ SparkAddress = "SparkAddress"
6307
6431
  }
6308
6432
  export declare const SendPaymentOptions: Readonly<{
6309
6433
  instanceOf: (obj: any) => obj is SendPaymentOptions;
@@ -6396,6 +6520,51 @@ export declare const SendPaymentOptions: Readonly<{
6396
6520
  readonly [uniffiTypeNameSymbol]: "SendPaymentOptions";
6397
6521
  };
6398
6522
  };
6523
+ SparkAddress: {
6524
+ new (inner: {
6525
+ /**
6526
+ * Can only be provided for Bitcoin payments. If set, a Spark HTLC transfer will be created.
6527
+ * The receiver will need to provide the preimage to claim it.
6528
+ */ htlcOptions: SparkHtlcOptions | undefined;
6529
+ }): {
6530
+ readonly tag: SendPaymentOptions_Tags.SparkAddress;
6531
+ readonly inner: Readonly<{
6532
+ htlcOptions: SparkHtlcOptions | undefined;
6533
+ }>;
6534
+ /**
6535
+ * @private
6536
+ * This field is private and should not be used, use `tag` instead.
6537
+ */
6538
+ readonly [uniffiTypeNameSymbol]: "SendPaymentOptions";
6539
+ };
6540
+ "new"(inner: {
6541
+ /**
6542
+ * Can only be provided for Bitcoin payments. If set, a Spark HTLC transfer will be created.
6543
+ * The receiver will need to provide the preimage to claim it.
6544
+ */ htlcOptions: SparkHtlcOptions | undefined;
6545
+ }): {
6546
+ readonly tag: SendPaymentOptions_Tags.SparkAddress;
6547
+ readonly inner: Readonly<{
6548
+ htlcOptions: SparkHtlcOptions | undefined;
6549
+ }>;
6550
+ /**
6551
+ * @private
6552
+ * This field is private and should not be used, use `tag` instead.
6553
+ */
6554
+ readonly [uniffiTypeNameSymbol]: "SendPaymentOptions";
6555
+ };
6556
+ instanceOf(obj: any): obj is {
6557
+ readonly tag: SendPaymentOptions_Tags.SparkAddress;
6558
+ readonly inner: Readonly<{
6559
+ htlcOptions: SparkHtlcOptions | undefined;
6560
+ }>;
6561
+ /**
6562
+ * @private
6563
+ * This field is private and should not be used, use `tag` instead.
6564
+ */
6565
+ readonly [uniffiTypeNameSymbol]: "SendPaymentOptions";
6566
+ };
6567
+ };
6399
6568
  }>;
6400
6569
  export type SendPaymentOptions = InstanceType<(typeof SendPaymentOptions)[keyof Omit<typeof SendPaymentOptions, 'instanceOf'>]>;
6401
6570
  export declare enum ServiceConnectivityError_Tags {
@@ -7148,6 +7317,20 @@ export declare const ServiceConnectivityError: Readonly<{
7148
7317
  };
7149
7318
  }>;
7150
7319
  export type ServiceConnectivityError = InstanceType<(typeof ServiceConnectivityError)[keyof Omit<typeof ServiceConnectivityError, 'instanceOf'>]>;
7320
+ export declare enum SparkHtlcStatus {
7321
+ /**
7322
+ * The HTLC is waiting for the preimage to be shared by the receiver
7323
+ */
7324
+ WaitingForPreimage = 0,
7325
+ /**
7326
+ * The HTLC preimage has been shared and the transfer can be or has been claimed by the receiver
7327
+ */
7328
+ PreimageShared = 1,
7329
+ /**
7330
+ * The HTLC has been returned to the sender due to expiry
7331
+ */
7332
+ Returned = 2
7333
+ }
7151
7334
  export declare enum StorageError_Tags {
7152
7335
  Implementation = "Implementation",
7153
7336
  InitializationError = "InitializationError",
@@ -7969,72 +8152,6 @@ export declare const UpdateDepositPayload: Readonly<{
7969
8152
  };
7970
8153
  }>;
7971
8154
  export type UpdateDepositPayload = InstanceType<(typeof UpdateDepositPayload)[keyof Omit<typeof UpdateDepositPayload, 'instanceOf'>]>;
7972
- export declare enum WaitForPaymentIdentifier_Tags {
7973
- PaymentId = "PaymentId",
7974
- PaymentRequest = "PaymentRequest"
7975
- }
7976
- export declare const WaitForPaymentIdentifier: Readonly<{
7977
- instanceOf: (obj: any) => obj is WaitForPaymentIdentifier;
7978
- PaymentId: {
7979
- new (v0: string): {
7980
- readonly tag: WaitForPaymentIdentifier_Tags.PaymentId;
7981
- readonly inner: Readonly<[string]>;
7982
- /**
7983
- * @private
7984
- * This field is private and should not be used, use `tag` instead.
7985
- */
7986
- readonly [uniffiTypeNameSymbol]: "WaitForPaymentIdentifier";
7987
- };
7988
- "new"(v0: string): {
7989
- readonly tag: WaitForPaymentIdentifier_Tags.PaymentId;
7990
- readonly inner: Readonly<[string]>;
7991
- /**
7992
- * @private
7993
- * This field is private and should not be used, use `tag` instead.
7994
- */
7995
- readonly [uniffiTypeNameSymbol]: "WaitForPaymentIdentifier";
7996
- };
7997
- instanceOf(obj: any): obj is {
7998
- readonly tag: WaitForPaymentIdentifier_Tags.PaymentId;
7999
- readonly inner: Readonly<[string]>;
8000
- /**
8001
- * @private
8002
- * This field is private and should not be used, use `tag` instead.
8003
- */
8004
- readonly [uniffiTypeNameSymbol]: "WaitForPaymentIdentifier";
8005
- };
8006
- };
8007
- PaymentRequest: {
8008
- new (v0: string): {
8009
- readonly tag: WaitForPaymentIdentifier_Tags.PaymentRequest;
8010
- readonly inner: Readonly<[string]>;
8011
- /**
8012
- * @private
8013
- * This field is private and should not be used, use `tag` instead.
8014
- */
8015
- readonly [uniffiTypeNameSymbol]: "WaitForPaymentIdentifier";
8016
- };
8017
- "new"(v0: string): {
8018
- readonly tag: WaitForPaymentIdentifier_Tags.PaymentRequest;
8019
- readonly inner: Readonly<[string]>;
8020
- /**
8021
- * @private
8022
- * This field is private and should not be used, use `tag` instead.
8023
- */
8024
- readonly [uniffiTypeNameSymbol]: "WaitForPaymentIdentifier";
8025
- };
8026
- instanceOf(obj: any): obj is {
8027
- readonly tag: WaitForPaymentIdentifier_Tags.PaymentRequest;
8028
- readonly inner: Readonly<[string]>;
8029
- /**
8030
- * @private
8031
- * This field is private and should not be used, use `tag` instead.
8032
- */
8033
- readonly [uniffiTypeNameSymbol]: "WaitForPaymentIdentifier";
8034
- };
8035
- };
8036
- }>;
8037
- export type WaitForPaymentIdentifier = InstanceType<(typeof WaitForPaymentIdentifier)[keyof Omit<typeof WaitForPaymentIdentifier, 'instanceOf'>]>;
8038
8155
  export interface BitcoinChainService {
8039
8156
  getAddressUtxos(address: string, asyncOpts_?: {
8040
8157
  signal: AbortSignal;
@@ -8048,6 +8165,9 @@ export interface BitcoinChainService {
8048
8165
  broadcastTransaction(tx: string, asyncOpts_?: {
8049
8166
  signal: AbortSignal;
8050
8167
  }): Promise<void>;
8168
+ recommendedFees(asyncOpts_?: {
8169
+ signal: AbortSignal;
8170
+ }): Promise<RecommendedFees>;
8051
8171
  }
8052
8172
  export declare class BitcoinChainServiceImpl extends UniffiAbstractObject implements BitcoinChainService {
8053
8173
  readonly [uniffiTypeNameSymbol] = "BitcoinChainServiceImpl";
@@ -8066,6 +8186,9 @@ export declare class BitcoinChainServiceImpl extends UniffiAbstractObject implem
8066
8186
  broadcastTransaction(tx: string, asyncOpts_?: {
8067
8187
  signal: AbortSignal;
8068
8188
  }): Promise<void>;
8189
+ recommendedFees(asyncOpts_?: {
8190
+ signal: AbortSignal;
8191
+ }): Promise<RecommendedFees>;
8069
8192
  /**
8070
8193
  * {@inheritDoc uniffi-bindgen-react-native#UniffiAbstractObject.uniffiDestroy}
8071
8194
  */
@@ -8105,6 +8228,9 @@ export interface BreezSdkInterface {
8105
8228
  claimDeposit(request: ClaimDepositRequest, asyncOpts_?: {
8106
8229
  signal: AbortSignal;
8107
8230
  }): Promise<ClaimDepositResponse>;
8231
+ claimHtlcPayment(request: ClaimHtlcPaymentRequest, asyncOpts_?: {
8232
+ signal: AbortSignal;
8233
+ }): Promise<ClaimHtlcPaymentResponse>;
8108
8234
  deleteLightningAddress(asyncOpts_?: {
8109
8235
  signal: AbortSignal;
8110
8236
  }): Promise<void>;
@@ -8236,6 +8362,12 @@ export interface BreezSdkInterface {
8236
8362
  receivePayment(request: ReceivePaymentRequest, asyncOpts_?: {
8237
8363
  signal: AbortSignal;
8238
8364
  }): Promise<ReceivePaymentResponse>;
8365
+ /**
8366
+ * Get the recommended BTC fees based on the configured chain service.
8367
+ */
8368
+ recommendedFees(asyncOpts_?: {
8369
+ signal: AbortSignal;
8370
+ }): Promise<RecommendedFees>;
8239
8371
  refundDeposit(request: RefundDepositRequest, asyncOpts_?: {
8240
8372
  signal: AbortSignal;
8241
8373
  }): Promise<RefundDepositResponse>;
@@ -8281,9 +8413,6 @@ export interface BreezSdkInterface {
8281
8413
  updateUserSettings(request: UpdateUserSettingsRequest, asyncOpts_?: {
8282
8414
  signal: AbortSignal;
8283
8415
  }): Promise<void>;
8284
- waitForPayment(request: WaitForPaymentRequest, asyncOpts_?: {
8285
- signal: AbortSignal;
8286
- }): Promise<WaitForPaymentResponse>;
8287
8416
  }
8288
8417
  /**
8289
8418
  * `BreezSDK` is a wrapper around `SparkSDK` that provides a more structured API
@@ -8322,6 +8451,9 @@ export declare class BreezSdk extends UniffiAbstractObject implements BreezSdkIn
8322
8451
  claimDeposit(request: ClaimDepositRequest, asyncOpts_?: {
8323
8452
  signal: AbortSignal;
8324
8453
  }): Promise<ClaimDepositResponse>;
8454
+ claimHtlcPayment(request: ClaimHtlcPaymentRequest, asyncOpts_?: {
8455
+ signal: AbortSignal;
8456
+ }): Promise<ClaimHtlcPaymentResponse>;
8325
8457
  deleteLightningAddress(asyncOpts_?: {
8326
8458
  signal: AbortSignal;
8327
8459
  }): Promise<void>;
@@ -8453,6 +8585,12 @@ export declare class BreezSdk extends UniffiAbstractObject implements BreezSdkIn
8453
8585
  receivePayment(request: ReceivePaymentRequest, asyncOpts_?: {
8454
8586
  signal: AbortSignal;
8455
8587
  }): Promise<ReceivePaymentResponse>;
8588
+ /**
8589
+ * Get the recommended BTC fees based on the configured chain service.
8590
+ */
8591
+ recommendedFees(asyncOpts_?: {
8592
+ signal: AbortSignal;
8593
+ }): Promise<RecommendedFees>;
8456
8594
  refundDeposit(request: RefundDepositRequest, asyncOpts_?: {
8457
8595
  signal: AbortSignal;
8458
8596
  }): Promise<RefundDepositResponse>;
@@ -8498,9 +8636,6 @@ export declare class BreezSdk extends UniffiAbstractObject implements BreezSdkIn
8498
8636
  updateUserSettings(request: UpdateUserSettingsRequest, asyncOpts_?: {
8499
8637
  signal: AbortSignal;
8500
8638
  }): Promise<void>;
8501
- waitForPayment(request: WaitForPaymentRequest, asyncOpts_?: {
8502
- signal: AbortSignal;
8503
- }): Promise<WaitForPaymentResponse>;
8504
8639
  /**
8505
8640
  * {@inheritDoc uniffi-bindgen-react-native#UniffiAbstractObject.uniffiDestroy}
8506
8641
  */
@@ -8722,9 +8857,10 @@ export interface SdkBuilderInterface {
8722
8857
  * Sets the REST chain service to be used by the SDK.
8723
8858
  * Arguments:
8724
8859
  * - `url`: The base URL of the REST API.
8860
+ * - `api_type`: The API type to be used.
8725
8861
  * - `credentials`: Optional credentials for basic authentication.
8726
8862
  */
8727
- withRestChainService(url: string, credentials: Credentials | undefined, asyncOpts_?: {
8863
+ withRestChainService(url: string, apiType: ChainApiType, credentials: Credentials | undefined, asyncOpts_?: {
8728
8864
  signal: AbortSignal;
8729
8865
  }): Promise<void>;
8730
8866
  /**
@@ -8814,9 +8950,10 @@ export declare class SdkBuilder extends UniffiAbstractObject implements SdkBuild
8814
8950
  * Sets the REST chain service to be used by the SDK.
8815
8951
  * Arguments:
8816
8952
  * - `url`: The base URL of the REST API.
8953
+ * - `api_type`: The API type to be used.
8817
8954
  * - `credentials`: Optional credentials for basic authentication.
8818
8955
  */
8819
- withRestChainService(url: string, credentials: Credentials | undefined, asyncOpts_?: {
8956
+ withRestChainService(url: string, apiType: ChainApiType, credentials: Credentials | undefined, asyncOpts_?: {
8820
8957
  signal: AbortSignal;
8821
8958
  }): Promise<void>;
8822
8959
  /**
@@ -9604,6 +9741,13 @@ declare const _default: Readonly<{
9604
9741
  lift(value: UniffiByteArray): BurnIssuerTokenRequest;
9605
9742
  lower(value: BurnIssuerTokenRequest): UniffiByteArray;
9606
9743
  };
9744
+ FfiConverterTypeChainApiType: {
9745
+ read(from: RustBuffer): ChainApiType;
9746
+ write(value: ChainApiType, into: RustBuffer): void;
9747
+ allocationSize(value: ChainApiType): number;
9748
+ lift(value: UniffiByteArray): ChainApiType;
9749
+ lower(value: ChainApiType): UniffiByteArray;
9750
+ };
9607
9751
  FfiConverterTypeCheckLightningAddressRequest: {
9608
9752
  read(from: RustBuffer): CheckLightningAddressRequest;
9609
9753
  write(value: CheckLightningAddressRequest, into: RustBuffer): void;
@@ -9639,6 +9783,20 @@ declare const _default: Readonly<{
9639
9783
  lift(value: UniffiByteArray): ClaimDepositResponse;
9640
9784
  lower(value: ClaimDepositResponse): UniffiByteArray;
9641
9785
  };
9786
+ FfiConverterTypeClaimHtlcPaymentRequest: {
9787
+ read(from: RustBuffer): ClaimHtlcPaymentRequest;
9788
+ write(value: ClaimHtlcPaymentRequest, into: RustBuffer): void;
9789
+ allocationSize(value: ClaimHtlcPaymentRequest): number;
9790
+ lift(value: UniffiByteArray): ClaimHtlcPaymentRequest;
9791
+ lower(value: ClaimHtlcPaymentRequest): UniffiByteArray;
9792
+ };
9793
+ FfiConverterTypeClaimHtlcPaymentResponse: {
9794
+ read(from: RustBuffer): ClaimHtlcPaymentResponse;
9795
+ write(value: ClaimHtlcPaymentResponse, into: RustBuffer): void;
9796
+ allocationSize(value: ClaimHtlcPaymentResponse): number;
9797
+ lift(value: UniffiByteArray): ClaimHtlcPaymentResponse;
9798
+ lower(value: ClaimHtlcPaymentResponse): UniffiByteArray;
9799
+ };
9642
9800
  FfiConverterTypeConfig: {
9643
9801
  read(from: RustBuffer): Config;
9644
9802
  write(value: Config, into: RustBuffer): void;
@@ -10082,6 +10240,13 @@ declare const _default: Readonly<{
10082
10240
  lift(value: UniffiByteArray): ReceivePaymentResponse;
10083
10241
  lower(value: ReceivePaymentResponse): UniffiByteArray;
10084
10242
  };
10243
+ FfiConverterTypeRecommendedFees: {
10244
+ read(from: RustBuffer): RecommendedFees;
10245
+ write(value: RecommendedFees, into: RustBuffer): void;
10246
+ allocationSize(value: RecommendedFees): number;
10247
+ lift(value: UniffiByteArray): RecommendedFees;
10248
+ lower(value: RecommendedFees): UniffiByteArray;
10249
+ };
10085
10250
  FfiConverterTypeRecord: {
10086
10251
  read(from: RustBuffer): Record;
10087
10252
  write(value: Record, into: RustBuffer): void;
@@ -10217,6 +10382,27 @@ declare const _default: Readonly<{
10217
10382
  lift(value: UniffiByteArray): SparkAddressDetails;
10218
10383
  lower(value: SparkAddressDetails): UniffiByteArray;
10219
10384
  };
10385
+ FfiConverterTypeSparkHtlcDetails: {
10386
+ read(from: RustBuffer): SparkHtlcDetails;
10387
+ write(value: SparkHtlcDetails, into: RustBuffer): void;
10388
+ allocationSize(value: SparkHtlcDetails): number;
10389
+ lift(value: UniffiByteArray): SparkHtlcDetails;
10390
+ lower(value: SparkHtlcDetails): UniffiByteArray;
10391
+ };
10392
+ FfiConverterTypeSparkHtlcOptions: {
10393
+ read(from: RustBuffer): SparkHtlcOptions;
10394
+ write(value: SparkHtlcOptions, into: RustBuffer): void;
10395
+ allocationSize(value: SparkHtlcOptions): number;
10396
+ lift(value: UniffiByteArray): SparkHtlcOptions;
10397
+ lower(value: SparkHtlcOptions): UniffiByteArray;
10398
+ };
10399
+ FfiConverterTypeSparkHtlcStatus: {
10400
+ read(from: RustBuffer): SparkHtlcStatus;
10401
+ write(value: SparkHtlcStatus, into: RustBuffer): void;
10402
+ allocationSize(value: SparkHtlcStatus): number;
10403
+ lift(value: UniffiByteArray): SparkHtlcStatus;
10404
+ lower(value: SparkHtlcStatus): UniffiByteArray;
10405
+ };
10220
10406
  FfiConverterTypeSparkInvoiceDetails: {
10221
10407
  read(from: RustBuffer): SparkInvoiceDetails;
10222
10408
  write(value: SparkInvoiceDetails, into: RustBuffer): void;
@@ -10346,27 +10532,6 @@ declare const _default: Readonly<{
10346
10532
  lift(value: UniffiByteArray): Utxo;
10347
10533
  lower(value: Utxo): UniffiByteArray;
10348
10534
  };
10349
- FfiConverterTypeWaitForPaymentIdentifier: {
10350
- read(from: RustBuffer): WaitForPaymentIdentifier;
10351
- write(value: WaitForPaymentIdentifier, into: RustBuffer): void;
10352
- allocationSize(value: WaitForPaymentIdentifier): number;
10353
- lift(value: UniffiByteArray): WaitForPaymentIdentifier;
10354
- lower(value: WaitForPaymentIdentifier): UniffiByteArray;
10355
- };
10356
- FfiConverterTypeWaitForPaymentRequest: {
10357
- read(from: RustBuffer): WaitForPaymentRequest;
10358
- write(value: WaitForPaymentRequest, into: RustBuffer): void;
10359
- allocationSize(value: WaitForPaymentRequest): number;
10360
- lift(value: UniffiByteArray): WaitForPaymentRequest;
10361
- lower(value: WaitForPaymentRequest): UniffiByteArray;
10362
- };
10363
- FfiConverterTypeWaitForPaymentResponse: {
10364
- read(from: RustBuffer): WaitForPaymentResponse;
10365
- write(value: WaitForPaymentResponse, into: RustBuffer): void;
10366
- allocationSize(value: WaitForPaymentResponse): number;
10367
- lift(value: UniffiByteArray): WaitForPaymentResponse;
10368
- lower(value: WaitForPaymentResponse): UniffiByteArray;
10369
- };
10370
10535
  FfiConverterTypeu128: {
10371
10536
  lift(value: Uint8Array<ArrayBufferLike>): bigint;
10372
10537
  lower(value: bigint): Uint8Array<ArrayBufferLike>;