-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added proper building instructions and updated readme
- Loading branch information
Showing
1 changed file
with
33 additions
and
27 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,47 +1,53 @@ | ||
# Paymint - A secure bitcoin wallet | ||
Paymint is a Bitcoin thin client written in Dart with powerful features. | ||
# Campfire - A secure Firo wallet | ||
Campfire is a Firo thin client written in Dart with powerful features. | ||
|
||
[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=com.paymintlabs.paymint) | ||
|
||
[Join the Telegram Group](https://www.t.me/paymintwallet) | ||
[![Playstore](https://bluewallet.io/img/play-store-badge.svg)](https://play.google.com/store/apps/details?id=com.cypherstack.campfire) | ||
|
||
## Feature List | ||
✅ Basic fee selection controls | ||
|
||
✅ Coin Control | ||
- UTXO renaming (labeling) | ||
- Block/Unblock UTXOs | ||
- Export Ouput data to CSV | ||
- Restore Output labels and block status from CSV import | ||
|
||
✅ View transaction worth in fiat when sent/received to the wallet AND current worth | ||
|
||
✅ Export transaction data to CSV | ||
✅ View transaction worth in fiat when sent/received to the wallet AND current worth | ||
|
||
✅ Preview transaction before sending | ||
- View amount being sent + fee in BTC, sats, or fiat currency | ||
- View amount being sent + fee in FIRO, sats, or fiat currency | ||
|
||
✅ Custom Esplora-Electrs server support | ||
✅ Custom Electrum server support | ||
|
||
✅ 15 Currencies supported | ||
|
||
✅ Native Segwit by default | ||
|
||
✅ And many more... | ||
|
||
## Build and run | ||
### Prerequisites | ||
- Flutter SDK Requirement (>=2.2.0, up until <3.0.0) | ||
- Flutter SDK Requirement (>=2.10.2, up until <3.0.0) | ||
- Android/iOS dev setup (Android Studio, xCode and subsequent dependencies) | ||
- Navigate into project root and run the following: | ||
|
||
Plug in your android device or use the emulator available via Android Studio and then run the following commands from project root: | ||
After that download the project and init the submodules | ||
``` | ||
flutter pub get | ||
flutter run --release | ||
git clone https://github.com/cypherstack/Campfire.git | ||
cd Campfire | ||
git submodule update --init --recursive | ||
``` | ||
|
||
Building plugins for Android | ||
``` | ||
cd crypto_plugins/flutter_liblelantus/scripts/android/ | ||
// note if you are on a mac go one directory further to android_on_mac | ||
./build_all.sh | ||
// when finished go back to the root directory | ||
cd ../../../.. | ||
``` | ||
|
||
Building plugins for IOS | ||
|
||
## Screenshots | ||
<img src="https://i.imgur.com/wwFTog5.jpg" width="250"> <img src="https://i.imgur.com/S7hJvfu.jpg" width="250"> <img src="https://i.imgur.com/aUPmgEq.jpg" width="250"> | ||
``` | ||
cd crypto_plugins/flutter_liblelantus/scripts/ios/ | ||
./build_all.sh | ||
// when finished go back to the root directory | ||
cd ../../../.. | ||
``` | ||
|
||
<img src="https://i.imgur.com/A94PyL4.jpg" width="250"> <img src="https://i.imgur.com/D602Htc.jpg" width="250"> | ||
Finally, plug in your android device or use the emulator available via Android Studio and then run the following commands: | ||
``` | ||
flutter pub get | ||
flutter run | ||
``` |