mirrors/lnd
1
0
Fork 0
mirror of https://github.com/lightningnetwork/lnd.git synced 2025-03-04 17:55:36 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #9287 from Abhinav-Bansal751/master

Browse source 
Update docs/grpc/python.md and ruby.md
This commit is contained in:
Oliver Gugger 2024-11-29 09:30:07 +01:00 • committed by GitHub
commit f2d9868906
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 8 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/grpc/python.md
View file

@ -17,25 +17,20 @@ file in Python before you can use it to communicate with lnd.
```shell
$ source lnd/bin/activate
```
3. Install dependencies (googleapis-common-protos is required due to the use of
google/api/annotations.proto)
3. Install dependencies
```shell
lnd $ pip install grpcio grpcio-tools googleapis-common-protos mypy-protobuf
lnd $ pip install grpcio-tools
```
4. Clone the google api's repository (required due to the use of
google/api/annotations.proto)
```shell
lnd $ git clone https://github.com/googleapis/googleapis.git
```
5. Copy the lnd lightning.proto file (you'll find this at
4. 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 lightning.proto -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/lightning.proto
```
6. Compile the proto file
5. Compile the proto file
```shell
lnd $ python -m grpc_tools.protoc --proto_path=googleapis:. --mypy_out=. --python_out=. --grpc_python_out=. lightning.proto
lnd $ python -m grpc_tools.protoc --proto_path=. --python_out=. --grpc_python_out=. lightning.proto
```
After following these steps, three files `lightning_pb2.py`,
@ -53,7 +48,7 @@ extra steps (after completing all 6 step described above) to get the
```shell
lnd $ curl -o router.proto -s https://raw.githubusercontent.com/lightningnetwork/lnd/master/lnrpc/routerrpc/router.proto
lnd $ python -m grpc_tools.protoc --proto_path=googleapis:. --mypy_out=. --python_out=. --grpc_python_out=. router.proto
lnd $ python -m grpc_tools.protoc --proto_path=. --python_out=. --grpc_python_out=. router.proto
```
### Imports and Client

6
docs/grpc/ruby.md
View file

@ -19,11 +19,7 @@ $ gem install grpc
$ gem install grpc-tools
```
Clone the Google APIs repository:
```shell
$ git clone https://github.com/googleapis/googleapis.git
```
Fetch the `lightning.proto` file (or copy it from your local source directory):
@ -34,7 +30,7 @@ $ curl -o lightning.proto -s https://raw.githubusercontent.com/lightningnetwork
Compile the proto file:
```shell
$ grpc_tools_ruby_protoc --proto_path googleapis:. --ruby_out=. --grpc_out=. lightning.proto
$ grpc_tools_ruby_protoc --ruby_out=. --grpc_out=. lightning.proto
```
Two files will be generated in the current directory: