Document Trezor Methods

[smk762]

closes: #392

• task::init_trezor::init
• task::init_trezor::status
• task::init_trezor::user_action
• task::enable_utxo::init
• task::enable_utxo::status
• task::enable_utxo::user_action
• task::enable_qtum::init
• task::enable_qtum::status
• task::enable_qtum::user_action
  task::withdraw::init moved to other doc
  task::withdraw::status moved to other doc
  task::withdraw::cancel moved to other doc
• task::account_balance::init
• task::account_balance::status
• task::account_balance::cancel
• can_get_new_address
• get_new_address

[sergeyboyko0791]

A huge work! Thank you!
Just a few notes and suggestions

[sergeyboyko0791]

The request payload is the same for task::enable_qtum::init and task::enable_utxo::init. I'm not sure if this is a good idea, but what do you think about declaring a TaskEnableUtxoInit (not the best name) payload and just link it within task\_enable\_qtum\_init and task\_enable\_utxo\_init methods?
I don't think that the payload will be different in the future

[smk762]

I think in general where request payloads are the same (or 80% same with the remaining optional) it is good to have a single method that can be used for both. It reduces confusion from user and overhead to create maintain docs.

IMO the ideal solution would be a single "enable_coin" method which can be used on anything, with API + coins file able to determine which underlying method to use. Another enhancement would be allowing user to define coins_config.json and derive the rpc_nodes / electrums etc from there - though I understand this would be a fairly big job and maybe better to plan towards for v3 of the API

[sergeyboyko0791]

I can't answer this suggestion correctly as I didn't work on enable V2 feature, so I'll just reference to this comment KomodoPlatform/komodo-defi-framework#1006 (comment) and to your comment KomodoPlatform/komodo-defi-framework#1006 (comment) 🙂

[sergeyboyko0791]

Response payload could be also declared somewhere above

[smk762]

I've made some updates to resolve review feedback - just waiting on @Canialon to provide an error response example for FoundMultipleDevices and it will be ready for re-review

[Canialon]

I've made some updates to resolve review feedback - just waiting on @Canialon to provide an error response example for FoundMultipleDevices and it will be ready for re-review

{
  "mmrpc": "2.0",
  "result": {
    "status": "Error",
    "details": {
      "error": "Found multiple devices. Please unplug unused devices",
      "error_path": "init_hw.crypto_ctx.hw_client",
      "error_trace": "init_hw:151] crypto_ctx:248] crypto_ctx:354] hw_client:152] hw_client:126]",
      "error_type": "HwError",
      "error_data": "FoundMultipleDevices"
    }
  },
  "id": null
}

[Canialon]

Looks like it is no trezor_integration page there.. it wasn’t added to the sidebar

[smk762]

Reference

Thanks, sidebar entries should be visible now.

[smk762]

fixed a little syntax that was causing error, should be good now 🤞

[Canialon]

fixed a little syntax that was causing error, should be good now 🤞

The sidebar works good now! thanks!!

[smk762]

There appears to be duplication of the withdraw task methods between this PR and #395, which is ready for re-review. Once we merge #395, I'll merge master into this branch and tweak the structure to use links instead of duplicated sections. Setting this to draft until then.

[smk762]

I've broken up this doc into sections, as some methods are not Trezor specific (e.g. coin activation and withdrawal tasks are possible without a Trezor). Sidebar now looks like below

[Canialon]

I believe it makes sense to add a coin_activation_tasks link to the address_managment and account balance_tasks pages