feat: ✨ Apply Forest root changes to Buckets in Blockchain Service

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

@@ -2125,14 +2125,23 @@ declare module "@polkadot/api-base/types/events" {
        * This is the generic version of [`MutationsAppliedForProvider`](Event::MutationsAppliedForProvider)
        * when [`generic_apply_delta`](ProofsDealerInterface::generic_apply_delta) is used
        * and the root is not necessarily linked to a specific Provider.
+       *
+       * Additional information for context on where the mutations were applied can be provided
+       * by using the `event_info` field.
        **/
       MutationsApplied: AugmentedEvent<
         ApiType,
-        [mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>, oldRoot: H256, newRoot: H256],
+        [
+          mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>,
+          oldRoot: H256,
+          newRoot: H256,
+          eventInfo: Option<Bytes>
+        ],
         {
           mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>;
           oldRoot: H256;
           newRoot: H256;
+          eventInfo: Option<Bytes>;
         }
       >;
       /**
@@ -2245,7 +2254,7 @@ declare module "@polkadot/api-base/types/events" {
     providers: {
       /**
        * Event emitted when a provider has been slashed and they have reached a capacity deficit (i.e. the provider's capacity fell below their used capacity)
-       * signaling the end of the grace period since an automatic top up could not be performed due to insufficient free balance.
+       * signalling the end of the grace period since an automatic top up could not be performed due to insufficient free balance.
        **/
       AwaitingTopUp: AugmentedEvent<
         ApiType,

api-augment/dist/types/interfaces/augment-api-runtime.d.ts

@@ -48,20 +48,23 @@ import type { IExtrinsic, Observable } from "@polkadot/types/types";
 import type {
   BackupStorageProvider,
   BackupStorageProviderId,
+  BucketId,
   ChunkId,
   GetBspInfoError,
   GetChallengePeriodError,
   GetChallengeSeedError,
   GetCheckpointChallengesError,
   GetNextDeadlineTickError,
   GetProofSubmissionRecordError,
+  GetStakeError,
   GetUsersWithDebtOverThresholdError,
   IsStorageRequestOpenToVolunteersError,
   MainStorageProviderId,
   Multiaddresses,
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBucketsForMspError,
   QueryEarliestChangeCapacityBlockError,
   QueryFileEarliestVolunteerBlockError,
   QueryMspConfirmChunksToProveForFileError,
@@ -631,6 +634,15 @@ declare module "@polkadot/api-base/types/calls" {
           bspId: BackupStorageProviderId | string | Uint8Array
         ) => Observable<Result<BackupStorageProvider, GetBspInfoError>>
       >;
+      /**
+       * Get the stake of a BSP.
+       **/
+      getBspStake: AugmentedCall<
+        ApiType,
+        (
+          bspId: BackupStorageProviderId | string | Uint8Array
+        ) => Observable<Result<Balance, GetStakeError>>
+      >;
       /**
        * Get the slashable amount corresponding to the configured max file size.
        **/
@@ -658,6 +670,15 @@ declare module "@polkadot/api-base/types/calls" {
           providerId: ProviderId | string | Uint8Array
         ) => Observable<Result<StorageDataUnit, QueryAvailableStorageCapacityError>>
       >;
+      /**
+       * Get the Buckets that an MSP is storing.
+       **/
+      queryBucketsForMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: MainStorageProviderId | string | Uint8Array
+        ) => Observable<Result<Vec<BucketId>, QueryBucketsForMspError>>
+      >;
       /**
        * Query the earliest block number that a BSP can change its capacity.
        **/

api-augment/dist/types/interfaces/augment-api-tx.d.ts

@@ -3481,7 +3481,7 @@ declare module "@polkadot/api-base/types/submittable" {
        * Notes:
        * - This extrinsic could be called by the user itself or by a third party
        * - The deposit that the user has to pay to register as a SP is held when the user requests to register as a SP
-       * - If this extrinsic is successful, it will be free for the caller, to incentive state debloating
+       * - If this extrinsic is successful, it will be free for the caller, to incentive state de-bloating
        **/
       confirmSignUp: AugmentedSubmittable<
         (

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

@@ -1320,6 +1320,7 @@ import type { Error } from "@polkadot/types/interfaces/xcmRuntimeApi";
 import type {
   BackupStorageProvider,
   BackupStorageProviderId,
+  BucketId,
   CheckpointChallenge,
   ChunkId,
   FileMetadata,
@@ -1330,6 +1331,7 @@ import type {
   GetFileFromFileStorageResult,
   GetNextDeadlineTickError,
   GetProofSubmissionRecordError,
+  GetStakeError,
   GetUsersWithDebtOverThresholdError,
   IncompleteFileStatus,
   IsStorageRequestOpenToVolunteersError,
@@ -1340,6 +1342,7 @@ import type {
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBucketsForMspError,
   QueryConfirmChunksToProveForFileError,
   QueryEarliestChangeCapacityBlockError,
   QueryFileEarliestVolunteerBlockError,
@@ -1503,6 +1506,7 @@ declare module "@polkadot/types/types/registry" {
     BridgedBlockNumber: BridgedBlockNumber;
     BridgedHeader: BridgedHeader;
     BridgeMessageId: BridgeMessageId;
+    BucketId: BucketId;
     BufferedSessionChange: BufferedSessionChange;
     Bytes: Bytes;
     Call: Call;
@@ -1845,6 +1849,7 @@ declare module "@polkadot/types/types/registry" {
     GetFileFromFileStorageResult: GetFileFromFileStorageResult;
     GetNextDeadlineTickError: GetNextDeadlineTickError;
     GetProofSubmissionRecordError: GetProofSubmissionRecordError;
+    GetStakeError: GetStakeError;
     GetUsersWithDebtOverThresholdError: GetUsersWithDebtOverThresholdError;
     GiltBid: GiltBid;
     GlobalValidationData: GlobalValidationData;
@@ -2211,6 +2216,7 @@ declare module "@polkadot/types/types/registry" {
     PvfPrepTimeoutKind: PvfPrepTimeoutKind;
     QueryAvailableStorageCapacityError: QueryAvailableStorageCapacityError;
     QueryBspConfirmChunksToProveForFileError: QueryBspConfirmChunksToProveForFileError;
+    QueryBucketsForMspError: QueryBucketsForMspError;
     QueryConfirmChunksToProveForFileError: QueryConfirmChunksToProveForFileError;
     QueryEarliestChangeCapacityBlockError: QueryEarliestChangeCapacityBlockError;
     QueryFileEarliestVolunteerBlockError: QueryFileEarliestVolunteerBlockError;

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

@@ -1678,6 +1678,7 @@ declare const _default: {
         mutations: string;
         oldRoot: string;
         newRoot: string;
+        eventInfo: string;
       };
       ChallengesTickerSet: {
         paused: string;

api-augment/dist/types/interfaces/storagehubclient/types.d.ts

@@ -24,6 +24,8 @@ export interface BackupStorageProvider extends Struct {
 }
 /** @name BackupStorageProviderId */
 export interface BackupStorageProviderId extends H256 {}
+/** @name BucketId */
+export interface BucketId extends H256 {}
 /** @name CheckpointChallenge */
 export interface CheckpointChallenge extends Struct {
   readonly file_key: H256;
@@ -98,6 +100,12 @@ export interface GetProofSubmissionRecordError extends Enum {
   readonly isInternalApiError: boolean;
   readonly type: "ProviderNotRegistered" | "ProviderNeverSubmittedProof" | "InternalApiError";
 }
+/** @name GetStakeError */
+export interface GetStakeError extends Enum {
+  readonly isProviderNotRegistered: boolean;
+  readonly isInternalError: boolean;
+  readonly type: "ProviderNotRegistered" | "InternalError";
+}
 /** @name GetUsersWithDebtOverThresholdError */
 export interface GetUsersWithDebtOverThresholdError extends Enum {
   readonly isProviderNotRegistered: boolean;
@@ -155,6 +163,12 @@ export interface QueryBspConfirmChunksToProveForFileError extends Enum {
   readonly isInternalError: boolean;
   readonly type: "StorageRequestNotFound" | "ConfirmChunks" | "InternalError";
 }
+/** @name QueryBucketsForMspError */
+export interface QueryBucketsForMspError extends Enum {
+  readonly isProviderNotRegistered: boolean;
+  readonly isInternalError: boolean;
+  readonly type: "ProviderNotRegistered" | "InternalError";
+}
 /** @name QueryConfirmChunksToProveForFileError */
 export interface QueryConfirmChunksToProveForFileError extends Enum {
   readonly isChallengedChunkToChunkIdError: boolean;

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

@@ -2168,6 +2168,7 @@ declare module "@polkadot/types/lookup" {
       readonly mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>;
       readonly oldRoot: H256;
       readonly newRoot: H256;
+      readonly eventInfo: Option<Bytes>;
     } & Struct;
     readonly isChallengesTickerSet: boolean;
     readonly asChallengesTickerSet: {

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

@@ -1647,11 +1647,24 @@ declare module "@polkadot/api-base/types/events" {
        * This is the generic version of [`MutationsAppliedForProvider`](Event::MutationsAppliedForProvider)
        * when [`generic_apply_delta`](ProofsDealerInterface::generic_apply_delta) is used
        * and the root is not necessarily linked to a specific Provider.
+       *
+       * Additional information for context on where the mutations were applied can be provided
+       * by using the `event_info` field.
        **/
       MutationsApplied: AugmentedEvent<
         ApiType,
-        [mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>, oldRoot: H256, newRoot: H256],
-        { mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>; oldRoot: H256; newRoot: H256 }
+        [
+          mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>,
+          oldRoot: H256,
+          newRoot: H256,
+          eventInfo: Option<Bytes>
+        ],
+        {
+          mutations: Vec<ITuple<[H256, ShpTraitsTrieMutation]>>;
+          oldRoot: H256;
+          newRoot: H256;
+          eventInfo: Option<Bytes>;
+        }
       >;
       /**
        * A set of mutations has been applied to the Forest of a given Provider.
@@ -1741,7 +1754,7 @@ declare module "@polkadot/api-base/types/events" {
     providers: {
       /**
        * Event emitted when a provider has been slashed and they have reached a capacity deficit (i.e. the provider's capacity fell below their used capacity)
-       * signaling the end of the grace period since an automatic top up could not be performed due to insufficient free balance.
+       * signalling the end of the grace period since an automatic top up could not be performed due to insufficient free balance.
        **/
       AwaitingTopUp: AugmentedEvent<
         ApiType,

api-augment/src/interfaces/augment-api-runtime.ts

@@ -54,20 +54,23 @@ import type { IExtrinsic, Observable } from "@polkadot/types/types";
 import type {
   BackupStorageProvider,
   BackupStorageProviderId,
+  BucketId,
   ChunkId,
   GetBspInfoError,
   GetChallengePeriodError,
   GetChallengeSeedError,
   GetCheckpointChallengesError,
   GetNextDeadlineTickError,
   GetProofSubmissionRecordError,
+  GetStakeError,
   GetUsersWithDebtOverThresholdError,
   IsStorageRequestOpenToVolunteersError,
   MainStorageProviderId,
   Multiaddresses,
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBucketsForMspError,
   QueryEarliestChangeCapacityBlockError,
   QueryFileEarliestVolunteerBlockError,
   QueryMspConfirmChunksToProveForFileError,
@@ -581,6 +584,15 @@ declare module "@polkadot/api-base/types/calls" {
           bspId: BackupStorageProviderId | string | Uint8Array
         ) => Observable<Result<BackupStorageProvider, GetBspInfoError>>
       >;
+      /**
+       * Get the stake of a BSP.
+       **/
+      getBspStake: AugmentedCall<
+        ApiType,
+        (
+          bspId: BackupStorageProviderId | string | Uint8Array
+        ) => Observable<Result<Balance, GetStakeError>>
+      >;
       /**
        * Get the slashable amount corresponding to the configured max file size.
        **/
@@ -608,6 +620,15 @@ declare module "@polkadot/api-base/types/calls" {
           providerId: ProviderId | string | Uint8Array
         ) => Observable<Result<StorageDataUnit, QueryAvailableStorageCapacityError>>
       >;
+      /**
+       * Get the Buckets that an MSP is storing.
+       **/
+      queryBucketsForMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: MainStorageProviderId | string | Uint8Array
+        ) => Observable<Result<Vec<BucketId>, QueryBucketsForMspError>>
+      >;
       /**
        * Query the earliest block number that a BSP can change its capacity.
        **/

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

@@ -2923,7 +2923,7 @@ declare module "@polkadot/api-base/types/submittable" {
        * Notes:
        * - This extrinsic could be called by the user itself or by a third party
        * - The deposit that the user has to pay to register as a SP is held when the user requests to register as a SP
-       * - If this extrinsic is successful, it will be free for the caller, to incentive state debloating
+       * - If this extrinsic is successful, it will be free for the caller, to incentive state de-bloating
        **/
       confirmSignUp: AugmentedSubmittable<
         (

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

@@ -1326,6 +1326,7 @@ import type { Error } from "@polkadot/types/interfaces/xcmRuntimeApi";
 import type {
   BackupStorageProvider,
   BackupStorageProviderId,
+  BucketId,
   CheckpointChallenge,
   ChunkId,
   FileMetadata,
@@ -1336,6 +1337,7 @@ import type {
   GetFileFromFileStorageResult,
   GetNextDeadlineTickError,
   GetProofSubmissionRecordError,
+  GetStakeError,
   GetUsersWithDebtOverThresholdError,
   IncompleteFileStatus,
   IsStorageRequestOpenToVolunteersError,
@@ -1346,6 +1348,7 @@ import type {
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBucketsForMspError,
   QueryConfirmChunksToProveForFileError,
   QueryEarliestChangeCapacityBlockError,
   QueryFileEarliestVolunteerBlockError,
@@ -1510,6 +1513,7 @@ declare module "@polkadot/types/types/registry" {
     BridgedBlockNumber: BridgedBlockNumber;
     BridgedHeader: BridgedHeader;
     BridgeMessageId: BridgeMessageId;
+    BucketId: BucketId;
     BufferedSessionChange: BufferedSessionChange;
     Bytes: Bytes;
     Call: Call;
@@ -1852,6 +1856,7 @@ declare module "@polkadot/types/types/registry" {
     GetFileFromFileStorageResult: GetFileFromFileStorageResult;
     GetNextDeadlineTickError: GetNextDeadlineTickError;
     GetProofSubmissionRecordError: GetProofSubmissionRecordError;
+    GetStakeError: GetStakeError;
     GetUsersWithDebtOverThresholdError: GetUsersWithDebtOverThresholdError;
     GiltBid: GiltBid;
     GlobalValidationData: GlobalValidationData;
@@ -2218,6 +2223,7 @@ declare module "@polkadot/types/types/registry" {
     PvfPrepTimeoutKind: PvfPrepTimeoutKind;
     QueryAvailableStorageCapacityError: QueryAvailableStorageCapacityError;
     QueryBspConfirmChunksToProveForFileError: QueryBspConfirmChunksToProveForFileError;
+    QueryBucketsForMspError: QueryBucketsForMspError;
     QueryConfirmChunksToProveForFileError: QueryConfirmChunksToProveForFileError;
     QueryEarliestChangeCapacityBlockError: QueryEarliestChangeCapacityBlockError;
     QueryFileEarliestVolunteerBlockError: QueryFileEarliestVolunteerBlockError;

api-augment/src/interfaces/lookup.ts

@@ -1699,7 +1699,8 @@ export default {
       MutationsApplied: {
         mutations: "Vec<(H256,ShpTraitsTrieMutation)>",
         oldRoot: "H256",
-        newRoot: "H256"
+        newRoot: "H256",
+        eventInfo: "Option<Bytes>"
       },
       ChallengesTickerSet: {
         paused: "bool"