Skip to content
master
Switch branches/tags
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
 
 
 
 
e2e
 
 
 
 
 
 
src
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

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.14.2, v0.14.1, v0.13.1, v0.13.0, v0.12.1, v0.11.1, v0.10.3
  • c-lightning - v0.10.2, v0.10.0, v0.9.3, v0.8.2
  • Eclair - v0.7.0, v0.6.2, v0.6.0, v0.5.0, v0.4.2
  • Bitcoin Core - v22.0, v0.21.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.3.0 for your OS

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

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.