@storagehub/api-augment 0.2.5 → 0.2.7

package/src/solochain-evm/interfaces/augment-api-consts.ts

@@ -132,6 +132,10 @@ declare module "@polkadot/api-base/types/consts" {
        * Maximum number of expired items (per type) to clean up in a single tick.
        **/
       maxExpiredItemsInTick: u32 & AugmentedConst<ApiType>;
+      /**
+       * Maximum number of file deletions that can be processed in a single extrinsic call for `delete_files` and `delete_files_for_incomplete_storage_request`.
+       **/
+      maxFileDeletionsPerExtrinsic: u32 & AugmentedConst<ApiType>;
       /**
        * Maximum byte size of a file path.
        **/

package/src/solochain-evm/interfaces/augment-api-errors.ts

@@ -186,6 +186,10 @@ declare module "@polkadot/api-base/types/errors" {
        * BSP did not succeed threshold check.
        **/
       AboveThreshold: AugmentedError<ApiType>;
+      /**
+       * Batch file deletion must contain files from a single bucket only.
+       **/
+      BatchFileDeletionMustContainSingleBucket: AugmentedError<ApiType>;
       /**
        * BSP has already confirmed storing the given file.
        **/
@@ -242,6 +246,10 @@ declare module "@polkadot/api-base/types/errors" {
        * Divided by 0
        **/
       DividedByZero: AugmentedError<ApiType>;
+      /**
+       * Duplicate file key detected within the same batch deletion request.
+       **/
+      DuplicateFileKeyInBatchFileDeletion: AugmentedError<ApiType>;
       /**
        * Failed to fetch the dynamic-rate payment stream.
        **/
@@ -282,6 +290,18 @@ declare module "@polkadot/api-base/types/errors" {
        * Failed to get the payment account of the provider.
        **/
       FailedToGetPaymentAccount: AugmentedError<ApiType>;
+      /**
+       * Failed to push file key to bounded vector during BSP file deletion
+       **/
+      FailedToPushFileKeyToBspDeletionVector: AugmentedError<ApiType>;
+      /**
+       * Failed to push file key to bounded vector during bucket file deletion
+       **/
+      FailedToPushFileKeyToBucketDeletionVector: AugmentedError<ApiType>;
+      /**
+       * Failed to push user to bounded vector during BSP file deletion
+       **/
+      FailedToPushUserToBspDeletionVector: AugmentedError<ApiType>;
       /**
        * Failed to query earliest volunteer tick
        **/
@@ -399,6 +419,10 @@ declare module "@polkadot/api-base/types/errors" {
        * No file keys to confirm storing
        **/
       NoFileKeysToConfirm: AugmentedError<ApiType>;
+      /**
+       * Requires at least 1 file key to be deleted.
+       **/
+      NoFileKeysToDelete: AugmentedError<ApiType>;
       /**
        * No global reputation weight set.
        **/

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

@@ -377,26 +377,12 @@ declare module "@polkadot/api-base/types/events" {
         { bspId: H256; fileKey: H256; newRoot: H256 }
       >;
       /**
-       * Notifies that a file deletion has been completed successfully for a BSP.
+       * Notifies that file deletions have been completed successfully for a BSP.
        **/
-      BspFileDeletionCompleted: AugmentedEvent<
+      BspFileDeletionsCompleted: AugmentedEvent<
         ApiType,
-        [
-          user: AccountId20,
-          fileKey: H256,
-          fileSize: u64,
-          bspId: H256,
-          oldRoot: H256,
-          newRoot: H256
-        ],
-        {
-          user: AccountId20;
-          fileKey: H256;
-          fileSize: u64;
-          bspId: H256;
-          oldRoot: H256;
-          newRoot: H256;
-        }
+        [users: Vec<AccountId20>, fileKeys: Vec<H256>, bspId: H256, oldRoot: H256, newRoot: H256],
+        { users: Vec<AccountId20>; fileKeys: Vec<H256>; bspId: H256; oldRoot: H256; newRoot: H256 }
       >;
       BspRequestedToStopStoring: AugmentedEvent<
         ApiType,
@@ -412,14 +398,13 @@ declare module "@polkadot/api-base/types/events" {
         { who: AccountId20; bucketId: H256; maybeCollectionId: Option<u32> }
       >;
       /**
-       * Notifies that a file deletion has been completed successfully for a Bucket.
+       * Notifies that file deletions have been completed successfully for a Bucket.
        **/
-      BucketFileDeletionCompleted: AugmentedEvent<
+      BucketFileDeletionsCompleted: AugmentedEvent<
         ApiType,
         [
           user: AccountId20,
-          fileKey: H256,
-          fileSize: u64,
+          fileKeys: Vec<H256>,
           bucketId: H256,
           mspId: Option<H256>,
           oldRoot: H256,
@@ -427,8 +412,7 @@ declare module "@polkadot/api-base/types/events" {
         ],
         {
           user: AccountId20;
-          fileKey: H256;
-          fileSize: u64;
+          fileKeys: Vec<H256>;
           bucketId: H256;
           mspId: Option<H256>;
           oldRoot: H256;
@@ -512,14 +496,6 @@ declare module "@polkadot/api-base/types/events" {
           error: SpRuntimeDispatchError;
         }
       >;
-      /**
-       * Notifies that a file has been deleted from a rejected storage request.
-       **/
-      FileDeletedFromIncompleteStorageRequest: AugmentedEvent<
-        ApiType,
-        [fileKey: H256, bspId: Option<H256>],
-        { fileKey: H256; bspId: Option<H256> }
-      >;
       /**
        * Notifies that a file will be deleted.
        **/

package/src/solochain-evm/interfaces/augment-api-tx.ts

@@ -29,6 +29,7 @@ import type {
   FpAccountEthereumSignature,
   PalletBalancesAdjustmentDirection,
   PalletFileSystemBucketMoveRequestResponse,
+  PalletFileSystemFileDeletionRequest,
   PalletFileSystemFileKeyWithProof,
   PalletFileSystemFileOperationIntention,
   PalletFileSystemReplicationTarget,
@@ -528,57 +529,57 @@ declare module "@polkadot/api-base/types/submittable" {
         [H256]
       >;
       /**
-       * Deletes a file from a provider's forest, changing its root
+       * Deletes files from a provider's forest, changing its root
        *
        * This extrinsic allows any actor to execute file deletion based on signed intentions
-       * from the `FileDeletionRequested` event. It requires a valid forest proof showing that the
-       * file exists in the specified provider's forest before allowing deletion.
+       * from the `FileDeletionRequested` event. It requires a valid forest proof showing that
+       * all files exist in the specified provider's forest before allowing deletion.
        *
-       * If `bsp_id` is `None`, the file will be deleted from the bucket forest.
-       * If `bsp_id` is `Some(id)`, the file will be deleted from the specified BSP's forest.
+       * Multiple files can be deleted in a single call using one forest proof bounded by [`MaxFileDeletionsPerExtrinsic`](Config::MaxFileDeletionsPerExtrinsic).
+       *
+       * If `bsp_id` is `None`, files will be deleted from the bucket forest.
+       * If `bsp_id` is `Some(id)`, files will be deleted from the specified BSP's forest.
        **/
-      deleteFile: AugmentedSubmittable<
+      deleteFiles: AugmentedSubmittable<
         (
-          fileOwner: AccountId20 | string | Uint8Array,
-          signedIntention:
-            | PalletFileSystemFileOperationIntention
-            | { fileKey?: any; operation?: any }
-            | string
-            | Uint8Array,
-          signature: FpAccountEthereumSignature | string | Uint8Array,
-          bucketId: H256 | string | Uint8Array,
-          location: Bytes | string | Uint8Array,
-          size: u64 | AnyNumber | Uint8Array,
-          fingerprint: H256 | string | Uint8Array,
+          fileDeletions:
+            | Vec<PalletFileSystemFileDeletionRequest>
+            | (
+                | PalletFileSystemFileDeletionRequest
+                | {
+                    fileOwner?: any;
+                    signedIntention?: any;
+                    signature?: any;
+                    bucketId?: any;
+                    location?: any;
+                    size_?: any;
+                    fingerprint?: any;
+                  }
+                | string
+                | Uint8Array
+              )[],
           bspId: Option<H256> | null | Uint8Array | H256 | string,
           forestProof: SpTrieStorageProofCompactProof | { encodedNodes?: any } | string | Uint8Array
         ) => SubmittableExtrinsic<ApiType>,
-        [
-          AccountId20,
-          PalletFileSystemFileOperationIntention,
-          FpAccountEthereumSignature,
-          H256,
-          Bytes,
-          u64,
-          H256,
-          Option<H256>,
-          SpTrieStorageProofCompactProof
-        ]
+        [Vec<PalletFileSystemFileDeletionRequest>, Option<H256>, SpTrieStorageProofCompactProof]
       >;
       /**
-       * Delete a file from an incomplete (rejected, expired or revoked) storage request.
+       * Delete files from an incomplete (rejected, expired or revoked) storage request.
        *
-       * This extrinsic allows fisherman nodes to delete files from providers when an IncompleteStorageRequestMetadata for the given file_key
-       * exist in the IncompleteStorageRequests mapping. It validates that the IncompleteStorageRequestMetadata exists,
-       * that the provider has the file in its Merkle Patricia Forest, and verifies the file key matches the metadata.
+       * This extrinsic allows fisherman nodes to delete files from providers when IncompleteStorageRequestMetadata
+       * for the given file keys exist in the IncompleteStorageRequests mapping. It validates that the metadata exists
+       * for each file, that the provider has the files in its Merkle Patricia Forest, and verifies the file keys match
+       * the metadata.
+       *
+       * Multiple files can be deleted in a single call using one forest proof bounded by [`MaxFileDeletionsPerExtrinsic`](Config::MaxFileDeletionsPerExtrinsic).
        **/
-      deleteFileForIncompleteStorageRequest: AugmentedSubmittable<
+      deleteFilesForIncompleteStorageRequest: AugmentedSubmittable<
         (
-          fileKey: H256 | string | Uint8Array,
+          fileKeys: Vec<H256> | (H256 | string | Uint8Array)[],
           bspId: Option<H256> | null | Uint8Array | H256 | string,
           forestProof: SpTrieStorageProofCompactProof | { encodedNodes?: any } | string | Uint8Array
         ) => SubmittableExtrinsic<ApiType>,
-        [H256, Option<H256>, SpTrieStorageProofCompactProof]
+        [Vec<H256>, Option<H256>, SpTrieStorageProofCompactProof]
       >;
       /**
        * Issue a new storage request for a file