Skip to content

Commit

Permalink
Update typegen and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
TarikGul committed Nov 7, 2024
1 parent da9fdc8 commit 19e7de0
Show file tree
Hide file tree
Showing 20 changed files with 11,415 additions and 2,395 deletions.
191 changes: 73 additions & 118 deletions docs/kusama/constants.md

Large diffs are not rendered by default.

464 changes: 266 additions & 198 deletions docs/kusama/errors.md

Large diffs are not rendered by default.

322 changes: 188 additions & 134 deletions docs/kusama/events.md

Large diffs are not rendered by default.

3,349 changes: 2,857 additions & 492 deletions docs/kusama/extrinsics.md

Large diffs are not rendered by default.

118 changes: 113 additions & 5 deletions docs/kusama/runtime.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,14 @@ The following section contains known runtime calls that may be available on spec

- **[core](#core)**

- **[dryRunApi](#dryrunapi)**

- **[genesisBuilder](#genesisbuilder)**

- **[grandpaApi](#grandpaapi)**

- **[locationToAccountApi](#locationtoaccountapi)**

- **[metadata](#metadata)**

- **[mmrApi](#mmrapi)**
Expand All @@ -40,6 +46,8 @@ The following section contains known runtime calls that may be available on spec

- **[transactionPaymentCallApi](#transactionpaymentcallapi)**

- **[xcmPaymentApi](#xcmpaymentapi)**


___

Expand Down Expand Up @@ -171,7 +179,7 @@ ___
- **runtime**: `Core_execute_block`
- **summary**: Execute the given block.

### initializeBlock(header: `Header`): `Null`
### initializeBlock(header: `Header`): `ExtrinsicInclusionMode`
- **interface**: `api.call.core.initializeBlock`
- **runtime**: `Core_initialize_block`
- **summary**: Initialize a block with the given header.
Expand All @@ -184,6 +192,36 @@ ___
___


## DryRunApi

### dryRunCall(origin: `OriginCaller`, call: `RuntimeCall`): `Result<CallDryRunEffects, XcmDryRunApiError>`
- **interface**: `api.call.dryRunApi.dryRunCall`
- **runtime**: `DryRunApi_dry_run_call`
- **summary**: Dry run call

### dryRunXcm(originLocation: `VersionedMultiLocation`, xcm: `VersionedXcm`): `Result<XcmDryRunEffects, XcmDryRunApiError>`
- **interface**: `api.call.dryRunApi.dryRunXcm`
- **runtime**: `DryRunApi_dry_run_xcm`
- **summary**: Dry run XCM program

___


## GenesisBuilder

### buildConfig(json: `Vec<u8>`): `Result<(), GenesisBuildErr>`
- **interface**: `api.call.genesisBuilder.buildConfig`
- **runtime**: `GenesisBuilder_build_config`
- **summary**: Build `RuntimeGenesisConfig` from a JSON blob not using any defaults and store it in the storage.

### createDefaultConfig(): `Vec<u8>`
- **interface**: `api.call.genesisBuilder.createDefaultConfig`
- **runtime**: `GenesisBuilder_create_default_config`
- **summary**: Creates the default `RuntimeGenesisConfig` and returns it as a JSON blob.

___


## GrandpaApi

### currentSetId(): `SetId`
Expand All @@ -209,6 +247,16 @@ ___
___


## LocationToAccountApi

### convertLocation(location: `XcmVersionedLocation`): `Result<AccountId, Error>`
- **interface**: `api.call.locationToAccountApi.convertLocation`
- **runtime**: `LocationToAccountApi_convert_location`
- **summary**: Converts `Location` to `AccountId`

___


## Metadata

### metadata(): `OpaqueMetadata`
Expand Down Expand Up @@ -236,9 +284,14 @@ ___
- **runtime**: `MmrApi_generate_proof`
- **summary**: Generate MMR proof for the given block numbers.

### root(): `Result<Hash, MmrError>`
- **interface**: `api.call.mmrApi.root`
- **runtime**: `MmrApi_root`
### mmrLeafCount(): `Result<U64, MmrError>`
- **interface**: `api.call.mmrApi.mmrLeafCount`
- **runtime**: `MmrApi_mmr_leaf_count`
- **summary**: Return the number of MMR blocks in the chain.

### mmrRoot(): `Result<Hash, MmrError>`
- **interface**: `api.call.mmrApi.mmrRoot`
- **runtime**: `MmrApi_mmr_root`
- **summary**: Return the on-chain MMR root hash.

### verifyProof(leaves: `Vec<MmrEncodableOpaqueLeaf>`, proof: `MmrBatchProof`): `Result<(), MmrError>`
Expand Down Expand Up @@ -286,11 +339,21 @@ ___

## ParachainHost

### approvalVotingParams(): `ApprovalVotingParams`
- **interface**: `api.call.parachainHost.approvalVotingParams`
- **runtime**: `ParachainHost_approval_voting_params`
- **summary**: Approval voting configuration parameters

### assumedValidationData(paraId: `ParaId`, hash: `Hash`): `Option<(PersistedValidationData, ValidationCodeHash)>`
- **interface**: `api.call.parachainHost.assumedValidationData`
- **runtime**: `ParachainHost_assumed_validation_data`
- **summary**: Returns the persisted validation data for the given `ParaId` along with the corresponding validation code hash.

### asyncBackingParams(): `AsyncBackingParams`
- **interface**: `api.call.parachainHost.asyncBackingParams`
- **runtime**: `ParachainHost_async_backing_params`
- **summary**: Returns candidate's acceptance limitations for asynchronous backing for a relay parent

### availabilityCores(): `Vec<CoreState>`
- **interface**: `api.call.parachainHost.availabilityCores`
- **runtime**: `ParachainHost_availability_cores`
Expand All @@ -311,6 +374,16 @@ ___
- **runtime**: `ParachainHost_check_validation_outputs`
- **summary**: Checks if the given validation outputs pass the acceptance criteria.

### claimQueue(): `BTreeMap<CoreIndex, Vec<u32>>`
- **interface**: `api.call.parachainHost.claimQueue`
- **runtime**: `ParachainHost_claim_queue`
- **summary**: Claim queue

### disabledValidators(): `ValidatorIndex`
- **interface**: `api.call.parachainHost.disabledValidators`
- **runtime**: `ParachainHost_disabled_validators`
- **summary**: Returns a list of all disabled validators at the given block

### disputes(): `Vec<(SessionIndex, CandidateHash, DisputeState)>`
- **interface**: `api.call.parachainHost.disputes`
- **runtime**: `ParachainHost_disputes`
Expand All @@ -331,11 +404,26 @@ ___
- **runtime**: `ParachainHost_key_ownership_proof`
- **summary**: Returns a merkle proof of a validator session key

### minimumBackingVotes(): `u32`
- **interface**: `api.call.parachainHost.minimumBackingVotes`
- **runtime**: `ParachainHost_minimum_backing_votes`
- **summary**: Get the minimum number of backing votes for a parachain candidate. This is a staging method! Do not use on production runtimes!

### nodeFeatures(): `NodeFeatures`
- **interface**: `api.call.parachainHost.nodeFeatures`
- **runtime**: `ParachainHost_node_features`
- **summary**: Get node features. This is a staging method! Do not use on production runtimes!

### onChainVotes(): `Option<ScrapedOnChainVotes>`
- **interface**: `api.call.parachainHost.onChainVotes`
- **runtime**: `ParachainHost_on_chain_votes`
- **summary**: Scrape dispute relevant from on-chain, backing votes and resolved disputes.

### paraBackingState(paraId: `ParaId`): `Option<BackingState>`
- **interface**: `api.call.parachainHost.paraBackingState`
- **runtime**: `ParachainHost_para_backing_state`
- **summary**: Returns the state of parachain backing for a given para

### persistedValidationData(paraId: `ParaId`, assumption: `OccupiedCoreAssumption`): `Option<PersistedValidationData>`
- **interface**: `api.call.parachainHost.persistedValidationData`
- **runtime**: `ParachainHost_persisted_validation_data`
Expand Down Expand Up @@ -376,7 +464,7 @@ ___
- **runtime**: `ParachainHost_unapplied_slashes`
- **summary**: Returns a list of validators that lost a past session dispute and need to be slashed

### validationCode(paraId: `ParaId`, assumption: `OccupiedCoreAssumption`): `ValidationCode`
### validationCode(paraId: `ParaId`, assumption: `OccupiedCoreAssumption`): `Option<ValidationCode>`
- **interface**: `api.call.parachainHost.validationCode`
- **runtime**: `ParachainHost_validation_code`
- **summary**: Fetch the validation code used by a para, making the given `OccupiedCoreAssumption`.
Expand Down Expand Up @@ -485,3 +573,23 @@ ___
- **interface**: `api.call.transactionPaymentCallApi.queryWeightToFee`
- **runtime**: `TransactionPaymentCallApi_query_weight_to_fee`
- **summary**: Query the output of the current WeightToFee given some input

___


## XcmPaymentApi

### queryAcceptablePaymentAssets(version: `u32`): `Result<Vec<XcmVersionedAssetId>, XcmPaymentApiError>`
- **interface**: `api.call.xcmPaymentApi.queryAcceptablePaymentAssets`
- **runtime**: `XcmPaymentApi_query_acceptable_payment_assets`
- **summary**: The API to query acceptable payment assets

### queryWeightToAssetFee(weight: `WeightV2`, asset: `XcmVersionedAssetId`): `Result<u128, XcmPaymentApiError>`
- **interface**: `api.call.xcmPaymentApi.queryWeightToAssetFee`
- **runtime**: `XcmPaymentApi_query_weight_to_asset_fee`
- **summary**:

### queryXcmWeight(message: `XcmVersionedXcm`): `Result<WeightV2, XcmPaymentApiError>`
- **interface**: `api.call.xcmPaymentApi.queryXcmWeight`
- **runtime**: `XcmPaymentApi_query_xcm_weight`
- **summary**:
Loading

0 comments on commit 19e7de0

Please sign in to comment.