Struct RootSeed

pub struct RootSeed(/* private fields */);

The root secret from which the user node’s keys and credentials are derived.

Implementations

impl RootSeed

pub fn generate() -> Self

Generate a new random RootSeed using the system CSPRNG.

pub fn read(wallet_env: &WalletEnv) -> Result<Option<Self>>

Read a RootSeed from the default seedphrase path for this environment (~/.lexe/seedphrase[.env].txt).

Returns Ok(None) if the file doesn’t exist.

pub fn write(&self, wallet_env: &WalletEnv) -> Result<()>

Write this RootSeed to the default seedphrase path for this environment (~/.lexe/seedphrase[.env].txt).

Creates parent directories if needed. Fails if the file already exists.

pub fn read_from_path(path: &Path) -> Result<Option<Self>>

Read a RootSeed from a seedphrase file at a specific path.

Returns Ok(None) if the file doesn’t exist.

pub fn write_to_path(&self, path: &Path) -> Result<()>

Write this RootSeed to a seedphrase file at a specific path.

Creates parent directories if needed. Returns an error if the file already exists. On Unix, the file is created with mode 0600 (owner read/write only).

pub fn from_mnemonic(mnemonic: Mnemonic) -> Result<Self>

Construct a RootSeed from a BIP39 mnemonic.

pub fn from_bytes(bytes: &[u8]) -> Result<Self>

Construct a RootSeed from a 32-byte slice.

pub fn from_hex(hex: &str) -> Result<Self>

Construct a RootSeed from a 64-character hex string.

pub fn to_mnemonic(&self) -> Mnemonic

Convert this root secret to its BIP39 mnemonic.

pub fn as_bytes(&self) -> &[u8]

Borrow the 32-byte root secret.

pub fn to_hex(&self) -> String

Encode the root secret as a 64-character hex string.

pub fn derive_user_pk(&self) -> UserPk

Derive the user’s public key.

pub fn derive_node_pk(&self) -> NodePk

Derive the node public key.

pub fn password_encrypt(&self, password: &str) -> Result<Vec<u8>>

Encrypt this root secret under the given password.

pub fn password_decrypt(password: &str, encrypted: Vec<u8>) -> Result<Self>

Decrypt a password-encrypted root secret.

Trait Implementations

impl Debug for RootSeed

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RootSeed

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a RootSeed> for CredentialsRef<'a>

fn from(root_seed: &'a RootSeed) -> Self

Converts to this type from the input type.

impl From<RootSeed> for Credentials

fn from(root_seed: RootSeed) -> Self

Converts to this type from the input type.

impl FromStr for RootSeed

type Err = <RootSeed as FromStr>::Err

The associated error which can be returned from parsing.

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

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

impl Serialize for RootSeed

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for RootSeed

type Error = Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<Mnemonic> for RootSeed

type Error = Error

The type returned in the event of a conversion error.

fn try_from(mnemonic: Mnemonic) -> Result<Self, Self::Error>

Performs the conversion.