Clean up `CallBuilder` `return()` type #1525

HCastano · 2022-11-30T23:18:04Z

In #1450 I had to change the return type used by CallBuilder callers in order to be
able to encode/decode the new MessageResult return type.

This PR bakes the assumption that all messages must return a MessageResult into the
into the CallBuilder's call stack, allowing callers to specify only the message return
type again. I.e, instead of returns::<Result<R, LangError>>() you can again specify just
returns::<R>().

A breaking change that ended up being introduced here is that ink_env::invoke_contract now
returns a MessageResult<R>, whereas it previously returned just R.

I'm not sure if we need to do anything for for the DelegateCall implementation, but we can
leave that as a follow-up since there are already examples of people stumbling due to (the
lack of) this: use-ink/ink-workshop#31.

codecov-commenter · 2023-01-17T00:21:04Z

Codecov Report

Merging #1525 (2c21791) into master (8ed95ea) will decrease coverage by 0.07%.
The diff coverage is 25.00%.

@@            Coverage Diff             @@
##           master    #1525      +/-   ##
==========================================
- Coverage   71.59%   71.52%   -0.08%     
==========================================
  Files         205      205              
  Lines        6292     6296       +4     
==========================================
- Hits         4505     4503       -2     
- Misses       1787     1793       +6

Impacted Files	Coverage Δ
crates/e2e/src/client.rs	`36.36% <ø> (ø)`
crates/env/src/api.rs	`36.92% <0.00%> (ø)`
crates/env/src/backend.rs	`78.12% <ø> (ø)`
crates/env/src/call/call_builder.rs	`0.00% <0.00%> (ø)`
crates/env/src/engine/off_chain/impls.rs	`47.64% <ø> (ø)`
...odegen/src/generator/as_dependency/contract_ref.rs	`100.00% <ø> (ø)`
crates/ink/src/env_access.rs	`9.09% <ø> (ø)`
...odegen/src/generator/as_dependency/call_builder.rs	`100.00% <100.00%> (ø)`
crates/allocator/src/bump.rs	`89.07% <0.00%> (-1.01%)`	⬇️

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

crates/env/src/call/call_builder.rs

athei · 2023-01-18T18:39:07Z

crates/env/src/api.rs

-pub fn invoke_contract<E, Args, R>(params: &CallParams<E, Call<E>, Args, R>) -> Result<R>
+pub fn invoke_contract<E, Args, R>(
+    params: &CallParams<E, Call<E>, Args, R>,
+) -> Result<ink_primitives::MessageResult<R>>


I know not related to this PR but do we really need these standalone functions? I don't think we want multiple ways to do the same thing.

I'm not sure how much use external developers are making of these specific APIs, but it's
probably important to leave them in. This at least gives developers a chance to optimize
their contracts, and third-party tooling to improve upon our abstractions.

A counter-argument here might be that this API is already opinionated (e.g the use of
CallParams) and doesn't give developers enough room to optimize or improve upon it. In
this case, maybe we want to expose even lower level APIs, but I'm not sure we want to go
down that route

I can't see how those stand alone function are more low level. Both operate on the same type CallParams. The difference is just inherent vs free function. This is just a mechanical change.

athei · 2023-01-18T18:44:42Z

crates/env/src/call/call_builder.rs

    pub fn invoke(&self) -> Result<R, crate::Error> {
+        crate::invoke_contract(self).map(|inner| {


I think we should take the chance to also unwrap the error from pallet-contracts while we are breaking things. Let's just make the default path as safe and frictionless as possible.

Yeah good idea. I'll do this in a small follow-up so that the CreateBuilder methods can also be included in the clean-up.

Edit: done in #1602

ascjones · 2023-01-19T10:38:02Z

crates/env/src/call/call_builder.rs

+    ///
+    /// # Note
+    ///
+    /// On failure this returns an [`ink_primitives::LangError`] which can be handled by the caller.


It would be more accurate to clarify that the inner Result will be a LangError, and the outer Result is an environmental error.

Yep, I'll fix it in the follow-up that removes the EnvError from the default execution path

* Assume that `CallBuilder`s return a `MessageResult` * Add `try_*` variants to `CallBuilder` * Add doc test showing how to handle `LangError` from `build_call` * Remove TODO related to `delegate_call` * Account for `LangError` in E2E tests * Improve `return_value` error message * Remove extra `expect` from E2E tests * Add test for checking that `fire` panics on `LangError` * Fix spelling * Remove extra `unwrap` in more E2E tests * Fix ERC-1155 example * Fix `invoke_contract` doc test * RustFmt * Fix `delegator` example * Update ERC-20 tests * Indicate that doc test panics in off-chain env * Forgot some commas 🤦 * Get `Flipper` example compiling again * Remove more unwraps * Update UI tests * Print out `LangError` when panicking after `invoke` * Bump `scale` to fix UI tests

DoubleOTheven · 2023-05-26T02:47:39Z

The change mentioned above: returns a MessageResult<R>, whereas it previously returned just R has been incredibly helpful on the front end. It is probably my favorite feature that ink! offers over Solidity. Nice work 👏🏼

HCastano added 4 commits November 30, 2022 16:33

Assume that CallBuilders return a MessageResult

b211af1

Add try_* variants to CallBuilder

5b9b1f1

Add doc test showing how to handle LangError from build_call

65edbfe

Remove TODO related to delegate_call

caba49c

HCastano mentioned this pull request Dec 11, 2022

Add support for language level errors (LangError) #1450

Merged

7 tasks

deuszx mentioned this pull request Jan 10, 2023

Fix the usage of CallBuilder pattern. Cardinal-Cryptography/bulletin-board-example#10

Merged

HCastano mentioned this pull request Jan 14, 2023

Handle LangError from instantiate #1512

Merged

HCastano added 17 commits January 15, 2023 12:50

Merge branch 'master' into hc-clean-up-call-builder-return

6e00bae

Account for LangError in E2E tests

a258897

Improve return_value error message

d8fb710

Remove extra expect from E2E tests

cb22885

Add test for checking that fire panics on LangError

313780d

Fix spelling

2710f17

Remove extra unwrap in more E2E tests

f03b929

Fix ERC-1155 example

5a6934d

Fix invoke_contract doc test

1716f88

RustFmt

1b6beec

Fix delegator example

b3f8888

Update ERC-20 tests

09e1b53

Indicate that doc test panics in off-chain env

a662d99

Forgot some commas 🤦

782ed2e

Get Flipper example compiling again

ffd3926

Remove more unwraps

84b5924

Update UI tests

2c21791

HCastano marked this pull request as ready for review January 17, 2023 00:31

HCastano requested review from cmichi and ascjones as code owners January 17, 2023 00:31

HCastano requested review from xermicus and athei January 17, 2023 00:31

athei reviewed Jan 18, 2023

View reviewed changes

HCastano added 2 commits January 18, 2023 15:48

Print out LangError when panicking after invoke

63d7b1c

Bump scale to fix UI tests

51af07e

athei approved these changes Jan 19, 2023

View reviewed changes

ascjones approved these changes Jan 19, 2023

View reviewed changes

HCastano merged commit e2715f7 into master Jan 19, 2023

HCastano deleted the hc-clean-up-call-builder-return branch January 19, 2023 22:53

HCastano mentioned this pull request Jan 20, 2023

Make CallBuilder and CreateBuilder error handling optional #1602

Merged

HCastano mentioned this pull request Jan 24, 2023

Release v4.0.0-beta.1 #1617

Merged

ascjones mentioned this pull request Feb 3, 2023

Incorrect codegen for trait methods #1530

Closed

ascjones mentioned this pull request Feb 15, 2023

Release v4.0.0 #1653

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clean up `CallBuilder` `return()` type #1525

Clean up `CallBuilder` `return()` type #1525

HCastano commented Nov 30, 2022 •

edited

Loading

codecov-commenter commented Jan 17, 2023 •

edited

Loading

athei Jan 18, 2023

HCastano Jan 19, 2023

athei Jan 19, 2023 •

edited

Loading

athei Jan 18, 2023

HCastano Jan 18, 2023 •

edited

Loading

ascjones Jan 19, 2023

HCastano Jan 19, 2023

DoubleOTheven commented May 26, 2023

		pub fn invoke(&self) -> Result<R, crate::Error> {
		crate::invoke_contract(self).map(\|inner\| {

Clean up CallBuilder return() type #1525

Clean up CallBuilder return() type #1525

Conversation

HCastano commented Nov 30, 2022 • edited Loading

codecov-commenter commented Jan 17, 2023 • edited Loading

Codecov Report

athei Jan 18, 2023

Choose a reason for hiding this comment

HCastano Jan 19, 2023

Choose a reason for hiding this comment

athei Jan 19, 2023 • edited Loading

Choose a reason for hiding this comment

athei Jan 18, 2023

Choose a reason for hiding this comment

HCastano Jan 18, 2023 • edited Loading

Choose a reason for hiding this comment

ascjones Jan 19, 2023

Choose a reason for hiding this comment

HCastano Jan 19, 2023

Choose a reason for hiding this comment

DoubleOTheven commented May 26, 2023

Clean up `CallBuilder` `return()` type #1525

Clean up `CallBuilder` `return()` type #1525

HCastano commented Nov 30, 2022 •

edited

Loading

codecov-commenter commented Jan 17, 2023 •

edited

Loading

athei Jan 19, 2023 •

edited

Loading

HCastano Jan 18, 2023 •

edited

Loading