@polkadot/api-augment 8.9.2-8 → 8.11.1

package/polkadot/runtime.d.ts

@@ -0,0 +1,388 @@
+import type { ApiTypes } from '@polkadot/api-base/types';
+import type { Bytes, Null, Option, Result, Vec, bool, u32 } from '@polkadot/types-codec';
+import type { AnyNumber, ITuple } from '@polkadot/types-codec/types';
+import type { BabeEquivocationProof, BabeGenesisConfiguration, Epoch, OpaqueKeyOwnershipProof } from '@polkadot/types/interfaces/babe';
+import type { ValidatorSet } from '@polkadot/types/interfaces/beefy';
+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 { Extrinsic } from '@polkadot/types/interfaces/extrinsics';
+import type { AuthorityList, GrandpaEquivocationProof, SetId } from '@polkadot/types/interfaces/grandpa';
+import type { OpaqueMetadata } from '@polkadot/types/interfaces/metadata';
+import type { MmrBatchProof, MmrEncodableOpaqueLeaf, MmrError, MmrLeafIndex, MmrProof } from '@polkadot/types/interfaces/mmr';
+import type { CandidateCommitments, CandidateEvent, CommittedCandidateReceipt, CoreState, GroupRotationInfo, InboundDownwardMessage, InboundHrmpMessage, OccupiedCoreAssumption, ParaId, ParaValidatorIndex, PersistedValidationData, PvfCheckStatement, ScrapedOnChainVotes, SessionInfo, ValidationCode, ValidationCodeHash, ValidatorSignature } from '@polkadot/types/interfaces/parachains';
+import type { FeeDetails, RuntimeDispatchInfo } from '@polkadot/types/interfaces/payment';
+import type { AccountId, Block, Hash, Header, Index, KeyTypeId, Slot, ValidatorId } from '@polkadot/types/interfaces/runtime';
+import type { SessionIndex } from '@polkadot/types/interfaces/session';
+import type { RuntimeVersion } from '@polkadot/types/interfaces/state';
+import type { ApplyExtrinsicResult } from '@polkadot/types/interfaces/system';
+import type { TransactionSource, TransactionValidity } from '@polkadot/types/interfaces/txqueue';
+import type { IExtrinsic, Observable } from '@polkadot/types/types';
+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>;
+        };
+        /** 0x687ad44ad37f03c2/1 */
+        authorityDiscoveryApi: {
+            /**
+             * Retrieve authority identifiers of the current and next authority set.
+             **/
+            authorities: AugmentedCall<ApiType, () => Observable<Vec<AuthorityId>>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
+        /** 0xcbca25e39f142387/2 */
+        babeApi: {
+            /**
+             * Return the genesis configuration for BABE. The configuration is only read on genesis.
+             **/
+            configuration: AugmentedCall<ApiType, () => Observable<BabeGenesisConfiguration>>;
+            /**
+             * Returns information regarding the current epoch.
+             **/
+            currentEpoch: AugmentedCall<ApiType, () => Observable<Epoch>>;
+            /**
+             * Returns the slot that started the current epoch.
+             **/
+            currentEpochStart: AugmentedCall<ApiType, () => Observable<Slot>>;
+            /**
+             * Generates a proof of key ownership for the given authority in the current epoch.
+             **/
+            generateKeyOwnershipProof: AugmentedCall<ApiType, (slot: Slot | AnyNumber | Uint8Array, authorityId: AuthorityId | string | Uint8Array) => Observable<Option<OpaqueKeyOwnershipProof>>>;
+            /**
+             * Returns information regarding the next epoch (which was already previously announced).
+             **/
+            nextEpoch: AugmentedCall<ApiType, () => Observable<Epoch>>;
+            /**
+             * Submits an unsigned extrinsic to report an equivocation.
+             **/
+            submitReportEquivocationUnsignedExtrinsic: AugmentedCall<ApiType, (equivocationProof: BabeEquivocationProof | {
+                offender?: any;
+                slotNumber?: any;
+                firstHeader?: any;
+                secondHeader?: any;
+            } | string | Uint8Array, keyOwnerProof: OpaqueKeyOwnershipProof | string | Uint8Array) => Observable<Option<Null>>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
+        /** 0x49eaaf1b548a0cb0/1 */
+        beefyApi: {
+            /**
+             * Return the current active BEEFY validator set
+             **/
+            validatorSet: AugmentedCall<ApiType, () => Observable<Option<ValidatorSet>>>;
+            /**
+             * 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>;
+        };
+        /** 0xdf6acb689907609b/4 */
+        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<Null>>;
+            /**
+             * Returns the version of the runtime.
+             **/
+            version: AugmentedCall<ApiType, () => Observable<RuntimeVersion>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
+        /** 0xed99c5acb25eedf5/3 */
+        grandpaApi: {
+            /**
+             * Get current GRANDPA authority set id.
+             **/
+            currentSetId: AugmentedCall<ApiType, () => Observable<SetId>>;
+            /**
+             * Generates a proof of key ownership for the given authority in the given set.
+             **/
+            generateKeyOwnershipProof: AugmentedCall<ApiType, (setId: SetId | AnyNumber | Uint8Array, authorityId: AuthorityId | string | Uint8Array) => Observable<Option<OpaqueKeyOwnershipProof>>>;
+            /**
+             * Get the current GRANDPA authorities and weights. This should not change except for when changes are scheduled and the corresponding delay has passed.
+             **/
+            grandpaAuthorities: AugmentedCall<ApiType, () => Observable<AuthorityList>>;
+            /**
+             * Submits an unsigned extrinsic to report an equivocation.
+             **/
+            submitReportEquivocationUnsignedExtrinsic: AugmentedCall<ApiType, (equivocationProof: GrandpaEquivocationProof | {
+                setId?: any;
+                equivocation?: any;
+            } | string | Uint8Array, keyOwnerProof: OpaqueKeyOwnershipProof | string | Uint8Array) => Observable<Option<Null>>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
+        /** 0x37e397fc7c91f5e4/1 */
+        metadata: {
+            /**
+             * Returns the metadata of a runtime
+             **/
+            metadata: AugmentedCall<ApiType, () => Observable<OpaqueMetadata>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
+        /** 0x91d5df18b0d2cf58/1 */
+        mmrApi: {
+            /**
+             * Generate MMR proof for a series of leaves under given indices.
+             **/
+            generateBatchProof: AugmentedCall<ApiType, (leafIndices: Vec<MmrLeafIndex> | (MmrLeafIndex | AnyNumber | Uint8Array)[]) => Observable<Result<ITuple<[Vec<MmrEncodableOpaqueLeaf>, MmrBatchProof]>, MmrError>>>;
+            /**
+             * Generate MMR proof for a leaf under given index.
+             **/
+            generateProof: AugmentedCall<ApiType, (leafIndex: MmrLeafIndex | AnyNumber | Uint8Array) => Observable<Result<ITuple<[MmrEncodableOpaqueLeaf, MmrProof]>, MmrError>>>;
+            /**
+             * Return the on-chain MMR root hash.
+             **/
+            mmrRoot: AugmentedCall<ApiType, () => Observable<Result<Hash, MmrError>>>;
+            /**
+             * Verify MMR proof against on-chain MMR for a batch of leaves.
+             **/
+            verifyBatchProof: AugmentedCall<ApiType, (leaves: Vec<MmrEncodableOpaqueLeaf> | (MmrEncodableOpaqueLeaf | string | Uint8Array)[], proof: MmrBatchProof | {
+                leafIndices?: any;
+                leafCount?: any;
+                items?: any;
+            } | string | Uint8Array) => Observable<Result<ITuple<[]>, MmrError>>>;
+            /**
+             * Verify MMR proof against given root hash or a batch of leaves.
+             **/
+            verifyBatchProofStateless: AugmentedCall<ApiType, (root: Hash | string | Uint8Array, leaves: Vec<MmrEncodableOpaqueLeaf> | (MmrEncodableOpaqueLeaf | string | Uint8Array)[], proof: MmrBatchProof | {
+                leafIndices?: any;
+                leafCount?: any;
+                items?: any;
+            } | string | Uint8Array) => Observable<Result<ITuple<[]>, MmrError>>>;
+            /**
+             * Verify MMR proof against on-chain MMR.
+             **/
+            verifyProof: AugmentedCall<ApiType, (leaf: MmrEncodableOpaqueLeaf | string | Uint8Array, proof: MmrProof | {
+                leafIndex?: any;
+                leafCount?: any;
+                items?: any;
+            } | string | Uint8Array) => Observable<Result<ITuple<[]>, MmrError>>>;
+            /**
+             * Verify MMR proof against given root hash.
+             **/
+            verifyProofStateless: AugmentedCall<ApiType, (root: Hash | string | Uint8Array, leaf: MmrEncodableOpaqueLeaf | string | Uint8Array, proof: MmrProof | {
+                leafIndex?: any;
+                leafCount?: any;
+                items?: any;
+            } | string | Uint8Array) => Observable<Result<ITuple<[]>, MmrError>>>;
+            /**
+             * 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>;
+        };
+        /** 0xaf2c0297a23e6d3d/2 */
+        parachainHost: {
+            /**
+             * Returns the persisted validation data for the given `ParaId` along with the corresponding validation code hash.
+             **/
+            assumedValidationData: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array, hash: Hash | string | Uint8Array) => Observable<Option<ITuple<[PersistedValidationData, ValidationCodeHash]>>>>;
+            /**
+             * Yields information on all availability cores as relevant to the child block.
+             **/
+            availabilityCores: AugmentedCall<ApiType, () => Observable<Vec<CoreState>>>;
+            /**
+             * Get a vector of events concerning candidates that occurred within a block.
+             **/
+            candidateEvents: AugmentedCall<ApiType, () => Observable<Vec<CandidateEvent>>>;
+            /**
+             * Get the receipt of a candidate pending availability.
+             **/
+            candidatePendingAvailability: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array) => Observable<Option<CommittedCandidateReceipt>>>;
+            /**
+             * Checks if the given validation outputs pass the acceptance criteria.
+             **/
+            checkValidationOutputs: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array, outputs: CandidateCommitments | {
+                upwardMessages?: any;
+                horizontalMessages?: any;
+                newValidationCode?: any;
+                headData?: any;
+                processedDownwardMessages?: any;
+                hrmpWatermark?: any;
+            } | string | Uint8Array) => Observable<bool>>;
+            /**
+             * Get all the pending inbound messages in the downward message queue for a para.
+             **/
+            dmqContents: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array) => Observable<Vec<InboundDownwardMessage>>>;
+            /**
+             * Get the contents of all channels addressed to the given recipient.
+             **/
+            inboundHrmpChannelsContents: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array) => Observable<Vec<InboundHrmpMessage>>>;
+            /**
+             * Scrape dispute relevant from on-chain, backing votes and resolved disputes.
+             **/
+            onChainVotes: AugmentedCall<ApiType, () => Observable<Option<ScrapedOnChainVotes>>>;
+            /**
+             * Yields the persisted validation data for the given `ParaId` along with an assumption that should be used if the para currently occupies a core.
+             **/
+            persistedValidationData: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array, assumption: OccupiedCoreAssumption | 'Included,' | 'TimedOut' | 'Free' | number | Uint8Array) => Observable<Option<PersistedValidationData>>>;
+            /**
+             * Returns code hashes of PVFs that require pre-checking by validators in the active set.
+             **/
+            pvfsRequirePrecheck: AugmentedCall<ApiType, () => Observable<Vec<ValidationCodeHash>>>;
+            /**
+             * Returns the session index expected at a child of the block.
+             **/
+            sessionIndexForChild: AugmentedCall<ApiType, () => Observable<SessionIndex>>;
+            /**
+             * Get the session info for the given session, if stored.
+             **/
+            sessionInfo: AugmentedCall<ApiType, (index: SessionIndex | AnyNumber | Uint8Array) => Observable<Option<SessionInfo>>>;
+            /**
+             * Submits a PVF pre-checking statement into the transaction pool.
+             **/
+            submitPvfCheckStatement: AugmentedCall<ApiType, (stmt: PvfCheckStatement | {
+                accept?: any;
+                subject?: any;
+                sessionIndex?: any;
+                validatorIndex?: any;
+            } | string | Uint8Array, signature: ValidatorSignature | string | Uint8Array) => Observable<Null>>;
+            /**
+             * Fetch the validation code used by a para, making the given `OccupiedCoreAssumption`.
+             **/
+            validationCode: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array, assumption: OccupiedCoreAssumption | 'Included,' | 'TimedOut' | 'Free' | number | Uint8Array) => Observable<ValidationCode>>;
+            /**
+             * Get the validation code from its hash.
+             **/
+            validationCodeByHash: AugmentedCall<ApiType, (hash: ValidationCodeHash | string | Uint8Array) => Observable<Option<ValidationCode>>>;
+            /**
+             * Fetch the hash of the validation code used by a para, making the given `OccupiedCoreAssumption`.
+             **/
+            validationCodeHash: AugmentedCall<ApiType, (paraId: ParaId | AnyNumber | Uint8Array, assumption: OccupiedCoreAssumption | 'Included,' | 'TimedOut' | 'Free' | number | Uint8Array) => Observable<Option<ValidationCodeHash>>>;
+            /**
+             * Returns the validator groups and rotation info localized based on the hypothetical child of a block whose state  this is invoked on
+             **/
+            validatorGroups: AugmentedCall<ApiType, () => Observable<ITuple<[Vec<Vec<ParaValidatorIndex>>, GroupRotationInfo]>>>;
+            /**
+             * Get the current validators.
+             **/
+            validators: AugmentedCall<ApiType, () => Observable<Vec<ValidatorId>>>;
+            /**
+             * 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 | object | string | Uint8Array) => Observable<Bytes>>;
+            /**
+             * 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/1 */
+        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>>;
+            /**
+             * Generic call
+             **/
+            [key: string]: DecoratedCallBase<ApiType>;
+        };
+    }
+}

package/polkadot/runtime.js

@@ -0,0 +1 @@
+export {};

package/polkadot/tx.d.ts

@@ -1271,8 +1271,9 @@ declare module '@polkadot/api-base/types/submittable' {
              * The dispatch of this call must be `FastTrackOrigin`.
              *
              * - `proposal_hash`: The hash of the current external proposal.
-             * - `voting_period`: The period that is allowed for voting on this proposal. Increased to
-             * `FastTrackVotingPeriod` if too low.
+             * - `voting_period`: The period that is allowed for voting on this proposal.
+             * Must be always greater than zero.
+             * For `FastTrackOrigin` must be equal or greater than `FastTrackVotingPeriod`.
              * - `delay`: The number of block after voting has ended in approval and this should be
              * enacted. This doesn't have a minimum amount.
              *
@@ -1551,12 +1552,17 @@ declare module '@polkadot/api-base/types/submittable' {
         };
         grandpa: {
             /**
-             * Note that the current authority set of the GRANDPA finality gadget has
-             * stalled. This will trigger a forced authority set change at the beginning
-             * of the next session, to be enacted `delay` blocks after that. The delay
-             * should be high enough to safely assume that the block signalling the
-             * forced change will not be re-orged (e.g. 1000 blocks). The GRANDPA voters
-             * will start the new authority set using the given finalized block as base.
+             * Note that the current authority set of the GRANDPA finality gadget has stalled.
+             *
+             * This will trigger a forced authority set change at the beginning of the next session, to
+             * be enacted `delay` blocks after that. The `delay` should be high enough to safely assume
+             * that the block signalling the forced change will not be re-orged e.g. 1000 blocks.
+             * The block production rate (which may be slowed down because of finality lagging) should
+             * be taken into account when choosing the `delay`. The GRANDPA voters based on the new
+             * authority will start voting on top of `best_finalized_block_number` for new finalized
+             * blocks. `best_finalized_block_number` should be the highest of the latest finalized
+             * block of all validators of the new authority set.
+             *
              * Only callable by root.
              **/
             noteStalled: AugmentedSubmittable<(delay: u32 | AnyNumber | Uint8Array, bestFinalizedBlockNumber: u32 | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [u32, u32]>;
@@ -4009,6 +4015,27 @@ declare module '@polkadot/api-base/types/submittable' {
              * exist altogether, thus there is no way it would have been approved in the first place.
              **/
             removeApproval: AugmentedSubmittable<(proposalId: Compact<u32> | AnyNumber | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u32>]>;
+            /**
+             * Propose and approve a spend of treasury funds.
+             *
+             * - `origin`: Must be `SpendOrigin` with the `Success` value being at least `amount`.
+             * - `amount`: The amount to be transferred from the treasury to the `beneficiary`.
+             * - `beneficiary`: The destination account for the transfer.
+             *
+             * NOTE: For record-keeping purposes, the proposer is deemed to be equivalent to the
+             * beneficiary.
+             **/
+            spend: AugmentedSubmittable<(amount: Compact<u128> | AnyNumber | Uint8Array, beneficiary: MultiAddress | {
+                Id: any;
+            } | {
+                Index: any;
+            } | {
+                Raw: any;
+            } | {
+                Address32: any;
+            } | {
+                Address20: any;
+            } | string | Uint8Array) => SubmittableExtrinsic<ApiType>, [Compact<u128>, MultiAddress]>;
             /**
              * Generic tx
              **/

package/substrate/errors.d.ts

@@ -729,6 +729,10 @@ declare module '@polkadot/api-base/types/errors' {
              * these are removed, either through `unvote` or `reap_vote`.
              **/
             VotesExist: AugmentedError<ApiType>;
+            /**
+             * Voting period too low
+             **/
+            VotingPeriodLow: AugmentedError<ApiType>;
             /**
              * Invalid upper bound.
              **/

package/substrate/index.d.ts

@@ -4,4 +4,5 @@ import './errors';
 import './events';
 import './query';
 import './registry';
+import './runtime';
 import './tx';

package/substrate/index.js

@@ -6,4 +6,5 @@ import "./errors.js";
 import "./events.js";
 import "./query.js";
 import "./registry.js";
+import "./runtime.js";
 import "./tx.js";