Struct solana_zk_token_sdk::encryption::elgamal::ElGamalKeypair

pub struct ElGamalKeypair {
    pub public: ElGamalPubkey,
    pub secret: ElGamalSecretKey,
}

A (twisted) ElGamal encryption keypair.

The instances of the secret key are zeroized on drop.

Fields

public: ElGamalPubkey

The public half of this keypair.

secret: ElGamalSecretKey

The secret half of this keypair.

Implementations

impl ElGamalKeypair

pub fn new(signer: &dyn Signer, address: &Pubkey) -> Result<Self, SignerError>

Deterministically derives an ElGamal keypair from an Ed25519 signing key and a Solana address.

This function exists for applications where a user may not wish to maintin a Solana (Ed25519) keypair and an ElGamal keypair separately. A user may wish to solely maintain the Solana keypair and then derive the ElGamal keypair on-the-fly whenever encryption/decryption is needed.

For the spl token-2022 confidential extension application, the ElGamal encryption public key is specified in a token account address. A natural way to derive an ElGamal keypair is then to define it from the hash of a Solana keypair and a Solana address. However, for general hardware wallets, the signing key is not exposed in the API. Therefore, this function uses a signer to sign a pre-specified message with respect to a Solana address. 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 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 PartialEq<ElGamalKeypair> 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 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 StructuralEq for ElGamalKeypair

impl StructuralPartialEq for ElGamalKeypair