contracts: add events to ContractResult #13807

juangirini · 2023-04-03T09:22:17Z

It adds an Option events to the ContractResult struct (ContractExecResult and ContractInstantiateResult) so that calls to bare_call and bare_instantiate can return the events collected. This is useful when dry running.

Collecting events though should only be done outside of the runtime block execution, so that the bare_call and bare_instantiate functions accept a new debug parameter of type DebugInfo which is an enum. When debug is set to DebugInfo::UnsafeDebug the events are collected, when set to DebugInfo::Skip events return None.

Related Cargo Contract issue

cumulus companion: paritytech/cumulus#2510

…return-emitted-events-for-dry-runs

juangirini · 2023-04-06T08:37:55Z

@athei This changes have been tested successfully against the contract-ui tool, but not against cargo-contract due to its issue reported yesterday

juangirini · 2023-05-02T09:20:54Z

bot help

command-bot · 2023-05-02T09:20:57Z

Here's a link to docs

agryaznov

Shouldn't this PR have a cumulus companion?

frame/contracts/primitives/src/lib.rs

frame/contracts/src/lib.rs

frame/contracts/src/tests.rs

frame/contracts/src/lib.rs

pgherveou · 2023-05-03T08:46:29Z

frame/contracts/src/lib.rs

@@ -980,7 +980,7 @@ pub enum CollectEvents {
 	///
 	/// # Note
 	///
-	/// Events should only be collected when called off-chain, as this would
+	/// Events should only be collected when called off-chain, as this would otherwise
 	/// collect all the Events emitted in the block so far and put them in them into the PoV.


Suggested change

/// collect all the Events emitted in the block so far and put them in them into the PoV.

/// collect all the Events emitted in the block so far and put them into the PoV.

missed that earlier

athei

Nice. Ready to merge after those last nits are removed.

athei · 2023-05-03T08:55:48Z

bin/node/runtime/src/lib.rs

+use pallet_contracts_primitives::{
+	Code, CodeUploadResult, ContractExecResult, ContractInstantiateResult, GetStorageResult,
+};


I think this is no longer needed, right? It is a bit inconsistent now. Sometimes you use fully qualified types and sometimes you use those imports.

Those types are used in the code, we do need either the imports or the fully qualified types.
There is indeed a mix of both in that file, not sure what is the guideline here. I am making them all fully qualified so at least it is consistent in my own code

Yes. This is what I was getting at. Thanks.

athei · 2023-05-03T09:00:36Z

frame/contracts/primitives/src/lib.rs

@@ -71,15 +71,26 @@ pub struct ContractResult<R, Balance> {
 	pub debug_message: Vec<u8>,
 	/// The execution result of the wasm code.
 	pub result: R,
+	/// The events that were emitted during execution. It is an options as event collection is
+	/// optional.
+	pub events: Option<Vec<EventRecord>>,


Can you add a #Note to the type to warn users that we take the liberty to extend the type with new data without bumping the API version? It should warn them to always ignore trailing data.

athei · 2023-05-03T09:02:32Z

Shouldn't this PR have a cumulus companion?

Correct. CI is complaining.

juangirini · 2023-05-03T12:59:45Z

bot merge

paritytech-processbot · 2023-05-03T12:59:53Z

Waiting for commit status.

* contracts: add events to ContractResult * contracts: add encoded events to ContractResult * contracts: add generic Event to ContractResult * contracts: test bare_call events * contracts: update bare_call test name * contracts: add better comments to dry run events * contracts: fix pallet contracts primitives implementation * contracts: add EventRecord generic to ContractInstantiateResult * contracts: make event collection optional * contracts: impreved notes on `collect_events` * contracts: update benchmarking calls * contracts: change bare_call and bare_instantiate to accept enums instead of bools * contracts: add partial eq to new enums * contracts: improve comments * contracts: improve comments * contracts: fix bare_call benchmarking * contracts: fix bare call and instantiate in impl_runtime_apis * contracts: add api versioning to new ContractsApi functions * contracts: modify api versioning to new ContractsApi functions * contracts: create new contracts api trait * contracts: clean up code * contracts: remove the contract results with events * contracts: undo contracts api v3 * contracts: remove commented out code * contracts: add new test bare call result does not return events * contracts: add code review improvements * contracts: remove type imports * contracts: minor code review improvements

contracts: add events to ContractResult

47200ff

juangirini linked an issue Apr 3, 2023 that may be closed by this pull request

Contracts: Return emitted events for dry-runs #12412

Closed

juangirini added 10 commits April 3, 2023 17:04

contracts: add encoded events to ContractResult

a534758

contracts: add generic Event to ContractResult

28a9643

Merge remote-tracking branch 'origin/master' into jg/12412-contracts-…

cf43686

…return-emitted-events-for-dry-runs

contracts: test bare_call events

08db645

contracts: update bare_call test name

7ca1b4b

contracts: add better comments to dry run events

5ad0868

contracts: fix pallet contracts primitives implementation

dbd8735

contracts: add EventRecord generic to ContractInstantiateResult

1718400

contracts: make event collection optional

782aba7

contracts: impreved notes on collect_events

74d4b70

juangirini self-assigned this Apr 6, 2023

juangirini mentioned this pull request Apr 6, 2023

Update pallet contracts primitives with new generic use-ink/cargo-contract#1064

Closed

juangirini marked this pull request as ready for review April 6, 2023 08:31

juangirini requested a review from athei as a code owner April 6, 2023 08:31

juangirini added A0-please_review Pull request needs code review. and removed A3-in_progress Pull request is in progress. No review needed at this stage. labels Apr 6, 2023

juangirini requested review from pgherveou and agryaznov April 6, 2023 08:32

juangirini requested a review from xermicus April 6, 2023 08:38

contracts: update benchmarking calls

45e6eab

juangirini added the T2-API This PR/Issue is related to APIs. label Apr 6, 2023

juangirini requested a review from athei May 2, 2023 09:38

juangirini added 4 commits May 2, 2023 14:41

contracts: remove the contract results with events

fca001f

contracts: undo contracts api v3

a8da1ff

contracts: remove commented out code

af6587a

contracts: add new test bare call result does not return events

9919fd1

agryaznov reviewed May 3, 2023

View reviewed changes

pgherveou reviewed May 3, 2023

View reviewed changes

frame/contracts/src/lib.rs Outdated Show resolved Hide resolved

juangirini added 2 commits May 3, 2023 10:04

contracts: merge master and resolve conflicts

51894be

contracts: add code review improvements

1e09bdb

juangirini requested review from agryaznov and pgherveou May 3, 2023 08:41

pgherveou reviewed May 3, 2023

View reviewed changes

pgherveou approved these changes May 3, 2023

View reviewed changes

athei approved these changes May 3, 2023

View reviewed changes

juangirini added 2 commits May 3, 2023 11:21

contracts: remove type imports

eef0f97

contracts: minor code review improvements

3023dfd

juangirini mentioned this pull request May 3, 2023

Companion PR for add events to ContractResult paritytech/cumulus#2510

Merged

paritytech-processbot bot merged commit 44130d5 into master May 3, 2023

paritytech-processbot bot deleted the jg/12412-contracts-return-emitted-events-for-dry-runs branch May 3, 2023 13:45

github-actions bot mentioned this pull request Jun 15, 2023

Update substrate/polkadot/cumulus from v0.9.40 to v0.9.43 moonbeam-foundation/moonbeam#2354

Closed

kiltbot mentioned this pull request Jun 21, 2023

1️⃣ [AUTOMATIC] Update Polkadot dependencies from 0.9.42 to 0.9.43 KILTprotocol/kilt-node#531

Closed

kacperzuk-neti mentioned this pull request Jun 23, 2023

Polkadot v0.9.43 liberland/liberland_substrate#295

Merged

15 tasks

jasl mentioned this pull request Jun 30, 2023

Upgrade to Polkadot v0.9.43 Phala-Network/phala-blockchain#1313

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

contracts: add events to ContractResult #13807

contracts: add events to ContractResult #13807

juangirini commented Apr 3, 2023 •

edited by athei

Loading

juangirini commented Apr 6, 2023

juangirini commented May 2, 2023

command-bot bot commented May 2, 2023

agryaznov left a comment

pgherveou May 3, 2023

athei left a comment

athei May 3, 2023

juangirini May 3, 2023

athei May 3, 2023

athei May 3, 2023

athei commented May 3, 2023

juangirini commented May 3, 2023

paritytech-processbot bot commented May 3, 2023

	/// collect all the Events emitted in the block so far and put them in them into the PoV.
	/// collect all the Events emitted in the block so far and put them into the PoV.

contracts: add events to ContractResult #13807

contracts: add events to ContractResult #13807

Conversation

juangirini commented Apr 3, 2023 • edited by athei Loading

juangirini commented Apr 6, 2023

juangirini commented May 2, 2023

command-bot bot commented May 2, 2023

agryaznov left a comment

Choose a reason for hiding this comment

pgherveou May 3, 2023

Choose a reason for hiding this comment

athei left a comment

Choose a reason for hiding this comment

athei May 3, 2023

Choose a reason for hiding this comment

juangirini May 3, 2023

Choose a reason for hiding this comment

athei May 3, 2023

Choose a reason for hiding this comment

athei May 3, 2023

Choose a reason for hiding this comment

athei commented May 3, 2023

juangirini commented May 3, 2023

paritytech-processbot bot commented May 3, 2023

juangirini commented Apr 3, 2023 •

edited by athei

Loading