Download the PHP package ndeet/ln-lnd-rest without Composer

On this page you can find all versions of the php package ndeet/ln-lnd-rest. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package ln-lnd-rest

LndRest

A Lightning Network Daemon (LND) package for LND's REST endpoints. PHP classes are generated by the Swagger Codegen project using LND's rpc.swagger.json

Requirements

PHP 7.1 and later

Installation & Usage

Composer

To install the bindings via Composer, use the following command:

Tests

To run the unit tests:

Getting Started

Note:

How to generate the code yourself

You can use swagger-codegen to create this whole package out of the rpc.swagger.json of LND. To do this you need swagger-codegen and (for this package as example) this lnrest-config.json:

You can generate the code by having the official lightningnetwork/lnd repo checked out to the tag you need and then use that rpc.swagger.json for the code genration like this.

Notice regarding to subscribeInvoices endpoint

The REST endpoints are generated from the same gRPC rpc.proto file and it seems the streaming does not work on REST services according to LND's lead developer @roasbeef. But they plan to provide Websockets in a future release. So you may need to do some custom long polling using lookupInvoice endpoint.

This are some autogenerated docs pointing to classes docs:

Documentation for API endpoints

Lightning API Endpoints
Wallet Unlocker API

Documentation for authorization

All endpoints do not require authorization. Make sure that those endpoints provided by this package are not publicly accessible. If you set a wallet password you need to unlock your wallet first, see documentation and example above.

Author

Andreas Tasch


All versions of ln-lnd-rest with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package ndeet/ln-lnd-rest contains the following files

Loading the files please wait ....