Enum iota_sdk::client::secret::SecretManager

#[non_exhaustive]
pub enum SecretManager {
    Stronghold(StrongholdSecretManager),
    LedgerNano(LedgerSecretManager),
    Mnemonic(MnemonicSecretManager),
    PrivateKey(Box<PrivateKeySecretManager>),
    Placeholder,
}

Available on crate feature client only.

Supported secret managers

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Stronghold(StrongholdSecretManager)

Available on crate feature stronghold only.

Secret manager that uses iota_stronghold as the backing storage.

LedgerNano(LedgerSecretManager)

Available on crate feature ledger_nano only.

Secret manager that uses a Ledger Nano hardware wallet or Speculos simulator.

Mnemonic(MnemonicSecretManager)

Secret manager that uses a mnemonic in plain memory. It’s not recommended for production use. Use LedgerNano or Stronghold instead.

PrivateKey(Box<PrivateKeySecretManager>)

Available on crate feature private_key_secret_manager only.

Secret manager that uses a single private key.

Placeholder

Secret manager that’s just a placeholder, so it can be provided to an online wallet, but can’t be used for signing.

Implementations

impl SecretManager

pub async fn generate_ed25519_addresses( &self, __arg1: GetAddressesOptions ) -> Result<Vec<Bech32Address>>

Get a vector of public bech32 addresses

pub async fn generate_evm_addresses( &self, __arg1: GetAddressesOptions ) -> Result<Vec<String>>

Get a vector of EVM address strings

impl SecretManager

pub fn try_from_mnemonic(mnemonic: impl Into<Mnemonic>) -> Result<Self>

Tries to create a SecretManager from a mnemonic string.

pub fn try_from_hex_seed(seed: impl Into<Zeroizing<String>>) -> Result<Self>

Tries to create a SecretManager from a seed hex string.

Trait Implementations

impl Debug for SecretManager

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

Formats the value using the given formatter.

impl Display for SecretManager

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

Formats the value using the given formatter.

impl From<&SecretManager> for SecretManagerDto

fn from(value: &SecretManager) -> Self

Converts to this type from the input type.

impl From<LedgerSecretManager> for SecretManager

fn from(secret_manager: LedgerSecretManager) -> Self

Converts to this type from the input type.

impl From<MnemonicSecretManager> for SecretManager

fn from(secret_manager: MnemonicSecretManager) -> Self

Converts to this type from the input type.

impl From<PrivateKeySecretManager> for SecretManager

fn from(secret_manager: PrivateKeySecretManager) -> Self

Converts to this type from the input type.

impl From<StrongholdAdapter> for SecretManager

fn from(secret_manager: StrongholdSecretManager) -> Self

Converts to this type from the input type.

impl FromStr for SecretManager

type Err = Error

The associated error which can be returned from parsing.

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

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

impl SecretManage for SecretManager

type Error = Error

fn generate_ed25519_addresses<'life0, 'async_trait>( &'life0 self, coin_type: u32, account_index: u32, address_indexes: Range<u32>, options: impl 'async_trait + Into<Option<GenerateAddressOptions>> + Send ) -> Pin<Box<dyn Future<Output = Result<Vec<Ed25519Address>>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Generates addresses.

fn generate_evm_addresses<'life0, 'async_trait>( &'life0 self, coin_type: u32, account_index: u32, address_indexes: Range<u32>, options: impl 'async_trait + Into<Option<GenerateAddressOptions>> + Send ) -> Pin<Box<dyn Future<Output = Result<Vec<EvmAddress>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn sign_ed25519<'life0, 'life1, 'async_trait>( &'life0 self, msg: &'life1 [u8], chain: Bip44 ) -> Pin<Box<dyn Future<Output = Result<Ed25519Signature>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs msg using the given Bip44 using Ed25519.

fn sign_secp256k1_ecdsa<'life0, 'life1, 'async_trait>( &'life0 self, msg: &'life1 [u8], chain: Bip44 ) -> Pin<Box<dyn Future<Output = Result<(PublicKey, RecoverableSignature), Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs msg using the given Bip44 using Secp256k1.

fn sign_transaction_essence<'life0, 'life1, 'async_trait>( &'life0 self, prepared_transaction_data: &'life1 PreparedTransactionData, time: Option<u32> ) -> Pin<Box<dyn Future<Output = Result<Unlocks, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs a transaction essence.

fn sign_transaction<'life0, 'async_trait>( &'life0 self, prepared_transaction_data: PreparedTransactionData ) -> Pin<Box<dyn Future<Output = Result<TransactionPayload, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn signature_unlock<'life0, 'life1, 'async_trait>( &'life0 self, essence_hash: &'life1 [u8; 32], chain: Bip44 ) -> Pin<Box<dyn Future<Output = Result<Unlock, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Signs essence_hash using the given chain, returning an Unlock.

impl SecretManagerConfig for SecretManager

type Config = SecretManagerDto

fn to_config(&self) -> Option<Self::Config>

fn from_config(config: &Self::Config) -> Result<Self, Self::Error>

impl TryFrom<SecretManagerDto> for SecretManager

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: SecretManagerDto) -> Result<Self>

Performs the conversion.