Included the total gas and fee into TransactionStatus (#1831)

Closes #1817 ### Before requesting review - [x] I have reviewed the code myself
FuelLabs · Apr 17, 2024 · 7babe1a · 7babe1a
1 parent df417f7
commit 7babe1a
Show file tree

Hide file tree

Showing 20 changed files with 241 additions and 36 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -15,6 +15,7 @@ Description of the upcoming release here.
 
 ### Added
 
+- [#1831](https://github.com/FuelLabs/fuel-core/pull/1831): Included the total gas and fee used by transaction into `TransactionStatus`.
 - [#1821](https://github.com/FuelLabs/fuel-core/pull/1821): Propagate shutdown signal to (re)genesis. Also add progress bar for (re)genesis.
 - [#1813](https://github.com/FuelLabs/fuel-core/pull/1813): Added back support for `/health` endpoint.
 - [#1799](https://github.com/FuelLabs/fuel-core/pull/1799): Snapshot creation is now concurrent.

diff --git a/benches/benches/block_target_gas.rs b/benches/benches/block_target_gas.rs
@@ -430,8 +430,9 @@ fn run_with_service_with_extra_inputs(
                 assert_eq!(res.sealed_block.entity.transactions().len(), 2);
                 assert_eq!(res.tx_status[0].id, tx_id);
 
-                let TransactionExecutionResult::Failed { result, receipts } =
-                    &res.tx_status[0].result
+                let TransactionExecutionResult::Failed {
+                    result, receipts, ..
+                } = &res.tx_status[0].result
                 else {
                     panic!("The execution should fails with out of gas")
                 };

diff --git a/bin/fuel-core/src/cli/snapshot.rs b/bin/fuel-core/src/cli/snapshot.rs
@@ -461,6 +461,8 @@ mod tests {
                     pc: self.rng.gen(),
                     is: self.rng.gen(),
                 }],
+                total_gas: self.rng.gen(),
+                total_fee: self.rng.gen(),
             };
 
             self.db

diff --git a/crates/client/assets/schema.sdl b/crates/client/assets/schema.sdl
@@ -272,11 +272,15 @@ type DryRunFailureStatus {
 	programState: ProgramState
 	reason: String!
 	receipts: [Receipt!]!
+	totalGas: U64!
+	totalFee: U64!
 }
 
 type DryRunSuccessStatus {
 	programState: ProgramState
 	receipts: [Receipt!]!
+	totalGas: U64!
+	totalFee: U64!
 }
 
 type DryRunTransactionExecutionStatus {
@@ -309,6 +313,8 @@ type FailureStatus {
 	reason: String!
 	programState: ProgramState
 	receipts: [Receipt!]!
+	totalGas: U64!
+	totalFee: U64!
 }
 
 type FeeParameters {
@@ -1002,6 +1008,8 @@ type SuccessStatus {
 	time: Tai64Timestamp!
 	programState: ProgramState
 	receipts: [Receipt!]!
+	totalGas: U64!
+	totalFee: U64!
 }
 
 scalar Tai64Timestamp

diff --git a/.../schema/snapshots/fuel_core_client__client__schema__tx__tests__dry_run_tx_gql_output.snap b/.../schema/snapshots/fuel_core_client__client__schema__tx__tests__dry_run_tx_gql_output.snap
@@ -42,6 +42,8 @@ mutation($txs: [HexString!]!, $utxoValidation: Boolean) {
           contractId
           subId
         }
+        totalGas
+        totalFee
       }
       ... on DryRunFailureStatus {
         programState {
@@ -78,9 +80,9 @@ mutation($txs: [HexString!]!, $utxoValidation: Boolean) {
           contractId
           subId
         }
+        totalGas
+        totalFee
       }
     }
   }
 }
-
-
diff --git a/...el_core_client__client__schema__tx__tests__opaque_transaction_by_id_query_gql_output.snap b/...el_core_client__client__schema__tx__tests__opaque_transaction_by_id_query_gql_output.snap
@@ -50,6 +50,8 @@ query($id: TransactionId!) {
           contractId
           subId
         }
+        totalGas
+        totalFee
       }
       ... on SqueezedOutStatus {
         reason
@@ -95,9 +97,9 @@ query($id: TransactionId!) {
           contractId
           subId
         }
+        totalGas
+        totalFee
       }
     }
   }
 }
-
-
diff --git a/...pshots/fuel_core_client__client__schema__tx__tests__transactions_by_owner_gql_output.snap b/...pshots/fuel_core_client__client__schema__tx__tests__transactions_by_owner_gql_output.snap
@@ -53,6 +53,8 @@ query($owner: Address!, $after: String, $before: String, $first: Int, $last: Int
               contractId
               subId
             }
+            totalGas
+            totalFee
           }
           ... on SqueezedOutStatus {
             reason
@@ -98,6 +100,8 @@ query($owner: Address!, $after: String, $before: String, $first: Int, $last: Int
               contractId
               subId
             }
+            totalGas
+            totalFee
           }
         }
       }
@@ -110,5 +114,3 @@ query($owner: Address!, $after: String, $before: String, $first: Int, $last: Int
     }
   }
 }
-
-
diff --git a/...uel_core_client__client__schema__tx__tests__transactions_connection_query_gql_output.snap b/...uel_core_client__client__schema__tx__tests__transactions_connection_query_gql_output.snap
@@ -53,6 +53,8 @@ query($after: String, $before: String, $first: Int, $last: Int) {
               contractId
               subId
             }
+            totalGas
+            totalFee
           }
           ... on SqueezedOutStatus {
             reason
@@ -98,6 +100,8 @@ query($after: String, $before: String, $first: Int, $last: Int) {
               contractId
               subId
             }
+            totalGas
+            totalFee
           }
         }
       }
@@ -110,5 +114,3 @@ query($after: String, $before: String, $first: Int, $last: Int) {
     }
   }
 }
-
-
diff --git a/...re_client__client__schema__tx__tests__transparent_transaction_by_id_query_gql_output.snap b/...re_client__client__schema__tx__tests__transparent_transaction_by_id_query_gql_output.snap
@@ -134,6 +134,8 @@ query($id: TransactionId!) {
           contractId
           subId
         }
+        totalGas
+        totalFee
       }
       ... on SqueezedOutStatus {
         reason
@@ -179,6 +181,8 @@ query($id: TransactionId!) {
           contractId
           subId
         }
+        totalGas
+        totalFee
       }
     }
     witnesses

diff --git a/crates/client/src/client/schema/tx.rs b/crates/client/src/client/schema/tx.rs
@@ -10,6 +10,7 @@ use crate::client::{
         PageInfo,
         Tai64Timestamp,
         TransactionId,
+        U64,
     },
     types::TransactionResponse,
     PageDirection,
@@ -182,6 +183,8 @@ pub struct SuccessStatus {
     pub time: Tai64Timestamp,
     pub program_state: Option<ProgramState>,
     pub receipts: Vec<Receipt>,
+    pub total_gas: U64,
+    pub total_fee: U64,
 }
 
 #[derive(cynic::QueryFragment, Clone, Debug)]
@@ -193,6 +196,8 @@ pub struct FailureStatus {
     pub reason: String,
     pub program_state: Option<ProgramState>,
     pub receipts: Vec<Receipt>,
+    pub total_gas: U64,
+    pub total_fee: U64,
 }
 
 #[derive(cynic::QueryFragment, Clone, Debug)]
@@ -225,6 +230,8 @@ impl TryFrom<DryRunTransactionStatus> for TransactionExecutionResult {
                 TransactionExecutionResult::Success {
                     result: s.program_state.map(TryInto::try_into).transpose()?,
                     receipts,
+                    total_gas: s.total_gas.0,
+                    total_fee: s.total_fee.0,
                 }
             }
             DryRunTransactionStatus::FailureStatus(s) => {
@@ -236,6 +243,8 @@ impl TryFrom<DryRunTransactionStatus> for TransactionExecutionResult {
                 TransactionExecutionResult::Failed {
                     result: s.program_state.map(TryInto::try_into).transpose()?,
                     receipts,
+                    total_gas: s.total_gas.0,
+                    total_fee: s.total_fee.0,
                 }
             }
             DryRunTransactionStatus::Unknown => {
@@ -250,13 +259,17 @@ impl TryFrom<DryRunTransactionStatus> for TransactionExecutionResult {
 pub struct DryRunSuccessStatus {
     pub program_state: Option<ProgramState>,
     pub receipts: Vec<Receipt>,
+    pub total_gas: U64,
+    pub total_fee: U64,
 }
 
 #[derive(cynic::QueryFragment, Clone, Debug)]
 #[cynic(schema_path = "./assets/schema.sdl")]
 pub struct DryRunFailureStatus {
     pub program_state: Option<ProgramState>,
     pub receipts: Vec<Receipt>,
+    pub total_gas: U64,
+    pub total_fee: U64,
 }
 
 #[derive(cynic::QueryFragment, Clone, Debug)]

diff --git a/crates/client/src/client/types.rs b/crates/client/src/client/types.rs
@@ -100,6 +100,8 @@ pub enum TransactionStatus {
         time: Tai64,
         program_state: Option<ProgramState>,
         receipts: Vec<Receipt>,
+        total_gas: u64,
+        total_fee: u64,
     },
     SqueezedOut {
         reason: String,
@@ -110,6 +112,8 @@ pub enum TransactionStatus {
         reason: String,
         program_state: Option<ProgramState>,
         receipts: Vec<Receipt>,
+        total_gas: u64,
+        total_fee: u64,
     },
 }
 
@@ -130,6 +134,8 @@ impl TryFrom<SchemaTxStatus> for TransactionStatus {
                     .into_iter()
                     .map(TryInto::try_into)
                     .collect::<Result<Vec<_>, _>>()?,
+                total_gas: s.total_gas.0,
+                total_fee: s.total_fee.0,
             },
             SchemaTxStatus::FailureStatus(s) => TransactionStatus::Failure {
                 block_height: s.block.height.into(),
@@ -141,6 +147,8 @@ impl TryFrom<SchemaTxStatus> for TransactionStatus {
                     .into_iter()
                     .map(TryInto::try_into)
                     .collect::<Result<Vec<_>, _>>()?,
+                total_gas: s.total_gas.0,
+                total_fee: s.total_fee.0,
             },
             SchemaTxStatus::SqueezedOutStatus(s) => {
                 TransactionStatus::SqueezedOut { reason: s.reason }

diff --git a/crates/fuel-core/src/query/message/test.rs b/crates/fuel-core/src/query/message/test.rs
@@ -184,6 +184,8 @@ async fn can_build_message_proof() {
                 time: Tai64::UNIX_EPOCH,
                 result: None,
                 receipts: vec![],
+                total_gas: 0,
+                total_fee: 0,
             })
         });
 

diff --git a/crates/fuel-core/src/query/subscriptions/test.rs b/crates/fuel-core/src/query/subscriptions/test.rs
@@ -56,6 +56,8 @@ fn success() -> TransactionStatus {
         time: Tai64(0),
         result: None,
         receipts: vec![],
+        total_gas: 0,
+        total_fee: 0,
     }
 }
 
@@ -66,6 +68,8 @@ fn failed() -> TransactionStatus {
         time: Tai64(0),
         result: None,
         receipts: vec![],
+        total_gas: 0,
+        total_fee: 0,
     }
 }