Skip to content

Update lnd documentation #746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 30, 2024
Merged

Update lnd documentation #746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 7 additions & 12 deletions docs/lnd/grpc/python.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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`,
Expand All @@ -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
Expand Down
6 changes: 1 addition & 5 deletions docs/lnd/grpc/ruby.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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):

Expand All @@ -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:
Expand Down
3 changes: 3 additions & 0 deletions docs/lnd/release-notes/release-notes-0.19.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@
* [Make the contract resolutions for the channel arbitrator optional](
https://github.com/lightningnetwork/lnd/pull/9253)

* [Fixed a bug](https://github.com/lightningnetwork/lnd/pull/9322) that caused
estimateroutefee to ignore the default payment timeout.

# New Features

* [Support](https://github.com/lightningnetwork/lnd/pull/8390) for
Expand Down