update proto generation and testing pipelines

.clang-format

@@ -0,0 +1,11 @@
+---
+Language: Proto
+BasedOnStyle: Google
+IndentWidth: 2
+ColumnLimit: 0
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+SpacesInSquareBrackets: true
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true

.github/workflows/proto-check.yml

@@ -0,0 +1,23 @@
+name: Proto Check
+# Protobuf runs buf (https://buf.build/) lint and check-breakage
+# This workflow is only run when a .proto file has been modified
+on:
+  workflow_dispatch: # allow running workflow manually
+  pull_request:
+    paths:
+      - "./proto"
+jobs:
+  proto-lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 4
+    steps:
+      - uses: actions/checkout@v2.4.0
+      - name: lint
+        run: make proto-lint
+  proto-breakage:
+    runs-on: ubuntu-latest
+    timeout-minutes: 4
+    steps:
+      - uses: actions/checkout@v2.4.0
+      - name: check-breakage
+        run: make proto-check-breaking-ci

.github/workflows/proto-dockerfile.yml

@@ -0,0 +1,51 @@
+name: Build & Push TM Proto Builder
+on:
+  pull_request:
+    paths:
+      - "proto/*"
+  push:
+    branches:
+      - master
+    paths:
+      - "proto/*"
+  schedule:
+    # run this job once a month to recieve any go or buf updates
+    - cron: "* * 1 * *"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2.4.0
+      - name: Prepare
+        id: prep
+        run: |
+          DOCKER_IMAGE=tendermintdev/docker-build-proto
+          VERSION=noop
+          if [[ $GITHUB_REF == refs/tags/* ]]; then
+            VERSION=${GITHUB_REF#refs/tags/}
+          elif [[ $GITHUB_REF == refs/heads/* ]]; then
+            VERSION=$(echo ${GITHUB_REF#refs/heads/} | sed -r 's#/+#-#g')
+            if [ "${{ github.event.repository.default_branch }}" = "$VERSION" ]; then
+              VERSION=latest
+            fi
+          fi
+          TAGS="${DOCKER_IMAGE}:${VERSION}"
+          echo ::set-output name=tags::${TAGS}
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v1.6.0
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v1.10.0
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Publish to Docker Hub
+        uses: docker/build-push-action@v2.7.0
+        with:
+          context: ./proto
+          file: ./proto/Dockerfile
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.prep.outputs.tags }}

.gitignore

@@ -6,3 +6,4 @@
 *.gz
 *.dvi
 .idea
+*.pb.go

Makefile

@@ -0,0 +1,31 @@
+DOCKER_PROTO_BUILDER := docker run -v $(shell pwd):/workspace --workdir /workspace tendermintdev/docker-build-proto
+HTTPS_GIT := https://github.com/tendermint/spec.git
+
+###############################################################################
+###                                Protobuf                                 ###
+###############################################################################
+
+proto-all: proto-lint proto-check-breaking
+.PHONY: proto-all
+
+proto-gen:
+	@echo "Generating Protobuf files"
+	@$(DOCKER_PROTO_BUILDER) buf generate --template=./proto/buf.gen.yaml --config ./proto/buf.yaml
+.PHONY: proto-gen
+
+proto-lint:
+	@$(DOCKER_PROTO_BUILDER) buf lint --error-format=json --config ./proto/buf.yaml
+.PHONY: proto-lint
+
+proto-format:
+	@echo "Formatting Protobuf files"
+	@$(DOCKER_PROTO_BUILDER) find . -name '*.proto' -path "./proto/*" -exec clang-format -i {} \;
+.PHONY: proto-format
+
+proto-check-breaking:
+	@$(DOCKER_PROTO_BUILDER) buf breaking --against .git --config ./proto/buf.yaml
+.PHONY: proto-check-breaking
+
+proto-check-breaking-ci:
+	@$(DOCKER_PROTO_BUILDER) buf breaking --against $(HTTPS_GIT) --config ./proto/buf.yaml
+.PHONY: proto-check-breaking-ci

proto/Dockerfile

@@ -0,0 +1,24 @@
+# This Dockerfile defines a toolbox for use in linting, formatting, and compiling the Tendermint protos.
+
+FROM bufbuild/buf:latest as buf
+
+FROM alpine:3.14
+
+# Install a commonly used set of programs for use with our protos.
+# clang-extra-tools is included here because it provides clang-format, the program used for formatting the protos.
+RUN echo 'http://dl-cdn.alpinelinux.org/alpine/edge/testing' >> /etc/apk/repositories && \
+  apk add --update --no-cache build-base clang-extra-tools curl git go && \
+  rm -rf /var/cache/apk/*
+
+ENV GOLANG_PROTOBUF_VERSION=1.3.1 \
+  GOGO_PROTOBUF_VERSION=1.3.2
+
+# Retrieve the go protoc programs and copy them into the PATH
+RUN GO111MODULE=on go get \
+  github.com/golang/protobuf/protoc-gen-go@v${GOLANG_PROTOBUF_VERSION} \
+  github.com/gogo/protobuf/protoc-gen-gogo@v${GOGO_PROTOBUF_VERSION} \
+  github.com/gogo/protobuf/protoc-gen-gogofaster@v${GOGO_PROTOBUF_VERSION} && \
+  mv $(go env | grep GOPATH | sed 's/GOPATH="\(.*\)"/\1/g')/bin/* /usr/local/bin/ 
+
+# Copy the 'buf' program out of the buildbuf/buf container.
+COPY --from=buf /usr/local/bin/* /usr/local/bin/

proto/buf.gen.yaml

@@ -0,0 +1,13 @@
+# The version of the generation template.
+# Required.
+# The only currently-valid value is v1beta1.
+version: v1beta1
+
+# The plugins to run.
+plugins:
+  # The name of the plugin.
+  - name: gogofaster
+    # The the relative output directory.
+    out: proto
+    # Any options to provide to the plugin.
+    opt: Mgoogle/protobuf/timestamp.proto=github.com/gogo/protobuf/types,Mgoogle/protobuf/duration.proto=github.com/golang/protobuf/ptypes/duration,plugins=grpc,paths=source_relative

proto/buf.yaml

@@ -0,0 +1,16 @@
+version: v1beta1
+
+build:
+  roots:
+    - proto
+    - third_party/proto
+lint:
+  use:
+    - BASIC
+    - FILE_LOWER_SNAKE_CASE
+    - UNARY_RPC
+  ignore:
+    - gogoproto
+breaking:
+  use:
+    - FILE

proto/tendermint/abci/types.proto

@@ -1,8 +1,6 @@
 syntax = "proto3";
 package tendermint.abci;
 
-option go_package = "github.com/tendermint/tendermint/abci/types";
-
 // For more information on gogo.proto, see:
 // https://github.com/gogo/protobuf/blob/master/extensions.md
 import "tendermint/crypto/proof.proto";
@@ -52,7 +50,8 @@ message RequestInfo {
 }
 
 message RequestInitChain {
-  google.protobuf.Timestamp        time             = 1 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
+  google.protobuf.Timestamp time = 1
+      [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
   string                           chain_id         = 2;
   tendermint.types.ConsensusParams consensus_params = 3;
   repeated ValidatorUpdate         validators       = 4 [(gogoproto.nullable) = false];
@@ -182,7 +181,10 @@ message ResponseQuery {
 }
 
 message ResponseBeginBlock {
-  repeated Event events = 1 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "events,omitempty"];
+  repeated Event events = 1 [
+    (gogoproto.nullable) = false,
+    (gogoproto.jsontag)  = "events,omitempty"
+  ];
 }
 
 message ResponseCheckTx {
@@ -192,10 +194,13 @@ message ResponseCheckTx {
   string         info       = 4;  // nondeterministic
   int64          gas_wanted = 5 [json_name = "gas_wanted"];
   int64          gas_used   = 6 [json_name = "gas_used"];
-  repeated Event events     = 7 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "events,omitempty"];
-  string         codespace  = 8;
-  string         sender     = 9;
-  int64          priority   = 10;
+  repeated Event events     = 7 [
+    (gogoproto.nullable) = false,
+    (gogoproto.jsontag)  = "events,omitempty"
+  ];
+  string codespace = 8;
+  string sender    = 9;
+  int64  priority  = 10;
 
   // mempool_error is set by Tendermint.
   // ABCI applications creating a ResponseCheckTX should not set mempool_error.
@@ -209,15 +214,21 @@ message ResponseDeliverTx {
   string         info       = 4;  // nondeterministic
   int64          gas_wanted = 5 [json_name = "gas_wanted"];
   int64          gas_used   = 6 [json_name = "gas_used"];
-  repeated Event events     = 7
-      [(gogoproto.nullable) = false, (gogoproto.jsontag) = "events,omitempty"];  // nondeterministic
+  repeated Event events     = 7 [
+    (gogoproto.nullable) = false,
+    (gogoproto.jsontag)  = "events,omitempty"
+  ];  // nondeterministic
   string codespace = 8;
 }
 
 message ResponseEndBlock {
-  repeated ValidatorUpdate         validator_updates       = 1 [(gogoproto.nullable) = false];
+  repeated ValidatorUpdate validator_updates = 1
+      [(gogoproto.nullable) = false];
   tendermint.types.ConsensusParams consensus_param_updates = 2;
-  repeated Event                   events                  = 3 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "events,omitempty"];
+  repeated Event                   events                  = 3 [
+    (gogoproto.nullable) = false,
+    (gogoproto.jsontag)  = "events,omitempty"
+  ];
 }
 
 message ResponseCommit {
@@ -275,7 +286,10 @@ message LastCommitInfo {
 // Later, transactions may be queried using these events.
 message Event {
   string                  type       = 1;
-  repeated EventAttribute attributes = 2 [(gogoproto.nullable) = false, (gogoproto.jsontag) = "attributes,omitempty"];
+  repeated EventAttribute attributes = 2 [
+    (gogoproto.nullable) = false,
+    (gogoproto.jsontag)  = "attributes,omitempty"
+  ];
 }
 
 // EventAttribute is a single key-value pair, associated with an event.
@@ -330,7 +344,8 @@ message Evidence {
   // The height when the offense occurred
   int64 height = 3;
   // The corresponding time where the offense occurred
-  google.protobuf.Timestamp time = 4 [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
+  google.protobuf.Timestamp time = 4
+      [(gogoproto.nullable) = false, (gogoproto.stdtime) = true];
   // Total voting power of the validator set in case the ABCI application does
   // not store historical validators.
   // https://github.com/tendermint/tendermint/issues/4581
@@ -364,6 +379,8 @@ service ABCIApplication {
   rpc EndBlock(RequestEndBlock) returns (ResponseEndBlock);
   rpc ListSnapshots(RequestListSnapshots) returns (ResponseListSnapshots);
   rpc OfferSnapshot(RequestOfferSnapshot) returns (ResponseOfferSnapshot);
-  rpc LoadSnapshotChunk(RequestLoadSnapshotChunk) returns (ResponseLoadSnapshotChunk);
-  rpc ApplySnapshotChunk(RequestApplySnapshotChunk) returns (ResponseApplySnapshotChunk);
+  rpc LoadSnapshotChunk(RequestLoadSnapshotChunk)
+      returns (ResponseLoadSnapshotChunk);
+  rpc ApplySnapshotChunk(RequestApplySnapshotChunk)
+      returns (ResponseApplySnapshotChunk);
 }

proto/tendermint/blocksync/types.proto

@@ -1,16 +1,15 @@
 syntax = "proto3";
 package tendermint.blocksync;
 
-option go_package = "github.com/tendermint/tendermint/proto/tendermint/blocksync";
-
 import "tendermint/types/block.proto";
 
 // BlockRequest requests a block for a specific height
 message BlockRequest {
   int64 height = 1;
 }
 
-// NoBlockResponse informs the node that the peer does not have block at the requested height
+// NoBlockResponse informs the node that the peer does not have block at the
+// requested height
 message NoBlockResponse {
   int64 height = 1;
 }
@@ -21,8 +20,7 @@ message BlockResponse {
 }
 
 // StatusRequest requests the status of a peer.
-message StatusRequest {
-}
+message StatusRequest {}
 
 // StatusResponse is a peer response to inform their status.
 message StatusResponse {

proto/tendermint/consensus/types.proto

@@ -1,8 +1,6 @@
 syntax = "proto3";
 package tendermint.consensus;
 
-option go_package = "github.com/tendermint/tendermint/proto/tendermint/consensus";
-
 import "gogoproto/gogo.proto";
 import "tendermint/types/types.proto";
 import "tendermint/libs/bits/types.proto";
@@ -17,15 +15,18 @@ message NewRoundStep {
   int32  last_commit_round        = 5;
 }
 
-// NewValidBlock is sent when a validator observes a valid block B in some round r,
-//i.e., there is a Proposal for block B and 2/3+ prevotes for the block B in the round r.
+// NewValidBlock is sent when a validator observes a valid block B in some round
+// r,
+// i.e., there is a Proposal for block B and 2/3+ prevotes for the block B in
+// the round r.
 // In case the block is also committed, then IsCommit flag is set to true.
 message NewValidBlock {
   int64                          height                = 1;
   int32                          round                 = 2;
-  tendermint.types.PartSetHeader block_part_set_header = 3 [(gogoproto.nullable) = false];
-  tendermint.libs.bits.BitArray  block_parts           = 4;
-  bool                           is_commit             = 5;
+  tendermint.types.PartSetHeader block_part_set_header = 3
+      [(gogoproto.nullable) = false];
+  tendermint.libs.bits.BitArray block_parts = 4;
+  bool                          is_commit   = 5;
 }
 
 // Proposal is sent when a new block is proposed.
@@ -37,7 +38,8 @@ message Proposal {
 message ProposalPOL {
   int64                         height             = 1;
   int32                         proposal_pol_round = 2;
-  tendermint.libs.bits.BitArray proposal_pol       = 3 [(gogoproto.nullable) = false];
+  tendermint.libs.bits.BitArray proposal_pol       = 3
+      [(gogoproto.nullable) = false];
 }
 
 // BlockPart is sent when gossipping a piece of the proposed block.
@@ -65,16 +67,19 @@ message VoteSetMaj23 {
   int64                          height   = 1;
   int32                          round    = 2;
   tendermint.types.SignedMsgType type     = 3;
-  tendermint.types.BlockID       block_id = 4 [(gogoproto.customname) = "BlockID", (gogoproto.nullable) = false];
+  tendermint.types.BlockID       block_id = 4
+      [(gogoproto.customname) = "BlockID", (gogoproto.nullable) = false];
 }
 
-// VoteSetBits is sent to communicate the bit-array of votes seen for the BlockID.
+// VoteSetBits is sent to communicate the bit-array of votes seen for the
+// BlockID.
 message VoteSetBits {
   int64                          height   = 1;
   int32                          round    = 2;
   tendermint.types.SignedMsgType type     = 3;
-  tendermint.types.BlockID       block_id = 4 [(gogoproto.customname) = "BlockID", (gogoproto.nullable) = false];
-  tendermint.libs.bits.BitArray  votes    = 5 [(gogoproto.nullable) = false];
+  tendermint.types.BlockID       block_id = 4
+      [(gogoproto.customname) = "BlockID", (gogoproto.nullable) = false];
+  tendermint.libs.bits.BitArray votes = 5 [(gogoproto.nullable) = false];
 }
 
 message Message {

proto/tendermint/crypto/keys.proto

@@ -1,8 +1,6 @@
 syntax = "proto3";
 package tendermint.crypto;
 
-option go_package = "github.com/tendermint/tendermint/proto/tendermint/crypto";
-
 import "gogoproto/gogo.proto";
 
 // PublicKey defines the keys available for use with Tendermint Validators