Struct grin_core::core::block::Block

pub struct Block {
    pub header: BlockHeader,
    pub body: TransactionBody,
}

A block as expressed in the Mimblewimble protocol. The reward is non-explicit, assumed to be deducible from block height (similar to bitcoin’s schedule) and expressed as a global transaction fee (added v.H), additive to the total of fees ever collected.

Fields

header: BlockHeader

The header with metadata and commitments to the rest of the data

body: TransactionBody

The body - inputs/outputs/kernels

Implementations

impl Block

pub fn new(
    prev: &BlockHeader,
    txs: &[Transaction],
    difficulty: Difficulty,
    reward_output: (Output, TxKernel)
) -> Result<Block, Error>

Builds a new block from the header of the previous block, a vector of transactions and the private key that will receive the reward. Checks that all transactions are valid and calculates the Merkle tree.

TODO - Move this somewhere where only tests will use it. *** Only used in tests. ***

pub fn hydrate_from(
    cb: CompactBlock,
    txs: &[Transaction]
) -> Result<Block, Error>

Hydrate a block from a compact block. Note: caller must validate the block themselves, we do not validate it here.

pub fn with_header(header: BlockHeader) -> Block

Build a new empty block from a specified header

pub fn from_reward(
    prev: &BlockHeader,
    txs: &[Transaction],
    reward_out: Output,
    reward_kern: TxKernel,
    difficulty: Difficulty
) -> Result<Block, Error>

Builds a new block ready to mine from the header of the previous block, a vector of transactions and the reward information. Checks that all transactions are valid and calculates the Merkle tree.

pub fn with_reward(self, reward_out: Output, reward_kern: TxKernel) -> Block

Consumes this block and returns a new block with the coinbase output and kernels added

pub fn inputs(&self) -> Inputs

Get inputs

pub fn outputs(&self) -> &[Output]

Get outputs

pub fn kernels(&self) -> &[TxKernel]

Get kernels

pub fn total_fees(&self) -> u64

Sum of all fees (inputs less outputs) in the block

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

“Lightweight” validation that we can perform quickly during read/deserialization. Subset of full validation that skips expensive verification steps, specifically -

• rangeproof verification (on the body)
• kernel signature verification (on the body)
• coinbase sum verification
• kernel sum verification

pub fn validate(&self, prev_kernel_offset: &BlindingFactor) -> Result<(), Error>

Validates all the elements in a block that can be checked without additional data. Includes commitment sums and kernels, Merkle trees, reward, etc.

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

Validate the coinbase.body.outputs generated by miners. Check the sum of coinbase-marked outputs match the sum of coinbase-marked kernels accounting for fees.

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Committed for Block

Provides all information from a block that allows the calculation of total Pedersen commitment.

fn inputs_committed(&self) -> Vec<Commitment>

Vector of input commitments to verify.

fn outputs_committed(&self) -> Vec<Commitment>

Vector of output commitments to verify.

fn kernels_committed(&self) -> Vec<Commitment>

Vector of kernel excesses to verify.

fn sum_kernel_excesses(
    &self,
    offset: &BlindingFactor
) -> Result<(Commitment, Commitment), Error>

Gather the kernel excesses and sum them.

fn sum_commitments(&self, overage: i64) -> Result<Commitment, Error>

Gathers commitments and sum them.

fn verify_kernel_sums(
    &self,
    overage: i64,
    kernel_offset: BlindingFactor
) -> Result<(Commitment, Commitment), Error>

Verify the sum of the kernel excesses equals the sum of the outputs, taking into account both the kernel_offset and overage.

impl Debug for Block

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

Formats the value using the given formatter.

impl Default for Block

Default properties for a block, everything zeroed out and empty vectors.

fn default() -> Block

Returns the “default value” for a type.

impl From<Block> for CompactBlock

fn from(block: Block) -> Self

Performs the conversion.

impl From<UntrustedBlock> for Block

fn from(block: UntrustedBlock) -> Self

Performs the conversion.

impl Hashed for Block

fn hash(&self) -> Hash

The hash of the underlying block.

impl Readable for Block

Implementation of Readable for a block, defines how to read a full block from a binary stream.

fn read<R: Reader>(reader: &mut R) -> Result<Block, Error>

Reads the data necessary to this Readable from the provided reader

impl Serialize for Block

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

Serialize this value into the given Serde serializer.

impl Writeable for Block

Implementation of Writeable for a block, defines how to write the block to a binary writer. Differentiates between writing the block for the purpose of full serialization and the one of just extracting a hash.

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

Write the data held by this Writeable to the provided writer