Docs: PR #2587 – feat(utxo): introduce a utxo consolidation rpc

[github-actions]

Source

• PR: feat(utxo): introduce a utxo consolidation rpc komodo-defi-framework#2587
• Title: feat(utxo): introduce a utxo consolidation rpc
• Author: @mariocynicys

Summary

This PR introduces a new consolidate_utxos RPC method for UTXO coin consolidation. Documentation updates are needed for the following:

• New Feature: consolidate_utxos RPC method.
• Parameters:
  • coin: (string) the coin to consolidate (e.g., "BTC").
  • merge_conditions: (object) includes:
    • merge_at: (integer) minimum lone UTXOs to trigger merge (default: 100).
    • max_merge_at_once: (integer) maximum UTXOs to merge at once (default: 50).
• Breaking Changes: None noted.
• Example Snippet: Update the RPC method examples to include the new consolidate_utxos request format and parameters.

Ensure to document the expected transaction details returned upon success.

Suggested docs tasks

• Update relevant pages
• Add/adjust RPC docs: purpose, parameters (types/defaults), and examples
• Provide JSON-RPC request/response samples
• Update changelog/What's New (if applicable)

Changed files (for scoping)

• mm2src/coins/rpc_command/consolidate_utxos.rs (added)
• mm2src/coins/rpc_command/mod.rs
• mm2src/coins/utxo/utxo_builder/mod.rs
• mm2src/coins/utxo/utxo_builder/utxo_arc_builder.rs
• mm2src/common/common.rs
• mm2src/common/log.rs
• mm2src/mm2_main/src/rpc/dispatcher/dispatcher.rs

This issue was generated automatically; edit as needed.

[github-actions]

Source PR: GLEECBTC/komodo-defi-framework#2587

[smk762]

Examples:

{
    "method": "consolidate_utxos",
    "userpass": "{{userpass}}",
    "mmrpc": "2.0",
    "params": {
        "coin": "MARTY",
        "merge_conditions": {
            "merge_at": 0,
            "max_merge_at_once": 1
        }
    }
}

{
    "method": "fetch_utxos",
    "userpass": "{{userpass}}",
    "mmrpc": "2.0",
    "params": {
        "coin": "MARTY"
    }
}