Enum Transaction

pub enum Transaction {
    Deploy(Deploy),
    V1(TransactionV1),
}

A versioned wrapper for a transaction or deploy.

Variants

Deploy(Deploy)

A deploy.

V1(TransactionV1)

A version 1 transaction.

Implementations

impl Transaction

pub fn from_deploy(deploy: Deploy) -> Self

pub fn from_v1(v1: TransactionV1) -> Self

pub fn hash(&self) -> TransactionHash

Returns the TransactionHash identifying this transaction.

pub fn size_estimate(&self) -> usize

Size estimate.

pub fn timestamp(&self) -> Timestamp

Timestamp.

pub fn ttl(&self) -> TimeDiff

Time to live.

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

Returns Ok if the given transaction is valid. Verification procedure is delegated to the implementation of the particular variant of the transaction.

pub fn sign(&mut self, secret_key: &SecretKey)

Adds a signature of this transaction’s hash to its approvals.

pub fn approvals(&self) -> BTreeSet<Approval>

Returns the Approvals for this transaction.

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

Returns the computed approvals hash identifying this transaction’s approvals.

pub fn chain_name(&self) -> String

Returns the chain name for the transaction, whether it’s a Deploy or V1 transaction.

pub fn is_standard_payment(&self) -> bool

Checks if the transaction is a standard payment.

For Deploy transactions, it checks if the session is a standard payment in the payment phase. For V1 transactions, it returns the value of standard_payment if the pricing mode is PaymentLimited, otherwise it returns true.

pub fn compute_id(&self) -> TransactionId

Returns the computed TransactionId uniquely identifying this transaction and its approvals.

pub fn initiator_addr(&self) -> InitiatorAddr

Returns the address of the initiator of the transaction.

pub fn expired(&self, current_instant: Timestamp) -> bool

Returns true if the transaction has expired.

pub fn expires(&self) -> Timestamp

Returns the timestamp of when the transaction expires, i.e. self.timestamp + self.ttl.

pub fn signers(&self) -> BTreeSet<AccountHash>

Returns the set of account hashes corresponding to the public keys of the approvals.

pub fn as_transaction_v1(&self) -> Option<&TransactionV1>

Get TransactionV1

pub fn authorization_keys(&self) -> BTreeSet<AccountHash>

Authorization keys.

pub fn is_legacy_transaction(&self) -> bool

Is the transaction the legacy deploy variant.

pub fn gas_limit( &self, chainspec: &Chainspec, lane_id: u8, ) -> Result<Gas, InvalidTransaction>

Available on crate features std and testing only.

Calcualates the gas limit for the transaction.

pub fn gas_cost( &self, chainspec: &Chainspec, lane_id: u8, gas_price: u8, ) -> Result<Motes, InvalidTransaction>

Available on crate features std and testing only.

Returns a gas cost based upon the gas_limit, the gas price, and the chainspec settings.

pub fn random(rng: &mut TestRng) -> Self

Available on crate features std and testing only.

Returns a random, valid but possibly expired transaction.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for Transaction

where Deploy: DataSize, TransactionV1: DataSize,

const IS_DYNAMIC: bool = true

If true, the type has a heap size that can vary at runtime, depending on the actual value.

const STATIC_HEAP_SIZE: usize = 0usize

The amount of space a value of the type always occupies. If IS_DYNAMIC is false, this is the total amount of heap memory occupied by the value. Otherwise this is a lower bound.

fn estimate_heap_size(&self) -> usize

Estimates the size of heap memory taken up by this value.

impl Debug for Transaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Transaction

Available on crate feature std only.

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for Transaction

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

Formats the value using the given formatter.

impl From<Deploy> for Transaction

fn from(deploy: Deploy) -> Self

Converts to this type from the input type.

impl From<TransactionV1> for Transaction

fn from(txn: TransactionV1) -> Self

Converts to this type from the input type.

impl FromBytes for Transaction

fn from_bytes(bytes: &[u8]) -> Result<(Self, &[u8]), Error>

Deserializes the slice into Self.

fn from_vec(bytes: Vec<u8>) -> Result<(Self, Vec<u8>), Error>

Deserializes the Vec<u8> into Self.

impl Hash for Transaction

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsonSchema for Transaction

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl Ord for Transaction

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Transaction

fn eq(&self, other: &Transaction) -> 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 PartialOrd for Transaction

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Transaction

Available on crate feature std only.

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl ToBytes for Transaction

fn to_bytes(&self) -> Result<Vec<u8>, Error>

Serializes &self to a Vec<u8>.

fn serialized_length(&self) -> usize

Returns the length of the Vec<u8> which would be returned from a successful call to to_bytes() or into_bytes(). The data is not actually serialized, so this call is relatively cheap.

fn write_bytes(&self, writer: &mut Vec<u8>) -> Result<(), Error>

Writes &self into a mutable writer.

fn into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

impl Eq for Transaction

impl StructuralPartialEq for Transaction