Backend v205

.deepsource.toml

@@ -1,7 +1,4 @@
 version = 1
 
-[[analyzers]]
-name = "csharp"
-
 [[analyzers]]
 name = "shell"

.editorconfig

@@ -10,7 +10,7 @@ insert_final_newline = true
 # Formatting - remove any whitespace characters preceding newline characters
 trim_trailing_whitespace = true
 
-[*.{cs,csproj}]
+[*.{cs,csproj,props}]
 
 # use hard tabs for indentation
 indent_style = tab
@@ -26,14 +26,15 @@ indent_size = 2
 
 [*.cs]
 
+# Spell Checker rules
+spelling_languages = en-us
+spelling_checkable_types = strings,identifiers,comments
+spelling_error_severity = information
+spelling_exclusion_path = .\exclusion.dic
+
 # require braces to be on a new line for all
 csharp_new_line_before_open_brace = all
 
-# Formatting - organize using options
-
-# do not place System.* using directives before other using directives
-dotnet_sort_system_directives_first = true:error
-
 # Formatting - spacing options
 
 # require NO space between a cast and the value
@@ -295,3 +296,6 @@ dotnet_diagnostic.CA1827.severity = warning
 
 # CA1822: This complains to make functions static. Static is evil. Don't let it complain.
 dotnet_diagnostic.CA1822.severity = none
+
+# CA1868: Unnecessary call to Set.Contains(item)
+dotnet_diagnostic.CA1868.severity = warning

.github/workflows/auto-add-to-projcet.yml

@@ -4,6 +4,7 @@ on:
   issues:
     types:
       - opened
+      - reopened
 
 permissions: {}
 jobs:

.github/workflows/codeql.yml

@@ -0,0 +1,44 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'csharp' ]
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+
+    - name: 'Install dotnet'
+      uses: actions/setup-dotnet@v3
+      with:
+        dotnet-version: '7.0.x'
+
+    - name: 'Restore packages'
+      run: dotnet restore
+
+    - name: 'Build project'
+      run: dotnet build --no-restore --configuration Release
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

CONTRIBUTING.md

@@ -1,10 +1,20 @@
-# Wasabi Coding Conventions
+# Contributing to Wasabi Wallet
+
+## How to be useful for the project
+
+- Any issue labelled as [good first issue](https://github.com/zkSNACKs/WalletWasabi/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is good to start contributing to Wasabi.
+- Always focus on a specific issue in your pull request and avoid unrelated/unnecessary changes.
+- Avoid working on complex problems (fees, amount decomposition, coin selection...) without extensive research on the context, either on Github or asking to contributors.
+- Avoid working on a UI or UX feature without first seeing a conclusion from a UX meeting.
+- Consider filing a new issue or explaining in an opened issue the change that you want to make, and wait for concept ACKs to work on the implementation.
+- For backend, the [Relevance Realization Buffet](https://github.com/orgs/zkSNACKs/projects/18/views/48) view is a list of tasks that has to be investigated or tackled. You can assign yourself to an issue or just make the pull request.
+- Feel free to join the [zkSNACKs Slack Server](https://join.slack.com/t/tumblebit/shared_invite/enQtNjQ1MTQ2NzQ1ODI0LWIzOTg5YTM3YmNkOTg1NjZmZTQ3NmM1OTAzYmQyYzk1M2M0MTdlZDk2OTQwNzFiNTg1ZmExNzM0NjgzY2M0Yzg) to discuss with other contributors.
 
 ## Automatic code clean up
 
 **Visual Studio IDE:**
 
-**DO** use [CodeMaid](http://www.codemaid.net/), a Visual Studio extension to automatically clean up your code on saving the file.
+**DO** use [CodeMaid](https://www.codemaid.net/), a Visual Studio extension to automatically clean up your code on saving the file.
 CodeMaid is a non-intrusive code cleanup tool.
 
 Wasabi's CodeMaid settings [can be found in the root of the repository](https://github.com/zkSNACKs/WalletWasabi/blob/master/CodeMaid.config). They are automatically picked up by Visual Studio when you open the project, assuming the CodeMaid extension is installed. Unfortunately CodeMaid has no Visual Studio Code extension yet. You can check out the progress on this [under this GitHub issue](https://github.com/codecadwallader/codemaid/issues/273).
@@ -55,14 +65,14 @@ If you are a new contributor **DO** keep refactoring pull requests short, uncomp
 
 ```cs
 // GOOD
-private AsyncLock AsyncLock { get; } = new AsyncLock();
+private AsyncLock AsyncLock { get; } = new();
 using (await AsyncLock.LockAsync())
 {
 	...
 }
 
 // GOOD
-private object Lock { get; } = new object();
+private object Lock { get; } = new();
 lock (Lock)
 {
 	...
@@ -131,7 +141,7 @@ private async void Synchronizer_ResponseArrivedAsync(object? sender, EventArgs e
 ## `ConfigureAwait(false)`
 
 Basically every async library method should use `ConfigureAwait(false)` except:
-- Methods that touch objects on the UI Thread, like modifying UI controls. 
+- Methods that touch objects on the UI Thread, like modifying UI controls.
 - Methods that are unit tests, xUnit [Fact].
 
 **Usage:**
@@ -145,13 +155,26 @@ await MyMethodAsync().ConfigureAwait(false);
 // Note: inside MyMethodAsync() you can still use .ConfigureAwait(false);.
 var result = await MyMethodAsync();
 
-// At this point we are still on the UI thread, so you can safely touch UI elements. 
+// At this point we are still on the UI thread, so you can safely touch UI elements.
 myUiControl.Text = result;
 ```
 
 - [ConfigureAwait FAQ](https://devblogs.microsoft.com/dotnet/configureawait-faq/)
 
-## Disposing Subscriptions in ReactiveObjects
+## Never throw AggregateException and Exception in a mixed way
+It causes confusion and awkward catch clauses.
+[Example](https://github.com/zkSNACKs/WalletWasabi/pull/10353/files)
+
+---
+
+# UI Coding Conventions
+
+The following is a list of UI specific coding conventions. Follow these any time you are contributing code in the following projects:
+ - `WalletWasabi.Fluent`
+ - `WalletWasabi.Fluent.Desktop`
+ - `WalletWasabi.Fluent.Generators`
+
+ ## Disposing Subscriptions in ReactiveObjects
 
 **DO** follow [ReactiveUI's Subscription Disposing Conventions](https://reactiveui.net/docs/guidelines/framework/dispose-your-subscriptions).
 
@@ -174,14 +197,14 @@ this.WhenAnyValue(...)
 
 ## Subscribe triggered once on initialization
 
-When you subscribe with the usage of `.WhenAnyValue()` right after the creation one call of Subcription will be triggered. This is by design and most of the cases it is fine. Still you can supress this behaviour by adding `Skip(1)`. 
+When you subscribe with the usage of `.WhenAnyValue()` right after the creation one call of Subcription will be triggered. This is by design and most of the cases it is fine. Still you can supress this behaviour by adding `Skip(1)`.
 
 ```cs
 this.WhenAnyValue(x => x.PreferPsbtWorkflow)
 	.Skip(1)
 	.Subscribe(value =>
 	{
-		// Expensive operation, that should not run unnecessary. 
+		// Expensive operation, that should not run unnecessary.
 	});
 ```
 
@@ -197,13 +220,13 @@ this.WhenAnyValue(x => x.PreferPsbtWorkflow)
 public class RepositoryViewModel : ReactiveObject
 {
   private ObservableAsPropertyHelper<bool> _canDoIt;
-  
+
   public RepositoryViewModel()
   {
     _canDoIt = this.WhenAnyValue(...)
 		.ToProperty(this, x => x.CanDoIt, scheduler: RxApp.MainThreadScheduler);
   }
-  
+
   public bool CanDoIt => _canDoIt?.Value ?? false;
 }
 ```
@@ -236,12 +259,106 @@ Some pointers on how to recognise if we are breaking MVVM:
 
 If it seems not possible to implement something without breaking some of this advice please consult with @danwalmsley.
 
-## Avoid using Grid as much as possible, Use Panel instead 
+## Avoid using Grid as much as possible, Use Panel instead
 If you don't need any row or column splitting for your child controls, just use `Panel` as your default container control instead of `Grid` since it is a moderately memory and CPU intensive control.
 
-## Never throw AggregateException and Exception in a mixed way
-It causes confusion and awkward catch clauses.
-[Example](https://github.com/zkSNACKs/WalletWasabi/pull/10353/files) 
+## ViewModel Hierarchy
+
+The ViewModel structure should reflect the UI structure as much as possible. This means that ViewModels can have *child* ViewModels directly referenced in their code, just like Views have direct reference to *child* views.
+
+❌ **DO NOT** write ViewModel code that depends on *parent* or *sibling* ViewModels in the logical UI structure. This harms both testability and maintainability.
+
+Examples:
+
+ - ✔️ `MainViewModel` represents the Main Wasabi UI and references `NavBarViewModel`.
+ - ✔️ `NavBarViewModel` represents the left-side navigation bar and references `WalletListViewModel`.
+ - ❌ `NavBarViewModel` code must NOT reference `MainViewModel` (its logical parent).
+ - ❌ `WalletListViewModel` code must NOT reference `NavBarViewModel` (its logical parent).
+ - ❌ `WalletListViewModel` code must NOT reference other ViewModels that are logical children of `NavBarViewModel` (its logical siblings).
+
+## UI Models
+
+The UI Model classes (which comprise the *Model* part of the MVVM pattern) sit as an abstraction layer between the UI and the larger Wasabi Object Model (which lives in the `WalletWasabi` project). This layer is responsible for:
+
+ - Exposing Wasabi data and functionality in a UI-friendly manner. Usually in the form of Observables.
+
+ - Avoiding tight coupling between UI code and business logic. This is critical for testability of UI code, mainly ViewModels.
+
+❌ **DO NOT** write ViewModel code that depends directly on `WalletWasabi` objects such as `Wallet`, `KeyManager`, `HdPubKey`, etc.
+
+✔️ **DO** write ViewModel code that depends on `IWalletModel`, `IWalletRepository`, `IAddress`, etc.
+
+❌ **DO NOT** convert regular .NET properties from `WalletWasabi` objects into observables or INPC properties in ViewModel code.
+
+❌ **DO NOT** convert regular .NET events from `WalletWasabi` objects into observables in ViewModel code.
+
+✔️ If such conversions are required, **DO** write them into the UI Model layer.
+
+## UiContext
+
+ViewModels that depend on external components (such as Navigation, Clipboard, QR Reader, etc) can access these via the `ViewModelBase.UIContext` property. For instance:
+
+ - Get text from clipboard: `var text = await UIContext.Clipboard.GetTextAsync();`
+
+ - Generate QR Code: `await UIContext.QrGenerator.Generate(data);`
+
+ - Open a popup or navigate to another Viewmodel: `UIContext.Navigate().To(....)`
+
+This is done to facilitate unit testing of viewmodels, since all dependencies that live inside the `UiContext` are designed to be mock-friendly.
+
+❌ **DO NOT** write Viewmodel code that directly depends on external device-specific components or code that might otherwise not work in the context of a unit test.
+
+## Source-Generated ViewModel Constructors
+
+Whenever a ViewModel references its `UiContext` property, the `UiContext` object becomes an actual **dependency** of said ViewModel. It must therefore be initialized, ideally as a constructor parameter.
+
+In order to minimize the amount of boilerplate required for such initialization, several things occur in this case:
+ - A new constructor is generated for that ViewModel, including all parameters of any existing constructor plus the UiContext.
+ - This generated constructor initializes the `UiContext` *after* running the code of the manually written constructor (if any).
+ - A Roslyn Analyzer inspects any manually written constructors in the ViewModel to prevent references to `UiContext` in the constructor body, before the above mentioned initialization can take place, resulting in `NullReferenceException`s.
+ - The Analyzer demands the manually written constructor to be declared `private`, so that external instatiation of the ViewModel is done by calling the source-generated constructor.
+
+❌ Writing code that directly references `UiContext` in a ViewModel's constructor body will result in a compile-time error.
+
+❌ Writing code that indirectly references `UiContext` in ViewModel's constructor body will result in a run-time `NullReferenceException`.
+
+✔️ Writing code that directly or indirectly references `UiContext` inside a lambda expression in a ViewModel's constructor body is okay, since this code is deferred to a later time at run-time when the `UiContext` property has already been properly initialized.
+
+Example:
+
+```csharp
+    // ❌ BAD, constructor should be private
+    public AddressViewModel(IAddress address)
+	{
+		if (condition)
+		{
+			//❌ BAD, UiContext is null at this point.
+			UiContext.Navigate().To(someOtherViewModel);
+		}
+	}
+
+    // ✔️ GOOD, constructor is private
+    private AddressViewModel(IAddress address)
+	{
+		//✔️ GOOD, UiContext is already initialized when the Command runs
+		NextCommand = ReactiveCommand.Create(() => UiContext.Navigate().To(someOtherViewModel)));
+	}
+```
+
+If you absolutely must reference `UiContext` in the constructor, you can create a public constructor explicitly taking `UiContext` as a parameter:
+
+```csharp
+    // ✔️ GOOD,
+    public AddressViewModel(UiContext uiContext, IAddress address)
+	{
+		UiContext = uiContext;
+
+		// ✔️Other code here can safely use the UiContext since it's explicitly initialized above.
+	}
+```
+
+In this case, no additional constructors will be generated, and the analyzer will be satisfied.
+
 
 
 

Contrib/AffiliationServer/README.md

@@ -15,3 +15,60 @@ publicKey: 3059301306072a8648ce3d020106082a8648ce3d0301070342000434117d20172fba2
 The `secretKey` must be settled as value in the coordinators `WabiSabiConfig.json` file in the `AffiliationMessageSignerKey` field while the `publicKey` must be
 shared with all the partners acting as affiliates (those running an affiliation server).
 
+
+Revenue Sharing Calculator
+--------------
+
+A script to calculate the total amount of bitcoins from affiliate.
+
+This script takes the coinjoin notifications provided by the affiliated which proves the affiliation of unmixed inputs and calculates the total amount of
+bitcoins coming from the affiliated. Given Wasabi doesn't store any kind of information related to affiliations, it is the affiliated the one that needs
+to prove the affiliation of unmixed inputs by presenting the coinjoin notifications.
+
+### Example
+
+This command runs the revenue.fsx script which parses the coinjoin notifications located in the directory `notification`. It verifies the notification is signed
+by the coordinator, that's why we must specify the coordinator's affiliation `pubkey`. The `connection` string is for authenticating agains the bitcoin node's
+RPC interface (`user:password`, `cookiefile`) which is required to verify the coinjoin transaction referred in the coinjoin notification really happened and
+it is in the blockchain. Finally, `affiliate` is also required because a coinjoin notification is valid only for one specific affiliated.
+
+```bash
+$ dotnet fsi revenue.fsx -- --network=TestNet \
+     --connection=<rpc-connection@> \
+      --path=notification \
+      --pubkey=3059301306072a8648ce3d020106082a8648ce3d03010703420004f267804052bd863a1644233b8bfb5b8652ab99bcbfa0fb9c36113a571eb5c0cb7c733dbcf1777c2745c782f96e218bb71d67d15da1a77d37fa3cb96f423e53ba \
+      --affiliate=WalletWasabi
+```
+
+Optional argument `coordinationFeeRate` can also be specified and its default value is `0.003`
+
+The result can be seen below:
+
+```
+coinjoin: 25aaef88eec92b18368c52fc3ef5f602f8dac1caea3cd9d5ee2d80ac81e61784 - Total amount: 6669693 satoshis. Share: 20009
+          4319673 0C155D64B106A6E09853F61726BBEA113A434D5528516CE1058A6FC045666294:0
+          2350020 38DED71FC19FB8189B8A90CB545CDDCAA9345FBE7ACC0E605347D9ED260FF00C:0
+coinjoin: e43ed0cadf6997e96c2412a8cf0a0773fb735a52482f3ddcb7669ba8f7ba7bfc - Total amount: 0 satoshis. Share: 0
+coinjoin: fbae1225f9443d88b22551e44fc90c2f9a0c88b33e868de3dd8b481a88e4171f - Total amount: 1062882 satoshis. Share: 3188
+          1062882 A6AA999F9C07A73BB877D46213801FD77A9324ACD06F137915B7467EB175B18F:1
+Total revenue to share: 0.00023197 btc.
+```
+
+There were three coinjoins. The first one contained two affiliated coins, the second one contained no affiliated coins and the third one contained one
+affiliated coin.
+
+This affiliated contributed a total of 0.00023197 btc in coordination fees.
+
+### Useful tip
+
+In case you don't have an indexed bitcoin node locally you can map the RPC port of one remote node as follow:
+
+```bash
+$ ssh -N -L remote-rpc-port:localhost:local-rpc-port server
+```
+
+For example, for testnet this would look like:
+
+```bash
+$ ssh -N -L 18332:localhost:18332 zk-testing
+```

Contrib/AffiliationServer/notification/README.md

@@ -0,0 +1,4 @@
+Coinjoin Notifications
+----------------------
+
+This directory contains three real coinjoin notifications for testing and demo.

Contrib/AffiliationServer/notification/n1.txt

@@ -0,0 +1 @@
+{"body":{"transaction_id":"e43ed0cadf6997e96c2412a8cf0a0773fb735a52482f3ddcb7669ba8f7ba7bfc","inputs":[{"prevout":{"hash":"6026c50adbc7261107dcfcdcc9a1c87bfb9493f74ca149ac120efff50af9283a","index":4},"script_pubkey":"0014916b9271efaacbc0e817747d94a00383157bd148","amount":177147,"is_affiliated":false,"is_no_fee":true},{"prevout":{"hash":"0351cf2e1521db00d325f34945b396ccec0c566e1d630288bb6b97d7959a8d8c","index":4},"script_pubkey":"0014f7b209c71bbb9105c7f4f63583ea0ecc33f7a26a","amount":131072,"is_affiliated":false,"is_no_fee":true},{"prevout":{"hash":"e18149e4e0fa337e7356cd516a8e3b7dbd903ec71daabf7ead1d6fae9dfa1c86","index":5},"script_pubkey":"5120782b768614b5988446ef4939d327496bf3f774c89c11860bb8bccefbf8fd0027","amount":32768,"is_affiliated":false,"is_no_fee":true},{"prevout":{"hash":"c720de168c4c0b5855e740eba8e6712767be28a58485f80be1df911a200f0f48","index":17},"script_pubkey":"5120d7ca470eff5de20d76a1be279cea6fcd63dd485ad22a49f7f8eab6196177097a","amount":5000,"is_affiliated":false,"is_no_fee":true}],"outputs":[{"amount":118098,"script_pubkey":"5120509c76013f4f27cecfdcea5e63de58813a736d7cc8aa5f4d244436f1217d54ad"},{"amount":118098,"script_pubkey":"5120a900c768fa280417e9e675332b8e28fe30965146d620cb9b5a0ac6914dcf9381"},{"amount":78863,"script_pubkey":"001494b43f4c56178a84b933bbb9ead63c89b1a2a7c6"},{"amount":10000,"script_pubkey":"001414ad5509e96c0c400716e2606c8fc2cd68339ef8"},{"amount":10000,"script_pubkey":"00142c951089ca62f4ab9cc25d3d50e5c10115a78f56"},{"amount":10000,"script_pubkey":"0014a15b541be8e779a4160548afa1ac5d809d6fade2"}],"slip44_coin_type":1,"fee_rate":300000,"no_fee_threshold":1000000,"min_registrable_amount":5000,"timestamp":1681413569},"signature":"52b9335cf0a4ab75dbc17a97e4bd8fb868a994d2bfce6d69bfee4b7a8057bb45943c8459ab1bfc5e4838eed62a39357255e6943fa710672e63c629d47a49e9be"}