Struct dusk_blindbid::Bid

pub struct Bid { /* fields omitted */ }

The Bid structure contains all of the logic and information needed to be able to participate in the Dusk consensus lottery through the bidding process. It allows the user to generate a random Bid with which will be able to generate a Score and participate in leader election process for this consensus round iteration. In particular, a Bid provides these core functionalities among others.

• Generation of a Prover ID.
• Generation of a Score.

It is always initialized randomly, and any trick to cheat on it’s initialization/construction will resume in a failure in the BindBidProof verification.

The Bid is also designed to be stored within a PoseidonTree. Although it’s not responsability of this crate to provide such implementation. To make that happen, make sure to implement PoseidonLeaf trait for it or a wrapper structure.

Implementations

impl Bid

pub fn as_hash_inputs(&self) -> [BlsScalar; 13]

Return the Bid as a set of “hasheable” parameters which is directly digestible by the Poseidon sponge hash fn.

pub fn hash(&self) -> BlsScalar

Calculate the one-way BlsScalar representation of the Bid

impl Bid

pub fn new(
    message: Message,
    hashed_secret: BlsScalar,
    addr: StealthAddress,
    eligibility: u64,
    expiration: u64
) -> Bid

Generate a new Bid from a Message, the hashed secret(m) and a StealthAddress.

pub const fn message(&self) -> &Message

Returns the message field of the Bid.

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

Returns the raw cipher data from the PoseidonCipher located inside of the Message field of the Bid.

pub const fn nonce(&self) -> &BlsScalar

Returns the nonce field of the Bid.

pub const fn hashed_secret(&self) -> &BlsScalar

Returns the hashed_secret field of the Bid.

pub const fn commitment(&self) -> &JubJubExtended

Returns the commitment field of the Bid.

pub const fn eligibility(&self) -> &u64

Returns the eligibility field of the Bid.

pub fn set_eligibility(&mut self, new_eligibility: u64)

Sets a new value for the eligibility of the Bid.

pub const fn expiration(&self) -> &u64

Returns the expiration field of the Bid.

pub fn extend_expiration(&mut self, extension: u64)

Returns a mutable ref pointing to the pos field of the Bid.

pub const fn pos(&self) -> &u64

Returns the pos field of the Bid.

pub fn set_pos(&mut self, new_pos: u64)

Sets a new value for the position of the Bid.

pub fn generate_prover_id(
    &self,
    secret_k: BlsScalar,
    consensus_round_seed: BlsScalar,
    latest_consensus_round: BlsScalar,
    latest_consensus_step: BlsScalar
) -> BlsScalar

Performs the sponge_hash techniqe using poseidon to compute the one-time prover_id that corresponds to a Bid in an specific point of the consensus which is determinated by:

• consensus_round_seed (sigma^s)
• latest_consensus_round (k^t)
• latest_consensus_step (k^s) One-time prover-id is stated to be H(bid.secret_k, sigma^s, k^t, k^s).

pub fn decrypt_data(
    &self,
    secret: &JubJubScalar,
    psk: &PublicSpendKey
) -> Result<(JubJubScalar, JubJubScalar), BlindBidError>

Provided the secret, decripts the data stored inside the cipher returning a tuple that contains the value at stake in the bid and the blinder data which are the two values used to generate the bid commitment.

Trait Implementations

impl Borrow<u64> for Bid

fn borrow(&self) -> &u64

Immutably borrows from an owned value.

impl Canon for Bid

fn encode(&self, sink: &mut Sink<'_>)

Write the value as bytes to a Sink

fn decode(source: &mut Source<'_>) -> Result<Self, CanonError>

Read the value from bytes in a Source

fn encoded_len(&self) -> usize

Returns the number of bytes needed to encode this value

impl Clone for Bid

fn clone(&self) -> Bid

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bid

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

Formats the value using the given formatter.

impl Into<Scalar> for &Bid

fn into(self) -> BlsScalar

Performs the conversion.

impl Into<Scalar> for Bid

fn into(self) -> BlsScalar

Performs the conversion.

impl Ownable for Bid

fn stealth_address(&self) -> &StealthAddress

Returns the associated StealthAddress

impl PartialEq<Bid> for Bid

fn eq(&self, other: &Self) -> 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 !=.

impl Serializable<{ Message::SIZE + StealthAddress::SIZE + BlsScalar::SIZE + 8 * 3 }> for Bid

type Error = Error

The type returned in the event of a conversion error.

fn from_bytes(buf: &[u8; 280]) -> Result<Bid, Self::Error>

Deserialize a [&[u8; N]] into Self, it might be fail.

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

Serialize Self into a [[u8; N]].

const SIZE: usize

The size of

impl Copy for Bid

impl Eq for Bid