'make protoc' now utilizes docker workflow by default. (Layr-Labs#748)

Signed-off-by: Cody Littley <[email protected]>

Makefile

@@ -17,37 +17,22 @@ endif
 
 RELEASE_TAG := $(or $(RELEASE_TAG),latest)
 
-PROTOS := ./api/proto
-PROTOS_DISPERSER := ./disperser/api/proto
-PROTO_GEN := ./api/grpc
-PROTO_GEN_DISPERSER_PATH = ./disperser/api/grpc
-
 compile-el:
 	cd contracts && ./compile.sh compile-el
 
 compile-dl:
 	cd contracts && ./compile.sh compile-dl
 
 clean:
-	find $(PROTO_GEN) -name "*.pb.go" -type f | xargs rm -rf
-	mkdir -p $(PROTO_GEN)
-	find $(PROTO_GEN_DISPERSER_PATH) -name "*.pb.go" -type f | xargs rm -rf
-	mkdir -p $(PROTO_GEN_DISPERSER_PATH)
+	./api/builder/clean.sh
 
+# Builds the protobuf files inside a docker container.
 protoc: clean
-	protoc -I $(PROTOS) \
-	--go_out=$(PROTO_GEN) \
-	--go_opt=paths=source_relative \
-	--go-grpc_out=$(PROTO_GEN) \
-	--go-grpc_opt=paths=source_relative \
-	$(PROTOS)/**/*.proto
-	# Generate Protobuf for sub directories of ./api/proto/disperser
-	protoc -I $(PROTOS_DISPERSER) -I $(PROTOS) \
-	--go_out=$(PROTO_GEN_DISPERSER_PATH) \
-	--go_opt=paths=source_relative \
-	--go-grpc_out=$(PROTO_GEN_DISPERSER_PATH) \
-	--go-grpc_opt=paths=source_relative \
-	$(PROTOS_DISPERSER)/**/*.proto
+	./api/builder/protoc-docker.sh
+
+# Builds the protobuf files locally (i.e. without docker).
+protoc-local: clean
+	./api/builder/protoc.sh
 
 lint:
 	golint -set_exit_status ./...

api/builder/README.md

@@ -13,7 +13,7 @@ To build the docker image, run the following command:
 Once the docker image is built, you can build the protobufs via the following command:
 
 ```bash
-./api/builder/build-protobufs.sh
+./api/builder/protoc-docker.sh
 ```
 
 # Caveats

api/builder/clean.sh

@@ -1,5 +1,14 @@
 #!/usr/bin/env bash
 
-# Cleans the docker image and all cached steps.
-docker image rm pbuf-compiler 2> /dev/null || true
-docker builder prune -f
+# This script finds and deletes all compiled protobufs.
+
+# The location where this script can be found.
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+API_DIR="${SCRIPT_DIR}/.."
+GRPC_DIR="${API_DIR}/grpc"
+find "${GRPC_DIR}" -name '*.pb.go' -type f | xargs rm -rf
+
+DISPERSER_DIR="$SCRIPT_DIR/../../disperser"
+DISPERSER_GRPC_DIR="$DISPERSER_DIR/api/grpc"
+find "${DISPERSER_GRPC_DIR}" -name '*.pb.go' -type f | xargs rm -rf

api/builder/debug.sh → api/builder/debug-docker.sh

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 
-# This is a handy little script for debugging the docker container. Attaches a bash shell to the container.
+# This is a handy little script for debugging the pbuf-compiler container. Attaches a bash shell to the container.
 
 # The location where this script can be found.
 SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )

api/builder/protoc-docker.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+# This script builds the eigenDA protobufs. It does this by running protoc.sh inside of the pbuf-compiler container.
+
+# The location where this script can be found.
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+ROOT="${SCRIPT_DIR}/../.."
+
+if [ -z "$(docker images -q pbuf-compiler:latest 2> /dev/null)" ]; then
+  echo "Docker image pbuf-compiler:latest does not exist. Building it now..."
+  "${SCRIPT_DIR}"/build-docker.sh
+fi
+
+
+docker container run \
+  --rm \
+  --mount "type=bind,source=${ROOT},target=/home/user/eigenda" \
+  pbuf-compiler bash -c "source ~/.bashrc && eigenda/api/builder/protoc.sh"

api/builder/protoc.sh

@@ -0,0 +1,34 @@
+#!/usr/bin/env bash
+
+# This script builds the eigenDA protobufs.
+
+# The location where this script can be found.
+SCRIPT_DIR=$( cd -- "$( dirname -- "${BASH_SOURCE[0]}" )" &> /dev/null && pwd )
+
+# Build protobufs in the api/proto directory.
+
+API_DIR="${SCRIPT_DIR}/.."
+PROTO_DIR="${API_DIR}/proto"
+GRPC_DIR="${API_DIR}/grpc"
+mkdir -p "${GRPC_DIR}"
+
+protoc -I "${PROTO_DIR}" \
+	--go_out="${GRPC_DIR}" \
+	--go_opt=paths=source_relative \
+	--go-grpc_out="${GRPC_DIR}" \
+	--go-grpc_opt=paths=source_relative \
+	"${PROTO_DIR}"/**/*.proto
+
+# Build protobufs in the disperser/api/proto directory.
+
+DISPERSER_DIR="$SCRIPT_DIR/../../disperser"
+DISPERSER_PROTO_DIR="$DISPERSER_DIR/api/proto"
+DISPERSER_GRPC_DIR="$DISPERSER_DIR/api/grpc"
+mkdir -p "${DISPERSER_GRPC_DIR}"
+
+protoc -I "${DISPERSER_PROTO_DIR}" -I "${PROTO_DIR}" \
+	--go_out="${DISPERSER_GRPC_DIR}" \
+	--go_opt=paths=source_relative \
+	--go-grpc_out="${DISPERSER_GRPC_DIR}" \
+	--go-grpc_opt=paths=source_relative \
+	"${DISPERSER_PROTO_DIR}"/**/*.proto

api/builder/rm-docker.sh

@@ -0,0 +1,7 @@
+#!/usr/bin/env bash
+
+# This script fully deletes the pbuf-compiler docker image and all cached steps.
+
+# Cleans the docker image and all cached steps.
+docker image rm pbuf-compiler 2> /dev/null || true
+docker builder prune -f