Account

Struct Account 

Source
pub struct Account { /* private fields */ }

Implementations§

Source§

impl Account

Source

pub fn new() -> Result<Self>

Generates a new Account using a random seed.

Source

pub fn private_key(&self) -> &PrivateKey

Returns the private key of the account.

Source

pub fn address(&self) -> &Address

Returns the address of the account.

Source

pub fn view_key(&self) -> &ViewKey

Returns the view key of the account.

Source

pub fn get_encrypted_key(&self, secret: &str) -> Result<Ciphertext>

Encrypts the private key into a ciphertext using a secret.

§Arguments
  • secret - The secret used for encryption.
§Returns

The ciphertext.

§Example
use std::str::FromStr;
use aleo_agent::account::Account;
use aleo_agent::PrivateKey;

let acc = Account::from_private_key("PRIVATE KEY").unwrap();
let encrypted_key = acc.get_encrypted_key("secret").expect("failed to encrypt key");
let recover_account = Account::from_encrypted_key(&encrypted_key, "secret").expect("failed to decrypt key");

assert_eq!(acc.private_key().to_string(), recover_account.private_key().to_string());
Source

pub fn sign(&self, msg: &[u8]) -> Result<Signature>

Signs a message with the private key.

§Arguments
  • msg - The message to sign.
§Returns

The signature.

§Example
use aleo_agent::account::Account;

let acc = Account::new().unwrap();
let sig = acc.sign("hello".as_bytes()).expect("failed to sign message");

assert!(acc.verify("hello".as_bytes(), &sig));
Source

pub fn verify(&self, msg: &[u8], signature: &Signature) -> bool

Verifies a message signature.

§Arguments
  • msg - The message to verify.
  • signature - The signature to verify.
§Returns

true if the signature is valid, false otherwise.

Source§

impl Account

Source

pub fn from_seed(seed: u64) -> Result<Self>

Generates a new Account from a seed.

§Example
use rand::Rng;
use rand_chacha::ChaChaRng;
use rand_chacha::rand_core::{SeedableRng};
use aleo_agent::account::Account;
use aleo_agent::PrivateKey;

let mut rng = ChaChaRng::from_entropy();
let seed : u64 = rng.gen();
let account = Account::from_seed(seed).unwrap();

let mut rng_from_seed = ChaChaRng::seed_from_u64(seed);
let private_key = PrivateKey::new(&mut rng_from_seed).expect("failed to recover private key from seed");

assert_eq!(account.private_key().to_string(), private_key.to_string());
Source

pub fn from_private_key(key: &str) -> Result<Self>

Generates a new Account from a private key string.

§Example
use std::str::FromStr;
use aleo_agent::account::Account;
use aleo_agent::PrivateKey;

let private_key = PrivateKey::from_str("YOUR PRIVATE KEY").unwrap();
let account = Account::from_private_key("YOUR PRIVATE KEY").unwrap();

assert_eq!(account.private_key().to_string(), private_key.to_string());
Source

pub fn from_encrypted_key(ciphertext: &Ciphertext, secret: &str) -> Result<Self>

Decrypts a private key from ciphertext using a secret.

§Arguments
  • ciphertext - The ciphertext of the encrypted private key.
  • secret - The secret used for decryption.
§Returns

The decrypted Account.

§Example
use std::str::FromStr;
use aleo_agent::account::Account;
use aleo_agent::PrivateKey;

let acc = Account::from_private_key("YOUR PRIVATE KET").unwrap();
let encrypted_key = acc.get_encrypted_key("SECRET").expect("failed to encrypt key");
let recover_account = Account::from_encrypted_key(&encrypted_key, "secret").expect("failed to decrypt key");

assert_eq!(acc.private_key().to_string(), recover_account.private_key().to_string());

Trait Implementations§

Source§

impl Clone for Account

Source§

fn clone(&self) -> Account

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Account

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Account

Source§

fn default() -> Account

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more