Enum forc_debug::Transaction

pub enum Transaction {
    Script(Script),
    Create(Create),
    Mint(Mint),
}

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

Variants

Script(Script)

Create(Create)

Mint(Mint)

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> ) -> Script

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

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

pub fn to_json(&self) -> String

Convert the type into a JSON string

This is implemented as infallible because serde_json will fail only if the type can’t serialize one of its attributes. We don’t have such case with the transaction because all of its attributes are trivially serialized.

If an error happens, a JSON string with the error description will be returned

pub fn from_json<J>(json: J) -> Option<Transaction>

where J: AsRef<str>,

Attempt to deserialize a transaction from a JSON string, returning None if it fails

pub const fn is_script(&self) -> bool

pub const fn is_create(&self) -> bool

pub const fn is_mint(&self) -> bool

pub const fn as_script(&self) -> Option<&Script>

pub fn as_script_mut(&mut self) -> Option<&mut Script>

pub const fn as_create(&self) -> Option<&Create>

pub fn as_create_mut(&mut self) -> Option<&mut Create>

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

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

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 = 3usize

impl EstimatePredicates for Transaction

fn estimate_predicates( &mut self, params: &CheckPredicateParams ) -> Result<(), CheckError>

Estimates predicates of the transaction.

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

where 'life0: 'async_trait, 'life1: '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<Create> for Transaction

fn from(create: Create) -> Transaction

Converts to this type from the input type.

impl From<Mint> for Transaction

fn from(mint: Mint) -> Transaction

Converts to this type from the input type.

impl From<Script> for Transaction

fn from(script: Script) -> 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.

impl PartialEq 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: &Rhs) -> bool

This method 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.

fn size_dynamic(&self) -> usize

Size of the dynamic part, in bytes.

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.

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<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