From 2e559364d81e6ac1866c06d0499a75cd66e576bd Mon Sep 17 00:00:00 2001 From: Roei Erez Date: Wed, 2 Oct 2024 09:25:17 +0300 Subject: [PATCH] fix comments --- lib/core/src/model.rs | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/lib/core/src/model.rs b/lib/core/src/model.rs index 294c57c..a4a4acb 100644 --- a/lib/core/src/model.rs +++ b/lib/core/src/model.rs @@ -225,28 +225,28 @@ impl From for SignerError { /// A trait that can be used to sign messages and verify signatures. /// The sdk user can implement this trait to use their own signer. pub trait Signer: Send + Sync { - // The master xpub encoded as 78 bytes length as defined in bip32 specification. - // For reference: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#user-content-Serialization_format + /// The master xpub encoded as 78 bytes length as defined in bip32 specification. + /// For reference: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#user-content-Serialization_format fn xpub(&self) -> Result, SignerError>; - // The derived xpub encoded as 78 bytes length as defined in bip32 specification. - // The derivation path is a string represents the shorter notation of the key tree to derive. For example: - // m/49'/1'/0'/0/0 - // m/48'/1'/0'/0/0 - // For reference: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#user-content-The_key_tree + /// The derived xpub encoded as 78 bytes length as defined in bip32 specification. + /// The derivation path is a string represents the shorter notation of the key tree to derive. For example: + /// m/49'/1'/0'/0/0 + /// m/48'/1'/0'/0/0 + /// For reference: https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki#user-content-The_key_tree fn derive_xpub(&self, derivation_path: String) -> Result, SignerError>; - // Sign an ECDSA message using the private key derived from the given derivation path + /// Sign an ECDSA message using the private key derived from the given derivation path fn sign_ecdsa(&self, msg: Vec, derivation_path: String) -> Result, SignerError>; - // Sign an ECDSA message using the private key derived from the master key + /// Sign an ECDSA message using the private key derived from the master key fn sign_ecdsa_recoverable(&self, msg: Vec) -> Result, SignerError>; - // Return the master blinding key for SLIP77: https://github.com/satoshilabs/slips/blob/master/slip-0077.md + /// Return the master blinding key for SLIP77: https://github.com/satoshilabs/slips/blob/master/slip-0077.md fn slip77_master_blinding_key(&self) -> Result, SignerError>; - // HMAC-SHA256 using the private key derived from the given derivation path - // This is used to calculate the linking key of lnurl-auth specification: https://github.com/lnurl/luds/blob/luds/05.md + /// HMAC-SHA256 using the private key derived from the given derivation path + /// This is used to calculate the linking key of lnurl-auth specification: https://github.com/lnurl/luds/blob/luds/05.md fn hmac_sha256(&self, msg: Vec, derivation_path: String) -> Result, SignerError>; }