Merge pull request #145 from guggero/json-stubs

frdrpc: add JSON/WASM client stubs for LNC, move server code into own package

.github/workflows/main.yml

@@ -50,6 +50,9 @@ jobs:
 
       - name: run imports check
         run: make imports
+
+      - name: run JS stubs check
+        run: make rpc-js-compile
 
   ########################
   # lint code

Makefile

@@ -156,6 +156,10 @@ rpc-format:
 	@$(call print, "Formatting protos.")
 	cd ./frdrpc; find . -name "*.proto" | xargs clang-format --style=file -i
 
+rpc-js-compile:
+	@$(call print, "Compiling JSON/WASM stubs.")
+	GOOS=js GOARCH=wasm $(GOBUILD) $(PKG)/frdrpc
+
 list:
 	@$(call print, "Listing commands.")
 	@$(MAKE)  -qp | \

faraday.go

@@ -14,7 +14,7 @@ import (
 	"github.com/lightningnetwork/lnd/signal"
 
 	"github.com/lightninglabs/faraday/chain"
-	"github.com/lightninglabs/faraday/frdrpc"
+	"github.com/lightninglabs/faraday/frdrpcserver"
 )
 
 // MinLndVersion is the minimum lnd version required. Note that apis that are
@@ -85,7 +85,7 @@ func Main() error {
 	defer client.Close()
 
 	// Instantiate the faraday gRPC server.
-	cfg := &frdrpc.Config{
+	cfg := &frdrpcserver.Config{
 		Lnd:              client.LndServices,
 		RPCListen:        config.RPCListen,
 		RESTListen:       config.RESTListen,
@@ -104,7 +104,7 @@ func Main() error {
 		}
 	}
 
-	server := frdrpc.NewRPCServer(cfg)
+	server := frdrpcserver.NewRPCServer(cfg)
 
 	// Start the server.
 	if err := server.Start(); err != nil {

frdrpc/Dockerfile

@@ -12,6 +12,7 @@ ARG PROTOBUF_VERSION
 ARG GRPC_GATEWAY_VERSION
 
 ENV PROTOC_GEN_GO_GRPC_VERSION="v1.1.0"
+ENV FALAFEL_VERSION="v0.9.1"
 ENV GOCACHE=/tmp/build/.cache
 ENV GOMODCACHE=/tmp/build/.modcache
 
@@ -23,6 +24,7 @@ RUN cd /tmp \
   && go get google.golang.org/grpc/cmd/protoc-gen-go-grpc@${PROTOC_GEN_GO_GRPC_VERSION} \
   && go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway@${GRPC_GATEWAY_VERSION} \
   && go get github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@${GRPC_GATEWAY_VERSION} \
+  && go get github.com/lightninglabs/falafel@${FALAFEL_VERSION} \
   && chmod -R 777 /tmp/build/
 
 WORKDIR /build

frdrpc/doc.go

@@ -0,0 +1,3 @@
+// Package frdrpc contains the proto files and generated code for faraday's
+// grpc server which serves requests for close recommendations.
+package frdrpc

frdrpc/gen_protos.sh

@@ -27,6 +27,16 @@ function generate() {
     --openapiv2_opt grpc_api_configuration=faraday.yaml \
     --openapiv2_opt json_names_for_fields=false \
     faraday.proto
+
+  # Generate the JSON/WASM client stubs.
+  falafel=$(which falafel)
+  pkg="frdrpc"
+  opts="package_name=$pkg,api_prefix=1,js_stubs=1,build_tags=// +build js"
+  protoc -I/usr/local/include -I. -I.. \
+    --plugin=protoc-gen-custom=$falafel\
+    --custom_out=. \
+    --custom_opt="$opts" \
+    faraday.proto
 }
 
 # format formats the *.proto files with the clang-format utility.

frdrpc/channel_insights.go → frdrpcserver/channel_insights.go

@@ -1,9 +1,10 @@
-package frdrpc
+package frdrpcserver
 
 import (
 	"context"
 	"time"
 
+	"github.com/lightninglabs/faraday/frdrpc"
 	"github.com/lightninglabs/faraday/insights"
 	"github.com/lightninglabs/faraday/lndwrap"
 	"github.com/lightninglabs/faraday/revenue"
@@ -41,12 +42,12 @@ func channelInsights(ctx context.Context,
 }
 
 func rpcChannelInsightsResponse(
-	insights []*insights.ChannelInfo) *ChannelInsightsResponse {
+	insights []*insights.ChannelInfo) *frdrpc.ChannelInsightsResponse {
 
-	rpcInsights := make([]*ChannelInsight, 0, len(insights))
+	rpcInsights := make([]*frdrpc.ChannelInsight, 0, len(insights))
 
 	for _, i := range insights {
-		insight := &ChannelInsight{
+		insight := &frdrpc.ChannelInsight{
 			ChanPoint:          i.ChannelPoint,
 			MonitoredSeconds:   uint64(i.MonitoredFor.Seconds()),
 			UptimeSeconds:      uint64(i.Uptime.Seconds()),
@@ -60,5 +61,5 @@ func rpcChannelInsightsResponse(
 		rpcInsights = append(rpcInsights, insight)
 	}
 
-	return &ChannelInsightsResponse{ChannelInsights: rpcInsights}
+	return &frdrpc.ChannelInsightsResponse{ChannelInsights: rpcInsights}
 }