Struct Key

pub struct Key {}

Implementations

impl Key

pub fn create( wallet_handle: IndyHandle, my_key_json: Option<&str>, ) -> Result<String, ErrorCode>

Creates key pair in wallet

Arguments

• wallet_handle - wallet handle (created by Wallet::open)
• my_key_json - Optional key information as json. If none then defaults are used.

Example

my_key_json { “seed”: string, // Optional (if not set random one will be used); Seed information that allows deterministic key creation. “crypto_type”: string, // Optional (if not set then ed25519 curve is used); Currently only ‘ed25519’ value is supported for this field. }

Returns

verkey of generated key pair, also used as key identifier

pub fn create_timeout( wallet_handle: IndyHandle, my_key_json: Option<&str>, timeout: Duration, ) -> Result<String, ErrorCode>

Creates key pair in wallet

Arguments

• wallet_handle - wallet handle (created by Wallet::open)
• my_key_json - key information as json
• timeout - the maximum time this function waits for a response

Example

my_key_json { “seed”: string, // Optional (if not set random one will be used); Seed information that allows deterministic key creation. “crypto_type”: string, // Optional (if not set then ed25519 curve is used); Currently only ‘ed25519’ value is supported for this field. }

Returns

verkey of generated key pair, also used as key identifier

pub fn create_async<F>( wallet_handle: IndyHandle, my_key_json: Option<&str>, closure: F, ) -> ErrorCode

where F: FnMut(ErrorCode, String) + Send + 'static,

Creates key pair in wallet

Arguments

• wallet_handle - wallet handle (created by Wallet::open)
• my_key_json - Optional key information as json. If none then defaults are used.
• closure - The closure that is called when finished

Example

my_key_json { “seed”: string, // Optional (if not set random one will be used); Seed information that allows deterministic key creation. “crypto_type”: string, // Optional (if not set then ed25519 curve is used); Currently only ‘ed25519’ value is supported for this field. }

Returns

errorcode from calling ffi function. The closure receives the return result

pub fn set_metadata( wallet_handle: IndyHandle, verkey: &str, metadata: &str, ) -> Result<(), ErrorCode>

Saves/replaces the metadata for the verkey in the wallet

Arguments

• wallet_handle - wallet handle (created by Wallet::open)
• verkey - the public key or key id where to store the metadata
• metadata - the metadata that will be stored with the key, can be empty string

pub fn set_metadata_timeout( wallet_handle: IndyHandle, verkey: &str, metadata: &str, timeout: Duration, ) -> Result<(), ErrorCode>

Saves/replaces the metadata for the verkey in the wallet

Arguments

• wallet_handle - wallet handle (created by Wallet::open)
• verkey - the public key or key id where to store the metadata
• metadata - the metadata that will be stored with the key, can be empty string
• timeout - the maximum time this function waits for a response

pub fn set_metadata_async<F>( wallet_handle: IndyHandle, verkey: &str, metadata: &str, closure: F, ) -> ErrorCode

where F: FnMut(ErrorCode) + Send + 'static,

Saves/replaces the metadata for the verkey in the wallet

Arguments

• wallet_handle - wallet handle (created by Wallet::open)
• verkey - the public key or key id where to store the metadata
• metadata - the metadata that will be stored with the key, can be empty string
• closure - The closure that is called when finished

pub fn get_metadata( wallet_handle: IndyHandle, verkey: &str, ) -> Result<String, ErrorCode>

Retrieves the metadata for the verkey in the wallet

Argument

• wallet_handle - wallet handle (created by Wallet::open)
• verkey - the public key or key id to retrieve metadata

Returns

metadata currently stored with the key; Can be empty if no metadata was saved for this key

pub fn get_metadata_timeout( wallet_handle: IndyHandle, verkey: &str, timeout: Duration, ) -> Result<String, ErrorCode>

Retrieves the metadata for the verkey in the wallet

Argument

• wallet_handle - wallet handle (created by Wallet::open)
• verkey - the public key or key id to retrieve metadata
• timeout - the maximum time this function waits for a response

Returns

metadata currently stored with the key; Can be empty if no metadata was saved for this key

pub fn get_metadata_async<F>( wallet_handle: IndyHandle, verkey: &str, closure: F, ) -> ErrorCode

where F: FnMut(ErrorCode, String) + Send + 'static,

Retrieves the metadata for the verkey in the wallet

Argument

• wallet_handle - wallet handle (created by Wallet::open)
• verkey - the public key or key id to retrieve metadata
• closure - The closure that is called when finished

Returns

errorcode from calling ffi function