1
0
mirror of https://github.com/ACINQ/eclair.git synced 2024-11-19 01:43:22 +01:00

Update various doc files (#2547)

- link to plugins repository
- remove android mention for eclair
- update other implementations (renamed)
- update docker CI action versions
- missing eclair-cli APIs in help
This commit is contained in:
Bastien Teinturier 2022-12-30 11:14:56 +01:00 committed by GitHub
parent d76d0f6591
commit 431df1fddb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 16 additions and 15 deletions

View File

@ -11,9 +11,9 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v3
- name: docker login - name: docker login
uses: docker/login-action@v1 uses: docker/login-action@v2
with: with:
username: ${{ secrets.DOCKER_USER }} username: ${{ secrets.DOCKER_USER }}
password: ${{ secrets.DOCKER_PASSWORD }} password: ${{ secrets.DOCKER_PASSWORD }}

View File

@ -45,6 +45,12 @@ To run tests for a specific class, run:
mvn test -Dsuites=*<TestClassName> mvn test -Dsuites=*<TestClassName>
``` ```
To run tests using a specific number of threads, run:
```shell
mvn -T <thread_count> test
```
To run tests with a specific version of `bitcoind`, run: To run tests with a specific version of `bitcoind`, run:
```shell ```shell

View File

@ -134,10 +134,6 @@ Further paragraphs come after blank lines.
We try to minimize our dependencies (libraries and tools). Introducing new dependencies increases We try to minimize our dependencies (libraries and tools). Introducing new dependencies increases
package size, attack surface and cognitive overhead. 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: If your contribution is adding a new dependency, please detail:
- why you need it - why you need it
@ -149,7 +145,7 @@ dependency may be required.
### Testing ### 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 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 recommended to keep the execution time of each test suite under one minute and split tests across

View File

@ -6,7 +6,8 @@
**Eclair** (French for Lightning) is a Scala implementation of the Lightning Network. **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: Here is how to run Eclair with plugins:
```shell ```shell
eclair-node-<version>-<commit_id>/bin/eclair-node.sh <plugin1.jar> <plugin2.jar> <...> eclair-node-<version>/bin/eclair-node.sh <plugin1.jar> <plugin2.jar> <...>
``` ```
### Non-exhaustive plugins list You can find more details about plugins in the [eclair-plugins](https://github.com/ACINQ/eclair-plugins) repository.
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)
## Testnet usage ## Testnet usage

View File

@ -64,6 +64,7 @@ and COMMAND is one of the available commands:
- listinvoices - listinvoices
- listpendinginvoices - listpendinginvoices
- parseinvoice - parseinvoice
- deleteinvoice
=== Payment === === Payment ===
- usablebalances - usablebalances
@ -76,12 +77,14 @@ and COMMAND is one of the available commands:
=== Message === === Message ===
- signmessage - signmessage
- verifymessage - verifymessage
- sendonionmessage
=== OnChain === === OnChain ===
- getnewaddress - getnewaddress
- sendonchain - sendonchain
- onchainbalance - onchainbalance
- onchaintransactions - onchaintransactions
- globalbalance
Examples Examples
-------- --------