Add additional events in x/lockup, x/superfluid, x/concentratedliquidity

[mattverse]

Closes: #XXX

What is the purpose of the change

This PR adds additional events that were missing. The list of events being added are as below

• pool Id addition in
  • MsgAddToPosition
  • MsgAddToConcentratedLiquiditySuperfluidPosition
• locked token amount & denom addition in
  • MsgBeginUnlocking
  • MsgSuperfluidDelegate
  • MsgSuperfluidUndelegate

Testing and Verifying

This change is a trivial rework / code cleanup without any test coverage.

Documentation and Release Note

• Does this pull request introduce a new feature or user-facing behavior changes?
• Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

• Specification (x/{module}/README.md)
• Osmosis documentation site
• Code comments?
• N/A

[coderabbitai]

Walkthrough

The changes introduce new event attributes throughout the concentrated-liquidity, lockup, and superfluid modules. These enhancements ensure additional data is included in events, such as pool IDs, denominations, and amounts. The additions provide more context and granularity to event handling, facilitating improved tracking and debugging of liquidity positions and lockup events.

Changes

File(s)	Change Summary
x/concentrated-liquidity/lp.go	addToPosition function now includes an attribute for AttributeKeyPoolId with the position ID.
x/lockup/keeper/msg_server.go, x/lockup/types/events.go	The createBeginUnlockEvent function now includes PeriodLockDenom and PeriodLockAmount attributes. Added AttributePeriodLockDenom constant.
x/superfluid/keeper/concentrated_liquidity.go	addToConcentratedLiquiditySuperfluidPosition function includes an attribute for AttributeKeyPoolId.
x/superfluid/keeper/internal/events/emit.go	Functions EmitSuperfluidDelegateEvent and EmitSuperfluidUndelegateEvent now require lockCoins parameter; event creation functions updated to include lock coin attributes.
x/superfluid/keeper/msg_server.go	SuperfluidDelegate function fetches lock.Coins before emitting an event. Added EmitSuperfluidDelegateEvent with lock coins, GetLockByID function, Lock struct, and MsgSuperfluidDelegateResponse struct.
x/superfluid/types/events.go	Added constants AttributeLockAmount and AttributeLockDenom.

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1becaea and c8abedf.

Files selected for processing (3)

• CHANGELOG.md (1 hunks)
• x/superfluid/keeper/internal/events/emit_test.go (4 hunks)
• x/superfluid/keeper/msg_server.go (2 hunks)

Files skipped from review due to trivial changes (1)

• CHANGELOG.md

Additional comments not posted (4)

x/superfluid/keeper/internal/events/emit_test.go (2)

118-127: LGTM!

The changes to include lockCoins in the test cases and expected events are appropriate. The test cases cover scenarios with and without an event manager.

Also applies to: 140-154

---

261-268: LGTM!

The changes to include lockCoins in the test cases and expected events are appropriate. The test cases cover scenarios with and without an event manager.

Also applies to: 280-294

x/superfluid/keeper/msg_server.go (2)

50-54: LGTM!

The changes to retrieve the lock by ID and pass lock.Coins to the event emission are appropriate. The error handling for the lock retrieval is also correctly implemented.

---

69-73: LGTM!

The changes to retrieve the lock by ID and pass lock.Coins to the event emission are appropriate. The error handling for the lock retrieval is also correctly implemented.

---

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 testing code 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 testing code 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 testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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 an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @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.
• Please see the configuration documentation for more information.
• 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/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

[coderabbitai]

Fix the attribute value.

The attribute types.AttributeKeyPoolId should be set to position.PoolId instead of positionId.

-	sdk.NewAttribute(types.AttributeKeyPoolId, strconv.FormatUint(positionId, 10)),
+	sdk.NewAttribute(types.AttributeKeyPoolId, strconv.FormatUint(position.PoolId, 10)),

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	sdk.NewAttribute(types.AttributeKeyPoolId, strconv.FormatUint(positionId, 10)),
	sdk.NewAttribute(types.AttributeKeyPoolId, strconv.FormatUint(position.PoolId, 10)),