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

fix: untracked tokenfactory ibc-rate-limit inflow #8922

Merged
merged 12 commits into from
Jan 8, 2025

Conversation

iboss-ptk
Copy link
Contributor

What is the purpose of the change

Recv denom doesn't detect tokenfactory token as native and hashed it as ibc token so inflow is untracked. This PR fixes it.

@iboss-ptk iboss-ptk requested a review from nicolaslara January 7, 2025 08:19
@iboss-ptk iboss-ptk added V:state/compatible/no_backport State machine compatible PR, depends on prior breaks Bug labels Jan 7, 2025
@iboss-ptk iboss-ptk changed the title fix untracked tokenfactory ibc-rate-limit inflow fix: untracked tokenfactory ibc-rate-limit inflow Jan 7, 2025
Copy link
Contributor

coderabbitai bot commented Jan 7, 2025

Walkthrough

The pull request introduces a new test function receive_tokenfactory_token in the packet.rs file of the IBC rate limiter contracts. This test specifically focuses on verifying the behavior of the local_denom method when handling tokens originating from a token factory. The test creates a Packet instance with a denom that includes the "factory" prefix, ensuring proper handling and parsing of token factory tokens during IBC transfers. Additionally, a new entry is added to the CHANGELOG.md to document a bug fix related to the token factory's IBC rate limit inflow. The migration process in contract_tests.rs is also updated to explicitly set the contract version.

Changes

File Change Summary
x/ibc-rate-limit/contracts/rate-limiter/src/packet.rs Added new test function receive_tokenfactory_token() to validate local_denom method behavior for token factory tokens.
CHANGELOG.md Added entry for bug fix regarding untracked tokenfactory IBC rate limit inflow.
x/ibc-rate-limit/contracts/rate-limiter/src/contract_tests.rs Renamed proper_migrate() to proper_migrate_for_v0_1_0(), added import for set_contract_version, and updated comments for migration clarity.

Sequence Diagram

sequenceDiagram
    participant Test as Test Function
    participant Packet as Packet Struct
    participant LocalDenom as local_denom Method

    Test->>Packet: Create Packet with factory token denom
    Packet->>LocalDenom: Call local_denom method
    LocalDenom-->>Packet: Return processed denom
    Test->>Test: Assert expected denom matches result
Loading

The sequence diagram illustrates the test flow, showing how the test function creates a packet, calls the local_denom method, and then verifies the returned denom matches the expected output.


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
🪧 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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 generate docstrings to generate docstrings for this PR. (Beta)
  • @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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Nitpick comments (2)
x/ibc-rate-limit/contracts/rate-limiter/src/contract_tests.rs (2)

411-411: Consider improving test function name and documentation.

While the function name indicates the version, it could be more descriptive about what it's testing. Consider adding documentation to explain:

  • The purpose of the migration test
  • The steps being tested
  • The expected outcomes
-fn proper_migrate_for_v0_1_0() {
+/// Tests the migration process from version 0.1.0, specifically verifying:
+/// - Proper contract version setting
+/// - Role revocation and reassignment for governance contract
+/// - Maintenance of contract state during migration
+fn test_migration_maintains_roles_from_v0_1_0() {

430-431: Consider adding version verification after migration.

The test sets the contract version but doesn't verify if it's updated after migration. Consider adding an assertion to ensure the version is properly updated.

 // force set contract version to 0.1.0
 set_contract_version(deps.as_mut().storage, "crates.io:rate-limiter", "0.1.0").unwrap();
+
+// verify initial version
+let version = cw2::get_contract_version(deps.as_ref().storage).unwrap();
+assert_eq!(version.version, "0.1.0");
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9de9d52 and 6c01a10.

⛔ Files ignored due to path filters (2)
  • x/ibc-rate-limit/Cargo.lock is excluded by !**/*.lock, !**/*.lock
  • x/ibc-rate-limit/bytecode/rate_limiter.wasm is excluded by !**/*.wasm, !**/*.wasm
📒 Files selected for processing (1)
  • x/ibc-rate-limit/contracts/rate-limiter/src/contract_tests.rs (4 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (10)
  • GitHub Check: e2e
  • GitHub Check: go-split-test-files
  • GitHub Check: Test Cosmwasm Contracts (./cosmwasm/, tests/ibc-hooks/bytecode/outpost.wasm, artifacts/outpost.wa...
  • GitHub Check: Test Cosmwasm Contracts (./cosmwasm/, tests/ibc-hooks/bytecode/swaprouter.wasm, artifacts/swaprou...
  • GitHub Check: Test Cosmwasm Contracts (./cosmwasm/, tests/ibc-hooks/bytecode/crosschain_swaps.wasm, artifacts/c...
  • GitHub Check: Optimize Cosmwasm Contracts (./cosmwasm/, tests/ibc-hooks/bytecode/outpost.wasm, artifacts/outpos...
  • GitHub Check: Optimize Cosmwasm Contracts (./cosmwasm/, tests/ibc-hooks/bytecode/swaprouter.wasm, artifacts/swa...
  • GitHub Check: Optimize Cosmwasm Contracts (./cosmwasm/, tests/ibc-hooks/bytecode/crosschain_swaps.wasm, artifac...
  • GitHub Check: Optimize Cosmwasm Contracts (./x/ibc-rate-limit/, x/ibc-rate-limit/bytecode/rate_limiter.wasm, ar...
  • GitHub Check: Summary
🔇 Additional comments (2)
x/ibc-rate-limit/contracts/rate-limiter/src/contract_tests.rs (2)

8-8: LGTM! Good practice using cw2 for contract versioning.

Using cw2 for contract versioning is a standard practice in CosmWasm and helps with proper migration management.


442-442: LGTM! Good test coverage for role reassignment.

The test properly verifies that roles are reassigned during migration by:

  1. Explicitly revoking all roles
  2. Performing migration
  3. Verifying all roles are reassigned

@crnbarr93 crnbarr93 merged commit e1e778c into main Jan 8, 2025
1 check passed
@crnbarr93 crnbarr93 deleted the fix/untracked-tokenfactor-ibc-rate-limit-inflow branch January 8, 2025 08:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug V:state/compatible/no_backport State machine compatible PR, depends on prior breaks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants