Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Zero-1729/volt
Volt Wallet
https://github.com/Zero-1729/volt
Last synced: 3 months ago
JSON representation
Volt Wallet
- Host: GitHub
- URL: https://github.com/Zero-1729/volt
- Owner: Zero-1729
- License: mit
- Created: 2021-09-24T02:04:27.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-09T16:38:31.000Z (5 months ago)
- Last Synced: 2024-09-09T20:28:42.838Z (5 months ago)
- Language: TypeScript
- Homepage:
- Size: 14.5 MB
- Stars: 57
- Watchers: 3
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-bdk - Volt Wallet - based, financial freedom bitcoin wallet. (Applications)
README
# Volt
[](https://github.com/prettier/prettier)
A modern descriptor-based Financial Freedom Bitcoin Wallet aimed at restoring sovereignty to Global Bitcoiners.
> What are descriptors? [Read more](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md).
# Features
- Descriptor-based HD wallet (`wpkh(KEY)`, `pkh(KEY)`, `sh(wpkh(KEY))`, `tr(KEY)`)
- Watch Only support
- Partially Signed Bitcoin Transactions (PSBTs) and Fee Bumping (RBF)
- Lightning Network support (BOLT11 & LNURL)
- Internal Wallet Lightning Swaps (Onchain ↔️ Lightning)
- Multi-lingual (English & Arabic)
## Official Socials
[
](https://x.com/voltbtc)
[
](https://primal.net/p/npub1n3dc6uzctzdpvcsywpphhkhzwnmljhu45lnpkrr30s300fr2yeyq8ed2q6)
## Download Beta
**:warning: Warning:** Volt is still in Beta, do not use it for large amounts of Bitcoin.
### Android
- [Download APK](https://github.com/Zero-1729/volt/releases/tag/v0.4.4-beta.1)
### IOS
- IOS Beta Test flight coming soon.
## Supported BIPs
- [BIP21](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) URI Scheme
- [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) Hierarchical Deterministic Wallets
- [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) Mnemonic code for generating deterministic keys
- [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) Multi-Account Hierarchy for Deterministic Wallets
- [BIP49](https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki) Derivation scheme for P2WPKH-nested-in-P2SH based accounts
- [BIP70](https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki) Payment Protocol
- [BIP84](https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki) Derivation scheme for P2WPKH based accounts
- [BIP86](https://github.com/bitcoin/bips/blob/master/bip-0086.mediawiki) Derivation scheme for PTR based accounts
- [BIP173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) Base32 address format for native v0-16 witness outputs
- [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) Partially Signed Bitcoin Transactions
## Supported Bitcoin Tech
- [Bitcoin Development Kit (BDK)](https://github.com/bitcoindevkit)
- [Breez SDK](https://github.com/breez/breez-sdk)
### Lightning Implementation Overview
# Translation
For details on contributing to the app translation, please see the [translation guide](./CONTRIBUTING.md#translation)
# Build
> Note: Please ensure the version of Node and NPM you are using are >= the minimum LTS Node and NPM versions specified in the package.json file. The recommended Node and NPM versions are LTS versions (i.e. even-numbered releases). Run `node --version && npm --version` to get the versions of Node and NPM on your system if unsure.
Clone the repo locally and install the required npm dependencies:
```sh
$ git clone https://github.com/Zero-1729/volt
cd volt
yarn install
```
To run the wallet locally on, and build for, Android or IOS you'll need [Android Studio](https://developer.android.com/studio/) and [Xcode](https://developer.apple.com/xcode/resources/) installed, respectively.
## Breez SDK And Greenlight Credentials
> Note: If any part of the original `.crt` or `.pem` files are cut out, you will get the Breez SDK error `Generic: transport error`. See documentation [here](https://sdk-doc.breez.technology/guide/production.html#applying-certificates) for more info.
### Setup Environment file
Create a copy of the `env.example`
```sh
cp env.example .env
```
This command creates a `.env` file in the project root `volt/`. Then fill it with the appropriate info.
### Read and Convert the `.crt` and `.pem` Files
You can read and convert the contents of your `client-key.pem` and `client.crt` files as binary/byte data, in their entirety without taking out any parts (e.g. `BEGIN CERTIFICATE / END CERTIFICATE / BEGIN PRIVATE KEY / END PRIVATE KEY`) to hex strings and add them to the `.env` file as `GL_CUSTOM_NOBODY_KEY` and `GL_CUSTOM_NOBODY_CERT`, respectively.
To run the app locally, you'll need to add the Breez SDK Greenlight credentials to the `.env` file:
```sh
# Contents of the '.env' file
# ...
GL_CUSTOM_NOBODY_KEY=YOUR_HEX_STRING
GL_CUSTOM_NOBODY_CERT=YOUR_HEX
```
## Development
To run the wallet locally on your system, run the following in the project root (`volt/`):
> This will start the Metro Bundler, which is the tool responsible for bundling the app's JavaScript code and assets into a single file that can be run on the device.
```sh
$ yarn run start
```
### Note on Tailwind
Due to the way Tailwind works, you'll need to run the following command to build the Tailwind CSS file:
> This builds the Tailwind styles in watch mode. You'll need to run this command in a separate terminal window to keep the Tailwind styles updated before running the app.
```sh
$ yarn run dev:tailwind
```
### Running on Android (Virtual) Device
- Download and run the latest (stable) version of Android Studio.
- Launch Android Studio, and Open the project's android folder (`volt/android`).
- Open the `build.gradle` file in the current folder (`volt/android`), it'll take some time for Android Studio to set up.
- Navigate to `AVD Manager` under the `Tools` sections of the menu, and click "*Create Virtual Device...*" to create a virtual device.
- Launch the newly created virtual device by clicking the `Play` in the `Actions` section of the menu.
After setting up the virtual device, run the following in the project root (`volt/`) to launch the emulator:
> The command builds the app and installs it on the virtual device or a connected Android device (if detected). Once launched, the app would take time loading the dependencies.
```sh
$ yarn run android
```
### Running on IOS
To run the app using XCode's IOS emulator, you'll need to install the CocoaPod dependencies:
```sh
$ cd ios
$ yarn pod install
```
After installing the dependencies, to launch the app on the IOS emulator you'll need to navigate to the project root (`volt`) and run:
> Note: If you have issues running the command above, you can also open Xcode and open the `ios/volt.xcworkspace` file and build/run the app from there.
```sh
yarn run ios
```
# Responsible Disclosure
Email `[email protected]` with the title "`volt: bug/vulnerability report`" to disclose any critical bugs or vulnerabilities.
---
MIT © Zero-1729