Struct iota_keys::keystore::FileBasedKeystore

pub struct FileBasedKeystore { /* private fields */ }

Implementations

impl FileBasedKeystore

pub fn new(path: &PathBuf) -> Result<Self, Error>

pub fn set_path(&mut self, path: &Path)

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

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

Keys saved as Base64 with 33 bytes flag || privkey ($BASE64_STR). To see Bech32 format encoding, use iota keytool export $IOTA_ADDRESS where $IOTA_ADDRESS can be found with iota keytool list. Or use iota keytool convert $BASE64_STR

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

pub fn key_pairs(&self) -> Vec<&IotaKeyPair>

Trait Implementations

impl AccountKeystore for FileBasedKeystore

fn aliases(&self) -> Vec<&Alias>

Return an array of Alias, consisting of every alias and its corresponding public key.

fn aliases_mut(&mut self) -> Vec<&mut Alias>

Return an array of Alias, consisting of every alias and its corresponding public key.

fn create_alias(&self, alias: Option<String>) -> Result<String, Error>

This function returns an error if the provided alias already exists. If the alias has not already been used, then it returns the alias. If no alias has been passed, it will generate a new alias.

fn get_address_by_alias(&self, alias: String) -> Result<&IotaAddress, Error>

Get the address by its alias

fn get_alias_by_address(&self, address: &IotaAddress) -> Result<String, Error>

Get the alias if it exists, or return an error if it does not exist.

fn update_alias( &mut self, old_alias: &str, new_alias: Option<&str>, ) -> Result<String, Error>

Updates an old alias to the new alias and saves it to the alias file. If the new_alias is None, it will generate a new random alias.

fn sign_hashed( &self, address: &IotaAddress, msg: &[u8], ) -> Result<Signature, Error>

fn sign_secure<T>( &self, address: &IotaAddress, msg: &T, intent: Intent, ) -> Result<Signature, Error>

where T: Serialize,

fn add_key( &mut self, alias: Option<String>, keypair: IotaKeyPair, ) -> Result<(), Error>

fn addresses_with_alias(&self) -> Vec<(&IotaAddress, &Alias)>

fn keys(&self) -> Vec<PublicKey>

fn get_key(&self, address: &IotaAddress) -> Result<&IotaKeyPair, Error>

fn addresses(&self) -> Vec<IotaAddress>

fn alias_names(&self) -> Vec<&str>

fn alias_exists(&self, alias: &str) -> bool

Check if an alias exists by its name

fn update_alias_value( &mut self, old_alias: &str, new_alias: Option<&str>, ) -> Result<String, Error>

fn generate_and_add_new_key( &mut self, key_scheme: SignatureScheme, alias: Option<String>, derivation_path: Option<DerivationPath>, word_length: Option<String>, ) -> Result<(IotaAddress, String, SignatureScheme), Error>

fn import_from_mnemonic( &mut self, phrase: &str, key_scheme: SignatureScheme, derivation_path: Option<DerivationPath>, alias: Option<String>, ) -> Result<IotaAddress, Error>

fn import_from_seed( &mut self, seed: &[u8], key_scheme: SignatureScheme, derivation_path: Option<DerivationPath>, alias: Option<String>, ) -> Result<IotaAddress, Error>

impl Default for FileBasedKeystore

fn default() -> FileBasedKeystore

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FileBasedKeystore

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FileBasedKeystore> for Keystore

fn from(v: FileBasedKeystore) -> Keystore

Converts to this type from the input type.

impl Serialize for FileBasedKeystore

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl TryInto<FileBasedKeystore> for Keystore

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<FileBasedKeystore, <Self as TryInto<FileBasedKeystore>>::Error>

Performs the conversion.