Struct cfxcore_accounts::AccountProvider
source · pub struct AccountProvider { /* private fields */ }
Expand description
Account management. Responsible for unlocking accounts.
Implementations§
source§impl AccountProvider
impl AccountProvider
sourcepub fn new(
sstore: Box<dyn SecretStore>,
settings: AccountProviderSettings
) -> Self
pub fn new( sstore: Box<dyn SecretStore>, settings: AccountProviderSettings ) -> Self
Creates new account provider.
sourcepub fn transient_provider() -> Self
pub fn transient_provider() -> Self
Creates not disk backed provider.
sourcepub fn new_account(&self, password: &Password) -> Result<Address, Error>
pub fn new_account(&self, password: &Password) -> Result<Address, Error>
Creates new random account.
sourcepub fn new_account_and_public(
&self,
password: &Password
) -> Result<(Address, Public), Error>
pub fn new_account_and_public( &self, password: &Password ) -> Result<(Address, Public), Error>
Creates new random account and returns address and public key
sourcepub fn insert_account(
&self,
secret: Secret,
password: &Password
) -> Result<Address, Error>
pub fn insert_account( &self, secret: Secret, password: &Password ) -> Result<Address, Error>
Inserts new account into underlying store. Does not unlock account!
sourcepub fn derive_account(
&self,
address: &Address,
password: Option<Password>,
derivation: Derivation,
save: bool
) -> Result<Address, SignError>
pub fn derive_account( &self, address: &Address, password: Option<Password>, derivation: Derivation, save: bool ) -> Result<Address, SignError>
Generates new derived account based on the existing one If password is not provided, account must be unlocked New account will be created with the same password (if save: true)
sourcepub fn import_wallet(
&self,
json: &[u8],
password: &Password,
gen_id: bool
) -> Result<Address, Error>
pub fn import_wallet( &self, json: &[u8], password: &Password, gen_id: bool ) -> Result<Address, Error>
Import a new wallet.
sourcepub fn has_account(&self, address: Address) -> bool
pub fn has_account(&self, address: Address) -> bool
Checks whether an account with a given address is present.
sourcepub fn default_account(&self) -> Result<Address, Error>
pub fn default_account(&self) -> Result<Address, Error>
Returns the address of default account.
sourcepub fn addresses_info(&self) -> HashMap<Address, AccountMeta>
pub fn addresses_info(&self) -> HashMap<Address, AccountMeta>
Returns each address along with metadata.
sourcepub fn set_address_name(&self, account: Address, name: String)
pub fn set_address_name(&self, account: Address, name: String)
Returns each address along with metadata.
sourcepub fn set_address_meta(&self, account: Address, meta: String)
pub fn set_address_meta(&self, account: Address, meta: String)
Returns each address along with metadata.
sourcepub fn remove_address(&self, addr: Address)
pub fn remove_address(&self, addr: Address)
Removes and address from the address book
sourcepub fn accounts_info(&self) -> Result<HashMap<Address, AccountMeta>, Error>
pub fn accounts_info(&self) -> Result<HashMap<Address, AccountMeta>, Error>
Returns each account along with name and meta.
sourcepub fn account_meta(&self, address: Address) -> Result<AccountMeta, Error>
pub fn account_meta(&self, address: Address) -> Result<AccountMeta, Error>
Returns each account along with name and meta.
sourcepub fn account_public(
&self,
address: Address,
password: &Password
) -> Result<Public, Error>
pub fn account_public( &self, address: Address, password: &Password ) -> Result<Public, Error>
Returns account public key.
sourcepub fn set_account_name(
&self,
address: Address,
name: String
) -> Result<(), Error>
pub fn set_account_name( &self, address: Address, name: String ) -> Result<(), Error>
Returns each account along with name and meta.
sourcepub fn set_account_meta(
&self,
address: Address,
meta: String
) -> Result<(), Error>
pub fn set_account_meta( &self, address: Address, meta: String ) -> Result<(), Error>
Returns each account along with name and meta.
sourcepub fn test_password(
&self,
address: &Address,
password: &Password
) -> Result<bool, Error>
pub fn test_password( &self, address: &Address, password: &Password ) -> Result<bool, Error>
Returns true
if the password for account
is password
. false
if
not.
sourcepub fn kill_account(
&self,
address: &Address,
password: &Password
) -> Result<(), Error>
pub fn kill_account( &self, address: &Address, password: &Password ) -> Result<(), Error>
Permanently removes an account.
sourcepub fn change_password(
&self,
address: &Address,
password: Password,
new_password: Password
) -> Result<(), Error>
pub fn change_password( &self, address: &Address, password: Password, new_password: Password ) -> Result<(), Error>
Changes the password of account
from password
to new_password
.
Fails if incorrect password
given.
sourcepub fn export_account(
&self,
address: &Address,
password: Password
) -> Result<KeyFile, Error>
pub fn export_account( &self, address: &Address, password: Password ) -> Result<KeyFile, Error>
Exports an account for given address.
sourcepub fn lock_account(&self, address: Address) -> Result<(), Error>
pub fn lock_account(&self, address: Address) -> Result<(), Error>
Lock an account
sourcepub fn unlock_account_permanently(
&self,
account: Address,
password: Password
) -> Result<(), Error>
pub fn unlock_account_permanently( &self, account: Address, password: Password ) -> Result<(), Error>
Unlocks account permanently.
sourcepub fn unlock_account_temporarily(
&self,
account: Address,
password: Password
) -> Result<(), Error>
pub fn unlock_account_temporarily( &self, account: Address, password: Password ) -> Result<(), Error>
Unlocks account temporarily (for one signing).
sourcepub fn unlock_account_timed(
&self,
account: Address,
password: Password,
duration: Duration
) -> Result<(), Error>
pub fn unlock_account_timed( &self, account: Address, password: Password, duration: Duration ) -> Result<(), Error>
Unlocks account temporarily with a timeout.
sourcepub fn is_unlocked(&self, address: &Address) -> bool
pub fn is_unlocked(&self, address: &Address) -> bool
Checks if given account is unlocked
sourcepub fn is_unlocked_permanently(&self, address: &Address) -> bool
pub fn is_unlocked_permanently(&self, address: &Address) -> bool
Checks if given account is unlocked permanently
sourcepub fn sign(
&self,
address: Address,
password: Option<Password>,
message: Message
) -> Result<Signature, SignError>
pub fn sign( &self, address: Address, password: Option<Password>, message: Message ) -> Result<Signature, SignError>
Signs the message. If password is not provided the account must be unlocked.
sourcepub fn sign_derived(
&self,
address: &Address,
password: Option<Password>,
derivation: Derivation,
message: Message
) -> Result<Signature, SignError>
pub fn sign_derived( &self, address: &Address, password: Option<Password>, derivation: Derivation, message: Message ) -> Result<Signature, SignError>
Signs message using the derived secret. If password is not provided the account must be unlocked.
sourcepub fn sign_with_token(
&self,
address: Address,
token: Password,
message: Message
) -> Result<(Signature, Password), SignError>
pub fn sign_with_token( &self, address: Address, token: Password, message: Message ) -> Result<(Signature, Password), SignError>
Signs given message with supplied token. Returns a token to use in next signing within this session.
sourcepub fn decrypt_with_token(
&self,
address: Address,
token: Password,
shared_mac: &[u8],
message: &[u8]
) -> Result<(Vec<u8>, Password), SignError>
pub fn decrypt_with_token( &self, address: Address, token: Password, shared_mac: &[u8], message: &[u8] ) -> Result<(Vec<u8>, Password), SignError>
Decrypts a message with given token. Returns a token to use in next operation for this account.
sourcepub fn decrypt(
&self,
address: Address,
password: Option<Password>,
shared_mac: &[u8],
message: &[u8]
) -> Result<Vec<u8>, SignError>
pub fn decrypt( &self, address: Address, password: Option<Password>, shared_mac: &[u8], message: &[u8] ) -> Result<Vec<u8>, SignError>
Decrypts a message. If password is not provided the account must be unlocked.
sourcepub fn agree(
&self,
address: Address,
password: Option<Password>,
other_public: &Public
) -> Result<Secret, SignError>
pub fn agree( &self, address: Address, password: Option<Password>, other_public: &Public ) -> Result<Secret, SignError>
Agree on shared key.
sourcepub fn list_geth_accounts(&self, testnet: bool) -> Vec<Address>
pub fn list_geth_accounts(&self, testnet: bool) -> Vec<Address>
Returns the underlying SecretStore
reference if one exists.
sourcepub fn import_geth_accounts(
&self,
desired: Vec<Address>,
testnet: bool
) -> Result<Vec<Address>, Error>
pub fn import_geth_accounts( &self, desired: Vec<Address>, testnet: bool ) -> Result<Vec<Address>, Error>
Returns the underlying SecretStore
reference if one exists.
sourcepub fn create_vault(&self, name: &str, password: &Password) -> Result<(), Error>
pub fn create_vault(&self, name: &str, password: &Password) -> Result<(), Error>
Create new vault.
sourcepub fn open_vault(&self, name: &str, password: &Password) -> Result<(), Error>
pub fn open_vault(&self, name: &str, password: &Password) -> Result<(), Error>
Open existing vault.
sourcepub fn list_opened_vaults(&self) -> Result<Vec<String>, Error>
pub fn list_opened_vaults(&self) -> Result<Vec<String>, Error>
List all currently opened vaults
sourcepub fn change_vault_password(
&self,
name: &str,
new_password: &Password
) -> Result<(), Error>
pub fn change_vault_password( &self, name: &str, new_password: &Password ) -> Result<(), Error>
Change vault password.