Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Jwyman328/LiveWallet
https://github.com/Jwyman328/LiveWallet
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Jwyman328/LiveWallet
- Owner: Jwyman328
- License: mit
- Created: 2024-03-03T21:37:34.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-23T14:25:16.000Z (3 months ago)
- Last Synced: 2024-06-23T15:40:01.457Z (3 months ago)
- Language: TypeScript
- Size: 10.2 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-bdk - Live Wallet
README
Live Wallet
Keep your utxos alive
## Description
- An application to help estimate the effect of bitcoin transaction fees on invididual utxos and transactions containing multiple utxos.
## Demo
https://github.com/Jwyman328/LiveWallet/assets/32882426/aa218a2e-bc5b-4795-98bd-6ae839ee091f
## Hardware wallet support demo
https://github.com/user-attachments/assets/4439fbef-a55e-45dd-8a90-4cc1a60e1be3
# Development
## Prerequisits
- For hardware wallet usb interactions, libusb is required.
```bash
$ brew install libusb
```
## How to create a new release
- Use the script update_app_version.sh, passing it a new version number and text to append to the change log file.
- If a new version is successfully set then this script will build a new release by running the package_app.sh script.
```bash
$ bash update_app_version.sh "1.2.0" "I am adding another item to the change log"
```
## How to create build
- in a single script you can package the backend and the frontend into a single executable by running
```bash
$ bash package_app.sh
```
- The app build will be available in /release directory
- To build just the backend python server run (from ./backend/)
```bash
bash build_executable.sh
```
- to copy the new backend builds to where the frontend is expecting it run (./backend/)
```bash
cp -R dist/* ../assets/
```
- To build the frontend which will include the backend build run (from .)
```bash
$ sudo npm run package
```
- The app build will be available in /release directory
## How to start app locally
- To startup the electron app run
```bash
$ sudo npm start
```
- To start up the backend server and related services run
```bash
$ bash backend/start_app.sh
```
- Docker must be running in order to run the related backend services. (chopsticks, espolora, electrs, bitcoin)
- These are needed for the backend to be able to communicate with an electrum server which talks with a bitcoind container, this is all handled via [nigiri](https://github.com/vulpemventures/nigiri)
- To tear down containers from start_app.sh run
```bash
$ bash backend/clean_up.sh
```
## How to run backend tests
- You can run
```bash
$ bash backend/test_app.sh
```
# Development fixtures
- when backend/start_app.sh is run the script randomly_fund_mock_wallet.py will be run to randomly generate 10 bitcoin transactions to the default dev wallet's address.
- to generate additional transactions you can use the scripts in backend/scripts/