Skip to content
One-click Bitcoin Lightning networks for local app development & testing
TypeScript JavaScript Other
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
.vscode
assets
docker
e2e
electron
public
src
.commitlintrc
.editorconfig
.electronbuildrc
.eslintignore
.eslintrc
.gitattributes
.gitignore
.i18next-scanner.js
.lintstagedrc
.prettierrc
.renovaterc
.rescriptsrc.js
.stylelintrc
.testcafe-electron-rc
.versionrc
CHANGELOG.md
LICENSE
README.md
TODO.md
package.json
tsconfig.json
yarn.lock

README.md

Polar

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

Actions Status codecov

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
  • Launch a terminal in each bitcoin/lightning node
  • Add more nodes using drag & drop
  • Open & Close Channels
  • Manually mine new blocks
  • Deposit regtest coins into each Lightning node

Supported Network Nodes:

  • LND v0.8.0 & v0.7.1
  • Bitcoin Core v0.18.1
  • c-lightning (coming soon)
  • eclair (coming soon)

Dependencies

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

Download

The most current downloads for Mac, Windows & Linux can be found in the GitHub releases

Development

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 langs extract i18n language keys from code
yarn package package the app for your OS

Tips

  • install the import-sorter Visual Studio Code extension for automatic import statement sorting

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

I plan to setup a website and email soon. The best place to reach me now is on Twitter @jamaljsr. I also lurk in the LND Slack server, so you can msg me there as well.

You can’t perform that action at this time.