@polkadot/api-augment 15.9.3 → 15.10.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,7 +7,7 @@ import type { Extrinsic } from '@polkadot/types/interfaces/extrinsics';
7
7
  import type { OpaqueMetadata } from '@polkadot/types/interfaces/metadata';
8
8
  import type { ParaId, ValidationCodeHash } from '@polkadot/types/interfaces/parachains';
9
9
  import type { AccountId32, H256, RuntimeCall, Slot } from '@polkadot/types/interfaces/runtime';
10
- import type { PalletTransactionPaymentFeeDetails, PalletTransactionPaymentRuntimeDispatchInfo, PolkadotCorePrimitivesInboundDownwardMessage, PolkadotCorePrimitivesInboundHrmpMessage, PolkadotPrimitivesV8ApprovalVotingParams, PolkadotPrimitivesV8AsyncBackingAsyncBackingParams, PolkadotPrimitivesV8AsyncBackingBackingState, PolkadotPrimitivesV8CandidateCommitments, PolkadotPrimitivesV8CandidateEvent, PolkadotPrimitivesV8CommittedCandidateReceipt, PolkadotPrimitivesV8CoreState, PolkadotPrimitivesV8DisputeState, PolkadotPrimitivesV8ExecutorParams, PolkadotPrimitivesV8GroupRotationInfo, PolkadotPrimitivesV8OccupiedCoreAssumption, PolkadotPrimitivesV8PersistedValidationData, PolkadotPrimitivesV8PvfCheckStatement, PolkadotPrimitivesV8ScrapedOnChainVotes, PolkadotPrimitivesV8SessionInfo, PolkadotPrimitivesV8SlashingDisputeProof, PolkadotPrimitivesV8SlashingPendingSlashes, PolkadotPrimitivesV8ValidatorAppPublic, PolkadotPrimitivesV8ValidatorAppSignature, PolkadotRuntimeOriginCaller, RelayCommonApisInflationInfo, SpAuthorityDiscoveryAppPublic, SpConsensusBabeAppPublic, SpConsensusBabeBabeConfiguration, SpConsensusBabeEpoch, SpConsensusBeefyDoubleVotingProof, SpConsensusBeefyEcdsaCryptoPublic, SpConsensusBeefyForkVotingProofOpaqueValue, SpConsensusBeefyFutureBlockVotingProof, SpConsensusBeefyMmrBeefyAuthoritySet, SpConsensusBeefyValidatorSet, SpConsensusGrandpaAppPublic, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpCoreCryptoKeyTypeId, SpInherentsCheckInherentsResult, SpInherentsInherentData, SpMmrPrimitivesError, SpMmrPrimitivesLeafProof, SpRuntimeBlock, SpRuntimeDispatchError, SpRuntimeExtrinsicInclusionMode, SpRuntimeHeader, SpRuntimeTransactionValidityTransactionSource, SpRuntimeTransactionValidityTransactionValidityError, SpRuntimeTransactionValidityValidTransaction, SpVersionRuntimeVersion, SpWeightsWeightV2Weight, XcmRuntimeApisConversionsError, XcmRuntimeApisDryRunCallDryRunEffects, XcmRuntimeApisDryRunError, XcmRuntimeApisDryRunXcmDryRunEffects, XcmRuntimeApisFeesError, XcmVersionedAssetId, XcmVersionedAssets, XcmVersionedLocation, XcmVersionedXcm } from '@polkadot/types/lookup';
10
+ import type { PalletTransactionPaymentFeeDetails, PalletTransactionPaymentRuntimeDispatchInfo, PolkadotCorePrimitivesInboundDownwardMessage, PolkadotCorePrimitivesInboundHrmpMessage, PolkadotPrimitivesV8ApprovalVotingParams, PolkadotPrimitivesV8AsyncBackingAsyncBackingParams, PolkadotPrimitivesV8CandidateCommitments, PolkadotPrimitivesV8DisputeState, PolkadotPrimitivesV8ExecutorParams, PolkadotPrimitivesV8GroupRotationInfo, PolkadotPrimitivesV8OccupiedCoreAssumption, PolkadotPrimitivesV8PersistedValidationData, PolkadotPrimitivesV8PvfCheckStatement, PolkadotPrimitivesV8SessionInfo, PolkadotPrimitivesV8SlashingDisputeProof, PolkadotPrimitivesV8SlashingPendingSlashes, PolkadotPrimitivesV8ValidatorAppPublic, PolkadotPrimitivesV8ValidatorAppSignature, PolkadotPrimitivesVstagingAsyncBackingBackingState, PolkadotPrimitivesVstagingCandidateEvent, PolkadotPrimitivesVstagingCommittedCandidateReceiptV2, PolkadotPrimitivesVstagingCoreState, PolkadotPrimitivesVstagingScrapedOnChainVotes, PolkadotRuntimeOriginCaller, RelayCommonApisInflationInfo, SpAuthorityDiscoveryAppPublic, SpConsensusBabeAppPublic, SpConsensusBabeBabeConfiguration, SpConsensusBabeEpoch, SpConsensusBeefyDoubleVotingProof, SpConsensusBeefyEcdsaCryptoPublic, SpConsensusBeefyForkVotingProofOpaqueValue, SpConsensusBeefyFutureBlockVotingProof, SpConsensusBeefyMmrBeefyAuthoritySet, SpConsensusBeefyValidatorSet, SpConsensusGrandpaAppPublic, SpConsensusGrandpaEquivocationProof, SpConsensusSlotsEquivocationProof, SpCoreCryptoKeyTypeId, SpInherentsCheckInherentsResult, SpInherentsInherentData, SpMmrPrimitivesError, SpMmrPrimitivesLeafProof, SpRuntimeBlock, SpRuntimeDispatchError, SpRuntimeExtrinsicInclusionMode, SpRuntimeHeader, SpRuntimeTransactionValidityTransactionSource, SpRuntimeTransactionValidityTransactionValidityError, SpRuntimeTransactionValidityValidTransaction, SpVersionRuntimeVersion, SpWeightsWeightV2Weight, XcmRuntimeApisConversionsError, XcmRuntimeApisDryRunCallDryRunEffects, XcmRuntimeApisDryRunError, XcmRuntimeApisDryRunXcmDryRunEffects, XcmRuntimeApisFeesError, XcmVersionedAssetId, XcmVersionedAssets, XcmVersionedLocation, XcmVersionedXcm } from '@polkadot/types/lookup';
11
11
  import type { IExtrinsic, Observable } from '@polkadot/types/types';
12
12
  export type __AugmentedCall<ApiType extends ApiTypes> = AugmentedCall<ApiType>;
13
13
  export type __DecoratedCallBase<ApiType extends ApiTypes> = DecoratedCallBase<ApiType>;
@@ -191,34 +191,32 @@ declare module '@polkadot/api-base/types/calls' {
191
191
  /** 0x91b1c8b16328eb92/ */
192
192
  dryRunApi: {
193
193
  /**
194
- * Dry run call.
194
+ * Dry run call V2.
195
195
  **/
196
196
  dryRunCall: AugmentedCall<ApiType, (origin: PolkadotRuntimeOriginCaller | {
197
197
  system: any;
198
- } | {
199
- Void: any;
200
198
  } | {
201
199
  Origins: any;
202
200
  } | {
203
201
  ParachainsOrigin: any;
204
202
  } | {
205
203
  XcmPallet: any;
206
- } | string | Uint8Array, call: RuntimeCall | IMethod | string | Uint8Array) => Observable<Result<XcmRuntimeApisDryRunCallDryRunEffects, XcmRuntimeApisDryRunError>>>;
204
+ } | string | Uint8Array, call: RuntimeCall | IMethod | string | Uint8Array, result_xcms_version: u32 | AnyNumber | Uint8Array) => Observable<Result<XcmRuntimeApisDryRunCallDryRunEffects, XcmRuntimeApisDryRunError>>>;
207
205
  /**
208
206
  * Dry run XCM program
209
207
  **/
210
208
  dryRunXcm: AugmentedCall<ApiType, (origin_location: XcmVersionedLocation | {
211
- V2: any;
212
- } | {
213
209
  V3: any;
214
210
  } | {
215
211
  V4: any;
216
- } | string | Uint8Array, xcm: XcmVersionedXcm | {
217
- V2: any;
218
212
  } | {
213
+ V5: any;
214
+ } | string | Uint8Array, xcm: XcmVersionedXcm | {
219
215
  V3: any;
220
216
  } | {
221
217
  V4: any;
218
+ } | {
219
+ V5: any;
222
220
  } | string | Uint8Array) => Observable<Result<XcmRuntimeApisDryRunXcmDryRunEffects, XcmRuntimeApisDryRunError>>>;
223
221
  /**
224
222
  * Generic call
@@ -228,11 +226,11 @@ declare module '@polkadot/api-base/types/calls' {
228
226
  /** 0xfbc577b9d747efd6/ */
229
227
  genesisBuilder: {
230
228
  /**
231
- * Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the, storage.,, In the case of a FRAME-based runtime, this function deserializes the full `RuntimeGenesisConfig` from the given JSON blob and, puts it into the storage. If the provided JSON blob is incorrect or incomplete or the, deserialization fails, an error is returned.,, Please note that provided JSON blob must contain all `RuntimeGenesisConfig` fields, no, defaults will be used.
229
+ * Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the, storage.,, In the case of a FRAME-based runtime, this function deserializes the full, `RuntimeGenesisConfig` from the given JSON blob and puts it into the storage. If the, provided JSON blob is incorrect or incomplete or the deserialization fails, an error, is returned.,, Please note that provided JSON blob must contain all `RuntimeGenesisConfig` fields, no, defaults will be used.
232
230
  **/
233
231
  buildState: AugmentedCall<ApiType, (json: Bytes | string | Uint8Array) => Observable<Result<Null, Text>>>;
234
232
  /**
235
- * Returns a JSON blob representation of the built-in `RuntimeGenesisConfig` identified by, `id`.,, If `id` is `None` the function returns JSON blob representation of the default, `RuntimeGenesisConfig` struct of the runtime. Implementation must provide default, `RuntimeGenesisConfig`.,, Otherwise function returns a JSON representation of the built-in, named, `RuntimeGenesisConfig` preset identified by `id`, or `None` if such preset does not, exist. Returned `Vec<u8>` contains bytes of JSON blob (patch) which comprises a list of, (potentially nested) key-value pairs that are intended for customizing the default, runtime genesis config. The patch shall be merged (rfc7386) with the JSON representation, of the default `RuntimeGenesisConfig` to create a comprehensive genesis config that can, be used in `build_state` method.
233
+ * Returns a JSON blob representation of the built-in `RuntimeGenesisConfig` identified by, `id`.,, If `id` is `None` the function should return JSON blob representation of the default, `RuntimeGenesisConfig` struct of the runtime. Implementation must provide default, `RuntimeGenesisConfig`.,, Otherwise function returns a JSON representation of the built-in, named, `RuntimeGenesisConfig` preset identified by `id`, or `None` if such preset does not, exist. Returned `Vec<u8>` contains bytes of JSON blob (patch) which comprises a list of, (potentially nested) key-value pairs that are intended for customizing the default, runtime genesis config. The patch shall be merged (rfc7386) with the JSON representation, of the default `RuntimeGenesisConfig` to create a comprehensive genesis config that can, be used in `build_state` method.
236
234
  **/
237
235
  getPreset: AugmentedCall<ApiType, (id: Option<Text> | null | Uint8Array | Text | string) => Observable<Option<Bytes>>>;
238
236
  /**
@@ -287,11 +285,11 @@ declare module '@polkadot/api-base/types/calls' {
287
285
  * Converts `Location` to `AccountId`.
288
286
  **/
289
287
  convertLocation: AugmentedCall<ApiType, (location: XcmVersionedLocation | {
290
- V2: any;
291
- } | {
292
288
  V3: any;
293
289
  } | {
294
290
  V4: any;
291
+ } | {
292
+ V5: any;
295
293
  } | string | Uint8Array) => Observable<Result<AccountId32, XcmRuntimeApisConversionsError>>>;
296
294
  /**
297
295
  * Generic call
@@ -363,7 +361,7 @@ declare module '@polkadot/api-base/types/calls' {
363
361
  **/
364
362
  memberNeedsDelegateMigration: AugmentedCall<ApiType, (member: AccountId32 | string | Uint8Array) => Observable<bool>>;
365
363
  /**
366
- * Returns the pending slash for a given pool member.,, If pending slash of the member exceeds `ExistentialDeposit`, it can be reported on, chain.
364
+ * Returns the pending slash for a given pool member.
367
365
  **/
368
366
  memberPendingSlash: AugmentedCall<ApiType, (member: AccountId32 | string | Uint8Array) => Observable<u128>>;
369
367
  /**
@@ -378,6 +376,10 @@ declare module '@polkadot/api-base/types/calls' {
378
376
  * Returns the equivalent balance of `points` for a given pool.
379
377
  **/
380
378
  pointsToBalance: AugmentedCall<ApiType, (pool_id: u32 | AnyNumber | Uint8Array, points: u128 | AnyNumber | Uint8Array) => Observable<u128>>;
379
+ /**
380
+ * Returns the bonded account and reward account associated with the pool_id.
381
+ **/
382
+ poolAccounts: AugmentedCall<ApiType, (pool_id: u32 | AnyNumber | Uint8Array) => Observable<ITuple<[AccountId32, AccountId32]>>>;
381
383
  /**
382
384
  * Total balance contributed to the pool.
383
385
  **/
@@ -429,19 +431,19 @@ declare module '@polkadot/api-base/types/calls' {
429
431
  /**
430
432
  * Yields information on all availability cores as relevant to the child block., Cores are either free or occupied. Free cores can have paras assigned to them.
431
433
  **/
432
- availabilityCores: AugmentedCall<ApiType, () => Observable<Vec<PolkadotPrimitivesV8CoreState>>>;
434
+ availabilityCores: AugmentedCall<ApiType, () => Observable<Vec<PolkadotPrimitivesVstagingCoreState>>>;
433
435
  /**
434
436
  * Get a vector of events concerning candidates that occurred within a block.
435
437
  **/
436
- candidateEvents: AugmentedCall<ApiType, () => Observable<Vec<PolkadotPrimitivesV8CandidateEvent>>>;
438
+ candidateEvents: AugmentedCall<ApiType, () => Observable<Vec<PolkadotPrimitivesVstagingCandidateEvent>>>;
437
439
  /**
438
440
  * Get the receipt of a candidate pending availability. This returns `Some` for any paras, assigned to occupied cores in `availability_cores` and `None` otherwise.
439
441
  **/
440
- candidatePendingAvailability: AugmentedCall<ApiType, (para_id: ParaId | AnyNumber | Uint8Array) => Observable<Option<PolkadotPrimitivesV8CommittedCandidateReceipt>>>;
442
+ candidatePendingAvailability: AugmentedCall<ApiType, (para_id: ParaId | AnyNumber | Uint8Array) => Observable<Option<PolkadotPrimitivesVstagingCommittedCandidateReceiptV2>>>;
441
443
  /**
442
444
  * Elastic scaling support
443
445
  **/
444
- candidatesPendingAvailability: AugmentedCall<ApiType, (para_id: ParaId | AnyNumber | Uint8Array) => Observable<Vec<PolkadotPrimitivesV8CommittedCandidateReceipt>>>;
446
+ candidatesPendingAvailability: AugmentedCall<ApiType, (para_id: ParaId | AnyNumber | Uint8Array) => Observable<Vec<PolkadotPrimitivesVstagingCommittedCandidateReceiptV2>>>;
445
447
  /**
446
448
  * Checks if the given validation outputs pass the acceptance criteria.
447
449
  **/
@@ -488,11 +490,11 @@ declare module '@polkadot/api-base/types/calls' {
488
490
  /**
489
491
  * Scrape dispute relevant from on-chain, backing votes and resolved disputes.
490
492
  **/
491
- onChainVotes: AugmentedCall<ApiType, () => Observable<Option<PolkadotPrimitivesV8ScrapedOnChainVotes>>>;
493
+ onChainVotes: AugmentedCall<ApiType, () => Observable<Option<PolkadotPrimitivesVstagingScrapedOnChainVotes>>>;
492
494
  /**
493
495
  * Returns the state of parachain backing for a given para.
494
496
  **/
495
- paraBackingState: AugmentedCall<ApiType, (_: ParaId | AnyNumber | Uint8Array) => Observable<Option<PolkadotPrimitivesV8AsyncBackingBackingState>>>;
497
+ paraBackingState: AugmentedCall<ApiType, (__runtime_api_generated_name_0__: ParaId | AnyNumber | Uint8Array) => Observable<Option<PolkadotPrimitivesVstagingAsyncBackingBackingState>>>;
496
498
  /**
497
499
  * Yields the persisted validation data for the given `ParaId` along with an assumption that, should be used if the para currently occupies a core.,, Returns `None` if either the para is not registered or the assumption is `Freed`, and the para already occupies a core.
498
500
  **/
@@ -539,6 +541,10 @@ declare module '@polkadot/api-base/types/calls' {
539
541
  * Fetch the validation code used by a para, making the given `OccupiedCoreAssumption`.,, Returns `None` if either the para is not registered or the assumption is `Freed`, and the para already occupies a core.
540
542
  **/
541
543
  validationCode: AugmentedCall<ApiType, (para_id: ParaId | AnyNumber | Uint8Array, assumption: PolkadotPrimitivesV8OccupiedCoreAssumption | 'Included' | 'TimedOut' | 'Free' | number | Uint8Array) => Observable<Option<Bytes>>>;
544
+ /**
545
+ * Retrieve the maximum uncompressed code size.
546
+ **/
547
+ validationCodeBombLimit: AugmentedCall<ApiType, () => Observable<u32>>;
542
548
  /**
543
549
  * Get the validation code from its hash.
544
550
  **/
@@ -667,17 +673,17 @@ declare module '@polkadot/api-base/types/calls' {
667
673
  * Get delivery fees for sending a specific `message` to a `destination`., These always come in a specific asset, defined by the chain.,, # Arguments, * `message`: The message that'll be sent, necessary because most delivery fees are based on the, size of the message., * `destination`: The destination to send the message to. Different destinations may use, different senders that charge different fees.
668
674
  **/
669
675
  queryDeliveryFees: AugmentedCall<ApiType, (destination: XcmVersionedLocation | {
670
- V2: any;
671
- } | {
672
676
  V3: any;
673
677
  } | {
674
678
  V4: any;
675
- } | string | Uint8Array, message: XcmVersionedXcm | {
676
- V2: any;
677
679
  } | {
680
+ V5: any;
681
+ } | string | Uint8Array, message: XcmVersionedXcm | {
678
682
  V3: any;
679
683
  } | {
680
684
  V4: any;
685
+ } | {
686
+ V5: any;
681
687
  } | string | Uint8Array) => Observable<Result<XcmVersionedAssets, XcmRuntimeApisFeesError>>>;
682
688
  /**
683
689
  * Converts a weight into a fee for the specified `AssetId`.,, # Arguments,, * `weight`: convertible `Weight`., * `asset`: `VersionedAssetId`.
@@ -689,16 +695,18 @@ declare module '@polkadot/api-base/types/calls' {
689
695
  V3: any;
690
696
  } | {
691
697
  V4: any;
698
+ } | {
699
+ V5: any;
692
700
  } | string | Uint8Array) => Observable<Result<u128, XcmRuntimeApisFeesError>>>;
693
701
  /**
694
702
  * Returns a weight needed to execute a XCM.,, # Arguments,, * `message`: `VersionedXcm`.
695
703
  **/
696
704
  queryXcmWeight: AugmentedCall<ApiType, (message: XcmVersionedXcm | {
697
- V2: any;
698
- } | {
699
705
  V3: any;
700
706
  } | {
701
707
  V4: any;
708
+ } | {
709
+ V5: any;
702
710
  } | string | Uint8Array) => Observable<Result<SpWeightsWeightV2Weight, XcmRuntimeApisFeesError>>>;
703
711
  /**
704
712
  * Generic call