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.

Methods

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 inpput 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

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.

Example

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

Trait Implementations

impl From<[u8; 32]> for PrivateKey

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

Performs the conversion.

impl Eq for PrivateKey

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.

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

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

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

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

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

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

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

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

impl Copy for PrivateKey

impl Default for PrivateKey

fn default() -> PrivateKey

Returns the "default value" for a type.

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 ToString for PrivateKey

fn to_string(&self) -> String

Converts PrivateKey into a textual representation.

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for PrivateKey

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Debug for PrivateKey

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

Formats the value using the given formatter.

impl UpperHex for PrivateKey

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

Formats the value using the given formatter.

impl LowerHex for PrivateKey

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

Formats the value using the given formatter.

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 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<'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.