Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FAQ-Use: musicbox #1649

Merged
merged 2 commits into from
Jan 19, 2024
Merged

FAQ-Use: musicbox #1649

merged 2 commits into from
Jan 19, 2024

Conversation

MarnixCroes
Copy link
Collaborator

#1602

didn't do all musicbox messages as there are 23, and some are obvious like Awaiting coinjoin

The structure should be something like this, but can be different:

  • Message1
    --What does it mean?
    --What can I do?

left out What can I do , this can become a rabbit hole, what should user do when having banned coins? send them out or something else...
and things like Insufficient funds eligible for coinjoin is something that should be improved in the UI, by telling the user more, i.e. that he has too small coins.

what does Awaiting cheaper coinjoins mean
@MarnixCroes
Copy link
Collaborator Author

@CAnorbo

@CAnorbo
Copy link
Contributor

CAnorbo commented Jan 16, 2024

The point of my request was first to inform the user and second to reduce the support requests by giving them the right troubleshooting steps.

Could you add a "Troubleshooting" section to each message?

docs/FAQ/FAQ-UseWasabi.md Outdated Show resolved Hide resolved
docs/FAQ/FAQ-UseWasabi.md Outdated Show resolved Hide resolved
docs/FAQ/FAQ-UseWasabi.md Outdated Show resolved Hide resolved
docs/FAQ/FAQ-UseWasabi.md Outdated Show resolved Hide resolved
@yahiheb
Copy link
Collaborator

yahiheb commented Jan 17, 2024

didn't do all musicbox messages as there are 23

@Kruwed did write an explanation for most of the music box (I used some of them in my suggestions above), I think we can add them as well.
WDYT?

Awaiting auto-start of coinjoin
When you open your wallet, there is a 14 minute delay before the automatic coinjoin process begins. This gives you the chance to ensure your intended transactions are completed and your connection is stable before continuing.

Awaiting coinjoin
This message appears if you have specified a long term coinjoin time preference in your settings and mining fees are higher than normal. Automatic coinjoin will resume when transaction fees drop or stabilize. You can change the coinjoin time preference setting to “hours” to register to coinjoin rounds immediately.

Coinjoin is paused/Coinjoin has stopped
While you have funds in your wallet below your anonymity score target, you can pause the automatic coinjoin function during the input registration phase.

Coinjoin successful! Continuing…
Your privacy progress percentage increases after a successful coinjoin. Once all of your coins reach the anonymity score target defined in the settings, your privacy progress reaches 100% and automatic coinjoin ends.

Round ended, awaiting next round
This message results from a coinjoin round ending early due to too many participants. Following this message, coinjoin participants are split into new rounds sorted by amount for greater efficiency.

Insufficient participants, retrying…
A minimum of 150 inputs are required to register for a coinjoin transaction to be built. A new 10 minute timeframe to gather the required participants starts when the previous one ends.

Coinjoin in progress
Signing the coinjoin transaction occurs during this phase. Pausing is not allowed at this point because it would disrupt the round for the other participants. Avoid disconnecting or closing your wallet during this stage, as it will cause your coins to be temporarily banned from participating in future coinjoin rounds.

Awaiting other participants
During this phase, inputs are registered privately with the coinjoin coordinator. You can view the coins that are selected for coinjoin through the UTXOs screen with the keyboard shortcut “CTRL + C + D”.

Awaiting the blame round
If another participant fails to sign the coinjoin transaction, this message briefly appears before a new coinjoin round is attempted with the responsive participants from the previous round.

Coinjoin may be uneconomical. Add more funds or press ‘Play’ to bypass
This message is displayed while your wallet balance is below the auto-start coinjoin threshold specified in the settings (0.01 BTC by default). This prevents coinjoin from starting automatically when transaction fees would have a high cost relative to your current balance.

Insufficient funds eligible for coinjoin
Inputs that have a value below 0.00005000 BTC are not eligible for coinjoin. You can view your input values through the UTXOs screen with the keyboard shortcut “CTRL + C + D”.

Awaiting confirmed funds
Only confirmed coins are able to register for coinjoin rounds. A timer icon appears in your transaction history next to unconfirmed transactions. If a non-coinjoin payment is stuck in an unconfirmed state, you can right click the entry in your transaction history to use the “Speedup Transaction” function to add mining fees.

Some funds are rejected from coinjoining
If an input has failed to sign for a previous round it registered to, it will be temporarily banned to prevent denial of service attacks. Coinjoin coordinators may also reject funds for risk management purposes. You can view the unban time through the UTXOs screen with the keyboard shortcut “CTRL + C + D”.

@MarnixCroes
Copy link
Collaborator Author

didn't do all musicbox messages as there are 23

@Kruwed did write an explanation for most of the music box (I used some of them in my suggestions above), I think we can add them as well. WDYT?

Awaiting auto-start of coinjoin
When you open your wallet, there is a 14 minute delay before the automatic coinjoin process begins. This gives you the chance to ensure your intended transactions are completed and your connection is stable before continuing.

Awaiting coinjoin
This message appears if you have specified a long term coinjoin time preference in your settings and mining fees are higher than normal. Automatic coinjoin will resume when transaction fees drop or stabilize. You can change the coinjoin time preference setting to “hours” to register to coinjoin rounds immediately.

Coinjoin is paused/Coinjoin has stopped
While you have funds in your wallet below your anonymity score target, you can pause the automatic coinjoin function during the input registration phase.

Coinjoin successful! Continuing…
Your privacy progress percentage increases after a successful coinjoin. Once all of your coins reach the anonymity score target defined in the settings, your privacy progress reaches 100% and automatic coinjoin ends.

Round ended, awaiting next round
This message results from a coinjoin round ending early due to too many participants. Following this message, coinjoin participants are split into new rounds sorted by amount for greater efficiency.

Insufficient participants, retrying…
A minimum of 150 inputs are required to register for a coinjoin transaction to be built. A new 10 minute timeframe to gather the required participants starts when the previous one ends.

Coinjoin in progress
Signing the coinjoin transaction occurs during this phase. Pausing is not allowed at this point because it would disrupt the round for the other participants. Avoid disconnecting or closing your wallet during this stage, as it will cause your coins to be temporarily banned from participating in future coinjoin rounds.

Awaiting other participants
During this phase, inputs are registered privately with the coinjoin coordinator. You can view the coins that are selected for coinjoin through the UTXOs screen with the keyboard shortcut “CTRL + C + D”.

Awaiting the blame round
If another participant fails to sign the coinjoin transaction, this message briefly appears before a new coinjoin round is attempted with the responsive participants from the previous round.

Coinjoin may be uneconomical. Add more funds or press ‘Play’ to bypass
This message is displayed while your wallet balance is below the auto-start coinjoin threshold specified in the settings (0.01 BTC by default). This prevents coinjoin from starting automatically when transaction fees would have a high cost relative to your current balance.

Insufficient funds eligible for coinjoin
Inputs that have a value below 0.00005000 BTC are not eligible for coinjoin. You can view your input values through the UTXOs screen with the keyboard shortcut “CTRL + C + D”.

Awaiting confirmed funds
Only confirmed coins are able to register for coinjoin rounds. A timer icon appears in your transaction history next to unconfirmed transactions. If a non-coinjoin payment is stuck in an unconfirmed state, you can right click the entry in your transaction history to use the “Speedup Transaction” function to add mining fees.

Some funds are rejected from coinjoining
If an input has failed to sign for a previous round it registered to, it will be temporarily banned to prevent denial of service attacks. Coinjoin coordinators may also reject funds for risk management purposes. You can view the unban time through the UTXOs screen with the keyboard shortcut “CTRL + C + D”.

fine by me,
but having a separate FAQ for each one is overkill imo

maybe just

### Other music box messages

#### Awaiting auto-start of coinjoin
When you open your wallet, there is a 14 minute delay before the automatic coinjoin process begins. This gives you the chance to ensure your intended transactions are completed and your connection is stable before continuing.

#### Awaiting coinjoin
This message appears if you have specified a long term coinjoin time preference in your settings and mining fees are higher than normal. Automatic coinjoin will resume when transaction fees drop or stabilize. You can change the coinjoin time preference setting to “hours” to register to coinjoin rounds immediately.

...

@Kruwed
Copy link
Contributor

Kruwed commented Jan 19, 2024

ACK.

Copy link
Collaborator

@yahiheb yahiheb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

We can add more music box messages later on if necessary.

@yahiheb yahiheb merged commit 12893c9 into WalletWasabi:master Jan 19, 2024
1 check passed
@MarnixCroes MarnixCroes deleted the faq-musicbox branch January 19, 2024 19:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants