All notable changes to this project will be documented in this file. See standard-version for commit guidelines.
This is a major release which adds supports for Taproot Assets Protocol Daemon (tapd) nodes. You can add tapd nodes to your network to begin easily minting and sending assets between nodes. You also have access to the terminal to run all tapcli commands.
There are also a few smaller improvements such and Auto Mining and Docker Compose v2 support. The full list of changes are below.
- tapd: add support for Taproot Assets Protocol nodes by @amovfx & @jamaljsr
- in #641, #656. #661, #667, #668, #669, #672, #683, #684, #685, #703
- network: automatically mine new blocks by @Jhoyola in jamaljsr#707
- images: add support for LND v0.16.1-beta and v0.16.2-beta by @jamaljsr in jamaljsr#709
- docker: support docker-compose v2 + minor improvements by @jamaljsr in jamaljsr#721
- terminal: change font size using shortcuts by @zackypick in jamaljsr#612
- bitcoind: add Compact Filters support by @hsjoberg in jamaljsr#630
- images: add support for Bitcoin Core v24.0 by @jamaljsr in jamaljsr#632
- images: add support for Eclair v0.8.0 by @jamaljsr in jamaljsr#632
- images: add support for Core Lightning v23.02.2 by @jamaljsr in jamaljsr#696
- images: add support for LND v0.16.0-beta by @jamaljsr in jamaljsr#702
- docker add multi-arch docker images by @NonsoAmadi10 in jamaljsr#701
- cln: Missing address flag for announcing externally by @niteshbalusu11 in jamaljsr#608
- docker: properly detect docker socket path by @jamaljsr in jamaljsr#695
- lnd: fix wrong source label for pending channels by @amovfx in jamaljsr#703
- network: clear RPC cache when nodes are stopped by @jamaljsr in jamaljsr#698
- custom-nodes: update golang version of custom docker image by @hieblmi in jamaljsr#691
- custom-nodes: add no-cache flag for docker build @hieblmi in jamaljsr#607
While Polar has kept up with the new node implementation releases via the out-of-band updates, it hasn't had any new features added in a long while. This release packages up all those node updates so that you don't need to manually update after the initial install. We now also have automatic updates. You can opt-in to checking for new node versions on startup, instead of having to do it manually. Links to check for updates have also been added to the start screen and footer to make it easier to get to.
There are a bunch of first-time contributors in this release. They've added some great updates which you can see listed below. Thank you all for your PRs.
This release is required to run Core Lightning v0.12.0 due to an API that Polar requires being deprecated.
- lnd: added LND connect URL for REST API by @NehaK745 in jamaljsr#484
- images: add support for Bitcoin Core v22.0 by @cstenglein in jamaljsr#510
- images: add support for LND v0.14.1-beta by @qustavo in jamaljsr#519
- images: update lightning nodes, add cli completion by @jonafll in jamaljsr#541
- images: add support for the latest node implementations by @jamaljsr in jamaljsr#559
- lightningd: add Core Lightning GRPC info to sidebar by @jamaljsr in jamaljsr#560
- images: add support for LND v0.15.0-beta by @jamaljsr in jamaljsr#563
- images: add support for CLN v0.11.2 by @ktecho in jamaljsr#572
- app: check for updates on startup by @jamaljsr in jamaljsr#578
- nodes: better visually know what node is selected by @ktecho in jamaljsr#583
- images: add support for LND v0.15.1-beta.rc1 by @jamaljsr in jamaljsr#585
- bitcoind: send funds to onchain address by @jamaljsr in jamaljsr#586
- images: add support for LND v0.15.1 and CLN v0.12.0 by @jamaljsr in jamaljsr#588
- designer: move sync button to actions toolbar by @jamaljsr in jamaljsr#589
- home: fix loading animation on home screen by @jamaljsr in jamaljsr#577
- network: add error handling when creating a new network by @jamaljsr in jamaljsr#580
- lightningd: display CA cert and distinguish it from client cert and key by @louneskmt in jamaljsr#584
- removing duplicates from CONTRIBUTING file by @ktecho in jamaljsr#570
- Update custom-nodes.md - fix typo by @git-sgmoore in jamaljsr#497
- Update custom-nodes.md by @niteshbalusu11 in jamaljsr#550
This is a minor release which adds a small set of improvements and fixes some bugs. All of the node implementations have been updated to their latest versions.
- channels: add private channel option (#430) by @bolatovumar
- examples: add example of an LND TypeScript app (#414) by @murtyjones
- images: add support for Bitcoin Core v0.21.1 (6d368ee)
- images: add support for c-lightning v0.10.0 (cabf9bf)
- images: add support for eclair v0.6.0 (625f025)
- images: add support for LND v0.12.1-beta (6d368ee)
- images: add support for LND v0.13.0-beta.rc3 (5667b3b)
- images: remove outdated node implementations (2ba55ae)
- layout: fix nav menu icon spacing (120f4c0)
- menu: fix context menu runtime console warning (aee7563)
- network: fix docker error when removing a started node (a521d74)
- nodes: increase node startup timeout from 60 to 120 secs (0d052c0)
This is a minor release which adds a small set of improvements and fixes some bugs. All of the node implementations have been updated to their latest versions.
This release is required to run Bitcoin Core v0.21.0 nodes due to a small breaking change. The default wallet is no longer created automatically during bitcoind startup, so Polar must create the wallet once bitcoind comes online.
- chart: add zoom support to the designer (#378)
- bitcoind: expose Bitcoin Core P2P port (#372) by @lukechilds
- bitcoind: expose REST interface by default (#419) by @valentinewallace
- lnd: add invoice macaroon to Connect tab (#376)
- images: add support for bitcoind v0.21.0 (f59dd1b)
- images: add support for c-lightning v0.9.3 (f3c3c0d)
- images: add support for eclair v0.5.0 (47af8c2)
- images: add support for LND v0.12.0-beta (57fc766)
- bitcoind: create default wallet when starting bitcoind v0.21.0 (548a138)
- designer: fix channels hiding when removing a node in a stopped network (534892c)
- designer: add hover state for node (#406) by @murtyjones
- lnd: correct REST url (#407) by @murtyjones
- lnd: fixes clipboard copy value for p2pLnUrlInternal (#381) by @Jasonvdb
- networks: fix error when deleting an imported network (b53de1a)
- sidebar: remove extra space between collapsed sidebar nodes (17643aa)
- chore: update dead link in code comment (#422) by @murtyjones
This is a small patch release which fixes a compatibility issue to support Bitcoin Core v0.20.0. There was a breaking change in this version requiring the use of -fallbackfee in regtest environments.
- images: add support for bitcoind v0.20.0 (a538ca0)
- images: add support for LND v0.10.2-beta.rc2 (be3a135)
- images: add support for LND v0.10.1-beta (20e1ed1)
- images: add support for LND v0.10.0 and c-lightning v0.8.2 (6df87c8)
- lnd: add docker container name as tlsextradomain (#355)
- fix small typos in CONTRIBUTING (#331 & #332) by @nickycutesc
This release was focused on implementing many of the feature requests submitted since the first release, as well as adding support for the Eclair Lightning implementation. You can now use your own custom Docker image, allowing you to run the master branch or your personal fork of each node. Polar now supports importing and exporting networks, which allows you to save snapshots to reuse as a starting point over an over again. We also added a log viewer for nodes which should make it easier to see what your nodes are doing and added right-click menus for nodes & channels so you can perform actions with less clicks. To support more flexible environments, the Lightning P2P and Bitcoin ZMQ ports are now exposed to the host machine, which means you can have nodes outside of Polar communicate with the nodes inside.
I am bumping the version to a major release v1.0.0 to signify that I feel Polar is now pretty stable and fully-functional, with support for the big three Lightning implementations. There are still more improvements which will be added in the future, but what's included now is a solid base.
- Add support for Eclair v0.3.3 nodes (#322)
- Add ability to import & export networks (#295) by @torkelrogstad
- Add support for custom docker images (#299)
- Make bitcoind's ZeroMQ servers reachable on LAN (#297) by @hsjoberg
- Make lightning nodes p2p port reachable on LAN (#301) by @hsjoberg
- Add right-click menus for nodes and channels (#312)
- Add ability to view live logs from nodes (#316)
- Handle errors in Bitcoind logger (#285) by @bolatovumar
- Make sure localBalance is never undefined for pending channel (#289) by @bolatovumar
- Fix corrupt redux state causing errors (#305)
- Fix broken line wrapping for long commands in the terminal (#310)
- Fix typo in English translations (#323)
- Add CONTRIBUTING documentation (#294)
- Add documentation for building custom node images (custom-node.md)
Polar received contributions from a few community members. I'd like to sincerely thank these devs for giving back to the project.
- Torkel Rogstad @torkelrogstad
- Hampus Sjöberg @hsjoberg
- Umar Bolatov @bolatovumar
All feedback and contributions are greatly appreciated.
This is just a small release to bring back light mode for those who prefer it over dark mode.
- ui: add light/dark mode toggle (#280)
- ui: lighten node background in dark mode (2a5fde4)
- fix spelling and add Polar version field to bug template (#279) h/t @bolatovumar
This release was focused on adding core features that didn't make it in the first release, as well as some UX and stability improvements. The UI has been redesigned to use a dark theme which has been a popular request. Polar now supports the latest versions of LND v0.8.2, Bitcoin Core v0.19.0.1 and adds support for c-lightning v0.8.0. Future released versions of these Lightning & Bitcoin nodes can now be used without needing to release a new version of Polar. This feature will let you start using the new versions as soon as they are out. To maintain support for older LND versions which are not compatible with the latest bitcoind, Polar now supports running multiple bitcoin nodes in a single network. Have fun creating chain splits and block reorgs with the new ability to stop and start individual nodes as well :)
There are now 10 languages included (English, French, German, Spanish, Russian, Italian, Chinese Simplified, Portuguese-Brazilian, Japanese, Korean), though most are machine generated, so they need some love. Languages are now crowd-sourced via Crowdin. See the Help Translate section of the README for more details.
In the next release, the focus will be on tackling some of the feature requests submitted since the initial launch. If you have any suggestions or use-cases you'd like to see improved with Polar, please don't hesitate to open an issue.
Be sure to stop all your running networks and close Polar v0.1.0 before installing v0.2.0!
When adding c-lighting v0.8.0, lightningd was unable to create the lightning-rpc socket file due to 'path too long' errors on Mac. Polar previously stored the data for nodes in ~/Library/Application Support/polar/data/networks/. This has now been changed to ~/.polar on all OS's. When you launch v0.2.0 for the first time, Polar will migrate your application data from the old folder location to the new location. This also means that the paths to certs & macaroons have changed. If you hard-coded them in your app, you'll need to update the paths.
Location in v0.1.0
- Mac:
~/Library/Application Support/polar/data/networks/ - Linux:
~/config/polar/data/networks/ - Windows:
~/AppData/Roaming/polar/data/networks/
New location in v0.2.0
- All OS's:
~/.polar/networks/
- ui: change ui design to use dark mode (#271)
- network: add support for c-lightning v0.8.0 with c-lightning-REST plugin (#259)
- network: add support for LND v0.8.2-beta (#257)
- network: add support for Bitcoin Core v0.19.0.1 (#257)
- docker: add ability to update future Bitcoin & Lightning node versions in-between Polar releases (#267)
- network: add ability to run multiple Bitcoin Core nodes in one network (#257)
- network: add ability to start and stop each node individually (#258)
- payments: add ability to create and pay basic invoices (#254)
- bitcoind: use tabs for the bitcoind sidebar and display RPC credentials (#256)
- i18n: add translations for 9 languages via Crowdin (#261)
- ui: disable "Close channel" button if opening channel to self (#247), closes #246 by @bolatovumar
- i18n: correct spanish translations (#245) by @federicobond
- readme: add some future plans to the readme (d875529)
- readme: add Crowdin information to the readme (69c89ee)
Polar received contributions from a few community members. I'd like to sincerely thank these devs for giving back to the project.
- Federico Bond @federicobond
- Umar Bolatov @bolatovumar
- Will O'Beirne @wbobeirne
- Otto Suess @ottosuess
All feedback and contributions are greatly appreciated.
This first stable release of Polar contains the following features:
- 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
- Multiple language support with English & Spanish (translations need improvement)
- Multiple OS support for Mac, Windows & Linux