Skip to content

Commit 55b5e01

Browse files
committed
Rename FFI named parameters to specify units
1 parent e28d058 commit 55b5e01

4 files changed

Lines changed: 27 additions & 29 deletions

File tree

payjoin-ffi/dart/test/test_payjoin_integration_test.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -322,7 +322,7 @@ Future<payjoin.PayjoinProposalReceiveSession> process_unchecked_proposal(
322322
) async {
323323
final unchecked_proposal = proposal
324324
.checkBroadcastSuitability(
325-
minFeeRate: null,
325+
minFeeRateSatPerKwu: null,
326326
canBroadcast: MempoolAcceptanceCallback(receiver),
327327
)
328328
.save(persister: recv_persister);
@@ -507,7 +507,7 @@ void main() {
507507
() => payjoin.SenderBuilder(
508508
psbt: psbt,
509509
uri: pjUri,
510-
).buildRecommended(minFeeRate: overflowFeeRate),
510+
).buildRecommended(minFeeRateSatPerKwu: overflowFeeRate),
511511
throwsA(isA<payjoin.SenderInputException>()),
512512
);
513513

@@ -555,10 +555,10 @@ void main() {
555555
// Create a funded PSBT (not broadcasted) to address with amount given in the pj_uri
556556
var pj_uri = session.pjUri();
557557
var psbt = build_sweep_psbt(sender, pj_uri);
558-
payjoin.WithReplyKey req_ctx = payjoin.SenderBuilder(
559-
psbt: psbt,
560-
uri: pj_uri,
561-
).buildRecommended(minFeeRate: 1000).save(persister: sender_persister);
558+
payjoin.WithReplyKey req_ctx =
559+
payjoin.SenderBuilder(psbt: psbt, uri: pj_uri)
560+
.buildRecommended(minFeeRateSatPerKwu: 1000)
561+
.save(persister: sender_persister);
562562
payjoin.RequestOhttpContext request = req_ctx.createV2PostRequest(
563563
ohttpRelay: ohttp_relay,
564564
);

payjoin-ffi/dart/test/test_payjoin_unit_test.dart

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -189,10 +189,9 @@ void main() {
189189

190190
var sender_persister = InMemorySenderPersister("1");
191191
var psbt = payjoin.originalPsbt();
192-
payjoin.SenderBuilder(
193-
psbt: psbt,
194-
uri: uri,
195-
).buildRecommended(minFeeRate: 1000).save(persister: sender_persister);
192+
payjoin.SenderBuilder(psbt: psbt, uri: uri)
193+
.buildRecommended(minFeeRateSatPerKwu: 1000)
194+
.save(persister: sender_persister);
196195
final senderResult = payjoin.replaySenderEventLog(
197196
persister: sender_persister,
198197
);
@@ -274,10 +273,9 @@ void main() {
274273

275274
var sender_persister = InMemorySenderPersister("1");
276275
var psbt = payjoin.originalPsbt();
277-
var withReplyKey = payjoin.SenderBuilder(
278-
psbt: psbt,
279-
uri: uri,
280-
).buildRecommended(minFeeRate: 1000).save(persister: sender_persister);
276+
var withReplyKey = payjoin.SenderBuilder(psbt: psbt, uri: uri)
277+
.buildRecommended(minFeeRateSatPerKwu: 1000)
278+
.save(persister: sender_persister);
281279
var cancelTransition = withReplyKey.cancel();
282280
var fallbackTx = cancelTransition.save(persister: sender_persister);
283281
expect(fallbackTx, isNotNull);
@@ -308,7 +306,7 @@ void main() {
308306
var sender_persister = InMemorySenderPersisterAsync("1");
309307
var psbt = payjoin.originalPsbt();
310308
var withReplyKey = await payjoin.SenderBuilder(psbt: psbt, uri: uri)
311-
.buildRecommended(minFeeRate: 1000)
309+
.buildRecommended(minFeeRateSatPerKwu: 1000)
312310
.saveAsync(persister: sender_persister);
313311
var cancelTransition = withReplyKey.cancel();
314312
var fallbackTx = await cancelTransition.saveAsync(
@@ -369,7 +367,7 @@ void main() {
369367
var sender_persister = InMemorySenderPersisterAsync("1");
370368
var psbt = payjoin.originalPsbt();
371369
await payjoin.SenderBuilder(psbt: psbt, uri: uri)
372-
.buildRecommended(minFeeRate: 1000)
370+
.buildRecommended(minFeeRateSatPerKwu: 1000)
373371
.saveAsync(persister: sender_persister);
374372
final senderResult = await payjoin.replaySenderEventLogAsync(
375373
persister: sender_persister,

payjoin-ffi/src/receive/mod.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -493,8 +493,8 @@ impl ReceiverBuilder {
493493
Ok(Self(self.0.clone().with_amount(amount)))
494494
}
495495

496-
pub fn with_expiration(&self, expiration: u64) -> Result<Self, FfiValidationError> {
497-
let expiration = validate_expiration_secs(expiration)?;
496+
pub fn with_expiration(&self, expiration_secs: u64) -> Result<Self, FfiValidationError> {
497+
let expiration = validate_expiration_secs(expiration_secs)?;
498498
Ok(Self(self.0.clone().with_expiration(expiration)))
499499
}
500500

@@ -715,10 +715,10 @@ pub trait CanBroadcast: Send + Sync {
715715
impl UncheckedOriginalPayload {
716716
pub fn check_broadcast_suitability(
717717
&self,
718-
min_fee_rate: Option<u64>,
718+
min_fee_rate_sat_per_kwu: Option<u64>,
719719
can_broadcast: Arc<dyn CanBroadcast>,
720720
) -> Result<UncheckedOriginalPayloadTransition, FfiValidationError> {
721-
let min_fee_rate = validate_fee_rate_sat_per_kwu_opt(min_fee_rate)?;
721+
let min_fee_rate = validate_fee_rate_sat_per_kwu_opt(min_fee_rate_sat_per_kwu)?;
722722
Ok(UncheckedOriginalPayloadTransition(Arc::new(RwLock::new(Some(
723723
self.0.clone().check_broadcast_suitability(min_fee_rate, |transaction| {
724724
can_broadcast

payjoin-ffi/src/send/mod.rs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -371,9 +371,9 @@ impl SenderBuilder {
371371
// This method fails if no recommendation can be made or if the PSBT is malformed.
372372
pub fn build_recommended(
373373
&self,
374-
min_fee_rate: u64,
374+
min_fee_rate_sat_per_kwu: u64,
375375
) -> Result<InitialSendTransition, SenderInputError> {
376-
let fee_rate = validate_fee_rate_sat_per_kwu(min_fee_rate)?;
376+
let fee_rate = validate_fee_rate_sat_per_kwu(min_fee_rate_sat_per_kwu)?;
377377
self.0
378378
.clone()
379379
.build_recommended(fee_rate)
@@ -384,7 +384,7 @@ impl SenderBuilder {
384384
}
385385
/// Offer the receiver contribution to pay for his input.
386386
///
387-
/// These parameters will allow the receiver to take `max_fee_contribution` from given change
387+
/// These parameters will allow the receiver to take `max_fee_contribution_sats` from given change
388388
/// output to pay for additional inputs. The recommended fee is `size_of_one_input * fee_rate`.
389389
///
390390
/// `change_index` specifies which output can be used to pay fee. If `None` is provided, then
@@ -397,13 +397,13 @@ impl SenderBuilder {
397397
/// be just lowered in the request to match the change amount.
398398
pub fn build_with_additional_fee(
399399
&self,
400-
max_fee_contribution: u64,
400+
max_fee_contribution_sats: u64,
401401
change_index: Option<u8>,
402-
min_fee_rate: u64,
402+
min_fee_rate_sat_per_kwu: u64,
403403
clamp_fee_contribution: bool,
404404
) -> Result<InitialSendTransition, SenderInputError> {
405-
let max_fee_contribution = validate_amount_sat(max_fee_contribution)?;
406-
let fee_rate = validate_fee_rate_sat_per_kwu(min_fee_rate)?;
405+
let max_fee_contribution = validate_amount_sat(max_fee_contribution_sats)?;
406+
let fee_rate = validate_fee_rate_sat_per_kwu(min_fee_rate_sat_per_kwu)?;
407407
self.0
408408
.clone()
409409
.build_with_additional_fee(
@@ -423,9 +423,9 @@ impl SenderBuilder {
423423
/// This function disables contribution.
424424
pub fn build_non_incentivizing(
425425
&self,
426-
min_fee_rate: u64,
426+
min_fee_rate_sat_per_kwu: u64,
427427
) -> Result<InitialSendTransition, SenderInputError> {
428-
let fee_rate = validate_fee_rate_sat_per_kwu(min_fee_rate)?;
428+
let fee_rate = validate_fee_rate_sat_per_kwu(min_fee_rate_sat_per_kwu)?;
429429
self.0
430430
.clone()
431431
.build_non_incentivizing(fee_rate)

0 commit comments

Comments
 (0)