Struct FilesystemKeyStore 

pub struct FilesystemKeyStore {
    pub keys_directory: PathBuf,
    /* private fields */
}

Available on crate feature std only.

A filesystem-based keystore that stores keys in separate files and provides transaction authentication functionality. The public key is hashed and the result is used as the filename and the contents of the file are the serialized public and secret key.

Account-to-key mappings are stored in a separate JSON index file.

Fields

keys_directory: PathBuf

The directory where the keys are stored and read from.

Implementations

impl FilesystemKeyStore

pub fn new(keys_directory: PathBuf) -> Result<Self, KeyStoreError>

Creates a FilesystemKeyStore on a specific directory.

pub fn get_key_sync( &self, pub_key: PublicKeyCommitment, ) -> Result<Option<AuthSecretKey>, KeyStoreError>

Retrieves a secret key from the keystore given the commitment of a public key.

Trait Implementations

impl Clone for FilesystemKeyStore

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FilesystemKeyStore

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

Formats the value using the given formatter.

impl Keystore for FilesystemKeyStore

fn add_key<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 AuthSecretKey, account_id: AccountId, ) -> Pin<Box<dyn Future<Output = Result<(), KeyStoreError>> + Send + 'async_trait>>

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

Adds a secret key to the keystore and associates it with the given account.

fn remove_key<'life0, 'async_trait>( &'life0 self, pub_key: PublicKeyCommitment, ) -> Pin<Box<dyn Future<Output = Result<(), KeyStoreError>> + Send + 'async_trait>>

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

Removes a key from the keystore by its public key commitment.

fn get_key<'life0, 'async_trait>( &'life0 self, pub_key: PublicKeyCommitment, ) -> Pin<Box<dyn Future<Output = Result<Option<AuthSecretKey>, KeyStoreError>> + Send + 'async_trait>>

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

Retrieves a secret key by its public key commitment.

fn get_account_id_by_key_commitment<'life0, 'async_trait>( &'life0 self, pub_key_commitment: PublicKeyCommitment, ) -> Pin<Box<dyn Future<Output = Result<Option<AccountId>, KeyStoreError>> + Send + 'async_trait>>

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

Returns the account ID associated with a given public key commitment.

fn get_account_key_commitments<'life0, 'life1, 'async_trait>( &'life0 self, account_id: &'life1 AccountId, ) -> Pin<Box<dyn Future<Output = Result<BTreeSet<PublicKeyCommitment>, KeyStoreError>> + Send + 'async_trait>>

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

Returns all public key commitments associated with the given account ID.

fn get_keys_for_account<'life0, 'life1, 'async_trait>( &'life0 self, account_id: &'life1 AccountId, ) -> Pin<Box<dyn Future<Output = Result<Vec<AuthSecretKey>, KeyStoreError>> + Send + 'async_trait>>

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

Returns all secret keys associated with the given account ID.

impl TransactionAuthenticator for FilesystemKeyStore

async fn get_signature( &self, pub_key: PublicKeyCommitment, signing_info: &SigningInputs, ) -> Result<Signature, AuthenticationError>

Gets a signature over a message, given a public key.

The public key should correspond to one of the keys tracked by the keystore.

Errors

If the public key isn’t found in the store, AuthenticationError::UnknownPublicKey is returned.

async fn get_public_key( &self, pub_key_commitment: PublicKeyCommitment, ) -> Option<Arc<PublicKey>>

Retrieves a public key for a specific public key commitment.