phoenix - GitLite

KO | EN

gitlite — search

#react #llm #golang #machine-learning #deep-learning #linux #macos #nodejs #java #windows #vue #security #mcp #ios

phoenix

(★ 859)

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

File Explorer

Download Latest Version (.zip)

- - testnet-build.yml
- config.json
- timestamps.android.json
- timestamps.ios.json
- phoenix_text.png
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- libs.versions.toml
- build.gradle.kts
- google-services.json
- proguard-rules.pro
- TRANSLATION.md
- - AppDelegate.swift
  - Currencies.xcstrings
  - GoogleService-Info.plist
  - Info.plist
  - InfoPlist.xcstrings
  - Localizable.xcstrings
  - Phoenix.entitlements
  - PrivacyInfo.xcprivacy
  - SceneDelegate.swift
- - Info.plist
- - project.pbxproj
- - aes256Tests.swift
  - currencyFormattingTests.swift
  - Info.plist
- - Info.plist
  - phoenix-iosUITests.swift
- - Info.plist
  - NotificationService.swift
  - NotificationServiceQueue.swift
  - phoenix-notifySrvExt.entitlements
  - PhoenixManager.swift
  - readme.md
- iOS Multi-Process Architecture.md
- TRANSLATION.md
- build.gradle.kts
.gitattributes
.gitignore
build.gradle.kts
BUILD.md
Dockerfile
gradle.properties
gradlew
gradlew.bat
LICENSE
local.properties.template
README.md
settings.gradle.kts
TRANSLATION.md

# Installation Guide

1. Get the code

git clone https://github.com/ACINQ/phoenix

Downloads the entire project code from GitHub to your computer.

cd phoenix

Moves into the project folder you just downloaded.

2. Docker

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Docker Desktop Needed to build and run containers. Install it and keep it running in the background.

docker build -t phoenix .

Builds a runnable image based on the Dockerfile.

docker run -p 8080:80 phoenix

Runs the built image as an actual container.

✅ Run docker compose ps to check the containers are Up. If the README mentions a port, open http://localhost:PORT in your browser.

3. Gradle (Java/Kotlin)

Medium

Prerequisites

Git Needed to download the project code from GitHub.
JDK (Java) Required to build and run Java/Kotlin projects.
Gradle If the repo includes gradlew (Gradle Wrapper), you don't need to install Gradle separately.

./gradlew build

Builds the project using Gradle.

✅ A BUILD SUCCESSFUL message means it worked. The output is created under build/.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://raw.githubusercontent.com/ACINQ/phoenix/master/LICENSE)
[![Testnet Build](https://github.com/ACINQ/phoenix/actions/workflows/testnet-build.yml/badge.svg)](https://github.com/ACINQ/phoenix/actions?query=testnet-build)
[![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](https://raw.githubusercontent.com/ACINQ/phoenix/master/.readme/phoenix_text.png)

Phoenix is a Bitcoin wallet developed by [ACINQ](https://acinq.co), that allows you to send and receive bitcoin 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).

## 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.