Skip to content

Commit 733eecb

Browse files
committed
adding all supported services
1 parent 043be14 commit 733eecb

21 files changed

+1347
-24
lines changed

README.md

+20
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ This is a low-level client library. For a better experience, you may want to che
66

77
- [Usage](#usage)
88
- [Documentation](https://icebaker.github.io/lnd-client)
9+
- [Available Supported Services][#available-supported-services]
910
- [Development](#development)
1011
- [Upgrading gRPC Proto Files](#upgrading-grpc-proto-files)
1112
- [Generating Documentation](#generating-documentation)
@@ -56,6 +57,25 @@ end
5657

5758
Check the [full documentation](https://icebaker.github.io/lnd-client).
5859

60+
## Available Supported Services
61+
62+
- [autopilot](https://icebaker.github.io/lnd-client/#/README?id=autopilot)
63+
- [chain_kit](https://icebaker.github.io/lnd-client/#/README?id=chain_kit)
64+
- [chain_notifier](https://icebaker.github.io/lnd-client/#/README?id=chain_notifier)
65+
- [dev](https://icebaker.github.io/lnd-client/#/README?id=dev)
66+
- [invoices](https://icebaker.github.io/lnd-client/#/README?id=invoices)
67+
- [lightning](https://icebaker.github.io/lnd-client/#/README?id=lightning)
68+
- [neutrino_kit](https://icebaker.github.io/lnd-client/#/README?id=neutrino_kit)
69+
- [peers](https://icebaker.github.io/lnd-client/#/README?id=peers)
70+
- [router](https://icebaker.github.io/lnd-client/#/README?id=router)
71+
- [signer](https://icebaker.github.io/lnd-client/#/README?id=signer)
72+
- [state](https://icebaker.github.io/lnd-client/#/README?id=state)
73+
- [versioner](https://icebaker.github.io/lnd-client/#/README?id=versioner)
74+
- [wallet_kit](https://icebaker.github.io/lnd-client/#/README?id=wallet_kit)
75+
- [wallet_unlocker](https://icebaker.github.io/lnd-client/#/README?id=wallet_unlocker)
76+
- [watchtower](https://icebaker.github.io/lnd-client/#/README?id=watchtower)
77+
- [watchtower_client](https://icebaker.github.io/lnd-client/#/README?id=watchtower_client)
78+
5979
## Development
6080

6181
Copy the `.env.example` file to `.env` and provide the required data.

components/grpc.rb

+29-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,41 @@
11
# frozen_string_literal: true
22

3+
require_relative './grpc/autopilotrpc/autopilot_services_pb'
4+
require_relative './grpc/chainrpc/chainkit_services_pb'
5+
require_relative './grpc/chainrpc/chainnotifier_services_pb'
6+
require_relative './grpc/devrpc/dev_services_pb'
7+
require_relative './grpc/invoicesrpc/invoices_services_pb'
38
require_relative './grpc/lightning_services_pb'
9+
require_relative './grpc/neutrinorpc/neutrino_services_pb'
10+
require_relative './grpc/peersrpc/peers_services_pb'
411
require_relative './grpc/routerrpc/router_services_pb'
12+
require_relative './grpc/signrpc/signer_services_pb'
13+
require_relative './grpc/stateservice_services_pb'
14+
require_relative './grpc/verrpc/verrpc_services_pb'
15+
require_relative './grpc/walletrpc/walletkit_services_pb'
16+
require_relative './grpc/walletunlocker_services_pb'
17+
require_relative './grpc/watchtowerrpc/watchtower_services_pb'
18+
require_relative './grpc/wtclientrpc/wtclient_services_pb'
519

620
module LNDClientInternal
721
module GRPC
822
SERVICES = {
23+
autopilot: Autopilotrpc::Autopilot,
24+
chain_kit: Chainrpc::ChainKit,
25+
chain_notifier: Chainrpc::ChainNotifier,
26+
dev: Devrpc::Dev,
27+
invoices: Invoicesrpc::Invoices,
928
lightning: Lnrpc::Lightning,
10-
router: Routerrpc::Router
29+
neutrino_kit: Neutrinorpc::NeutrinoKit,
30+
peers: Peersrpc::Peers,
31+
router: Routerrpc::Router,
32+
signer: Signrpc::Signer,
33+
state: Lnrpc::State,
34+
versioner: Verrpc::Versioner,
35+
wallet_kit: Walletrpc::WalletKit,
36+
wallet_unlocker: Lnrpc::WalletUnlocker,
37+
watchtower: Watchtowerrpc::Watchtower,
38+
watchtower_client: Wtclientrpc::WatchtowerClient
1139
}.freeze
1240
end
1341
end

components/grpc/autopilotrpc/autopilot_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/chainrpc/chainkit_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/chainrpc/chainnotifier_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/devrpc/dev_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/devrpc/dev_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/invoicesrpc/invoices_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/invoicesrpc/invoices_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/lnclipb/lncli_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/neutrinorpc/neutrino_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/peersrpc/peers_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/peersrpc/peers_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/signrpc/signer_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/verrpc/verrpc_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/walletrpc/walletkit_pb.rb

+2-2
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/walletrpc/walletkit_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/watchtowerrpc/watchtower_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

components/grpc/wtclientrpc/wtclient_services_pb.rb

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

controllers/documentation.rb

+20-5
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ class DocumentationController
1010
PROGRESS = true
1111
PATH = 'docs/README.md'
1212
KEY = '<!-- [INJECT:GRP:DOCS] -->'
13+
KEY_INDEX = '<!-- [INJECT:GRP:INDEX] -->'
1314

1415
attr_reader :available_methods
1516

@@ -35,6 +36,18 @@ def self.generate!
3536
progressbar = ProgressBar.create(total: total, format: '%a %e |%b>>%i| %P% | %c of %C')
3637
end
3738

39+
document = File.read(PATH)
40+
41+
content = ''
42+
43+
services.each do |service|
44+
content += "- [#{service}](?id=#{service})\n"
45+
end
46+
47+
parts = document.split(KEY_INDEX)
48+
49+
document = "#{parts[0]}#{KEY_INDEX}\n\n#{content}\n#{KEY_INDEX}#{parts[2]}"
50+
3851
content = ''
3952

4053
services.each do |service|
@@ -44,9 +57,11 @@ def self.generate!
4457
doc.available_methods.each do |method_name|
4558
content += "\n### #{method_name}\n"
4659

47-
url = "https://lightning.engineering/api-docs/api/lnd/#{service}/#{method_name.gsub('_', '-')}/index.html"
60+
url = "https://lightning.engineering/api-docs/api/lnd/#{service.to_s.gsub('_',
61+
'-')}/#{method_name.gsub('_',
62+
'-')}/index.html"
4863

49-
content += "\n[lightning.engineering/#{service}/#{method_name.gsub('_', '-')}](#{url})\n"
64+
content += "\n[lightning.engineering/#{service.to_s.gsub('_', '-')}/#{method_name.gsub('_', '-')}](#{url})\n"
5065

5166
description = doc.describe(method_name)
5267
content += "\n```ruby\n"
@@ -74,11 +89,11 @@ def self.generate!
7489
end
7590
end
7691

77-
document = File.read(PATH)
78-
7992
parts = document.split(KEY)
8093

81-
File.write(PATH, "#{parts[0]}#{KEY}\n\n#{content}\n#{KEY}#{parts[2]}")
94+
document = "#{parts[0]}#{KEY}\n\n#{content}\n#{KEY}#{parts[2]}"
95+
96+
File.write(PATH, document)
8297

8398
progressbar.finish
8499

0 commit comments

Comments
 (0)