{"id":13499180,"url":"https://github.com/lightninglabs/lightning-app","last_synced_at":"2025-03-29T04:30:49.208Z","repository":{"id":45901483,"uuid":"76898197","full_name":"lightninglabs/lightning-app","owner":"lightninglabs","description":"An easy-to-use cross-platform Lightning wallet","archived":true,"fork":false,"pushed_at":"2020-07-30T08:31:26.000Z","size":27902,"stargazers_count":899,"open_issues_count":221,"forks_count":173,"subscribers_count":72,"default_branch":"master","last_synced_at":"2024-08-01T22:50:17.797Z","etag":null,"topics":["bitcoin","cryptocurrency","electron-app","lightning","react","wallet"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/lightninglabs.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}},"created_at":"2016-12-19T21:21:03.000Z","updated_at":"2024-07-05T16:50:53.000Z","dependencies_parsed_at":"2022-07-18T12:19:21.406Z","dependency_job_id":null,"html_url":"https://github.com/lightninglabs/lightning-app","commit_stats":null,"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-app","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-app/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-app/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lightninglabs%2Flightning-app/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lightninglabs","download_url":"https://codeload.github.com/lightninglabs/lightning-app/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222456039,"owners_count":16987585,"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":["bitcoin","cryptocurrency","electron-app","lightning","react","wallet"],"created_at":"2024-07-31T22:00:30.536Z","updated_at":"2024-10-31T17:31:40.877Z","avatar_url":"https://github.com/lightninglabs.png","language":"JavaScript","funding_links":[],"categories":["Applications","JavaScript"],"sub_categories":["Desktop Interfaces"],"readme":"Lightning [![Build Status](https://travis-ci.org/lightninglabs/lightning-app.svg?branch=master)](https://travis-ci.org/lightninglabs/lightning-app)\n==========\n\nAn easy-to-use cross platform lightning wallet\n\n![Screenshot](https://github.com/lightninglabs/lightning-app/blob/5f2620d1e99ed1372985fec2063066236e4c16d9/assets/screenshot.png)\n\n**N.B. This is still early technology and there’s a risk of losing all of your funds. We recommend not putting in more money than you are willing to lose.**\n\n### Getting Started\n\nThe app comes for two threat models:\n\n1. *Pocket Money:* prebuilt and signed [releases](https://github.com/lightninglabs/lightning-app/releases) with auto update (recommended for most users).\n\n2. *Tin Foil Hat:* if you'd rather build it yourself and do without auto updates, see the instructions below.\n\n### Contributing\n\nSee the `ToDo (next release)` column on our [project board](https://github.com/lightninglabs/lightning-app/projects/1?fullscreen=true). Issues that are easy to pick up for outside contributors are labeled `help wanted`.\n\n### Developing Locally\n\nTo build the mobile app locally, see the [README](https://github.com/lightninglabs/lightning-app/blob/master/mobile/README.md) in the `/mobile` directory for instructions.\n\nTo build the desktop app locally follow the instructions below:\n\n#### Install lnd\nWe will use `lnd` to make GRPC calls from the ReactJS environment\n```\ngit clone https://github.com/lightningnetwork/lnd $GOPATH/src/github.com/lightningnetwork/lnd\ncd $GOPATH/src/github.com/lightningnetwork/lnd\nmake \u0026\u0026 make install tags=\"experimental autopilotrpc signrpc walletrpc chainrpc invoicesrpc routerrpc\"\n```\nIf you have any issues with this step, make sure to review the [Preliniaries to installing LND](https://github.com/lightningnetwork/lnd/blob/master/docs/INSTALL.md#preliminaries)\n\n#### Install btcd\nWe will use `btcd` as the backend operating mode\n```\ngit clone https://github.com/btcsuite/btcd $GOPATH/src/github.com/btcsuite/btcd\ncd $GOPATH/src/github.com/btcsuite/btcd\nGO111MODULE=on go install -v . ./cmd/...\n```\n\n#### Set up \u0026 run\nCloning this git repo `git clone https://github.com/lightninglabs/lightning-app` and from the project root folder run the following commands:\n```\nnpm install\n\nnpm test\n```\n\nTo start the app in development mode (simnet):\n```\nnpm run electron-dev\n```\n\nRunning in development mode can allow you to run in full node mode instead of the default neutrino mode, and will also allow you to run in simnet node for testing. The app will use it's own lnd `data/lnd` dir and does not share state with other lnd installations on your system. See [setup local cluster](https://github.com/lightninglabs/lightning-app/blob/master/assets/script/setup_local_cluster.md) on how to set up your simnet cluster for development.\n\n#### Review UI style guide\n\nTo build the UI style guide\n```\nnpm run storybook\n```\n\n### Building the Packaged App\n\nTo build the packaged version of the app e.g. for macOS run:\n```\ncp $GOPATH/bin/lnd ./assets/bin/darwin\nnpm run electron-pack\n```\n\nThe packaged app will then be available in the `dist` directory. The packaged version of the app will run on Bitcoin mainnet.\n\n### Starting the Packaged App (light client)\n\nTo run the packaged version of the app e.g. for macOS run:\n```\n./dist/mac/Lightning.app/Contents/MacOS/Lightning\n```\n\nThe app is configured for mainnet by default but you can opt-in to testnet:\n```\n./dist/mac/Lightning.app/Contents/MacOS/Lightning --bitcoin.testnet --bitcoin.node=neutrino --neutrino.addpeer=btcd-testnet.lightning.computer --neutrino.feeurl=https://nodes.lightning.computer/fees/v1/btc-fee-estimates.json\n```\n\n### Starting the Packaged App (full node)\n\n#### btcd\nStart btcd in a separate terminal session and wait until it's fully synced (can take a while):\n```\nbtcd --txindex --rpcuser=kek --rpcpass=kek\n```\n\nTo run the packaged version of the app e.g. for macOS run:\n```\n./dist/mac/Lightning.app/Contents/MacOS/Lightning --bitcoin.mainnet --btcd.rpcuser=kek --btcd.rpcpass=kek\n```\n\n#### bitcoind\nStart bitcoind in a separate terminal session and wait until it's fully synced (can take over a day):\n```\nbitcoind -txindex=1 -rpcuser=kek -rpcpassword=kek -rpcbind=localhost -zmqpubrawblock=tcp://127.0.0.1:28332 -zmqpubrawtx=tcp://127.0.0.1:28333\n```\n\nTo run the packaged version of the app e.g. for macOS run:\n```\n./dist/mac/Lightning.app/Contents/MacOS/Lightning --bitcoin.mainnet --bitcoin.node=bitcoind --bitcoind.rpcuser=kek --bitcoind.rpcpass=kek --bitcoind.zmqpubrawblock=tcp://127.0.0.1:28332 --bitcoind.zmqpubrawtx=tcp://127.0.0.1:28333\n```\n\n### Lnd data and logs\nLnd data and logs are written to the following locations in production:\n\n* **Linux:** `~/.config/lightning-app/lnd`\n* **OSX:** `~/Library/Application Support/lightning-app/lnd`\n* **Windows:** `%USERPROFILE%\\AppData\\Roaming\\lightning-app\\lnd`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightninglabs%2Flightning-app","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flightninglabs%2Flightning-app","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flightninglabs%2Flightning-app/lists"}