@storagehub/api-augment 0.2.14 → 0.4.0

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

@@ -456,6 +456,10 @@ declare module "@polkadot/api-base/types/errors" {
        * A SP tried to stop storing files from a user that was supposedly insolvent, but the user is not insolvent.
        **/
       UserNotInsolvent: AugmentedError<ApiType>;
+      /**
+       * Operation is currently paused.
+       **/
+      UserOperationPaused: AugmentedError<ApiType>;
       /**
        * The selected value proposition is not available in the MSP.
        **/

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

@@ -647,6 +647,14 @@ declare module "@polkadot/api-base/types/events" {
         [actualUsedCapacity: u64],
         { actualUsedCapacity: u64 }
       >;
+      /**
+       * Notifies that the user operation pause flags have been updated.
+       **/
+      UserOperationPauseFlagsUpdated: AugmentedEvent<
+        ApiType,
+        [old: u32, new_: u32],
+        { old: u32; new_: u32 }
+      >;
       /**
        * Generic event
        **/

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

@@ -603,6 +603,18 @@ declare module "@polkadot/api-base/types/storage" {
         [H256]
       > &
         QueryableStorageEntry<ApiType, [H256]>;
+      /**
+       * Bitmask controlling which user operations are currently paused.
+       *
+       * When a particular bit is set in this mask, the corresponding user operation in this pallet
+       * is considered paused and should fail with [`Error::UserOperationPaused`].
+       *
+       * By default this is initialised to [`UserOperationPauseFlags::NONE`], meaning no operations
+       * are paused. Governance (for example via sudo) can update it using the
+       * `set_user_operation_pause_flags` extrinsic.
+       **/
+      userOperationPauseFlagsStorage: AugmentedQuery<ApiType, () => Observable<u32>, []> &
+        QueryableStorageEntry<ApiType, []>;
       /**
        * Generic query
        **/

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

@@ -406,6 +406,10 @@ declare module "@polkadot/api-base/types/calls" {
           encodedEventInfo: Bytes | string | Uint8Array
         ) => Observable<Result<BucketId, GenericApplyDeltaEventInfoError>>
       >;
+      /**
+       * Get the maximum batch size for confirm storage requests.
+       **/
+      getMaxBatchConfirmStorageRequests: AugmentedCall<ApiType, () => Observable<u32>>;
       /**
        * Check if a storage request is open to volunteers.
        **/
@@ -487,6 +491,16 @@ declare module "@polkadot/api-base/types/calls" {
           fileKey: H256 | string | Uint8Array
         ) => Observable<Result<Vec<ChunkId>, QueryMspConfirmChunksToProveForFileError>>
       >;
+      /**
+       * Query the file keys that a BSP still needs to confirm storing after volunteering.
+       **/
+      queryPendingBspConfirmStorageRequests: AugmentedCall<
+        ApiType,
+        (
+          bspId: BackupStorageProviderId | string | Uint8Array,
+          fileKeys: Vec<H256> | (H256 | string | Uint8Array)[]
+        ) => Observable<Vec<H256>>
+      >;
       /**
        * Get the storage requests for a given MSP.
        **/

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

@@ -755,6 +755,19 @@ declare module "@polkadot/api-base/types/submittable" {
         (fileKey: H256 | string | Uint8Array) => SubmittableExtrinsic<ApiType>,
         [H256]
       >;
+      /**
+       * Set the pause flags that control which user operations are currently allowed.
+       *
+       * This extrinsic can only be called by `Root` (for example via `pallet-sudo` or governance).
+       * Passing [`UserOperationPauseFlags::NONE`] unpauses all operations, while setting one or more
+       * bits in the flags pauses the corresponding user operations.
+       *
+       * This call replaces the entire bitmask in storage with the provided value.
+       **/
+      setUserOperationPauseFlags: AugmentedSubmittable<
+        (newFlags: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>,
+        [u32]
+      >;
       /**
        * Executed by a SP to stop storing a file from an insolvent user.
        *