feat(msp): rejected storage request triggers file clean up if needed

api-augment/dist/types/parachain/interfaces/augment-api-events.d.ts

@@ -597,8 +597,10 @@ declare module '@polkadot/api-base/types/events' {
              * Note: the storage request will be marked as "incomplete", and it is expected that fisherman
              * nodes will pick it up and delete the file from the confirmed BSPs as well as the Bucket.
              **/
-            StorageRequestRejected: AugmentedEvent<ApiType, [fileKey: H256, reason: PalletFileSystemRejectedStorageRequestReason], {
+            StorageRequestRejected: AugmentedEvent<ApiType, [fileKey: H256, mspId: H256, bucketId: H256, reason: PalletFileSystemRejectedStorageRequestReason], {
                 fileKey: H256;
+                mspId: H256;
+                bucketId: H256;
                 reason: PalletFileSystemRejectedStorageRequestReason;
             }>;
             /**

api-augment/dist/types/parachain/interfaces/lookup.d.ts

@@ -1565,6 +1565,8 @@ declare const _default: {
             };
             StorageRequestRejected: {
                 fileKey: string;
+                mspId: string;
+                bucketId: string;
                 reason: string;
             };
             BspRequestedToStopStoring: {

api-augment/dist/types/parachain/interfaces/types-lookup.d.ts

@@ -1659,6 +1659,8 @@ declare module '@polkadot/types/lookup' {
         readonly isStorageRequestRejected: boolean;
         readonly asStorageRequestRejected: {
             readonly fileKey: H256;
+            readonly mspId: H256;
+            readonly bucketId: H256;
             readonly reason: PalletFileSystemRejectedStorageRequestReason;
         } & Struct;
         readonly isBspRequestedToStopStoring: boolean;

api-augment/dist/types/solochain-evm/interfaces/augment-api-events.d.ts

@@ -557,8 +557,10 @@ declare module '@polkadot/api-base/types/events' {
              * Note: the storage request will be marked as "incomplete", and it is expected that fisherman
              * nodes will pick it up and delete the file from the confirmed BSPs as well as the Bucket.
              **/
-            StorageRequestRejected: AugmentedEvent<ApiType, [fileKey: H256, reason: PalletFileSystemRejectedStorageRequestReason], {
+            StorageRequestRejected: AugmentedEvent<ApiType, [fileKey: H256, mspId: H256, bucketId: H256, reason: PalletFileSystemRejectedStorageRequestReason], {
                 fileKey: H256;
+                mspId: H256;
+                bucketId: H256;
                 reason: PalletFileSystemRejectedStorageRequestReason;
             }>;
             /**

api-augment/dist/types/solochain-evm/interfaces/lookup.d.ts

@@ -862,6 +862,8 @@ declare const _default: {
             };
             StorageRequestRejected: {
                 fileKey: string;
+                mspId: string;
+                bucketId: string;
                 reason: string;
             };
             BspRequestedToStopStoring: {

api-augment/dist/types/solochain-evm/interfaces/types-lookup.d.ts

@@ -880,6 +880,8 @@ declare module '@polkadot/types/lookup' {
         readonly isStorageRequestRejected: boolean;
         readonly asStorageRequestRejected: {
             readonly fileKey: H256;
+            readonly mspId: H256;
+            readonly bucketId: H256;
             readonly reason: PalletFileSystemRejectedStorageRequestReason;
         } & Struct;
         readonly isBspRequestedToStopStoring: boolean;

api-augment/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storagehub/api-augment",
-  "version": "0.2.8",
+  "version": "0.2.9",
   "description": "",
   "scripts": {
     "scrape": "pnpm tsx scripts/scrapeMetadata.ts",

api-augment/src/parachain/interfaces/augment-api-events.ts

@@ -780,8 +780,18 @@ declare module "@polkadot/api-base/types/events" {
        **/
       StorageRequestRejected: AugmentedEvent<
         ApiType,
-        [fileKey: H256, reason: PalletFileSystemRejectedStorageRequestReason],
-        { fileKey: H256; reason: PalletFileSystemRejectedStorageRequestReason }
+        [
+          fileKey: H256,
+          mspId: H256,
+          bucketId: H256,
+          reason: PalletFileSystemRejectedStorageRequestReason
+        ],
+        {
+          fileKey: H256;
+          mspId: H256;
+          bucketId: H256;
+          reason: PalletFileSystemRejectedStorageRequestReason;
+        }
       >;
       /**
        * Notifies that a storage request has been revoked by the user who initiated it.

api-augment/src/parachain/interfaces/lookup.ts

@@ -1596,6 +1596,8 @@ export default {
       },
       StorageRequestRejected: {
         fileKey: "H256",
+        mspId: "H256",
+        bucketId: "H256",
         reason: "PalletFileSystemRejectedStorageRequestReason"
       },
       BspRequestedToStopStoring: {

api-augment/src/parachain/interfaces/types-lookup.ts

@@ -2099,6 +2099,8 @@ declare module "@polkadot/types/lookup" {
     readonly isStorageRequestRejected: boolean;
     readonly asStorageRequestRejected: {
       readonly fileKey: H256;
+      readonly mspId: H256;
+      readonly bucketId: H256;
       readonly reason: PalletFileSystemRejectedStorageRequestReason;
     } & Struct;
     readonly isBspRequestedToStopStoring: boolean;

api-augment/src/solochain-evm/interfaces/augment-api-events.ts

@@ -719,8 +719,18 @@ declare module "@polkadot/api-base/types/events" {
        **/
       StorageRequestRejected: AugmentedEvent<
         ApiType,
-        [fileKey: H256, reason: PalletFileSystemRejectedStorageRequestReason],
-        { fileKey: H256; reason: PalletFileSystemRejectedStorageRequestReason }
+        [
+          fileKey: H256,
+          mspId: H256,
+          bucketId: H256,
+          reason: PalletFileSystemRejectedStorageRequestReason
+        ],
+        {
+          fileKey: H256;
+          mspId: H256;
+          bucketId: H256;
+          reason: PalletFileSystemRejectedStorageRequestReason;
+        }
       >;
       /**
        * Notifies that a storage request has been revoked by the user who initiated it.

api-augment/src/solochain-evm/interfaces/lookup.ts

@@ -937,6 +937,8 @@ export default {
       },
       StorageRequestRejected: {
         fileKey: "H256",
+        mspId: "H256",
+        bucketId: "H256",
         reason: "PalletFileSystemRejectedStorageRequestReason"
       },
       BspRequestedToStopStoring: {

api-augment/src/solochain-evm/interfaces/types-lookup.ts

@@ -1165,6 +1165,8 @@ declare module "@polkadot/types/lookup" {
     readonly isStorageRequestRejected: boolean;
     readonly asStorageRequestRejected: {
       readonly fileKey: H256;
+      readonly mspId: H256;
+      readonly bucketId: H256;
       readonly reason: PalletFileSystemRejectedStorageRequestReason;
     } & Struct;
     readonly isBspRequestedToStopStoring: boolean;

client/blockchain-service/src/events.rs

@@ -198,6 +198,17 @@ pub struct SlashableProvider<Runtime: StorageEnableRuntime> {
     pub next_challenge_deadline: BlockNumber<Runtime>,
 }
 
+// Storage Request Expired in a Finalised Block
+//
+// This event is emitted when a storage request expires in a finalised block.
+#[derive(Debug, Clone, ActorEvent)]
+#[actor(actor = "blockchain_service")]
+pub struct FinalisedStorageRequestRejected<Runtime: StorageEnableRuntime> {
+    pub file_key: FileKey,
+    pub provider_id: ProofsDealerProviderId<Runtime>,
+    pub bucket_id: BucketId<Runtime>,
+}
+
 /// Mutations applied event in a finalised block, for a BSP.
 ///
 /// This event is emitted when a finalised block is received by the Blockchain service,

client/blockchain-service/src/handler_msp.rs

@@ -24,8 +24,8 @@ use crate::{
     events::{
         DistributeFileToBsp, FinalisedBucketMovedAway, FinalisedBucketMutationsApplied,
         FinalisedMspStopStoringBucketInsolventUser, FinalisedMspStoppedStoringBucket,
-        ForestWriteLockTaskData, MoveBucketRequestedForMsp, NewStorageRequest,
-        ProcessMspRespondStoringRequest, ProcessMspRespondStoringRequestData,
+        FinalisedStorageRequestRejected, ForestWriteLockTaskData, MoveBucketRequestedForMsp,
+        NewStorageRequest, ProcessMspRespondStoringRequest, ProcessMspRespondStoringRequestData,
         ProcessStopStoringForInsolventUserRequest, ProcessStopStoringForInsolventUserRequestData,
         StartMovedBucketDownload, VerifyMspBucketForests,
     },
@@ -235,6 +235,33 @@ where
                     }
                 }
             }
+            StorageEnableEvents::FileSystem(
+                pallet_file_system::Event::StorageRequestRejected {
+                    file_key,
+                    msp_id,
+                    bucket_id,
+                    reason,
+                },
+            ) => {
+                // Other reason than RequestExpired means that the MSP proactively rejected the request.
+                // We also check for InternalError just to be sure we dont have an inconsistent state due the error.
+                if !matches!(
+                    reason,
+                    pallet_file_system::types::RejectedStorageRequestReason::RequestExpired
+                        | pallet_file_system::types::RejectedStorageRequestReason::InternalError
+                ) {
+                    return;
+                }
+
+                // Process either InternalError or RequestExpire if this provider is managing the bucket.
+                if managed_msp_id == &msp_id {
+                    self.emit(FinalisedStorageRequestRejected {
+                        file_key: file_key.into(),
+                        provider_id: msp_id.into(),
+                        bucket_id,
+                    })
+                }
+            }
             StorageEnableEvents::ProofsDealer(pallet_proofs_dealer::Event::MutationsApplied {
                 mutations,
                 old_root: _,

client/indexer-service/src/handler.rs

@@ -384,7 +384,9 @@ impl<Runtime: StorageEnableRuntime> IndexerService<Runtime> {
                 }
                 // If the file has associations, the `IncompleteStorageRequest` event will handle it
             }
-            pallet_file_system::Event::StorageRequestRejected { file_key, reason } => {
+            pallet_file_system::Event::StorageRequestRejected {
+                file_key, reason, ..
+            } => {
                 // Check if the file has any BSP associations (it will not have MSP ones since the MSP did not accept it)
                 let has_bsp = File::has_bsp_associations(conn, file_key.as_ref()).await?;
                 if has_bsp {

client/src/handler.rs

@@ -15,9 +15,10 @@ use shc_blockchain_service::{
         AcceptedBspVolunteer, DistributeFileToBsp, FinalisedBspConfirmStoppedStoring,
         FinalisedBucketMovedAway, FinalisedBucketMutationsApplied,
         FinalisedMspStopStoringBucketInsolventUser, FinalisedMspStoppedStoringBucket,
-        FinalisedTrieRemoveMutationsAppliedForBsp, LastChargeableInfoUpdated, MoveBucketAccepted,
-        MoveBucketExpired, MoveBucketRejected, MoveBucketRequested, MoveBucketRequestedForMsp,
-        MultipleNewChallengeSeeds, NewStorageRequest, NotifyPeriod, ProcessConfirmStoringRequest,
+        FinalisedStorageRequestRejected, FinalisedTrieRemoveMutationsAppliedForBsp,
+        LastChargeableInfoUpdated, MoveBucketAccepted, MoveBucketExpired, MoveBucketRejected,
+        MoveBucketRequested, MoveBucketRequestedForMsp, MultipleNewChallengeSeeds,
+        NewStorageRequest, NotifyPeriod, ProcessConfirmStoringRequest,
         ProcessMspRespondStoringRequest, ProcessStopStoringForInsolventUserRequest,
         ProcessSubmitProofRequest, SlashableProvider, SpStopStoringInsolventUser,
         StartMovedBucketDownload, UserWithoutFunds, VerifyMspBucketForests,
@@ -319,6 +320,7 @@ where
                 DistributeFileToBsp<Runtime> => MspDistributeFileTask,
                 // MspRemoveFinalisedFilesTask handles events for removing files from file storage after mutations are finalised.
                 FinalisedBucketMutationsApplied<Runtime> => MspDeleteFileTask,
+                FinalisedStorageRequestRejected<Runtime> => MspDeleteFileTask,
                 VerifyMspBucketForests => MspVerifyBucketForestsTask,
             ]
         );

client/src/tasks/msp_delete_file.rs

@@ -1,7 +1,9 @@
 use anyhow::anyhow;
 use sc_tracing::tracing::*;
 use shc_actors_framework::event_bus::EventHandler;
-use shc_blockchain_service::events::FinalisedBucketMutationsApplied;
+use shc_blockchain_service::events::{
+    FinalisedBucketMutationsApplied, FinalisedStorageRequestRejected,
+};
 use shc_common::{
     traits::StorageEnableRuntime,
     types::{FileKey, TrieMutation, TrieRemoveMutation},
@@ -140,3 +142,78 @@ where
         Ok(())
     }
 }
+
+/// Handles the [`FinalisedStorageRequestRejected`] event.
+impl<NT, Runtime> EventHandler<FinalisedStorageRequestRejected<Runtime>>
+    for MspDeleteFileTask<NT, Runtime>
+where
+    NT: ShNodeType<Runtime> + 'static,
+    NT::FSH: MspForestStorageHandlerT<Runtime>,
+    Runtime: StorageEnableRuntime,
+{
+    async fn handle_event(
+        &mut self,
+        event: FinalisedStorageRequestRejected<Runtime>,
+    ) -> anyhow::Result<()> {
+        info!(
+            target: LOG_TARGET,
+            "Processing finalised storage request expired for file key {:?} in bucket {:?}",
+            event.file_key,
+            event.bucket_id
+        );
+
+        // Ensure the file key is not present in the bucket's Forest.
+        let bucket_forest_key = event.bucket_id.as_ref().to_vec();
+        let read_fs = self
+            .storage_hub_handler
+            .forest_storage_handler
+            .get(&bucket_forest_key.into())
+            .await
+            .ok_or_else(|| {
+                anyhow!(
+                    "CRITICAL❗️❗️ Failed to get forest storage for bucket [{:?}].",
+                    event.bucket_id
+                )
+            })?;
+
+        if read_fs
+            .read()
+            .await
+            .contains_file_key(&event.file_key.into())?
+        {
+            warn!(
+                target: LOG_TARGET,
+                "StorageRequestExpired and finalised for file key {:?} in bucket {:?}, but file key is still in Forest.",
+                event.file_key,
+                event.bucket_id
+            );
+            return Err(anyhow!("File key is still in Forest"));
+        }
+
+        // Check that the file is present in the File Storage.
+        let is_in_file_storage = {
+            let read_file_storage = self.storage_hub_handler.file_storage.read().await;
+            read_file_storage
+                .get_metadata(&event.file_key.into())
+                .map_err(|e| {
+                    error!(target: LOG_TARGET, "Failed to get file metadata from File Storage: {:?}", e);
+                    anyhow!("Failed to get file metadata from File Storage: {:?}", e)
+                })?
+                .is_some()
+        };
+
+        if is_in_file_storage {
+            // If file is present in File Storage and not in Forest, remove it from File Storage.
+            self.remove_file_from_file_storage(&event.file_key.into())
+                .await?;
+        } else {
+            debug!(
+                target: LOG_TARGET,
+                "File key {:?} not present in File Storage; skipping removal.",
+                event.file_key
+            );
+        }
+
+        Ok(())
+    }
+}

pallets/file-system/src/benchmarking.rs

@@ -2180,6 +2180,8 @@ mod benchmarks {
         let expected_event =
             <T as pallet::Config>::RuntimeEvent::from(Event::StorageRequestRejected {
                 file_key,
+                msp_id,
+                bucket_id,
                 reason: RejectedStorageRequestReason::RequestExpired,
             });
         frame_system::Pallet::<T>::assert_last_event(expected_event.into());

pallets/file-system/src/lib.rs

@@ -644,6 +644,8 @@ pub mod pallet {
         /// nodes will pick it up and delete the file from the confirmed BSPs as well as the Bucket.
         StorageRequestRejected {
             file_key: MerkleHash<T>,
+            msp_id: ProviderIdFor<T>,
+            bucket_id: BucketIdFor<T>,
             reason: RejectedStorageRequestReason,
         },
         BspRequestedToStopStoring {