React Electron Docker Bitcoin lightning-network lightning lnd TypeScript
Need help with polar?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.
jamaljsr

Description

One-click Bitcoin Lightning networks for local app development & testing

240 Stars 40 Forks MIT License 1.6K Commits 7 Opened issues

Services available

Need anything else?

Polar

One-click Bitcoin Lightning networks for local app development & testing

Actions Status codecov Crowdin GitHub license GitHub release

View a short video demo

Purpose

Polar was built to help Lightning Network application developers quickly spin up one or more networks locally on their computers.

With Polar you can:

  • Create a regtest Lightning Network in just a few clicks
  • Connect from your app to the lightning nodes via RPC
  • Add more nodes using drag & drop
  • Start and stop individual nodes
  • Open & Close Channels
  • Create & Pay Lightning Invoices
  • Launch a terminal in each bitcoin/lightning node
  • View streaming logs from each node
  • Manually mine new blocks
  • Deposit regtest coins into each Lightning node
  • Export and import networks, for sharing with other Lightning developers
  • Create you own docker images to use as custom nodes (ex: master branch, local fork)

Supported Network Node Versions:

  • LND v0.11.1, v0.11.0, v0.10.3, v0.10.2, v0.10.1, v0.10.0, v0.9.1, v0.9.0, v0.8.2, v0.8.0 & v0.7.1
  • c-lightning v0.9.1, v0.9.0, v0.8.2, v0.8.1 & v0.8.0
  • Eclair v0.4.2, v0.3.3
  • Bitcoin Core v0.20.1, v0.20.0, v0.19.1, v0.19.0.1 & v0.18.1

Dependencies

Polar requires that you have Docker installed to create the local networks

You will be prompted to install Docker if Polar cannot detect it automatically

Download

Download Polar v1.0.1 for your OS

Alternative and older version binaries can be found in the GitHub releases

Polar's Future

The overall goal of Polar is to minimize the time & effort needed for a developer new to Lightning to get started building their next killer app. In addition, Polar aims to be a useful tool for experienced Lightning App developers to iterate faster on their projects. Less time setting up nodes, more time building your app.

Here's a short list of ideas for features that may be beneficial to add in future releases (in no particular order):

  • Importing network templates from external sources (such as GitHub) to allow for community contributions. This may require a scripting system built-in.
  • Sample app projects/code in different languages (Python, Typescript/JS, Go, C#) showing how to connect to the Lightning/Bitcoin nodes from an external app.
  • Bitcoin Block Explorer & GRPC/REST API Explorers to have access to all of the node RPC API's graphically, without needing to fallback to the Terminal.

Help Translate

Polar's translations are managed on Crowdin. The initial translations of 10 languages were done by machine (Google Translate) and are likely to not be 100% accurate. If you speak multiple languages and wish to help with translations, please feel free to head over to the project page on Crowdin and submit updated strings. This assistance would be greatly appreciated.

Development

If you would like to learn how to package Polar from source code or want to fix a bug or add a new feature, please see CONTRIBUTING for detailed instructions.

Commands

| Command | Description | | --------------- | ----------------------------------------------------------------- | |

yarn
| install dependencies | |
yarn dev
| run the app with react hot reloading and electron live restarting | |
yarn test
| run unit tests in watch mode | |
yarn test:e2e
| run e2e tests | |
yarn lint:all
| run typescript and eslint syntax checking | |
yarn package
| package the app for your OS |

Tech Stack

Recognition

Huge thanks to maintainers of Lightning Joule, Zap Wallet, LND, Bitcoin Core, along with many others for the amazing apps & libraries that gave this project inspiration, ideas & sometimes even a little code 😊.

Contact

The best place to reach me is on Twitter @jamaljsr. I also lurk in the LND Slack server, so you can msg me there as well.

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.