Struct emerald_core::keystore::KeyFile

pub struct KeyFile {
    pub visible: Option<bool>,
    pub name: Option<String>,
    pub description: Option<String>,
    pub address: Address,
    pub uuid: Uuid,
    pub crypto: CryptoType,
}

A keystore file (account private core encrypted with a passphrase)

Fields

visible: Option<bool>

Specifies if Keyfile is visible

name: Option<String>

User specified name

description: Option<String>

User specified description

address: Address

Address

uuid: Uuid

UUID v4

crypto: CryptoType

Methods

impl KeyFile

fn decode(f: String) -> Result<KeyFile, Error>

Decode Keyfile from JSON Handles different variants of crypto section

fn flush<P: AsRef<Path>>(
    &self,
    dir: P,
    filename: Option<&str>
) -> Result<(), Error>

Serializes into JSON file with the name format UTC--<timestamp>Z--<uuid>

Arguments

• dir - path to destination directory
• addr - a public address (optional)

fn search_by_address<P: AsRef<Path>>(
    addr: &Address,
    path: P
) -> Result<(PathBuf, KeyFile), Error>

Search of KeyFile by specified Address Returns set of filepath and Keyfile

Arguments

• path - path with keystore files

impl KeyFile

fn new(
    passphrase: &str,
    sec_level: &KdfDepthLevel,
    name: Option<String>,
    description: Option<String>
) -> Result<KeyFile, Error>

Creates a new KeyFile with specified passphrase at random (rand::OsRng)

Arguments

• passphrase - password for key derivation function

fn new_custom<R: Rng>(
    pk: PrivateKey,
    passphrase: &str,
    kdf: Kdf,
    rng: &mut R,
    name: Option<String>,
    description: Option<String>
) -> Result<KeyFile, Error>

Creates a new KeyFile with specified PrivateKey, passphrase, key derivation function and with given custom random generator

Arguments

• pk - a private key
• passphrase - password for key derivation function
• kdf - customized key derivation function
• rnd - predefined random number generator

fn decrypt_address(&self, passphrase: &str) -> Result<Address, Error>

Decrypt public address from keystore file by a passphrase

fn decrypt_key(&self, passphrase: &str) -> Result<PrivateKey, Error>

Decrypt private key from keystore file by a passphrase

fn encrypt_key(&mut self, pk: PrivateKey, passphrase: &str)

Encrypt a new private key for keystore file with a passphrase

fn encrypt_key_custom<R: Rng>(
    &mut self,
    pk: PrivateKey,
    passphrase: &str,
    rng: &mut R
)

Encrypt a new private key for keystore file with a passphrase and with given custom random generator

Trait Implementations

impl Encodable for KeyFile

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

Serialize a value using an Encoder.

impl Debug for KeyFile

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

Formats the value using the given formatter.

impl Clone for KeyFile

fn clone(&self) -> KeyFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for KeyFile

impl Default for KeyFile

fn default() -> Self

Returns the "default value" for a type.

impl From<Uuid> for KeyFile

fn from(uuid: Uuid) -> Self

Performs the conversion.

impl PartialEq for KeyFile

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

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

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

This method tests for !=.

impl PartialOrd for KeyFile

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

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

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

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

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

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

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

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

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 Ord for KeyFile

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

This method returns an Ordering between self and other.

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

🔬 This is a nightly-only experimental API. (ord_max_min)

Compares and returns the maximum of two values.

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

🔬 This is a nightly-only experimental API. (ord_max_min)

Compares and returns the minimum of two values.

impl Display for KeyFile

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

Formats the value using the given formatter.