Struct PrivateKey

pub struct PrivateKey<N>
where
    N: Network,
{ /* private fields */ }

Implementations

impl<N> PrivateKey<N>

where N: Network,

pub fn try_from(seed: Field<N>) -> Result<PrivateKey<N>, Error>

Returns the account private key from an account seed.

impl<N> PrivateKey<N>

where N: Network,

pub fn sign<R>( &self, message: &[Field<N>], rng: &mut R, ) -> Result<Signature<N>, Error>

where R: Rng + CryptoRng,

Returns a signature for the given message (as field elements) using the private key.

pub fn sign_bytes<R>( &self, message: &[u8], rng: &mut R, ) -> Result<Signature<N>, Error>

where R: Rng + CryptoRng,

Returns a signature for the given message (as bytes) using the private key.

pub fn sign_bits<R>( &self, message: &[bool], rng: &mut R, ) -> Result<Signature<N>, Error>

where R: Rng + CryptoRng,

Returns a signature for the given message (as bits) using the private key.

impl<N> PrivateKey<N>

where N: Network,

pub fn new<R>(rng: &mut R) -> Result<PrivateKey<N>, Error>

where R: Rng + CryptoRng,

Samples a new random private key.

pub const fn seed(&self) -> Field<N>

Returns the account seed.

pub const fn sk_sig(&self) -> Scalar<N>

Returns the signature secret key.

pub const fn r_sig(&self) -> Scalar<N>

Returns the signature randomizer.

Trait Implementations

impl<N> Clone for PrivateKey<N>

where N: Clone + Network,

fn clone(&self) -> PrivateKey<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N> Debug for PrivateKey<N>

where N: Debug + Network,

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

Formats the value using the given formatter.

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

where N: Network,

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

where D: Deserializer<'de>,

Deserializes an account private key from a string or bytes.

impl<N> Display for PrivateKey<N>

where N: Network,

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

Writes the account private key as a base58 string.

impl<N> FromBytes for PrivateKey<N>

where N: Network,

fn read_le<R>(reader: R) -> Result<PrivateKey<N>, Error>

where R: Read,

Reads an account private key from a buffer.

fn from_bytes_le(bytes: &[u8]) -> Result<Self, Error>

where Self: Sized,

Returns Self from a byte array in little-endian order.

impl<N> FromStr for PrivateKey<N>

where N: Network,

fn from_str(s: &str) -> Result<PrivateKey<N>, <PrivateKey<N> as FromStr>::Err>

Reads in an account private key from a base58 string.

type Err = Error

The associated error which can be returned from parsing.

impl<N> Hash for PrivateKey<N>

where N: Hash + Network,

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<N> PartialEq for PrivateKey<N>

where N: PartialEq + Network,

fn eq(&self, other: &PrivateKey<N>) -> 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<N> Serialize for PrivateKey<N>

where N: Network,

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

where S: Serializer,

Serializes an account private key into string or bytes.

impl<N> ToBytes for PrivateKey<N>

where N: Network,

fn write_le<W>(&self, writer: W) -> Result<(), Error>

where W: Write,

Writes an account private key to a buffer.

fn to_bytes_le(&self) -> Result<Vec<u8>, Error>

where Self: Sized,

Returns self as a byte array in little-endian order.

impl<N> TryFrom<&PrivateKey<N>> for Address<N>

where N: Network,

fn try_from( private_key: &PrivateKey<N>, ) -> Result<Address<N>, <Address<N> as TryFrom<&PrivateKey<N>>>::Error>

Derives the account address from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<&PrivateKey<N>> for ViewKey<N>

where N: Network,

fn try_from( private_key: &PrivateKey<N>, ) -> Result<ViewKey<N>, <ViewKey<N> as TryFrom<&PrivateKey<N>>>::Error>

Initializes a new account view key from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<PrivateKey<N>> for Address<N>

where N: Network,

fn try_from( private_key: PrivateKey<N>, ) -> Result<Address<N>, <Address<N> as TryFrom<PrivateKey<N>>>::Error>

Derives the account address from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> TryFrom<PrivateKey<N>> for ViewKey<N>

where N: Network,

fn try_from( private_key: PrivateKey<N>, ) -> Result<ViewKey<N>, <ViewKey<N> as TryFrom<PrivateKey<N>>>::Error>

Initializes a new account view key from an account private key.

type Error = Error

The type returned in the event of a conversion error.

impl<N> Zeroize for PrivateKey<N>

where N: Network,

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<N> Copy for PrivateKey<N>

where N: Copy + Network,

impl<N> Eq for PrivateKey<N>

where N: Eq + Network,

impl<N> StructuralPartialEq for PrivateKey<N>

where N: Network,