highperfocused/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-08-30 23:53:41 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs+lnrpc: rename rpc.proto to lightning.proto

Browse Source 
To avoid a naming conflict with etcd, we rename our very generic
rpc.proto to lightning.proto to match the service name that's declared
within. This will break many external tutorials and possibly also our
API docs but the change needs to be done eventually.
This commit is contained in:
Oliver Gugger
2021-07-27 12:59:56 +02:00
parent 62888894d2
commit 235efc04e4
20 changed files with 4241 additions and 4240 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/grpc/python.md
View File

@@ -27,20 +27,20 @@ file in Python before you can use it to communicate with lnd.
```shell
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))
5. Copy the lnd lightning.proto file (you'll find this at
[lnrpc/lightning.proto](https://github.com/lightningnetwork/lnd/blob/master/lnrpc/lightning.proto))
or just download it
```shell
lnd ⛰ curl -o rpc.proto -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/rpc.proto
lnd ⛰ curl -o lightning.proto -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/lightning.proto
```
6. Compile the proto file
```shell
lnd ⛰ python -m grpc_tools.protoc --proto_path=googleapis:. --python_out=. --grpc_python_out=. rpc.proto
lnd ⛰ python -m grpc_tools.protoc --proto_path=googleapis:. --python_out=. --grpc_python_out=. lightning.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.
After following these steps, two files `lightning_pb2.py` and
`lightning_pb2_grpc.py` will be generated. These files will be imported in your
project anytime you use Python gRPC.
### Generating RPC modules for subservers
@@ -63,8 +63,8 @@ Every time you use Python gRPC, you will have to import the generated rpc module
and set up a channel and stub to your connect to your `lnd` node:
```python
import rpc_pb2 as ln
import rpc_pb2_grpc as lnrpc
import lightning_pb2 as ln
import lightning_pb2_grpc as lnrpc
import grpc
import os