Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/acinq/phoenix

Phoenix is a self-custodial Bitcoin wallet using Lightning to send/receive payments.
https://github.com/acinq/phoenix

bitcoin kotlin lightning lightning-network

Last synced: 4 days ago
JSON representation

Phoenix is a self-custodial Bitcoin wallet using Lightning to send/receive payments.

Host: GitHub
URL: https://github.com/acinq/phoenix
Owner: ACINQ
License: apache-2.0
Created: 2019-06-20T17:52:39.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-10-28T15:23:48.000Z (3 months ago)
Last Synced: 2024-10-31T18:52:03.304Z (3 months ago)
Topics: bitcoin, kotlin, lightning, lightning-network
Language: C
Homepage: https://phoenix.acinq.co
Size: 34.7 MB
Stars: 669
Watchers: 24
Forks: 96
Open Issues: 101
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)

[![Testnet Build](https://github.com/ACINQ/phoenix/workflows/TESTNET%20Build/badge.svg)](https://github.com/ACINQ/phoenix/actions?query=workflow%3A%22TESTNET+Build%22)

[![Download Testnet APK](https://img.shields.io/badge/Download-Testnet%20APK-green?style=flat&logo=android&logoColor=white)](https://acinq.co/pub/phoenix/phoenix-testnet-latest.apk)

![Phoenix Logo](.readme/phoenix_text.png)

Phoenix is a Bitcoin wallet developed by [ACINQ](https://acinq.co), that allows you to send and receive bitcoins securely over the Lightning Network. It is self-custodial, which means that **you hold the keys** of the wallet. It provides a simple and clean UX. Thanks to native Lightning support, payments are faster and cheaper.

---

:rotating_light: This wallet is self-custodial. It means that, when creating a new wallet, a 12-words recovery phrase is generated. Only you have it. It is your responsibility to make a backup of that recovery phrase. It gives full access to your funds, so do not share it with anyone. If you lose the recovery phrase, your funds are lost.

---

Head to our website for more information:

- [FAQ](https://phoenix.acinq.co/faq)

- [Terms](https://phoenix.acinq.co/terms)

- [Privacy](https://phoenix.acinq.co/privacy)

## Download

Phoenix is available for Android and iOS:

- for iOS: [on the App Store](https://apps.apple.com/us/app/phoenix-wallet/id1544097028) - requires iOS 15+.

- for Android: [on Google Play](https://play.google.com/store/apps/details?id=fr.acinq.phoenix.mainnet), or [get the APK from the releases](https://github.com/ACINQ/phoenix/releases) - requires Android 8+.

## Build and test Phoenix

Phoenix is separated in 3 modules:

- `phoenix-shared`: business logic written in Kotlin, shared between the iOS and the Android applications. Uses [lightning-kmp](https://github.com/ACINQ/lightning-kmp) for everything Lightning/Bitcoin related.

- `phoenix-android`: the UI for the new Android application, written in Kotlin and Jetpack Compose.

- `phoenix-ios`: the UI for the iOS application, written in Swift.

Instructions to build the iOS and the Android apps are provided [here](https://github.com/ACINQ/phoenix/blob/master/BUILD.md).

Deprecated module:

- `phoenix-legacy`: contains the old, legacy Android application (version 1.x), using [eclair-core](https://github.com/ACINQ/eclair) for Lightning, which has been replaced by `phoenix-android`. However, this legacy app is still embedded in the new production application for migration purposes so the code remains. It will be removed eventually.

## Contribute

We use GitHub for bug tracking. Search [the existing issues](https://github.com/ACINQ/phoenix/issues) for your bug and create a new one if needed.

You can also contribute to the project by submitting pull requests to improve the codebase or bring new features. Pull requests will be reviewed by members of the ACINQ team.

To contribute to Lightning in general, take a look at the [Eclair repository](https://github.com/ACINQ/eclair) for routing nodes, or the [lightning-kmp repository](https://github.com/ACINQ/lightning-kmp) for mobile nodes.

## Translate the app

If you want to contribute to the translation effort, consult the guidelines provided in [TRANSLATION.md](https://github.com/ACINQ/phoenix/blob/master/TRANSLATION.md)

## Support

For troubleshooting and questions, visit [our support page](https://phoenix.acinq.co/support).

## License

Phoenix is released under the terms of the Apache 2.0 license. See LICENSE for more information.