Rename package eclair to lightning (#252)

Co-authored-by: dpad85 <[email protected]>

Author: sstone

BUILD.md

@@ -1,6 +1,6 @@
 # Building
 
-Eclair-kmp is a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) library.
+lightning-kmp is a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) library.
 It can run on many different platforms, including mobile devices (iOS and Android).
 
 ## Requirements
@@ -21,8 +21,8 @@ brew install gmp
 You should start by cloning the repository locally:
 
 ```sh
-git clone [email protected]:ACINQ/eclair-kmp.git
-cd eclair-kmp
+git clone [email protected]:ACINQ/lightning-kmp.git
+cd lightning-kmp
 ```
 
 To build the project library and install it locally, you can run:

CONTRIBUTING.md

@@ -1,6 +1,6 @@
-# Contributing to Eclair Multi-Platform
+# Contributing to the lightning-kmp project
 
-Eclair welcomes contributions in the form of peer review, testing and patches.
+ACINQ welcomes contributions in the form of peer review, testing and patches.
 This document explains the practical process and guidelines for contributing.
 
 While developing a Lightning implementation is an exciting project that spans many domains
@@ -9,7 +9,7 @@ represents real money and introducing bugs or security vulnerabilities can have
 consequences than in typical projects. In the world of cryptocurrencies, even the smallest bug in
 the wrong area can cost users a significant amount of money.
 
-If you're looking for somewhere to start contributing, check out the [good first issue](https://github.com/ACINQ/eclair-kmp/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list.
+If you're looking for somewhere to start contributing, check out the [good first issue](https://github.com/ACINQ/lightning-kmp/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue") list.
 
 Another way to start contributing is by adding tests or improving them.
 This will help you understand the different parts of the codebase and how they work together.
@@ -22,7 +22,7 @@ some pointers and feedback from experienced contributors. It will also ensure th
 duplicating work that someone else is doing.
 
 We use Github issues only for, well, issues (mostly bugs that need to be investigated).
-You can also use Github issues for [feature requests](https://github.com/ACINQ/eclair-kmp/issues?q=is%3Aissue+label%3A"feature+request").
+You can also use Github issues for [feature requests](https://github.com/ACINQ/lightning-kmp/issues?q=is%3Aissue+label%3A"feature+request").
 
 ## Recommended Reading
 
@@ -35,7 +35,7 @@ You can also use Github issues for [feature requests](https://github.com/ACINQ/e
 
 ## Recommended Skillset
 
-Eclair KMP uses [Kotlin Multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html) with [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html).
+lightning-kmp uses [Kotlin Multiplatform](https://kotlinlang.org/docs/reference/multiplatform.html) with [Kotlin Coroutines](https://kotlinlang.org/docs/reference/coroutines-overview.html).
 Good understanding of these technologies is required to contribute.
 There are a lot of good resources online to learn about them.
 
@@ -78,7 +78,7 @@ made between versions (since Github doesn't easily show prior versions) and it m
 the PR author as they can set it to auto-squash the fixup commits on rebase.
 
 It's recommended to take great care in writing tests and ensuring the entire test suite has a
-stable successful outcome; eclair uses continuous integration techniques and having a stable build
+stable successful outcome; lightning-kmp uses continuous integration techniques and having a stable build
 helps the reviewers with their job.
 
 Contributors should follow the default Kotlin coding style guide. If you use IntelliJ:
@@ -96,7 +96,7 @@ You can find setup instructions [here](https://help.github.com/en/github/authent
 
 ### Commit Message
 
-Eclair keeps a clean commit history on the master branch with well-formed commit messages.
+lightning-kmp keeps a clean commit history on the master branch with well-formed commit messages.
 
 Here is a model Git commit message:
 

README.md

@@ -1,7 +1,7 @@
 [![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
 [![Gitter chat](https://img.shields.io/badge/chat-on%20gitter-red.svg)](https://gitter.im/ACINQ/developers)
 
-**Eclair-kmp** is a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) implementation of the Lightning Network optimized for mobile wallets.
+**lightning-kmp** is a [Kotlin Multiplatform](https://kotlinlang.org/docs/multiplatform.html) implementation of the Lightning Network optimized for mobile wallets.
 It can run on many different platforms, including mobile devices (iOS and Android).
 
 This software implements the [Lightning Network Specifications (BOLTs)](https://github.com/lightningnetwork/lightning-rfc).
@@ -19,15 +19,15 @@ Read [this article](https://medium.com/@ACINQ/when-ios-cdf798d5f8ef) for more de
 
 ## Installation
 
-See instructions [here](https://github.com/ACINQ/eclair-kmp/blob/master/BUILD.md) to build and test the library.
+See instructions [here](https://github.com/ACINQ/lightning-kmp/blob/master/BUILD.md) to build and test the library.
 
 ## Contributing
 
 We use GitHub for bug tracking. Search the existing issues for your bug and create a new one if needed.
 
 Contribute to the project by submitting pull requests.
 Review is done by members of the ACINQ team.
-Please read the guidelines [here](https://github.com/ACINQ/eclair-kmp/blob/master/CONTRIBUTING.md).
+Please read the guidelines [here](https://github.com/ACINQ/lightning-kmp/blob/master/CONTRIBUTING.md).
 
 ## Resources
 

build.gradle.kts

@@ -8,8 +8,8 @@ plugins {
 }
 
 allprojects {
-    group = "fr.acinq.eclair"
-    version = "1.0-beta10"
+    group = "fr.acinq.lightning"
+    version = "snapshot"
 
     repositories {
         mavenLocal()
@@ -48,7 +48,7 @@ kotlin {
             implementation(kotlin("test-common"))
             implementation(kotlin("test-annotations-common"))
             implementation("org.kodein.memory:kodein-memory-files:0.4.1")
-            implementation(project(":eclair-kmp-test-fixtures"))
+            implementation(project(":lightning-kmp-test-fixtures"))
         }
     }
 

docker-local-test/TESTING.md

@@ -1,8 +1,6 @@
 # Manual tests with Docker
 
-`eclair-kmp` includes a simple `Node` test program that simulates a Phoenix can and can be used to test against local eclair nodes. To run it just start `Node` in the `jvmTest` package. It will start an `eclair-kmp` node, connect it to a
-hardcoded `eclair` node (that must already be running)
-and read and parse text inputs from Idea's console.
+This project includes a simple `Node` test program that runs a lightning-kmp node and test it against local [eclair](https://github.com/ACINQ/eclair) nodes (eclair is our reference implementation). To run it just start `Node` in the `jvmTest` package. It will start a lightning-kmp node, connect it to a hardcoded [eclair](https://github.com/ACINQ/eclair) node (that must already be running), and read and parse text inputs from Idea's console.
 
 Tests use a small docker environment:
 
@@ -11,10 +9,10 @@ Tests use a small docker environment:
 - a bitcoind container
 - 2 eclair containers, nodes A and B
 
-For testing, A simulates horizon/endurance and B simulates a node we want to exchange payments with.
+For testing, A simulates the endurance node, and B simulates a node we want to exchange payments with.
 
 ```
- B <--> A <--> eclair-kmp
+ B <--> A <--> lightning-kmp
 
 ```
 
@@ -42,13 +40,13 @@ $ ./env.sh btc-start elx-start
 
 You can check that they're running with `./env.sh btc-logs` and `./env.sh elx-logs`
 
-## Start eclair nodes
+## Start the two eclair nodes (`node A` and `node B`)
 
 ```
 $ ./env.sh ecl-start 
 ```
 
-You can check that they're running properly and start using their APIss:
+You can check that they're running properly and start using their APIs:
 
 ```
 $ docker exec eclair-nodeA ./eclair-cli -p foobar getinfo
@@ -62,9 +60,9 @@ $ docker exec eclair-nodeB ./eclair-cli -p foobar connect --uri=039dc0e0b1d25905
 $ docker exec eclair-nodeB ./eclair-cli -p foobar open --nodeId=039dc0e0b1d25905e44fdf6f8e89755a5e219685840d0bc1d28d3308f9628a3585 --fundingSatoshis=200000 --pushMsat=50000000
 ```
 
-## Start eclair-kmp
+## Start lightning-kmp
 
-From Idea, start the `Node` class in `jvmTest`. It should automatically connect to node A. Get your eclair-kmp node Id from the console logs and open a channel from node A:
+From Idea, start the `Node` class in `jvmTest`. It should automatically connect to node A. Get your lightning-kmp node id from the console logs and open a channel from node A:
 
 ```
 docker exec eclair-nodeA ./eclair-cli -p foobar open --nodeId=03af0ed6052cf28d670665549bc86f4b721c9fdb309d40c58f5811f63966e005d0 --fundingSatoshis=200000 --pushMsat=50000000
@@ -90,4 +88,4 @@ Generate a payment request on node B:
 docker exec eclair-nodeB ./eclair-cli -p foobar createinvoice --description=test --amountMsat=50000
 ```
 
-In the Idea console, type `pay` and paste the generated payment request
+In the Idea console, type `pay` and paste the generated payment request.