mirror of
https://github.com/sparrowwallet/sparrow.git
synced 2024-11-05 05:46:44 +00:00
107 lines
4.1 KiB
Markdown
107 lines
4.1 KiB
Markdown
# Sparrow Bitcoin Wallet
|
|
|
|
Sparrow is a modern desktop Bitcoin wallet application supporting most hardware wallets and built on common standards such as PSBT, with an emphasis on transparency and usability.
|
|
|
|
More information (and release binaries) can be found at https://sparrowwallet.com. Release binaries are also available directly from [GitHub](https://github.com/sparrowwallet/sparrow/releases).
|
|
|
|
|
|
|
|
## Building
|
|
|
|
To clone this project, use
|
|
|
|
`git clone --recursive git@github.com:sparrowwallet/sparrow.git`
|
|
|
|
or for those without SSH credentials:
|
|
|
|
`git clone --recursive https://github.com/sparrowwallet/sparrow.git`
|
|
|
|
In order to build, Sparrow requires Java 17 or higher to be installed.
|
|
The release binaries are built with [Eclipse Temurin 18.0.1+10](https://github.com/adoptium/temurin18-binaries/releases/tag/jdk-18.0.1%2B10).
|
|
|
|
Other packages may also be necessary to build depending on the platform. On Debian/Ubuntu systems:
|
|
|
|
`sudo apt install -y rpm fakeroot binutils`
|
|
|
|
|
|
The Sparrow binaries can be built from source using
|
|
|
|
`./gradlew jpackage`
|
|
|
|
Note that to build the Windows installer, you will need to install [WiX](https://github.com/wixtoolset/wix3/releases).
|
|
|
|
When updating to the latest HEAD
|
|
|
|
`git pull --recurse-submodules`
|
|
|
|
The release binaries are reproducible from v1.5.0 onwards (pre codesigning and installer packaging). More detailed [instructions on reproducing the binaries](docs/reproducible.md) are provided.
|
|
|
|
> Video documentation of your build process uploaded to [bitcoinbinary.org](https://bitcoinbinary.org/) is appreciated. Alternatively check the site if you wish to see if someone else already verified the provided binaries.
|
|
|
|
## Running
|
|
|
|
If you prefer to run Sparrow directly from source, it can be launched from within the project directory with
|
|
|
|
`./sparrow`
|
|
|
|
Java 17 or higher must be installed.
|
|
|
|
## Configuration
|
|
|
|
Sparrow has a number of command line options, for example to change its home folder or use testnet:
|
|
|
|
```
|
|
./sparrow -h
|
|
|
|
Usage: sparrow [options]
|
|
Options:
|
|
--dir, -d
|
|
Path to Sparrow home folder
|
|
--help, -h
|
|
Show usage
|
|
--level, -l
|
|
Set log level
|
|
Possible Values: [ERROR, WARN, INFO, DEBUG, TRACE]
|
|
--network, -n
|
|
Network to use
|
|
Possible Values: [mainnet, testnet, regtest, signet]
|
|
```
|
|
|
|
As a fallback, the network (mainnet, testnet, regtest or signet) can also be set using an environment variable `SPARROW_NETWORK`. For example:
|
|
|
|
`export SPARROW_NETWORK=testnet`
|
|
|
|
A final fallback which can be useful when running the Sparrow binary is to create a file called ``network-testnet`` in the Sparrow home folder (see below) to configure the testnet network.
|
|
|
|
Note that if you are connecting to an Electrum server when using testnet, that server will need to be running on testnet configuration as well.
|
|
|
|
When not explicitly configured using the command line argument above, Sparrow stores its mainnet config file, log file and wallets in a home folder location appropriate to the operating system:
|
|
|
|
| Platform | Location |
|
|
|----------| -------- |
|
|
| OSX | ~/.sparrow |
|
|
| Linux | ~/.sparrow |
|
|
| Windows | %APPDATA%/Sparrow |
|
|
|
|
Testnet, regtest and signet configurations (along with their wallets) are stored in subfolders to allow easy switching between networks.
|
|
|
|
## Reporting Issues
|
|
|
|
Please use the [Issues](https://github.com/sparrowwallet/sparrow/issues) tab above to report an issue. If possible, look in the sparrow.log file in the configuration directory for information helpful in debugging.
|
|
|
|
## License
|
|
|
|
Sparrow is licensed under the Apache 2 software licence.
|
|
|
|
## GPG Key
|
|
|
|
The Sparrow release binaries here and on [sparrowwallet.com](https://sparrowwallet.com/download/) are signed using [craigraw's GPG key](https://keybase.io/craigraw):
|
|
Fingerprint: D4D0D3202FC06849A257B38DE94618334C674B40
|
|
64-bit: E946 1833 4C67 4B40
|
|
|
|
## Credit
|
|
|
|
|
|
|
|
Sparrow Wallet uses the [Yourkit Java Profiler](https://www.yourkit.com/java/profiler/) to profile and improve performance.
|
|
YourKit supports open source projects with useful tools for monitoring and profiling Java and .NET applications.
|