feat(x/gov): emit depositor in proposal_deposit event

[kienn6034]

Description

Closes: #19849

Emit depositor in proposal_deposit event in AddDeposit function

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• New Features
  • Enhanced event details for deposits by including the depositor's address information.

[coderabbitai]

Walkthrough

Walkthrough

The changes aim to enhance the governance module by including the depositor's address in the event data when a deposit is made to a proposal. This improvement facilitates tracking and identification of deposit transactions related to governance proposals, offering increased transparency and usability for users and applications interacting with the blockchain.

Changes

File Path	Change Summary
x/gov/keeper/deposit.go	Added the Depositor attribute to the event in the AddDeposit function.
x/gov/types/events.go	Introduced the constant AttributeKeyDepositor to represent the depositor's address in events.
x/gov/CHANGELOG.md	Enhanced functionality to emit the depositor in the proposal_deposit event in PR #19853.
x/gov/keeper/proposal.go	Added an event attribute for the proposal type in the SubmitProposal function.

Assessment against linked issues

Objective	Addressed	Explanation
Emit depositor in proposal_deposit event (#19849)	✅

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between adc3432 and 61d8d49.

Files selected for processing (2)

• x/gov/keeper/deposit.go (1 hunks)
• x/gov/types/events.go (1 hunks)

Additional comments: 2

x/gov/types/events.go (1)

• 16-16: The addition of AttributeKeyDepositor follows the established naming conventions and is consistent with the structure of the file. This change enhances the event data by including depositor information, aligning with the PR's objectives.

x/gov/keeper/deposit.go (1)

• 182-182: The modification to include the depositor's address in the proposal_deposit event is implemented correctly and follows the Cosmos SDK's conventions for event handling. This enhancement aligns with the PR's objectives and improves the traceability of deposit transactions.

[sontrinh16]

minor nit, just need to add an entry to CHANGELOG

[kienn6034]

@sontrinh16 thanks for reviewing. Updated the CHANGELOG

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 61d8d49 and 022619a.

Files selected for processing (1)

• x/gov/CHANGELOG.md (1 hunks)

Additional comments: 2

x/gov/CHANGELOG.md (2)

• 37-37: The changelog entry for PR feat(x/gov): emit depositor in proposal_deposit event #19853 is clear and correctly categorized under Features. It succinctly describes the enhancement made to the proposal_deposit event.
• 34-40: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [1-75]

The CHANGELOG.md document adheres to its guiding principles, providing a clear and structured overview of changes. Each entry is appropriately categorized and linked, facilitating easy navigation and understanding of the module's evolution.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 022619a and 65e6bc4.

Files selected for processing (1)

• x/gov/CHANGELOG.md (1 hunks)

Additional comments: 1

x/gov/CHANGELOG.md (1)

• 37-37: The changelog entry for PR feat(x/gov): emit depositor in proposal_deposit event #19853 correctly captures the essence of the change and is placed appropriately under the Features section. It succinctly describes the enhancement made to the proposal_deposit event by including the depositor information.

[julienrbrt]

Thanks!

Can we add proposal_type as well in EventTypeSubmitProposal event?

[kienn6034]

@julienrbrt updated!

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 65e6bc4 and ed8a77a.

Files selected for processing (2)

• x/gov/CHANGELOG.md (1 hunks)
• x/gov/keeper/proposal.go (1 hunks)

Additional comments: 2

x/gov/CHANGELOG.md (1)

• 37-37: The changelog entry correctly documents the new feature introduced by the PR. It is well-placed under the "Features" section for the "Unreleased" version and provides a clear, concise description of the changes made.

x/gov/keeper/proposal.go (1)

• 149-149: The addition of the event attribute for the proposal type in the SubmitProposal function is correctly implemented. It enhances the function's functionality by providing more detailed event data, which aligns with the PR's objectives.