clightning4j / lamp

c-Lightning Android Mobile Porting
MIT License
20 stars 10 forks source link

:bulb: Lamp :zap:

:bulb: c-lightning Android Mobile Porting :zap:

GitHub Workflow Status (branch) GitHub release (latest SemVer) GitHub all releases GitHub

Table of Content

Introduction

This is an experimenting lightning wallet. Use it on testnet or only with amounts you can afford to lose on mainnet.

Touch the lamp to download and run c-lightning from cross-compiled binaries for Android are available here.

<img src="https://github.com/clightning4j/lamp/raw/master/doc/img/Screen2.png" width="230" height="350" />
<img src="https://github.com/clightning4j/lamp/raw/master/doc/img/Screen3.png" width="230" height="350" />

How to Use

Bitcoin Setup

Automatic with esplora plugin

This is the default behaviour.

Lamp is using the C Esplora plugin for C-lightning as the Bitcoin backend of the lightning node (to fetch chain/blocks/transactions information and send transactions).

You can point it to your own Esplora instance in the settings, and it uses blockstream.info by default.

Manually with bitcoind rpc node

On Lamp settings, disable Esplora plugin and set the current Bitcoin RPC options:

Tor Setup

Automatic with internal tor service

Lamp is using tor hidden service as default. A new hidden service will be created at the first running time.

Manually with Orbot

Open Orbot and setup a fixed tor address by menu: Onion Services -> Hosted Services -> set a service name and port 9735. Restarting tor to discover and copy the local address.

On Lamp settings, enable proxy using orbot localhost gateway:

Read the following instructions at Tor on clightning to setup address on different network scenario.

Building

How to Contribute

Just propose new stuff to add or bug fixing with a new PR.

Code Style

ktlint

We live in a world where robots can drive a car, so we shouldn't just write code, we should write elegant code.

This repository use ktlint to maintains the code of the repository elegant, so before submit the code check the Kotlin format with the following command on the root of the directory

./gradlew formatKotlin

References

License

c-lightning Android Mobile Porting

Copyright (c) 2019-2021 Luca Vaccaro

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.