document disabling utxo_freeze_threshold #8035
Conversation
Add documentation to the docstring of the appropriate function explaining how to disable the spesmilo#6960 test for dusting transactions TODO: it may make sense to document passing this option on the command line as well, since editing the config file by hand is a recipe for trouble. Unfortunately this is not as simple as doing: ``` electrum --unconf_utxo_freeze_threshold=0 ``` and I can't find how electrum takes config arguments on the command line. Maybe someone else knows?
There are the Users should not directly edit the config file. Not even power users IMHO.
The Qt GUI already has this. electrum/electrum/gui/qt/send_tab.py Line 278 in fffbccf If you click "max" and some (but not all) coins are frozen, there is a forced tooltip: electrum/electrum/gui/qt/send_tab.py Line 216 in fffbccf
If using the Qt GUI, as above, there are already hints that the utxo is frozen. (also e.g. the wallet balance piechart shows the coins as frozen) This config variable is not documented and I agree the behaviour might be unintuitive to users, but I think it would be overkill to expose it directly in the settings. |
| ``` | ||
| in ~/.electrum/config. Make sure to back up your config file first as | ||
| JSON syntax is somewhat difficult to get right, and the config file | ||
| will be overwritten with defaults if you get it wrong. |
There was a problem hiding this comment.
The advice text here applies to editing the config in general. Should we maybe document setconfig and getconfig better instead?
- document that coins must be un-frozen using the Coins tab - document using getconfig/setconfig as better than manually editing the config
|
On Mon, Oct 24, 2022 at 10:39:56AM -0700, ghost43 wrote:
There are the `setconfig`/`getconfig` commands.
```
$ ./run_electrum -o getconfig unconf_utxo_freeze_threshold
$ ./run_electrum -o setconfig unconf_utxo_freeze_threshold 1234
true
$ ./run_electrum -o getconfig unconf_utxo_freeze_threshold
1234
$ ./run_electrum -o setconfig unconf_utxo_freeze_threshold null
true
$ ./run_electrum -o getconfig unconf_utxo_freeze_threshold
$
```
Oh, that's a much better way to do it!
> Most users who run into this behaviour and find it to be erroneous may not read this far into the code.
If using the Qt GUI, as above, there are already hints that the utxo is frozen.
If the user then goes to the Coins tab, they will see that's indeed the case and can manually unfreeze the utxo.
Ah, when I ran into the error (with a new multisig wallet setup I was
creating) the coins were **not** frozen in the Addresses tab (which is
where I went to look to un-freeze them manually).
Since I could not manually un-freeze the UTXO (via the Addresses tab) I
ended up finding the config option (in the source code) and manually
editing the config file.
So I would suggest:
1. having the freeze also show in the Addresses tab, not just in the
Coins tab (which is not shown by default, and I think is not an
intuitive place to look for un-freezing UTXOs).
2. documenting the setconfig/getconfig commands.
I have updated my branch to reflect these changes.
|
In the Coins tab, there is one line per utxo, each with one column for outpoint and one column for address. Users can freeze addresses and coins ~independently. A coin being frozen is reflected by changing the background colour of the outpoint column, and an address being frozen has different bgcolor in the address column.
I don't think it's a good approach to teach the reader about getconfig/setconfig in the docstring of every method that might use a config key. There should be a single (more central) place for it, e.g. it could go into |
|
On Thu, Oct 27, 2022 at 12:45:47PM -0700, ghost43 wrote:
> So I would suggest:
> 1. having the freeze also show in the Addresses tab, not just in the Coins tab (which is not shown by default, and I think is not an intuitive place to look for un-freezing UTXOs).
In the Coins tab, there is one line per utxo, each with one column for outpoint and one column for address. Users can freeze addresses and coins ~independently. If a coin being frozen is reflected by changing the background colour of the outpoint column, and an address being frozen has different bgcolor in the address column.
I see.
In the Addresses tab, it is not clear how to display "some coins are frozen" in the Addresses tab. That functionality is not there atm. I've sketched it out in #8040 but some more interface work would be needed (starting with figuring out how it should look like in the first place).
Checkered blue/white? Pale blue?
> 2. documenting the setconfig/getconfig commands.
> I have updated my branch to reflect these changes.
I don't think it's a good approach to teach the reader about getconfig/setconfig in the docstring of every method that might use a config key. There should be a single (more central) place for it, e.g. it could go into `simple_config.py`.
Also documented it in `simple_config.py`, see latest commit. Ideally it
would also be in the manpage.
|
|
On Thu, Oct 27, 2022 at 12:45:47PM -0700, ghost43 wrote:
In the Addresses tab, it is not clear how to display "some coins are frozen" in the Addresses tab. That functionality is not there atm. I've sketched it out in #8040 but some more interface work would be needed (starting with figuring out how it should look like in the first place).
Worth adding: it may be worth clarifying that *coins* (in the Coins tab)
can be frozen even when *addresses* are not frozen, in the pop-up
message which warns that there are not sufficient funds, and coins are
frozen.
By warning the user that they should check the (normally not visible)
Coins tab because coins are frozen, we would eliminate some of the
confusion which drives the need for changing the appearance of addresses
in the Addresses tab.
|
Add documentation to the docstring of the appropriate function
explaining how to disable the #6960 test for dusting transactions
Why this is a problem: when testing new wallet configurations it is helpful to
make some very low value test transactions to ensure everything works (without
losing too much money if something is not correctly set up and the private key
is not recoverable).
In this case the test transaction may fall below the threshold.
TODO:
line as well, since editing the config file by hand is a recipe for
trouble.
Unfortunately this is not as simple as doing:
and I can't find how electrum takes config arguments on the command
line. Maybe someone else knows?
and find it to be erroneous may not read this far into the code. An alternate
way to document it would be to include a note about the freezing behaviour in
the error that pops up, if frozen funds are the reason a transaction cannot be
sent.