mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-01 10:07:56 +00:00
Enrich metadata with type information (#8615)
* Cargo.lock after merge * Restore scale-info feature * Fully qualify TypeInfo derive * Skip PendingSwap T * Add missing skip_type_params attr * metadata docs features * Reduce pallet event attribute to struct * Cargo.lock * Update frame/balances/src/tests_composite.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Line widths check * Cargo.lock * Add scale-info/std * Update frame/system/src/lib.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Use `skip_type_params` to remove `TypeInfo` requirements on checks * Revert "Remove unused Call metadata stuff" This reverts commit 41311f85 * Skip BalanceSwapAction type parameter * Remove unused event metadata macro * Update frame-metadata * Update primitives/npos-elections/compact/src/codec.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Manual TypeInfo for Header * Remove TypeInfo requirement for consts in BoundedVec etc. * Another TypeInfo bound removed * review: fix indentation * TypeInfo impls for Identity types * Add some todos to add custom TypeInfo impls * Update frame/support/procedural/src/pallet/expand/pallet_struct.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Add some todos to add custom TypeInfo impls * Add a test for manual Data TypeInfo impl * Add custom TypeInfo impl for Vote * Era custom TypeInfo crimes * Revert finality-grandpa version to 0.14.z * review: renamed module to pallet_constants_metadata * New line at end of file * Add missing scale-info/std * Update frame/support/src/storage/types/mod.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Remove StorageEntryType::Map unused flag * Add missing scale-info dependency after merge * SignedExtension::AdditionalSigned metadata * Update frame-metadata, use abbreviated docs and args fields * Update frame/example/Cargo.toml Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Add scale_info/std and remove unused scale-info dependency * Remove scale-info dependency * Remove treasury pallet::metadata * Remove redundant Event test * Add back scale-info as dev dependency * fix error metadata when no error defined in decl_module * Add Module3 to tests * Fix metadata test * Add docs feature to frame-support test * WIP fixing pallet metadata test * Remove redundant FunctionMetadata, FunctionArgumentMetadata as per https://github.com/paritytech/frame-metadata/pull/20 * Use main branch of frame-metadata * Use patch of scale-info for latest changes * Use latest patched scale-info * Manual TypeInfo for DigestItem * Manual TypeInfo for DigestItem * Update scale-info * Skip __Ignore variants for Error, depends on https://github.com/paritytech/scale-info/pull/117 * Named fields for FRAME v2 pallet Call variants * Named fields for FRAME v1 pallet Call variants * Add missing scale-info dependency * WIP expand benchmark call variant * fix benchmark with new function create a new function for each variant of a pallet call. This function is called by benchmarking macro in order not to break call creation with unnamed argument * fix tests * more fix * Fix staking tests * Fix offchain workers calls * Cherry pick rustfmt.toml from master * cargo +nightly-2021-06-22 fmt --all * Update to new call variant structs * More call variant struct updates * Remove unused import * More call variant structs * More call variant structs * Even more call variant structs * Mooar variant structs * Evermore variant structs * Call variant structs ad infinitum * Fmt * More call variants * Last call variant * Call variants all done? * Fix SS58Prefix type * Potential workaround for BitFlags<IdentityFields> TypeInfo * Enable docs capturing for Call, Event, and Error types * Fix IdentityFields TypeInfo * Remove metadata-docs feature * Add capture_docs = true for legacy Call, Event and Error types * Fmt * Fix metadata test type * Update benchmarks with call struct variants * Fmt * More test fixes * Fmt * Fix benches * Use latest capture_docs attr * Latest scale_info * Fmt * review: change &Vec to &[] * Remove pallet metadata attr * review: remove commented out test code * review: skip_type_params trailing comma suggestion * Update to scale-info 0.10.0 * Update construct_runtime ui tests, different because of metadata TypeInfo impls * Add some TypeInfo derives for UI tests * Update storage ensure span ui stderrs * Update call argument bound ui tests Possibly changed because change from tuple to struct variants? * Add scale-info dev dependency * Update to latest finality-grandpa release * review: missing newline * review: missing scale-info/std * review: remove duplicate scale-info/std * review: remove fully qualified TypeInfo * review: add missing scale-info/std * review: remove unnecessary imports. * Fmt * Use crates.io RC version of frame-metadata * Remove scale-info/std because it is a dev dependency * Add missing scale_info dev-dependency for test * Delete empty metadata folder * Fix sp_std import * review: improve manual UncheckedExtrinsic TypeInfo impl * review: use full scale-info for dev-dependency * Remove DefaultByteGetter impl * review: derive TypeInfo for generic header * Fmt * Update primitives/runtime/src/generic/unchecked_extrinsic.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Update primitives/runtime/src/generic/unchecked_extrinsic.rs Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> * Update bin/node/executor/Cargo.toml Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/identity/src/types.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Update frame/support/src/dispatch.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Remove redundant derive * Simplify scale-info dependency * Strip underscore prefix from call variant struct names * Another underscore field * More underscore fields * Another underscore field * Update to frame-metadata 14.0.0-rc.2 with combined StorageEntryType::Map * Fmt * Revert weights formatting * Fix up some tests * Fix up some tests for StorageEntryTypeMetadata * scale-info dev dependency * Fix test error * Add missing TypeInfo derives * Add back missing scale-info dependency * Add back missing scale-info dependency * Fix npos compact impls * Cargo.lock * Fmt * Fix errors * Fmt * Fix renamed raw_solution field * Fix error * Fmt * Fix some benchmarks * Fmt * Stray R * Fix * Add missing TypeInfos * ui test fix * Fix line widths * Revert "ui test fix" This reverts commit 2d15ec058a216e3f92d713f1174603a2bb1eac65. * Upgrade to scale-info 0.11.0 * Revert "Upgrade to scale-info 0.11.0" This reverts commit 047bb179085a0059c36cd20ab405f55cf0867e28. * Add Runtime type * Update to scale-info 0.12 * Update to scale-info 1.0 * Update frame-metadata to version 14.0.0 * Patch finality-grandpa until release available * Fix metadata tests * Fix metadata tests * Fmt * Remove patched finality-grandpa * Fix tests, use scale_info imports * Fix pallet tests * Add BlockNumber TypeInfo bound * ui test fix * Cargo.lock * Remove pallet metadata * Cargo.lock * Add missing scale-info dependency * Remove pallet event metadata * Fix error * Fix collective errors * Semicolol * Fmt * Remove another metadata attribute * Add new variant to custom digest TypeInfo * Fmt * Cargo.lock from master * Remove comma lol * Fix example call error * Fix example call error properly Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> Co-authored-by: Keith Yeung <kungfukeith11@gmail.com> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Andrew Jones
@@ -24,12 +24,16 @@ use sp_std::prelude::*;
|
||||
|
||||
use crate::{
|
||||
codec::{Decode, Encode, Error, Input},
|
||||
scale_info::{
|
||||
build::{Fields, Variants},
|
||||
meta_type, Path, Type, TypeInfo, TypeParameter,
|
||||
},
|
||||
ConsensusEngineId,
|
||||
};
|
||||
use sp_core::{ChangesTrieConfiguration, RuntimeDebug};
|
||||
|
||||
/// Generic header digest.
|
||||
#[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug)]
|
||||
#[derive(PartialEq, Eq, Clone, Encode, Decode, RuntimeDebug, TypeInfo)]
|
||||
#[cfg_attr(feature = "std", derive(Serialize, Deserialize, parity_util_mem::MallocSizeOf))]
|
||||
pub struct Digest<Hash> {
|
||||
/// A list of logs in the digest.
|
||||
@@ -129,7 +133,7 @@ pub enum DigestItem<Hash> {
|
||||
}
|
||||
|
||||
/// Available changes trie signals.
|
||||
#[derive(PartialEq, Eq, Clone, Encode, Decode)]
|
||||
#[derive(PartialEq, Eq, Clone, Encode, Decode, TypeInfo)]
|
||||
#[cfg_attr(feature = "std", derive(Debug, parity_util_mem::MallocSizeOf))]
|
||||
pub enum ChangesTrieSignal {
|
||||
/// New changes trie configuration is enacted, starting from **next block**.
|
||||
@@ -167,6 +171,69 @@ impl<'a, Hash: Decode> serde::Deserialize<'a> for DigestItem<Hash> {
|
||||
}
|
||||
}
|
||||
|
||||
impl<Hash> TypeInfo for DigestItem<Hash>
|
||||
where
|
||||
Hash: TypeInfo + 'static,
|
||||
{
|
||||
type Identity = Self;
|
||||
|
||||
fn type_info() -> Type {
|
||||
Type::builder()
|
||||
.path(Path::new("DigestItem", module_path!()))
|
||||
.type_params(vec![TypeParameter::new("Hash", Some(meta_type::<Hash>()))])
|
||||
.variant(
|
||||
Variants::new()
|
||||
.variant("ChangesTrieRoot", |v| {
|
||||
v.index(DigestItemType::ChangesTrieRoot as u8)
|
||||
.fields(Fields::unnamed().field(|f| f.ty::<Hash>().type_name("Hash")))
|
||||
})
|
||||
.variant("PreRuntime", |v| {
|
||||
v.index(DigestItemType::PreRuntime as u8).fields(
|
||||
Fields::unnamed()
|
||||
.field(|f| {
|
||||
f.ty::<ConsensusEngineId>().type_name("ConsensusEngineId")
|
||||
})
|
||||
.field(|f| f.ty::<Vec<u8>>().type_name("Vec<u8>")),
|
||||
)
|
||||
})
|
||||
.variant("Consensus", |v| {
|
||||
v.index(DigestItemType::Consensus as u8).fields(
|
||||
Fields::unnamed()
|
||||
.field(|f| {
|
||||
f.ty::<ConsensusEngineId>().type_name("ConsensusEngineId")
|
||||
})
|
||||
.field(|f| f.ty::<Vec<u8>>().type_name("Vec<u8>")),
|
||||
)
|
||||
})
|
||||
.variant("Seal", |v| {
|
||||
v.index(DigestItemType::Seal as u8).fields(
|
||||
Fields::unnamed()
|
||||
.field(|f| {
|
||||
f.ty::<ConsensusEngineId>().type_name("ConsensusEngineId")
|
||||
})
|
||||
.field(|f| f.ty::<Vec<u8>>().type_name("Vec<u8>")),
|
||||
)
|
||||
})
|
||||
.variant("ChangesTrieSignal", |v| {
|
||||
v.index(DigestItemType::ChangesTrieSignal as u8).fields(
|
||||
Fields::unnamed().field(|f| {
|
||||
f.ty::<ChangesTrieSignal>().type_name("ChangesTrieSignal")
|
||||
}),
|
||||
)
|
||||
})
|
||||
.variant("Other", |v| {
|
||||
v.index(DigestItemType::Other as u8).fields(
|
||||
Fields::unnamed().field(|f| f.ty::<Vec<u8>>().type_name("Vec<u8>")),
|
||||
)
|
||||
})
|
||||
.variant("RuntimeEnvironmentUpdated", |v| {
|
||||
v.index(DigestItemType::RuntimeEnvironmentUpdated as u8)
|
||||
.fields(Fields::unit())
|
||||
}),
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
/// A 'referencing view' for digest item. Does not own its contents. Used by
|
||||
/// final runtime implementations for encoding/decoding its log items.
|
||||
#[derive(PartialEq, Eq, Clone, RuntimeDebug)]
|
||||
@@ -509,4 +576,52 @@ mod tests {
|
||||
r#"{"logs":["0x0204000000","0x000c010203","0x05746573740c010203"]}"#
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn digest_item_type_info() {
|
||||
let type_info = DigestItem::<u32>::type_info();
|
||||
let variants = if let scale_info::TypeDef::Variant(variant) = type_info.type_def() {
|
||||
variant.variants()
|
||||
} else {
|
||||
panic!("Should be a TypeDef::TypeDefVariant")
|
||||
};
|
||||
|
||||
// ensure that all variants are covered by manual TypeInfo impl
|
||||
let check = |digest_item_type: DigestItemType| {
|
||||
let (variant_name, digest_item) = match digest_item_type {
|
||||
DigestItemType::Other => ("Other", DigestItem::<u32>::Other(Default::default())),
|
||||
DigestItemType::ChangesTrieRoot =>
|
||||
("ChangesTrieRoot", DigestItem::ChangesTrieRoot(Default::default())),
|
||||
DigestItemType::Consensus =>
|
||||
("Consensus", DigestItem::Consensus(Default::default(), Default::default())),
|
||||
DigestItemType::Seal =>
|
||||
("Seal", DigestItem::Seal(Default::default(), Default::default())),
|
||||
DigestItemType::PreRuntime =>
|
||||
("PreRuntime", DigestItem::PreRuntime(Default::default(), Default::default())),
|
||||
DigestItemType::ChangesTrieSignal => (
|
||||
"ChangesTrieSignal",
|
||||
DigestItem::ChangesTrieSignal(ChangesTrieSignal::NewConfiguration(
|
||||
Default::default(),
|
||||
)),
|
||||
),
|
||||
DigestItemType::RuntimeEnvironmentUpdated =>
|
||||
("RuntimeEnvironmentUpdated", DigestItem::RuntimeEnvironmentUpdated),
|
||||
};
|
||||
let encoded = digest_item.encode();
|
||||
let variant = variants
|
||||
.iter()
|
||||
.find(|v| v.name() == &variant_name)
|
||||
.expect(&format!("Variant {} not found", variant_name));
|
||||
|
||||
assert_eq!(encoded[0], variant.index())
|
||||
};
|
||||
|
||||
check(DigestItemType::Other);
|
||||
check(DigestItemType::ChangesTrieRoot);
|
||||
check(DigestItemType::Consensus);
|
||||
check(DigestItemType::Seal);
|
||||
check(DigestItemType::PreRuntime);
|
||||
check(DigestItemType::ChangesTrieSignal);
|
||||
check(DigestItemType::RuntimeEnvironmentUpdated);
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user