ndeet / ln-lnd-grpc
Lightning Network LND gRPC client for Bitcoin and other supported coins. The classes and client is generated from rpc.proto.
Requires
- php: >=7.0
- ext-grpc: >=0.1.0
- google/protobuf: ^3.3
- grpc/grpc: ^v1.1.0
README
This package has been abandoned, please use the better maintened one on lnpay here https://packagist.org/packages/lnpay/php-lnd-grpc.
This library is a gRPC client for lnd version 0.5-beta. It is generated code from rpc.proto.
Requirements
To use this library you need to
- gRPC extension
- PHP >= 7.0
Install gRPC extension if not installed
# pecl install grpc
Add grpc.so to php.ini. For PHP 7.0 in Ubuntu it will be
# echo 'extension=grpc.so' >> /etc/php/7.0/cli/php.ini
Adding to your project
Via composer
$ cd /project/
$ composer require ndeet/ln-lnd-grpc
Cloning from Git
$ cd /project/
$ git clone https://github.com/ndeet/php-ln-lnd-grpc.git lndrpc
$ cd ./lndrpc/
$ composer install
Example
Example of usage you can find in example/index.php. Note: This is currently untested with the latest lnd-0.5-beta release as time of committing but wanted to push the updated classes out.
Generation of PHP classes
As a primer to grpc and PHP see the official tutorial and the lnrpc readme.
The following command was used to generate the classes:
protoc -I/usr/local/include -I. -I$GOPATH/src -I$GOPATH/src/github.com/grpc-ecosystem/grpc-gateway/third_party/googleapis/ --php_out=src --grpc_out=src --plugin=protoc-gen-grpc=/usr/local/Cellar/grpc/1.14.2/bin/grpc_php_plugin rpc.proto
Credits
This is a fork of Bitfury Lighting gRPC PHP client. Unfortunately they seem to have abandoned it and did not respond to issues/pull requests #1 #2 #3. That's why this fork now lives here on its own.