aljaz/breez-sdk-liquid
1
0
Fork 0
mirror of https://github.com/aljazceru/breez-sdk-liquid.git synced 2026-02-23 15:04:22 +01:00
Code Issues Packages Projects Releases Wiki Activity

fix comments

Browse Source
This commit is contained in:
Roei Erez
2024-10-02 09:25:17 +03:00
committed by Ross Savage
parent bbac3f5fc2
commit 2e559364d8
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
lib/core/src/model.rs
View File

@@ -225,28 +225,28 @@ impl From<bip32::Error> 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<Vec<u8>, 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<Vec<u8>, 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<u8>, derivation_path: String) -> Result<Vec<u8>, 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<u8>) -> Result<Vec<u8>, 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<Vec<u8>, 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<u8>, derivation_path: String) -> Result<Vec<u8>, SignerError>;
}