Change naming parameter

Author: AurelienFT

crates/client/assets/schema.sdl

@@ -1342,7 +1342,7 @@ type Subscription {
 		"""
 		If true, accept to receive the preconfirmation status
 		"""
-		allowPreconfirmation: Boolean
+		includePreconfirmation: Boolean
 	): TransactionStatus!
 	"""
 	Submits transaction to the `TxPool` and await either success or failure.
@@ -1353,7 +1353,7 @@ type Subscription {
 	Compared to the `submitAndAwait`, the stream also contains
 	`SubmittedStatus` and potentially preconfirmation as an intermediate state.
 	"""
-	submitAndAwaitStatus(tx: HexString!, estimatePredicates: Boolean, allowPreconfirmation: Boolean): TransactionStatus!
+	submitAndAwaitStatus(tx: HexString!, estimatePredicates: Boolean, includePreconfirmation: Boolean): TransactionStatus!
 	contractStorageSlots(contractId: ContractId!): StorageSlot!
 	contractStorageBalances(contractId: ContractId!): ContractBalance!
 }
@@ -1395,7 +1395,7 @@ type Transaction {
 	outputContract: ContractOutput
 	witnesses: [HexString!]
 	receiptsRoot: Bytes32
-	status(allowPreconfirmation: Boolean): TransactionStatus
+	status(includePreconfirmation: Boolean): TransactionStatus
 	script: HexString
 	scriptData: HexString
 	bytecodeWitnessIndex: U16

crates/client/src/client.rs

@@ -948,7 +948,7 @@ impl FuelClient {
         &'a self,
         tx: &'a Transaction,
         estimate_predicates: Option<bool>,
-        allow_preconfirmation: Option<bool>,
+        include_preconfirmation: Option<bool>,
     ) -> io::Result<impl Stream<Item = io::Result<TransactionStatus>> + 'a> {
         use cynic::SubscriptionBuilder;
         use schema::tx::SubmitAndAwaitStatusArg;
@@ -957,7 +957,7 @@ impl FuelClient {
             SubmitAndAwaitStatusArg {
                 tx: HexString(Bytes(tx)),
                 estimate_predicates,
-                allow_preconfirmation,
+                include_preconfirmation,
             },
         );
 
@@ -1222,15 +1222,15 @@ impl FuelClient {
     pub async fn subscribe_transaction_status_opt<'a>(
         &'a self,
         id: &'a TxId,
-        allow_preconfirmation: Option<bool>,
+        include_preconfirmation: Option<bool>,
     ) -> io::Result<impl Stream<Item = io::Result<TransactionStatus>> + 'a> {
         use cynic::SubscriptionBuilder;
         use schema::tx::StatusChangeSubscriptionArgs;
         let tx_id: TransactionId = (*id).into();
         let s =
             schema::tx::StatusChangeSubscription::build(StatusChangeSubscriptionArgs {
                 id: tx_id,
-                allow_preconfirmation,
+                include_preconfirmation,
             });
 
         tracing::debug!("subscribing");

crates/client/src/client/schema/tx.rs

@@ -476,7 +476,7 @@ pub struct TransactionsByOwnerQuery {
 pub struct StatusChangeSubscriptionArgs {
     pub id: TransactionId,
     #[cynic(skip_serializing_if = "Option::is_none")]
-    pub allow_preconfirmation: Option<bool>,
+    pub include_preconfirmation: Option<bool>,
 }
 
 #[derive(cynic::QueryFragment, Clone, Debug)]
@@ -486,7 +486,7 @@ pub struct StatusChangeSubscriptionArgs {
     variables = "StatusChangeSubscriptionArgs"
 )]
 pub struct StatusChangeSubscription {
-    #[arguments(id: $id, allowPreconfirmation: $allow_preconfirmation)]
+    #[arguments(id: $id, includePreconfirmation: $include_preconfirmation)]
     pub status_change: TransactionStatus,
 }
 
@@ -510,7 +510,7 @@ pub struct SubmitAndAwaitStatusArg {
     #[cynic(skip_serializing_if = "Option::is_none")]
     pub estimate_predicates: Option<bool>,
     #[cynic(skip_serializing_if = "Option::is_none")]
-    pub allow_preconfirmation: Option<bool>,
+    pub include_preconfirmation: Option<bool>,
 }
 
 #[derive(cynic::QueryFragment, Clone, Debug)]
@@ -662,7 +662,7 @@ pub struct SubmitAndAwaitSubscriptionWithTransaction {
     variables = "SubmitAndAwaitStatusArg"
 )]
 pub struct SubmitAndAwaitStatusSubscription {
-    #[arguments(tx: $tx, estimatePredicates: $estimate_predicates, allowPreconfirmation: $allow_preconfirmation)]
+    #[arguments(tx: $tx, estimatePredicates: $estimate_predicates, includePreconfirmation: $include_preconfirmation)]
     pub submit_and_await_status: TransactionStatus,
 }
 

crates/fuel-core/src/query/subscriptions.rs

@@ -20,7 +20,7 @@ pub(crate) trait TxnStatusChangeState {
     async fn get_tx_status(
         &self,
         id: Bytes32,
-        allow_preconfirmation: bool,
+        include_preconfirmation: bool,
     ) -> StorageResult<Option<TransactionStatus>>;
 }
 
@@ -29,15 +29,15 @@ pub(crate) async fn transaction_status_change<'a, State>(
     state: State,
     stream: BoxStream<'a, TxStatusMessage>,
     transaction_id: Bytes32,
-    allow_preconfirmation: bool,
+    include_preconfirmation: bool,
 ) -> impl Stream<Item = anyhow::Result<ApiTxStatus>> + 'a
 where
     State: TxnStatusChangeState + Send + Sync + 'a,
 {
     // Check the database first to see if the transaction already
     // has a status.
     let maybe_db_status = state
-        .get_tx_status(transaction_id, allow_preconfirmation)
+        .get_tx_status(transaction_id, include_preconfirmation)
         .await
         .transpose()
         .map(TxStatusMessage::from);
@@ -62,7 +62,7 @@ where
             match status {
                 TxStatusMessage::Status(status) => {
                     let status = ApiTxStatus::new(transaction_id, status);
-                    if !allow_preconfirmation && status.is_preconfirmation() {
+                    if !include_preconfirmation && status.is_preconfirmation() {
                         futures::future::ready(None)
                     } else {
                         futures::future::ready(Some(Ok(status)))

crates/fuel-core/src/schema/tx.rs

@@ -626,7 +626,7 @@ impl TxStatusSubscription {
         ctx: &'a Context<'a>,
         #[graphql(desc = "The ID of the transaction")] id: TransactionId,
         #[graphql(desc = "If true, accept to receive the preconfirmation status")]
-        allow_preconfirmation: Option<bool>,
+        include_preconfirmation: Option<bool>,
     ) -> anyhow::Result<impl Stream<Item = async_graphql::Result<TransactionStatus>> + 'a>
     {
         let tx_status_manager = ctx.data_unchecked::<DynTxStatusManager>();
@@ -641,7 +641,7 @@ impl TxStatusSubscription {
             status_change_state,
             rx,
             id.into(),
-            allow_preconfirmation.unwrap_or(false),
+            include_preconfirmation.unwrap_or(false),
         )
         .await
         .map_err(async_graphql::Error::from))
@@ -676,15 +676,15 @@ impl TxStatusSubscription {
         ctx: &'a Context<'a>,
         tx: HexString,
         estimate_predicates: Option<bool>,
-        allow_preconfirmation: Option<bool>,
+        include_preconfirmation: Option<bool>,
     ) -> async_graphql::Result<
         impl Stream<Item = async_graphql::Result<TransactionStatus>> + 'a,
     > {
         submit_and_await_status(
             ctx,
             tx,
             estimate_predicates.unwrap_or(false),
-            allow_preconfirmation.unwrap_or(false),
+            include_preconfirmation.unwrap_or(false),
         )
         .await
     }
@@ -694,7 +694,7 @@ async fn submit_and_await_status<'a>(
     ctx: &'a Context<'a>,
     tx: HexString,
     estimate_predicates: bool,
-    allow_preconfirmation: bool,
+    include_preconfirmation: bool,
 ) -> async_graphql::Result<
     impl Stream<Item = async_graphql::Result<TransactionStatus>> + 'a,
 > {
@@ -721,7 +721,7 @@ async fn submit_and_await_status<'a>(
             match status {
                 TxStatusMessage::Status(status) => {
                     let status = TransactionStatus::new(tx_id, status);
-                    if !allow_preconfirmation && status.is_preconfirmation() {
+                    if !include_preconfirmation && status.is_preconfirmation() {
                         None
                     } else {
                         Some(Ok(status))
@@ -746,13 +746,13 @@ impl<'a> TxnStatusChangeState for StatusChangeState<'a> {
     async fn get_tx_status(
         &self,
         id: Bytes32,
-        allow_preconfirmation: bool,
+        include_preconfirmation: bool,
     ) -> StorageResult<Option<transaction_status::TransactionStatus>> {
         get_tx_status(
             &id,
             self.query.as_ref(),
             self.tx_status_manager,
-            allow_preconfirmation,
+            include_preconfirmation,
         )
         .await
     }

crates/fuel-core/src/schema/tx/types.rs

@@ -777,7 +777,7 @@ impl Transaction {
     async fn status(
         &self,
         ctx: &Context<'_>,
-        allow_preconfirmation: Option<bool>,
+        include_preconfirmation: Option<bool>,
     ) -> async_graphql::Result<Option<TransactionStatus>> {
         let id = self.1;
         let query = ctx.read_view()?;
@@ -788,7 +788,7 @@ impl Transaction {
             &id,
             query.as_ref(),
             tx_status_manager,
-            allow_preconfirmation.unwrap_or(false),
+            include_preconfirmation.unwrap_or(false),
         )
         .await
         .map(|status| status.map(|status| TransactionStatus::new(id, status)))
@@ -1112,7 +1112,7 @@ pub(crate) async fn get_tx_status(
     id: &fuel_core_types::fuel_types::Bytes32,
     query: &ReadView,
     tx_status_manager: &DynTxStatusManager,
-    allow_preconfirmation: bool,
+    include_preconfirmation: bool,
 ) -> Result<Option<transaction_status::TransactionStatus>, StorageError> {
     let api_result = query
         .tx_status(id)
@@ -1126,7 +1126,7 @@ pub(crate) async fn get_tx_status(
                     // Filter out preconfirmation statuses if not allowed. Converting to submitted status
                     // because it's the closest to the preconfirmation status.
                     // Having `now()` as timestamp isn't ideal but shouldn't cause much inconsistency.
-                    if !allow_preconfirmation
+                    if !include_preconfirmation
                         && status.is_preconfirmation()
                         && !status.is_final()
                     {

crates/fuel-core/src/service/query.rs

@@ -103,7 +103,7 @@ impl<'a> TxnStatusChangeState for StatusChangeState<'a> {
     async fn get_tx_status(
         &self,
         id: Bytes32,
-        allow_preconfirmation: bool,
+        include_preconfirmation: bool,
     ) -> StorageResult<Option<TxPoolTxStatus>> {
         match self.db.get_tx_status(&id)? {
             Some(status) => Ok(Some(status.into())),
@@ -113,7 +113,7 @@ impl<'a> TxnStatusChangeState for StatusChangeState<'a> {
                     // Filter out preconfirmation statuses if not allowed. Converting to submitted status
                     // because it's the closest to the preconfirmation status.
                     // Having `now()` as timestamp isn't ideal but shouldn't cause much inconsistency.
-                    if !allow_preconfirmation
+                    if !include_preconfirmation
                         && status.is_preconfirmation()
                         && !status.is_final()
                     {