Struct grin_core::core::transaction::TransactionBody

source ·

pub struct TransactionBody {
    pub inputs: Inputs,
    pub outputs: Vec<Output>,
    pub kernels: Vec<TxKernel>,
}

Expand description

TransactionBody is a common abstraction for transaction and block

Fields§

§inputs: Inputs

List of inputs spent by the transaction.

§outputs: Vec<Output>

List of outputs the transaction produces.

§kernels: Vec<TxKernel>

List of kernels that make up this transaction (usually a single kernel).

Implementations§

source §

impl TransactionBody

source

pub fn empty() -> TransactionBody

Creates a new empty transaction (no inputs or outputs, zero fee).

source

pub fn sort(&mut self)

Sort the inputs|outputs|kernels.

source

pub fn init( inputs: Inputs, outputs: &[Output], kernels: &[TxKernel], verify_sorted: bool ) -> Result<TransactionBody, Error>

Creates a new transaction body initialized with the provided inputs, outputs and kernels. Guarantees inputs, outputs, kernels are sorted lexicographically.

source

pub fn inputs(&self) -> Inputs

Transaction inputs.

source

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

Transaction outputs.

source

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

Transaction kernels.

source

pub fn with_input(self, input: Input) -> TransactionBody

Builds a new body with the provided inputs added. Existing inputs, if any, are kept intact. Sort order is maintained.

source

pub fn replace_inputs(self, inputs: Inputs) -> TransactionBody

Fully replace inputs.

source

pub fn with_output(self, output: Output) -> TransactionBody

Builds a new TransactionBody with the provided output added. Existing outputs, if any, are kept intact. Sort order is maintained.

source

pub fn replace_outputs(self, outputs: &[Output]) -> TransactionBody

Fully replace outputs.

source

pub fn with_kernel(self, kernel: TxKernel) -> TransactionBody

Builds a new TransactionBody with the provided kernel added. Existing kernels, if any, are kept intact. Sort order is maintained.

source

pub fn replace_kernel(self, kernel: TxKernel) -> TransactionBody

Builds a new TransactionBody replacing any existing kernels with the provided kernel.

source

pub fn fee(&self) -> u64

Total fee for a TransactionBody is the sum of fees of all fee carrying kernels.

source

pub fn fee_shift(&self) -> u8

fee_shift for a TransactionBody is the maximum of fee_shifts of all fee carrying kernels.

source

pub fn shifted_fee(&self) -> u64

Shifted fee for a TransactionBody is the sum of fees shifted right by the maximum fee_shift this is used to determine whether a tx can be relayed or accepted in a mempool where transactions can specify a higher block-inclusion priority as a positive shift up to 15 but are required to overpay the minimum required fees by a factor of 2^priority

source

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

aggregate fee_fields from all appropriate kernels in TransactionBody into one, if possible

source

pub fn weight(&self) -> u64

Calculate weight of transaction using block weighing

source

pub fn weight_by_iok(num_inputs: u64, num_outputs: u64, num_kernels: u64) -> u64

Calculate transaction weight using block weighing from transaction details. Consensus critical and uses consensus weight values.

source

pub fn lock_height(&self) -> u64

Lock height of a body is the max lock height of the kernels.

source

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

Verify we have no invalid outputs or kernels in the transaction due to invalid features. Specifically, a transaction cannot contain a coinbase output or a coinbase kernel.

source

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

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