Struct dusk_poseidon::cipher::PoseidonCipher

pub struct PoseidonCipher { /* private fields */ }

Encapsulates an encrypted data

Implementations

impl PoseidonCipher

pub fn initial_state_circuit<C>( composer: &mut C, ks0: Witness, ks1: Witness, nonce: Witness ) -> [Witness; 5]where C: Composer,

Returns the initial state of the encryption within a composer circuit

impl PoseidonCipher

pub const fn new(cipher: [BlsScalar; 3]) -> Self

PoseidonCipher constructor

pub const fn capacity() -> usize

Maximum number of scalars allowed per message

pub const fn cipher_size() -> usize

Number of scalars used in a cipher

pub const fn cipher_size_bytes() -> usize

Number of bytes used by from/to bytes PoseidonCipher function

pub fn initial_state(secret: &JubJubAffine, nonce: BlsScalar) -> [BlsScalar; 5]

Returns the initial state of the encryption

pub const fn cipher(&self) -> &[BlsScalar; 3]

Getter for the cipher

pub fn encrypt( message: &[BlsScalar], secret: &JubJubAffine, nonce: &BlsScalar ) -> Self

Encrypt a slice of scalars into an internal cipher representation

The message size will be truncated to PoseidonCipher::capacity() bits

pub fn decrypt( &self, secret: &JubJubAffine, nonce: &BlsScalar ) -> Option<[BlsScalar; 2]>

Perform the decrypt of a previously encrypted message.

Will return None if the decryption fails.

Trait Implementations

impl Clone for PoseidonCipher

fn clone(&self) -> PoseidonCipher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PoseidonCipher

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

Formats the value using the given formatter.

impl Default for PoseidonCipher

fn default() -> PoseidonCipher

Returns the “default value” for a type.

impl Ord for PoseidonCipher

fn cmp(&self, other: &PoseidonCipher) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PoseidonCipher> for PoseidonCipher

fn eq(&self, other: &PoseidonCipher) -> 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 PartialOrd<PoseidonCipher> for PoseidonCipher

fn partial_cmp(&self, other: &PoseidonCipher) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serializable<CIPHER_BYTES_SIZE> for PoseidonCipher

fn from_bytes(bytes: &[u8; 96]) -> Result<Self, Self::Error>

Create an instance from a previous PoseidonCipher::to_bytes function

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

Convert the instance to a bytes representation

type Error = Error

The type returned in the event of a conversion error.

const SIZE: usize = N

The size of

impl Copy for PoseidonCipher

impl Eq for PoseidonCipher

impl StructuralEq for PoseidonCipher

impl StructuralPartialEq for PoseidonCipher