Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ndeet/php-ln-lnd-grpc
Lightning Network LND generated gRPC classes.
https://github.com/ndeet/php-ln-lnd-grpc
bitcoin grpc lightning-network lnd php-library
Last synced: 7 days ago
JSON representation
Lightning Network LND generated gRPC classes.
- Host: GitHub
- URL: https://github.com/ndeet/php-ln-lnd-grpc
- Owner: ndeet
- Created: 2018-03-16T22:46:18.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-10-15T07:56:12.000Z (about 3 years ago)
- Last Synced: 2023-09-16T12:27:19.674Z (about 1 year ago)
- Topics: bitcoin, grpc, lightning-network, lnd, php-library
- Language: PHP
- Size: 182 KB
- Stars: 6
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
PHP lnd gRPC client
===================
**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](https://github.com/lightningnetwork/lnd) version [0.5-beta](https://github.com/lightningnetwork/lnd/releases/tag/v0.5-beta). It is generated code
from [rpc.proto](https://github.com/lightningnetwork/lnd/blob/v0.5-beta/lnrpc/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](https://github.com/ndeet/php-ln-lnd-grpc/blob/master/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](https://grpc.io/docs/quickstart/php.html) and the `lnrpc` [readme](https://github.com/lightningnetwork/lnd/tree/v0.5-beta/lnrpc).
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](https://github.com/BitfuryLightning/php-lnd-grpc-client). Unfortunately they seem to have abandoned it and did not respond to issues/pull requests [#1](https://github.com/BitfuryLightning/php-lnd-grpc-client/issues/2) [#2](https://github.com/BitfuryLightning/php-lnd-grpc-client/pull/3) [#3](https://github.com/BitfuryLightning/php-lnd-grpc-client/pull/1). That's why this fork now lives here on its own.