{"id":13820108,"url":"https://github.com/breez/breezmobile","last_synced_at":"2025-10-04T01:11:10.134Z","repository":{"id":37431344,"uuid":"152418816","full_name":"breez/breezmobile","owner":"breez","description":"Lightning Network mobile client","archived":false,"fork":false,"pushed_at":"2025-04-28T09:55:05.000Z","size":30792,"stargazers_count":588,"open_issues_count":89,"forks_count":134,"subscribers_count":26,"default_branch":"master","last_synced_at":"2025-04-28T10:51:09.963Z","etag":null,"topics":["android","bitcoin","breez","lightning-network","lnd","neutrino","payments","pos"],"latest_commit_sha":null,"homepage":"https://breez.technology","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/breez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-10-10T12:19:28.000Z","updated_at":"2025-04-28T09:53:50.000Z","dependencies_parsed_at":"2024-04-23T12:59:50.350Z","dependency_job_id":null,"html_url":"https://github.com/breez/breezmobile","commit_stats":null,"previous_names":[],"tags_count":51,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breez%2Fbreezmobile","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breez%2Fbreezmobile/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breez%2Fbreezmobile/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/breez%2Fbreezmobile/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/breez","download_url":"https://codeload.github.com/breez/breezmobile/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254488494,"owners_count":22079440,"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":["android","bitcoin","breez","lightning-network","lnd","neutrino","payments","pos"],"created_at":"2024-08-04T08:00:58.494Z","updated_at":"2025-10-04T01:11:10.117Z","avatar_url":"https://github.com/breez.png","language":"Dart","funding_links":[],"categories":["Flutter","Dart"],"sub_categories":["Flutter Wallet"],"readme":"# Breez Mobile Client\n\n\u003cp align='center'\u003e\n  \u003cimg src='https://breez.technology/balance-illustration.webp' height='300' alt='screenshot' /\u003e\n  \u003cimg src='https://breez.technology/pos-illustration.webp' height='300' alt='screenshot' /\u003e\n  \u003cimg src='https://breez.technology/podcast-illustration.webp' height='300' alt='screenshot' /\u003e\n\u003c/p\u003e\n\n[Breez](https://breez.technology) is a Lightning Network [mobile client](https://github.com/breez/breezmobile) and a [hub](https://github.com/breez/server). It provides a platform for simple, instantaneous bitcoin payments. \u003cbr\u003e\nBreez is currently in a public beta, available on [Android](https://play.google.com/apps/testing/com.breez.client) and on [iOS](https://testflight.apple.com/join/wPju2Du7). \u003cbr\u003e\nTo learn more about it, please read [Introducing Breez](https://doc.breez.technology). \u003cbr\u003e\n\n## Features\n\n- [x] lnd on Android\n- [x] Neutrino on Android\n- [x] Seamless hub channel creation\n- [x] Adding funds using on-chain tx\n- [x] BTC \u0026 Satoshi units\n- [x] Random avatars\n- [x] Connect to Pay: simple interface to execute payments between users\n- [x] A full lncli interface to query and execute ln commands\n- [x] Filter tx by type\n- [x] Filter tx by date\n- [x] Pay invoice (link or QR) from other ln wallets\n- [x] Create invoice (link or QR) to be paid by other ln wallets\n- [x] Removing funds to an on-chain address\n- [x] SubmarineSwaps for adding on-chain funds including refund functionality\n- [x] End-to-end encryption of Connect-to-Pay session\n- [x] Make Connect-to-Pay links work for users that didn't yet install Breez\n- [x] Ability to Backup/Restore the ln node  \n- [x] Mainnet support\n- [x] Support zero-sat invoices\n- [x] Startup optimizations\n- [x] Background sync via FCM\n- [x] Marketplace w/ Bitrefill\n- [x] Adding funds via vouchers\n- [x] Backup improvements\n- [x] Add background ChannelsWatcher job\n- [x] Expose Bitcoin Node (BIP157) configuration\n- [x] iOS support\n- [x] Add webLN support\n- [x] Fiat units\n- [x] Optional PIN\n- [x] Adding funds via credit card\n- [x] Add stronger encryption to cloud backup\n- [x] iCloud backup option\n- [x] Dark mode\n- [x] Export payments to .csv\n- [x] Support 3rd-party LSPs\n- [x] Biometric login\n- [x] Fast onboarding\n- [x] Pay w/o full sync\n- [x] Implement lnurl-withdraw\n- [x] Send on-chain via reverse Submarine Swaps\n- [x] Improve hodl invoice support\n- [x] POS POC release\n- [x] Spontaneous payments to node id (nodes running with --accept-keysend)\n- [x] Fast graph sync\n- [x] Scan QR code from an image\n- [x] Import/export POS items\n- [x] Support zero-conf channels\n- [x] 'On-the-fly' channel creation (increase limit)\n- [x] Remove reserve working using Breez channels\n- [x] Support additional fiat currencies\n- [x] Support LNURL-Auth \u0026 LNURL-Fallback\n- [x] Print POS transactions\n- [x] Hide balance\n- [x] Read NFC tags on Android\n- [x] In-app podcast player (podcasting 2.0)\n- [x] Backup to WebDav servers (e.g. Nextcloud)\n- [x] Support LNURL-Pay ([bounty redeemed](https://github.com/breez/breezmobile/wiki/Bounties#lnurl-pay-support))\n- [x] Send to a Lightning address\n- [x] Boostagrams\n- [x] WebDav backups\n- [x] Sales reports\n- [x] Top podcasts\n- [x] NFC checkout\n- [x] Tor support (Android)\n- [x] Neutrino sync optimizations\n- [x] Co-operative Close Channels\n- [ ] Async payments\n\n## System Requirements\n\n- Android 7+ 64bit\n- iPhone 6+\n\n## Setting up the environment\n\n### Prerequisites\n\nMake sure you have Flutter 3 installed on your system before continuing the setup process.\n\n### Setting up for Android\n\n1. Build `breez.aar` as described in \u003chttps://github.com/breez/breez\u003e\n2. Create a symlink from the `breez.aar` to `android/app/libs` directory.\n3. Create an Android app on [Firebase](https://console.firebase.google.com/) and download `google-services.json` file.\n\n- **Package name (for debugging):** com.breez.client.debug\n\n4. Copy the downloaded `google-services.json` file to `android/app/src/client` folder.\n\n### Setting up for iOS\n\n1. Build and `bindings.xcframework` as described in \u003chttps://github.com/breez/breez\u003e\n2. Copy the `bindings.xcframework` directory to the ios directory.\n3. Create an iOS app on [Firebase](https://console.firebase.google.com/) and download `GoogleServices-info.plist` file.\n4. Copy the downloaded `GoogleServices-info.plist` file to `ios/Runner` folder.\n5. Run `pod install` from `breezmobile/ios`\n\n## Building and Running\n\n```sh\n# Install dependencies for building\nflutter pub get\n\n# Run a client app on the connected device\nflutter run --flavor=client\n\n# Build a client app as APK file\nflutter build apk --target-platform=android-arm64 --flavor=client --debug\n```\n\n## [Overview for Developers](https://doc.breez.technology/Overview-for-Developers.html)\n\n## [Running Breez in simnet](https://doc.breez.technology/Running-Breez-in-simnet.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreez%2Fbreezmobile","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbreez%2Fbreezmobile","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbreez%2Fbreezmobile/lists"}