fix(fee-info): update tendermint, erc20, and qrc20 `fee_details` response format #60

takenagain · 2025-05-21T17:51:41Z

Updated FeeInfo fields to match the response structure in the docs, which includes new total_ gas amount fields in the response.

Fixed toJson format for QRC20 and Tendermint coins, which expect f64 (double/decimal) values instead of string

Summary by CodeRabbit

New Features
- Added support for a new "Tendermint" fee type, allowing display and handling of Tendermint transaction fees.
- Fee breakdown UI now displays Tendermint fee details, including gas limit and amount.
Enhancements
- Improved Ethereum and QRC20 fee types with optional explicit total gas fee values for more accurate fee calculations and display.
Chores
- Updated package exports to include additional utility functions.

tendermint fee_details has an `amount` field which returns the fee, so no calculation is required

added as optional parameters to mitigate potential breaking changes

coderabbitai · 2025-05-21T17:51:48Z

Walkthrough

The changes introduce a new Tendermint fee type to the FeeInfo union, including support for serialization, deserialization, and UI display. Optional totalGasFee fields are added to EthGas and Qrc20Gas fee variants. The komodo_defi_type_utils library now exports backoff_strategy.dart for broader utility access.

Changes

File(s)	Change Summary
`packages/komodo_defi_types/lib/komodo_defi_type_utils.dart`	Added export for `src/utils/backoff_strategy.dart`, making its utilities publicly available.
`packages/komodo_defi_types/lib/src/transactions/fee_info.dart`	Introduced new `FeeInfo.tendermint` variant with `coin`, `amount`, and `gasLimit`. Updated JSON parsing, serialization, `totalFee` calculation, and `maybeMap` extension. Enhanced `EthGas` and `Qrc20Gas` with optional `totalGasFee` fields and related logic.
`packages/komodo_defi_types/lib/src/transactions/fee_info.freezed.dart`	Added `totalGasFee` field to `FeeInfoEthGas` and `FeeInfoQrc20Gas`, updating constructors, copyWith, equality, and toString. Added new `FeeInfoTendermint` class with required fields and standard methods.
`packages/komodo_ui/lib/src/core/displays/fee_info_display.dart`	Added UI display logic for the new `FeeInfoTendermint` type, showing gas limit and amount. No changes to exported/public APIs.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant UI
    participant FeeInfo
    participant JSON

    User->>UI: Requests fee info display
    UI->>FeeInfo: Receives FeeInfo instance (could be Tendermint, EthGas, Qrc20Gas, etc.)
    FeeInfo->>JSON: Parses/serializes as needed
    FeeInfo-->>UI: Provides fee type and details
    UI-->>User: Displays fee breakdown (including Tendermint if present)

Poem

A new fee hops into view,
Tendermint joins the crew!
With totalGasFee, the math is neat,
Now UI and logic both complete.
Exports expand, utilities grow—
What else will Komodo show?
🐇✨

Note

⚡️ AI Code Reviews for VS Code, Cursor, Windsurf

CodeRabbit now has a plugin for VS Code, Cursor and Windsurf. This brings AI code reviews directly in the code editor. Each commit is reviewed immediately, finding bugs before the PR is raised. Seamless context handoff to your AI code agent ensures that you can easily incorporate review feedback.
Learn more here.

Note

⚡️ Faster reviews with caching

CodeRabbit now supports caching for code and dependencies, helping speed up reviews. This means quicker feedback, reduced wait times, and a smoother review experience overall. Cached data is encrypted and stored securely. This feature will be automatically enabled for all accounts on May 30th. To opt out, configure Review - Disable Cache at either the organization or repository level. If you prefer to disable all data retention across your organization, simply turn off the Data Retention setting under your Organization Settings.
Enjoy the performance boost—your workflow just got faster.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting

📥 Commits

Reviewing files that changed from the base of the PR and between 1291dfc and 327fb85.

📒 Files selected for processing (4)

packages/komodo_defi_types/lib/komodo_defi_type_utils.dart (1 hunks)
packages/komodo_defi_types/lib/src/transactions/fee_info.dart (9 hunks)
packages/komodo_defi_types/lib/src/transactions/fee_info.freezed.dart (13 hunks)
packages/komodo_ui/lib/src/core/displays/fee_info_display.dart (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: setup

🔇 Additional comments (33)

packages/komodo_defi_types/lib/komodo_defi_type_utils.dart (1)

6-6: Clean addition of backoff strategy export

The addition of the backoff strategy export makes this utility accessible to consumers of the library, which is necessary for the fee-related changes in this PR.

packages/komodo_ui/lib/src/core/displays/fee_info_display.dart (1)

102-114: Proper implementation of FeeInfoTendermint display

The implementation of the FeeInfoTendermint case in the switch expression follows the same pattern as the existing fee types, maintaining UI consistency across the application. The 8-decimal precision for formatting the amount is appropriate for blockchain amounts.

packages/komodo_defi_types/lib/src/transactions/fee_info.freezed.dart (18)

234-241: EthGas constructor properly updated with optional totalGasFee parameter

The FeeInfoEthGas constructor has been correctly modified to include the optional totalGasFee parameter, which aligns with the changes in the original fee_info.dart file.

250-252: Documentation added for totalGasFee field

Good job adding clear documentation that explains the purpose of the totalGasFee field and how it overrides the default calculation when provided.

270-272: Updated equals operator includes totalGasFee comparison

The equals operator correctly includes the totalGasFee field in the comparison, ensuring proper equality checks for instances of FeeInfoEthGas.

276-277: Updated hashCode calculation includes totalGasFee

The hashCode calculation properly includes the totalGasFee field, maintaining consistency with the equals operator implementation.

280-282: toString method updated to include totalGasFee

The toString implementation correctly includes the totalGasFee field, which is helpful for debugging and logging.

293-293: CopyWith interface updated to include totalGasFee

The CopyWith interface correctly includes the totalGasFee parameter, ensuring that the copyWith method works as expected with the new field.

312-313: Proper freezed handling of nullable totalGasFee field

The code correctly uses the 'freezed' sentinel value for the nullable totalGasFee field in the call method, ensuring proper behavior when the field is not provided in copyWith calls.

327-330: Proper handling of nullable totalGasFee in copyWith implementation

The implementation of the call method properly handles the nullable totalGasFee parameter, maintaining the existing value when not specified in copyWith calls.

339-342: QRC20Gas constructor properly updated with optional totalGasFee parameter

The FeeInfoQrc20Gas constructor has been correctly modified to include the optional totalGasFee parameter, following the same pattern as FeeInfoEthGas.

354-356: Documentation added for QRC20Gas totalGasFee field

Clear documentation provided for the totalGasFee field in FeeInfoQrc20Gas, explaining how it's used to override the default calculation.

375-377: Updated QRC20Gas equals operator includes totalGasFee comparison

The equals operator for FeeInfoQrc20Gas correctly includes the totalGasFee field in the comparison.

381-382: Updated QRC20Gas hashCode calculation includes totalGasFee

The hashCode calculation for FeeInfoQrc20Gas properly includes the totalGasFee field.

386-387: QRC20Gas toString method updated to include totalGasFee

The toString implementation for FeeInfoQrc20Gas correctly includes the totalGasFee field.

398-399: QRC20Gas CopyWith interface updated to include totalGasFee

The CopyWith interface for FeeInfoQrc20Gas correctly includes the totalGasFee parameter.

418-419: Proper freezed handling of nullable totalGasFee field for QRC20Gas

The code correctly uses the 'freezed' sentinel value for the nullable totalGasFee field in the QRC20Gas call method.

433-436: Proper handling of nullable totalGasFee in QRC20Gas copyWith implementation

The implementation of the QRC20Gas call method properly handles the nullable totalGasFee parameter.

531-573: Complete implementation of new FeeInfoTendermint class

The new FeeInfoTendermint class is well-implemented with all required functionality including constructor, field definitions, copyWith support, equality operator, hashCode, and toString methods. The structure follows the same pattern as the other fee info variants, maintaining consistency in the codebase.

576-618: Well-implemented CopyWith functionality for FeeInfoTendermint

The CopyWith functionality for FeeInfoTendermint is properly implemented, including the interface definition and implementation class with appropriate call method handling.

packages/komodo_defi_types/lib/src/transactions/fee_info.dart (13)

8-14: Updated documentation to include Tendermint fee type

The class documentation has been appropriately updated to include the new Tendermint fee type in the list of possible fee types.

39-47: Added support for total_fee override in EthGas parsing

Good implementation of the totalGasFee parsing from the 'total_fee' field in the JSON for EthGas type. This allows for explicit fee values to be provided instead of calculating them.

50-57: Added support for total_gas_fee override in Qrc20Gas parsing

Similar to EthGas, the implementation properly parses the 'total_gas_fee' field for the Qrc20Gas type to support explicit fee values.

59-64: Added Tendermint fee type support in fromJson factory

The fromJson factory method has been correctly extended to handle the 'Tendermint' type, parsing the required fields (coin, amount, gasLimit) from JSON.

117-120: Added optional totalGasFee field to EthGas constructor

The EthGas constructor has been updated to include an optional totalGasFee field with clear documentation explaining its purpose and usage.

133-135: Added optional totalGasFee field to Qrc20Gas constructor

The Qrc20Gas constructor has also been updated to include an optional totalGasFee field with appropriate documentation.

159-179: Well-documented new Tendermint fee type

The new Tendermint fee type is well-documented with clear examples and explanations of its fields. The structure is consistent with other fee types in the class.

185-191: Updated totalFee getter to handle new types and overrides

The totalFee getter has been correctly updated to:

Use the provided totalGasFee for EthGas and Qrc20Gas when available

Fall back to calculated values when no override is provided

Handle the new Tendermint type by returning its amount field

This ensures consistent fee calculation across all fee types.

206-218: Updated EthGas toJson method to include totalFee when present

The toJson implementation for EthGas now conditionally includes the 'total_fee' field when totalGasFee is provided, which is appropriate for the optional nature of this field.

219-231: Updated Qrc20Gas toJson method to include total_gas_fee when present

Similarly, the toJson implementation for Qrc20Gas now conditionally includes the 'total_gas_fee' field when totalGasFee is provided.

232-237: Consistent serialization for CosmosGas

The CosmosGas toJson implementation now consistently uses toDouble() for the 'gas_price' field, aligning with the serialization approach used for Qrc20Gas.

238-243: Appropriate toJson implementation for Tendermint fee type

The toJson implementation for the Tendermint fee type correctly serializes all required fields (type, coin, amount, gas_limit) following the same pattern as other fee types.

258-267: Updated maybeMap extension to support Tendermint variant

The maybeMap extension method has been appropriately updated to include support for the new Tendermint variant, maintaining the pattern matching functionality.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

takenagain · 2025-05-21T17:51:59Z

@coderabbitai review

coderabbitai · 2025-05-21T17:52:04Z

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

github-actions · 2025-05-21T17:58:02Z

Visit the preview URL for this PR (updated for commit 327fb85):

https://komodo-defi-sdk--pr60-bugfix-tendermint-fe-1b4yhlbt.web.app

_{(expires Wed, 28 May 2025 17:57:52 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 7f9f5ac39928f333b6e8fcefb7138575e24ed347}

Copilot

Pull Request Overview

This pull request updates the fee_info handling with new support for Tendermint fee details while enhancing EthGas and Qrc20Gas fee types to optionally accept a total fee override. It also updates UI display components accordingly and adds a new utility export.

Reviewed Changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File	Description
packages/komodo_ui/lib/src/core/displays/fee_info_display.dart	Adds UI elements for displaying tendermint fee details
packages/komodo_defi_types/lib/src/transactions/fee_info.freezed.dart	Introduces new totalGasFee field for EthGas and Qrc20Gas, and adds the new FeeInfoTendermint case
packages/komodo_defi_types/lib/src/transactions/fee_info.dart	Updates JSON parsing and serialization to support optional total fee overrides and the new Tendermint fee type
packages/komodo_defi_types/lib/komodo_defi_type_utils.dart	Exports a new backoff_strategy utility

Copilot · 2025-05-21T17:59:26Z

packages/komodo_ui/lib/src/core/displays/fee_info_display.dart

+            final FeeInfoTendermint fee => [
+              Text('Gas Limit:', style: Theme.of(context).textTheme.bodyMedium),
+              Text(
+                '${fee.gasLimit}',
+                style: Theme.of(context).textTheme.labelLarge,
+              ),
+              Text('Amount:', style: Theme.of(context).textTheme.bodyMedium),
+              Text(
+                fee.formatTotal(precision: 8),
+                style: Theme.of(context).textTheme.labelLarge,
+              ),
+            ],


[nitpick] The inline lambda declaration for FeeInfoTendermint is somewhat unconventional within the widget tree. It would improve readability and maintainability to extract this logic into a clearly named helper or builder method.

Suggested change

final FeeInfoTendermint fee => [

Text('Gas Limit:', style: Theme.of(context).textTheme.bodyMedium),

Text(

'${fee.gasLimit}',

style: Theme.of(context).textTheme.labelLarge,

),

Text('Amount:', style: Theme.of(context).textTheme.bodyMedium),

Text(

fee.formatTotal(precision: 8),

style: Theme.of(context).textTheme.labelLarge,

),

],

final FeeInfoTendermint fee => _buildTendermintFeeDetails(fee, context),

packages/komodo_defi_types/lib/src/transactions/fee_info.dart

CharlVS

LGTMTYSM

GLEECBTC/komodo-defi-sdk-flutter#60

* fix: fix SDK roll CI script issues - Fix SDK roll CI script issues - Roll SDK version * CI Test #1 * build: update remaining SDK commit refs in lockfiles * CI Test 2 * fix(icon-pre-caching): exclude excluded assets to remove NFT_ coins `NFT_` prefixed coins do not have icons and should not be shown to users, so filter them out from the icon pre-caching * chore: roll SDK * chore(deps): upgrade SDK to include fee info fix GLEECBTC/komodo-defi-sdk-flutter#60 --------- Co-authored-by: Francois <[email protected]>

* fix: fix SDK roll CI script issues - Fix SDK roll CI script issues - Roll SDK version * CI Test #1 * build: update remaining SDK commit refs in lockfiles * CI Test 2 * fix(icon-pre-caching): exclude excluded assets to remove NFT_ coins `NFT_` prefixed coins do not have icons and should not be shown to users, so filter them out from the icon pre-caching * chore: roll SDK * docs(analytics): add event implementation plan * feat(analytics): log onboarding and app lifecycle events * feat(analytics): add send and swap event callbacks * feat(analytics): log events for hd address and page metrics * feat(analytics): add portfolio and asset event logging * fix(analytics): Fix analytics type errors * fix(analytics): fix missing import * chore(deps): upgrade SDK to include fee info fix GLEECBTC/komodo-defi-sdk-flutter#60 * feat(analytics): add high priority events * fix: update alpha version warning * feat(analytics): add cross-chain events and triggers * feat(analytics): trigger new event logs * fix: various analytics fixes/enhancements * refactor(analytics): log events directly * fix: various analytics fixes * feat: analytics event queuing --------- Co-authored-by: Francois <[email protected]>