muun-recovery/README.md

90 lines
3.5 KiB
Markdown
Raw Permalink Normal View History

2019-10-01 11:29:53 -04:00
![muun](https://muun.com/images/github-banner-v2.png)
2021-03-17 14:28:04 -04:00
Welcome!
2019-10-01 11:29:53 -04:00
2021-04-23 14:22:35 -04:00
You can use this Recovery Tool to transfer all funds out of your Muun account to an address
of your choosing.
2019-10-01 11:29:53 -04:00
2021-04-09 17:04:25 -04:00
![](readme/demo.gif)
2021-03-17 14:28:04 -04:00
**This process requires no collaboration from Muun to work**. We wholeheartedly believe that self-custodianship
is an essential right, and we want to create a world in which people have complete and exclusive
control over their own money. Bitcoin has finally made this possible.
2019-10-01 11:29:53 -04:00
2021-03-17 14:28:04 -04:00
## Usage
2020-02-07 09:04:49 -05:00
2021-04-23 14:22:35 -04:00
Download the appropriate binary from the following table (or see [`BUILD.md`](BUILD.md) to build it yourself),
and follow the instructions below.
2021-03-17 14:28:04 -04:00
2022-10-04 13:55:21 -04:00
| System | Link |
2022-10-04 15:20:57 -04:00
| --- | --- |
2022-10-04 13:55:21 -04:00
| Linux 32-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-linux32) |
| Linux 64-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-linux64) |
| Windows 32-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-windows32.exe) |
| Windows 64-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-windows64.exe) |
| MacOS 12 Intel 64-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-macos-12-amd64) |
| MacOS 12 ARM 64-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-macos-12-arm64) |
| MacOS 11 Intel 64-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-macos-11-amd64) |
| MacOS 11 ARM 64-bit | [Download](https://github.com/muun/recovery/releases/latest/download/recovery-tool-macos-11-arm64) |
2021-04-23 14:22:35 -04:00
### Windows
Open the downloaded file. You'll be warned that the executable is not from a Microsoft-verified
source. Click `More info`, and then `Run anyway`.
### MacOS
Download the file to a known location (say `Downloads` in your Home directory), then open a terminal
2022-10-04 13:55:21 -04:00
and run (changing the last part of the binary name to match yours):
2021-04-23 14:22:35 -04:00
```
cd ~/Downloads
2022-10-04 13:55:21 -04:00
chmod +x recovery-tool-macos-12-amd64
./recovery-tool-macos-12-amd64 <path to your Emergency Kit PDF>
2021-04-23 14:22:35 -04:00
```
#### Security Warnings
MacOS may prevent you from running the downloaded tool, depending on the active security settings. If it
does, head to System Preferences, then Security and Privacy, and give permission for the tool to run at the
bottom of the General tab.
2021-04-23 14:22:35 -04:00
### Linux
2021-03-17 14:28:04 -04:00
2021-04-23 14:22:35 -04:00
Download the file to a known location (say `Downloads` in your Home directory), then open a terminal
and run:
2019-10-01 11:29:53 -04:00
```
2021-04-23 14:22:35 -04:00
cd ~/Downloads
chmod +x recovery-tool-linux64
./recovery-tool-linux64 <path to your Emergency Kit PDF>
```
2021-03-17 14:28:04 -04:00
2021-04-23 14:22:35 -04:00
Use the `linux32` binary if appropriate.
2020-02-07 09:04:49 -05:00
2021-04-23 14:22:35 -04:00
### Questions?
2019-10-01 11:29:53 -04:00
2021-04-23 14:22:35 -04:00
If you have any questions, we'll be happy to answer them. Contact us at [support@muun.com](mailto:support@muun.com).
2019-10-01 11:29:53 -04:00
2021-04-23 14:22:35 -04:00
## Auditing and Veryfing
2021-04-23 14:22:35 -04:00
This tool is open-sourced so that auditors can inspect the code, build their own binaries and
verify them to their benefit and everyone else's. We encourage people with the technical knowledge
to do this.
2021-03-17 14:28:04 -04:00
2021-04-23 14:22:35 -04:00
To audit the source code, we suggest you start at `main.go` and navigate your way from there. We
always work to improve code quality and readability with each release, so that auditing is easier
and more effective.
2021-03-17 14:28:04 -04:00
2021-04-23 14:22:35 -04:00
To build and verify the reproducible binaries we provide, see [`BUILD.md`](BUILD.md).
2019-10-01 11:29:53 -04:00
## Responsible Disclosure
Send us an email to report any security related bugs or vulnerabilities at [security@muun.com](mailto:security@muun.com).
You can encrypt your email message using our public PGP key.
Public key fingerprint: `1299 28C1 E79F E011 6DA4 C80F 8DB7 FD0F 61E6 ED76`