@@ -44,7 +44,7 @@ pub enum SpendableOutputDescriptor {
44
44
/// ChannelKeys::pubkeys().
45
45
///
46
46
/// To derive the revocation_pubkey provided here (which is used in the witness
47
- /// script generation), you must pass the revocation_basepoint (which appears in the
47
+ /// script generation), you must pass the counterparty revocation_basepoint (which appears in the
48
48
/// call to ChannelKeys::on_accept) and the provided per_commitment point
49
49
/// to chan_utils::derive_public_revocation_key.
50
50
///
@@ -261,7 +261,7 @@ pub struct ChannelKeys {
261
261
/// TODO: return a Result so we can signal a validation error
262
262
#[ must_use]
263
263
pub release_commitment_secret : extern "C" fn ( this_arg : * const c_void , idx : u64 ) -> crate :: c_types:: ThirtyTwoBytes ,
264
- /// Gets the local channel public keys and basepoints
264
+ /// Gets the holder's channel public keys and basepoints
265
265
pub pubkeys : crate :: ln:: chan_utils:: ChannelPublicKeys ,
266
266
/// Fill in the pubkeys field as a reference to it will be given to Rust after this returns
267
267
/// Note that this takes a pointer to this object, not the this_ptr like other methods do
@@ -272,18 +272,18 @@ pub struct ChannelKeys {
272
272
/// ChannelKeys object uniquely and lookup or re-derive its keys.
273
273
#[ must_use]
274
274
pub key_derivation_params : extern "C" fn ( this_arg : * const c_void ) -> crate :: c_types:: derived:: C2Tuple_u64u64Z ,
275
- /// Create a signature for a counterparty commitment transaction and associated HTLC transactions.
275
+ /// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
276
276
///
277
277
/// Note that if signing fails or is rejected, the channel will be force-closed.
278
278
#[ must_use]
279
279
pub sign_counterparty_commitment : extern "C" fn ( this_arg : * const c_void , feerate_per_kw : u32 , commitment_tx : crate :: c_types:: Transaction , keys : & crate :: ln:: chan_utils:: PreCalculatedTxCreationKeys , htlcs : crate :: c_types:: derived:: CVec_HTLCOutputInCommitmentZ ) -> crate :: c_types:: derived:: CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ ,
280
- /// Create a signature for a local commitment transaction. This will only ever be called with
281
- /// the same local_commitment_tx (or a copy thereof), though there are currently no guarantees
280
+ /// Create a signature for a holder's commitment transaction. This will only ever be called with
281
+ /// the same holder_commitment_tx (or a copy thereof), though there are currently no guarantees
282
282
/// that it will not be called multiple times.
283
283
/// An external signer implementation should check that the commitment has not been revoked.
284
284
#[ must_use]
285
285
pub sign_holder_commitment : extern "C" fn ( this_arg : * const c_void , holder_commitment_tx : & crate :: ln:: chan_utils:: HolderCommitmentTransaction ) -> crate :: c_types:: derived:: CResult_SignatureNoneZ ,
286
- /// Create a signature for each HTLC transaction spending a holder commitment transaction.
286
+ /// Create a signature for each HTLC transaction spending a holder's commitment transaction.
287
287
///
288
288
/// Unlike sign_holder_commitment, this may be called multiple times with *different*
289
289
/// holder_commitment_tx values. While this will never be called with a revoked
@@ -309,16 +309,16 @@ pub struct ChannelKeys {
309
309
/// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
310
310
///
311
311
/// per_commitment_key is revocation secret which was provided by our counterparty when they
312
- /// revoked the state which they eventually broadcast. It's not a _local_ secret key and does
313
- /// not allow the spending of any funds by itself (you need our local revocation_secret to do
312
+ /// revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
313
+ /// not allow the spending of any funds by itself (you need our holder revocation_secret to do
314
314
/// so).
315
315
///
316
316
/// htlc holds HTLC elements (hash, timelock) if the output being spent is a HTLC output, thus
317
317
/// changing the format of the witness script (which is committed to in the BIP 143
318
318
/// signatures).
319
319
#[ must_use]
320
320
pub sign_justice_transaction : extern "C" fn ( this_arg : * const c_void , justice_tx : crate :: c_types:: Transaction , input : usize , amount : u64 , per_commitment_key : * const [ u8 ; 32 ] , htlc : & crate :: ln:: chan_utils:: HTLCOutputInCommitment ) -> crate :: c_types:: derived:: CResult_SignatureNoneZ ,
321
- /// Create a signature for a claiming transaction for a HTLC output on a counterparty commitment
321
+ /// Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
322
322
/// transaction, either offered or received.
323
323
///
324
324
/// Such a transaction may claim multiples offered outputs at same time if we know the
@@ -351,13 +351,13 @@ pub struct ChannelKeys {
351
351
/// protocol.
352
352
#[ must_use]
353
353
pub sign_channel_announcement : extern "C" fn ( this_arg : * const c_void , msg : & crate :: ln:: msgs:: UnsignedChannelAnnouncement ) -> crate :: c_types:: derived:: CResult_SignatureNoneZ ,
354
- /// Set the counterparty channel basepoints and counterparty/local to_self_delay .
354
+ /// Set the counterparty channel basepoints and counterparty_selected/holder_selected_contest_delay .
355
355
/// This is done immediately on incoming channels and as soon as the channel is accepted on outgoing channels.
356
356
///
357
- /// We bind local_to_self_delay late here for API convenience.
357
+ /// We bind holder_selected_contest_delay late here for API convenience.
358
358
///
359
359
/// Will be called before any signatures are applied.
360
- pub on_accept : extern "C" fn ( this_arg : * mut c_void , channel_points : & crate :: ln:: chan_utils:: ChannelPublicKeys , counterparty_to_self_delay : u16 , local_to_self_delay : u16 ) ,
360
+ pub on_accept : extern "C" fn ( this_arg : * mut c_void , channel_points : & crate :: ln:: chan_utils:: ChannelPublicKeys , counterparty_selected_contest_delay : u16 , holder_selected_contest_delay : u16 ) ,
361
361
pub clone : Option < extern "C" fn ( this_arg : * const c_void ) -> * mut c_void > ,
362
362
pub free : Option < extern "C" fn ( this_arg : * mut c_void ) > ,
363
363
}
@@ -413,13 +413,13 @@ impl rustChannelKeys for ChannelKeys {
413
413
let mut local_ret = match ret. result_ok { true => Ok ( { let ( mut orig_ret_0_0, mut orig_ret_0_1) = ( * unsafe { Box :: from_raw ( ret. contents . result . take_ptr ( ) ) } ) . to_rust ( ) ; let mut local_orig_ret_0_1 = Vec :: new ( ) ; for mut item in orig_ret_0_1. into_rust ( ) . drain ( ..) { local_orig_ret_0_1. push ( { item. into_rust ( ) } ) ; } ; let mut local_ret_0 = ( orig_ret_0_0. into_rust ( ) , local_orig_ret_0_1) ; local_ret_0 } ) , false => Err ( { ( ) /*(*unsafe { Box::from_raw(ret.contents.err.take_ptr()) })*/ } ) } ;
414
414
local_ret
415
415
}
416
- fn sign_holder_commitment < T : bitcoin:: secp256k1:: Signing + bitcoin:: secp256k1:: Verification > ( & self , local_commitment_tx : & lightning:: ln:: chan_utils:: HolderCommitmentTransaction , _secp_ctx : & bitcoin:: secp256k1:: Secp256k1 < T > ) -> Result < bitcoin:: secp256k1:: Signature , ( ) > {
417
- let mut ret = ( self . sign_holder_commitment ) ( self . this_arg , & crate :: ln:: chan_utils:: HolderCommitmentTransaction { inner : unsafe { ( local_commitment_tx as * const _ ) as * mut _ } , is_owned : false } ) ;
416
+ fn sign_holder_commitment < T : bitcoin:: secp256k1:: Signing + bitcoin:: secp256k1:: Verification > ( & self , holder_commitment_tx : & lightning:: ln:: chan_utils:: HolderCommitmentTransaction , _secp_ctx : & bitcoin:: secp256k1:: Secp256k1 < T > ) -> Result < bitcoin:: secp256k1:: Signature , ( ) > {
417
+ let mut ret = ( self . sign_holder_commitment ) ( self . this_arg , & crate :: ln:: chan_utils:: HolderCommitmentTransaction { inner : unsafe { ( holder_commitment_tx as * const _ ) as * mut _ } , is_owned : false } ) ;
418
418
let mut local_ret = match ret. result_ok { true => Ok ( { ( * unsafe { Box :: from_raw ( ret. contents . result . take_ptr ( ) ) } ) . into_rust ( ) } ) , false => Err ( { ( ) /*(*unsafe { Box::from_raw(ret.contents.err.take_ptr()) })*/ } ) } ;
419
419
local_ret
420
420
}
421
- fn sign_holder_commitment_htlc_transactions < T : bitcoin:: secp256k1:: Signing + bitcoin:: secp256k1:: Verification > ( & self , local_commitment_tx : & lightning:: ln:: chan_utils:: HolderCommitmentTransaction , _secp_ctx : & bitcoin:: secp256k1:: Secp256k1 < T > ) -> Result < Vec < Option < bitcoin:: secp256k1:: Signature > > , ( ) > {
422
- let mut ret = ( self . sign_holder_commitment_htlc_transactions ) ( self . this_arg , & crate :: ln:: chan_utils:: HolderCommitmentTransaction { inner : unsafe { ( local_commitment_tx as * const _ ) as * mut _ } , is_owned : false } ) ;
421
+ fn sign_holder_commitment_htlc_transactions < T : bitcoin:: secp256k1:: Signing + bitcoin:: secp256k1:: Verification > ( & self , holder_commitment_tx : & lightning:: ln:: chan_utils:: HolderCommitmentTransaction , _secp_ctx : & bitcoin:: secp256k1:: Secp256k1 < T > ) -> Result < Vec < Option < bitcoin:: secp256k1:: Signature > > , ( ) > {
422
+ let mut ret = ( self . sign_holder_commitment_htlc_transactions ) ( self . this_arg , & crate :: ln:: chan_utils:: HolderCommitmentTransaction { inner : unsafe { ( holder_commitment_tx as * const _ ) as * mut _ } , is_owned : false } ) ;
423
423
let mut local_ret = match ret. result_ok { true => Ok ( { let mut local_ret_0 = Vec :: new ( ) ; for mut item in ( * unsafe { Box :: from_raw ( ret. contents . result . take_ptr ( ) ) } ) . into_rust ( ) . drain ( ..) { local_ret_0. push ( { let mut local_ret_0_0 = if item. is_null ( ) { None } else { Some ( { item. into_rust ( ) } ) } ; local_ret_0_0 } ) ; } ; local_ret_0 } ) , false => Err ( { ( ) /*(*unsafe { Box::from_raw(ret.contents.err.take_ptr()) })*/ } ) } ;
424
424
local_ret
425
425
}
@@ -447,8 +447,8 @@ impl rustChannelKeys for ChannelKeys {
447
447
let mut local_ret = match ret. result_ok { true => Ok ( { ( * unsafe { Box :: from_raw ( ret. contents . result . take_ptr ( ) ) } ) . into_rust ( ) } ) , false => Err ( { ( ) /*(*unsafe { Box::from_raw(ret.contents.err.take_ptr()) })*/ } ) } ;
448
448
local_ret
449
449
}
450
- fn on_accept ( & mut self , channel_points : & lightning:: ln:: chan_utils:: ChannelPublicKeys , counterparty_to_self_delay : u16 , local_to_self_delay : u16 ) {
451
- ( self . on_accept ) ( self . this_arg , & crate :: ln:: chan_utils:: ChannelPublicKeys { inner : unsafe { ( channel_points as * const _ ) as * mut _ } , is_owned : false } , counterparty_to_self_delay , local_to_self_delay )
450
+ fn on_accept ( & mut self , channel_points : & lightning:: ln:: chan_utils:: ChannelPublicKeys , counterparty_selected_contest_delay : u16 , holder_selected_contest_delay : u16 ) {
451
+ ( self . on_accept ) ( self . this_arg , & crate :: ln:: chan_utils:: ChannelPublicKeys { inner : unsafe { ( channel_points as * const _ ) as * mut _ } , is_owned : false } , counterparty_selected_contest_delay , holder_selected_contest_delay )
452
452
}
453
453
}
454
454
@@ -602,46 +602,46 @@ pub extern "C" fn InMemoryChannelKeys_get_funding_key(this_ptr: &InMemoryChannel
602
602
pub extern "C" fn InMemoryChannelKeys_set_funding_key ( this_ptr : & mut InMemoryChannelKeys , mut val : crate :: c_types:: SecretKey ) {
603
603
unsafe { & mut * this_ptr. inner } . funding_key = val. into_rust ( ) ;
604
604
}
605
- /// Local secret key for blinded revocation pubkey
605
+ /// Holder secret key for blinded revocation pubkey
606
606
#[ no_mangle]
607
607
pub extern "C" fn InMemoryChannelKeys_get_revocation_base_key ( this_ptr : & InMemoryChannelKeys ) -> * const [ u8 ; 32 ] {
608
608
let mut inner_val = & mut unsafe { & mut * this_ptr. inner } . revocation_base_key ;
609
609
( * inner_val) . as_ref ( )
610
610
}
611
- /// Local secret key for blinded revocation pubkey
611
+ /// Holder secret key for blinded revocation pubkey
612
612
#[ no_mangle]
613
613
pub extern "C" fn InMemoryChannelKeys_set_revocation_base_key ( this_ptr : & mut InMemoryChannelKeys , mut val : crate :: c_types:: SecretKey ) {
614
614
unsafe { & mut * this_ptr. inner } . revocation_base_key = val. into_rust ( ) ;
615
615
}
616
- /// Local secret key used for our balance in counterparty-broadcasted commitment transactions
616
+ /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
617
617
#[ no_mangle]
618
618
pub extern "C" fn InMemoryChannelKeys_get_payment_key ( this_ptr : & InMemoryChannelKeys ) -> * const [ u8 ; 32 ] {
619
619
let mut inner_val = & mut unsafe { & mut * this_ptr. inner } . payment_key ;
620
620
( * inner_val) . as_ref ( )
621
621
}
622
- /// Local secret key used for our balance in counterparty-broadcasted commitment transactions
622
+ /// Holder secret key used for our balance in counterparty-broadcasted commitment transactions
623
623
#[ no_mangle]
624
624
pub extern "C" fn InMemoryChannelKeys_set_payment_key ( this_ptr : & mut InMemoryChannelKeys , mut val : crate :: c_types:: SecretKey ) {
625
625
unsafe { & mut * this_ptr. inner } . payment_key = val. into_rust ( ) ;
626
626
}
627
- /// Local secret key used in HTLC tx
627
+ /// Holder secret key used in HTLC tx
628
628
#[ no_mangle]
629
629
pub extern "C" fn InMemoryChannelKeys_get_delayed_payment_base_key ( this_ptr : & InMemoryChannelKeys ) -> * const [ u8 ; 32 ] {
630
630
let mut inner_val = & mut unsafe { & mut * this_ptr. inner } . delayed_payment_base_key ;
631
631
( * inner_val) . as_ref ( )
632
632
}
633
- /// Local secret key used in HTLC tx
633
+ /// Holder secret key used in HTLC tx
634
634
#[ no_mangle]
635
635
pub extern "C" fn InMemoryChannelKeys_set_delayed_payment_base_key ( this_ptr : & mut InMemoryChannelKeys , mut val : crate :: c_types:: SecretKey ) {
636
636
unsafe { & mut * this_ptr. inner } . delayed_payment_base_key = val. into_rust ( ) ;
637
637
}
638
- /// Local htlc secret key used in commitment tx htlc outputs
638
+ /// Holder htlc secret key used in commitment tx htlc outputs
639
639
#[ no_mangle]
640
640
pub extern "C" fn InMemoryChannelKeys_get_htlc_base_key ( this_ptr : & InMemoryChannelKeys ) -> * const [ u8 ; 32 ] {
641
641
let mut inner_val = & mut unsafe { & mut * this_ptr. inner } . htlc_base_key ;
642
642
( * inner_val) . as_ref ( )
643
643
}
644
- /// Local htlc secret key used in commitment tx htlc outputs
644
+ /// Holder htlc secret key used in commitment tx htlc outputs
645
645
#[ no_mangle]
646
646
pub extern "C" fn InMemoryChannelKeys_set_htlc_base_key ( this_ptr : & mut InMemoryChannelKeys , mut val : crate :: c_types:: SecretKey ) {
647
647
unsafe { & mut * this_ptr. inner } . htlc_base_key = val. into_rust ( ) ;
@@ -675,10 +675,10 @@ pub extern "C" fn InMemoryChannelKeys_counterparty_pubkeys(this_arg: &InMemoryCh
675
675
crate :: ln:: chan_utils:: ChannelPublicKeys { inner : unsafe { ( ( & ( * ret) as * const _ ) as * mut _ ) } , is_owned : false }
676
676
}
677
677
678
- /// The contest delay value specified by our counterparty and applied on holder-broadcastable
678
+ /// The contest_delay value specified by our counterparty and applied on holder-broadcastable
679
679
/// transactions, ie the amount of time that we have to wait to recover our funds if we
680
680
/// broadcast a transaction. You'll likely want to pass this to the
681
- /// ln::chan_utils::build*_transaction functions when signing holder transactions.
681
+ /// ln::chan_utils::build*_transaction functions when signing holder's transactions.
682
682
/// Will panic if on_accept wasn't called.
683
683
#[ must_use]
684
684
#[ no_mangle]
@@ -687,7 +687,7 @@ pub extern "C" fn InMemoryChannelKeys_counterparty_selected_contest_delay(this_a
687
687
ret
688
688
}
689
689
690
- /// The to_contest delay value specified by us and applied on transactions broadcastable
690
+ /// The contest_delay value specified by us and applied on transactions broadcastable
691
691
/// by our counterparty, ie the amount of time that they have to wait to recover their funds
692
692
/// if they broadcast a transaction.
693
693
/// Will panic if on_accept wasn't called.
@@ -757,14 +757,14 @@ extern "C" fn InMemoryChannelKeys_ChannelKeys_sign_counterparty_commitment(this_
757
757
local_ret
758
758
}
759
759
#[ must_use]
760
- extern "C" fn InMemoryChannelKeys_ChannelKeys_sign_holder_commitment ( this_arg : * const c_void , local_commitment_tx : & crate :: ln:: chan_utils:: HolderCommitmentTransaction ) -> crate :: c_types:: derived:: CResult_SignatureNoneZ {
761
- let mut ret = unsafe { & mut * ( this_arg as * mut nativeInMemoryChannelKeys ) } . sign_holder_commitment ( unsafe { & * local_commitment_tx . inner } , & bitcoin:: secp256k1:: Secp256k1 :: new ( ) ) ;
760
+ extern "C" fn InMemoryChannelKeys_ChannelKeys_sign_holder_commitment ( this_arg : * const c_void , holder_commitment_tx : & crate :: ln:: chan_utils:: HolderCommitmentTransaction ) -> crate :: c_types:: derived:: CResult_SignatureNoneZ {
761
+ let mut ret = unsafe { & mut * ( this_arg as * mut nativeInMemoryChannelKeys ) } . sign_holder_commitment ( unsafe { & * holder_commitment_tx . inner } , & bitcoin:: secp256k1:: Secp256k1 :: new ( ) ) ;
762
762
let mut local_ret = match ret { Ok ( mut o) => crate :: c_types:: CResultTempl :: ok ( { crate :: c_types:: Signature :: from_rust ( & o) } ) , Err ( mut e) => crate :: c_types:: CResultTempl :: err ( { 0u8 /*e*/ } ) } ;
763
763
local_ret
764
764
}
765
765
#[ must_use]
766
- extern "C" fn InMemoryChannelKeys_ChannelKeys_sign_holder_commitment_htlc_transactions ( this_arg : * const c_void , local_commitment_tx : & crate :: ln:: chan_utils:: HolderCommitmentTransaction ) -> crate :: c_types:: derived:: CResult_CVec_SignatureZNoneZ {
767
- let mut ret = unsafe { & mut * ( this_arg as * mut nativeInMemoryChannelKeys ) } . sign_holder_commitment_htlc_transactions ( unsafe { & * local_commitment_tx . inner } , & bitcoin:: secp256k1:: Secp256k1 :: new ( ) ) ;
766
+ extern "C" fn InMemoryChannelKeys_ChannelKeys_sign_holder_commitment_htlc_transactions ( this_arg : * const c_void , holder_commitment_tx : & crate :: ln:: chan_utils:: HolderCommitmentTransaction ) -> crate :: c_types:: derived:: CResult_CVec_SignatureZNoneZ {
767
+ let mut ret = unsafe { & mut * ( this_arg as * mut nativeInMemoryChannelKeys ) } . sign_holder_commitment_htlc_transactions ( unsafe { & * holder_commitment_tx . inner } , & bitcoin:: secp256k1:: Secp256k1 :: new ( ) ) ;
768
768
let mut local_ret = match ret { Ok ( mut o) => crate :: c_types:: CResultTempl :: ok ( { let mut local_ret_0 = Vec :: new ( ) ; for item in o. drain ( ..) { local_ret_0. push ( { let mut local_ret_0_0 = if item. is_none ( ) { crate :: c_types:: Signature :: null ( ) } else { { crate :: c_types:: Signature :: from_rust ( & ( item. unwrap ( ) ) ) } } ; local_ret_0_0 } ) ; } ; local_ret_0. into ( ) } ) , Err ( mut e) => crate :: c_types:: CResultTempl :: err ( { 0u8 /*e*/ } ) } ;
769
769
local_ret
770
770
}
0 commit comments