Skip to content

feat(revive): add contract instantiated event #8789

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
athei merged 8 commits into from
Jun 25, 2025
Merged

feat(revive): add contract instantiated event #8789

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
d7f4038
feat(revive): add contract instantiated event
voliva Jun 5, 2025
44872e8
add prdoc
voliva Jun 6, 2025
02868c9
bump change to major
voliva Jun 6, 2025
5a9d86c
Merge remote-tracking branch 'origin/master' into revive-instantiated…
voliva Jun 24, 2025
c41a259
move instantiated event to keep pre-existing indices
voliva Jun 24, 2025
e5eb49e
Update from github-actions[bot] running command 'fmt'
github-actions[bot] Jun 24, 2025
b12b59a
Merge branch 'master' into revive-instantiated-evt
athei Jun 24, 2025
4bd566e
Merge branch 'master' into revive-instantiated-evt
athei Jun 25, 2025
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
12 changes: 12 additions & 0 deletions prdoc/pr_8789.prdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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: minor
11 changes: 9 additions & 2 deletions substrate/frame/revive/src/exec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -810,6 +810,7 @@ where
salt: Option<&[u8; 32]>,
skip_transfer: bool,
) -> Result<(H160, ExecReturnValue), ExecError> {
let deployer = T::AddressMapper::to_address(&origin);
let (mut stack, executable) = Stack::<'_, T, E>::new(
FrameArgs::Instantiate {
sender: origin.clone(),
Expand All @@ -825,9 +826,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)
.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
Comment on lines +829 to +842

@voliva voliva Jun 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added this within exec, in run_instantiate which is called only from the top frame. The other possibility was to have this in bare_instantiate of the pallet's lib.rs, but I thought it would be better to have it in here since this is the function performing the instantiation (and some tests are actually calling this function directly).

}

#[cfg(any(feature = "runtime-benchmarks", test))]
Expand Down
7 changes: 7 additions & 0 deletions substrate/frame/revive/src/exec/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1142,6 +1142,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
}]
);
Comment on lines +1148 to +1154

@voliva voliva Jun 6, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the only test that was effected.

I've checked there's also a test that already checks the case when the instantiation call succeeds but the contract is reverted - In that case there's already an assertion that checks that no events should be emitted. See instantiation_fails_with_failing_output.

All these tests were done previously, but updated the event assertions when #7164 removed the events. The only one that needed to be updated is this one.

});
}

Expand Down
3 changes: 3 additions & 0 deletions substrate/frame/revive/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -347,6 +347,9 @@ pub mod pallet {

#[pallet::event]
pub enum Event<T: Config> {
/// Contract deployed by deployer at the specified address.
Instantiated { deployer: H160, contract: H160 },

Comment thread
athei marked this conversation as resolved.
Outdated
/// A custom event emitted by the contract.
ContractEmitted {
/// The contract that emitted the event.
Expand Down
24 changes: 24 additions & 0 deletions substrate/frame/revive/src/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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![],
},
]
);
});
Expand Down Expand Up @@ -2215,6 +2223,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![],
},
]
);
});
Expand Down Expand Up @@ -2281,6 +2297,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![],
},
]
);
});
Expand Down