Struct sp_runtime::transaction_validity::ValidTransactionBuilder

pub struct ValidTransactionBuilder { /* fields omitted */ }

ValidTransaction builder.

Allows to easily construct ValidTransaction and most importantly takes care of prefixing requires and provides tags to avoid conflicts.

Implementations

impl ValidTransactionBuilder

pub fn priority(mut self: Self, priority: TransactionPriority) -> Self

Set the priority of a transaction.

Note that the final priority for FRAME is combined from all SignedExtensions. Most likely for unsigned transactions you want the priority to be higher than for regular transactions. We recommend exposing a base priority for unsigned transactions as a runtime module parameter, so that the runtime can tune inter-module priorities.

pub fn longevity(mut self: Self, longevity: TransactionLongevity) -> Self

Set the longevity of a transaction.

By default the transaction will be considered valid forever and will not be revalidated by the transaction pool. It's recommended though to set the longevity to a finite value though. If unsure, it's also reasonable to expose this parameter via module configuration and let the runtime decide.

pub fn propagate(mut self: Self, propagate: bool) -> Self

Set the propagate flag.

Set to false if the transaction is not meant to be gossiped to peers. Combined with TransactionSource::Local validation it can be used to have special kind of transactions that are only produced and included by the validator nodes.

pub fn and_requires(mut self: Self, tag: impl Encode) -> Self

Add a TransactionTag to the set of required tags.

The tag will be encoded and prefixed with module prefix (if any). If you'd rather add a raw require tag, consider using #combine_with method.

pub fn and_provides(mut self: Self, tag: impl Encode) -> Self

Add a TransactionTag to the set of provided tags.

The tag will be encoded and prefixed with module prefix (if any). If you'd rather add a raw require tag, consider using #combine_with method.

pub fn combine_with(mut self: Self, validity: ValidTransaction) -> Self

Augment the builder with existing ValidTransaction.

This method does add the prefix to require or provides tags.

pub fn build(self) -> TransactionValidity

Finalize the builder and produce TransactionValidity.

Note the result will always be Ok. Use Into to produce ValidTransaction.

Trait Implementations

impl Clone for ValidTransactionBuilder

pub fn clone(&self) -> ValidTransactionBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ValidTransactionBuilder

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

Formats the value using the given formatter.

impl Default for ValidTransactionBuilder

pub fn default() -> ValidTransactionBuilder

Returns the "default value" for a type.

impl From<ValidTransactionBuilder> for TransactionValidity

pub fn from(builder: ValidTransactionBuilder) -> Self

Performs the conversion.

impl From<ValidTransactionBuilder> for ValidTransaction

pub fn from(builder: ValidTransactionBuilder) -> Self

Performs the conversion.