@storagehub/api-augment 0.1.0

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

@@ -0,0 +1,707 @@
+// Auto-generated via `yarn polkadot-types-from-chain`, do not edit
+/* eslint-disable */
+
+// import type lookup before we augment - in some environments
+// this is required to allow for ambient/previous definitions
+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 { 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 { 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 { 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 { 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";
+
+export type __AugmentedCall<ApiType extends ApiTypes> = AugmentedCall<ApiType>;
+export type __DecoratedCallBase<ApiType extends ApiTypes> = DecoratedCallBase<ApiType>;
+
+declare module "@polkadot/api-base/types/calls" {
+  interface AugmentedCalls<ApiType extends ApiTypes> {
+    /** 0xbc9d89904f5b923f/1 */
+    accountNonceApi: {
+      /**
+       * The API to query account nonce (aka transaction index)
+       **/
+      accountNonce: AugmentedCall<
+        ApiType,
+        (accountId: AccountId | string | Uint8Array) => Observable<Index>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xdd718d5cc53262d4/1 */
+    auraApi: {
+      /**
+       * Return the current set of authorities.
+       **/
+      authorities: AugmentedCall<ApiType, () => Observable<Vec<AuthorityId>>>;
+      /**
+       * Returns the slot duration for Aura.
+       **/
+      slotDuration: AugmentedCall<ApiType, () => Observable<SlotDuration>>;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xd7bdd8a272ca0d65/1 */
+    auraUnincludedSegmentApi: {
+      /**
+       * Whether it is legal to extend the chain
+       **/
+      canBuildUpon: AugmentedCall<
+        ApiType,
+        (
+          includedHash: BlockHash | string | Uint8Array,
+          slot: Slot | AnyNumber | Uint8Array
+        ) => Observable<bool>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x40fe3ad401f8959a/6 */
+    blockBuilder: {
+      /**
+       * Apply the given extrinsic.
+       **/
+      applyExtrinsic: AugmentedCall<
+        ApiType,
+        (
+          extrinsic: Extrinsic | IExtrinsic | string | Uint8Array
+        ) => Observable<ApplyExtrinsicResult>
+      >;
+      /**
+       * Check that the inherents are valid.
+       **/
+      checkInherents: AugmentedCall<
+        ApiType,
+        (
+          block: Block | { header?: any; extrinsics?: any } | string | Uint8Array,
+          data: InherentData | { data?: any } | string | Uint8Array
+        ) => Observable<CheckInherentsResult>
+      >;
+      /**
+       * Finish the current block.
+       **/
+      finalizeBlock: AugmentedCall<ApiType, () => Observable<Header>>;
+      /**
+       * Generate inherent extrinsics.
+       **/
+      inherentExtrinsics: AugmentedCall<
+        ApiType,
+        (
+          inherent: InherentData | { data?: any } | string | Uint8Array
+        ) => Observable<Vec<Extrinsic>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xea93e3f16f3d6962/2 */
+    collectCollationInfo: {
+      /**
+       * Collect information about a collation.
+       **/
+      collectCollationInfo: AugmentedCall<
+        ApiType,
+        (
+          header:
+            | Header
+            | {
+                parentHash?: any;
+                number?: any;
+                stateRoot?: any;
+                extrinsicsRoot?: any;
+                digest?: any;
+              }
+            | string
+            | Uint8Array
+        ) => Observable<CollationInfo>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xdf6acb689907609b/5 */
+    core: {
+      /**
+       * Execute the given block.
+       **/
+      executeBlock: AugmentedCall<
+        ApiType,
+        (
+          block: Block | { header?: any; extrinsics?: any } | string | Uint8Array
+        ) => Observable<Null>
+      >;
+      /**
+       * Initialize a block with the given header.
+       **/
+      initializeBlock: AugmentedCall<
+        ApiType,
+        (
+          header:
+            | Header
+            | {
+                parentHash?: any;
+                number?: any;
+                stateRoot?: any;
+                extrinsicsRoot?: any;
+                digest?: any;
+              }
+            | string
+            | Uint8Array
+        ) => Observable<ExtrinsicInclusionMode>
+      >;
+      /**
+       * Returns the version of the runtime.
+       **/
+      version: AugmentedCall<ApiType, () => Observable<RuntimeVersion>>;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xb9e7717ace5b45cd/1 */
+    fileSystemApi: {
+      /**
+       * 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 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 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>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xfbc577b9d747efd6/1 */
+    genesisBuilder: {
+      /**
+       * Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the storage.
+       **/
+      buildConfig: AugmentedCall<
+        ApiType,
+        (json: Bytes | string | Uint8Array) => Observable<Result<ITuple<[]>, GenesisBuildErr>>
+      >;
+      /**
+       * Creates the default `RuntimeGenesisConfig` and returns it as a JSON blob.
+       **/
+      createDefaultConfig: AugmentedCall<ApiType, () => Observable<Bytes>>;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x9ffb505aa738d69c/1 */
+    locationToAccountApi: {
+      /**
+       * Converts `Location` to `AccountId`
+       **/
+      convertLocation: AugmentedCall<
+        ApiType,
+        (
+          location:
+            | XcmVersionedLocation
+            | { V2: any }
+            | { V3: any }
+            | { V4: any }
+            | string
+            | Uint8Array
+        ) => Observable<Result<AccountId, Error>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x37e397fc7c91f5e4/2 */
+    metadata: {
+      /**
+       * Returns the metadata of a runtime
+       **/
+      metadata: AugmentedCall<ApiType, () => Observable<OpaqueMetadata>>;
+      /**
+       * Returns the metadata at a given version.
+       **/
+      metadataAtVersion: AugmentedCall<
+        ApiType,
+        (version: u32 | AnyNumber | Uint8Array) => Observable<Option<OpaqueMetadata>>
+      >;
+      /**
+       * Returns the supported metadata versions.
+       **/
+      metadataVersions: AugmentedCall<ApiType, () => Observable<Vec<u32>>>;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xf78b278be53f454c/2 */
+    offchainWorkerApi: {
+      /**
+       * Starts the off-chain task for given block header.
+       **/
+      offchainWorker: AugmentedCall<
+        ApiType,
+        (
+          header:
+            | Header
+            | {
+                parentHash?: any;
+                number?: any;
+                stateRoot?: any;
+                extrinsicsRoot?: any;
+                digest?: any;
+              }
+            | string
+            | Uint8Array
+        ) => Observable<Null>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x1078d7ac24a07b0e/1 */
+    paymentStreamsApi: {
+      /**
+       * Get the payment streams of a provider.
+       **/
+      getUsersOfPaymentStreamsOfProvider: AugmentedCall<
+        ApiType,
+        (providerId: ProviderId | string | Uint8Array) => Observable<Vec<AccountId>>
+      >;
+      /**
+       * Get the users that have a debt to the provider greater than the threshold.
+       **/
+      getUsersWithDebtOverThreshold: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array,
+          threshold: Balance | AnyNumber | Uint8Array
+        ) => Observable<Result<Vec<AccountId>, GetUsersWithDebtOverThresholdError>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x0be7208954c7c6c9/1 */
+    proofsDealerApi: {
+      /**
+       * Get the challenge period for a given Provider.
+       **/
+      getChallengePeriod: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<BlockNumber, GetChallengePeriodError>>
+      >;
+      /**
+       * Get the seed for a given challenge tick.
+       **/
+      getChallengeSeed: AugmentedCall<
+        ApiType,
+        (
+          tick: BlockNumber | AnyNumber | Uint8Array
+        ) => Observable<Result<RandomnessOutput, GetChallengeSeedError>>
+      >;
+      /**
+       * Get challenges from a seed.
+       **/
+      getChallengesFromSeed: AugmentedCall<
+        ApiType,
+        (
+          seed: RandomnessOutput | string | Uint8Array,
+          providerId: ProviderId | string | Uint8Array,
+          count: u32 | AnyNumber | Uint8Array
+        ) => Observable<Vec<Key>>
+      >;
+      /**
+       * Get the checkpoint challenge period.
+       **/
+      getCheckpointChallengePeriod: AugmentedCall<ApiType, () => Observable<BlockNumber>>;
+      /**
+       * Get checkpoint challenges for a given block.
+       **/
+      getCheckpointChallenges: AugmentedCall<
+        ApiType,
+        (
+          tick: BlockNumber | AnyNumber | Uint8Array
+        ) => Observable<
+          Result<Vec<ITuple<[Key, Option<TrieRemoveMutation>]>>, GetCheckpointChallengesError>
+        >
+      >;
+      /**
+       * Get the current tick.
+       **/
+      getCurrentTick: AugmentedCall<ApiType, () => Observable<BlockNumber>>;
+      /**
+       * Get forest challenges from a seed.
+       **/
+      getForestChallengesFromSeed: AugmentedCall<
+        ApiType,
+        (
+          seed: RandomnessOutput | string | Uint8Array,
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Vec<Key>>
+      >;
+      /**
+       * Get the last checkpoint challenge tick.
+       **/
+      getLastCheckpointChallengeTick: AugmentedCall<ApiType, () => Observable<BlockNumber>>;
+      /**
+       * Get the last tick for which the submitter submitted a proof.
+       **/
+      getLastTickProviderSubmittedProof: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<BlockNumber, GetLastTickProviderSubmittedProofError>>
+      >;
+      /**
+       * Get the next deadline tick.
+       **/
+      getNextDeadlineTick: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<BlockNumber, GetNextDeadlineTickError>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xab3c0572291feb8b/1 */
+    sessionKeys: {
+      /**
+       * Decode the given public session keys.
+       **/
+      decodeSessionKeys: AugmentedCall<
+        ApiType,
+        (
+          encoded: Bytes | string | Uint8Array
+        ) => Observable<Option<Vec<ITuple<[Bytes, KeyTypeId]>>>>
+      >;
+      /**
+       * Generate a set of session keys with optionally using the given seed.
+       **/
+      generateSessionKeys: AugmentedCall<
+        ApiType,
+        (seed: Option<Bytes> | null | Uint8Array | Bytes | string) => Observable<Bytes>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x966604ffe78eb092/1 */
+    storageProvidersApi: {
+      /**
+       * Get the BSP info for a given BSP ID.
+       **/
+      getBspInfo: AugmentedCall<
+        ApiType,
+        (
+          bspId: BackupStorageProviderId | string | Uint8Array
+        ) => Observable<Result<BackupStorageProvider, GetBspInfoError>>
+      >;
+      /**
+       * Get the slashable amount corresponding to the configured max file size.
+       **/
+      getSlashAmountPerMaxFileSize: AugmentedCall<ApiType, () => Observable<Balance>>;
+      /**
+       * Get the Storage Provider ID for a given Account ID.
+       **/
+      getStorageProviderId: AugmentedCall<
+        ApiType,
+        (who: AccountId | string | Uint8Array) => Observable<Option<StorageProviderId>>
+      >;
+      /**
+       * Get the worst case scenario slashable amount for a provider.
+       **/
+      getWorstCaseScenarioSlashableAmount: AugmentedCall<
+        ApiType,
+        (providerId: ProviderId | string | Uint8Array) => Observable<Option<Balance>>
+      >;
+      /**
+       * Query the available storage capacity.
+       **/
+      queryAvailableStorageCapacity: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<StorageDataUnit, QueryAvailableStorageCapacityError>>
+      >;
+      /**
+       * Query the earliest block number that a BSP can change its capacity.
+       **/
+      queryEarliestChangeCapacityBlock: AugmentedCall<
+        ApiType,
+        (
+          providerId: BackupStorageProviderId | string | Uint8Array
+        ) => Observable<Result<BlockNumber, QueryEarliestChangeCapacityBlockError>>
+      >;
+      /**
+       * Query the MSP ID of a bucket ID.
+       **/
+      queryMspIdOfBucketId: AugmentedCall<
+        ApiType,
+        (
+          bucketId: H256 | string | Uint8Array
+        ) => Observable<Result<ProviderId, QueryMspIdOfBucketIdError>>
+      >;
+      /**
+       * Query the provider's multiaddresses.
+       **/
+      queryProviderMultiaddresses: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<Multiaddresses, QueryProviderMultiaddressesError>>
+      >;
+      /**
+       * Query the storage provider capacity.
+       **/
+      queryStorageProviderCapacity: AugmentedCall<
+        ApiType,
+        (
+          providerId: ProviderId | string | Uint8Array
+        ) => Observable<Result<StorageDataUnit, QueryStorageProviderCapacityError>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xd2bc9897eed08f15/3 */
+    taggedTransactionQueue: {
+      /**
+       * Validate the transaction.
+       **/
+      validateTransaction: AugmentedCall<
+        ApiType,
+        (
+          source: TransactionSource | "InBlock" | "Local" | "External" | number | Uint8Array,
+          tx: Extrinsic | IExtrinsic | string | Uint8Array,
+          blockHash: BlockHash | string | Uint8Array
+        ) => Observable<TransactionValidity>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x37c8bb1350a9a2a8/4 */
+    transactionPaymentApi: {
+      /**
+       * The transaction fee details
+       **/
+      queryFeeDetails: AugmentedCall<
+        ApiType,
+        (
+          uxt: Extrinsic | IExtrinsic | string | Uint8Array,
+          len: u32 | AnyNumber | Uint8Array
+        ) => Observable<FeeDetails>
+      >;
+      /**
+       * The transaction info
+       **/
+      queryInfo: AugmentedCall<
+        ApiType,
+        (
+          uxt: Extrinsic | IExtrinsic | string | Uint8Array,
+          len: u32 | AnyNumber | Uint8Array
+        ) => Observable<RuntimeDispatchInfo>
+      >;
+      /**
+       * Query the output of the current LengthToFee given some input
+       **/
+      queryLengthToFee: AugmentedCall<
+        ApiType,
+        (length: u32 | AnyNumber | Uint8Array) => Observable<Balance>
+      >;
+      /**
+       * Query the output of the current WeightToFee given some input
+       **/
+      queryWeightToFee: AugmentedCall<
+        ApiType,
+        (
+          weight: Weight | { refTime?: any; proofSize?: any } | string | Uint8Array
+        ) => Observable<Balance>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0xf3ff14d5ab527059/3 */
+    transactionPaymentCallApi: {
+      /**
+       * The call fee details
+       **/
+      queryCallFeeDetails: AugmentedCall<
+        ApiType,
+        (
+          call: Call | IMethod | string | Uint8Array,
+          len: u32 | AnyNumber | Uint8Array
+        ) => Observable<FeeDetails>
+      >;
+      /**
+       * The call info
+       **/
+      queryCallInfo: AugmentedCall<
+        ApiType,
+        (
+          call: Call | IMethod | string | Uint8Array,
+          len: u32 | AnyNumber | Uint8Array
+        ) => Observable<RuntimeDispatchInfo>
+      >;
+      /**
+       * Query the output of the current LengthToFee given some input
+       **/
+      queryLengthToFee: AugmentedCall<
+        ApiType,
+        (length: u32 | AnyNumber | Uint8Array) => Observable<Balance>
+      >;
+      /**
+       * Query the output of the current WeightToFee given some input
+       **/
+      queryWeightToFee: AugmentedCall<
+        ApiType,
+        (
+          weight: Weight | { refTime?: any; proofSize?: any } | string | Uint8Array
+        ) => Observable<Balance>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+    /** 0x6ff52ee858e6c5bd/1 */
+    xcmPaymentApi: {
+      /**
+       * The API to query acceptable payment assets
+       **/
+      queryAcceptablePaymentAssets: AugmentedCall<
+        ApiType,
+        (
+          version: u32 | AnyNumber | Uint8Array
+        ) => Observable<Result<Vec<XcmVersionedAssetId>, XcmPaymentApiError>>
+      >;
+      /**
+       *
+       **/
+      queryWeightToAssetFee: AugmentedCall<
+        ApiType,
+        (
+          weight: WeightV2 | { refTime?: any; proofSize?: any } | string | Uint8Array,
+          asset: XcmVersionedAssetId | { V3: any } | { V4: any } | string | Uint8Array
+        ) => Observable<Result<u128, XcmPaymentApiError>>
+      >;
+      /**
+       *
+       **/
+      queryXcmWeight: AugmentedCall<
+        ApiType,
+        (
+          message: XcmVersionedXcm | { V2: any } | { V3: any } | { V4: any } | string | Uint8Array
+        ) => Observable<Result<WeightV2, XcmPaymentApiError>>
+      >;
+      /**
+       * Generic call
+       **/
+      [key: string]: DecoratedCallBase<ApiType>;
+    };
+  } // AugmentedCalls
+} // declare module