Merge pull request #27 from guggero/grub

Grand unified binary

Author: Roasbeef

.dockerignore

@@ -0,0 +1,4 @@
+app/build
+app/coverage
+app/node_modules
+shushtar-debug

.gitignore

@@ -3,4 +3,10 @@ https.cert
 https.key
 
 # local environment vars to ignore
-.env*.local
+.env*.local
+
+shushtar-debug
+/shushtar-*
+
+# go code generated by statik
+/statik/statik.go

Dockerfile

@@ -0,0 +1,58 @@
+FROM golang:1.13-alpine as builder
+
+# Copy in the local repository to build from.
+COPY . /go/src/github.com/lightninglabs/shushtar
+
+# Force Go to use the cgo based DNS resolver. This is required to ensure DNS
+# queries required to connect to linked containers succeed.
+ENV GODEBUG netdns=cgo
+
+# Explicitly turn on the use of modules (until this becomes the default).
+ENV GO111MODULE on
+
+ENV NODE_VERSION=v12.17.0
+
+# Install dependencies and install/build shushtar.
+RUN apk add --no-cache --update alpine-sdk \
+    git \
+    make \
+    curl \
+    bash \
+    binutils \
+    tar \
+&& touch ~/.bashrc \
+&& curl -sfSLO https://unofficial-builds.nodejs.org/download/release/${NODE_VERSION}/node-${NODE_VERSION}-linux-x64-musl.tar.xz \
+&& tar -xf node-${NODE_VERSION}-linux-x64-musl.tar.xz -C /usr --strip 1 \
+&& rm node-${NODE_VERSION}-linux-x64-musl.tar.xz \
+&& curl -o- -L https://yarnpkg.com/install.sh | bash \
+&& /bin/bash \
+&& . ~/.bashrc \
+&&  cd /go/src/github.com/lightninglabs/shushtar \
+&&  make install \
+&& go install -v -trimpath github.com/lightningnetwork/lnd/cmd/lncli \
+&& go install -v -trimpath github.com/lightninglabs/faraday/cmd/frcli \
+&& go install -v -trimpath github.com/lightninglabs/loop/cmd/loop
+
+# Start a new, final image to reduce size.
+FROM alpine as final
+
+# Define a root volume for data persistence.
+VOLUME /root/.lnd
+
+# Expose shushtar and lnd ports (server, rpc).
+EXPOSE 8443 10009 9735
+
+# Copy the binaries and entrypoint from the builder image.
+COPY --from=builder /go/bin/shushtar /bin/
+COPY --from=builder /go/bin/lncli /bin/
+COPY --from=builder /go/bin/frcli /bin/
+COPY --from=builder /go/bin/loop /bin/
+
+# Add bash.
+RUN apk add --no-cache \
+    bash \
+    jq \
+    ca-certificates
+
+# Specify the start command and entrypoint as the shushtar daemon.
+ENTRYPOINT ["shushtar"]

Makefile

@@ -0,0 +1,183 @@
+PKG := github.com/lightninglabs/shushtar
+ESCPKG := github.com\/lightninglabs\/shushtar
+LND_PKG := github.com/lightningnetwork/lnd
+
+LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint
+GOVERALLS_PKG := github.com/mattn/goveralls
+GOACC_PKG := github.com/ory/go-acc
+STATIK_PKG := github.com/rakyll/statik
+
+GO_BIN := ${GOPATH}/bin
+GOVERALLS_BIN := $(GO_BIN)/goveralls
+LINT_BIN := $(GO_BIN)/golangci-lint
+GOACC_BIN := $(GO_BIN)/go-acc
+STATIK_BIN := $(GO_BIN)/statik
+
+COMMIT := $(shell git describe --abbrev=40 --dirty --tags)
+
+LINT_COMMIT := v1.18.0
+GOACC_COMMIT := ddc355013f90fea78d83d3a6c71f1d37ac07ecd5
+
+DEPGET := cd /tmp && GO111MODULE=on go get -v
+GOBUILD := GO111MODULE=on go build -v
+GOINSTALL := GO111MODULE=on go install -v
+GOTEST := GO111MODULE=on go test -v
+GOMOD := GO111MODULE=on go mod
+
+GOFILES_NOVENDOR = $(shell find . -type f -name '*.go' -not -path "./vendor/*")
+GOLIST := go list -deps $(PKG)/... | grep '$(PKG)'| grep -v '/vendor/'
+GOLISTCOVER := $(shell go list -deps -f '{{.ImportPath}}' ./... | grep '$(PKG)' | sed -e 's/^$(ESCPKG)/./')
+
+RM := rm -f
+CP := cp
+MAKE := make
+XARGS := xargs -L 1
+
+LINT = $(LINT_BIN) run -v
+
+include make/release_flags.mk
+
+# We only return the part inside the double quote here to avoid escape issues
+# when calling the external release script. The second parameter can be used to
+# add additional ldflags if needed (currently only used for the release).
+make_ldflags = $(2) -X $(LND_PKG)/build.Commit=$(COMMIT) \
+	-X $(LND_PKG)/build.CommitHash=$(COMMIT_HASH) \
+	-X $(LND_PKG)/build.GoVersion=$(GOVERSION) \
+	-X $(LND_PKG)/build.RawTags=$(shell echo $(1) | sed -e 's/ /,/g')
+
+LDFLAGS := $(call make_ldflags, $(LND_RELEASE_TAGS))
+
+# For the release, we want to remove the symbol table and debug information (-s)
+# and omit the DWARF symbol table (-w). Also we clear the build ID.
+RELEASE_LDFLAGS := $(call make_ldflags, $(LND_RELEASE_TAGS), -s -w -buildid=)
+
+GREEN := "\\033[0;32m"
+NC := "\\033[0m"
+define print
+	echo $(GREEN)$1$(NC)
+endef
+
+default: scratch
+
+all: scratch check install
+
+# ============
+# DEPENDENCIES
+# ============
+
+$(GOVERALLS_BIN):
+	@$(call print, "Fetching goveralls.")
+	go get -u $(GOVERALLS_PKG)
+
+$(LINT_BIN):
+	@$(call print, "Fetching linter")
+	$(DEPGET) $(LINT_PKG)@$(LINT_COMMIT)
+
+$(GOACC_BIN):
+	@$(call print, "Fetching go-acc")
+	$(DEPGET) $(GOACC_PKG)@$(GOACC_COMMIT)
+
+$(STATIK_BIN):
+	@$(call print, "Fetching statik")
+	$(DEPGET) $(STATIK_PKG)
+
+yarn-install:
+	@$(call print, "Installing app dependencies with yarn")
+	cd app; yarn
+
+# ============
+# INSTALLATION
+# ============
+statik-build: $(STATIK_BIN) app-build
+	@$(call print, "Building statik package.")
+	statik -src=app/build
+
+build: statik-build go-build
+install: statik-build go-install
+
+go-build:
+	@$(call print, "Building shushtar.")
+	$(GOBUILD) -tags="$(LND_RELEASE_TAGS)" -ldflags "$(LDFLAGS)" -o shushtar-debug $(PKG)/cmd/shushtar
+
+go-install:
+	@$(call print, "Installing shushtar.")
+	$(GOINSTALL) -tags="$(LND_RELEASE_TAGS)" -ldflags "$(LDFLAGS)" $(PKG)/cmd/shushtar
+
+app-build: yarn-install
+	@$(call print, "Building production app.")
+	cd app; yarn build
+
+release: statik-build
+	@$(call print, "Creating release of shushtar.")
+	./release.sh build-release "$(VERSION_TAG)" "$(BUILD_SYSTEM)" "$(LND_RELEASE_TAGS)" "$(RELEASE_LDFLAGS)"
+
+scratch: build
+
+# =======
+# TESTING
+# =======
+
+check: unit
+
+unit:
+	@$(call print, "Running unit tests.")
+	$(UNIT)
+
+unit-cover: $(GOACC_BIN)
+	@$(call print, "Running unit coverage tests.")
+	$(GOACC_BIN) $(COVER_PKG)
+
+unit-race:
+	@$(call print, "Running unit race tests.")
+	env CGO_ENABLED=1 GORACE="history_size=7 halt_on_errors=1" $(UNIT_RACE)
+
+goveralls: $(GOVERALLS_BIN)
+	@$(call print, "Sending coverage report.")
+	$(GOVERALLS_BIN) -coverprofile=coverage.txt -service=travis-ci
+
+travis-race: lint unit-race
+
+travis-cover: lint unit-cover goveralls
+
+travis-itest: lint
+
+
+# =============
+# FLAKE HUNTING
+# =============
+flake-unit:
+	@$(call print, "Flake hunting unit tests.")
+	while [ $$? -eq 0 ]; do GOTRACEBACK=all $(UNIT) -count=1; done
+
+# =========
+# UTILITIES
+# =========
+fmt:
+	@$(call print, "Formatting source.")
+	gofmt -l -w -s $(GOFILES_NOVENDOR)
+
+lint: $(LINT_BIN)
+	@$(call print, "Linting source.")
+	$(LINT)
+
+mod:
+	@$(call print, "Tidying modules.")
+	$(GOMOD) tidy
+
+mod-check:
+	@$(call print, "Checking modules.")
+	$(GOMOD) tidy
+	if test -n "$$(git status | grep -e "go.mod\|go.sum")"; then echo "Running go mod tidy changes go.mod/go.sum"; git status; git diff; exit 1; fi
+
+list:
+	@$(call print, "Listing commands.")
+	@$(MAKE)  -qp | \
+		awk -F':' '/^[a-zA-Z0-9][^$$#\/\t=]*:([^=]|$$)/ {split($$1,A,/ /);for(i in A)print A[i]}' | \
+		grep -v Makefile | \
+		sort
+
+clean:
+	@$(call print, "Cleaning source.$(NC)")
+	$(RM) ./shushtar-debug
+	$(RM) coverage.txt
+	$(RM) -r statik

README.md

@@ -6,13 +6,6 @@ Requirements: [Go](https://golang.org/doc/install), [protoc](https://github.com/
 
 ## One-time Setup
 
-Create certificate for browser to backend proxy communication
-
-```
-openssl genrsa -out https.key 2048
-openssl req -new -x509 -key https.key -out https.cert -days 365
-```
-
 Install client app dependencies
 
 ```sh
@@ -23,16 +16,7 @@ yarn
 
 ## Development
 
-- Spin up a local regtest env with nautilus and loopd (See [docker-regtest](https://github.com/lightninglabs/dev-resources/tree/master/docker-regtest))
-- Create a `.env.local` file in the `app/` directory with the following content. Replace `<macaroon>` with the HEX encoded admin.macaroon of the LND node to connect to
-  ```
-  REACT_APP_DEV_MACAROON=<macaroon>
-  REACT_APP_DEV_HOST=http://localhost:3000
-  ```
-- Start backend server, updating the ports for the LND and Loop nodes if necessary
-  ```sh
-  go run . --lndhost=localhost:10011 --loophost=localhost:11010
-  ```
+- Compile and start the GrUB (see [Run the GrUB](#run-the-grub))
 - Run the client app in a separate terminal
   ```sh
   cd app
@@ -79,3 +63,33 @@ The value for `debug` is a namespace filter which determines which portions of t
 Example filters: `main,action` will only log main and action messages. `*,-action` will log everything except action messages.
 
 The value for `debug-level` determines the verbosity of the logs. The value can be one of `debug`, `info`, `warn`, or `error`.
+
+# Run the GrUB
+
+- Compile the GrUB binary:
+  ```sh
+  make build
+  ```
+- Start the GrUB binary. The following is an example for testnet that starts an
+  lnd node called `zane` on port `10020` (REST: `8100`), change this to your
+  needs:
+  ```sh
+  ./shushtar-debug \
+    --httpslisten=8443 \
+    --lnd.lnddir=/home/$USER/.lnd-dev-zane \
+    --lnd.alias=zane \
+    --lnd.noseedbackup \
+    --lnd.rpclisten=localhost:10020 \
+    --lnd.listen=0.0.0.0:9750 \
+    --lnd.restlisten=localhost:8100 \
+    --lnd.bitcoin.active \
+    --lnd.bitcoin.testnet \
+    --lnd.bitcoin.node=bitcoind \
+    --lnd.bitcoind.rpchost=localhost \
+    --lnd.bitcoind.rpcuser=lightning \
+    --lnd.bitcoind.rpcpass=lightning \
+    --lnd.bitcoind.zmqpubrawblock=localhost:28332 \
+    --lnd.bitcoind.zmqpubrawtx=localhost:28333 \
+    --lnd.debuglevel=debug
+  ```
+- You can now access the web interface on https://localhost:8443

app/src/api/lnd.ts

@@ -1,16 +1,11 @@
 import * as LND from 'types/generated/lnd_pb';
 import { Lightning } from 'types/generated/lnd_pb_service';
-import { DEV_MACAROON } from 'config';
 import GrpcClient from './grpc';
 
 /**
  * An API wrapper to communicate with the LND node via GRPC
  */
 class LndApi {
-  _meta = {
-    'X-Grpc-Backend': 'lnd',
-    macaroon: DEV_MACAROON,
-  };
 
   private _grpc: GrpcClient;
 
@@ -23,7 +18,7 @@ class LndApi {
    */
   async getInfo(): Promise<LND.GetInfoResponse.AsObject> {
     const req = new LND.GetInfoRequest();
-    const res = await this._grpc.request(Lightning.GetInfo, req, this._meta);
+    const res = await this._grpc.request(Lightning.GetInfo, req);
     return res.toObject();
   }
 
@@ -32,7 +27,7 @@ class LndApi {
    */
   async channelBalance(): Promise<LND.ChannelBalanceResponse.AsObject> {
     const req = new LND.ChannelBalanceRequest();
-    const res = await this._grpc.request(Lightning.ChannelBalance, req, this._meta);
+    const res = await this._grpc.request(Lightning.ChannelBalance, req);
     return res.toObject();
   }
 
@@ -41,7 +36,7 @@ class LndApi {
    */
   async walletBalance(): Promise<LND.WalletBalanceResponse.AsObject> {
     const req = new LND.WalletBalanceRequest();
-    const res = await this._grpc.request(Lightning.WalletBalance, req, this._meta);
+    const res = await this._grpc.request(Lightning.WalletBalance, req);
     return res.toObject();
   }
 
@@ -50,7 +45,7 @@ class LndApi {
    */
   async listChannels(): Promise<LND.ListChannelsResponse.AsObject> {
     const req = new LND.ListChannelsRequest();
-    const res = await this._grpc.request(Lightning.ListChannels, req, this._meta);
+    const res = await this._grpc.request(Lightning.ListChannels, req);
     return res.toObject();
   }
 }