Skip to content
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.

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

Rename MessageExecuted event for clarity #90

Closed
ermyas opened this issue Sep 27, 2023 · 1 comment
Closed

Rename MessageExecuted event for clarity #90

ermyas opened this issue Sep 27, 2023 · 1 comment
Assignees
Labels
code style documentation Improvements or additions to documentation

Comments

@ermyas
Copy link
Collaborator

ermyas commented Sep 27, 2023

The MessageExecuted event is emitted by the MultiBridgeMessageReceiver when a message is queued for final execution on the destination governance timelock contract. The name can be misleading and imply that a message has actually been executed. While we describe this behaviour in the documentation page here, it might also be better to change the name of the event to be more descriptive of this behaviour.

Associated with this change, we might also want to also consider renaming MultiBridgeMessageReceiver.executeMessage() to MultiBridgeMessageReceiver.scheduleForExecution() or similar, to better describe the behaviour of the function.

@ermyas ermyas added documentation Improvements or additions to documentation code style labels Sep 27, 2023
@ermyas ermyas self-assigned this Oct 5, 2023
@ermyas
Copy link
Collaborator Author

ermyas commented Oct 8, 2023

Closed through PR #100

@ermyas ermyas closed this as completed Oct 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code style documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant