{"id":13596966,"url":"https://github.com/Zero-1729/volt","last_synced_at":"2025-04-10T00:31:31.309Z","repository":{"id":242863388,"uuid":"409801580","full_name":"Zero-1729/volt","owner":"Zero-1729","description":"Volt Wallet","archived":false,"fork":false,"pushed_at":"2025-02-26T15:46:07.000Z","size":14317,"stargazers_count":60,"open_issues_count":1,"forks_count":8,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-02T22:09:27.339Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Zero-1729.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-24T02:04:27.000Z","updated_at":"2025-03-21T12:46:06.000Z","dependencies_parsed_at":"2024-06-11T07:26:21.142Z","dependency_job_id":"dce1c7b7-5fdc-423f-a004-b6d3cad1cbb9","html_url":"https://github.com/Zero-1729/volt","commit_stats":{"total_commits":3058,"total_committers":4,"mean_commits":764.5,"dds":"0.0032701111837802888","last_synced_commit":"65fe1ce1440b550381ef83c7d9453741d3a07dfc"},"previous_names":["zero-1729/volt"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zero-1729%2Fvolt","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zero-1729%2Fvolt/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zero-1729%2Fvolt/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Zero-1729%2Fvolt/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Zero-1729","download_url":"https://codeload.github.com/Zero-1729/volt/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248135208,"owners_count":21053639,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T17:00:16.032Z","updated_at":"2025-04-10T00:31:29.966Z","avatar_url":"https://github.com/Zero-1729.png","language":"TypeScript","funding_links":[],"categories":["Applications"],"sub_categories":[],"readme":"# Volt\n\n[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)\n![](https://camo.githubusercontent.com/bb4c8c469821e7b1e3f2998bf0c183f700a6597106e2c28c0e62f44b2f53e710/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d3233323332332e7376673f7374796c653d666c61742d737175617265)\n\nA modern descriptor-based Financial Freedom Bitcoin Wallet aimed at restoring sovereignty to Global Bitcoiners.\n\n\u003e What are descriptors? [Read more](https://github.com/bitcoin/bitcoin/blob/master/doc/descriptors.md).\n\n\u003cimg src=\"./assets/app_showcase.png\" width=720\u003e\n\n# Features\n\n- Descriptor-based HD wallet (`wpkh(KEY)`, `pkh(KEY)`, `sh(wpkh(KEY))`, `tr(KEY)`)\n- Watch Only support\n- Partially Signed Bitcoin Transactions (PSBTs) and Fee Bumping (RBF)\n- Lightning Network support (BOLT11 \u0026 LNURL)\n- Internal Wallet Lightning Swaps (Onchain ↔️ Lightning)\n- Multi-lingual (English \u0026 Arabic)\n\n## Official Socials\n\n[\u003cimg src='./assets/x-voltbtc.png' width=512\u003e](https://x.com/voltbtc)\n[\u003cimg src='./assets/nostr-voltbtc.png' width=512\u003e](https://primal.net/p/npub1n3dc6uzctzdpvcsywpphhkhzwnmljhu45lnpkrr30s300fr2yeyq8ed2q6)\n\n## Download Beta\n\n**:warning: Warning:** Volt is still in Beta, do not use it for large amounts of Bitcoin.\n\n### Android\n\n- [Download APK](https://github.com/Zero-1729/volt/releases/tag/v0.4.4-beta.1)\n\n### IOS\n\n- IOS Beta Test flight coming soon.\n\n## Supported BIPs\n\n- [BIP21](https://github.com/bitcoin/bips/blob/master/bip-0021.mediawiki) URI Scheme\n- [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) Hierarchical Deterministic Wallets\n- [BIP39](https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki) Mnemonic code for generating deterministic keys\n- [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) Multi-Account Hierarchy for Deterministic Wallets\n- [BIP49](https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki) Derivation scheme for P2WPKH-nested-in-P2SH based accounts\n- [BIP70](https://github.com/bitcoin/bips/blob/master/bip-0070.mediawiki) Payment Protocol\n- [BIP84](https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki) Derivation scheme for P2WPKH based accounts\n- [BIP86](https://github.com/bitcoin/bips/blob/master/bip-0086.mediawiki) Derivation scheme for PTR based accounts\n- [BIP173](https://github.com/bitcoin/bips/blob/master/bip-0173.mediawiki) Base32 address format for native v0-16 witness outputs\n- [BIP174](https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki) Partially Signed Bitcoin Transactions\n\n## Supported Bitcoin Tech\n\n- [Bitcoin Development Kit (BDK)](https://github.com/bitcoindevkit)\n- [Breez SDK](https://github.com/breez/breez-sdk)\n\n### Lightning Implementation Overview\n\n\u003cimg src='./assets/breezsdk_greenlight.png' width=720\u003e\n\n# Translation\n\nFor details on contributing to the app translation, please see the [translation guide](./CONTRIBUTING.md#translation)\n\n# Build\n\n\u003e Note: Please ensure the version of Node and NPM you are using are \u003e= 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 \u0026\u0026 npm --version` to get the versions of Node and NPM on your system if unsure.\n\nClone the repo locally and install the required npm dependencies:\n\n```sh\n$ git clone https://github.com/Zero-1729/volt\ncd volt\nyarn install\n```\n\nTo 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. \n\n## Breez SDK And Greenlight Credentials\n\n\u003e 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.\n\n### Setup Environment file\n\nCreate a copy of the `env.example`\n\n```sh\ncp env.example .env\n```\n\nThis command creates a `.env` file in the project root `volt/`. Then fill it with the appropriate info.\n\n### Read and Convert the `.crt` and `.pem` Files\n\nYou 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.\n\nTo run the app locally, you'll need to add the Breez SDK Greenlight credentials to the `.env` file:\n\n```sh\n# Contents of the '.env' file\n# ...\nGL_CUSTOM_NOBODY_KEY=YOUR_HEX_STRING\nGL_CUSTOM_NOBODY_CERT=YOUR_HEX\n```\n\n\n## Development\n\nTo run the wallet locally on your system, run the following in the project root (`volt/`):\n\n\u003e 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.\n\n```sh\n$ yarn run start\n```\n\n### Note on Tailwind\n\nDue to the way Tailwind works, you'll need to run the following command to build the Tailwind CSS file:\n\n\u003e 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.\n\n```sh\n$ yarn run dev:tailwind\n```\n\n\n### Running on Android (Virtual) Device\n\n- Download and run the latest (stable) version of Android Studio.\n- Launch Android Studio, and Open the project's android folder (`volt/android`).\n- Open the `build.gradle` file in the current folder (`volt/android`), it'll take some time for Android Studio to set up.\n- Navigate to `AVD Manager` under the `Tools` sections of the menu, and click \"*Create Virtual Device...*\" to create a virtual device.\n- Launch the newly created virtual device by clicking the `Play` in the `Actions` section of the menu.\n\nAfter setting up the virtual device, run the following in the project root (`volt/`) to launch the emulator:\n\n\u003e 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. \n\n```sh\n$ yarn run android\n```\n\n### Running on IOS\n\nTo run the app using XCode's IOS emulator, you'll need to install the CocoaPod dependencies:\n\n```sh\n$ cd ios\n$ yarn pod install\n```\n\nAfter installing the dependencies, to launch the app on the IOS emulator you'll need to navigate to the project root (`volt`) and run:\n\n\u003e 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.\n\n```sh\nyarn run ios\n```\n\n# Responsible Disclosure\n\nEmail `Zero-1729@protonmail.com` with the title \"`volt: bug/vulnerability report`\" to disclose any critical bugs or vulnerabilities.\n\n---\n\nMIT \u0026copy; Zero-1729\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZero-1729%2Fvolt","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FZero-1729%2Fvolt","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FZero-1729%2Fvolt/lists"}