Skip to content

Chain Extension: Evaluation of method return type at compile time #1569

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cmichi merged 13 commits into from
Jan 24, 2023
Merged

Chain Extension: Evaluation of method return type at compile time #1569

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
06ac319
remove returns_result attr
Dec 15, 2022
d58e571
generic return type based on const eval
Dec 21, 2022
2c1a671
working concept of const eval of result type
Dec 24, 2022
d30c7b3
cargo fmt
Dec 24, 2022
2f15161
Merge branch 'master' into gn/ce-use-result-macro
Dec 24, 2022
ab9b1c5
code cleanup and docs
Dec 26, 2022
59e433f
fix typos
Dec 26, 2022
0e0b710
uncomment other UI tests
Dec 26, 2022
045b8e6
clarify comment and fix typos
Dec 26, 2022
0a41504
provide correct args to generics in doctest
Dec 26, 2022
3edee36
Add entry to CHANGELOG
Dec 28, 2022
7b3d181
Fix punctuation
cmichi Jan 24, 2023
1a40267
Merge branch 'master' into gn/ce-use-result-macro
cmichi Jan 24, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
remove returns_result attr
  • Loading branch information
SkymanOne committed Dec 15, 2022
commit 06ac31903a6647d41690c8488dbdfebaa4b19afc
72 changes: 33 additions & 39 deletions crates/ink/codegen/src/generator/chain_extension.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ impl ChainExtension<'_> {
};

let handle_status = method.handle_status();
let returns_result = method.returns_result();

let error_code_handling = if handle_status {
quote_spanned!(span=>
Expand All @@ -85,55 +84,50 @@ impl ChainExtension<'_> {
)
};

let result_handling = if returns_result {
let returned_type = if handle_status {
quote_spanned!(span=>
.output_result::<
<#output_type as ::ink::IsResultType>::Ok,
<#output_type as ::ink::IsResultType>::Err,
>()
::core::result::Result<#output_type, #error_code>
)
} else {
quote_spanned!(span=>
.output::<#output_type>()
#output_type
)
};

let returned_type = match (returns_result, handle_status) {
(false, true) => {
quote_spanned!(span=>
::core::result::Result<#output_type, #error_code>
)
}
_ => {
quote_spanned!(span=>
#output_type
)
}
};

let where_output_is_result = Some(quote_spanned!(span=>
#output_type: ::ink::IsResultType,
))
.filter(|_| returns_result);

let where_output_impls_from_error_code = Some(quote_spanned!(span=>
<#output_type as ::ink::IsResultType>::Err: ::core::convert::From<#error_code>,
)).filter(|_| returns_result && handle_status);
)).filter(|_| handle_status);

quote_spanned!(span=>
#( #attrs )*
#[inline]
pub fn #ident(self, #inputs) -> #returned_type
where
#where_output_is_result
#where_output_impls_from_error_code
{
::ink::env::chain_extension::ChainExtensionMethod::build(#func_id)
.input::<#compound_input_type>()
#result_handling
#error_code_handling
.call(&#compound_input_bindings)
}
const #ident : #ident = if ::ink::is_result_type!(#output_type) {
#( #attrs )*
#[inline]
pub fn #ident(self, #inputs) -> #returned_type
where
#output_type: ::ink::IsResultType,
#where_output_impls_from_error_code
{
::ink::env::chain_extension::ChainExtensionMethod::build(#func_id)
.input::<#compound_input_type>()
.output_result::<
<#output_type as ::ink::IsResultType>::Ok,
<#output_type as ::ink::IsResultType>::Err,
>()
#error_code_handling
.call(&#compound_input_bindings)
}
} else {
#( #attrs )*
#[inline]
pub fn #ident(self, #inputs) -> #output_type
{
::ink::env::chain_extension::ChainExtensionMethod::build(#func_id)
.input::<#compound_input_type>()
.output::<#output_type>()
#error_code_handling
.call(&#compound_input_bindings)
}
};
)
}
}
Expand Down
79 changes: 0 additions & 79 deletions crates/ink/ir/src/ir/attrs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,15 +303,6 @@ impl InkAttribute {
.args()
.any(|arg| matches!(arg.kind(), AttributeArg::HandleStatus(false)))
}

/// Returns `false` if the ink! attribute contains the `returns_result = false` argument.
///
/// Otherwise returns `true`.
pub fn is_returns_result(&self) -> bool {
!self
.args()
.any(|arg| matches!(arg.kind(), AttributeArg::ReturnsResult(false)))
}
}

/// An ink! specific attribute argument.
Expand Down Expand Up @@ -362,8 +353,6 @@ pub enum AttributeArgKind {
Implementation,
/// `#[ink(handle_status = flag: bool)]`
HandleStatus,
/// `#[ink(returns_result = flag: bool)]`
ReturnsResult,
}

/// An ink! specific attribute flag.
Expand Down Expand Up @@ -444,12 +433,6 @@ pub enum AttributeArg {
///
/// Default value: `true`
HandleStatus(bool),
/// `#[ink(returns_result = flag: bool)]`
///
/// Used by the `#[ink::chain_extension]` procedural macro.
///
/// Default value: `true`
ReturnsResult(bool),
}

impl core::fmt::Display for AttributeArgKind {
Expand All @@ -473,7 +456,6 @@ impl core::fmt::Display for AttributeArgKind {
}
Self::Implementation => write!(f, "impl"),
Self::HandleStatus => write!(f, "handle_status"),
Self::ReturnsResult => write!(f, "returns_result"),
}
}
}
Expand All @@ -494,7 +476,6 @@ impl AttributeArg {
Self::Namespace(_) => AttributeArgKind::Namespace,
Self::Implementation => AttributeArgKind::Implementation,
Self::HandleStatus(_) => AttributeArgKind::HandleStatus,
Self::ReturnsResult(_) => AttributeArgKind::ReturnsResult,
}
}
}
Expand All @@ -518,7 +499,6 @@ impl core::fmt::Display for AttributeArg {
}
Self::Implementation => write!(f, "impl"),
Self::HandleStatus(value) => write!(f, "handle_status = {:?}", value),
Self::ReturnsResult(value) => write!(f, "returns_result = {:?}", value),
}
}
}
Expand Down Expand Up @@ -978,16 +958,6 @@ impl TryFrom<syn::NestedMeta> for AttributeFrag {
}
return Err(format_err!(name_value, "expected `bool` value type for `flag` in #[ink(handle_status = flag)]"))
}
if name_value.path.is_ident("returns_result") {
if let syn::Lit::Bool(lit_bool) = &name_value.lit {
let value = lit_bool.value;
return Ok(AttributeFrag {
ast: meta,
arg: AttributeArg::ReturnsResult(value),
})
}
return Err(format_err!(name_value, "expected `bool` value type for `flag` in #[ink(returns_result = flag)]"))
}
Err(format_err_spanned!(
meta,
"unknown ink! attribute argument (name = value)",
Expand Down Expand Up @@ -1027,11 +997,6 @@ impl TryFrom<syn::NestedMeta> for AttributeFrag {
"encountered #[ink(handle_status)] that is missing its `flag: bool` parameter. \
Did you mean #[ink(handle_status = flag: bool)] ?"
)),
"returns_result" => Err(format_err!(
meta,
"encountered #[ink(returns_result)] that is missing its `flag: bool` parameter. \
Did you mean #[ink(returns_result = flag: bool)] ?"
)),
_ => Err(format_err_spanned!(
meta, "unknown ink! attribute (path)"
))
Expand Down Expand Up @@ -1411,50 +1376,6 @@ mod tests {
);
}

#[test]
fn returns_result_works() {
fn expected_ok(value: bool) -> Result<test::Attribute, &'static str> {
Ok(test::Attribute::Ink(vec![AttributeArg::ReturnsResult(
value,
)]))
}
assert_attribute_try_from(
syn::parse_quote! {
#[ink(returns_result = true)]
},
expected_ok(true),
);
assert_attribute_try_from(
syn::parse_quote! {
#[ink(returns_result = false)]
},
expected_ok(false),
);
}

#[test]
fn returns_result_missing_parameter() {
assert_attribute_try_from(
syn::parse_quote! {
#[ink(returns_result)]
},
Err(
"encountered #[ink(returns_result)] that is missing its `flag: bool` parameter. \
Did you mean #[ink(returns_result = flag: bool)] ?",
),
);
}

#[test]
fn returns_result_invalid_parameter_type() {
assert_attribute_try_from(
syn::parse_quote! {
#[ink(returns_result = "string")]
},
Err("expected `bool` value type for `flag` in #[ink(returns_result = flag)]"),
);
}

#[test]
fn compound_mixed_works() {
assert_attribute_try_from(
Expand Down
27 changes: 5 additions & 22 deletions crates/ink/ir/src/ir/chain_extension.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,6 @@ pub struct ChainExtensionMethod {
///
/// The default for this flag is `true`.
handle_status: bool,
/// If `false` the procedural macro no longer tries to enforce that the returned type encoded
/// into the output buffer of the chain extension method call is of type `Result<T, E>`.
/// Also `E` is no longer required to implement `From<Self::ErrorCode>` in case `handle_status`
/// flag does not exist.
///
/// The default for this flag is `true`.
returns_result: bool,
}

impl ChainExtensionMethod {
Expand Down Expand Up @@ -138,11 +131,6 @@ impl ChainExtensionMethod {
pub fn handle_status(&self) -> bool {
self.handle_status
}

/// Returns `true` if the chain extension method was flagged with `#[ink(returns_result)]`.
pub fn returns_result(&self) -> bool {
self.returns_result
}
}

pub struct ChainExtensionMethodInputs<'a> {
Expand Down Expand Up @@ -278,7 +266,7 @@ impl ChainExtension {
item_type.ident,
"chain extensions expect an associated type with name `ErrorCode` but found {}",
item_type.ident,
))
));
}
if !item_type.generics.params.is_empty() {
return Err(format_err_spanned!(
Expand Down Expand Up @@ -412,7 +400,7 @@ impl ChainExtension {
return Err(format_err_spanned!(
default_impl,
"ink! chain extension methods with default implementations are not supported"
))
));
}
if let Some(constness) = &method.sig.constness {
return Err(format_err_spanned!(
Expand Down Expand Up @@ -486,8 +474,7 @@ impl ChainExtension {
|arg| {
match arg.kind() {
ir::AttributeArg::Extension(_)
| ir::AttributeArg::HandleStatus(_)
| ir::AttributeArg::ReturnsResult(_) => Ok(()),
| ir::AttributeArg::HandleStatus(_) => Ok(()),
_ => Err(None),
}
},
Expand All @@ -502,7 +489,6 @@ impl ChainExtension {
id: extension,
item: item_method.clone(),
handle_status: ink_attrs.is_handle_status(),
returns_result: ink_attrs.is_returns_result(),
};
Ok(result)
}
Expand Down Expand Up @@ -932,20 +918,17 @@ mod tests {

#[ink(extension = 1, handle_status = false)]
fn extension_a();
#[ink(extension = 2, returns_result = false)]
#[ink(extension = 2)]
fn extension_b();
#[ink(extension = 3, handle_status = false, returns_result = false)]
#[ink(extension = 3, handle_status = false)]
fn extension_c();

#[ink(extension = 4)]
#[ink(handle_status = false)]
fn extension_d();
#[ink(extension = 5)]
#[ink(returns_result = false)]
fn extension_e();
#[ink(extension = 6)]
#[ink(handle_status = false)]
#[ink(returns_result = false)]
fn extension_f();
}
})
Expand Down
26 changes: 13 additions & 13 deletions crates/ink/tests/compile_tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,25 @@
fn ui_tests() {
let t = trybuild::TestCases::new();

t.pass("tests/ui/blake2b/pass/*.rs");
t.compile_fail("tests/ui/blake2b/fail/*.rs");
// t.pass("tests/ui/blake2b/pass/*.rs");
// t.compile_fail("tests/ui/blake2b/fail/*.rs");

t.pass("tests/ui/selector_id/pass/*.rs");
t.compile_fail("tests/ui/selector_id/fail/*.rs");
// t.pass("tests/ui/selector_id/pass/*.rs");
// t.compile_fail("tests/ui/selector_id/fail/*.rs");

t.pass("tests/ui/selector_bytes/pass/*.rs");
t.compile_fail("tests/ui/selector_bytes/fail/*.rs");
// t.pass("tests/ui/selector_bytes/pass/*.rs");
// t.compile_fail("tests/ui/selector_bytes/fail/*.rs");

t.pass("tests/ui/contract/pass/*.rs");
t.compile_fail("tests/ui/contract/fail/*.rs");
// t.pass("tests/ui/contract/pass/*.rs");
// t.compile_fail("tests/ui/contract/fail/*.rs");

t.pass("tests/ui/storage_item/pass/*.rs");
t.compile_fail("tests/ui/storage_item/fail/*.rs");
// t.pass("tests/ui/storage_item/pass/*.rs");
// t.compile_fail("tests/ui/storage_item/fail/*.rs");

t.pass("tests/ui/trait_def/pass/*.rs");
t.compile_fail("tests/ui/trait_def/fail/*.rs");
// t.pass("tests/ui/trait_def/pass/*.rs");
// t.compile_fail("tests/ui/trait_def/fail/*.rs");

t.pass("tests/ui/chain_extension/E-01-simple.rs");

t.pass("tests/ui/pay_with_call/pass/multiple_args.rs");
// t.pass("tests/ui/pay_with_call/pass/multiple_args.rs");
}
6 changes: 3 additions & 3 deletions crates/ink/tests/ui/chain_extension/E-01-simple.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ pub trait RuntimeReadWrite {
type ErrorCode = ReadWriteErrorCode;

/// Reads from runtime storage.
#[ink(extension = 1, returns_result = false)]
#[ink(extension = 1)]
fn read(key: &[u8]) -> Vec<u8>;

/// Reads from runtime storage.
Expand All @@ -22,11 +22,11 @@ pub trait RuntimeReadWrite {
fn read_small(key: &[u8]) -> Result<(u32, [u8; 32]), ReadWriteError>;

/// Writes into runtime storage.
#[ink(extension = 3, returns_result = false)]
#[ink(extension = 3)]
fn write(key: &[u8], value: &[u8]);

/// Returns the access allowed for the key for the caller.
#[ink(extension = 4, returns_result = false, handle_status = false)]
#[ink(extension = 4, handle_status = false)]
fn access(key: &[u8]) -> Option<Access>;

/// Unlocks previously aquired permission to access key.
Expand Down
2 changes: 1 addition & 1 deletion examples/rand-extension/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ pub trait FetchRandom {

/// Note: this gives the operation a corresponding `func_id` (1101 in this case),
/// and the chain-side chain extension will get the `func_id` to do further operations.
#[ink(extension = 1101, returns_result = false)]
#[ink(extension = 1101)]
fn fetch_random(subject: [u8; 32]) -> [u8; 32];
}

Expand Down