Struct solana_zk_token_sdk::encryption::elgamal::ElGamalKeypair

pub struct ElGamalKeypair { /* private fields */ }

A (twisted) ElGamal encryption keypair.

The instances of the secret key are zeroized on drop.

Implementations

impl ElGamalKeypair

pub fn new_for_tests(public: ElGamalPubkey, secret: ElGamalSecretKey) -> Self

Create an ElGamal keypair from an ElGamal public key and an ElGamal secret key.

An ElGamal keypair should never be instantiated manually; ElGamalKeypair::new_rand or ElGamalKeypair::new_from_signer should be used instead. This function exists to create custom ElGamal keypairs for tests.

pub fn new_from_signer( signer: &dyn Signer, public_seed: &[u8] ) -> Result<Self, Box<dyn Error>>

Deterministically derives an ElGamal keypair from a Solana signer and a public seed.

This function exists for applications where a user may not wish to maintain a Solana signer and an ElGamal keypair separately. Instead, a user can derive the ElGamal keypair on-the-fly whenever encryption/decryption is needed.

For the spl-token-2022 confidential extension, the ElGamal public key is specified in a token account. A natural way to derive an ElGamal keypair is to define it from the hash of a Solana keypair and a Solana address as the public seed. However, for general hardware wallets, the signing key is not exposed in the API. Therefore, this function uses a signer to sign a public seed and the resulting signature is then hashed to derive an ElGamal keypair.

pub fn new_rand() -> Self

Generates the public and secret keys for ElGamal encryption.

This function is randomized. It internally samples a scalar element using OsRng.

pub fn pubkey(&self) -> &ElGamalPubkey

pub fn secret(&self) -> &ElGamalSecretKey

pub fn to_bytes(&self) -> [u8; 64]

pub fn from_bytes(bytes: &[u8]) -> Option<Self>

pub fn read_json<R: Read>(reader: &mut R) -> Result<Self, Box<dyn Error>>

Reads a JSON-encoded keypair from a Reader implementor

pub fn read_json_file<F: AsRef<Path>>(path: F) -> Result<Self, Box<dyn Error>>

Reads keypair from a file

pub fn write_json<W: Write>( &self, writer: &mut W ) -> Result<String, Box<dyn Error>>

Writes to a Write implementer with JSON-encoding

pub fn write_json_file<F: AsRef<Path>>( &self, outfile: F ) -> Result<String, Box<dyn Error>>

Write keypair to a file with JSON-encoding

Trait Implementations

impl Clone for ElGamalKeypair

fn clone(&self) -> ElGamalKeypair

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ElGamalKeypair

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElGamalKeypair

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EncodableKey for ElGamalKeypair

fn read<R: Read>(reader: &mut R) -> Result<Self, Box<dyn Error>>

fn write<W: Write>(&self, writer: &mut W) -> Result<String, Box<dyn Error>>

fn read_from_file<F>(path: F) -> Result<Self, Box<dyn Error>>

where F: AsRef<Path>,

fn write_to_file<F>(&self, outfile: F) -> Result<String, Box<dyn Error>>

where F: AsRef<Path>,

impl EncodableKeypair for ElGamalKeypair

type Pubkey = ElGamalPubkey

fn encodable_pubkey(&self) -> Self::Pubkey

Returns an encodable representation of the associated public key.

impl PartialEq for ElGamalKeypair

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

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

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 SeedDerivable for ElGamalKeypair

fn from_seed(seed: &[u8]) -> Result<Self, Box<dyn Error>>

fn from_seed_and_derivation_path( _seed: &[u8], _derivation_path: Option<DerivationPath> ) -> Result<Self, Box<dyn Error>>

fn from_seed_phrase_and_passphrase( seed_phrase: &str, passphrase: &str ) -> Result<Self, Box<dyn Error>>

impl Serialize for ElGamalKeypair

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Zeroize for ElGamalKeypair

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl Eq for ElGamalKeypair

impl StructuralPartialEq for ElGamalKeypair