Struct clarity::private_key::PrivateKey

pub struct PrivateKey(_);

Representation of an Ethereum private key.

Private key can be created using a textual representation, a raw binary form using array of bytes.

With PrivateKey you are able to sign messages, derive public keys. Cryptography-related methods use SECP256K1 elliptic curves.

Implementations

impl PrivateKey

pub fn from_slice(slice: &[u8]) -> Result<PrivateKey, Error>

Convert a given slice of bytes into a valid private key.

Input bytes are validated for a length only.

• slice - A slice of raw bytes with a length of 32.

pub fn to_bytes(&self) -> [u8; 32]

Get bytes back from a PrivateKey

pub fn to_public_key(&self) -> Result<Address, Error>

Create a public key for a given private key.

This is well explained in the Ethereum Yellow Paper Appendix F.

Examples

use clarity::PrivateKey;
let private_key : PrivateKey = "0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f1e".parse().unwrap();
let public_key = private_key.to_public_key().unwrap();

pub fn sign_hash(&self, data: &[u8]) -> Signature

Signs a message that is represented by a hash contained in a binary form.

Requires the data buffer to be exactly 32 bytes in length. You can prepare an input using a hashing function such as Keccak256 which will return a buffer of exact size.

You are advised, though, to use sign_msg which is more user friendly version that uses Keccak256 internally.

Example

let private_key : PrivateKey = "0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f1e".parse().unwrap();
let hash = Keccak256::digest("Hello, world!".as_bytes());
let signature = private_key.sign_hash(&hash);

pub fn sign_msg(&self, data: &[u8]) -> Signature

👎 Deprecated since 0.3.2:

Please use sign_ethereum_msg or sign_insecure_msg instead

Signs any message represented by a slice of data.

Internally it makes Keccak256 hash out of your data, and then creates a signature.

This is more user friendly version of sign_hash which means it will use Keccak256 function to hash your input data.

This method is deprecated as insecure, since it does not prevent signed messages from being possibly valid transactions by appending the standard \x19Ethereum Signed Message:\n32

Example

let private_key : PrivateKey = "0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f1e".parse().unwrap();
let signature = private_key.sign_msg("Hello, world!".as_bytes());

pub fn sign_insecure_msg(&self, data: &[u8]) -> Signature

Signs any message represented by a slice of data.

Internally it makes Keccak256 hash out of your data, and then creates a signature.

This is more user friendly version of sign_hash which means it will use Keccak256 function to hash your input data.

This method is provided on the assumption you know what you are doing, it does not prevent signed messages from being possibly valid transactions. No Ethereum signed message salt is appended. Use with Caution!

Example

let private_key : PrivateKey = "0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f1e".parse().unwrap();
let signature = private_key.sign_msg("Hello, world!".as_bytes());

pub fn sign_ethereum_msg(&self, data: &[u8]) -> Signature

Signs any message represented by a slice of data.

Internally it makes Keccak256 hash out of your data, and then creates a signature.

This is more user friendly version of sign_hash which means it will use Keccak256 function to hash your input data.

Remember this function appends \x19Ethereum Signed Message:\n32 to your hash! so you may need to take that into account when you go to verify

Example

let private_key : PrivateKey = "0102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f1e".parse().unwrap();
let signature = private_key.sign_ethereum_msg("Hello, world!".as_bytes());

Trait Implementations

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PrivateKey

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl Default for PrivateKey

fn default() -> PrivateKey

Returns the “default value” for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for PrivateKey

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

Formats the value using the given formatter.

impl Eq for PrivateKey

impl From<[u8; 32]> for PrivateKey

fn from(val: [u8; 32]) -> PrivateKey

Performs the conversion.

impl FromStr for PrivateKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parse a textual representation of a private key back into PrivateKey type.

It has to be a string that represents 64 characters that are hexadecimal representation of 32 bytes. Optionally this string can be prefixed with 0x at the beggining.

impl LowerHex for PrivateKey

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

Formats the value using the given formatter.

impl Ord for PrivateKey

fn cmp(&self, other: &PrivateKey) -> Ordering

This method returns an Ordering between self and other.

#[must_use]

pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]

pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]

pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PrivateKey> for PrivateKey

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<PrivateKey> for PrivateKey

fn partial_cmp(&self, other: &PrivateKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use]

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

This method tests less than (for self and other) and is used by the < operator.

#[must_use]

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use]

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

This method tests greater than (for self and other) and is used by the > operator.

#[must_use]

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PrivateKey

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

Serialize this value into the given Serde serializer.

impl StructuralEq for PrivateKey

impl StructuralPartialEq for PrivateKey

impl UpperHex for PrivateKey

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

Formats the value using the given formatter.