Struct algonaut_transaction::transaction::Transaction

pub struct Transaction {
    pub fee: MicroAlgos,
    pub first_valid: Round,
    pub genesis_hash: HashDigest,
    pub last_valid: Round,
    pub txn_type: TransactionType,
    pub genesis_id: Option<String>,
    pub group: Option<HashDigest>,
    pub lease: Option<HashDigest>,
    pub note: Option<Vec<u8>>,
    pub rekey_to: Option<Address>,
}

A transaction that can appear in a block

Fields

fee: MicroAlgos

Paid by the sender to the FeeSink to prevent denial-of-service. The minimum fee on Algorand is currently 1000 microAlgos.

first_valid: Round

The first round for when the transaction is valid. If the transaction is sent prior to this round it will be rejected by the network.

genesis_hash: HashDigest

The hash of the genesis block of the network for which the transaction is valid. See the genesis hash for MainNet, TestNet, and BetaNet.

last_valid: Round

The ending round for which the transaction is valid. After this round, the transaction will be rejected by the network.

txn_type: TransactionType

Specifies the type of transaction. This value is automatically generated using any of the developer tools.

genesis_id: Option<String>

The human-readable string that identifies the network for the transaction. The genesis ID is found in the genesis block. See the genesis ID for MainNet, TestNet, and BetaNet.

group: Option<HashDigest>

The group specifies that the transaction is part of a group and, if so, specifies the hash of the transaction group. Assign a group ID to a transaction through the workflow described in the Atomic Transfers Guide.

lease: Option<HashDigest>

A lease enforces mutual exclusion of transactions. If this field is nonzero, then once the transaction is confirmed, it acquires the lease identified by the (Sender, Lease) pair of the transaction until the LastValid round passes. While this transaction possesses the lease, no other transaction specifying this lease can be confirmed. A lease is often used in the context of Algorand Smart Contracts to prevent replay attacks. Read more about Algorand Smart Contracts and see the Delegate Key Registration TEAL template for an example implementation of leases. Leases can also be used to safeguard against unintended duplicate spends. For example, if I send a transaction to the network and later realize my fee was too low, I could send another transaction with a higher fee, but the same lease value. This would ensure that only one of those transactions ends up getting confirmed during the validity period.

note: Option<Vec<u8>>

Any data up to 1000 bytes.

rekey_to: Option<Address>

Specifies the authorized address. This address will be used to authorize all future transactions. Learn more about Rekeying accounts.

Implementations

impl Transaction

pub fn fee_per_byte(
    self,
    fee_per_byte: MicroAlgos
) -> Result<Transaction, TransactionError>

Creates a new transaction with a fee calculated based on fee_per_byte.

pub fn bytes_to_sign(&self) -> Result<Vec<u8>, TransactionError>

pub fn raw_id(&self) -> Result<HashDigest, TransactionError>

pub fn id(&self) -> Result<String, TransactionError>

pub fn assign_group_id(&mut self, group_id: HashDigest)

pub fn sender(&self) -> Address

The address of the account that signs and pays the fee. It can have additional responsibilities dependending on the transaction type. We keep it in the transaction types to be able to document (and possibly name) it separately.

Trait Implementations

impl Clone for Transaction

fn clone(&self) -> Transaction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Transaction

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

Formats the value using the given formatter.

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

Convenience to deserialize Transaction directly from msg pack

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<Transaction> for Transaction

fn eq(&self, other: &Transaction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Transaction) -> bool

This method tests for !=.

impl Serialize for Transaction

Convenience to serialize Transaction directly to msg pack

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

Serialize this value into the given Serde serializer.

impl ToMsgPack for Transaction

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

impl Eq for Transaction

impl StructuralEq for Transaction

impl StructuralPartialEq for Transaction