Struct TransactionV1

pub struct TransactionV1 { /* private fields */ }

A unit of work sent by a client to the network, which when executed can cause global state to be altered.

Implementations

impl TransactionV1

pub fn new( hash: TransactionV1Hash, payload: TransactionV1Payload, approvals: BTreeSet<Approval>, ) -> Self

ctor

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

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

pub fn hash(&self) -> &TransactionV1Hash

Returns the ApprovalsHash of this transaction’s approvals.

pub fn payload(&self) -> &TransactionV1Payload

Returns the internal payload of this transaction.

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

Returns transactions approvals.

pub fn initiator_addr(&self) -> &InitiatorAddr

Returns the address of the initiator of the transaction.

pub fn chain_name(&self) -> &str

Returns the name of the chain the transaction should be executed on.

pub fn timestamp(&self) -> Timestamp

Returns the creation timestamp of the transaction.

pub fn ttl(&self) -> TimeDiff

Returns the duration after the creation timestamp for which the transaction will stay valid.

After this duration has ended, the transaction will be considered expired.

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

Returns true if the transaction has expired.

pub fn pricing_mode(&self) -> &PricingMode

Returns the pricing mode for the transaction.

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

Returns the ApprovalsHash of this transaction’s approvals.

pub fn apply_approvals(&mut self, approvals: Vec<Approval>)

Available on crate features std and testing only.

pub fn payment_amount(&self) -> Option<u64>

Available on crate features std and testing only.

Returns the payment amount if the txn is using payment limited mode.

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

Available on crate features std and testing only.

Returns a random, valid but possibly expired transaction.

pub fn random_with_lane_and_timestamp_and_ttl( rng: &mut TestRng, lane: u8, maybe_timestamp: Option<Timestamp>, ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

pub fn random_with_timestamp_and_ttl( rng: &mut TestRng, maybe_timestamp: Option<Timestamp>, ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

pub fn random_transfer( rng: &mut TestRng, timestamp: Option<Timestamp>, ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

Returns a random transaction with “transfer” category.

pub fn random_wasm( rng: &mut TestRng, timestamp: Option<Timestamp>, ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

Returns a random transaction with “standard” category.

pub fn random_auction( rng: &mut TestRng, timestamp: Option<Timestamp>, ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

Returns a random transaction with “install/upgrade” category.

pub fn random_install_upgrade( rng: &mut TestRng, timestamp: Option<Timestamp>, ttl: Option<TimeDiff>, ) -> Self

Available on crate features std and testing only.

Returns a random transaction with “install/upgrade” category.

pub fn deserialize_field<T: FromBytes>( &self, index: u16, ) -> Result<T, FieldDeserializationError>

Returns result of attempting to deserailize a field from the amorphic fields container.

pub fn number_of_fields(&self) -> usize

Returns number of fields in the amorphic fields container.

pub fn has_valid_hash(&self) -> Result<(), InvalidTransactionV1>

Checks if the declared hash of the transaction matches calculated hash.

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

Returns Ok if and only if:

• the transaction hash is correct (see TransactionV1::has_valid_hash for details)
• approvals are non-empty, and
• all approvals are valid signatures of the signed hash

pub fn payload_hash(&self) -> Result<Digest, InvalidTransactionV1>

Returns the hash of the transaction’s payload.

pub fn invalidate(&mut self)

Available on crate features std and testing only.

Turns self into an invalid TransactionV1 by clearing the chain_name, invalidating the transaction hash

pub fn gas_price_tolerance(&self) -> u8

Returns the gas price tolerance for the given transaction.

Trait Implementations

impl Clone for TransactionV1

fn clone(&self) -> TransactionV1

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl DataSize for TransactionV1

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 TransactionV1

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TransactionV1

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for TransactionV1

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

Formats the value using the given formatter.

impl From<TransactionV1> for Transaction

fn from(txn: TransactionV1) -> Self

Converts to this type from the input type.

impl FromBytes for TransactionV1

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 TransactionV1

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 TransactionV1

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 TransactionV1

fn cmp(&self, other: &TransactionV1) -> 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 TransactionV1

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

fn partial_cmp(&self, other: &TransactionV1) -> 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 TransactionV1

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToBytes for TransactionV1

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 into_bytes(self) -> Result<Vec<u8>, Error>

where Self: Sized,

Consumes self and serializes to a Vec<u8>.

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

Writes &self into a mutable writer.

impl Eq for TransactionV1