@storagehub/api-augment 0.2.11 → 0.2.14

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storagehub/api-augment",
-  "version": "0.2.11",
+  "version": "0.2.14",
   "description": "",
   "keywords": [],
   "author": "",
@@ -34,7 +34,7 @@
     "@polkadot/types-codec": "^16.4.7",
     "tsx": "4.20.5",
     "typescript": "^5.9.2",
-    "@storagehub/types-bundle": "0.2.8"
+    "@storagehub/types-bundle": "0.2.9"
   },
   "scripts": {
     "scrape": "pnpm tsx scripts/scrapeMetadata.ts",

package/src/parachain/interfaces/augment-api-errors.ts

@@ -162,10 +162,6 @@ declare module "@polkadot/api-base/types/errors" {
       [key: string]: AugmentedError<ApiType>;
     };
     fileSystem: {
-      /**
-       * BSP did not succeed threshold check.
-       **/
-      AboveThreshold: AugmentedError<ApiType>;
       /**
        * Batch file deletion must contain files from a single bucket only.
        **/
@@ -174,18 +170,10 @@ declare module "@polkadot/api-base/types/errors" {
        * BSP has already confirmed storing the given file.
        **/
       BspAlreadyConfirmed: AugmentedError<ApiType>;
-      /**
-       * BSP is already a data server for the move bucket request.
-       **/
-      BspAlreadyDataServer: AugmentedError<ApiType>;
       /**
        * BSP already volunteered to store the given file.
        **/
       BspAlreadyVolunteered: AugmentedError<ApiType>;
-      /**
-       * Too many registered data servers for the move bucket request.
-       **/
-      BspDataServersExceeded: AugmentedError<ApiType>;
       /**
        * BSP has not confirmed storing the given file.
        **/
@@ -202,10 +190,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Action not allowed while the bucket is being moved.
        **/
       BucketIsBeingMoved: AugmentedError<ApiType>;
-      /**
-       * Bucket is not private. Call `update_bucket_privacy` to make it private.
-       **/
-      BucketIsNotPrivate: AugmentedError<ApiType>;
       /**
        * Bucket is not empty.
        **/
@@ -222,10 +206,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Collection ID was not found.
        **/
       CollectionNotFound: AugmentedError<ApiType>;
-      /**
-       * Divided by 0
-       **/
-      DividedByZero: AugmentedError<ApiType>;
       /**
        * Duplicate file key detected within the same batch deletion request.
        **/
@@ -250,18 +230,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Failed to create file metadata
        **/
       FailedToCreateFileMetadata: AugmentedError<ApiType>;
-      /**
-       * Failed to decode threshold.
-       **/
-      FailedToDecodeThreshold: AugmentedError<ApiType>;
-      /**
-       * Failed to encode BSP id as slice.
-       **/
-      FailedToEncodeBsp: AugmentedError<ApiType>;
-      /**
-       * Failed to encode fingerprint as slice.
-       **/
-      FailedToEncodeFingerprint: AugmentedError<ApiType>;
       /**
        * Failed to get owner account of ID of provider
        **/
@@ -286,10 +254,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Failed to query earliest volunteer tick
        **/
       FailedToQueryEarliestFileVolunteerTick: AugmentedError<ApiType>;
-      /**
-       * Failed to convert to primitive type.
-       **/
-      FailedTypeConversion: AugmentedError<ApiType>;
       /**
        * File has an active storage request and as such is not eligible for deletion.
        * The user should use the `revoke_storage_request` extrinsic to revoke it first.
@@ -299,18 +263,6 @@ declare module "@polkadot/api-base/types/errors" {
        * File has an `IncompleteStorageRequest` associated with it and as such is not eligible for a new storage request
        **/
       FileHasIncompleteStorageRequest: AugmentedError<ApiType>;
-      /**
-       * File key already pending deletion.
-       **/
-      FileKeyAlreadyPendingDeletion: AugmentedError<ApiType>;
-      /**
-       * File key computed from metadata doesn't match the provided file key.
-       **/
-      FileKeyMismatch: AugmentedError<ApiType>;
-      /**
-       * File key not found in pending deletion requests.
-       **/
-      FileKeyNotPendingDeletion: AugmentedError<ApiType>;
       /**
        * The bounded vector that holds file metadata to process it is full but there's still more to process.
        **/
@@ -323,10 +275,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Failed to fetch the rate for the payment stream.
        **/
       FixedRatePaymentStreamNotFound: AugmentedError<ApiType>;
-      /**
-       * Forest proof verification failed.
-       **/
-      ForestProofVerificationFailed: AugmentedError<ApiType>;
       /**
        * Failed to get value when just checked it existed.
        **/
@@ -335,10 +283,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Incomplete storage request not found.
        **/
       IncompleteStorageRequestNotFound: AugmentedError<ApiType>;
-      /**
-       * Key already exists in mapping when it should not.
-       **/
-      InconsistentStateKeyAlreadyExists: AugmentedError<ApiType>;
       /**
        * SP does not have enough storage capacity to store the file.
        **/
@@ -363,23 +307,11 @@ declare module "@polkadot/api-base/types/errors" {
        * Invalid signed operation provided.
        **/
       InvalidSignedOperation: AugmentedError<ApiType>;
-      /**
-       * Maximum threshold cannot be zero.
-       **/
-      MaximumThresholdCannotBeZero: AugmentedError<ApiType>;
-      /**
-       * Max replication target cannot be smaller than default replication target.
-       **/
-      MaxReplicationTargetSmallerThanDefault: AugmentedError<ApiType>;
       /**
        * Error created in 2024. If you see this, you are well beyond the singularity and should
        * probably stop using this pallet.
        **/
       MaxTickNumberReached: AugmentedError<ApiType>;
-      /**
-       * Max number of user pending deletion requests reached.
-       **/
-      MaxUserPendingDeletionRequestsReached: AugmentedError<ApiType>;
       /**
        * Minimum amount of blocks between the request opening and being able to confirm it not reached.
        **/
@@ -416,10 +348,6 @@ declare module "@polkadot/api-base/types/errors" {
        * No global reputation weight set.
        **/
       NoGlobalReputationWeightSet: AugmentedError<ApiType>;
-      /**
-       * Privacy update results in no change
-       **/
-      NoPrivacyChange: AugmentedError<ApiType>;
       /**
        * Account is not a BSP.
        **/
@@ -436,10 +364,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Operation failed because the account is not the owner of the bucket.
        **/
       NotBucketOwner: AugmentedError<ApiType>;
-      /**
-       * Unauthorized operation, signer does not own the file.
-       **/
-      NotFileOwner: AugmentedError<ApiType>;
       /**
        * The MSP is trying to confirm to store a file from a storage request is not the one selected to store it.
        **/
@@ -448,10 +372,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Operations not allowed for insolvent provider
        **/
       OperationNotAllowedForInsolventProvider: AugmentedError<ApiType>;
-      /**
-       * Operations not allowed while bucket is not being stored by an MSP
-       **/
-      OperationNotAllowedWhileBucketIsNotStoredByMsp: AugmentedError<ApiType>;
       /**
        * Certain operations (such as issuing new storage requests) are not allowed when interacting with insolvent users.
        **/
@@ -468,10 +388,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Provider is not storing the file.
        **/
       ProviderNotStoringFile: AugmentedError<ApiType>;
-      /**
-       * Root of the provider not found.
-       **/
-      ProviderRootNotFound: AugmentedError<ApiType>;
       /**
        * Replication target cannot be zero.
        **/
@@ -500,10 +416,6 @@ declare module "@polkadot/api-base/types/errors" {
        * Operation not allowed while the storage request exists.
        **/
       StorageRequestExists: AugmentedError<ApiType>;
-      /**
-       * No slot available found in ticks to insert storage request expiration time.
-       **/
-      StorageRequestExpiredNoSlotAvailable: AugmentedError<ApiType>;
       /**
        * Not authorized to delete the storage request.
        **/
@@ -512,34 +424,14 @@ declare module "@polkadot/api-base/types/errors" {
        * Storage request not registered for the given file.
        **/
       StorageRequestNotFound: AugmentedError<ApiType>;
-      /**
-       * Operation not allowed while the storage request is not being revoked.
-       **/
-      StorageRequestNotRevoked: AugmentedError<ApiType>;
       /**
        * Arithmetic error in threshold calculation.
        **/
       ThresholdArithmeticError: AugmentedError<ApiType>;
-      /**
-       * BSPs assignment threshold cannot be below asymptote.
-       **/
-      ThresholdBelowAsymptote: AugmentedError<ApiType>;
-      /**
-       * Tick range to maximum threshold cannot be zero.
-       **/
-      TickRangeToMaximumThresholdCannotBeZero: AugmentedError<ApiType>;
-      /**
-       * Too many batch responses to process.
-       **/
-      TooManyBatchResponses: AugmentedError<ApiType>;
       /**
        * Too many storage request responses.
        **/
       TooManyStorageRequestResponses: AugmentedError<ApiType>;
-      /**
-       * Number of removed BSPs volunteered from storage request prefix did not match the expected number.
-       **/
-      UnexpectedNumberOfRemovedVolunteeredBsps: AugmentedError<ApiType>;
       /**
        * A SP tried to stop storing files from a user that was supposedly insolvent, but the user is not insolvent.
        **/

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

@@ -26,7 +26,6 @@ import type {
   FrameSupportMessagesProcessMessageError,
   FrameSupportTokensMiscBalanceStatus,
   FrameSystemDispatchEventInfo,
-  PalletFileSystemEitherAccountIdOrMspId,
   PalletFileSystemFileOperationIntention,
   PalletFileSystemRejectedStorageRequestReason,
   PalletNftsAttributeNamespace,
@@ -488,45 +487,6 @@ declare module "@polkadot/api-base/types/events" {
         [who: AccountId32, bucketId: H256, collectionId: Option<u32>, private: bool],
         { who: AccountId32; bucketId: H256; collectionId: Option<u32>; private: bool }
       >;
-      /**
-       * Failed to decrease MSP's used capacity for expired file deletion request
-       **/
-      FailedToDecreaseMspUsedCapacity: AugmentedEvent<
-        ApiType,
-        [
-          user: AccountId32,
-          mspId: H256,
-          fileKey: H256,
-          fileSize: u64,
-          error: SpRuntimeDispatchError
-        ],
-        {
-          user: AccountId32;
-          mspId: H256;
-          fileKey: H256;
-          fileSize: u64;
-          error: SpRuntimeDispatchError;
-        }
-      >;
-      /**
-       * Failed to get the MSP owner of the bucket for an expired file deletion request
-       * This is different from the bucket not having a MSP, which is allowed and won't error
-       **/
-      FailedToGetMspOfBucket: AugmentedEvent<
-        ApiType,
-        [bucketId: H256, error: SpRuntimeDispatchError],
-        { bucketId: H256; error: SpRuntimeDispatchError }
-      >;
-      /**
-       * Notifies that a priority challenge with a trie remove mutation failed to be queued in the `on_idle` hook.
-       * This can happen if the priority challenge queue is full, and the failed challenge should be manually
-       * queued at a later time.
-       **/
-      FailedToQueuePriorityChallenge: AugmentedEvent<
-        ApiType,
-        [fileKey: H256, error: SpRuntimeDispatchError],
-        { fileKey: H256; error: SpRuntimeDispatchError }
-      >;
       /**
        * Event to notify if, in the `on_idle` hook when cleaning up an expired storage request,
        * the return of that storage request's deposit to the user failed.
@@ -536,49 +496,6 @@ declare module "@polkadot/api-base/types/events" {
         [fileKey: H256, owner: AccountId32, amountToReturn: u128, error: SpRuntimeDispatchError],
         { fileKey: H256; owner: AccountId32; amountToReturn: u128; error: SpRuntimeDispatchError }
       >;
-      /**
-       * Event to notify if, in the `on_idle` hook when cleaning up an expired storage request,
-       * the transfer of a part of that storage request's deposit to one of the volunteered BSPs failed.
-       **/
-      FailedToTransferDepositFundsToBsp: AugmentedEvent<
-        ApiType,
-        [
-          fileKey: H256,
-          owner: AccountId32,
-          bspId: H256,
-          amountToTransfer: u128,
-          error: SpRuntimeDispatchError
-        ],
-        {
-          fileKey: H256;
-          owner: AccountId32;
-          bspId: H256;
-          amountToTransfer: u128;
-          error: SpRuntimeDispatchError;
-        }
-      >;
-      /**
-       * Notifies that a file will be deleted.
-       **/
-      FileDeletionRequest: AugmentedEvent<
-        ApiType,
-        [
-          user: AccountId32,
-          fileKey: H256,
-          fileSize: u64,
-          bucketId: H256,
-          mspId: H256,
-          proofOfInclusion: bool
-        ],
-        {
-          user: AccountId32;
-          fileKey: H256;
-          fileSize: u64;
-          bucketId: H256;
-          mspId: H256;
-          proofOfInclusion: bool;
-        }
-      >;
       /**
        * Notifies that a file deletion has been requested.
        * Contains a signed intention that allows any actor to execute the actual deletion.
@@ -601,6 +518,20 @@ declare module "@polkadot/api-base/types/events" {
        * the file key from the BSPs and/or Bucket storing that file from their forest.
        **/
       IncompleteStorageRequest: AugmentedEvent<ApiType, [fileKey: H256], { fileKey: H256 }>;
+      /**
+       * Notifies that an incomplete storage request has been fully cleaned up.
+       *
+       * This event is emitted in two scenarios:
+       * 1. When an incomplete storage request is created but there are no providers to clean
+       * (e.g., MSP confirmed with inclusion proof and no BSPs confirmed).
+       * 2. When the file has been removed from all providers and the incomplete storage
+       * request entry is removed from storage.
+       **/
+      IncompleteStorageRequestCleanedUp: AugmentedEvent<
+        ApiType,
+        [fileKey: H256],
+        { fileKey: H256 }
+      >;
       /**
        * Notifies that a bucket has been moved to a new MSP under a new value proposition.
        **/
@@ -721,36 +652,6 @@ declare module "@polkadot/api-base/types/events" {
           expiresAt: u32;
         }
       >;
-      /**
-       * Notifies that a file key has been queued for a priority challenge for file deletion.
-       **/
-      PriorityChallengeForFileDeletionQueued: AugmentedEvent<
-        ApiType,
-        [issuer: PalletFileSystemEitherAccountIdOrMspId, fileKey: H256],
-        { issuer: PalletFileSystemEitherAccountIdOrMspId; fileKey: H256 }
-      >;
-      /**
-       * Notifies that a proof has been submitted for a pending file deletion request.
-       **/
-      ProofSubmittedForPendingFileDeletionRequest: AugmentedEvent<
-        ApiType,
-        [
-          user: AccountId32,
-          fileKey: H256,
-          fileSize: u64,
-          bucketId: H256,
-          mspId: H256,
-          proofOfInclusion: bool
-        ],
-        {
-          user: AccountId32;
-          fileKey: H256;
-          fileSize: u64;
-          bucketId: H256;
-          mspId: H256;
-          proofOfInclusion: bool;
-        }
-      >;
       /**
        * Notifies that a SP has stopped storing a file because its owner has become insolvent.
        **/

package/src/parachain/interfaces/augment-api-tx.ts

@@ -423,11 +423,31 @@ declare module "@polkadot/api-base/types/submittable" {
     };
     fileSystem: {
       /**
-       * Executed by a BSP to confirm to stop storing a file.
+       * Executed by a BSP to confirm stopping storage of a file and remove it from their forest.
        *
-       * It has to have previously opened a pending stop storing request using the `bsp_request_stop_storing` extrinsic.
-       * The minimum amount of blocks between the request and the confirmation is defined by the runtime, such that the
-       * BSP can't immediately stop storing a file it has previously lost when receiving a challenge for it.
+       * This is the second step of the two-phase stop storing process. The BSP must have previously
+       * called [`bsp_request_stop_storing`] to open a pending stop storing request.
+       *
+       * A minimum waiting period ([`MinWaitForStopStoring`]) must pass between the request and this
+       * confirmation. This prevents a BSP from immediately dropping a file when challenged for it,
+       * ensuring they can't avoid slashing by quickly calling stop storing upon receiving a challenge.
+       *
+       * ## What this extrinsic does
+       *
+       * 1. Verifies the pending stop storing request exists and the minimum wait time has passed
+       * 2. Verifies the file is still in the BSP's forest via the inclusion proof
+       * 3. **Removes the file from the BSP's forest and updates their root**
+       * 4. Decreases the BSP's used capacity
+       * 5. Stops challenge/randomness cycles if the BSP has no more files
+       *
+       * Note: The payment stream was already updated in [`bsp_request_stop_storing`].
+       *
+       * ## Errors
+       *
+       * - [`PendingStopStoringRequestNotFound`]: No pending request exists for this BSP and file
+       * - [`MinWaitForStopStoringNotReached`]: The minimum waiting period hasn't passed yet
+       * - [`OperationNotAllowedWithInsolventUser`]: The file owner is insolvent (the BSP should use
+       * [`stop_storing_for_insolvent_user`] instead)
        **/
       bspConfirmStopStoring: AugmentedSubmittable<
         (
@@ -464,12 +484,45 @@ declare module "@polkadot/api-base/types/submittable" {
       /**
        * Executed by a BSP to request to stop storing a file.
        *
-       * In the event when a storage request no longer exists for the data the BSP no longer stores,
-       * it is required that the BSP still has access to the metadata of the initial storage request.
-       * If they do not, they will at least need that metadata to reconstruct the File ID and from wherever
-       * the BSP gets that data is up to it. One example could be from the assigned MSP.
-       * This metadata is necessary since it is needed to reconstruct the leaf node key in the storage
-       * provider's Merkle Forest.
+       * This is the first step of a two-phase process for a BSP to voluntarily stop storing a file.
+       * The BSP must later call [`bsp_confirm_stop_storing`] after a minimum waiting period to
+       * complete the process and actually remove the file from their forest.
+       *
+       * **Important**: This extrinsic does NOT modify the BSP's forest root. The file remains in the
+       * BSP's forest until [`bsp_confirm_stop_storing`] is called.
+       *
+       * The BSP is required to provide the file metadata (bucket_id, location, owner, fingerprint, size)
+       * to reconstruct and verify the file key. The BSP can get this metadata from its file storage, but
+       * it providing it is not a proof that the BSP actually has the file, since this metadata can be obtained
+       * from the original storage request or from the assigned MSP if the storage request no longer exists.
+       *
+       * ## Behavior based on storage request state
+       *
+       * 1. **Storage request exists and BSP has confirmed storing it**: The BSP is removed from the
+       * storage request's confirmed and volunteered lists and the confirmed/volunteered counts are decremented.
+       * The BSP is also removed from the storage request as a data server.
+       *
+       * 2. **Storage request exists but BSP is not a volunteer**: The `bsps_required` count is
+       * incremented to compensate for the BSP leaving.
+       *
+       * 3. **No storage request exists**: A new storage request is created with `bsps_required = 1`
+       * so another BSP can pick up the file and maintain its replication target. If `can_serve` is true,
+       * the requesting BSP is added as a data server to help the new volunteer download the file.
+       *
+       * ## Fees
+       *
+       * The BSP is charged a penalty fee ([`BspStopStoringFilePenalty`]) which is transferred to the treasury.
+       *
+       * ## Payment Stream
+       *
+       * The payment stream with the file owner is **updated immediately** in this extrinsic (not in
+       * [`bsp_confirm_stop_storing`]). This removes any financial incentive for the BSP to delay or
+       * skip the confirmation, as they stop getting paid as soon as they announce their intent to stop storing.
+       *
+       * ## Restrictions
+       *
+       * This extrinsic will fail with [`FileHasIncompleteStorageRequest`] if an `IncompleteStorageRequest`
+       * exists for the file key. The BSP must wait until fisherman nodes clean up the incomplete request.
        **/
       bspRequestStopStoring: AugmentedSubmittable<
         (

package/src/parachain/interfaces/augment-types.ts

@@ -1401,6 +1401,7 @@ import type {
   LoadFileInStorageResult,
   MainStorageProviderId,
   MerklePatriciaRoot,
+  MspStorageRequestStatus,
   Multiaddresses,
   ProviderId,
   QueryAvailableStorageCapacityError,
@@ -2137,6 +2138,7 @@ declare module "@polkadot/types/types/registry" {
     MomentOf: MomentOf;
     MoreAttestations: MoreAttestations;
     MortalEra: MortalEra;
+    MspStorageRequestStatus: MspStorageRequestStatus;
     MultiAddress: MultiAddress;
     Multiaddresses: Multiaddresses;
     MultiAsset: MultiAsset;