protobuf generator update

Makefile

@@ -111,83 +111,42 @@ distclean: clean
 ###############################################################################
 ###                                Protobuf                                 ###
 ###############################################################################
-
-containerProtoVer=v0.2
-containerProtoImage=tendermintdev/sdk-proto-gen:$(containerProtoVer)
-containerProtoGen=cosmos-sdk-proto-gen-$(containerProtoVer)
-containerProtoGenSwagger=cosmos-sdk-proto-gen-swagger-$(containerProtoVer)
-containerProtoFmt=cosmos-sdk-proto-fmt-$(containerProtoVer)
+protoVer=0.11.6
+protoImageName=ghcr.io/cosmos/proto-builder:$(protoVer)
+protoImage=$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(protoImageName)
 
 proto-all: proto-format proto-lint proto-gen
 
 proto-gen:
 	@echo "Generating Protobuf files"
-	$(DOCKER) run --rm --name $(containerProtoGen) \
-		-v $(CURDIR):/workspace \
-		--workdir /workspace \
-		$(containerProtoImage) sh ./scripts/protocgen.sh
-
-# This generates the SDK's custom wrapper for google.protobuf.Any. It should only be run manually when needed
-proto-gen-any:
-	@echo "Generating Protobuf Any"
-	$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace $(containerProtoImage) sh ./scripts/protocgen-any.sh
+	@$(protoImage) sh ./scripts/protocgen.sh
 
 proto-swagger-gen:
 	@echo "Generating Protobuf Swagger"
-	$(DOCKER) run --rm --name $(containerProtoGenSwagger) -v $(CURDIR):/workspace --workdir /workspace $(containerProtoImage) sh ./scripts/protoc-swagger-gen.sh
+	@$(protoImage) sh ./scripts/protoc-swagger-gen.sh
+	$(MAKE) update-swagger-docs
 
 proto-format:
-	@echo "Formatting Protobuf files"
-	$(DOCKER) run --rm --name $(containerProtoFmt) \
-		--user $(shell id -u):$(shell id -g) \
-		-v $(CURDIR):/workspace \
-		--workdir /workspace \
-		tendermintdev/docker-build-proto find ./ -not -path "./third_party/*" -name *.proto -exec clang-format -i {} \;
+	@$(protoImage) find ./ -name "*.proto" -exec clang-format -i {} \;
 
 proto-lint:
-	@$(DOCKER_BUF) lint --error-format=json
+	@$(protoImage) buf lint --error-format=json
 
 proto-check-breaking:
-	@$(DOCKER_BUF) breaking --against $(HTTPS_GIT)#branch=master
-
-TM_URL           = https://raw.githubusercontent.com/tendermint/tendermint/v0.34.13/proto/tendermint
-GOGO_PROTO_URL   = https://raw.githubusercontent.com/regen-network/protobuf/cosmos
-COSMOS_URL 		 = https://raw.githubusercontent.com/cosmos/cosmos-sdk/v0.42.10/proto/cosmos
-COSMOS_PROTO_URL = https://raw.githubusercontent.com/regen-network/cosmos-proto/master
-IBC_URL 		 = https://raw.githubusercontent.com/cosmos/ibc-go/v1.2.0/proto/ibc
-
-TM_CRYPTO_TYPES     = third_party/proto/tendermint/crypto
-TM_ABCI_TYPES       = third_party/proto/tendermint/abci
-TM_TYPES     		= third_party/proto/tendermint/types
-TM_VERSION 			= third_party/proto/tendermint/version
-TM_LIBS				= third_party/proto/tendermint/libs/bits
-IBC_TYPES		 	= third_party/proto/ibc
-
-GOGO_PROTO_TYPES    = third_party/proto/gogoproto
-COSMOS_TYPES 		= third_party/proto/cosmos
-COSMOS_PROTO_TYPES  = third_party/proto/cosmos_proto
-IBC_TYPES		 	= third_party/proto/ibc
-
-proto-update-deps:
-	@mkdir -p $(COSMOS_TYPES)/base/query/v1beta1
-	@curl -sSL $(COSMOS_URL)/base/query/v1beta1/pagination.proto > $(COSMOS_TYPES)/base/query/v1beta1/pagination.proto
+	@$(protoImage) buf breaking --against $(HTTPS_GIT)#branch=main
 
-	@mkdir -p $(COSMOS_TYPES)/upgrade/v1beta1
-	@curl -sSL $(COSMOS_URL)/upgrade/v1beta1/upgrade.proto > $(COSMOS_TYPES)/upgrade/v1beta1/upgrade.proto
+CMT_URL              = https://raw.githubusercontent.com/cometbft/cometbft/v0.37.0/proto/tendermint
 
-	@mkdir -p $(GOGO_PROTO_TYPES)
-	@curl -sSL $(GOGO_PROTO_URL)/gogoproto/gogo.proto > $(GOGO_PROTO_TYPES)/gogo.proto
+TM_CRYPTO_TYPES     = proto/tendermint/crypto
+TM_ABCI_TYPES       = proto/tendermint/abci
+TM_TYPES            = proto/tendermint/types
+TM_VERSION          = proto/tendermint/version
+TM_LIBS             = proto/tendermint/libs/bits
+TM_P2P              = proto/tendermint/p2p
 
-	@mkdir -p $(COSMOS_PROTO_TYPES)
-	@curl -sSL $(COSMOS_PROTO_URL)/cosmos.proto > $(COSMOS_PROTO_TYPES)/cosmos.proto
-
-	@mkdir -p $(IBC_TYPES)/core/client/v1
-	@curl -sSL $(IBC_URL)/core/client/v1/client.proto > $(IBC_TYPES)/core/client/v1/client.proto
+proto-update-deps:
+	@echo "Updating Protobuf dependencies"
 
-## Importing of tendermint protobuf definitions currently requires the
-## use of `sed` in order to build properly with cosmos-sdk's proto file layout
-## (which is the standard Buf.build FILE_LAYOUT)
-## Issue link: https://github.com/tendermint/tendermint/issues/5021
 	@mkdir -p $(TM_ABCI_TYPES)
 	@curl -sSL $(TM_URL)/abci/types.proto > $(TM_ABCI_TYPES)/types.proto
 
@@ -199,6 +158,7 @@ proto-update-deps:
 	@curl -sSL $(TM_URL)/types/evidence.proto > $(TM_TYPES)/evidence.proto
 	@curl -sSL $(TM_URL)/types/params.proto > $(TM_TYPES)/params.proto
 	@curl -sSL $(TM_URL)/types/validator.proto > $(TM_TYPES)/validator.proto
+	@curl -sSL $(TM_URL)/types/block.proto > $(TM_TYPES)/block.proto
 
 	@mkdir -p $(TM_CRYPTO_TYPES)
 	@curl -sSL $(TM_URL)/crypto/proof.proto > $(TM_CRYPTO_TYPES)/proof.proto
@@ -207,7 +167,12 @@ proto-update-deps:
 	@mkdir -p $(TM_LIBS)
 	@curl -sSL $(TM_URL)/libs/bits/types.proto > $(TM_LIBS)/types.proto
 
-.PHONY: proto-all proto-gen proto-lint proto-check-breaking proto-update-deps
+	@mkdir -p $(TM_P2P)
+	@curl -sSL $(TM_URL)/p2p/types.proto > $(TM_P2P)/types.proto
+
+	$(DOCKER) run --rm -v $(CURDIR)/proto:/workspace --workdir /workspace $(protoImageName) buf mod update
+
+.PHONY: proto-all proto-gen proto-swagger-gen proto-format proto-lint proto-check-breaking proto-update-deps
 
 ########################################
 ### Testing

buf.work.yaml

@@ -0,0 +1,9 @@
+# Generated by "buf config migrate-v1beta1". Edit as necessary, and
+# remove this comment when you're finished.
+#
+# This workspace file points to the roots found in your
+# previous "buf.yaml" configuration.
+version: v1
+directories:
+  - proto
+  - thirdparty/proto

cmd/qwoynd/cmd/sign.go

@@ -22,7 +22,6 @@ func GetSignBytesCommand() *cobra.Command {
 	}
 
 	cmd.Flags().String(flags.FlagOutputDocument, "", "The document will be written to the given file instead of STDOUT")
-	cmd.Flags().String(flags.FlagChainID, "", "The network chain ID")
 	flags.AddTxFlagsToCmd(cmd)
 
 	cmd.MarkFlagRequired(flags.FlagFrom)

proto/README.md

@@ -0,0 +1,26 @@
+# Maintaining Cosmos SDK Proto Files
+
+All of the Cosmos SDK proto files are defined here. This folder should
+be synced regularly with buf.build/cosmos/cosmos-sdk regularly by
+a maintainer by running `buf push` in this folder.
+
+User facing documentation should not be placed here but instead goes in
+`buf.md` and in each protobuf package following the guidelines in
+https://docs.buf.build/bsr/documentation.
+
+## SDK x Buf
+
+| Cosmos SDK Version | Buf Commit Version                                                                                            |
+| ------------------ | ------------------------------------------------------------------------------------------------------------- |
+| Prior v0.46.0      | [Unavailable](https://github.com/bufbuild/buf/issues/1415)                                                    |
+| v0.46.x            | [8cb30a2c4de74dc9bd8d260b1e75e176](https://buf.build/cosmos/cosmos-sdk/docs/8cb30a2c4de74dc9bd8d260b1e75e176) |
+| v0.47.x            | [v0.47.0](https://buf.build/cosmos/cosmos-sdk/docs/v0.47.0)                                                   |
+| Next               | [latest on buf](https://buf.build/cosmos/cosmos-sdk/commits/main)                                             |
+
+## Generate
+
+To get the Cosmos SDK proto given a commit, run:
+
+```bash
+buf export buf.build/cosmos/cosmos-sdk:${commit} --output .
+```

proto/buf.gen.gogo.yaml

@@ -0,0 +1,8 @@
+version: v1
+plugins:
+  - name: gocosmos
+    out: ..
+    opt: plugins=grpc,Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types
+  - name: grpc-gateway
+    out: ..
+    opt: logtostderr=true,allow_colon_final_segments=true

proto/buf.gen.pulsar.yaml

@@ -0,0 +1,17 @@
+version: v1
+managed:
+  enabled: true
+  go_package_prefix:
+    default: cosmossdk.io/api
+    except:
+      - buf.build/googleapis/googleapis
+      - buf.build/cosmos/gogo-proto
+      - buf.build/cosmos/cosmos-proto
+    override:
+plugins:
+  - name: go-pulsar
+    out: ../api
+    opt: paths=source_relative
+  - name: go-grpc
+    out: ../api
+    opt: paths=source_relative

proto/buf.gen.swagger.yaml

@@ -0,0 +1,5 @@
+version: v1
+plugins:
+  - name: swagger
+    out: ../tmp-swagger-gen
+    opt: logtostderr=true,fqn_for_swagger_name=true,simple_operation_ids=true

proto/buf.lock

@@ -0,0 +1,15 @@
+# Generated by buf. DO NOT EDIT.
+version: v1
+deps:
+  - remote: buf.build
+    owner: cosmos
+    repository: cosmos-proto
+    commit: 1935555c206d4afb9e94615dfd0fad31
+  - remote: buf.build
+    owner: cosmos
+    repository: gogo-proto
+    commit: 34d970b699f84aa382f3c29773a60836
+  - remote: buf.build
+    owner: googleapis
+    repository: googleapis
+    commit: 75b4300737fb4efca0831636be94e517

proto/buf.md

@@ -0,0 +1,3 @@
+# Protobufs
+
+This is the public protocol buffers API for the [Cosmos SDK](https://github.com/cosmos/cosmos-sdk).

proto/buf.yaml

@@ -0,0 +1,23 @@
+# This module represents buf.build/cosmos/cosmos-sdk
+version: v1
+name: buf.build/cosmos/cosmos-sdk
+deps:
+  - buf.build/cosmos/cosmos-proto
+  - buf.build/cosmos/gogo-proto
+  - buf.build/googleapis/googleapis
+breaking:
+  use:
+    - FILE
+lint:
+  use:
+    - DEFAULT
+    - COMMENTS
+    - FILE_LOWER_SNAKE_CASE
+  except:
+    - UNARY_RPC
+    - COMMENT_FIELD
+    - SERVICE_SUFFIX
+    - PACKAGE_VERSION_SUFFIX
+    - RPC_REQUEST_STANDARD_NAME
+  ignore:
+    - tendermint

proto/aquifer/genesis.proto → proto/cosmichorizon/qwoyn/aquifer/genesis.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 package cosmichorizon.qwoyn.aquifer;
 
 import "gogoproto/gogo.proto";
-import "aquifer/params.proto";
+import "cosmichorizon/qwoyn/aquifer/params.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/aquifer/types";
 

proto/aquifer/query.proto → proto/cosmichorizon/qwoyn/aquifer/query.proto

@@ -3,8 +3,7 @@ package cosmichorizon.qwoyn.aquifer;
 
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "cosmos/base/query/v1beta1/pagination.proto";
-import "aquifer/params.proto";
+import "cosmichorizon/qwoyn/aquifer/params.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/aquifer/types";
 

proto/game/genesis.proto → proto/cosmichorizon/qwoyn/game/genesis.proto

@@ -4,9 +4,9 @@ package cosmichorizon.qwoyn.game;
 import "gogoproto/gogo.proto";
 import "google/protobuf/duration.proto";
 import "google/protobuf/timestamp.proto";
-import "game/params.proto";
-import "game/game.proto";
-import "game/liquidity.proto";
+import "cosmichorizon/qwoyn/game/params.proto";
+import "cosmichorizon/qwoyn/game/game.proto";
+import "cosmichorizon/qwoyn/game/liquidity.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/game/types";
 

proto/game/query.proto → proto/cosmichorizon/qwoyn/game/query.proto

@@ -3,10 +3,9 @@ package cosmichorizon.qwoyn.game;
 
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "cosmos/base/query/v1beta1/pagination.proto";
-import "game/params.proto";
-import "game/game.proto";
-import "game/liquidity.proto";
+import "cosmichorizon/qwoyn/game/params.proto";
+import "cosmichorizon/qwoyn/game/game.proto";
+import "cosmichorizon/qwoyn/game/liquidity.proto";
 import "cosmos/base/v1beta1/coin.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/game/types";

proto/mint/genesis.proto → proto/cosmichorizon/qwoyn/mint/genesis.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 package cosmichorizon.qwoyn.mint;
 
 import "gogoproto/gogo.proto";
-import "mint/mint.proto";
+import "cosmichorizon/qwoyn/mint/mint.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/mint/types";
 

proto/mint/query.proto → proto/cosmichorizon/qwoyn/mint/query.proto

@@ -3,7 +3,7 @@ package cosmichorizon.qwoyn.mint;
 
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "mint/mint.proto";
+import "cosmichorizon/qwoyn/mint/mint.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/mint/types";
 

proto/stimulus/genesis.proto → proto/cosmichorizon/qwoyn/stimulus/genesis.proto

@@ -2,7 +2,7 @@ syntax = "proto3";
 package cosmichorizon.qwoyn.stimulus;
 
 import "gogoproto/gogo.proto";
-import "stimulus/params.proto";
+import "cosmichorizon/qwoyn/stimulus/params.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/stimulus/types";
 

proto/stimulus/query.proto → proto/cosmichorizon/qwoyn/stimulus/query.proto

@@ -3,8 +3,7 @@ package cosmichorizon.qwoyn.stimulus;
 
 import "gogoproto/gogo.proto";
 import "google/api/annotations.proto";
-import "cosmos/base/query/v1beta1/pagination.proto";
-import "stimulus/params.proto";
+import "cosmichorizon/qwoyn/stimulus/params.proto";
 
 option go_package = "github.com/cosmic-horizon/qwoyn/x/stimulus/types";
 

scripts/protoc-swagger-gen.sh

@@ -0,0 +1,23 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+mkdir -p ./tmp-swagger-gen
+cd proto
+proto_dirs=$(find ./cosmos -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
+for dir in $proto_dirs; do
+  # generate swagger files (filter query files)
+  query_file=$(find "${dir}" -maxdepth 1 \( -name 'query.proto' -o -name 'service.proto' \))
+  if [[ ! -z "$query_file" ]]; then
+    buf generate --template buf.gen.swagger.yaml $query_file
+  fi
+done
+
+cd ..
+# combine swagger files
+# uses nodejs package `swagger-combine`.
+# all the individual swagger files need to be configured in `config.json` for merging
+swagger-combine ./client/docs/config.json -o ./client/docs/swagger-ui/swagger.yaml -f yaml --continueOnConflictingPaths true --includeDefinitions true
+
+# clean swagger files
+rm -rf ./tmp-swagger-gen

scripts/protocgen-pulsar.sh

@@ -0,0 +1,19 @@
+# this script is for generating protobuf files for the new google.golang.org/protobuf API
+
+set -eo pipefail
+
+protoc_install_gopulsar() {
+  go install github.com/cosmos/cosmos-proto/cmd/protoc-gen-go-pulsar@latest
+  go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
+}
+
+protoc_install_gopulsar
+
+echo "Cleaning API directory"
+(cd api; find ./ -type f \( -iname \*.pulsar.go -o -iname \*.pb.go -o -iname \*.cosmos_orm.go -o -iname \*.pb.gw.go \) -delete; find . -empty -type d -delete; cd ..)
+
+echo "Generating API module"
+(cd proto; buf generate --template buf.gen.pulsar.yaml)
+
+echo "Generate Pulsar Test Data"
+(cd testutil/testdata; buf generate --template buf.gen.pulsar.yaml)