mirrors/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-01-19 14:45:23 +01:00
Code Issues Projects Releases Wiki Activity

docs+python: fix headings, make numbered list

Browse Source
This commit is contained in:
Oliver Gugger 2020-05-04 09:52:49 +02:00
parent 20a776d703
commit 0bb449c8fe
No known key found for this signature in database
GPG Key ID: 8E4256593F177720
1 changed files with 32 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

64
docs/grpc/python.md
View File

@ -3,46 +3,46 @@
This section enumerates what you need to do to write a client that communicates
with `lnd` in Python.
### Setup and Installation
## Setup and Installation
Lnd uses the gRPC protocol for communication with clients like lncli. gRPC is
based on protocol buffers and as such, you will need to compile the lnd proto
file in Python before you can use it to communicate with lnd.
* Create a virtual environment for your project
```
$ virtualenv lnd
```
* Activate the virtual environment
```
$ source lnd/bin/activate
```
* Install dependencies (googleapis-common-protos is required due to the use of
1. Create a virtual environment for your project
```
$ virtualenv lnd
```
2. Activate the virtual environment
```
$ source lnd/bin/activate
```
3. Install dependencies (googleapis-common-protos is required due to the use of
google/api/annotations.proto)
```
(lnd)$ pip install grpcio grpcio-tools googleapis-common-protos
```
* Clone the google api's repository (required due to the use of
```
(lnd)$ pip install grpcio grpcio-tools googleapis-common-protos
```
4. Clone the google api's repository (required due to the use of
google/api/annotations.proto)
```
(lnd)$ git clone https://github.com/googleapis/googleapis.git
```
* Copy the lnd rpc.proto file (you'll find this at
```
(lnd)$ git clone https://github.com/googleapis/googleapis.git
```
5. Copy the lnd rpc.proto file (you'll find this at
[lnrpc/rpc.proto](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/rpc.proto))
or just download it
```
(lnd)$ curl -o rpc.proto -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/rpc.proto
```
* Compile the proto file
```
(lnd)$ python -m grpc_tools.protoc --proto_path=googleapis:. --python_out=. --grpc_python_out=. rpc.proto
```
```
(lnd)$ curl -o rpc.proto -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/rpc.proto
```
6. Compile the proto file
```
(lnd)$ python -m grpc_tools.protoc --proto_path=googleapis:. --python_out=. --grpc_python_out=. rpc.proto
```
After following these steps, two files `rpc_pb2.py` and `rpc_pb2_grpc.py` will
be generated. These files will be imported in your project anytime you use
Python gRPC.
#### Imports and Client
### Imports and Client
Every time you use Python gRPC, you will have to import the generated rpc modules
and set up a channel and stub to your connect to your `lnd` node:
@ -66,13 +66,13 @@ channel = grpc.secure_channel('localhost:10009', creds)
stub = lnrpc.LightningStub(channel)
```
### Examples
## Examples
Let's walk through some examples of Python gRPC clients. These examples assume
that you have at least two `lnd` nodes running, the RPC location of one of which
is at the default `localhost:10009`, with an open channel between the two nodes.
#### Simple RPC
### Simple RPC
```python
# Retrieve and display the wallet balance
@ -80,7 +80,7 @@ response = stub.WalletBalance(ln.WalletBalanceRequest())
print(response.total_balance)
```
#### Response-streaming RPC
### Response-streaming RPC
```python
request = ln.InvoiceSubscription()
@ -102,7 +102,7 @@ $ lncli sendpayment --pay_req=<PAY_REQ>
Your Python console should now display the details of the recently satisfied
invoice.
#### Bidirectional-streaming RPC
### Bidirectional-streaming RPC
```python
from time import sleep
@ -133,7 +133,7 @@ for payment in stub.SendPayment(request_iterable):
```
This example will send a payment of 100 satoshis every 2 seconds.
#### Using Macaroons
### Using Macaroons
To authenticate using macaroons you need to include the macaroon in the metadata of the request.
@ -180,7 +180,7 @@ stub.GetInfo(ln.GetInfoRequest())
```
### Conclusion
## Conclusion
With the above, you should have all the `lnd` related `gRPC` dependencies
installed locally into your virtual environment. In order to get up to speed