Enum Transaction

pub enum Transaction {
    Script(ChargeableTransaction<ScriptBody, ScriptMetadata>),
    Create(ChargeableTransaction<CreateBody, CreateMetadata>),
    Mint(Mint),
    Upgrade(ChargeableTransaction<UpgradeBody, UpgradeMetadata>),
    Upload(ChargeableTransaction<UploadBody, UploadMetadata>),
    Blob(ChargeableTransaction<BlobBody, BlobMetadata>),
}

The fuel transaction entity https://github.com/FuelLabs/fuel-specs/blob/master/src/tx-format/transaction.md.

Variants

Script(ChargeableTransaction<ScriptBody, ScriptMetadata>)

Create(ChargeableTransaction<CreateBody, CreateMetadata>)

Mint(Mint)

Upgrade(ChargeableTransaction<UpgradeBody, UpgradeMetadata>)

Upload(ChargeableTransaction<UploadBody, UploadMetadata>)

Blob(ChargeableTransaction<BlobBody, BlobMetadata>)

Implementations

impl Transaction

pub fn default_test_tx() -> Transaction

Return default valid transaction useful for tests.

pub const fn script( gas_limit: u64, script: Vec<u8>, script_data: Vec<u8>, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<ScriptBody, ScriptMetadata>

pub fn create( bytecode_witness_index: u16, policies: Policies, salt: Salt, storage_slots: Vec<StorageSlot>, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<CreateBody, CreateMetadata>

pub fn mint( tx_pointer: TxPointer, input_contract: Contract, output_contract: Contract, mint_amount: u64, mint_asset_id: AssetId, gas_price: u64, ) -> Mint

pub fn upgrade( upgrade_purpose: UpgradePurpose, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<UpgradeBody, UpgradeMetadata>

pub fn upgrade_consensus_parameters( consensus_parameters: &ConsensusParameters, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> Result<ChargeableTransaction<UpgradeBody, UpgradeMetadata>, ValidityError>

Creates an Upgrade transaction with the purpose of upgrading the consensus parameters.

pub fn upload( upload_body: UploadBody, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<UploadBody, UploadMetadata>

pub fn upload_from_subsection( subsection: UploadSubsection, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<UploadBody, UploadMetadata>

pub fn blob( body: BlobBody, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<BlobBody, BlobMetadata>

pub fn blob_from_bytes( bytes: Vec<u8>, policies: Policies, inputs: Vec<Input>, outputs: Vec<Output>, witnesses: Vec<Witness>, ) -> ChargeableTransaction<BlobBody, BlobMetadata>

pub const fn is_script(&self) -> bool

pub const fn is_create(&self) -> bool

pub const fn is_mint(&self) -> bool

pub const fn is_upgrade(&self) -> bool

pub const fn is_upload(&self) -> bool

pub const fn is_blob(&self) -> bool

pub const fn as_script( &self, ) -> Option<&ChargeableTransaction<ScriptBody, ScriptMetadata>>

pub fn as_script_mut( &mut self, ) -> Option<&mut ChargeableTransaction<ScriptBody, ScriptMetadata>>

pub const fn as_create( &self, ) -> Option<&ChargeableTransaction<CreateBody, CreateMetadata>>

pub fn as_create_mut( &mut self, ) -> Option<&mut ChargeableTransaction<CreateBody, CreateMetadata>>

pub const fn as_mint(&self) -> Option<&Mint>

pub fn as_mint_mut(&mut self) -> Option<&mut Mint>

pub const fn as_upgrade( &self, ) -> Option<&ChargeableTransaction<UpgradeBody, UpgradeMetadata>>

pub fn as_upgrade_mut( &mut self, ) -> Option<&mut ChargeableTransaction<UpgradeBody, UpgradeMetadata>>

pub const fn as_upload( &self, ) -> Option<&ChargeableTransaction<UploadBody, UploadMetadata>>

pub fn as_upload_mut( &mut self, ) -> Option<&mut ChargeableTransaction<UploadBody, UploadMetadata>>

pub const fn as_blob( &self, ) -> Option<&ChargeableTransaction<BlobBody, BlobMetadata>>

pub fn as_blob_mut( &mut self, ) -> Option<&mut ChargeableTransaction<BlobBody, BlobMetadata>>

Trait Implementations

impl Cacheable for Transaction

fn is_computed(&self) -> bool

The cache is already computed.

fn precompute(&mut self, chain_id: &ChainId) -> Result<(), ValidityError>

Computes the cache for the entity.

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<(), Error>

Formats the value using the given formatter.

impl Default for Transaction

fn default() -> Transaction

Returns the “default value” for a type.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<Transaction, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Deserialize for Transaction

fn decode_static<I>(buffer: &mut I) -> Result<Transaction, Error>

where I: Input + ?Sized,

Decodes static part of Self from the buffer.

fn decode_dynamic<I>(&mut self, buffer: &mut I) -> Result<(), Error>

where I: Input + ?Sized,

Decodes dynamic part of the information from the buffer to fill Self. The default implementation does nothing. Dynamically-sized contains should override this.

fn decode<I>(buffer: &mut I) -> Result<Self, Error>

where I: Input + ?Sized,

Decodes Self from the buffer.

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

Helper method for deserializing Self from bytes.

impl EnumCount for Transaction

const COUNT: usize = 6usize

impl EstimatePredicates for Transaction

fn estimate_predicates( &mut self, params: &CheckPredicateParams, memory: impl Memory, storage: &impl PredicateStorageRequirements, ) -> Result<(), CheckError>

Estimates predicates of the transaction.

fn estimate_predicates_async<'life0, 'life1, 'life2, 'life3, 'async_trait, E>( &'life0 mut self, params: &'life1 CheckPredicateParams, pool: &'life2 (impl VmMemoryPool + 'async_trait), storage: &'life3 (impl PredicateStorageProvider + 'async_trait), ) -> Pin<Box<dyn Future<Output = Result<(), CheckError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, E: 'async_trait + ParallelExecutor, Transaction: 'async_trait,

Estimates predicates of the transaction in parallel.

impl FormatValidityChecks for Transaction

fn check_signatures(&self, chain_id: &ChainId) -> Result<(), ValidityError>

Validates that all required signatures are set in the transaction and that they are valid.

fn check_without_signatures( &self, block_height: BlockHeight, consensus_params: &ConsensusParameters, ) -> Result<(), ValidityError>

Validates the transactions according to rules from the specification: https://github.com/FuelLabs/fuel-specs/blob/master/src/tx-format/transaction.md

fn check( &self, block_height: BlockHeight, consensus_params: &ConsensusParameters, ) -> Result<(), ValidityError>

Performs all stateless transaction validity checks. This includes the validity of fields according to rules in the specification and validity of signatures.

impl From<&PoolTransaction> for Transaction

fn from(tx: &PoolTransaction) -> Transaction

Converts to this type from the input type.

impl From<BlobTransaction> for Transaction

fn from(tx: BlobTransaction) -> Transaction

Converts to this type from the input type.

impl From<ChargeableTransaction<BlobBody, BlobMetadata>> for Transaction

fn from(tx: ChargeableTransaction<BlobBody, BlobMetadata>) -> Transaction

Converts to this type from the input type.

impl From<ChargeableTransaction<CreateBody, CreateMetadata>> for Transaction

fn from(tx: ChargeableTransaction<CreateBody, CreateMetadata>) -> Transaction

Converts to this type from the input type.

impl From<ChargeableTransaction<ScriptBody, ScriptMetadata>> for Transaction

fn from(tx: ChargeableTransaction<ScriptBody, ScriptMetadata>) -> Transaction

Converts to this type from the input type.

impl From<ChargeableTransaction<UpgradeBody, UpgradeMetadata>> for Transaction

fn from(tx: ChargeableTransaction<UpgradeBody, UpgradeMetadata>) -> Transaction

Converts to this type from the input type.

impl From<ChargeableTransaction<UploadBody, UploadMetadata>> for Transaction

fn from(tx: ChargeableTransaction<UploadBody, UploadMetadata>) -> Transaction

Converts to this type from the input type.

impl From<CreateTransaction> for Transaction

fn from(tx: CreateTransaction) -> Transaction

Converts to this type from the input type.

impl From<Mint> for Transaction

fn from(tx: Mint) -> Transaction

Converts to this type from the input type.

impl From<MintTransaction> for Transaction

fn from(mint: MintTransaction) -> Transaction

Converts to this type from the input type.

impl From<ScriptTransaction> for Transaction

fn from(tx: ScriptTransaction) -> Transaction

Converts to this type from the input type.

impl From<TransactionType> for Transaction

fn from(value: TransactionType) -> Transaction

Converts to this type from the input type.

impl From<UpgradeTransaction> for Transaction

fn from(tx: UpgradeTransaction) -> Transaction

Converts to this type from the input type.

impl From<UploadTransaction> for Transaction

fn from(tx: UploadTransaction) -> Transaction

Converts to this type from the input type.

impl Hash for Transaction

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 IntoChecked for Transaction

type Metadata = CheckedMetadata

Metadata produced during the check.

fn into_checked_basic( self, block_height: BlockHeight, consensus_params: &ConsensusParameters, ) -> Result<Checked<Transaction>, CheckError>

Returns transaction that passed only Checks::Basic.

fn into_checked( self, block_height: BlockHeight, consensus_params: &ConsensusParameters, ) -> Result<Checked<Self>, CheckError>

where Checked<Self>: CheckPredicates,

Returns transaction that passed all Checks.

fn into_checked_reusable_memory( self, block_height: BlockHeight, consensus_params: &ConsensusParameters, memory: impl Memory, storage: &impl PredicateStorageRequirements, ) -> Result<Checked<Self>, CheckError>

where Checked<Self>: CheckPredicates,

Returns transaction that passed all Checks accepting reusable memory to run predicates.

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 Serialize for Transaction

fn size_static(&self) -> usize

Size of the static part of the serialized object, in bytes. Saturates to usize::MAX on overflow.

fn size_dynamic(&self) -> usize

Size of the dynamic part, in bytes. Saturates to usize::MAX on overflow.

fn encode_static<O>(&self, buffer: &mut O) -> Result<(), Error>

where O: Output + ?Sized,

Encodes staticly-sized part of Self.

fn encode_dynamic<O>(&self, buffer: &mut O) -> Result<(), Error>

where O: Output + ?Sized,

Encodes dynamically-sized part of Self. The default implementation does nothing. Dynamically-sized contains should override this.

fn size(&self) -> usize

Total size of the serialized object, in bytes. Saturates to usize::MAX on overflow.

fn encode<O>(&self, buffer: &mut O) -> Result<(), Error>

where O: Output + ?Sized,

Encodes Self into the buffer.

fn to_bytes(&self) -> Vec<u8>

Encodes Self into bytes vector. Required known size.

impl Serialize for Transaction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<NetworkableTransactionPool> for Transaction

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from( value: NetworkableTransactionPool, ) -> Result<Transaction, <Transaction as TryFrom<NetworkableTransactionPool>>::Error>

Performs the conversion.

impl TryFrom<OpaqueTransaction> for Transaction

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( value: OpaqueTransaction, ) -> Result<Transaction, <Transaction as TryFrom<OpaqueTransaction>>::Error>

Performs the conversion.

impl TryFrom<Transaction> for Transaction

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from( tx: Transaction, ) -> Result<Transaction, <Transaction as TryFrom<Transaction>>::Error>

Performs the conversion.

impl UniqueIdentifier for Transaction

fn id(&self, chain_id: &ChainId) -> Bytes32

The unique identifier of the transaction is based on its content.

fn cached_id(&self) -> Option<Bytes32>

The cached unique identifier of the transaction. Returns None if transaction was not precomputed.

impl Eq for Transaction

impl StructuralPartialEq for Transaction