mod retain;
use frame_metadata::{
ExtrinsicMetadata, RuntimeMetadataV14, StorageEntryMetadata, StorageEntryType,
};
pub use retain::retain_metadata_pallets;
use scale_info::{form::PortableForm, Field, PortableRegistry, TypeDef, Variant};
use std::collections::HashSet;
#[repr(u8)]
enum TypeBeingHashed {
Composite,
Variant,
Sequence,
Array,
Tuple,
Primitive,
Compact,
BitSequence,
}
fn hash(data: &[u8]) -> [u8; 32] {
sp_core_hashing::twox_256(data)
}
fn xor(a: [u8; 32], b: [u8; 32]) -> [u8; 32] {
let mut out = [0u8; 32];
for (idx, (a, b)) in a.into_iter().zip(b).enumerate() {
out[idx] = a ^ b;
}
out
}
fn hash_hashes(a: [u8; 32], b: [u8; 32]) -> [u8; 32] {
let mut out = [0u8; 32 * 2];
for (idx, byte) in a.into_iter().chain(b).enumerate() {
out[idx] = byte;
}
hash(&out)
}
fn get_field_hash(
registry: &PortableRegistry,
field: &Field<PortableForm>,
visited_ids: &mut HashSet<u32>,
) -> [u8; 32] {
let mut bytes = get_type_hash(registry, field.ty.id, visited_ids);
if let Some(name) = &field.name {
bytes = xor(bytes, hash(name.as_bytes()));
}
bytes
}
fn get_variant_hash(
registry: &PortableRegistry,
var: &Variant<PortableForm>,
visited_ids: &mut HashSet<u32>,
) -> [u8; 32] {
let mut bytes = hash(var.name.as_bytes());
for field in &var.fields {
bytes = hash_hashes(bytes, get_field_hash(registry, field, visited_ids))
}
bytes
}
fn get_type_def_hash(
registry: &PortableRegistry,
ty_def: &TypeDef<PortableForm>,
visited_ids: &mut HashSet<u32>,
) -> [u8; 32] {
match ty_def {
TypeDef::Composite(composite) => {
let mut bytes = hash(&[TypeBeingHashed::Composite as u8]);
for field in &composite.fields {
bytes = hash_hashes(bytes, get_field_hash(registry, field, visited_ids));
}
bytes
}
TypeDef::Variant(variant) => {
let mut bytes = hash(&[TypeBeingHashed::Variant as u8]);
for var in &variant.variants {
bytes = hash_hashes(bytes, get_variant_hash(registry, var, visited_ids));
}
bytes
}
TypeDef::Sequence(sequence) => {
let bytes = hash(&[TypeBeingHashed::Sequence as u8]);
xor(
bytes,
get_type_hash(registry, sequence.type_param.id, visited_ids),
)
}
TypeDef::Array(array) => {
let len_bytes = array.len.to_be_bytes();
let bytes = hash(&[
TypeBeingHashed::Array as u8,
len_bytes[0],
len_bytes[1],
len_bytes[2],
len_bytes[3],
]);
xor(
bytes,
get_type_hash(registry, array.type_param.id, visited_ids),
)
}
TypeDef::Tuple(tuple) => {
let mut bytes = hash(&[TypeBeingHashed::Tuple as u8]);
for field in &tuple.fields {
bytes = hash_hashes(bytes, get_type_hash(registry, field.id, visited_ids));
}
bytes
}
TypeDef::Primitive(primitive) => {
hash(&[TypeBeingHashed::Primitive as u8, primitive.clone() as u8])
}
TypeDef::Compact(compact) => {
let bytes = hash(&[TypeBeingHashed::Compact as u8]);
xor(
bytes,
get_type_hash(registry, compact.type_param.id, visited_ids),
)
}
TypeDef::BitSequence(bitseq) => {
let mut bytes = hash(&[TypeBeingHashed::BitSequence as u8]);
bytes = xor(
bytes,
get_type_hash(registry, bitseq.bit_order_type.id, visited_ids),
);
bytes = xor(
bytes,
get_type_hash(registry, bitseq.bit_store_type.id, visited_ids),
);
bytes
}
}
}
fn get_type_hash(registry: &PortableRegistry, id: u32, visited_ids: &mut HashSet<u32>) -> [u8; 32] {
if !visited_ids.insert(id) {
return hash(&[123u8]);
}
let ty = registry.resolve(id).unwrap();
get_type_def_hash(registry, &ty.type_def, visited_ids)
}
fn get_extrinsic_hash(
registry: &PortableRegistry,
extrinsic: &ExtrinsicMetadata<PortableForm>,
) -> [u8; 32] {
let mut visited_ids = HashSet::<u32>::new();
let mut bytes = get_type_hash(registry, extrinsic.ty.id, &mut visited_ids);
bytes = xor(bytes, hash(&[extrinsic.version]));
for signed_extension in extrinsic.signed_extensions.iter() {
let mut ext_bytes = hash(signed_extension.identifier.as_bytes());
ext_bytes = xor(
ext_bytes,
get_type_hash(registry, signed_extension.ty.id, &mut visited_ids),
);
ext_bytes = xor(
ext_bytes,
get_type_hash(
registry,
signed_extension.additional_signed.id,
&mut visited_ids,
),
);
bytes = hash_hashes(bytes, ext_bytes);
}
bytes
}
fn get_storage_entry_hash(
registry: &PortableRegistry,
entry: &StorageEntryMetadata<PortableForm>,
visited_ids: &mut HashSet<u32>,
) -> [u8; 32] {
let mut bytes = hash(entry.name.as_bytes());
bytes = xor(bytes, hash(&[entry.modifier.clone() as u8]));
bytes = xor(bytes, hash(&entry.default));
match &entry.ty {
StorageEntryType::Plain(ty) => {
bytes = xor(bytes, get_type_hash(registry, ty.id, visited_ids));
}
StorageEntryType::Map {
hashers,
key,
value,
} => {
for hasher in hashers {
bytes = hash_hashes(bytes, [hasher.clone() as u8; 32]);
}
bytes = xor(bytes, get_type_hash(registry, key.id, visited_ids));
bytes = xor(bytes, get_type_hash(registry, value.id, visited_ids));
}
}
bytes
}
pub fn get_storage_hash(
metadata: &RuntimeMetadataV14,
pallet_name: &str,
storage_name: &str,
) -> Result<[u8; 32], NotFound> {
let pallet = metadata
.pallets
.iter()
.find(|p| p.name == pallet_name)
.ok_or(NotFound::Pallet)?;
let storage = pallet.storage.as_ref().ok_or(NotFound::Item)?;
let entry = storage
.entries
.iter()
.find(|s| s.name == storage_name)
.ok_or(NotFound::Item)?;
let hash = get_storage_entry_hash(&metadata.types, entry, &mut HashSet::new());
Ok(hash)
}
pub fn get_constant_hash(
metadata: &RuntimeMetadataV14,
pallet_name: &str,
constant_name: &str,
) -> Result<[u8; 32], NotFound> {
let pallet = metadata
.pallets
.iter()
.find(|p| p.name == pallet_name)
.ok_or(NotFound::Pallet)?;
let constant = pallet
.constants
.iter()
.find(|c| c.name == constant_name)
.ok_or(NotFound::Item)?;
let bytes = get_type_hash(&metadata.types, constant.ty.id, &mut HashSet::new());
Ok(bytes)
}
pub fn get_call_hash(
metadata: &RuntimeMetadataV14,
pallet_name: &str,
call_name: &str,
) -> Result<[u8; 32], NotFound> {
let pallet = metadata
.pallets
.iter()
.find(|p| p.name == pallet_name)
.ok_or(NotFound::Pallet)?;
let call_id = pallet.calls.as_ref().ok_or(NotFound::Item)?.ty.id;
let call_ty = metadata.types.resolve(call_id).ok_or(NotFound::Item)?;
let call_variants = match &call_ty.type_def {
TypeDef::Variant(variant) => &variant.variants,
_ => return Err(NotFound::Item),
};
let variant = call_variants
.iter()
.find(|v| v.name == call_name)
.ok_or(NotFound::Item)?;
let hash = get_variant_hash(&metadata.types, variant, &mut HashSet::new());
Ok(hash)
}
pub fn get_pallet_hash(
registry: &PortableRegistry,
pallet: &frame_metadata::PalletMetadata<PortableForm>,
) -> [u8; 32] {
let mut bytes = hash(&[19]);
let mut visited_ids = HashSet::<u32>::new();
if let Some(calls) = &pallet.calls {
bytes = xor(
bytes,
get_type_hash(registry, calls.ty.id, &mut visited_ids),
);
}
if let Some(ref event) = pallet.event {
bytes = xor(
bytes,
get_type_hash(registry, event.ty.id, &mut visited_ids),
);
}
for constant in pallet.constants.iter() {
bytes = xor(bytes, hash(constant.name.as_bytes()));
bytes = xor(
bytes,
get_type_hash(registry, constant.ty.id, &mut visited_ids),
);
}
if let Some(ref error) = pallet.error {
bytes = xor(
bytes,
get_type_hash(registry, error.ty.id, &mut visited_ids),
);
}
if let Some(ref storage) = pallet.storage {
bytes = xor(bytes, hash(storage.prefix.as_bytes()));
for entry in storage.entries.iter() {
bytes = hash_hashes(
bytes,
get_storage_entry_hash(registry, entry, &mut visited_ids),
);
}
}
bytes
}
pub fn get_metadata_hash(metadata: &RuntimeMetadataV14) -> [u8; 32] {
let mut pallets: Vec<(&str, [u8; 32])> = metadata
.pallets
.iter()
.map(|pallet| {
let hash = get_pallet_hash(&metadata.types, pallet);
(&*pallet.name, hash)
})
.collect();
pallets.sort_by_key(|&(name, _hash)| name);
let mut bytes = Vec::with_capacity(pallets.len() * 32 + 64);
for (_, hash) in pallets.iter() {
bytes.extend(hash)
}
bytes.extend(get_extrinsic_hash(&metadata.types, &metadata.extrinsic));
let mut visited_ids = HashSet::<u32>::new();
bytes.extend(get_type_hash(
&metadata.types,
metadata.ty.id,
&mut visited_ids,
));
hash(&bytes)
}
pub fn get_metadata_per_pallet_hash<T: AsRef<str>>(
metadata: &RuntimeMetadataV14,
pallets: &[T],
) -> [u8; 32] {
let mut pallets_hashed: Vec<(&str, [u8; 32])> = metadata
.pallets
.iter()
.filter_map(|pallet| {
let in_pallet = pallets
.iter()
.any(|pallet_ref| pallet_ref.as_ref() == pallet.name);
if in_pallet {
let hash = get_pallet_hash(&metadata.types, pallet);
Some((&*pallet.name, hash))
} else {
None
}
})
.collect();
pallets_hashed.sort_by_key(|&(name, _hash)| name);
let mut bytes = Vec::with_capacity(pallets_hashed.len() * 32);
for (_, hash) in pallets_hashed.iter() {
bytes.extend(hash)
}
hash(&bytes)
}
#[derive(Clone, Debug)]
pub enum NotFound {
Pallet,
Item,
}
#[cfg(test)]
mod tests {
use super::*;
use bitvec::{order::Lsb0, vec::BitVec};
use frame_metadata::{
ExtrinsicMetadata, PalletCallMetadata, PalletConstantMetadata, PalletErrorMetadata,
PalletEventMetadata, PalletMetadata, PalletStorageMetadata, RuntimeMetadataV14,
StorageEntryMetadata, StorageEntryModifier,
};
use scale_info::meta_type;
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct A {
pub b: Box<B>,
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct B {
pub a: Box<A>,
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct AccountId32([u8; 32]);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum DigestItem {
PreRuntime(
[::core::primitive::u8; 4usize],
::std::vec::Vec<::core::primitive::u8>,
),
Other(::std::vec::Vec<::core::primitive::u8>),
RuntimeEnvironmentUpdated(((i8, i16), (u32, u64))),
Index(#[codec(compact)] ::core::primitive::u8),
BitSeq(BitVec<u8, Lsb0>),
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct MetadataTestType {
recursive: A,
composite: AccountId32,
type_def: DigestItem,
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum Call {
#[codec(index = 0)]
FillBlock { ratio: AccountId32 },
#[codec(index = 1)]
Remark { remark: DigestItem },
}
fn build_default_extrinsic() -> ExtrinsicMetadata {
ExtrinsicMetadata {
ty: meta_type::<()>(),
version: 0,
signed_extensions: vec![],
}
}
fn default_pallet() -> PalletMetadata {
PalletMetadata {
name: "Test",
storage: None,
calls: None,
event: None,
constants: vec![],
error: None,
index: 0,
}
}
fn build_default_pallets() -> Vec<PalletMetadata> {
vec![
PalletMetadata {
name: "First",
calls: Some(PalletCallMetadata {
ty: meta_type::<MetadataTestType>(),
}),
..default_pallet()
},
PalletMetadata {
name: "Second",
index: 1,
calls: Some(PalletCallMetadata {
ty: meta_type::<(DigestItem, AccountId32, A)>(),
}),
..default_pallet()
},
]
}
fn pallets_to_metadata(pallets: Vec<PalletMetadata>) -> RuntimeMetadataV14 {
RuntimeMetadataV14::new(pallets, build_default_extrinsic(), meta_type::<()>())
}
#[test]
fn different_pallet_index() {
let pallets = build_default_pallets();
let mut pallets_swap = pallets.clone();
let metadata = pallets_to_metadata(pallets);
pallets_swap.swap(0, 1);
pallets_swap[0].index = 0;
pallets_swap[1].index = 1;
let metadata_swap = pallets_to_metadata(pallets_swap);
let hash = get_metadata_hash(&metadata);
let hash_swap = get_metadata_hash(&metadata_swap);
assert_eq!(hash, hash_swap);
}
#[test]
fn recursive_type() {
let mut pallet = default_pallet();
pallet.calls = Some(PalletCallMetadata {
ty: meta_type::<A>(),
});
let metadata = pallets_to_metadata(vec![pallet]);
get_metadata_hash(&metadata);
}
#[test]
fn recursive_types_different_order() {
let mut pallets = build_default_pallets();
pallets[0].calls = Some(PalletCallMetadata {
ty: meta_type::<A>(),
});
pallets[1].calls = Some(PalletCallMetadata {
ty: meta_type::<B>(),
});
pallets[1].index = 1;
let mut pallets_swap = pallets.clone();
let metadata = pallets_to_metadata(pallets);
pallets_swap.swap(0, 1);
pallets_swap[0].index = 0;
pallets_swap[1].index = 1;
let metadata_swap = pallets_to_metadata(pallets_swap);
let hash = get_metadata_hash(&metadata);
let hash_swap = get_metadata_hash(&metadata_swap);
assert_eq!(hash, hash_swap);
}
#[test]
fn pallet_hash_correctness() {
let compare_pallets_hash = |lhs: &PalletMetadata, rhs: &PalletMetadata| {
let metadata = pallets_to_metadata(vec![lhs.clone()]);
let hash = get_metadata_hash(&metadata);
let metadata = pallets_to_metadata(vec![rhs.clone()]);
let new_hash = get_metadata_hash(&metadata);
assert_ne!(hash, new_hash);
};
let mut pallet = default_pallet();
let pallet_lhs = pallet.clone();
pallet.storage = Some(PalletStorageMetadata {
prefix: "Storage",
entries: vec![StorageEntryMetadata {
name: "BlockWeight",
modifier: StorageEntryModifier::Default,
ty: StorageEntryType::Plain(meta_type::<u8>()),
default: vec![],
docs: vec![],
}],
});
compare_pallets_hash(&pallet_lhs, &pallet);
let pallet_lhs = pallet.clone();
pallet.calls = Some(PalletCallMetadata {
ty: meta_type::<Call>(),
});
compare_pallets_hash(&pallet_lhs, &pallet);
let pallet_lhs = pallet.clone();
pallet.event = Some(PalletEventMetadata {
ty: meta_type::<Call>(),
});
compare_pallets_hash(&pallet_lhs, &pallet);
let pallet_lhs = pallet.clone();
pallet.constants = vec![PalletConstantMetadata {
name: "BlockHashCount",
ty: meta_type::<u64>(),
value: vec![96u8, 0, 0, 0],
docs: vec![],
}];
compare_pallets_hash(&pallet_lhs, &pallet);
let pallet_lhs = pallet.clone();
pallet.error = Some(PalletErrorMetadata {
ty: meta_type::<MetadataTestType>(),
});
compare_pallets_hash(&pallet_lhs, &pallet);
}
#[test]
fn metadata_per_pallet_hash_correctness() {
let pallets = build_default_pallets();
let metadata_one = pallets_to_metadata(vec![pallets[0].clone()]);
let metadata_both = pallets_to_metadata(pallets);
let hash = get_metadata_per_pallet_hash(&metadata_one, &["First", "Second"]);
let hash_rhs = get_metadata_per_pallet_hash(&metadata_one, &["First"]);
assert_eq!(hash, hash_rhs, "hashing should ignore non-existant pallets");
let hash_second = get_metadata_per_pallet_hash(&metadata_both, &["First"]);
assert_eq!(
hash_second, hash,
"hashing one pallet should ignore the others"
);
let hash_second = get_metadata_per_pallet_hash(&metadata_both, &["First", "Second"]);
assert_ne!(
hash_second, hash,
"hashing both pallets should produce a different result from hashing just one pallet"
);
}
#[test]
fn field_semantic_changes() {
let to_hash = |meta_ty| {
let pallet = PalletMetadata {
calls: Some(PalletCallMetadata { ty: meta_ty }),
..default_pallet()
};
let metadata = pallets_to_metadata(vec![pallet]);
get_metadata_hash(&metadata)
};
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldNotNamedA {
First(u8),
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldNotNamedB {
First(u8),
}
assert_eq!(
to_hash(meta_type::<EnumFieldNotNamedA>()),
to_hash(meta_type::<EnumFieldNotNamedB>())
);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct StructFieldNotNamedA([u8; 32]);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct StructFieldNotNamedSecondB([u8; 32]);
assert_eq!(
to_hash(meta_type::<StructFieldNotNamedA>()),
to_hash(meta_type::<StructFieldNotNamedSecondB>())
);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldNotNamed {
First(u8),
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldNotNamedSecond {
Second(u8),
}
assert_ne!(
to_hash(meta_type::<EnumFieldNotNamed>()),
to_hash(meta_type::<EnumFieldNotNamedSecond>())
);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldNamed {
First { a: u8 },
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldNamedSecond {
First { b: u8 },
}
assert_ne!(
to_hash(meta_type::<EnumFieldNamed>()),
to_hash(meta_type::<EnumFieldNamedSecond>())
);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct StructFieldNamed {
a: u32,
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct StructFieldNamedSecond {
b: u32,
}
assert_ne!(
to_hash(meta_type::<StructFieldNamed>()),
to_hash(meta_type::<StructFieldNamedSecond>())
);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumField {
First,
Second(u8),
Third { named: u8 },
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
enum EnumFieldSwap {
Second(u8),
First,
Third { named: u8 },
}
assert_ne!(
to_hash(meta_type::<EnumField>()),
to_hash(meta_type::<EnumFieldSwap>())
);
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct StructField {
a: u32,
b: u32,
}
#[allow(dead_code)]
#[derive(scale_info::TypeInfo)]
struct StructFieldSwap {
b: u32,
a: u32,
}
assert_ne!(
to_hash(meta_type::<StructField>()),
to_hash(meta_type::<StructFieldSwap>())
);
}
}