All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
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](https://github.com/jamaljsr/polar#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.
### Application Data Folder Moved
**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.
- **ui**: change ui design to use dark mode ([#271](https://github.com/jamaljsr/polar/pull/271))
- **network**: add support for c-lightning v0.8.0 with [c-lightning-REST](https://github.com/Ride-The-Lightning/c-lightning-REST) plugin ([#259](https://github.com/jamaljsr/polar/pull/259))
- **network**: add support for LND v0.8.2-beta ([#257](https://github.com/jamaljsr/polar/pull/257))
- **network**: add support for Bitcoin Core v0.19.0.1 ([#257](https://github.com/jamaljsr/polar/pull/257))
- 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
- Start and stop individual nodes
- Open & Close Channels
- Create & Pay Lightning Invoices
- Launch a terminal in each bitcoin/lightning node
- Manually mine new blocks
- Deposit regtest coins into each Lightning node
Supported Network Nodes:
Supported Network Node Versions:
- LND v0.8.0 & v0.7.1
- Bitcoin Core v0.18.1
- c-lightning (coming soon)
- eclair (coming soon)
- LND v0.8.2, v0.8.0 & v0.7.1
- Bitcoin Core v0.19.0.1 & v0.18.1
- c-lightning v0.8.0
- eclair (coming soon?) \*need to gauge demand for this implementation\*
## Dependencies
@ -41,9 +43,17 @@ Polar requires that you have Docker installed to create the local networks
- On Mac & Windows, you can just install [Docker Desktop](https://www.docker.com/products/docker-desktop)
- On Linux, you need to install [Docker Server](https://docs.docker.com/install/#server) and [Docker Compose](https://docs.docker.com/compose/install/) separately
You will be prompted to install Docker if Polar cannot detect it automatically
## Download
The most current Polar downloads for Mac, Windows & Linux can be found in the [GitHub releases](https://github.com/jamaljsr/polar/releases)
Download Polar v0.2.0 for
- Mac ([dmg](https://github.com/jamaljsr/polar/releases/download/v0.2.0/polar-mac-v0.2.0.dmg), [zip](https://github.com/jamaljsr/polar/releases/download/v0.2.0/polar-mac-v0.2.0.zip))
- Linux ([deb](https://github.com/jamaljsr/polar/releases/download/v0.2.0/polar-linux-amd64-v0.2.0.deb), [AppImage](https://github.com/jamaljsr/polar/releases/download/v0.2.0/polar-linux-x86_64-v0.2.0.AppImage))
- Windows ([exe](https://github.com/jamaljsr/polar/releases/download/v0.2.0/polar-win-v0.1.0.exe))
Alternative and older version binaries can be found in the [GitHub releases](https://github.com/jamaljsr/polar/releases)
## Polar's Future
@ -91,7 +101,7 @@ Polar's translations are managed on [Crowdin](https://crowdin.com/project/polar)
- [Prettier](https://github.com/prettier/prettier): keep code format consistent
- [ESLint](https://github.com/eslint/eslint): follow code quality best practices
- [Github Actions](https://github.com/actions): automate builds and testing on Windows/Mac/Linux
- [Renevate Bot](https://github.com/renovatebot/renovate): automate dependency upgrades via GitHub bot
- [Renovate Bot](https://github.com/renovatebot/renovate): automate dependency upgrades via GitHub bot
jamaljsr
5 years ago
