fix(trezor,activation): add PrivateKeyPolicy to AuthOptions

[takenagain]

Passes the PrivateKeyPolicy via AuthOptions to ensure that coin activation uses Trezor private key policy (current default is local device context-based).

Summary by CodeRabbit

• New Features

  • Added support for specifying private key handling policies during asset activation, allowing for enhanced customization based on user authentication preferences.

• Improvements

  • Activation processes now dynamically use the latest authentication settings, ensuring more accurate and secure asset activations.
  • Enhanced serialization and configuration options for authentication and protocol settings, providing greater flexibility for advanced users.

• Bug Fixes

  • Improved handling of activation parameters to ensure consistent behavior across different asset types.

[coderabbitai]

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The changes introduce support for a PrivateKeyPolicy throughout the activation flow. Constructors and methods across activation strategies, protocol classes, and authentication options are updated to accept and propagate this policy. Serialization, deserialization, and activation parameter generation now consistently handle the privKeyPolicy, ensuring its correct usage during asset activation.

Changes

Files/Groups	Change Summary
.../activation/activation_manager.dart	ActivationManager now dynamically creates activators using the current user's privKeyPolicy for each activation, removing the stored _activator field.
.../activation/base_strategies/activation_strategy_factory.dart	createStrategy updated to accept and forward privKeyPolicy to relevant activation strategies.
.../activation/protocol_strategies/qtum_activation_strategy.dart, .../utxo_activation_strategy.dart	Constructors updated to accept and store privKeyPolicy, passing it to protocol activation parameter methods. Return type annotations for status parsing methods updated.
.../auth/auth_options.dart	AuthOptions class extended to include privKeyPolicy, with updated serialization, deserialization, and equality logic.
.../coin_classes/protocol_class.dart	defaultActivationParams now accepts an optional privKeyPolicy parameter and returns params with this policy. Formatting improved.
.../protocols/erc20/erc20_protocol.dart	defaultActivationParams updated to accept privKeyPolicy; new method activationParamsWithTokens added for handling child tokens.
.../protocols/utxo/utxo_protocol.dart	defaultActivationParams updated to accept and propagate privKeyPolicy using copyWith.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ActivationManager
    participant AuthOptions
    participant ActivationStrategyFactory
    participant Activator
    participant Protocol

    User->>ActivationManager: activateAssets()
    ActivationManager->>AuthOptions: get privKeyPolicy
    ActivationManager->>ActivationStrategyFactory: createStrategy(client, privKeyPolicy)
    ActivationStrategyFactory->>Activator: construct with privKeyPolicy
    ActivationManager->>Activator: activate()
    Activator->>Protocol: defaultActivationParams(privKeyPolicy)
    Protocol-->>Activator: ActivationParams with privKeyPolicy
    Activator-->>ActivationManager: Activation result
    ActivationManager-->>User: Activation status

Loading

Suggested labels

enhancement

Suggested reviewers

• smk762

Poem

In the warren of code, a new path unfurls,
Where private key policies twirl and swirl.
Activation flows now smart and spry,
Each asset’s fate decided on the fly.
With every hop, security grows—
A rabbit’s delight as the blockchain glows! 🐇✨

---

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

• 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>, 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.

[github-actions]

Visit the preview URL for this PR (updated for commit 2e21ecc):

https://komodo-defi-sdk--pr75-hotfix-trezor-privke-ssv0dwf7.web.app

_{(expires Fri, 13 Jun 2025 11:47:51 GMT)}

_{🔥 via Firebase Hosting GitHub Action 🌎}

_{Sign: 7f9f5ac39928f333b6e8fcefb7138575e24ed347}

[takenagain]

@coderabbitai review

[coderabbitai]

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e2561b3 and 3fab8c3.

📒 Files selected for processing (8)

• packages/komodo_defi_sdk/lib/src/activation/activation_manager.dart (3 hunks)
• packages/komodo_defi_sdk/lib/src/activation/base_strategies/activation_strategy_factory.dart (1 hunks)
• packages/komodo_defi_sdk/lib/src/activation/protocol_strategies/qtum_activation_strategy.dart (3 hunks)
• packages/komodo_defi_sdk/lib/src/activation/protocol_strategies/utxo_activation_strategy.dart (4 hunks)
• packages/komodo_defi_types/lib/src/auth/auth_options.dart (1 hunks)
• packages/komodo_defi_types/lib/src/coin_classes/protocol_class.dart (4 hunks)
• packages/komodo_defi_types/lib/src/protocols/erc20/erc20_protocol.dart (1 hunks)
• packages/komodo_defi_types/lib/src/protocols/utxo/utxo_protocol.dart (1 hunks)

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

• GitHub Check: setup

🔇 Additional comments (21)

packages/komodo_defi_types/lib/src/protocols/utxo/utxo_protocol.dart (1)

31-37: LGTM! Good integration of PrivateKeyPolicy parameter.

The addition of the optional privKeyPolicy parameter with a sensible default value is well-implemented. The parameter is properly propagated through the copyWith method call.

Note that the existing TODO comment (lines 25-30) is particularly relevant to this PR's objectives, as it specifically mentions Trezor activation parameter configuration needs.

packages/komodo_defi_sdk/lib/src/activation/base_strategies/activation_strategy_factory.dart (3)

1-1: Import addition is appropriate.

The new import for komodo_defi_rpc_methods is necessary to access the PrivateKeyPolicy type.

---

7-10: Method signature update is well-designed.

The addition of the PrivateKeyPolicy privKeyPolicy parameter to the factory method enables dynamic configuration based on user authentication settings.

---

16-16: Selective parameter passing is correct.

Only UtxoActivationStrategy and QtumActivationStrategy constructors receive the privKeyPolicy parameter, which is appropriate as other activation strategies (ERC20, Tendermint, etc.) likely don't require this configuration.

Also applies to: 20-20

packages/komodo_defi_sdk/lib/src/activation/activation_manager.dart (5)

6-6: Import addition is necessary.

The new import for komodo_defi_rpc_methods is required to access the PrivateKeyPolicy type.

---

21-21: Constructor simplification is appropriate.

Removing the static _activator initialization aligns with the new dynamic creation pattern.

---

100-110: Dynamic privKeyPolicy retrieval is well-implemented.

The approach of retrieving the current user's privKeyPolicy from authentication options ensures that each activation uses the most up-to-date user settings. The fallback to PrivateKeyPolicy.contextPrivKey provides a sensible default.

---

107-110: Dynamic activator creation improves flexibility.

Creating a new activator instance per activation with the current user's privKeyPolicy is a significant architectural improvement over the previous static approach. This ensures that changes to user authentication settings are immediately reflected in activation behavior.

---

112-115: Activator usage is consistent.

The call to activator.activate() maintains the same interface while benefiting from the dynamic configuration.

packages/komodo_defi_sdk/lib/src/activation/protocol_strategies/qtum_activation_strategy.dart (4)

1-1: Import addition is necessary.

The new import for komodo_defi_rpc_methods is required to access the PrivateKeyPolicy type.

---

6-8: Constructor update is well-implemented.

The addition of the privKeyPolicy parameter to the constructor and its storage as a final field follows good Dart practices and maintains consistency with the activation strategy pattern.

---

40-42: Parameter propagation is correct.

Passing the stored privKeyPolicy to the defaultActivationParams method ensures that the QTUM activation uses the appropriate private key policy configuration.

---

108-108: Return type annotation simplification is a minor improvement.

The change from a more verbose named record type annotation to the standard Dart record syntax is a cosmetic improvement that doesn't affect functionality.

packages/komodo_defi_types/lib/src/protocols/erc20/erc20_protocol.dart (1)

34-43: Well-structured separation of concerns.

Good approach to separate token handling into a dedicated method while keeping the default activation params focused on the private key policy.

packages/komodo_defi_types/lib/src/auth/auth_options.dart (3)

10-10: Good default value choice.

Using PrivateKeyPolicy.contextPrivKey as the default is a sensible choice for backward compatibility.

---

37-38: Properly integrated into equality comparison.

The privKeyPolicy field is correctly added to the props getter for proper equality comparison.

---

18-20:

Details

✅ Verification successful

Verify the PrivateKeyPolicy enum structure.

The JSON parsing assumes that PrivateKeyPolicy.trezor exists and that the enum has an id property for serialization. Ensure these properties are correctly defined in the enum.

---

🏁 Script executed:

#!/bin/bash
# Verify PrivateKeyPolicy enum definition and properties
ast-grep --pattern 'enum PrivateKeyPolicy {
  $$$
}'

# Also search for the enum definition more broadly
rg -A 10 "enum PrivateKeyPolicy"

Length of output: 1558

---

PrivateKeyPolicy enum validated

The PrivateKeyPolicy enum in komodo_defi_rpc_methods defines both the trezor case and a String get id accessor, so the JSON parsing (priv_key_policy == 'Trezor') and subsequent serialization via .id will work as expected. No changes required.

packages/komodo_defi_types/lib/src/coin_classes/protocol_class.dart (1)

139-144: Excellent base implementation for PrivateKeyPolicy support.

The method correctly accepts the privKeyPolicy parameter with a sensible default and applies it using genericCopyWith. This provides a solid foundation for subclasses to inherit or override.

packages/komodo_defi_sdk/lib/src/activation/protocol_strategies/utxo_activation_strategy.dart (3)

6-8: Clean integration of PrivateKeyPolicy parameter.

The constructor properly accepts and stores the privKeyPolicy parameter, enabling its use throughout the activation strategy.

---

38-42: Consistent policy application in progress reporting.

Good practice to include the privKeyPolicy when generating activation params for progress details, ensuring consistency throughout the activation flow.

---

61-61: Proper policy propagation to RPC call.

The privKeyPolicy is correctly passed to the defaultActivationParams method for the actual RPC activation call, ensuring the policy is applied where it matters most.

[CharlVS]

LGTMGGWPTYSM