Struct PrivateKey 

pub struct PrivateKey {
    pub compressed: bool,
    pub network: NetworkKind,
    pub inner: SecretKey,
}

A Bitcoin ECDSA private key

Fields

compressed: bool

Whether this private key should be serialized as compressed

network: NetworkKind

The network kind on which this key should be used

inner: SecretKey

The actual ECDSA key

Implementations

impl PrivateKey

pub fn generate(network: impl Into<NetworkKind>) -> PrivateKey

Constructs new compressed ECDSA private key using the secp256k1 algorithm and a secure random number generator.

pub fn new(key: SecretKey, network: impl Into<NetworkKind>) -> PrivateKey

Constructs compressed ECDSA private key from the provided generic Secp256k1 private key and the specified network

pub fn new_uncompressed( key: SecretKey, network: impl Into<NetworkKind>, ) -> PrivateKey

Constructs uncompressed (legacy) ECDSA private key from the provided generic Secp256k1 private key and the specified network

pub fn public_key<C>(&self, secp: &Secp256k1<C>) -> PublicKey

where C: Signing,

Creates a public key from this private key

pub fn to_bytes(self) -> Vec<u8>

Serialize the private key to bytes

pub fn from_slice( data: &[u8], network: impl Into<NetworkKind>, ) -> Result<PrivateKey, Error>

Deserialize a private key from a slice

pub fn fmt_wif(&self, fmt: &mut dyn Write) -> Result<(), Error>

Format the private key to WIF format.

pub fn to_wif(self) -> String

Get WIF encoding of this private key.

pub fn from_wif(wif: &str) -> Result<PrivateKey, FromWifError>

Parse WIF encoded private key.

pub fn negate(&self) -> PrivateKey

Returns a new private key with the negated secret value.

The resulting key corresponds to the same x-only public key (identical x-coordinate) but with the opposite y-coordinate parity. This is useful for ensuring compatibility with specific public key formats and BIP-340 requirements.

Trait Implementations

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PrivateKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PrivateKey

Available on crate feature serde only.

fn deserialize<D>(d: D) -> Result<PrivateKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PrivateKey

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl FromStr for PrivateKey

type Err = FromWifError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<PrivateKey, FromWifError>

Parses a string s to return a value of this type.

impl<Ctx> GeneratableKey<Ctx> for PrivateKey

where Ctx: ScriptContext,

type Entropy = [u8; 32]

Type specifying the amount of entropy required e.g. [u8;32]

type Options = PrivateKeyGenerateOptions

Extra options required by the generate_with_entropy

type Error = Error

Returned error in case of failure

fn generate_with_entropy( options: <PrivateKey as GeneratableKey<Ctx>>::Options, entropy: <PrivateKey as GeneratableKey<Ctx>>::Entropy, ) -> Result<GeneratedKey<PrivateKey, Ctx>, <PrivateKey as GeneratableKey<Ctx>>::Error>

Generate a key given the extra options and the entropy

fn generate( options: Self::Options, ) -> Result<GeneratedKey<Self, Ctx>, Self::Error>

Generate a key given the options with random entropy.

fn generate_with_aux_rand( options: Self::Options, rng: &mut (impl CryptoRng + RngCore), ) -> Result<GeneratedKey<Self, Ctx>, Self::Error>

Generate a key given the options with random entropy.

impl Index<RangeFull> for PrivateKey

type Output = [u8]

The returned type after indexing.

fn index(&self, _: RangeFull) -> &[u8]

Performs the indexing (container[index]) operation.

impl<Ctx> IntoDescriptorKey<Ctx> for PrivateKey

where Ctx: ScriptContext,

fn into_descriptor_key(self) -> Result<DescriptorKey<Ctx>, KeyError>

Turn the key into a DescriptorKey within the requested ScriptContext

impl PartialEq for PrivateKey

fn eq(&self, other: &PrivateKey) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for PrivateKey

Available on crate feature serde only.

fn serialize<S>( &self, s: S, ) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PrivateKey

impl Eq for PrivateKey

impl StructuralPartialEq for PrivateKey