Update deps to use scale-type-resolver 0.2 (#1565)

* Updates for scale-type-resolver 0.2

* show that we can check the name too now

* Bump versions and fix WrapperKeepOpaque name check
This commit is contained in:
James Wilson
2024-04-30 08:45:39 +01:00
committed by GitHub
parent cdbf025db1
commit bc079e7c98
18 changed files with 247 additions and 252 deletions
Generated
+174 -185
View File
File diff suppressed because it is too large Load Diff
+6 -6
View File
@@ -91,12 +91,12 @@ proc-macro2 = "1.0.81"
quote = "1.0.36" quote = "1.0.36"
regex = { version = "1.10.4", default-features = false } regex = { version = "1.10.4", default-features = false }
scale-info = { version = "2.11.0", default-features = false } scale-info = { version = "2.11.0", default-features = false }
scale-value = { version = "0.14.1", default-features = false } scale-value = { version = "0.15.0", default-features = false }
scale-bits = { version = "0.5.0", default-features = false } scale-bits = { version = "0.6.0", default-features = false }
scale-decode = { version = "0.11.1", default-features = false } scale-decode = { version = "0.12.0", default-features = false }
scale-encode = { version = "0.6.0", default-features = false } scale-encode = { version = "0.7.0", default-features = false }
scale-typegen = "0.4.2" scale-typegen = "0.5.0"
scale-typegen-description = "0.4.3" scale-typegen-description = "0.5.0"
serde = { version = "1.0.199", default-features = false, features = ["derive"] } serde = { version = "1.0.199", default-features = false, features = ["derive"] }
serde_json = { version = "1.0.116", default-features = false } serde_json = { version = "1.0.116", default-features = false }
syn = { version = "2.0.15", features = ["full", "extra-traits"] } syn = { version = "2.0.15", features = ["full", "extra-traits"] }
@@ -64,11 +64,8 @@ pub fn explore_constants(
.highlight(); .highlight();
// value // value
let value = scale_value::scale::decode_as_type( let value =
&mut constant.value(), scale_value::scale::decode_as_type(&mut constant.value(), constant.ty(), metadata.types())?;
&constant.ty(),
metadata.types(),
)?;
let value = format_scale_value(&value).indent(4); let value = format_scale_value(&value).indent(4);
writedoc!( writedoc!(
+1 -1
View File
@@ -169,7 +169,7 @@ pub async fn explore_storage(
{value_str} {value_str}
"}?; "}?;
let key_bytes = value.encode_as_type(&type_id, metadata.types())?; let key_bytes = value.encode_as_type(type_id, metadata.types())?;
let bytes_composite = Value::from_bytes(key_bytes); let bytes_composite = Value::from_bytes(key_bytes);
vec![bytes_composite] vec![bytes_composite]
} }
+2 -2
View File
@@ -161,8 +161,8 @@ pub async fn run<'a>(
{value_str} {value_str}
"}?; "}?;
// encode, then decode. This ensures that the scale value is of the correct shape for the param: // encode, then decode. This ensures that the scale value is of the correct shape for the param:
let bytes = value.encode_as_type(&ty.ty, metadata.types())?; let bytes = value.encode_as_type(ty.ty, metadata.types())?;
let value = Value::decode_as_type(&mut &bytes[..], &ty.ty, metadata.types())?; let value = Value::decode_as_type(&mut &bytes[..], ty.ty, metadata.types())?;
Ok(value) Ok(value)
}) })
.collect::<color_eyre::Result<Vec<Value>>>()?; .collect::<color_eyre::Result<Vec<Value>>>()?;
@@ -47,7 +47,7 @@ impl<'a, T: Config> ExtrinsicSignedExtensions<'a, T> {
let cursor = &mut &bytes[byte_start_idx..]; let cursor = &mut &bytes[byte_start_idx..];
if let Err(err) = scale_decode::visitor::decode_with_visitor( if let Err(err) = scale_decode::visitor::decode_with_visitor(
cursor, cursor,
&ty_id, ty_id,
metadata.types(), metadata.types(),
scale_decode::visitor::IgnoreVisitor::new(), scale_decode::visitor::IgnoreVisitor::new(),
) )
@@ -146,7 +146,7 @@ impl<'a, T: Config> ExtrinsicSignedExtension<'a, T> {
pub fn value(&self) -> Result<Value<u32>, Error> { pub fn value(&self) -> Result<Value<u32>, Error> {
let value = scale_value::scale::decode_as_type( let value = scale_value::scale::decode_as_type(
&mut &self.bytes[..], &mut &self.bytes[..],
&self.ty_id, self.ty_id,
self.metadata.types(), self.metadata.types(),
)?; )?;
Ok(value) Ok(value)
@@ -163,7 +163,7 @@ impl<'a, T: Config> ExtrinsicSignedExtension<'a, T> {
} }
fn as_type<E: DecodeAsType>(&self) -> Result<E, Error> { fn as_type<E: DecodeAsType>(&self) -> Result<E, Error> {
let value = E::decode_as_type(&mut &self.bytes[..], &self.ty_id, self.metadata.types())?; let value = E::decode_as_type(&mut &self.bytes[..], self.ty_id, self.metadata.types())?;
Ok(value) Ok(value)
} }
} }
+6 -6
View File
@@ -194,7 +194,7 @@ where
// Skip over the address, signature and extra fields. // Skip over the address, signature and extra fields.
scale_decode::visitor::decode_with_visitor( scale_decode::visitor::decode_with_visitor(
cursor, cursor,
&ids.address, ids.address,
metadata.types(), metadata.types(),
scale_decode::visitor::IgnoreVisitor::new(), scale_decode::visitor::IgnoreVisitor::new(),
) )
@@ -203,7 +203,7 @@ where
scale_decode::visitor::decode_with_visitor( scale_decode::visitor::decode_with_visitor(
cursor, cursor,
&ids.signature, ids.signature,
metadata.types(), metadata.types(),
scale_decode::visitor::IgnoreVisitor::new(), scale_decode::visitor::IgnoreVisitor::new(),
) )
@@ -212,7 +212,7 @@ where
scale_decode::visitor::decode_with_visitor( scale_decode::visitor::decode_with_visitor(
cursor, cursor,
&ids.extra, ids.extra,
metadata.types(), metadata.types(),
scale_decode::visitor::IgnoreVisitor::new(), scale_decode::visitor::IgnoreVisitor::new(),
) )
@@ -370,7 +370,7 @@ where
.variant .variant
.fields .fields
.iter() .iter()
.map(|f| scale_decode::Field::new(&f.ty.id, f.name.as_deref())); .map(|f| scale_decode::Field::new(f.ty.id, f.name.as_deref()));
let decoded = let decoded =
scale_value::scale::decode_as_fields(bytes, &mut fields, self.metadata.types())?; scale_value::scale::decode_as_fields(bytes, &mut fields, self.metadata.types())?;
@@ -388,7 +388,7 @@ where
.variant .variant
.fields .fields
.iter() .iter()
.map(|f| scale_decode::Field::new(&f.ty.id, f.name.as_deref())); .map(|f| scale_decode::Field::new(f.ty.id, f.name.as_deref()));
let decoded = let decoded =
E::decode_as_fields(&mut self.field_bytes(), &mut fields, self.metadata.types())?; E::decode_as_fields(&mut self.field_bytes(), &mut fields, self.metadata.types())?;
Ok(Some(decoded)) Ok(Some(decoded))
@@ -403,7 +403,7 @@ where
pub fn as_root_extrinsic<E: DecodeAsType>(&self) -> Result<E, Error> { pub fn as_root_extrinsic<E: DecodeAsType>(&self) -> Result<E, Error> {
let decoded = E::decode_as_type( let decoded = E::decode_as_type(
&mut &self.call_bytes()[..], &mut &self.call_bytes()[..],
&self.metadata.outer_enums().call_enum_ty(), self.metadata.outer_enums().call_enum_ty(),
self.metadata.types(), self.metadata.types(),
)?; )?;
+2 -2
View File
@@ -67,7 +67,7 @@ impl DecodedValueThunk {
pub fn to_value(&self) -> Result<DecodedValue, scale_decode::Error> { pub fn to_value(&self) -> Result<DecodedValue, scale_decode::Error> {
let val = scale_value::scale::decode_as_type( let val = scale_value::scale::decode_as_type(
&mut &*self.scale_bytes, &mut &*self.scale_bytes,
&self.type_id, self.type_id,
self.metadata.types(), self.metadata.types(),
)?; )?;
Ok(val) Ok(val)
@@ -76,7 +76,7 @@ impl DecodedValueThunk {
pub fn as_type<T: DecodeAsType>(&self) -> Result<T, scale_decode::Error> { pub fn as_type<T: DecodeAsType>(&self) -> Result<T, scale_decode::Error> {
T::decode_as_type( T::decode_as_type(
&mut &self.scale_bytes[..], &mut &self.scale_bytes[..],
&self.type_id, self.type_id,
self.metadata.types(), self.metadata.types(),
) )
} }
+4 -4
View File
@@ -272,7 +272,7 @@ impl<T: Config> EventDetails<T> {
// Skip over the bytes for this field: // Skip over the bytes for this field:
scale_decode::visitor::decode_with_visitor( scale_decode::visitor::decode_with_visitor(
input, input,
&field_metadata.ty.id, field_metadata.ty.id,
metadata.types(), metadata.types(),
scale_decode::visitor::IgnoreVisitor::new(), scale_decode::visitor::IgnoreVisitor::new(),
) )
@@ -373,7 +373,7 @@ impl<T: Config> EventDetails<T> {
.variant .variant
.fields .fields
.iter() .iter()
.map(|f| scale_decode::Field::new(&f.ty.id, f.name.as_deref())); .map(|f| scale_decode::Field::new(f.ty.id, f.name.as_deref()));
let decoded = let decoded =
scale_value::scale::decode_as_fields(bytes, &mut fields, self.metadata.types())?; scale_value::scale::decode_as_fields(bytes, &mut fields, self.metadata.types())?;
@@ -390,7 +390,7 @@ impl<T: Config> EventDetails<T> {
.variant .variant
.fields .fields
.iter() .iter()
.map(|f| scale_decode::Field::new(&f.ty.id, f.name.as_deref())); .map(|f| scale_decode::Field::new(f.ty.id, f.name.as_deref()));
let decoded = let decoded =
E::decode_as_fields(&mut self.field_bytes(), &mut fields, self.metadata.types())?; E::decode_as_fields(&mut self.field_bytes(), &mut fields, self.metadata.types())?;
Ok(Some(decoded)) Ok(Some(decoded))
@@ -407,7 +407,7 @@ impl<T: Config> EventDetails<T> {
let decoded = E::decode_as_type( let decoded = E::decode_as_type(
&mut &bytes[..], &mut &bytes[..],
&self.metadata.outer_enums().event_enum_ty(), self.metadata.outer_enums().event_enum_ty(),
self.metadata.types(), self.metadata.types(),
)?; )?;
+2 -2
View File
@@ -22,7 +22,7 @@ impl<T: scale_decode::DecodeAsType> DecodeWithMetadata for T {
type_id: u32, type_id: u32,
metadata: &Metadata, metadata: &Metadata,
) -> Result<T, scale_decode::Error> { ) -> Result<T, scale_decode::Error> {
let val = T::decode_as_type(bytes, &type_id, metadata.types())?; let val = T::decode_as_type(bytes, type_id, metadata.types())?;
Ok(val) Ok(val)
} }
} }
@@ -46,7 +46,7 @@ impl<T: scale_encode::EncodeAsType> EncodeWithMetadata for T {
metadata: &Metadata, metadata: &Metadata,
bytes: &mut Vec<u8>, bytes: &mut Vec<u8>,
) -> Result<(), scale_encode::Error> { ) -> Result<(), scale_encode::Error> {
self.encode_as_type_to(&type_id, metadata.types(), bytes)?; self.encode_as_type_to(type_id, metadata.types(), bytes)?;
Ok(()) Ok(())
} }
} }
+1 -1
View File
@@ -108,7 +108,7 @@ impl<ArgsData: EncodeAsFields, ReturnTy: DecodeWithMetadata> Payload
.ok_or_else(|| MetadataError::RuntimeMethodNotFound((*self.method_name).to_owned()))?; .ok_or_else(|| MetadataError::RuntimeMethodNotFound((*self.method_name).to_owned()))?;
let mut fields = api_method let mut fields = api_method
.inputs() .inputs()
.map(|input| scale_encode::Field::named(&input.ty, &input.name)); .map(|input| scale_encode::Field::named(input.ty, &input.name));
self.args_data self.args_data
.encode_as_fields_to(&mut fields, metadata.types(), out)?; .encode_as_fields_to(&mut fields, metadata.types(), out)?;
+4 -4
View File
@@ -206,7 +206,7 @@ impl<K: ?Sized> StorageKey for StaticStorageKey<K> {
types: &PortableRegistry, types: &PortableRegistry,
) -> Result<(), Error> { ) -> Result<(), Error> {
let (hasher, ty_id) = hashers.next_or_err()?; let (hasher, ty_id) = hashers.next_or_err()?;
let encoded_value = self.bytes.encode_as_type(&ty_id, types)?; let encoded_value = self.bytes.encode_as_type(ty_id, types)?;
hash_bytes(&encoded_value, hasher, bytes); hash_bytes(&encoded_value, hasher, bytes);
Ok(()) Ok(())
} }
@@ -245,7 +245,7 @@ impl StorageKey for Vec<scale_value::Value> {
) -> Result<(), Error> { ) -> Result<(), Error> {
for value in self.iter() { for value in self.iter() {
let (hasher, ty_id) = hashers.next_or_err()?; let (hasher, ty_id) = hashers.next_or_err()?;
let encoded_value = value.encode_as_type(&ty_id, types)?; let encoded_value = value.encode_as_type(ty_id, types)?;
hash_bytes(&encoded_value, hasher, bytes); hash_bytes(&encoded_value, hasher, bytes);
} }
Ok(()) Ok(())
@@ -264,7 +264,7 @@ impl StorageKey for Vec<scale_value::Value> {
match consume_hash_returning_key_bytes(bytes, hasher, ty_id, types)? { match consume_hash_returning_key_bytes(bytes, hasher, ty_id, types)? {
Some(value_bytes) => { Some(value_bytes) => {
let value = let value =
scale_value::scale::decode_as_type(&mut &*value_bytes, &ty_id, types)?; scale_value::scale::decode_as_type(&mut &*value_bytes, ty_id, types)?;
result.push(value.remove_context()); result.push(value.remove_context());
} }
None => { None => {
@@ -302,7 +302,7 @@ fn consume_hash_returning_key_bytes<'a>(
if hasher.ends_with_key() { if hasher.ends_with_key() {
scale_decode::visitor::decode_with_visitor( scale_decode::visitor::decode_with_visitor(
bytes, bytes,
&ty_id, ty_id,
types, types,
IgnoreVisitor::<PortableRegistry>::new(), IgnoreVisitor::<PortableRegistry>::new(),
) )
+1 -1
View File
@@ -152,7 +152,7 @@ impl<CallData: EncodeAsFields> Payload for DefaultPayload<CallData> {
let mut fields = call let mut fields = call
.fields .fields
.iter() .iter()
.map(|f| scale_encode::Field::new(&f.ty.id, f.name.as_deref())); .map(|f| scale_encode::Field::new(f.ty.id, f.name.as_deref()));
self.call_data self.call_data
.encode_as_fields_to(&mut fields, metadata.types(), out) .encode_as_fields_to(&mut fields, metadata.types(), out)
+2 -2
View File
@@ -156,7 +156,7 @@ impl<Store, Order, R: TypeResolver> scale_decode::Visitor for DecodedBitsVisitor
fn unchecked_decode_as_type<'scale, 'info>( fn unchecked_decode_as_type<'scale, 'info>(
self, self,
input: &mut &'scale [u8], input: &mut &'scale [u8],
type_id: &R::TypeId, type_id: R::TypeId,
types: &'info R, types: &'info R,
) -> scale_decode::visitor::DecodeAsTypeResult< ) -> scale_decode::visitor::DecodeAsTypeResult<
Self, Self,
@@ -181,7 +181,7 @@ impl<Store, Order> scale_decode::IntoVisitor for DecodedBits<Store, Order> {
impl<Store, Order> scale_encode::EncodeAsType for DecodedBits<Store, Order> { impl<Store, Order> scale_encode::EncodeAsType for DecodedBits<Store, Order> {
fn encode_as_type_to<R: TypeResolver>( fn encode_as_type_to<R: TypeResolver>(
&self, &self,
type_id: &R::TypeId, type_id: R::TypeId,
types: &R, types: &R,
out: &mut Vec<u8>, out: &mut Vec<u8>,
) -> Result<(), scale_encode::Error> { ) -> Result<(), scale_encode::Error> {
+2 -2
View File
@@ -22,7 +22,7 @@ pub struct Static<T>(pub T);
impl<T: Encode> EncodeAsType for Static<T> { impl<T: Encode> EncodeAsType for Static<T> {
fn encode_as_type_to<R: TypeResolver>( fn encode_as_type_to<R: TypeResolver>(
&self, &self,
_type_id: &R::TypeId, _type_id: R::TypeId,
_types: &R, _types: &R,
out: &mut Vec<u8>, out: &mut Vec<u8>,
) -> Result<(), scale_encode::Error> { ) -> Result<(), scale_encode::Error> {
@@ -41,7 +41,7 @@ impl<T: Decode, R: TypeResolver> Visitor for StaticDecodeAsTypeVisitor<T, R> {
fn unchecked_decode_as_type<'scale, 'info>( fn unchecked_decode_as_type<'scale, 'info>(
self, self,
input: &mut &'scale [u8], input: &mut &'scale [u8],
_type_id: &R::TypeId, _type_id: R::TypeId,
_types: &'info R, _types: &'info R,
) -> DecodeAsTypeResult<Self, Result<Self::Value<'scale, 'info>, Self::Error>> { ) -> DecodeAsTypeResult<Self, Result<Self::Value<'scale, 'info>, Self::Error>> {
use scale_decode::{visitor::DecodeError, Error}; use scale_decode::{visitor::DecodeError, Error};
+2 -2
View File
@@ -55,7 +55,7 @@ impl<Address, Call, Signature, Extra> scale_encode::EncodeAsType
{ {
fn encode_as_type_to<R: TypeResolver>( fn encode_as_type_to<R: TypeResolver>(
&self, &self,
type_id: &R::TypeId, type_id: R::TypeId,
types: &R, types: &R,
out: &mut Vec<u8>, out: &mut Vec<u8>,
) -> Result<(), scale_encode::Error> { ) -> Result<(), scale_encode::Error> {
@@ -93,7 +93,7 @@ impl<Address, Call, Signature, Extra, R: TypeResolver> Visitor
fn unchecked_decode_as_type<'scale, 'info>( fn unchecked_decode_as_type<'scale, 'info>(
self, self,
input: &mut &'scale [u8], input: &mut &'scale [u8],
type_id: &R::TypeId, type_id: R::TypeId,
types: &'info R, types: &'info R,
) -> DecodeAsTypeResult<Self, Result<Self::Value<'scale, 'info>, Self::Error>> { ) -> DecodeAsTypeResult<Self, Result<Self::Value<'scale, 'info>, Self::Error>> {
DecodeAsTypeResult::Decoded(Self::Value::decode_as_type(input, type_id, types)) DecodeAsTypeResult::Decoded(Self::Value::decode_as_type(input, type_id, types))
+18 -9
View File
@@ -72,26 +72,27 @@ impl<T> WrapperKeepOpaque<T> {
impl<T> EncodeAsType for WrapperKeepOpaque<T> { impl<T> EncodeAsType for WrapperKeepOpaque<T> {
fn encode_as_type_to<R: TypeResolver>( fn encode_as_type_to<R: TypeResolver>(
&self, &self,
type_id: &R::TypeId, type_id: R::TypeId,
types: &R, types: &R,
out: &mut Vec<u8>, out: &mut Vec<u8>,
) -> Result<(), scale_encode::Error> { ) -> Result<(), scale_encode::Error> {
use scale_encode::error::{Error, ErrorKind, Kind}; use scale_encode::error::{Error, ErrorKind, Kind};
let visitor = visitor::new(out, |_, _| { let ctx = (type_id.clone(), out);
let visitor = visitor::new(ctx, |(type_id, _out), _| {
// Check that the target shape lines up: any other shape but composite is wrong. // Check that the target shape lines up: any other shape but composite is wrong.
Err(Error::new(ErrorKind::WrongShape { Err(Error::new(ErrorKind::WrongShape {
actual: Kind::Struct, actual: Kind::Struct,
expected_id: format!("{:?}", type_id), expected_id: format!("{type_id:?}"),
})) }))
}) })
.visit_composite(|out, _fields| { .visit_composite(|(_type_id, out), _path, _fields| {
self.data.encode_to(out); self.data.encode_to(out);
Ok(()) Ok(())
}); });
types types
.resolve_type(type_id, visitor) .resolve_type(type_id.clone(), visitor)
.map_err(|_| Error::new(ErrorKind::TypeNotFound(format!("{:?}", type_id))))? .map_err(|_| Error::new(ErrorKind::TypeNotFound(format!("{:?}", type_id))))?
} }
} }
@@ -105,11 +106,19 @@ impl<T, R: TypeResolver> Visitor for WrapperKeepOpaqueVisitor<T, R> {
fn visit_composite<'scale, 'info>( fn visit_composite<'scale, 'info>(
self, self,
value: &mut scale_decode::visitor::types::Composite<'scale, 'info, R>, value: &mut scale_decode::visitor::types::Composite<'scale, 'info, R>,
_type_id: &R::TypeId, _type_id: R::TypeId,
) -> Result<Self::Value<'scale, 'info>, Self::Error> { ) -> Result<Self::Value<'scale, 'info>, Self::Error> {
use scale_decode::error::{Error, ErrorKind}; use scale_decode::error::{Error, ErrorKind};
use scale_decode::visitor::DecodeError;
// TODO: When `scale-type-resolver` [provides struct names](https://github.com/paritytech/scale-type-resolver/issues/4), check that this struct name is `WrapperKeepOpaque` if value.name() != Some("WrapperKeepOpaque") {
return Err(Error::new(ErrorKind::VisitorDecodeError(
DecodeError::TypeResolvingError(format!(
"Expected a type named 'WrapperKeepOpaque', got: {:?}",
value.name()
)),
)));
}
if value.remaining() != 2 { if value.remaining() != 2 {
return Err(Error::new(ErrorKind::WrongLength { return Err(Error::new(ErrorKind::WrongLength {
@@ -193,7 +202,7 @@ mod test {
let (type_id, types) = make_type::<T>(); let (type_id, types) = make_type::<T>();
let scale_codec_encoded = t.encode(); let scale_codec_encoded = t.encode();
let encode_as_type_encoded = t.encode_as_type(&type_id, &types).unwrap(); let encode_as_type_encoded = t.encode_as_type(type_id, &types).unwrap();
assert_eq!( assert_eq!(
scale_codec_encoded, encode_as_type_encoded, scale_codec_encoded, encode_as_type_encoded,
@@ -201,7 +210,7 @@ mod test {
); );
let decode_as_type_bytes = &mut &*scale_codec_encoded; let decode_as_type_bytes = &mut &*scale_codec_encoded;
let decoded_as_type = T::decode_as_type(decode_as_type_bytes, &type_id, &types) let decoded_as_type = T::decode_as_type(decode_as_type_bytes, type_id, &types)
.expect("decode-as-type decodes"); .expect("decode-as-type decodes");
let decode_scale_codec_bytes = &mut &*scale_codec_encoded; let decode_scale_codec_bytes = &mut &*scale_codec_encoded;
+2 -2
View File
@@ -210,7 +210,7 @@ impl ModuleError {
pub fn as_root_error<E: DecodeAsType>(&self) -> Result<E, Error> { pub fn as_root_error<E: DecodeAsType>(&self) -> Result<E, Error> {
let decoded = E::decode_as_type( let decoded = E::decode_as_type(
&mut &self.bytes[..], &mut &self.bytes[..],
&self.metadata.outer_enums().error_enum_ty(), self.metadata.outer_enums().error_enum_ty(),
self.metadata.types(), self.metadata.types(),
)?; )?;
@@ -272,7 +272,7 @@ impl DispatchError {
fn unchecked_decode_as_type<'scale, 'info>( fn unchecked_decode_as_type<'scale, 'info>(
self, self,
input: &mut &'scale [u8], input: &mut &'scale [u8],
_type_id: &R::TypeId, _type_id: R::TypeId,
_types: &'info R, _types: &'info R,
) -> DecodeAsTypeResult<Self, Result<Self::Value<'scale, 'info>, Self::Error>> ) -> DecodeAsTypeResult<Self, Result<Self::Value<'scale, 'info>, Self::Error>>
{ {