Struct Coinbase 

pub struct Coinbase {
    receiver: CompressedPubKey,
    amount: Amount,
    fee_transfer: Option<CoinbaseFeeTransfer>,
}

A coinbase transaction for block rewards.

The coinbase transaction is included in each block to:

1. Credit the block producer with the coinbase reward
2. Optionally transfer a fee to a SNARK worker who contributed proofs

The amount represents the total coinbase reward for the block. If a fee_transfer is present, the fee is deducted from the amount before crediting the receiver.

Fields

receiver: CompressedPubKey

amount: Amount

fee_transfer: Option<CoinbaseFeeTransfer>

Implementations

impl Coinbase

pub const fn new(receiver: CompressedPubKey, amount: Amount) -> Self

Creates a new coinbase transaction without a fee transfer.

Arguments

• receiver - The compressed public key of the block producer
• amount - The coinbase reward amount

pub const fn with_fee_transfer( receiver: CompressedPubKey, amount: Amount, fee_transfer: CoinbaseFeeTransfer, ) -> Self

Creates a new coinbase transaction with a fee transfer.

Arguments

• receiver - The compressed public key of the block producer
• amount - The coinbase reward amount
• fee_transfer - The fee transfer to a SNARK worker

pub const fn receiver(&self) -> &CompressedPubKey

Returns the coinbase receiver (block producer).

pub const fn amount(&self) -> Amount

Returns the total coinbase amount.

pub const fn fee_transfer(&self) -> Option<&CoinbaseFeeTransfer>

Returns the optional fee transfer.

pub const fn has_fee_transfer(&self) -> bool

Returns true if this coinbase has a fee transfer.

pub fn net_amount(&self) -> Option<Amount>

Returns the net amount credited to the block producer.

This is the coinbase amount minus any fee transfer. Returns None if the fee exceeds the amount (which should not happen in valid transactions).

Trait Implementations

impl Clone for Coinbase

fn clone(&self) -> Coinbase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Coinbase

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

Formats the value using the given formatter.

impl PartialEq for Coinbase

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Coinbase

impl StructuralPartialEq for Coinbase