Enum elements::confidential::Value

pub enum Value {
    Null,
    Explicit(u64),
    Confidential(PedersenCommitment),
}

A CT commitment to an amount

Variants

Null

No value

Explicit(u64)

Value is explicitly encoded

Confidential(PedersenCommitment)

Value is committed

Implementations

impl Value

pub fn new_confidential<C: Signing>( secp: &Secp256k1<C>, value: u64, asset: Generator, bf: ValueBlindingFactor ) -> Self

Create value commitment.

pub fn new_confidential_from_assetid<C: Signing>( secp: &Secp256k1<C>, value: u64, asset: AssetId, v_bf: ValueBlindingFactor, a_bf: AssetBlindingFactor ) -> Self

Create value commitment from assetID, asset blinding factor, value and value blinding factor

pub fn encoded_length(&self) -> usize

Serialized length, in bytes

pub fn from_commitment(bytes: &[u8]) -> Result<Self, Error>

Create from commitment.

pub fn is_null(&self) -> bool

Check if the object is null.

pub fn is_explicit(&self) -> bool

Check if the object is explicit.

pub fn is_confidential(&self) -> bool

Check if the object is confidential.

pub fn explicit(&self) -> Option<u64>

Returns the explicit inner value. Returns None if Value::is_explicit returns false.

pub fn commitment(&self) -> Option<PedersenCommitment>

Returns the confidential commitment in case of a confidential value. Returns None if Value::is_confidential returns false.

impl Value

pub fn blind<C: Signing>( self, secp: &Secp256k1<C>, vbf: ValueBlindingFactor, receiver_blinding_pk: PublicKey, ephemeral_sk: SecretKey, spk: &Script, msg: &RangeProofMessage ) -> Result<(Self, Nonce, RangeProof), ConfidentialTxOutError>

Blinds the values and outputs the blinded value along with RangeProof. This computes the nonce by doing an ECDH with receiver_blinding_pk and ephemeral_sk

Returns:

A pair of blinded value, nonce and corresponding proof as (Value, Nonce, RangeProof) The nonce here refers to public key corresponding to the input ephemeral_sk

pub fn blind_with_shared_secret<C: Signing>( self, secp: &Secp256k1<C>, vbf: ValueBlindingFactor, shared_secret: SecretKey, spk: &Script, msg: &RangeProofMessage ) -> Result<(Self, RangeProof), ConfidentialTxOutError>

Blinds with the given shared_secret(instead of computing it via ECDH) This is useful while blinding assets as there is no counter party to provide the blinding key.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Decodable for Value

fn consensus_decode<D: Read>(d: D) -> Result<Value, Error>

Decode an object with a well-defined format

impl Default for Value

fn default() -> Self

Returns the “default value” for a type.

impl Deserialize for Value

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

Deserialize a value from raw data.

impl Display for Value

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

Formats the value using the given formatter.

impl Encodable for Value

fn consensus_encode<S: Write>(&self, s: S) -> Result<usize, Error>

Encode an object with a well-defined format, should only ever error if the underlying Write errors. Returns the number of bytes written on success

impl From<PedersenCommitment> for Value

fn from(from: PedersenCommitment) -> Self

Converts to this type from the input type.

impl Hash for Value

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Value

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Value

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

fn partial_cmp(&self, other: &Value) -> 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 Serialize for Value

fn serialize(&self) -> Vec<u8>

Serialize a value as raw data.

impl Copy for Value

impl Eq for Value

impl StructuralPartialEq for Value