fix: check recipient for lp role

[johnletey]

Summary by CodeRabbit

• New Features

  • Updated trade transaction logic to validate the recipient's role as a liquidity provider, enhancing security and authorization flow.
  • Introduced the ability to issue USYC tokens natively on the Noble platform, allowing for seamless management and transactions.

• Bug Fixes

  • Improved test coverage by simulating interactions between an admin and a recipient account during trading scenarios.
  • Added a critical check to ensure that the recipient involved in trading to fiat is a liquidity provider, enhancing transaction integrity.

• Documentation

  • Added a changelog to document changes and improvements to the x/halo module, including version updates and significant patches.

[coderabbitai]

Walkthrough

The changes involve modifications to the TradeToFiat function in the msgServer struct, shifting the role validation from the transaction initiator (signer) to the recipient of the trade. Additionally, the TestTradeToFiat function has been updated to create both an admin and a recipient account, enhancing the testing of trading functionality by simulating interactions between distinct accounts. A new configuration entry for the project URL has been added, and the changelog has been updated to document these changes, including a consensus-breaking patch.

Changes

Files	Change Summary
x/halo/keeper/msg_server.go	Modified TradeToFiat function to check if the recipient has the liquidity provider role instead of the signer.
x/halo/keeper/msg_server_test.go	Updated TestTradeToFiat to create both an admin and a recipient account, enhancing test coverage and accuracy.
.changelog/config.toml	Added project_url key with the value "https://github.com/noble-assets/halo".
.changelog/v1.0.0/summary.md	Introduced initial release of x/halo module for USYC token issuance on the Noble platform.
.changelog/v1.0.1/bug-fixes/8-recipient-check.md	Added check to ensure the recipient is a liquidity provider when trading to fiat.
.changelog/v1.0.1/summary.md	Documented a consensus-breaking patch for the v1 release line, dated September 12, 2024.
CHANGELOG.md	Added CHANGELOG.md documenting changes to the x/halo module.

Poem

🐇 In the realm of trade, a shift we see,
From signer to recipient, as clear as can be.
With accounts now two, the tests leap and bound,
Ensuring our logic is solidly sound.
Hooray for the changes, let’s hop with delight,
For trading is better, and all feels just right! 🎉

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17e979a and 57f7f12.

Files selected for processing (5)

• .changelog/config.toml (1 hunks)
• .changelog/v1.0.0/summary.md (1 hunks)
• .changelog/v1.0.1/bug-fixes/8-recipient-check.md (1 hunks)
• .changelog/v1.0.1/summary.md (1 hunks)
• CHANGELOG.md (1 hunks)

Files skipped from review due to trivial changes (1)

• .changelog/config.toml

Additional context used

LanguageTool

CHANGELOG.md

[grammar] ~11-~11: The word ‘fiat’ is not correct in this context. Use one of the suggestions or replace it with an appropriate verb.
Context: ...nt is a liquidity provider when trading to fiat. ([#8](https://github.com/noble-assets/...

(VB_TO_NN_DT)

Markdownlint

CHANGELOG.md

5-5: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

15-15: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (3)

.changelog/v1.0.1/summary.md (1)

1-3: LGTM, but verify the date.

The changelog entry is concise and accurately describes the consensus-breaking nature of the patch. However, please double-check the date, as it appears to be in the future.

.changelog/v1.0.1/bug-fixes/8-recipient-check.md (1)

1-1: LGTM!

The changelog entry is correctly formatted, links to the relevant pull request, and provides a concise summary of the bug fix.

CHANGELOG.md (1)

1-18: LGTM!

The changelog is well-structured and follows a consistent format. The bug fix is clearly documented with a reference to the pull request.

Tools

LanguageTool

[grammar] ~11-~11: The word ‘fiat’ is not correct in this context. Use one of the suggestions or replace it with an appropriate verb.
Context: ...nt is a liquidity provider when trading to fiat. ([#8](https://github.com/noble-assets/...

(VB_TO_NN_DT)

Markdownlint

5-5: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

15-15: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

---

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 using 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.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

📢 Thoughts on this report? Let us know!

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

x/halo/keeper/msg_server.go (1)

234-235: LGTM! The change aligns with the PR objective.

The change shifts the role validation from the transaction initiator (signer) to the recipient of the trade. This impacts the authorization flow and the security model of the transaction processing. Please ensure that this change is thoroughly tested and validated.

Consider adding a test case to cover the scenario where the recipient does not have the liquidity provider role to ensure that the function returns the expected error.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 865b1ce and 17e979a.

Files selected for processing (2)

• x/halo/keeper/msg_server.go (1 hunks)
• x/halo/keeper/msg_server_test.go (4 hunks)

Additional comments not posted (8)

x/halo/keeper/msg_server_test.go (8)

916-917: LGTM!

Generating both an admin and recipient account enhances the test coverage by simulating interactions between distinct accounts. This is a good change.

---

939-939: LGTM!

Using the recipient's address in the test case that checks for an invalid recipient address is the correct approach.

---

947-947: LGTM!

Using the recipient's address in the test case that checks for invalid recipient permissions is the correct approach.

---

953-953: LGTM!

Assigning the liquidity provider role to the recipient in the test setup is necessary for validating the trade functionality correctly.

---

959-959: LGTM!

Using the recipient's address in the test case that checks for insufficient funds is the correct approach.

---

971-971: LGTM!

Using the recipient's address in the test case that attempts to trade with a negative amount is the correct approach.

---

980-980: LGTM!

Using the recipient's address in the test case that attempts a valid trade is the correct approach.

---

984-984: LGTM!

Checking the recipient's balance in the assertion after a successful trade is the correct approach to ensure the trade amount is correctly transferred.