elra

README

E.L.R.A.

Easy LND REST API

ELRA is an open source REST extension for LND with a lot of additional features compared to LND's default REST or gRPC API built on Go.

Comparison

Build

Prerequisites

1. macOS
2. Install Go and Cross Compiler

brew install go 
brew install mingw-w64
brew install FiloSottile/musl-cross/musl-cross
brew reinstall FiloSottile/musl-cross/musl-cross --with-arm-hf

1. Set $GOPATH system environment
2. Get Go Dependencies

go get github.com/mattn/go-sqlite3
go get github.com/dgrijalva/jwt-go
go get github.com/gorilla/mux
go get github.com/golang/protobuf/proto
go get github.com/joncalhoun/qson
go get github.com/lightningnetwork/lnd/lnrpc
go get github.com/lightningnetwork/lnd/macaroons
go get golang.org/x/crypto/bcrypt
go get golang.org/x/sys/unix

1. Clone InventorizerAPI

cd %GOPATH/src
git clone https://github.com/JediWed/ELRA.git
cd ELRA

1. (Optional) Install and Start via PM2

npm install pm2@latest -g
pm2 start pm2-ELRA.json

Build

Command	Description
make	Builds executable. Binary can be found in dist/
make clean	Cleanup previous builds and releases
make serve	Build and start API
make release	Builds binaries for macOS, Windows, Linux and Raspberry Pi. Release builds can be found in release/

Build Releases on other Hosts than macOS

To Cross Compile on other Hosts (e.g. Windows or Linux) edit Makefile and replace CC Binaries with your installed Cross Compile Binaries.

License

ELRA is released under the terms of the GPL-3.0 license. See LICENSE for more information or see https://www.gnu.org/licenses/.