Skip to content

Commit

Permalink
Merge branch 'master' into SendManualControl2
Browse files Browse the repository at this point in the history
  • Loading branch information
ichthus1604 committed Jun 21, 2024
2 parents 994506c + f7a9e58 commit 41c3ded
Show file tree
Hide file tree
Showing 76 changed files with 291 additions and 260 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ contact_links:
url: https://docs.wasabiwallet.io/
about: Search for any information about Wasabi.
- name: 💪 Community support
url: https://github.com/zkSNACKs/WalletWasabi/discussions/categories/support
url: https://github.com/WalletWasabi/WalletWasabi/discussions/categories/support
about: Feel free to ask anything.
- name: ❓ Other issue?
url: https://github.com/zkSNACKs/WalletWasabi/discussions/
url: https://github.com/WalletWasabi/WalletWasabi/discussions/
about: Search on the community forum.
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## 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.
- Any issue labelled as [good first issue](https://github.com/WalletWasabi/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.
Expand All @@ -18,7 +18,7 @@
**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).
Wasabi's CodeMaid settings [can be found in the root of the repository](https://github.com/WalletWasabi/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).

**Rider IDE:**

Expand All @@ -31,7 +31,7 @@ And also enable `Enable EditorConfig support` in `Settings -> Editor -> Code Sty

## .editorconfig

Not only CodeMaid, but Visual Studio also enforces consistent coding style through [`.editorconfig`](https://github.com/zkSNACKs/WalletWasabi/blob/master/.editorconfig) file.
Not only CodeMaid, but Visual Studio also enforces consistent coding style through [`.editorconfig`](https://github.com/WalletWasabi/WalletWasabi/blob/master/.editorconfig) file.

If you are using Visual Studio Code make sure to install "C# Dev Kit" extension and add the following settings to your settings file:

Expand All @@ -41,13 +41,13 @@ If you are using Visual Studio Code make sure to install "C# Dev Kit" extension

## Technologies and scope

- [.NET SDK](https://dotnet.microsoft.com/en-us/): free, open-source, cross-platform framework for building apps. SDK version path: [WalletWasabi/global.json](https://github.com/zkSNACKs/WalletWasabi/blob/master/global.json).
- [.NET SDK](https://dotnet.microsoft.com/en-us/): free, open-source, cross-platform framework for building apps. SDK version path: [WalletWasabi/global.json](https://github.com/WalletWasabi/WalletWasabi/blob/master/global.json).
- [C#](https://dotnet.microsoft.com/en-us/languages/csharp): open-source programming language.
- Model-View-ViewModel architecture (MVVM).
- [Avalonia UI](https://www.avaloniaui.net/): framework to create cross-platform UI.
- [xUnit](https://xunit.net/): create unit tests.
- Dependencies path: [WalletWasabi/Directory.Packages.props](https://github.com/zkSNACKs/WalletWasabi/blob/master/Directory.Packages.props).
- Developer's documentation path: [WalletWasabi/WalletWasabi.Documentation/](https://github.com/zkSNACKs/WalletWasabi/tree/master/WalletWasabi.Documentation).
- Dependencies path: [WalletWasabi/Directory.Packages.props](https://github.com/WalletWasabi/WalletWasabi/blob/master/Directory.Packages.props).
- Developer's documentation path: [WalletWasabi/WalletWasabi.Documentation/](https://github.com/WalletWasabi/WalletWasabi/tree/master/WalletWasabi.Documentation).

# Code conventions

Expand Down Expand Up @@ -177,7 +177,7 @@ myUiControl.Text = result;

## 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)
[Example](https://github.com/WalletWasabi/WalletWasabi/pull/10353/files)

## Unused return value

Expand Down
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<a href="https://wasabiwallet.io">
<img src="https://github.com/zkSNACKs/WalletWasabi/blob/master/ui-ww.png">
<img src="https://github.com/WalletWasabi/WalletWasabi/blob/master/ui-ww.png">
</a>
</p>

Expand All @@ -21,15 +21,15 @@
API
</a>
<span> | </span>
<a href="https://github.com/zkSNACKs/WalletWasabi/discussions/5185">
<a href="https://github.com/WalletWasabi/WalletWasabi/discussions/5185">
Support
</a>
<span> | </span>
<a href="https://www.youtube.com/c/WasabiWallet">
YouTube
</a>
<span> | </span>
<a href="https://github.com/zkSNACKs/WalletWasabi/blob/master/PGP.txt">
<a href="https://github.com/WalletWasabi/WalletWasabi/blob/master/PGP.txt">
PGP
</a>
</h3>
Expand All @@ -46,10 +46,10 @@
[4]: https://dev.azure.com/zkSNACKs/Wasabi/_build?definitionId=1
[5]: https://dev.azure.com/zkSNACKs/Wasabi/_apis/build/status/Wasabi.Osx?branchName=master
[6]: https://dev.azure.com/zkSNACKs/Wasabi/_build?definitionId=2
[7]: https://img.shields.io/github/license/zkSNACKs/WalletWasabi.svg
[8]: https://github.com/zkSNACKs/WalletWasabi/blob/master/LICENSE.md
[9]: https://www.codefactor.io/repository/github/zksnacks/walletwasabi/badge
[10]: https://www.codefactor.io/repository/github/zksnacks/walletwasabi
[7]: https://img.shields.io/github/license/WalletWasabi/WalletWasabi.svg
[8]: https://github.com/WalletWasabi/WalletWasabi/blob/master/LICENSE.md
[9]: https://www.codefactor.io/repository/github/WalletWasabi/walletwasabi/badge
[10]: https://www.codefactor.io/repository/github/WalletWasabi/walletwasabi
[11]: https://dev.azure.com/zkSNACKs/Wasabi/_apis/build/status/Wasabi.ContinuousDelivery?branchName=master
[12]: https://dev.azure.com/zkSNACKs/Wasabi/_build/latest?definitionId=12&branchName=master
[13]: https://dev.azure.com/zkSNACKs/Wasabi/_apis/build/status/Wasabi.DeterministicBuild?branchName=master
Expand All @@ -58,7 +58,7 @@
</h3>
<br>

# [Download Wasabi](https://github.com/zkSNACKs/WalletWasabi/releases)
# [Download Wasabi](https://github.com/WalletWasabi/WalletWasabi/releases)

<br>

Expand All @@ -75,7 +75,7 @@
Clone & Restore & Build

```sh
git clone --depth=1 --single-branch --branch=master https://github.com/zkSNACKs/WalletWasabi.git
git clone --depth=1 --single-branch --branch=master https://github.com/WalletWasabi/WalletWasabi.git
cd WalletWasabi/WalletWasabi.Fluent.Desktop
dotnet build
```
Expand Down
4 changes: 2 additions & 2 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Security Policy

If a vulnerability does not compromise users' privacy or security, open a [regular GitHub issue](https://github.com/zkSNACKs/WalletWasabi/issues/new/choose).
If it does, then pay great care to responsible disclosure. Report a [private vulnerability on GitHub](https://github.com/zkSNACKs/WalletWasabi/security/advisories/new) or send an email to [email protected], preferably using PGP encryption: `F079 0C08 68BD BAB8 EE33 F9CE 50FB 7FEB 00F9 7588`
If a vulnerability does not compromise users' privacy or security, open a [regular GitHub issue](https://github.com/WalletWasasbi/WalletWasabi/issues/new/choose).
If it does, then pay great care to responsible disclosure. Report a [private vulnerability on GitHub](https://github.com/WalletWasabi/WalletWasabi/security/advisories/new) or send an email to [email protected], preferably using PGP encryption: `F079 0C08 68BD BAB8 EE33 F9CE 50FB 7FEB 00F9 7588`

```
-----BEGIN PGP PUBLIC KEY BLOCK-----
Expand Down
2 changes: 1 addition & 1 deletion WalletWasabi.Backend/Startup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public void ConfigureServices(IServiceCollection services)
Version = $"v{Constants.BackendMajorVersion}",
Title = "Wasabi Wallet API",
Description = "Privacy focused Bitcoin Web API.",
License = new OpenApiLicense { Name = "Use under MIT.", Url = new Uri("https://github.com/zkSNACKs/WalletWasabi/blob/master/LICENSE.md") }
License = new OpenApiLicense { Name = "Use under MIT.", Url = new Uri("https://github.com/WalletWasabi/WalletWasabi/blob/master/LICENSE.md") }
});

// Set the comments path for the Swagger JSON and UI.
Expand Down
2 changes: 1 addition & 1 deletion WalletWasabi.Backend/WalletWasabi.Backend.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<Copyright>MIT</Copyright>
<PackageTags>walletwasabi, wasabiwallet, wasabi, wallet, bitcoin, nbitcoin, tor, zerolink, wabisabi, coinjoin, fungibility, privacy, anonymity</PackageTags>
<RepositoryType>Git</RepositoryType>
<RepositoryUrl>https://github.com/zkSNACKs/WalletWasabi/</RepositoryUrl>
<RepositoryUrl>https://github.com/WalletWasabi/WalletWasabi/</RepositoryUrl>
<PathMap>$(MSBuildProjectDirectory)\=WalletWasabi.Backend</PathMap>
<DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
<StaticWebAssetsEnabled>false</StaticWebAssetsEnabled>
Expand Down
2 changes: 1 addition & 1 deletion WalletWasabi.Daemon/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,4 +66,4 @@ Wasabi Daemon 2.0.3.0

### Usage

To interact with the daemon, use the [RPC server](https://docs.wasabiwallet.io/using-wasabi/RPC.html) or the [wcli script](https://github.com/zkSNACKs/WalletWasabi/tree/master/Contrib/CLI).
To interact with the daemon, use the [RPC server](https://docs.wasabiwallet.io/using-wasabi/RPC.html) or the [wcli script](https://github.com/WalletWasabi/WalletWasabi/tree/master/Contrib/CLI).
6 changes: 3 additions & 3 deletions WalletWasabi.Daemon/WalletWasabi.Daemon.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@
<PackageId>Wasabi Wallet Daemon</PackageId>
<AssemblyTitle>Wasabi Wallet Daemon</AssemblyTitle>
<PackageTags>bitcoin-wallet;privacy;bitcoin;dotnet;nbitcoin;cross-platform;zerolink;wallet;wabisabi;coinjoin;tor</PackageTags>
<PackageProjectUrl>https://github.com/zkSNACKs/WalletWasabi/</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/zkSNACKs/WalletWasabi/blob/master/LICENSE.md</PackageLicenseUrl>
<PackageProjectUrl>https://github.com/WalletWasabi/WalletWasabi/</PackageProjectUrl>
<PackageLicenseUrl>https://github.com/WalletWasabi/WalletWasabi/blob/master/LICENSE.md</PackageLicenseUrl>
<RepositoryType>git</RepositoryType>
<RepositoryUrl>https://github.com/zkSNACKs/WalletWasabi/</RepositoryUrl>
<RepositoryUrl>https://github.com/WalletWasabi/WalletWasabi/</RepositoryUrl>
<Product>Wasabi Wallet Fluent Daemon</Product>
</PropertyGroup>

Expand Down
16 changes: 8 additions & 8 deletions WalletWasabi.Documentation/ClientRelease/ClientDeployment.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# Final tests

- Check the exact **date** of the last release and the **name** of the last PR.
- List the PR-s in order, open the [link and (adjust date!)](https://github.com/zkSNACKs/WalletWasabi/pulls?q=is%3Apr+merged%3A%3E%3D2019-07-07+sort%3Aupdated-asc).
- Go through all PR, create the Final Test issue. Create test cases according to PR-s and write a list - [Final Test format](https://github.com/zkSNACKs/WalletWasabi/issues/2227).
- Go through all issues and pick the [important ones (adjust date!)](https://github.com/zkSNACKs/WalletWasabi/issues?utf8=%E2%9C%93&q=is%3Aissue+closed%3A%3E%3D2019-07-07+sort%3Aupdated-asc+) and add to Final Tests if required.
- List the PR-s in order, open the [link and (adjust date!)](https://github.com/WalletWasabi/WalletWasabi/pulls?q=is%3Apr+merged%3A%3E%3D2019-07-07+sort%3Aupdated-asc).
- Go through all PR, create the Final Test issue. Create test cases according to PR-s and write a list - [Final Test format](https://github.com/WalletWasabi/WalletWasabi/issues/2227).
- Go through all issues and pick the [important ones (adjust date!)](https://github.com/WalletWasabi/WalletWasabi/issues?utf8=%E2%9C%93&q=is%3Aissue+closed%3A%3E%3D2019-07-07+sort%3Aupdated-asc+) and add to Final Tests if required.
- Check Tor status. Never release during a Tor network disruption: https://status.torproject.org/
- At the end there will be a Final Test document.
- Do testing contribution game if needed.
Expand Down Expand Up @@ -31,17 +31,17 @@ Make sure to run a virus detection scan on one of the Release candidate's .msi i
- Run tests.
- MAKE SURE YOU ARE ON THE RIGHT BRANCH AND UP TO DATE in GitHub Desktop on the release machine!
- Discard packages.lock changes if there are. Inserted USB drive name must contain the string USB!
- Run the [script file](https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Packager/scripts/Wasabi_release.ps1) on the **Windows Release Laptop** and follow the instructions.
- At some point you will need to run [this script](https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Packager/scripts/WasabiNoratize.scpt) file on Mac. Don't forget to open the script file on Mac and insert your Apple dev username and password. Guide how to setup it: [macOS release environment](https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Documentation/Guides/MacOsSigning.md).
- Run the [script file](https://github.com/WalletWasabi/WalletWasabi/blob/master/WalletWasabi.Packager/scripts/Wasabi_release.ps1) on the **Windows Release Laptop** and follow the instructions.
- At some point you will need to run [this script](https://github.com/WalletWasabi/WalletWasabi/blob/master/WalletWasabi.Packager/scripts/WasabiNoratize.scpt) file on Mac. Don't forget to open the script file on Mac and insert your Apple dev username and password. Guide how to setup it: [macOS release environment](https://github.com/WalletWasabi/WalletWasabi/blob/master/WalletWasabi.Documentation/Guides/MacOsSigning.md).
- Finish the script on Windows. Now a folder should pop up with all the files that need to be uploaded to GitHub.
- Test asc file for `.msi`.
- Final `.msi` test on own computer. Check the About dialog and optionally the BUILDINFO.json next to the wasabi executable, the commit ID should match with the one on GitHub.

# Final release

- Draft a [new release at the main repo](https://github.com/zkSNACKs/WalletWasabi/releases/new).
- Draft a [new release at the main repo](https://github.com/WalletWasabi/WalletWasabi/releases/new).
- Bump client version. (WalletWasabi/Helpers/Constants.cs) - maybe you already did this.
- Create the release notes by using [the template](https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Documentation/ClientRelease/ReleaseNotesTemplate.md). Make sure the the recent changes are in the What's new section.
- Create the release notes by using [the template](https://github.com/WalletWasabi/WalletWasabi/blob/master/WalletWasabi.Documentation/ClientRelease/ReleaseNotesTemplate.md). Make sure the the recent changes are in the What's new section.
- Run tests.
- Do Packaging (see above).
- Upload the files to the main repo!
Expand All @@ -52,7 +52,7 @@ Make sure to run a virus detection scan on one of the Release candidate's .msi i
# Notify

- Refresh website download and signature links.
- [Deploy testnet and mainnet backend](https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Documentation/HowToDeploy.md). Make sure the client version number is bumped here as well. If it is a hotfix you do not need to update the backend, but you need to update the website!
- [Deploy testnet and mainnet backend](https://github.com/WalletWasabi/WalletWasabi/blob/master/WalletWasabi.Documentation/HowToDeploy.md). Make sure the client version number is bumped here as well. If it is a hotfix you do not need to update the backend, but you need to update the website!

# Announce

Expand Down
14 changes: 7 additions & 7 deletions WalletWasabi.Documentation/ClientRelease/ReleaseNotesTemplate.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
### _[Wasabi Wallet](https://WasabiWallet.io) is an easy to use, privacy-focused, open-source, non-custodial, Bitcoin wallet_

# Download
:window: [Windows](https://github.com/zkSNACKs/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.msi)
:green_apple: [Apple M1/M2](https://github.com/zkSNACKs/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x-arm64.dmg)
:apple: [Apple Intel](https://github.com/zkSNACKs/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.dmg)
:penguin: [Ubuntu / Debian](https://github.com/zkSNACKs/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.deb)
:penguin: [Other Linux](https://github.com/zkSNACKs/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.tar.gz)
:window: [Windows](https://github.com/WalletWasabi/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.msi)
:green_apple: [Apple M1/M2](https://github.com/WalletWasabi/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x-arm64.dmg)
:apple: [Apple Intel](https://github.com/WalletWasabi/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.dmg)
:penguin: [Ubuntu / Debian](https://github.com/WalletWasabi/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.deb)
:penguin: [Other Linux](https://github.com/WalletWasabi/WalletWasabi/releases/download/v2.0.x/Wasabi-2.0.x.tar.gz)

---
## Release Highlights
Expand All @@ -23,12 +23,12 @@ For a detailed installation guide, including **signature verification**, see [th
:spider_web: [Website](https://wasabiwallet.io)
:onion: [Tor onion site](http://wasabiukrxmkdgve5kynjztuovbg43uxcbcxn6y2okcrsg7gb6jdmbad.onion/)
:orange_book: [Documentation](https://docs.wasabiwallet.io)
:grey_question: [FAQ](https://github.com/zkSNACKs/WalletWasabi/discussions/categories/faq)
:grey_question: [FAQ](https://github.com/WalletWasabi/WalletWasabi/discussions/categories/faq)

## Advanced Guide
If you want to build or update Wasabi from source code, check out [these easy instructions](https://docs.wasabiwallet.io/using-wasabi/BuildSource.html).

Wasabi uses [reproducible builds](https://reproducible-builds.org/), which you can verify with [this guide](https://github.com/zkSNACKs/WalletWasabi/blob/master/WalletWasabi.Documentation/Guides/DeterministicBuildGuide.md).
Wasabi uses [reproducible builds](https://reproducible-builds.org/), which you can verify with [this guide](https://github.com/WalletWasabi/WalletWasabi/blob/master/WalletWasabi.Documentation/Guides/DeterministicBuildGuide.md).

## Requirements
- Windows 10 1607+
Expand Down
Loading

0 comments on commit 41c3ded

Please sign in to comment.