Struct aleo_wasm::account::private_key::PrivateKey

impl PrivateKey

pub fn new() -> Self

Generate a new private key using a cryptographically secure random number generator

@returns {PrivateKey}

pub fn from_seed_unchecked(seed: &[u8]) -> PrivateKey

Get a private key from a series of unchecked bytes

@param {Uint8Array} seed Unchecked 32 byte long Uint8Array acting as the seed for the private key @returns {PrivateKey}

pub fn from_string(private_key: &str) -> Result<PrivateKey, String>

Get a private key from a string representation of a private key

@param {string} seed String representation of a private key @returns {PrivateKey}

pub fn to_string(&self) -> String

Get a string representation of the private key. This function should be used very carefully as it exposes the private key plaintext

@returns {string} String representation of a private key

pub fn to_view_key(&self) -> ViewKey

Get the view key corresponding to the private key

@returns {ViewKey}

pub fn to_address(&self) -> Address

Get the address corresponding to the private key

@returns {Address}

pub fn sign(&self, message: &[u8]) -> Signature

Sign a message with the private key

@param {Uint8Array} Byte array representing a message signed by the address @returns {Signature} Signature generated by signing the message with the address

pub fn new_encrypted(secret: &str) -> Result<PrivateKeyCiphertext, String>

Get a new randomly generated private key ciphertext using a secret. The secret is sensitive and will be needed to decrypt the private key later, so it should be stored securely

@param {string} secret Secret used to encrypt the private key @returns {PrivateKeyCiphertext | Error} Ciphertext representation of the private key

pub fn to_ciphertext( &self, secret: &str ) -> Result<PrivateKeyCiphertext, String>

Encrypt an existing private key with a secret. The secret is sensitive and will be needed to decrypt the private key later, so it should be stored securely

@param {string} secret Secret used to encrypt the private key @returns {PrivateKeyCiphertext | Error} Ciphertext representation of the private key

pub fn from_private_key_ciphertext( ciphertext: &PrivateKeyCiphertext, secret: &str ) -> Result<PrivateKey, String>

Get private key from a private key ciphertext and secret originally used to encrypt it

@param {PrivateKeyCiphertext} ciphertext Ciphertext representation of the private key @param {string} secret Secret originally used to encrypt the private key @returns {PrivateKey | Error} Private key

Methods from Deref<Target = PrivateKey<Testnet3>>§

pub fn sign<R>( &self, message: &[Field<N>], rng: &mut R ) -> Result<Signature<N>, Error>where R: Rng + CryptoRng,

Returns a signature for the given message (as field elements) using the private key.

pub fn sign_bytes<R>( &self, message: &[u8], rng: &mut R ) -> Result<Signature<N>, Error>where R: Rng + CryptoRng,

Returns a signature for the given message (as bytes) using the private key.

pub fn sign_bits<R>( &self, message: &[bool], rng: &mut R ) -> Result<Signature<N>, Error>where R: Rng + CryptoRng,

Returns a signature for the given message (as bits) using the private key.

pub fn seed(&self) -> Field<N>

Returns the account seed.

pub fn sk_sig(&self) -> Scalar<N>

Returns the signature secret key.

pub fn r_sig(&self) -> Scalar<N>

Returns the signature randomizer.

Trait Implementations§

impl Clone for PrivateKey

fn clone(&self) -> PrivateKey

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

impl Debug for PrivateKey

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

Formats the value using the given formatter. Read more

impl Deref for PrivateKey

type Target = PrivateKey<Testnet3>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for PrivateKey

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

Formats the value using the given formatter. Read more

impl From<&PrivateKey> for PrivateKey<Testnet3>

fn from(private_key: &PrivateKey) -> Self

Converts to this type from the input type.

impl From<PrivateKey<Testnet3>> for PrivateKey

fn from(private_key: PrivateKey<Testnet3>) -> Self

Converts to this type from the input type.

impl From<PrivateKey> for JsValue

fn from(value: PrivateKey) -> Self

Converts to this type from the input type.

impl From<PrivateKey> for PrivateKey<Testnet3>

fn from(private_key: PrivateKey) -> Self

Converts to this type from the input type.

impl FromStr for PrivateKey

type Err = Error

The associated error which can be returned from parsing.

fn from_str(private_key: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type. Read more

impl FromWasmAbi for PrivateKey

type Abi = u32

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more

impl IntoWasmAbi for PrivateKey

type Abi = u32

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for PrivateKey

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = Ref<'static, PrivateKey>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for PrivateKey

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for PrivateKey

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option. Read more

impl PartialEq for PrivateKey

fn eq(&self, other: &PrivateKey) -> bool

This method tests for self and other values to be equal, and is used by ==.

1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RefFromWasmAbi for PrivateKey

type Abi = u32

The wasm ABI type references to Self are recovered from.

type Anchor = Ref<'static, PrivateKey>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.