Struct grin_core::core::transaction::TxKernel

pub struct TxKernel {
    pub features: KernelFeatures,
    pub fee: u64,
    pub lock_height: u64,
    pub excess: Commitment,
    pub excess_sig: Signature,
}

A proof that a transaction sums to zero. Includes both the transaction's Pedersen commitment and the signature, that guarantees that the commitments amount to zero. The signature signs the fee and the lock_height, which are retained for signature validation.

Fields

features: KernelFeatures

Options for a kernel's structure or use

fee: u64

Fee originally included in the transaction this proof is for.

lock_height: u64

This kernel is not valid earlier than lock_height blocks The max lock_height of all inputs to this transaction

excess: Commitment

Remainder of the sum of all transaction commitments. If the transaction is well formed, amounts components should sum to zero and the excess is hence a valid public key.

excess_sig: Signature

The signature proving the excess is a valid public key, which signs the transaction fee.

Methods

impl TxKernel

pub fn is_coinbase(&self) -> bool

Is this a coinbase kernel?

pub fn is_plain(&self) -> bool

Is this a plain kernel?

pub fn is_height_locked(&self) -> bool

Is this a height locked kernel?

pub fn excess(&self) -> Commitment

Return the excess commitment for this tx_kernel.

pub fn msg_to_sign(&self) -> Result<Message, Error>

The msg signed as part of the tx kernel. Consists of the fee and the lock_height.

pub fn verify(&self) -> Result<(), Error>

Verify the transaction proof validity. Entails handling the commitment as a public key and checking the signature verifies with the fee as message.

pub fn empty() -> TxKernel

Build an empty tx kernel with zero values.

pub fn with_fee(self, fee: u64) -> TxKernel

Builds a new tx kernel with the provided fee.

pub fn with_lock_height(self, lock_height: u64) -> TxKernel

Builds a new tx kernel with the provided lock_height.

Trait Implementations

impl DefaultHashable for TxKernel

impl Writeable for TxKernel

fn write<W: Writer>(&self, writer: &mut W) -> Result<(), Error>

Write the data held by this Writeable to the provided writer

impl Readable for TxKernel

fn read(reader: &mut dyn Reader) -> Result<TxKernel, Error>

Reads the data necessary to this Readable from the provided reader

impl PMMRable for TxKernel

We store TxKernelEntry in the kernel MMR.

type E = TxKernelEntry

The type of element actually stored in the MMR data file. This allows us to store Hash elements in the header MMR for variable size BlockHeaders.

fn as_elmt(&self) -> TxKernelEntry

Convert the pmmrable into the element to be stored in the MMR data file.

impl PartialOrd<TxKernel> for TxKernel

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] 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 PartialEq<TxKernel> for TxKernel

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for TxKernel

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Eq for TxKernel

impl From<TxKernel> for TxKernelEntry

fn from(kernel: TxKernel) -> Self

Performs the conversion.

impl Clone for TxKernel

fn clone(&self) -> TxKernel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Hash for TxKernel

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for TxKernel

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

Formats the value using the given formatter.

impl Serialize for TxKernel

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for TxKernel

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.