Skip to content

Commit e226ac1

Browse files
committed
feat: rename payment_preimage to payment_proof
Payment preimage is lightning specific so with generic payment method and onchain coming it make sense to rename.
1 parent b3d7407 commit e226ac1

28 files changed

Lines changed: 89 additions & 81 deletions

File tree

crates/cdk-common/src/database/wallet/test/mod.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,7 @@ fn test_melt_quote() -> MeltQuote {
131131
fee_reserve: Amount::from(10),
132132
state: cashu::MeltQuoteState::Unpaid,
133133
expiry: 9999999999,
134-
payment_preimage: None,
134+
payment_proof: None,
135135
payment_method: cashu::PaymentMethod::Known(KnownMethod::Bolt11),
136136
used_by_operation: None,
137137
version: 0,

crates/cdk-common/src/melt.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ impl<Q> MeltQuoteResponse<Q> {
120120
}
121121

122122
/// Returns the payment preimage.
123-
pub fn payment_preimage(&self) -> Option<&str> {
123+
pub fn payment_proof(&self) -> Option<&str> {
124124
match self {
125125
Self::Bolt11(r) => r.payment_preimage.as_deref(),
126126
Self::Bolt12(r) => r.payment_preimage.as_deref(),

crates/cdk-common/src/mint.rs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -849,8 +849,8 @@ pub struct MeltQuote {
849849
pub state: MeltQuoteState,
850850
/// Expiration time of quote
851851
pub expiry: u64,
852-
/// Payment preimage
853-
pub payment_preimage: Option<String>,
852+
/// Payment proof
853+
pub payment_proof: Option<String>,
854854
/// Value used by ln backend to look up state of request
855855
pub request_lookup_id: Option<PaymentIdentifier>,
856856
/// Payment options
@@ -889,7 +889,7 @@ impl MeltQuote {
889889
fee_reserve,
890890
state: MeltQuoteState::Unpaid,
891891
expiry,
892-
payment_preimage: None,
892+
payment_proof: None,
893893
request_lookup_id,
894894
options,
895895
created_time: unix_time(),
@@ -929,7 +929,7 @@ impl MeltQuote {
929929
fee_reserve: u64,
930930
state: MeltQuoteState,
931931
expiry: u64,
932-
payment_preimage: Option<String>,
932+
payment_proof: Option<String>,
933933
request_lookup_id: Option<PaymentIdentifier>,
934934
options: Option<MeltOptions>,
935935
created_time: u64,
@@ -944,7 +944,7 @@ impl MeltQuote {
944944
fee_reserve: Amount::new(fee_reserve, unit),
945945
state,
946946
expiry,
947-
payment_preimage,
947+
payment_proof,
948948
request_lookup_id,
949949
options,
950950
created_time,
@@ -1158,7 +1158,7 @@ impl From<MeltQuote> for MeltQuoteBolt11Response<QuoteId> {
11581158
fee_reserve: melt_quote.fee_reserve().clone().into(),
11591159
state: melt_quote.state,
11601160
expiry: melt_quote.expiry,
1161-
payment_preimage: melt_quote.payment_preimage,
1161+
payment_preimage: melt_quote.payment_proof,
11621162
change: None,
11631163
request: Some(melt_quote.request.to_string()),
11641164
unit: Some(melt_quote.unit.clone()),

crates/cdk-common/src/wallet/mod.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -223,8 +223,9 @@ pub struct MeltQuote {
223223
pub state: MeltQuoteState,
224224
/// Expiration time of quote
225225
pub expiry: u64,
226-
/// Payment preimage
227-
pub payment_preimage: Option<String>,
226+
/// Payment proof
227+
#[serde(alias = "payment_preimage")]
228+
pub payment_proof: Option<String>,
228229
/// Payment method
229230
pub payment_method: PaymentMethod,
230231
/// Operation ID that has reserved this quote (for saga pattern)
@@ -419,6 +420,7 @@ pub struct Transaction {
419420
/// Payment request (e.g., BOLT11 invoice, BOLT12 offer)
420421
pub payment_request: Option<String>,
421422
/// Payment proof (e.g., preimage for Lightning melt transactions)
423+
#[serde(alias = "payment_preimage")]
422424
pub payment_proof: Option<String>,
423425
/// Payment method (e.g., Bolt11, Bolt12) for mint/melt transactions
424426
#[serde(default)]

crates/cdk-ffi/src/types/quote.rs

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -228,8 +228,8 @@ pub struct MeltQuoteBolt11Response {
228228
pub state: QuoteState,
229229
/// Expiry timestamp
230230
pub expiry: u64,
231-
/// Payment preimage (optional)
232-
pub payment_preimage: Option<String>,
231+
/// Payment proof (optional)
232+
pub payment_proof: Option<String>,
233233
/// Request string (optional)
234234
pub request: Option<String>,
235235
/// Unit (optional)
@@ -244,7 +244,7 @@ impl From<cdk::nuts::MeltQuoteBolt11Response<String>> for MeltQuoteBolt11Respons
244244
fee_reserve: response.fee_reserve.into(),
245245
state: response.state.into(),
246246
expiry: response.expiry,
247-
payment_preimage: response.payment_preimage,
247+
payment_proof: response.payment_preimage,
248248
request: response.request,
249249
unit: response.unit.map(Into::into),
250250
}
@@ -267,8 +267,8 @@ pub struct MeltQuoteCustomResponse {
267267
pub state: QuoteState,
268268
/// Expiry timestamp
269269
pub expiry: u64,
270-
/// Payment preimage (optional)
271-
pub payment_preimage: Option<String>,
270+
/// Payment proof (optional)
271+
pub payment_proof: Option<String>,
272272
/// Request string (optional)
273273
pub request: Option<String>,
274274
/// Unit (optional)
@@ -294,7 +294,7 @@ impl From<cdk::nuts::MeltQuoteCustomResponse<String>> for MeltQuoteCustomRespons
294294
fee_reserve: response.fee_reserve.into(),
295295
state: response.state.into(),
296296
expiry: response.expiry,
297-
payment_preimage: response.payment_preimage,
297+
payment_proof: response.payment_preimage,
298298
request: response.request,
299299
unit: response.unit.map(Into::into),
300300
extra,
@@ -354,8 +354,8 @@ pub struct MeltQuote {
354354
pub state: QuoteState,
355355
/// Expiry timestamp
356356
pub expiry: u64,
357-
/// Payment preimage
358-
pub payment_preimage: Option<String>,
357+
/// Payment proof
358+
pub payment_proof: Option<String>,
359359
/// Payment method
360360
pub payment_method: PaymentMethod,
361361
/// Operation ID that reserved this quote
@@ -376,7 +376,7 @@ impl From<cdk::wallet::MeltQuote> for MeltQuote {
376376
fee_reserve: quote.fee_reserve.into(),
377377
state: quote.state.into(),
378378
expiry: quote.expiry,
379-
payment_preimage: quote.payment_preimage.clone(),
379+
payment_proof: quote.payment_proof.clone(),
380380
payment_method: quote.payment_method.into(),
381381
used_by_operation: quote.used_by_operation.map(|id| id.to_string()),
382382
version: quote.version,
@@ -397,7 +397,7 @@ impl TryFrom<MeltQuote> for cdk::wallet::MeltQuote {
397397
fee_reserve: quote.fee_reserve.into(),
398398
state: quote.state.into(),
399399
expiry: quote.expiry,
400-
payment_preimage: quote.payment_preimage,
400+
payment_proof: quote.payment_proof,
401401
payment_method: quote.payment_method.into(),
402402
used_by_operation: quote.used_by_operation,
403403
version: quote.version,

crates/cdk-redb/src/migrations.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ pub struct V1MeltQuote {
5353
/// Expiration time of quote
5454
pub expiry: u64,
5555
/// Payment preimage
56-
pub payment_preimage: Option<String>,
56+
#[serde(alias = "payment_preimage")]
57+
pub payment_proof: Option<String>,
5758
}
5859

5960
impl From<V0MintQuote> for V1MintQuote {
@@ -100,7 +101,7 @@ impl From<V0MeltQuote> for V1MeltQuote {
100101
state,
101102
expiry: quote.expiry,
102103
fee_reserve: quote.fee_reserve,
103-
payment_preimage: None,
104+
payment_proof: None,
104105
}
105106
}
106107
}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ALTER TABLE melt_quote RENAME COLUMN payment_preimage TO payment_proof;
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ALTER TABLE melt_quote RENAME COLUMN payment_preimage TO payment_proof;

crates/cdk-sql-common/src/mint/quotes.rs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ where
273273
fee_reserve,
274274
expiry,
275275
state,
276-
payment_preimage,
276+
payment_proof,
277277
request_lookup_id,
278278
created_time,
279279
paid_time,
@@ -380,7 +380,7 @@ where
380380
fee_reserve,
381381
expiry,
382382
state,
383-
payment_preimage,
383+
payment_proof,
384384
request_lookup_id,
385385
created_time,
386386
paid_time,
@@ -433,7 +433,7 @@ where
433433
fee_reserve,
434434
expiry,
435435
state,
436-
payment_preimage,
436+
payment_proof,
437437
request_lookup_id,
438438
created_time,
439439
paid_time,
@@ -539,7 +539,7 @@ fn sql_row_to_melt_quote(row: Vec<Column>) -> Result<mint::MeltQuote, Error> {
539539
fee_reserve,
540540
expiry,
541541
state,
542-
payment_preimage,
542+
payment_proof,
543543
request_lookup_id,
544544
created_time,
545545
paid_time,
@@ -554,7 +554,7 @@ fn sql_row_to_melt_quote(row: Vec<Column>) -> Result<mint::MeltQuote, Error> {
554554
let fee_reserve: u64 = column_as_number!(fee_reserve);
555555

556556
let expiry = column_as_number!(expiry);
557-
let payment_preimage = column_as_nullable_string!(payment_preimage);
557+
let payment_proof = column_as_nullable_string!(payment_proof);
558558
let options = column_as_nullable_string!(options);
559559
let options = options.and_then(|o| serde_json::from_str(&o).ok());
560560
let created_time: i64 = column_as_number!(created_time);
@@ -608,7 +608,7 @@ fn sql_row_to_melt_quote(row: Vec<Column>) -> Result<mint::MeltQuote, Error> {
608608
fee_reserve,
609609
state,
610610
expiry,
611-
payment_preimage,
611+
payment_proof,
612612
request_lookup_id,
613613
options,
614614
created_time as u64,
@@ -925,13 +925,13 @@ where
925925
INSERT INTO melt_quote
926926
(
927927
id, unit, amount, request, fee_reserve, state,
928-
expiry, payment_preimage, request_lookup_id,
928+
expiry, payment_proof, request_lookup_id,
929929
created_time, paid_time, options, request_lookup_id_kind, payment_method
930930
)
931931
VALUES
932932
(
933933
:id, :unit, :amount, :request, :fee_reserve, :state,
934-
:expiry, :payment_preimage, :request_lookup_id,
934+
:expiry, :payment_proof, :request_lookup_id,
935935
:created_time, :paid_time, :options, :request_lookup_id_kind, :payment_method
936936
)
937937
"#,
@@ -943,7 +943,7 @@ where
943943
.bind("fee_reserve", quote.fee_reserve().to_i64())
944944
.bind("state", quote.state.to_string())
945945
.bind("expiry", quote.expiry as i64)
946-
.bind("payment_preimage", quote.payment_preimage)
946+
.bind("payment_proof", quote.payment_proof)
947947
.bind(
948948
"request_lookup_id",
949949
quote.request_lookup_id.as_ref().map(|id| id.to_string()),
@@ -993,11 +993,11 @@ where
993993
let rec = if state == MeltQuoteState::Paid {
994994
let current_time = unix_time();
995995
quote.paid_time = Some(current_time);
996-
quote.payment_preimage = payment_proof.clone();
997-
query(r#"UPDATE melt_quote SET state = :state, paid_time = :paid_time, payment_preimage = :payment_preimage WHERE id = :id"#)?
996+
quote.payment_proof = payment_proof.clone();
997+
query(r#"UPDATE melt_quote SET state = :state, paid_time = :paid_time, payment_proof = :payment_proof WHERE id = :id"#)?
998998
.bind("state", state.to_string())
999999
.bind("paid_time", current_time as i64)
1000-
.bind("payment_preimage", payment_proof)
1000+
.bind("payment_proof", payment_proof)
10011001
.bind("id", quote.id.to_string())
10021002
.execute(&self.inner)
10031003
.await
@@ -1229,7 +1229,7 @@ where
12291229
fee_reserve,
12301230
expiry,
12311231
state,
1232-
payment_preimage,
1232+
payment_proof,
12331233
request_lookup_id,
12341234
created_time,
12351235
paid_time,
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
ALTER TABLE melt_quote RENAME COLUMN payment_preimage TO payment_proof;

0 commit comments

Comments
 (0)