Protobuf Introduction + Types

.circleci/config.yml

@@ -73,6 +73,12 @@ jobs:
           key: go-src-v1-{{ .Revision }}
           paths:
             - ".git"
+  proto:
+    executor: golang
+    steps:
+      - make:
+          target: proto-all
+          description: "Lint and verify Protocol Buffer definitions"
 
   test-sim-nondeterminism:
     executor: golang
@@ -182,6 +188,9 @@ workflows:
             tags:
               only:
                 - /^v.*/
+      - proto:
+          requires:
+            - setup-dependencies                       
       - test-sim-nondeterminism:
           requires:
             - setup-dependencies

Makefile

@@ -11,37 +11,37 @@ MOCKS_DIR = $(CURDIR)/tests/mocks
 
 export GO111MODULE = on
 
-all: tools build lint test
-
 # The below include contains the tools and runsim targets.
 include contrib/devtools/Makefile
 
-########################################
-### Build
+all: tools build lint test
+
+###############################################################################
+###                                  Build                                  ###
+###############################################################################
 
 build: go.sum
 	@go build -mod=readonly ./...
 .PHONY: build
 
-update-swagger-docs: statik
-	$(BINDIR)/statik -src=client/lcd/swagger-ui -dest=client/lcd -f -m
-	@if [ -n "$(git status --porcelain)" ]; then \
-        echo "\033[91mSwagger docs are out of sync!!!\033[0m";\
-        exit 1;\
-    else \
-    	echo "\033[92mSwagger docs are in sync\033[0m";\
-    fi
-.PHONY: update-swagger-docs
-
 mocks: $(MOCKS_DIR)
 	mockgen -source=x/auth/types/account_retriever.go -package mocks -destination tests/mocks/account_retriever.go
 .PHONY: mocks
 
 $(MOCKS_DIR):
 	mkdir -p $(MOCKS_DIR)
 
-########################################
-### Tools & dependencies
+distclean:
+	rm -rf \
+    gitian-build-darwin/ \
+    gitian-build-linux/ \
+    gitian-build-windows/ \
+    .gitian-builder-cache/
+.PHONY: distclean
+
+###############################################################################
+###                          Tools & Dependencies                           ###
+###############################################################################
 
 go-mod-cache: go.sum
 	@echo "--> Download go modules to local cache"
@@ -53,16 +53,19 @@ go.sum: go.mod
 	@go mod verify
 	@go mod tidy
 
-distclean:
-	rm -rf \
-    gitian-build-darwin/ \
-    gitian-build-linux/ \
-    gitian-build-windows/ \
-    .gitian-builder-cache/
-.PHONY: distclean
+###############################################################################
+###                              Documentation                              ###
+###############################################################################
 
-########################################
-### Documentation
+update-swagger-docs: statik
+	$(BINDIR)/statik -src=client/lcd/swagger-ui -dest=client/lcd -f -m
+	@if [ -n "$(git status --porcelain)" ]; then \
+        echo "\033[91mSwagger docs are out of sync!!!\033[0m";\
+        exit 1;\
+    else \
+    	echo "\033[92mSwagger docs are in sync\033[0m";\
+    fi
+.PHONY: update-swagger-docs
 
 godocs:
 	@echo "--> Wait a few seconds and visit http://localhost:6060/pkg/github.com/cosmos/cosmos-sdk/types"
@@ -85,8 +88,9 @@ sync-docs:
 	aws cloudfront create-invalidation --distribution-id ${CF_DISTRIBUTION_ID} --profile terraform --path "/*" ;
 .PHONY: sync-docs
 
-########################################
-### Testing
+###############################################################################
+###                           Tests & Simulation                            ###
+###############################################################################
 
 test: test-unit
 test-all: test-unit test-ledger-mock test-race test-cover
@@ -173,6 +177,14 @@ test-cover:
 	@export VERSION=$(VERSION); bash -x tests/test_cover.sh
 .PHONY: test-cover
 
+benchmark:
+	@go test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION)
+.PHONY: benchmark
+
+###############################################################################
+###                                Linting                                  ###
+###############################################################################
+
 lint: golangci-lint
 	$(BINDIR)/golangci-lint run
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" | xargs gofmt -d -s
@@ -185,12 +197,9 @@ format: tools
 	find . -name '*.go' -type f -not -path "./vendor*" -not -path "*.git*" -not -path "./client/lcd/statik/statik.go" | xargs goimports -w -local github.com/cosmos/cosmos-sdk
 .PHONY: format
 
-benchmark:
-	@go test -mod=readonly -bench=. $(PACKAGES_NOSIMULATION)
-.PHONY: benchmark
-
-########################################
-### Devdoc
+###############################################################################
+###                                 Devdoc                                  ###
+###############################################################################
 
 DEVDOC_SAVE = docker commit `docker ps -a -n 1 -q` devdoc:local
 
@@ -213,3 +222,21 @@ devdoc-update:
 	docker pull tendermint/devdoc
 
 .PHONY: devdoc devdoc-clean devdoc-init devdoc-save devdoc-update
+
+###############################################################################
+###                                Protobuf                                 ###
+###############################################################################
+
+proto-all: proto-gen proto-lint proto-check-breaking
+
+proto-gen:
+	@go mod vendor
+	@./scripts/protocgen.sh
+
+proto-lint:
+	@buf check lint --error-format=json
+
+proto-check-breaking:
+	@buf check breaking --against-input '.git#branch=master'
+
+.PHONY: proto-all proto-gen proto-lint proto-check-breaking

buf.yaml

@@ -0,0 +1,19 @@
+build:
+  roots:
+    - .
+  excludes:
+    - vendor/github.com/tendermint
+lint:
+  use:
+    - DEFAULT
+    - COMMENTS
+    - FILE_LOWER_SNAKE_CASE
+  except:
+    - UNARY_RPC
+    - COMMENT_FIELD
+    - PACKAGE_DIRECTORY_MATCH
+  ignore:
+    - vendor
+breaking:
+  use:
+    - FILE

contrib/devtools/Makefile

@@ -1,3 +1,6 @@
+.PHONY: all tools tools-clean statik runsim golangci-lint \
+protoc buf protoc-gen-buf-check-breaking protoc-gen-buf-check-lint protoc-gen-gocosmos
+
 ###
 # Find OS and Go environment
 # GO contains the Go binary
@@ -15,13 +18,11 @@ ifeq ($(GO),)
   $(error could not find go. Is it in PATH? $(GO))
 endif
 
-GOPATH ?= $(shell $(GO) env GOPATH)
-GITHUBDIR := $(GOPATH)$(FS)src$(FS)github.com
-GOLANGCI_LINT_HASHSUM := 8d21cc95da8d3daf8321ac40091456fc26123c964d7c2281d339d431f2f4c840
+all: tools
 
-###
-# Functions
-###
+###############################################################################
+###                                Functions                                ###
+###############################################################################
 
 go_get = $(if $(findstring Windows_NT,$(OS)),\
 IF NOT EXIST $(GITHUBDIR)$(FS)$(1)$(FS) ( mkdir $(GITHUBDIR)$(FS)$(1) ) else (cd .) &\
@@ -35,19 +36,27 @@ cd $(GITHUBDIR)$(FS)$(1)$(FS)$(2) && git fetch origin && git checkout -q $(3)
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 mkfile_dir := $(shell cd $(shell dirname $(mkfile_path)); pwd)
 
-###
-# tools
-###
 
-TOOLS_DESTDIR  ?= $(GOPATH)/bin
+###############################################################################
+###                                 Tools                                   ###
+###############################################################################
 
-GOLANGCI_LINT = $(TOOLS_DESTDIR)/golangci-lint
-STATIK        = $(TOOLS_DESTDIR)/statik
-RUNSIM			  = $(TOOLS_DESTDIR)/runsim
+BIN ?= /usr/local/bin
+UNAME_S ?= $(shell uname -s)
+UNAME_M ?= $(shell uname -m)
 
-all: tools
+GOPATH ?= $(shell $(GO) env GOPATH)
+GITHUBDIR := $(GOPATH)$(FS)src$(FS)github.com
+GOLANGCI_LINT_HASHSUM := f11179f445385a4a6d5079d67de63fe48a9113cee8e9ee0ced19327a83a4394b
 
-tools: statik runsim golangci-lint
+BUF_VERSION ?= 0.4.0
+
+TOOLS_DESTDIR  ?= $(GOPATH)/bin
+GOLANGCI_LINT  = $(TOOLS_DESTDIR)/golangci-lint
+STATIK         = $(TOOLS_DESTDIR)/statik
+RUNSIM			   = $(TOOLS_DESTDIR)/runsim
+
+tools: protoc buf statik runsim golangci-lint
 
 golangci-lint: $(GOLANGCI_LINT)
 $(GOLANGCI_LINT): $(mkfile_dir)/install-golangci-lint.sh
@@ -74,8 +83,46 @@ $(RUNSIM):
 	@echo "Installing runsim..."
 	@(cd /tmp && go get github.com/cosmos/tools/cmd/runsim@v1.0.0)
 
+PROTOC_VERSION ?= 3.11.2
+ifeq ($(UNAME_S),Linux)
+  PROTOC_ZIP ?= protoc-3.11.2-linux-x86_64.zip
+endif
+ifeq ($(UNAME_S),Darwin)
+  PROTOC_ZIP ?= protoc-3.11.2-osx-x86_64.zip
+endif
+
+protoc:
+	@echo "Installing protoc compiler..."
+	@(cd /tmp; \
+	curl -OL "https://github.com/protocolbuffers/protobuf/releases/download/v${PROTOC_VERSION}/${PROTOC_ZIP}"; \
+	unzip -o ${PROTOC_ZIP} -d /usr/local bin/protoc; \
+	unzip -o ${PROTOC_ZIP} -d /usr/local 'include/*'; \
+	rm -f ${PROTOC_ZIP})
+
+protoc-gen-gocosmos:
+	@go install github.com/regen-network/cosmos-proto/protoc-gen-gocosmos
+
+buf: protoc-gen-buf-check-breaking protoc-gen-buf-check-lint
+	@echo "Installing buf..."
+	@curl -sSL \
+    "https://github.com/bufbuild/buf/releases/download/v${BUF_VERSION}/buf-${UNAME_S}-${UNAME_M}" \
+    -o "${BIN}/buf" && \
+	chmod +x "${BIN}/buf"
+
+protoc-gen-buf-check-breaking:
+	@echo "Installing protoc-gen-buf-check-breaking..."
+	@curl -sSL \
+    "https://github.com/bufbuild/buf/releases/download/v${BUF_VERSION}/protoc-gen-buf-check-breaking-${UNAME_S}-${UNAME_M}" \
+    -o "${BIN}/protoc-gen-buf-check-breaking" && \
+	chmod +x "${BIN}/protoc-gen-buf-check-breaking"
+
+protoc-gen-buf-check-lint:
+	@echo "Installing protoc-gen-buf-check-lint..."
+	@curl -sSL \
+    "https://github.com/bufbuild/buf/releases/download/v${BUF_VERSION}/protoc-gen-buf-check-lint-${UNAME_S}-${UNAME_M}" \
+    -o "${BIN}/protoc-gen-buf-check-lint" && \
+	chmod +x "${BIN}/protoc-gen-buf-check-lint"
+
 tools-clean:
 	rm -f $(STATIK) $(GOLANGCI_LINT) $(RUNSIM)
 	rm -f tools-stamp
-
-.PHONY: all tools tools-clean