feat(revive): add contract instantiated event (#8789)

# Description

This PR adds the `Instantiated` event for pallet-revive for the top
frame. Addresses issue #8677

This might need refreshing the weights of bot `instantiate` and
`instantiate_with_code`, as it emits a new event.

## Integration

No additional work is needed to integrate this feature. The pallet will
emit on `Instantiated` event every time `instantiate` or
`instantiate_with_code` successfully performs an instantiation.

# Checklist

* [x] My PR includes a detailed description as outlined in the
"Description" and its two subsections above.
* [x] My PR follows the [labeling requirements](

https://github.com/paritytech/polkadot-sdk/blob/master/docs/contributor/CONTRIBUTING.md#Process
) of this project (at minimum one label for `T` required)
* External contributors: ask maintainers to put the right label on your
PR.
* [x] I have made corresponding changes to the documentation (if
applicable)
* [x] I have added tests that prove my fix is effective or that my
feature works (if applicable)

---------

Co-authored-by: cmd[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Alexander Theißen <[email protected]>

Author: 3 people

prdoc/pr_8789.prdoc

@@ -0,0 +1,12 @@
+# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
+# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json
+
+title: '[pallet-revive] Add contract instantiated event'
+
+doc:
+  - audience: Runtime Dev
+    description: ' `instantiate` and `instantiate_with_code` emit a `Instantiated` event.'
+
+crates:
+  - name: pallet-revive
+    bump: major

substrate/frame/revive/src/exec.rs

@@ -815,6 +815,7 @@ where
 		skip_transfer: bool,
 		bump_nonce: BumpNonce,
 	) -> Result<(H160, ExecReturnValue), ExecError> {
+		let deployer = T::AddressMapper::to_address(&origin);
 		let (mut stack, executable) = Stack::<'_, T, E>::new(
 			FrameArgs::Instantiate {
 				sender: origin.clone(),
@@ -830,9 +831,15 @@ where
 		)?
 		.expect(FRAME_ALWAYS_EXISTS_ON_INSTANTIATE);
 		let address = T::AddressMapper::to_address(&stack.top_frame().account_id);
-		stack
+		let result = stack
 			.run(executable, input_data, bump_nonce)
-			.map(|_| (address, stack.first_frame.last_frame_output))
+			.map(|_| (address, stack.first_frame.last_frame_output));
+		if let Ok((contract, ref output)) = result {
+			if !output.did_revert() {
+				Contracts::<T>::deposit_event(Event::Instantiated { deployer, contract });
+			}
+		}
+		result
 	}
 
 	#[cfg(any(feature = "runtime-benchmarks", test))]
@@ -930,7 +937,7 @@ where
 						if let Some(info) = <ContractInfoOf<T>>::get(&address) {
 							CachedContract::Cached(info)
 						} else {
-							return Ok(None)
+							return Ok(None);
 						},
 					(None, Some(precompile)) if precompile.has_contract_info() => {
 						if let Some(info) = <ContractInfoOf<T>>::get(&address) {

substrate/frame/revive/src/exec/tests.rs

@@ -1145,6 +1145,13 @@ fn instantiation_work_with_success_output() {
 				ContractInfo::<Test>::load_code_hash(&instantiated_contract_id).unwrap(),
 				dummy_ch
 			);
+			assert_eq!(
+				&events(),
+				&[Event::Instantiated {
+					deployer: ALICE_ADDR,
+					contract: instantiated_contract_address
+				}]
+			);
 		});
 }
 

substrate/frame/revive/src/lib.rs

@@ -361,6 +361,9 @@ pub mod pallet {
 			/// Number of topics is capped by [`limits::NUM_EVENT_TOPICS`].
 			topics: Vec<H256>,
 		},
+
+		/// Contract deployed by deployer at the specified address.
+		Instantiated { deployer: H160, contract: H160 },
 	}
 
 	#[pallet::error]

substrate/frame/revive/src/tests.rs

@@ -519,6 +519,14 @@ fn instantiate_and_call_and_deposit_event() {
 					}),
 					topics: vec![],
 				},
+				EventRecord {
+					phase: Phase::Initialization,
+					event: RuntimeEvent::Contracts(crate::Event::Instantiated {
+						deployer: ALICE_ADDR,
+						contract: addr
+					}),
+					topics: vec![],
+				},
 			]
 		);
 	});
@@ -2220,6 +2228,14 @@ fn instantiate_with_zero_balance_works() {
 					}),
 					topics: vec![],
 				},
+				EventRecord {
+					phase: Phase::Initialization,
+					event: RuntimeEvent::Contracts(crate::Event::Instantiated {
+						deployer: ALICE_ADDR,
+						contract: addr,
+					}),
+					topics: vec![],
+				},
 			]
 		);
 	});
@@ -2286,6 +2302,14 @@ fn instantiate_with_below_existential_deposit_works() {
 					}),
 					topics: vec![],
 				},
+				EventRecord {
+					phase: Phase::Initialization,
+					event: RuntimeEvent::Contracts(crate::Event::Instantiated {
+						deployer: ALICE_ADDR,
+						contract: addr,
+					}),
+					topics: vec![],
+				},
 			]
 		);
 	});