Merge branch 'master' into pr/1701

WalletWasabi · Jun 20, 2024 · 3be1de0 · 3be1de0
2 parents b608fd5 + 703f20b
commit 3be1de0
Show file tree

Hide file tree

Showing 92 changed files with 673 additions and 240 deletions.
diff --git a/azure-pipelines.yml b/azure-pipelines.yml
@@ -25,7 +25,7 @@ steps:
     npm ci
     npm run build
 - script: |
-    npm run deploy -- -r https://$(GITHUB_DEPLOY_ACCESS_TOKEN)@github.com/zkSNACKs/WasabiDoc.git -u "Azure Pipeline <[email protected]>"
+    npm run deploy -- -r https://$(GITHUB_DEPLOY_ACCESS_TOKEN)@github.com/WalletWasabi/WasabiDoc.git -u "Azure Pipeline <[email protected]>"
   displayName: 'Build and deploy'
   condition: |
     and(not(eq(variables['Build.Reason'], 'PullRequest')),

diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -17,7 +17,7 @@ export default defineUserConfig({
         const render = md.renderer.render;
 
         const variables = {
-            currentVersion: '2.0.7.1',
+            currentVersion: '2.0.8.1',
             dotnetVersion: '8.0',
             zksnacksPublicKeyFingerprint: '6FB3 872B 5D42 292F 5992 0797 8563 4832 8949 861E',
             minInputCountFreshRound: '180',
@@ -38,7 +38,7 @@ export default defineUserConfig({
     theme: defaultTheme({
         logo: "/Logo_without_text_dark.png",
         logoDark: "/Logo_without_text.png",
-        docsRepo: 'https://github.com/zkSNACKs/WasabiDoc',
+        docsRepo: 'https://github.com/WalletWasabi/WasabiDoc',
         docsBranch: 'master',
         docsDir: 'docs',
         editLinks: true,

diff --git a/docs/.vuepress/public/AddWallet.png b/docs/.vuepress/public/AddWallet.png
diff --git a/docs/.vuepress/public/AddWalletAddPassphrase.png b/docs/.vuepress/public/AddWalletAddPassphrase.png
diff --git a/docs/.vuepress/public/AddWalletAddPassword.png b/docs/.vuepress/public/AddWalletAddPassword.png
diff --git a/docs/.vuepress/public/AddWalletButton.png b/docs/.vuepress/public/AddWalletButton.png
diff --git a/docs/.vuepress/public/AddWalletConfirmRecoveryWords.png b/docs/.vuepress/public/AddWalletConfirmRecoveryWords.png
diff --git a/docs/.vuepress/public/AddWalletRecoveryWords.png b/docs/.vuepress/public/AddWalletRecoveryWords.png
diff --git a/docs/.vuepress/public/AddWalletSuccessfullyAdded.png b/docs/.vuepress/public/AddWalletSuccessfullyAdded.png
diff --git a/docs/.vuepress/public/AddWalletWalletName.png b/docs/.vuepress/public/AddWalletWalletName.png
diff --git a/docs/.vuepress/public/AddressAwaitingPayment.png b/docs/.vuepress/public/AddressAwaitingPayment.png
diff --git a/docs/.vuepress/public/AddressesAwaitingPayment.png b/docs/.vuepress/public/AddressesAwaitingPayment.png
diff --git a/docs/.vuepress/public/AddressesAwaitingPaymentEditLabel.png b/docs/.vuepress/public/AddressesAwaitingPaymentEditLabel.png
diff --git a/docs/.vuepress/public/AddressesAwaitingPaymentQRCodeIcon.png b/docs/.vuepress/public/AddressesAwaitingPaymentQRCodeIcon.png
diff --git a/docs/.vuepress/public/AnonymityScoreTarget.png b/docs/.vuepress/public/AnonymityScoreTarget.png
diff --git a/docs/.vuepress/public/AutoStartCoinjoinThreshold.png b/docs/.vuepress/public/AutoStartCoinjoinThreshold.png
diff --git a/docs/.vuepress/public/CancelTxConfirm.png b/docs/.vuepress/public/CancelTxConfirm.png
diff --git a/docs/.vuepress/public/CoinjoinSettings.png b/docs/.vuepress/public/CoinjoinSettings.png
diff --git a/docs/.vuepress/public/CoinjoinSettingsAutomaticallyStartCoinjoin.png b/docs/.vuepress/public/CoinjoinSettingsAutomaticallyStartCoinjoin.png
diff --git a/docs/.vuepress/public/CoinjoinStrategy.png b/docs/.vuepress/public/CoinjoinStrategy.png
diff --git a/docs/.vuepress/public/CoinjoinStrategySettings.png b/docs/.vuepress/public/CoinjoinStrategySettings.png
diff --git a/docs/.vuepress/public/FeeDisplayUnit.png b/docs/.vuepress/public/FeeDisplayUnit.png
diff --git a/docs/.vuepress/public/History.png b/docs/.vuepress/public/History.png
diff --git a/docs/.vuepress/public/HistoryCoinjoin.png b/docs/.vuepress/public/HistoryCoinjoin.png
diff --git a/docs/.vuepress/public/HistoryCoinjoinExpanded.png b/docs/.vuepress/public/HistoryCoinjoinExpanded.png
diff --git a/docs/.vuepress/public/HistoryRightClick.png b/docs/.vuepress/public/HistoryRightClick.png
diff --git a/docs/.vuepress/public/HistorySort.png b/docs/.vuepress/public/HistorySort.png
diff --git a/docs/.vuepress/public/HistorySortDateColumn.png b/docs/.vuepress/public/HistorySortDateColumn.png
diff --git a/docs/.vuepress/public/MusicBoxAwaitingOtherParticipants.png b/docs/.vuepress/public/MusicBoxAwaitingOtherParticipants.png
diff --git a/docs/.vuepress/public/MusicBoxAwaitingToAutoStartCoinjoin.png b/docs/.vuepress/public/MusicBoxAwaitingToAutoStartCoinjoin.png
diff --git a/docs/.vuepress/public/MusicBoxCoinjoinInProgress.png b/docs/.vuepress/public/MusicBoxCoinjoinInProgress.png
diff --git a/docs/.vuepress/public/MusicBoxCoinjoinStopped.png b/docs/.vuepress/public/MusicBoxCoinjoinStopped.png
diff --git a/docs/.vuepress/public/MusicBoxCoinjoinSuccessful.png b/docs/.vuepress/public/MusicBoxCoinjoinSuccessful.png
diff --git a/docs/.vuepress/public/PayJoinPreviewTransaction.png b/docs/.vuepress/public/PayJoinPreviewTransaction.png
diff --git a/docs/.vuepress/public/PayJoinSend.png b/docs/.vuepress/public/PayJoinSend.png
diff --git a/docs/.vuepress/public/PaymentSuccessful.png b/docs/.vuepress/public/PaymentSuccessful.png
diff --git a/docs/.vuepress/public/PrivacyBar.png b/docs/.vuepress/public/PrivacyBar.png
diff --git a/docs/.vuepress/public/PrivacyProgressTile.png b/docs/.vuepress/public/PrivacyProgressTile.png
diff --git a/docs/.vuepress/public/ReceiveLabelingRequired.png b/docs/.vuepress/public/ReceiveLabelingRequired.png
diff --git a/docs/.vuepress/public/RedCoinIsolation.png b/docs/.vuepress/public/RedCoinIsolation.png
diff --git a/docs/.vuepress/public/SearchBarHelpSupportOpen.png b/docs/.vuepress/public/SearchBarHelpSupportOpen.png
diff --git a/docs/.vuepress/public/SearchBarTXIDSearch.png b/docs/.vuepress/public/SearchBarTXIDSearch.png
diff --git a/docs/.vuepress/public/Send.png b/docs/.vuepress/public/Send.png
diff --git a/docs/.vuepress/public/SendAmountField.png b/docs/.vuepress/public/SendAmountField.png
diff --git a/docs/.vuepress/public/SendButton.png b/docs/.vuepress/public/SendButton.png
diff --git a/docs/.vuepress/public/SendChangeFee.png b/docs/.vuepress/public/SendChangeFee.png
diff --git a/docs/.vuepress/public/SendCustomFee.png b/docs/.vuepress/public/SendCustomFee.png
diff --git a/docs/.vuepress/public/SendFeeIcon.png b/docs/.vuepress/public/SendFeeIcon.png
diff --git a/docs/.vuepress/public/SendFeeSlider.png b/docs/.vuepress/public/SendFeeSlider.png
diff --git a/docs/.vuepress/public/SendPassword.png b/docs/.vuepress/public/SendPassword.png
diff --git a/docs/.vuepress/public/SendPreviewTransaction.png b/docs/.vuepress/public/SendPreviewTransaction.png
diff --git a/docs/.vuepress/public/SendPreviewTransactionReviewCoins.png b/docs/.vuepress/public/SendPreviewTransactionReviewCoins.png
diff --git a/docs/.vuepress/public/SendPrivacySuggestion.png b/docs/.vuepress/public/SendPrivacySuggestion.png
diff --git a/docs/.vuepress/public/SendRecipientLabel.png b/docs/.vuepress/public/SendRecipientLabel.png
diff --git a/docs/.vuepress/public/SendToField.png b/docs/.vuepress/public/SendToField.png
diff --git a/docs/.vuepress/public/SettingsBitcoin.png b/docs/.vuepress/public/SettingsBitcoin.png
diff --git a/docs/.vuepress/public/SettingsBitcoinCore.png b/docs/.vuepress/public/SettingsBitcoinCore.png
diff --git a/docs/.vuepress/public/SettingsBitcoinCoreRemote.png b/docs/.vuepress/public/SettingsBitcoinCoreRemote.png
diff --git a/docs/.vuepress/public/SettingsButton.png b/docs/.vuepress/public/SettingsButton.png
diff --git a/docs/.vuepress/public/SettingsCoinjoinConfigs.png b/docs/.vuepress/public/SettingsCoinjoinConfigs.png
diff --git a/docs/.vuepress/public/SettingsCoordinatorURI.png b/docs/.vuepress/public/SettingsCoordinatorURI.png
diff --git a/docs/.vuepress/public/SettingsDustThreshold.png b/docs/.vuepress/public/SettingsDustThreshold.png
diff --git a/docs/.vuepress/public/SettingsNetwork.png b/docs/.vuepress/public/SettingsNetwork.png
diff --git a/docs/.vuepress/public/SpeedUpTxConfirm.png b/docs/.vuepress/public/SpeedUpTxConfirm.png
diff --git a/docs/.vuepress/public/TestNetIndicator.png b/docs/.vuepress/public/TestNetIndicator.png
diff --git a/docs/.vuepress/public/TorStatusWarningIcon.png b/docs/.vuepress/public/TorStatusWarningIcon.png
diff --git a/docs/.vuepress/public/UpdateAvailable.png b/docs/.vuepress/public/UpdateAvailable.png
diff --git a/docs/.vuepress/public/VerifyRecoveryWords.png b/docs/.vuepress/public/VerifyRecoveryWords.png
diff --git a/docs/.vuepress/public/WalletCoinsSendSelectedCoins.png b/docs/.vuepress/public/WalletCoinsSendSelectedCoins.png
diff --git a/docs/.vuepress/public/WalletDiscreetModeActive.png b/docs/.vuepress/public/WalletDiscreetModeActive.png
diff --git a/docs/.vuepress/public/WalletOpen.png b/docs/.vuepress/public/WalletOpen.png
diff --git a/docs/.vuepress/public/WalletRecovery.png b/docs/.vuepress/public/WalletRecovery.png
diff --git a/docs/.vuepress/public/WalletRecoveryAdvanced.png b/docs/.vuepress/public/WalletRecoveryAdvanced.png
diff --git a/docs/.vuepress/public/WalletSynchronizing.png b/docs/.vuepress/public/WalletSynchronizing.png
diff --git a/docs/.vuepress/public/WhiteMode.png b/docs/.vuepress/public/WhiteMode.png
diff --git a/docs/FAQ/FAQ-Installation.md b/docs/FAQ/FAQ-Installation.md
@@ -121,11 +121,15 @@ When you broadcast a transaction over clearnet, the connected full node will kno
 
 ### Can I use Wasabi on Tails?
 
-No, it is not possible to install Wasabi on Tails, because Wasabi uses the Tor control port, which is not exposed in this operating system.
+Since Wasabi version [2.0.8](https://github.com/WalletWasabi/WalletWasabi/releases/tag/v2.0.8) it is possible to run Wasabi on Tails.
+To make it work, Wasabi should be started with the `--UseTor=EnabledOnlyRunning` start up parameter or specify `"UseTor": "EnabledOnlyRunning"` in the config file.
+So Wasabi uses the existing Tor process, instead of starting a new one.
 
 ### Can I use Wasabi on Whonix?
 
-No, it is not possible to install Wasabi on Whonix, because Wasabi uses the Tor control port, which is not exposed in this operating system.
+Since Wasabi version [2.0.8](https://github.com/WalletWasabi/WalletWasabi/releases/tag/v2.0.8) it is possible to run Wasabi on Whonix.
+To make it work, Wasabi should be started with the `--UseTor=EnabledOnlyRunning` start up parameter or specify `"UseTor": "EnabledOnlyRunning"` in the config file.
+So Wasabi uses the existing Tor process, instead of starting a new one.
 
 ### What are the differences between the Debian/Ubuntu version and the "Other Linux" version?
 

diff --git a/docs/FAQ/FAQ-UseWasabi.md b/docs/FAQ/FAQ-UseWasabi.md
diff --git a/docs/getting-started/README.md b/docs/getting-started/README.md
@@ -48,16 +48,16 @@ Select _Create a new wallet_.
 
 Now follow the next few steps/dialogs: 
 - Write down the recovery words. (do not share these with anyone!)
-- Add a password. (do not forget it and also write it down on a separate place from the recovery words, without your password you cannot open your wallet and send your bitcoin!)
+- Add a passphrase. (do not forget it and also write it down on a separate place from the recovery words, without your passphrase you cannot open your wallet and send your bitcoin!)
 - Select the coinjoin strategy: we select the default one `Maximize Speed`.
 
 :::danger
 The Recovery words can never be shown again.
 :::
 
 :::danger
-The password cannot be changed later on.
-If you lose your password you lose your bitcoin.
+The passphrase cannot be changed later on.
+If you lose your passphrase you lose your bitcoin.
 :::
 
 ## Receive bitcoin

diff --git a/docs/using-wasabi/BackupBestPractices.md b/docs/using-wasabi/BackupBestPractices.md
@@ -1,11 +1,11 @@
 ---
 {
-  "title": "Backup Best Practices",
-  "description": "A detailed guide about the best practices of backing up your passwords and recovery words. This is the Wasabi documentation, an archive of knowledge about the open-source, non-custodial and privacy-focused Bitcoin wallet for desktop."
+  "title": "Wasabi Backup Best Practices",
+  "description": "A detailed guide about the best practices of backing up your passphrases and recovery words. This is the Wasabi documentation, an archive of knowledge about the open-source, non-custodial and privacy-focused Bitcoin wallet for desktop."
 }
 ---
 
-# Backup Best Practices
+# Wasabi Backup Best Practices
 
 [[toc]]
 
@@ -90,3 +90,4 @@ There are large quality differences in drives, but I am assuming you aren't usin
 - Trust that the object was not tampered with in delivery
 - Trust that no one has tampered with the object since you got it
 
+These are the methods you can use for your Wasabi backup and their benefits and tradeoffs. 
diff --git a/docs/using-wasabi/CoinJoin.md b/docs/using-wasabi/CoinJoin.md
@@ -64,12 +64,16 @@ Notice that it is not yet possible to coinjoin from a hardware wallet, the keys
 
 ### Fees
 
-A 0.3% coordination fee will be taken from fresh coins bigger than 0.01 BTC.
-Coins less than or equal to 0.01 BTC don't pay coordination fees at all, according to the _PlebsDontPay_ threshold.
+The coinjoin coordinator sets its own fee policy for the coinjoin service provided.
 
-Remixing is free, as well as coinjoining coins 1 hop from a coinjoin, although, Bitcoin mining fees still do apply, as shown in [this table](/FAQ/FAQ-UseWasabi.md#what-are-the-fees-for-the-coinjoin).
-So if you send a coinjoined coin and receive a change output, you will not be charged the coordination fee for this change output.
-The recipient of the payment will not have to pay the coordination fee, as long as he is making coinjoins with the same coordinator.
+Although the coordinator cannot steal money from the coinjoin participants, it could set a high mining fee rate and/or a high coordination fee. 
+This would make the participants pay a lot (unnecessarily). 
+To prevent against such behavior the Wasabi client can configure the maximum mining fee rate and the maximum coordination fee it is willing to pay per round. 
+If one of these is higher than the set values, the client will not participate in the coinjoin.
+
+The default values are 0% coordination fee and maximum 150 sat/vByte mining fee rate.
+
+![Coinjoin Configurations](/SettingsCoinjoinConfigs.png "Coinjoin Configurations")
 
 ## WabiSabi protocol step-by-step
 

diff --git a/docs/using-wasabi/ELI5.md b/docs/using-wasabi/ELI5.md
@@ -34,13 +34,13 @@ See [this chapter](/using-wasabi/InstallPackage.md) for a detailed step-by-step
 When you start Wasabi for the first time, the dialog to generate a new wallet will be open.
 You can set a unique name for the wallet so that you remember what it is for.
 In the next step, Wasabi will show your 12 recovery words.
-These must be carefully backed up, in the correct order, as they are needed to recover your wallet (together with the password) on another computer or in another wallet software.
-Next, choose a very secure password, as this encrypts the secrets, and should not be guessed by others.
-You will always need this password in order to spend your bitcoins, so take great care to back it up properly.
-Make sure you store the backup of your recovery words in a different location than the backup of your password.
+These must be carefully backed up, in the correct order, as they are needed to recover your wallet (together with the passphrase) on another computer or in another wallet software.
+Next, choose a very secure passphrase, as this encrypts the secrets, and should not be guessed by others.
+You will always need this passphrase in order to spend your bitcoins, so take great care to back it up properly.
+Make sure you store the backup of your recovery words in a different location than the backup of your passphrase.
 
 :::warning Backup both!
-If you ever need to restore your wallet in Wasabi, or any other wallet, you will need both: your password AND your 12 recovery words.
+If you ever need to restore your wallet in Wasabi, or any other wallet, you will need both: your passphrase AND your 12 recovery words.
 :::
 
 See [this chapter](/using-wasabi/WalletGeneration.md) for more information on how to securely generate your wallet.
@@ -63,7 +63,7 @@ Sending process is different depending on the privacy of coins you have. Assumin
 2. Insert the address of the receiver and type in the amount the receiver should get, then click `Continue`.
 3. Enter the name of the person or company receiving the payment and click `Continue`.
 4. Make sure everything is filled in correctly in `Preview Transaction` window and click `Confirm`.
-5. Type in your password and click `Continue`.
+5. Type in your passphrase and click `Continue`.
 
 You will now see a pop-up window telling you that the transaction is broadcasted to the Bitcoin network.
 

diff --git a/docs/using-wasabi/PayJoin.md b/docs/using-wasabi/PayJoin.md
@@ -16,17 +16,17 @@
 2. Request from the receiver a [BIP21 Bitcoin URI](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) with the flag `pj=` and paste it into the `To` field of the `Send` dialog.
 (E.g. `bitcoin:tb1q0382a3m2jzvyk5lkea5h5jcht88xa6l0jufgwx?amount=0.00010727&pj=https://payjoin.test.kukks.org/BTC/pj`)
 
+Enter the label of the recipient.
+
 ![Send Bitcoin PayJoin transaction in Wasabi Wallet](/PayJoinSend.png "Send Bitcoin PayJoin transaction in Wasabi Wallet")
 
 3. Click `Continue`.
 
-4. Enter the label.
-
-5. At `Preview Transaction`, verify that the information is correct.
+4. At `Preview Transaction`, verify that the information is correct.
 
 ![PayJoinPreviewTransaction](/PayJoinPreviewTransaction.png "PayJoin Preview Transaction")
 
-6. Click `Confirm`, and type in the password.
+5. Click `Confirm`, and type in the passphrase.
 
 :::warning The success of a PayJoin transaction is not something that depends on Wasabi.
 It may happen that the transaction is broadcast with success, but that it is not a PayJoin.