diff --git a/.github/workflows/docker-image.yml b/.github/workflows/docker-image.yml index 8d145e39c..602b224dc 100644 --- a/.github/workflows/docker-image.yml +++ b/.github/workflows/docker-image.yml @@ -11,9 +11,9 @@ jobs: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3 - name: docker login - uses: docker/login-action@v1 + uses: docker/login-action@v2 with: username: ${{ secrets.DOCKER_USER }} password: ${{ secrets.DOCKER_PASSWORD }} diff --git a/BUILD.md b/BUILD.md index 967da4b2f..515fd3dd8 100644 --- a/BUILD.md +++ b/BUILD.md @@ -45,6 +45,12 @@ To run tests for a specific class, run: mvn test -Dsuites=* ``` +To run tests using a specific number of threads, run: + +```shell +mvn -T test +``` + To run tests with a specific version of `bitcoind`, run: ```shell diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 96aa2fb1d..fa66c88a0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -134,10 +134,6 @@ Further paragraphs come after blank lines. We try to minimize our dependencies (libraries and tools). Introducing new dependencies increases package size, attack surface and cognitive overhead. -Since Eclair is [running on Android](https://github.com/acinq/eclair-mobile), we have a requirement -to be compatible with Java 7. This currently restricts the set of dependencies we can add and the -language features we use. - If your contribution is adding a new dependency, please detail: - why you need it @@ -149,7 +145,7 @@ dependency may be required. ### Testing -Your code should be tested. We use ScalaTest as a testing framework. +Your code should be tested. We use [ScalaTest](https://www.scalatest.org/) as a testing framework. ScalaTest's approach is to parallelize on test suites rather than individual tests, therefore it is recommended to keep the execution time of each test suite under one minute and split tests across diff --git a/README.md b/README.md index 3ed77a074..846e7e12f 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,8 @@ **Eclair** (French for Lightning) is a Scala implementation of the Lightning Network. -This software follows the [Lightning Network Specifications (BOLTs)](https://github.com/lightning/bolts). Other implementations include [c-lightning](https://github.com/ElementsProject/lightning), [lnd](https://github.com/LightningNetwork/lnd), [electrum](https://github.com/spesmilo/electrum/), and [rust-lightning](https://github.com/rust-bitcoin/rust-lightning). +This software follows the [Lightning Network Specifications (BOLTs)](https://github.com/lightning/bolts). +Other implementations include [core lightning](https://github.com/ElementsProject/lightning), [lnd](https://github.com/LightningNetwork/lnd), [electrum](https://github.com/spesmilo/electrum/), and [ldk](https://github.com/lightningdevkit/rust-lightning). --- @@ -242,15 +243,10 @@ A valid plugin is a jar that contains an implementation of the [Plugin](eclair-n Here is how to run Eclair with plugins: ```shell -eclair-node--/bin/eclair-node.sh <...> +eclair-node-/bin/eclair-node.sh <...> ``` -### Non-exhaustive plugins list - -Here are some plugins created by the Eclair community. -If you need support for these plugins, head over to their respective github repository. - -* [Telegram Bot for Eclair alerts](https://github.com/engenegr/eclair-alarmbot-plugin) +You can find more details about plugins in the [eclair-plugins](https://github.com/ACINQ/eclair-plugins) repository. ## Testnet usage diff --git a/eclair-core/eclair-cli b/eclair-core/eclair-cli index 06c75098e..c7970e251 100755 --- a/eclair-core/eclair-cli +++ b/eclair-core/eclair-cli @@ -64,6 +64,7 @@ and COMMAND is one of the available commands: - listinvoices - listpendinginvoices - parseinvoice + - deleteinvoice === Payment === - usablebalances @@ -76,12 +77,14 @@ and COMMAND is one of the available commands: === Message === - signmessage - verifymessage + - sendonionmessage === OnChain === - getnewaddress - sendonchain - onchainbalance - onchaintransactions + - globalbalance Examples --------