Wasabi Documentation

Wasabi Wallet is an open-source, non-custodial, privacy focused Bitcoin wallet for desktop. It implements trustless coin shuffling: Schnorrian CoinJoin.

This is Wasabi Wallets open source documentation repository. Here you will find information about the nuances of privacy in Bitcoin, how Wasabi solves these difficult problems, and how you can use these tools to defend yourself.

If you would like to support the project by educating your peers, this documentation repository is the right place for your efforts! Do you have a question that is not yet covered, please open an issue. If you have a good answer to a question, please open a pull request. For more details on how to contribute, see the contribution checklist or the to-do-list.

The pillars of the documentation

Why Wasabi

Why is privacy important.

For those who are relatively new to Bitcoin and privacy, here we explain what problem exists and why this is important to fix it. This is the introduction to the over-arching reason why we are so enthusiastic about Bitcoin in general and Wasabi specifically.

Using Wasabi

How to use Wasabi Wallet.

For those who seek to understand the nuances of Wasabi and how they can use this tool to reclaim and protect their privacy. Here we have a step by step guide to all the aspects, starting at beginner level, all the way up to power user features and advanced privacy practices.

Building Wasabi

How to contribute to Wasabi.

For those many Wasabikas who are already, or would like to start to suppoert this lovely open source project. Here we want to make sure that new contributors find all the knowledge to give them a swift start on their path to black-belt of the Dojo.

Wasabi FAQ

Frequently asked questions.

In addition to this main documentation, here we have the most commonly asked questions and answers. Specific questions are answered with linked reference to the main documentation. This is for all the users who need a precise answer to a common question.

If you are looking for the developers repository, it can be found here [WalletWasabi](https://github.com/zkSNACKs/WalletWasabi).

---

Contribute to the Documentation

Just like the Wasabi wallet software, this documentation is libre and open source under the MIT license. Not only do we appreciate the contributoin of peers, but we desperately need it! If you have a question, open an issue and if you know the answer, then make a pull request.

If you'd like to contribute to the content of the site, you can make PRs pertaining to the markdown files in the /docs/ directory, and if accepted, the merged changes will automatically be integrated into the documentation website by VuePress. Know that you do not need to understand/deal with VuePress at all in this case.

To ensure a swift start to your productive contribution, please see the contribution checklist, and the below best practices.

Writing Conventions

• Wasabi [capitalized]
• CoinJoin [capitalized, one word]
• Every sentense must start a new line.
• For a paragraph, add an empty line or </br> in the markdown.

Reference files

Please consider this repsoitory structure for hyperlinks, and use relative links whenever possible, for example

[What is a CoinJoin?](FAQ-Introduction.md#what-is-a-coinjoin)

Embedding images

The images are stored in the /docs/.vuepress/public/ directory. They can be embedded via the following markdown tags:

![](/IMAGENAME.png)

Embedding videos

Youtube videos and playlists can be embedded via the following custom markdown tags:

@[youtube](VIDEO_ID)
@[youtubePlaylist](PLAYLIST_ID)

Optionally you can also specify the start position of a video in seconds: (starts at 100 seconds in)

@[youtube](VIDEO_ID,100)

And the index of the video of a playlist: (starts with the third video)

@[youtubePlaylist](PLAYLIST_ID,3)

---

Build the Documentation Locally

If you have front end skills and would like to help improve the theme/look of the website, we welcome your input! Check out the VuePress documentation for details on how it works.

The Wasabi documentation website is built using an open source static site generator called VuePress. It is extrememly customizable in the configuration and theme and offers great defaults out-of-the-box. Check out the VuePress documentation for details on how to use it powerfully.

In order to build the website locally, you'll need Node.js.

Serve locally

1. Install dependencies
2. Serve locally (by default on port 8080)

npm install
npm start