@storagehub/api-augment 0.1.0 → 0.2.2

package/src/{interfaces → parachain/interfaces}/augment-api-rpc.ts

@@ -67,7 +67,6 @@ import type { FeeDetails, RuntimeDispatchInfoV1 } from "@polkadot/types/interfac
 import type { RpcMethods } from "@polkadot/types/interfaces/rpc";
 import type {
   AccountId,
-  AccountId32,
   BlockNumber,
   H160,
   H256,
@@ -98,10 +97,14 @@ import type {
 } from "@polkadot/types/interfaces/system";
 import type { IExtrinsic, Observable } from "@polkadot/types/types";
 import type {
+  AddFilesToForestStorageResult,
+  CheckpointChallenge,
   FileMetadata,
   GetFileFromFileStorageResult,
+  LoadFileInStorageResult,
+  RemoveFilesFromForestStorageResult,
   SaveFileToDisk
-} from "@storagehub/api-augment/interfaces/storagehubclient";
+} from "@storagehub/api-augment/parachain/interfaces/storagehubclient";
 
 export type __AugmentedRpc = AugmentedRpc<() => unknown>;
 
@@ -782,6 +785,15 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
       version: AugmentedRpc<() => Observable<Text>>;
     };
     offchain: {
+      /**
+       * Clear offchain local storage under given key and prefix
+       **/
+      localStorageClear: AugmentedRpc<
+        (
+          kind: StorageKind | "PERSISTENT" | "LOCAL" | number | Uint8Array,
+          key: Bytes | string | Uint8Array
+        ) => Observable<Null>
+      >;
       /**
        * Get offchain local storage under given key and prefix
        **/
@@ -1026,6 +1038,52 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
       >;
     };
     storagehubclient: {
+      /**
+       * Add files to the forest storage. Useful when doing manual maintenance.
+       **/
+      addFilesToForestStorage: AugmentedRpc<
+        (
+          forest_key: Option<H256> | null | Uint8Array | H256 | string,
+          metadata_of_files_to_add:
+            | Vec<FileMetadata>
+            | (
+                | FileMetadata
+                | {
+                    owner?: any;
+                    bucket_id?: any;
+                    location?: any;
+                    file_size?: any;
+                    fingerprint?: any;
+                  }
+                | string
+                | Uint8Array
+              )[]
+        ) => Observable<AddFilesToForestStorageResult>
+      >;
+      /**
+       * Add key to exclude list. Exclude type can be `file`, `user`, `bucket` and `fingerprint`.
+       **/
+      addToExcludeList: AugmentedRpc<
+        (key: H256 | string | Uint8Array, exclude_type: Text | string) => Observable<ITuple<[]>>
+      >;
+      /**
+       * Generate a SCALE-encoded proof for a file key to allow a BSP to confirm storing it.
+       **/
+      generateFileKeyProofBspConfirm: AugmentedRpc<
+        (
+          bsp_id: H256 | string | Uint8Array,
+          file_key: H256 | string | Uint8Array
+        ) => Observable<Bytes>
+      >;
+      /**
+       * Generate a SCALE-encoded proof for a file key to allow a MSP to accept storing it.
+       **/
+      generateFileKeyProofMspAccept: AugmentedRpc<
+        (
+          msp_id: H256 | string | Uint8Array,
+          file_key: H256 | string | Uint8Array
+        ) => Observable<Bytes>
+      >;
       /**
        * Generate a SCALE-encoded proof for a group of file keys that might or might not be in the forest.
        **/
@@ -1035,6 +1093,26 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
           challenged_file_keys: Vec<H256> | (H256 | string | Uint8Array)[]
         ) => Observable<Bytes>
       >;
+      /**
+       * Generate a SCALE-encoded proof for a group of file keys that might or might not be in the forest, alongside their key proofs.
+       **/
+      generateProof: AugmentedRpc<
+        (
+          provider_id: H256 | string | Uint8Array,
+          seed: H256 | string | Uint8Array,
+          checkpoint_challenges:
+            | Option<Vec<CheckpointChallenge>>
+            | null
+            | Uint8Array
+            | Vec<CheckpointChallenge>
+            | (
+                | CheckpointChallenge
+                | { file_key?: any; should_remove_file?: any }
+                | string
+                | Uint8Array
+              )[]
+        ) => Observable<Bytes>
+      >;
       /**
        * Get the metadata of a file from the Forest storage.
        **/
@@ -1048,7 +1126,7 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
        * Get the root of the forest trie.
        **/
       getForestRoot: AugmentedRpc<
-        (forest_key: Option<H256> | null | Uint8Array | H256 | string) => Observable<H256>
+        (forest_key: Option<H256> | null | Uint8Array | H256 | string) => Observable<Option<H256>>
       >;
       /**
        * Generate and insert new keys of type BCSV into the keystore.
@@ -1071,6 +1149,10 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
           file_key: H256 | string | Uint8Array
         ) => Observable<bool>
       >;
+      /**
+       * Check whether this node is currently expecting to receive the given file key
+       **/
+      isFileKeyExpected: AugmentedRpc<(file_key: H256 | string | Uint8Array) => Observable<bool>>;
       /**
        * Load a file in the local storage. This is the first step when uploading a file.
        **/
@@ -1078,14 +1160,50 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
         (
           file_path: Text | string,
           location: Text | string,
-          owner: AccountId32 | string | Uint8Array,
+          owner_account_id_hex: Text | string,
           bucket_id: H256 | string | Uint8Array
-        ) => Observable<FileMetadata>
+        ) => Observable<LoadFileInStorageResult>
+      >;
+      /**
+       * Send a FileKeyProof with one or more chunks to be processed locally by the node
+       **/
+      receiveBackendFileChunks: AugmentedRpc<
+        (
+          file_key: H256 | string | Uint8Array,
+          file_key_proof: Bytes | string | Uint8Array
+        ) => Observable<Bytes>
       >;
       /**
        * Remove keys of BCSV type for the Blockchain Service.
        **/
       removeBcsvKeys: AugmentedRpc<(keystore_path: Text | string) => Observable<ITuple<[]>>>;
+      /**
+       * Remove a list of files from the file storage. Useful when doing manual maintenance.
+       **/
+      removeFilesFromFileStorage: AugmentedRpc<
+        (file_keys: Vec<H256> | (H256 | string | Uint8Array)[]) => Observable<ITuple<[]>>
+      >;
+      /**
+       * Remove files from the forest storage. Useful when doing manual maintenance.
+       **/
+      removeFilesFromForestStorage: AugmentedRpc<
+        (
+          forest_key: Option<H256> | null | Uint8Array | H256 | string,
+          file_keys: Vec<H256> | (H256 | string | Uint8Array)[]
+        ) => Observable<RemoveFilesFromForestStorageResult>
+      >;
+      /**
+       * Remove all files under a prefix from the file storage. Useful when doing manual maintenance.
+       **/
+      removeFilesWithPrefixFromFileStorage: AugmentedRpc<
+        (prefix: H256 | string | Uint8Array) => Observable<ITuple<[]>>
+      >;
+      /**
+       * Remove key from exclude list
+       **/
+      removeFromExcludeList: AugmentedRpc<
+        (key: H256 | string | Uint8Array, exclude_type: Text | string) => Observable<ITuple<[]>>
+      >;
       /**
        * Save a file from the local storage to the disk.
        **/

package/src/{interfaces → parachain/interfaces}/augment-api-runtime.ts

@@ -6,12 +6,27 @@
 import "@polkadot/api-base/types/calls";
 
 import type { ApiTypes, AugmentedCall, DecoratedCallBase } from "@polkadot/api-base/types";
-import type { Bytes, Null, Option, Result, Vec, bool, u128, u32 } from "@polkadot/types-codec";
+import type {
+  BTreeMap,
+  Bytes,
+  Null,
+  Option,
+  Result,
+  Vec,
+  bool,
+  u128,
+  u32
+} from "@polkadot/types-codec";
 import type { AnyNumber, IMethod, ITuple } from "@polkadot/types-codec/types";
 import type { CheckInherentsResult, InherentData } from "@polkadot/types/interfaces/blockbuilder";
 import type { BlockHash } from "@polkadot/types/interfaces/chain";
 import type { AuthorityId } from "@polkadot/types/interfaces/consensus";
 import type { CollationInfo } from "@polkadot/types/interfaces/cumulus";
+import type {
+  CallDryRunEffects,
+  XcmDryRunApiError,
+  XcmDryRunEffects
+} from "@polkadot/types/interfaces/dryRunApi";
 import type { Extrinsic } from "@polkadot/types/interfaces/extrinsics";
 import type { GenesisBuildErr } from "@polkadot/types/interfaces/genesisBuilder";
 import type { OpaqueMetadata } from "@polkadot/types/interfaces/metadata";
@@ -27,6 +42,8 @@ import type {
   Header,
   Index,
   KeyTypeId,
+  OriginCaller,
+  RuntimeCall,
   Slot,
   SlotDuration,
   Weight,
@@ -35,6 +52,7 @@ import type {
 import type { RuntimeVersion } from "@polkadot/types/interfaces/state";
 import type { ApplyExtrinsicResult, Key } from "@polkadot/types/interfaces/system";
 import type { TransactionSource, TransactionValidity } from "@polkadot/types/interfaces/txqueue";
+import type { VersionedMultiLocation, VersionedXcm } from "@polkadot/types/interfaces/xcm";
 import type { XcmPaymentApiError } from "@polkadot/types/interfaces/xcmPaymentApi";
 import type { Error } from "@polkadot/types/interfaces/xcmRuntimeApi";
 import type {
@@ -46,21 +64,30 @@ import type { IExtrinsic, Observable } from "@polkadot/types/types";
 import type {
   BackupStorageProvider,
   BackupStorageProviderId,
+  BucketId,
   ChunkId,
+  GenericApplyDeltaEventInfoError,
   GetBspInfoError,
   GetChallengePeriodError,
   GetChallengeSeedError,
   GetCheckpointChallengesError,
-  GetLastTickProviderSubmittedProofError,
   GetNextDeadlineTickError,
+  GetProofSubmissionRecordError,
+  GetStakeError,
   GetUsersWithDebtOverThresholdError,
+  IncompleteStorageRequestMetadataResponse,
+  IsStorageRequestOpenToVolunteersError,
   MainStorageProviderId,
   Multiaddresses,
   ProviderId,
   QueryAvailableStorageCapacityError,
   QueryBspConfirmChunksToProveForFileError,
+  QueryBspsVolunteeredForFileError,
+  QueryBucketsForMspError,
+  QueryBucketsOfUserStoredByMspError,
   QueryEarliestChangeCapacityBlockError,
   QueryFileEarliestVolunteerBlockError,
+  QueryIncompleteStorageRequestMetadataError,
   QueryMspConfirmChunksToProveForFileError,
   QueryMspIdOfBucketIdError,
   QueryProviderMultiaddressesError,
@@ -68,8 +95,10 @@ import type {
   RandomnessOutput,
   StorageDataUnit,
   StorageProviderId,
-  TrieRemoveMutation
-} from "@storagehub/api-augment/interfaces/storagehubclient";
+  StorageRequestMetadata,
+  TrieRemoveMutation,
+  ValuePropositionWithId
+} from "@storagehub/api-augment/parachain/interfaces/storagehubclient";
 
 export type __AugmentedCall<ApiType extends ApiTypes> = AugmentedCall<ApiType>;
 export type __DecoratedCallBase<ApiType extends ApiTypes> = DecoratedCallBase<ApiType>;
@@ -226,8 +255,81 @@ declare module "@polkadot/api-base/types/calls" {
        **/
       [key: string]: DecoratedCallBase<ApiType>;
     };
+    /** 0x91b1c8b16328eb92/2 */
+    dryRunApi: {
+      /**
+       * Dry run call
+       **/
+      dryRunCall: AugmentedCall<
+        ApiType,
+        (
+          origin: OriginCaller | { System: any } | string | Uint8Array,
+          call: RuntimeCall | IMethod | string | Uint8Array,
+          resultXcmsVersion: u32 | AnyNumber | Uint8Array
+        ) => Observable<Result<CallDryRunEffects, XcmDryRunApiError>>
+      >;
+      /**
+       * Dry run XCM program
+       **/
+      dryRunXcm: AugmentedCall<
+        ApiType,
+        (
+          originLocation:
+            | VersionedMultiLocation
+            | { V0: any }
+            | { V1: any }
+            | { V2: any }
+            | { V3: any }
+            | { V4: any }
+            | { v5: any }
+            | string
+            | Uint8Array,
+          xcm:
+            | VersionedXcm
+            | { V0: any }
+            | { V1: any }
+            | { V2: any }
+            | { V3: any }
+            | { V4: any }
+            | { V5: any }
+            | string
+            | Uint8Array
+        ) => Observable<Result<XcmDryRunEffects, XcmDryRunApiError>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
     /** 0xb9e7717ace5b45cd/1 */
     fileSystemApi: {
+      /**
+       * Decodes the BucketId expected to be found in the event info of a generic apply delta.
+       **/
+      decodeGenericApplyDeltaEventInfo: AugmentedCall<
+        ApiType,
+        (
+          encodedEventInfo: Bytes | string | Uint8Array
+        ) => Observable<Result<BucketId, GenericApplyDeltaEventInfoError>>
+      >;
+      /**
+       * Check if a storage request is open to volunteers.
+       **/
+      isStorageRequestOpenToVolunteers: AugmentedCall<
+        ApiType,
+        (
+          fileKey: H256 | string | Uint8Array
+        ) => Observable<Result<bool, IsStorageRequestOpenToVolunteersError>>
+      >;
+      /**
+       * Get pending storage requests for a Main Storage Provider.
+       **/
+      pendingStorageRequestsByMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: MainStorageProviderId | string | Uint8Array
+        ) => Observable<BTreeMap<H256, StorageRequestMetadata>>
+      >;
       /**
        * Query the chunks that a BSP needs to prove to confirm that it is storing a file.
        **/
@@ -238,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.
        **/
@@ -248,6 +359,20 @@ declare module "@polkadot/api-base/types/calls" {
           fileKey: H256 | string | Uint8Array
         ) => Observable<Result<BlockNumber, QueryFileEarliestVolunteerBlockError>>
       >;
+      /**
+       * Query incomplete storage request metadata for a file key.
+       **/
+      queryIncompleteStorageRequestMetadata: AugmentedCall<
+        ApiType,
+        (
+          fileKey: H256 | string | Uint8Array
+        ) => Observable<
+          Result<
+            IncompleteStorageRequestMetadataResponse,
+            QueryIncompleteStorageRequestMetadataError
+          >
+        >
+      >;
       /**
        * Query the chunks that a MSP needs to prove to confirm that it is storing a file.
        **/
@@ -258,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
        **/
@@ -291,9 +425,9 @@ declare module "@polkadot/api-base/types/calls" {
         (
           location:
             | XcmVersionedLocation
-            | { V2: any }
             | { V3: any }
             | { V4: any }
+            | { V5: any }
             | string
             | Uint8Array
         ) => Observable<Result<AccountId, Error>>
@@ -353,6 +487,13 @@ declare module "@polkadot/api-base/types/calls" {
     };
     /** 0x1078d7ac24a07b0e/1 */
     paymentStreamsApi: {
+      /**
+       * Get the Providers that have at least one payment stream with a specific user.
+       **/
+      getProvidersWithPaymentStreamsWithUser: AugmentedCall<
+        ApiType,
+        (userAccount: AccountId | string | Uint8Array) => Observable<Vec<ProviderId>>
+      >;
       /**
        * Get the payment streams of a provider.
        **/
@@ -446,7 +587,7 @@ declare module "@polkadot/api-base/types/calls" {
         ApiType,
         (
           providerId: ProviderId | string | Uint8Array
-        ) => Observable<Result<BlockNumber, GetLastTickProviderSubmittedProofError>>
+        ) => Observable<Result<BlockNumber, GetProofSubmissionRecordError>>
       >;
       /**
        * Get the next deadline tick.
@@ -457,6 +598,15 @@ declare module "@polkadot/api-base/types/calls" {
           providerId: ProviderId | string | Uint8Array
         ) => Observable<Result<BlockNumber, GetNextDeadlineTickError>>
       >;
+      /**
+       * Get the next tick for which the submitter should submit a proof.
+       **/
+      getNextTickToSubmitProofFor: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<BlockNumber, GetProofSubmissionRecordError>>
+      >;
       /**
        * Generic call
        **/
@@ -487,6 +637,13 @@ declare module "@polkadot/api-base/types/calls" {
     };
     /** 0x966604ffe78eb092/1 */
     storageProvidersApi: {
+      /**
+       * Check if a provider can be deleted.
+       **/
+      canDeleteProvider: AugmentedCall<
+        ApiType,
+        (providerId: ProviderId | string | Uint8Array) => Observable<bool>
+      >;
       /**
        * Get the BSP info for a given BSP ID.
        **/
@@ -496,6 +653,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.
        **/
@@ -523,6 +689,25 @@ 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 buckets stored by an MSP that belong to a specific user.
+       **/
+      queryBucketsOfUserStoredByMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: ProviderId | string | Uint8Array,
+          user: AccountId | string | Uint8Array
+        ) => Observable<Result<Vec<H256>, QueryBucketsOfUserStoredByMspError>>
+      >;
       /**
        * Query the earliest block number that a BSP can change its capacity.
        **/
@@ -559,6 +744,15 @@ declare module "@polkadot/api-base/types/calls" {
           providerId: ProviderId | string | Uint8Array
         ) => Observable<Result<StorageDataUnit, QueryStorageProviderCapacityError>>
       >;
+      /**
+       * Query the value propositions for a MSP.
+       **/
+      queryValuePropositionsForMsp: AugmentedCall<
+        ApiType,
+        (
+          mspId: MainStorageProviderId | string | Uint8Array
+        ) => Observable<Vec<ValuePropositionWithId>>
+      >;
       /**
        * Generic call
        **/
@@ -686,7 +880,7 @@ declare module "@polkadot/api-base/types/calls" {
         ApiType,
         (
           weight: WeightV2 | { refTime?: any; proofSize?: any } | string | Uint8Array,
-          asset: XcmVersionedAssetId | { V3: any } | { V4: any } | string | Uint8Array
+          asset: XcmVersionedAssetId | { V3: any } | { V4: any } | { V5: any } | string | Uint8Array
         ) => Observable<Result<u128, XcmPaymentApiError>>
       >;
       /**
@@ -695,7 +889,7 @@ declare module "@polkadot/api-base/types/calls" {
       queryXcmWeight: AugmentedCall<
         ApiType,
         (
-          message: XcmVersionedXcm | { V2: any } | { V3: any } | { V4: any } | string | Uint8Array
+          message: XcmVersionedXcm | { V3: any } | { V4: any } | { V5: any } | string | Uint8Array
         ) => Observable<Result<WeightV2, XcmPaymentApiError>>
       >;
       /**