@storagehub/api-augment 0.2.1 → 0.2.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storagehub/api-augment",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "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.1"
+    "@storagehub/types-bundle": "0.2.3"
   },
   "scripts": {
     "scrape": "pnpm tsx scripts/scrapeMetadata.ts",

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

@@ -799,8 +799,8 @@ declare module "@polkadot/api-base/types/events" {
       /**
        * Notifies that a storage request has either been directly rejected by the MSP or
        * the MSP did not respond to the storage request in time.
-       * Note: There might be BSPs that have volunteered and confirmed the file already, for
-       * which a priority challenge to delete the file will be issued.
+       * 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,
@@ -809,8 +809,8 @@ declare module "@polkadot/api-base/types/events" {
       >;
       /**
        * Notifies that a storage request has been revoked by the user who initiated it.
-       * Note: the BSPs who confirmed the file are also issued a priority challenge to delete the
-       * file.
+       * 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.
        **/
       StorageRequestRevoked: AugmentedEvent<ApiType, [fileKey: H256], { fileKey: H256 }>;
       /**

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

@@ -101,8 +101,10 @@ import type {
   CheckpointChallenge,
   FileMetadata,
   GetFileFromFileStorageResult,
+  GetValuePropositionsResult,
   LoadFileInStorageResult,
   RemoveFilesFromForestStorageResult,
+  RpcProviderId,
   SaveFileToDisk
 } from "@storagehub/api-augment/parachain/interfaces/storagehubclient";
 
@@ -1128,6 +1130,14 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
       getForestRoot: AugmentedRpc<
         (forest_key: Option<H256> | null | Uint8Array | H256 | string) => Observable<Option<H256>>
       >;
+      /**
+       * Get the provider ID of the current node, if any.
+       **/
+      getProviderId: AugmentedRpc<() => Observable<RpcProviderId>>;
+      /**
+       * Get the value propositions of the node if it's an MSP; otherwise a NotAnMsp/Error enum.
+       **/
+      getValuePropositions: AugmentedRpc<() => Observable<GetValuePropositionsResult>>;
       /**
        * Generate and insert new keys of type BCSV into the keystore.
        **/

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

@@ -82,6 +82,7 @@ import type {
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBspsVolunteeredForFileError,
   QueryBucketsForMspError,
   QueryBucketsOfUserStoredByMspError,
   QueryEarliestChangeCapacityBlockError,
@@ -339,6 +340,15 @@ declare module "@polkadot/api-base/types/calls" {
           fileKey: H256 | string | Uint8Array
         ) => Observable<Result<Vec<ChunkId>, QueryBspConfirmChunksToProveForFileError>>
       >;
+      /**
+       * Query the BSPs that volunteered for a file.
+       **/
+      queryBspsVolunteeredForFile: AugmentedCall<
+        ApiType,
+        (
+          fileKey: H256 | string | Uint8Array
+        ) => Observable<Result<Vec<BackupStorageProviderId>, QueryBspsVolunteeredForFileError>>
+      >;
       /**
        * Query the earliest tick number that a BSP can volunteer for a file.
        **/
@@ -373,6 +383,15 @@ declare module "@polkadot/api-base/types/calls" {
           fileKey: H256 | string | Uint8Array
         ) => Observable<Result<Vec<ChunkId>, QueryMspConfirmChunksToProveForFileError>>
       >;
+      /**
+       * Get the storage requests for a given MSP.
+       **/
+      storageRequestsByMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: MainStorageProviderId | string | Uint8Array
+        ) => Observable<BTreeMap<H256, StorageRequestMetadata>>
+      >;
       /**
        * Generic call
        **/

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

@@ -1394,6 +1394,7 @@ import type {
   GetProofSubmissionRecordError,
   GetStakeError,
   GetUsersWithDebtOverThresholdError,
+  GetValuePropositionsResult,
   IncompleteFileStatus,
   IncompleteStorageRequestMetadataResponse,
   IsStorageRequestOpenToVolunteersError,
@@ -1404,6 +1405,7 @@ import type {
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBspsVolunteeredForFileError,
   QueryBucketsForMspError,
   QueryBucketsOfUserStoredByMspError,
   QueryConfirmChunksToProveForFileError,
@@ -1417,6 +1419,7 @@ import type {
   RandomnessOutput,
   RemoveFilesFromForestStorageResult,
   ReputationWeightType,
+  RpcProviderId,
   SaveFileToDisk,
   ShouldRemoveFile,
   StorageDataUnit,
@@ -1937,6 +1940,7 @@ declare module "@polkadot/types/types/registry" {
     GetProofSubmissionRecordError: GetProofSubmissionRecordError;
     GetStakeError: GetStakeError;
     GetUsersWithDebtOverThresholdError: GetUsersWithDebtOverThresholdError;
+    GetValuePropositionsResult: GetValuePropositionsResult;
     GiltBid: GiltBid;
     GlobalValidationData: GlobalValidationData;
     GlobalValidationSchedule: GlobalValidationSchedule;
@@ -2325,6 +2329,7 @@ declare module "@polkadot/types/types/registry" {
     PvfPrepTimeoutKind: PvfPrepTimeoutKind;
     QueryAvailableStorageCapacityError: QueryAvailableStorageCapacityError;
     QueryBspConfirmChunksToProveForFileError: QueryBspConfirmChunksToProveForFileError;
+    QueryBspsVolunteeredForFileError: QueryBspsVolunteeredForFileError;
     QueryBucketsForMspError: QueryBucketsForMspError;
     QueryBucketsOfUserStoredByMspError: QueryBucketsOfUserStoredByMspError;
     QueryConfirmChunksToProveForFileError: QueryConfirmChunksToProveForFileError;
@@ -2410,6 +2415,7 @@ declare module "@polkadot/types/types/registry" {
     RoundSnapshot: RoundSnapshot;
     RoundState: RoundState;
     RpcMethods: RpcMethods;
+    RpcProviderId: RpcProviderId;
     RuntimeApiMetadataLatest: RuntimeApiMetadataLatest;
     RuntimeApiMetadataV15: RuntimeApiMetadataV15;
     RuntimeApiMetadataV16: RuntimeApiMetadataV16;

package/src/parachain/interfaces/storagehubclient/types.ts

@@ -156,6 +156,14 @@ export interface GetUsersWithDebtOverThresholdError extends Enum {
     | "InternalApiError";
 }
 
+/** @name GetValuePropositionsResult */
+export interface GetValuePropositionsResult extends Enum {
+  readonly isSuccess: boolean;
+  readonly asSuccess: Vec<Bytes>;
+  readonly isNotAnMsp: boolean;
+  readonly type: "Success" | "NotAnMsp";
+}
+
 /** @name IncompleteFileStatus */
 export interface IncompleteFileStatus extends Struct {
   readonly file_metadata: FileMetadata;
@@ -218,6 +226,13 @@ export interface QueryBspConfirmChunksToProveForFileError extends Enum {
   readonly type: "StorageRequestNotFound" | "ConfirmChunks" | "InternalError";
 }
 
+/** @name QueryBspsVolunteeredForFileError */
+export interface QueryBspsVolunteeredForFileError extends Enum {
+  readonly isStorageRequestNotFound: boolean;
+  readonly isInternalError: boolean;
+  readonly type: "StorageRequestNotFound" | "InternalError";
+}
+
 /** @name QueryBucketsForMspError */
 export interface QueryBucketsForMspError extends Enum {
   readonly isProviderNotRegistered: boolean;
@@ -315,6 +330,16 @@ export interface RemoveFilesFromForestStorageResult extends Enum {
 /** @name ReputationWeightType */
 export interface ReputationWeightType extends u32 {}
 
+/** @name RpcProviderId */
+export interface RpcProviderId extends Enum {
+  readonly isNotAProvider: boolean;
+  readonly isBsp: boolean;
+  readonly asBsp: H256;
+  readonly isMsp: boolean;
+  readonly asMsp: H256;
+  readonly type: "NotAProvider" | "Bsp" | "Msp";
+}
+
 /** @name SaveFileToDisk */
 export interface SaveFileToDisk extends Enum {
   readonly isFileNotFound: boolean;

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

@@ -738,8 +738,8 @@ declare module "@polkadot/api-base/types/events" {
       /**
        * Notifies that a storage request has either been directly rejected by the MSP or
        * the MSP did not respond to the storage request in time.
-       * Note: There might be BSPs that have volunteered and confirmed the file already, for
-       * which a priority challenge to delete the file will be issued.
+       * 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,
@@ -748,8 +748,8 @@ declare module "@polkadot/api-base/types/events" {
       >;
       /**
        * Notifies that a storage request has been revoked by the user who initiated it.
-       * Note: the BSPs who confirmed the file are also issued a priority challenge to delete the
-       * file.
+       * 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.
        **/
       StorageRequestRevoked: AugmentedEvent<ApiType, [fileKey: H256], { fileKey: H256 }>;
       /**

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

@@ -101,8 +101,10 @@ import type {
   CheckpointChallenge,
   FileMetadata,
   GetFileFromFileStorageResult,
+  GetValuePropositionsResult,
   LoadFileInStorageResult,
   RemoveFilesFromForestStorageResult,
+  RpcProviderId,
   SaveFileToDisk
 } from "@storagehub/api-augment/solochain-evm/interfaces/storagehubclient";
 
@@ -1128,6 +1130,14 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
       getForestRoot: AugmentedRpc<
         (forest_key: Option<H256> | null | Uint8Array | H256 | string) => Observable<Option<H256>>
       >;
+      /**
+       * Get the provider ID of the current node, if any.
+       **/
+      getProviderId: AugmentedRpc<() => Observable<RpcProviderId>>;
+      /**
+       * Get the value propositions of the node if it's an MSP; otherwise a NotAnMsp/Error enum.
+       **/
+      getValuePropositions: AugmentedRpc<() => Observable<GetValuePropositionsResult>>;
       /**
        * Generate and insert new keys of type BCSV into the keystore.
        **/

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

@@ -86,6 +86,7 @@ import type {
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBspsVolunteeredForFileError,
   QueryBucketsForMspError,
   QueryBucketsOfUserStoredByMspError,
   QueryEarliestChangeCapacityBlockError,
@@ -433,6 +434,15 @@ declare module "@polkadot/api-base/types/calls" {
           fileKey: H256 | string | Uint8Array
         ) => Observable<Result<Vec<ChunkId>, QueryBspConfirmChunksToProveForFileError>>
       >;
+      /**
+       * Query the BSPs that volunteered for a file.
+       **/
+      queryBspsVolunteeredForFile: AugmentedCall<
+        ApiType,
+        (
+          fileKey: H256 | string | Uint8Array
+        ) => Observable<Result<Vec<BackupStorageProviderId>, QueryBspsVolunteeredForFileError>>
+      >;
       /**
        * Query the earliest tick number that a BSP can volunteer for a file.
        **/
@@ -467,6 +477,15 @@ declare module "@polkadot/api-base/types/calls" {
           fileKey: H256 | string | Uint8Array
         ) => Observable<Result<Vec<ChunkId>, QueryMspConfirmChunksToProveForFileError>>
       >;
+      /**
+       * Get the storage requests for a given MSP.
+       **/
+      storageRequestsByMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: MainStorageProviderId | string | Uint8Array
+        ) => Observable<BTreeMap<H256, StorageRequestMetadata>>
+      >;
       /**
        * Generic call
        **/

package/src/solochain-evm/interfaces/augment-types.ts

@@ -1394,6 +1394,7 @@ import type {
   GetProofSubmissionRecordError,
   GetStakeError,
   GetUsersWithDebtOverThresholdError,
+  GetValuePropositionsResult,
   IncompleteFileStatus,
   IncompleteStorageRequestMetadataResponse,
   IsStorageRequestOpenToVolunteersError,
@@ -1404,6 +1405,7 @@ import type {
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBspsVolunteeredForFileError,
   QueryBucketsForMspError,
   QueryBucketsOfUserStoredByMspError,
   QueryConfirmChunksToProveForFileError,
@@ -1417,6 +1419,7 @@ import type {
   RandomnessOutput,
   RemoveFilesFromForestStorageResult,
   ReputationWeightType,
+  RpcProviderId,
   SaveFileToDisk,
   ShouldRemoveFile,
   StorageDataUnit,
@@ -1937,6 +1940,7 @@ declare module "@polkadot/types/types/registry" {
     GetProofSubmissionRecordError: GetProofSubmissionRecordError;
     GetStakeError: GetStakeError;
     GetUsersWithDebtOverThresholdError: GetUsersWithDebtOverThresholdError;
+    GetValuePropositionsResult: GetValuePropositionsResult;
     GiltBid: GiltBid;
     GlobalValidationData: GlobalValidationData;
     GlobalValidationSchedule: GlobalValidationSchedule;
@@ -2325,6 +2329,7 @@ declare module "@polkadot/types/types/registry" {
     PvfPrepTimeoutKind: PvfPrepTimeoutKind;
     QueryAvailableStorageCapacityError: QueryAvailableStorageCapacityError;
     QueryBspConfirmChunksToProveForFileError: QueryBspConfirmChunksToProveForFileError;
+    QueryBspsVolunteeredForFileError: QueryBspsVolunteeredForFileError;
     QueryBucketsForMspError: QueryBucketsForMspError;
     QueryBucketsOfUserStoredByMspError: QueryBucketsOfUserStoredByMspError;
     QueryConfirmChunksToProveForFileError: QueryConfirmChunksToProveForFileError;
@@ -2410,6 +2415,7 @@ declare module "@polkadot/types/types/registry" {
     RoundSnapshot: RoundSnapshot;
     RoundState: RoundState;
     RpcMethods: RpcMethods;
+    RpcProviderId: RpcProviderId;
     RuntimeApiMetadataLatest: RuntimeApiMetadataLatest;
     RuntimeApiMetadataV15: RuntimeApiMetadataV15;
     RuntimeApiMetadataV16: RuntimeApiMetadataV16;

package/src/solochain-evm/interfaces/storagehubclient/types.ts

@@ -163,6 +163,14 @@ export interface GetUsersWithDebtOverThresholdError extends Enum {
     | "InternalApiError";
 }
 
+/** @name GetValuePropositionsResult */
+export interface GetValuePropositionsResult extends Enum {
+  readonly isSuccess: boolean;
+  readonly asSuccess: Vec<Bytes>;
+  readonly isNotAnMsp: boolean;
+  readonly type: "Success" | "NotAnMsp";
+}
+
 /** @name IncompleteFileStatus */
 export interface IncompleteFileStatus extends Struct {
   readonly file_metadata: FileMetadata;
@@ -228,6 +236,13 @@ export interface QueryBspConfirmChunksToProveForFileError extends Enum {
   readonly type: "StorageRequestNotFound" | "ConfirmChunks" | "InternalError";
 }
 
+/** @name QueryBspsVolunteeredForFileError */
+export interface QueryBspsVolunteeredForFileError extends Enum {
+  readonly isStorageRequestNotFound: boolean;
+  readonly isInternalError: boolean;
+  readonly type: "StorageRequestNotFound" | "InternalError";
+}
+
 /** @name QueryBucketsForMspError */
 export interface QueryBucketsForMspError extends Enum {
   readonly isProviderNotRegistered: boolean;
@@ -325,6 +340,16 @@ export interface RemoveFilesFromForestStorageResult extends Enum {
 /** @name ReputationWeightType */
 export interface ReputationWeightType extends u32 {}
 
+/** @name RpcProviderId */
+export interface RpcProviderId extends Enum {
+  readonly isNotAProvider: boolean;
+  readonly isBsp: boolean;
+  readonly asBsp: H256;
+  readonly isMsp: boolean;
+  readonly asMsp: H256;
+  readonly type: "NotAProvider" | "Bsp" | "Msp";
+}
+
 /** @name SaveFileToDisk */
 export interface SaveFileToDisk extends Enum {
   readonly isFileNotFound: boolean;