@storagehub/api-augment 0.1.0 → 0.2.2

package/dist/types/{interfaces → parachain/interfaces}/augment-api-rpc.d.ts

@@ -19,11 +19,11 @@ import type { MmrHash, MmrLeafBatchProof } from "@polkadot/types/interfaces/mmr"
 import type { StorageKind } from "@polkadot/types/interfaces/offchain";
 import type { FeeDetails, RuntimeDispatchInfoV1 } from "@polkadot/types/interfaces/payment";
 import type { RpcMethods } from "@polkadot/types/interfaces/rpc";
-import type { AccountId, AccountId32, BlockNumber, H160, H256, H64, Hash, Header, Index, Justification, KeyValue, SignedBlock, StorageData } from "@polkadot/types/interfaces/runtime";
+import type { AccountId, BlockNumber, H160, H256, H64, Hash, Header, Index, Justification, KeyValue, SignedBlock, StorageData } from "@polkadot/types/interfaces/runtime";
 import type { MigrationStatusResult, ReadProof, RuntimeVersion, TraceBlockResponse } from "@polkadot/types/interfaces/state";
 import type { ApplyExtrinsicResult, ChainProperties, ChainType, Health, NetworkState, NodeRole, PeerInfo, SyncState } from "@polkadot/types/interfaces/system";
 import type { IExtrinsic, Observable } from "@polkadot/types/types";
-import type { FileMetadata, GetFileFromFileStorageResult, SaveFileToDisk } from "@storagehub/api-augment/interfaces/storagehubclient";
+import type { AddFilesToForestStorageResult, CheckpointChallenge, FileMetadata, GetFileFromFileStorageResult, LoadFileInStorageResult, RemoveFilesFromForestStorageResult, SaveFileToDisk } from "@storagehub/api-augment/parachain/interfaces/storagehubclient";
 export type __AugmentedRpc = AugmentedRpc<() => unknown>;
 declare module "@polkadot/rpc-core/types/jsonrpc" {
     interface RpcInterface {
@@ -467,6 +467,10 @@ 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
              **/
@@ -583,10 +587,39 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
             trieMigrationStatus: AugmentedRpc<(at?: BlockHash | string | Uint8Array) => Observable<MigrationStatusResult>>;
         };
         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.
              **/
             generateForestProof: AugmentedRpc<(forest_key: Option<H256> | null | Uint8Array | H256 | string, 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.
              **/
@@ -594,7 +627,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>>;
+            getForestRoot: AugmentedRpc<(forest_key: Option<H256> | null | Uint8Array | H256 | string) => Observable<Option<H256>>>;
             /**
              * Generate and insert new keys of type BCSV into the keystore.
              **/
@@ -607,14 +640,38 @@ declare module "@polkadot/rpc-core/types/jsonrpc" {
              * Check if a file is in the forest.
              **/
             isFileInForest: AugmentedRpc<(forest_key: Option<H256> | null | Uint8Array | H256 | string, 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.
              **/
-            loadFileInStorage: AugmentedRpc<(file_path: Text | string, location: Text | string, owner: AccountId32 | string | Uint8Array, bucket_id: H256 | string | Uint8Array) => Observable<FileMetadata>>;
+            loadFileInStorage: AugmentedRpc<(file_path: Text | string, location: Text | string, owner_account_id_hex: Text | string, bucket_id: H256 | string | Uint8Array) => 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/dist/types/{interfaces → parachain/interfaces}/augment-api-runtime.d.ts

@@ -1,24 +1,26 @@
 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";
 import type { FeeDetails, RuntimeDispatchInfo } from "@polkadot/types/interfaces/payment";
-import type { AccountId, Balance, Block, BlockNumber, Call, ExtrinsicInclusionMode, H256, Header, Index, KeyTypeId, Slot, SlotDuration, Weight, WeightV2 } from "@polkadot/types/interfaces/runtime";
+import type { AccountId, Balance, Block, BlockNumber, Call, ExtrinsicInclusionMode, H256, Header, Index, KeyTypeId, OriginCaller, RuntimeCall, Slot, SlotDuration, Weight, WeightV2 } from "@polkadot/types/interfaces/runtime";
 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 { XcmVersionedAssetId, XcmVersionedLocation, XcmVersionedXcm } from "@polkadot/types/lookup";
 import type { IExtrinsic, Observable } from "@polkadot/types/types";
-import type { BackupStorageProvider, BackupStorageProviderId, ChunkId, GetBspInfoError, GetChallengePeriodError, GetChallengeSeedError, GetCheckpointChallengesError, GetLastTickProviderSubmittedProofError, GetNextDeadlineTickError, GetUsersWithDebtOverThresholdError, MainStorageProviderId, Multiaddresses, ProviderId, QueryAvailableStorageCapacityError, QueryBspConfirmChunksToProveForFileError, QueryEarliestChangeCapacityBlockError, QueryFileEarliestVolunteerBlockError, QueryMspConfirmChunksToProveForFileError, QueryMspIdOfBucketIdError, QueryProviderMultiaddressesError, QueryStorageProviderCapacityError, RandomnessOutput, StorageDataUnit, StorageProviderId, TrieRemoveMutation } from "@storagehub/api-augment/interfaces/storagehubclient";
+import type { BackupStorageProvider, BackupStorageProviderId, BucketId, ChunkId, GenericApplyDeltaEventInfoError, GetBspInfoError, GetChallengePeriodError, GetChallengeSeedError, GetCheckpointChallengesError, GetNextDeadlineTickError, GetProofSubmissionRecordError, GetStakeError, GetUsersWithDebtOverThresholdError, IncompleteStorageRequestMetadataResponse, IsStorageRequestOpenToVolunteersError, MainStorageProviderId, Multiaddresses, ProviderId, QueryAvailableStorageCapacityError, QueryBspConfirmChunksToProveForFileError, QueryBspsVolunteeredForFileError, QueryBucketsForMspError, QueryBucketsOfUserStoredByMspError, QueryEarliestChangeCapacityBlockError, QueryFileEarliestVolunteerBlockError, QueryIncompleteStorageRequestMetadataError, QueryMspConfirmChunksToProveForFileError, QueryMspIdOfBucketIdError, QueryProviderMultiaddressesError, QueryStorageProviderCapacityError, RandomnessOutput, StorageDataUnit, StorageProviderId, 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>;
 declare module "@polkadot/api-base/types/calls" {
@@ -135,20 +137,85 @@ 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.
              **/
             queryBspConfirmChunksToProveForFile: AugmentedCall<ApiType, (bspId: BackupStorageProviderId | string | Uint8Array, 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.
              **/
             queryEarliestFileVolunteerTick: AugmentedCall<ApiType, (bspId: BackupStorageProviderId | string | Uint8Array, 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.
              **/
             queryMspConfirmChunksToProveForFile: AugmentedCall<ApiType, (mspId: MainStorageProviderId | string | Uint8Array, 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
              **/
@@ -175,11 +242,11 @@ declare module "@polkadot/api-base/types/calls" {
              * Converts `Location` to `AccountId`
              **/
             convertLocation: AugmentedCall<ApiType, (location: XcmVersionedLocation | {
-                V2: any;
-            } | {
                 V3: any;
             } | {
                 V4: any;
+            } | {
+                V5: any;
             } | string | Uint8Array) => Observable<Result<AccountId, Error>>>;
             /**
              * Generic call
@@ -224,6 +291,10 @@ 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.
              **/
@@ -274,11 +345,15 @@ declare module "@polkadot/api-base/types/calls" {
             /**
              * Get the last tick for which the submitter submitted a proof.
              **/
-            getLastTickProviderSubmittedProof: AugmentedCall<ApiType, (providerId: ProviderId | string | Uint8Array) => Observable<Result<BlockNumber, GetLastTickProviderSubmittedProofError>>>;
+            getLastTickProviderSubmittedProof: AugmentedCall<ApiType, (providerId: ProviderId | string | Uint8Array) => Observable<Result<BlockNumber, GetProofSubmissionRecordError>>>;
             /**
              * Get the next deadline tick.
              **/
             getNextDeadlineTick: AugmentedCall<ApiType, (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
              **/
@@ -301,10 +376,18 @@ 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.
              **/
             getBspInfo: AugmentedCall<ApiType, (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.
              **/
@@ -321,6 +404,14 @@ declare module "@polkadot/api-base/types/calls" {
              * Query the available storage capacity.
              **/
             queryAvailableStorageCapacity: AugmentedCall<ApiType, (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.
              **/
@@ -337,6 +428,10 @@ declare module "@polkadot/api-base/types/calls" {
              * Query the storage provider capacity.
              **/
             queryStorageProviderCapacity: AugmentedCall<ApiType, (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
              **/
@@ -421,16 +516,18 @@ declare module "@polkadot/api-base/types/calls" {
                 V3: any;
             } | {
                 V4: any;
+            } | {
+                V5: any;
             } | string | Uint8Array) => Observable<Result<u128, XcmPaymentApiError>>>;
             /**
              *
              **/
             queryXcmWeight: AugmentedCall<ApiType, (message: XcmVersionedXcm | {
-                V2: any;
-            } | {
                 V3: any;
             } | {
                 V4: any;
+            } | {
+                V5: any;
             } | string | Uint8Array) => Observable<Result<WeightV2, XcmPaymentApiError>>>;
             /**
              * Generic call