setup proto

.github/workflows/proto.yml

@@ -0,0 +1,21 @@
+name: Protobuf
+# Protobuf runs buf (https://buf.build/) lint and check-breakage
+# This workflow is only run when a .proto file has been changed
+on:
+  pull_request:
+    paths:
+      - "**.proto"
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@master
+      - name: lint
+        run: make proto-lint
+  breakage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - name: check-breakage
+        run: make proto-check-breaking

Makefile

@@ -89,3 +89,31 @@ init-run-noInstall:
 rollback:
 	./scripts/rollback.sh
 
+###############################################################################
+###                                Protobuf                                 ###
+###############################################################################
+
+proto-all: proto-format proto-lint proto-gen
+
+proto-gen:
+	@echo "Generating Protobuf files"
+	$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace tendermintdev/sdk-proto-gen sh ./scripts/protocgen.sh
+
+proto-format:
+	@echo "Formatting Protobuf files"
+	$(DOCKER) run --rm -v $(CURDIR):/workspace \
+	--workdir /workspace tendermintdev/docker-build-proto \
+	find ./ -not -path "./third_party/*" -name *.proto -exec clang-format -i {} \;
+
+# This generates the SDK's custom wrapper for google.protobuf.Any. It should only be run manually when needed
+proto-gen-any:
+	$(DOCKER) run --rm -v $(CURDIR):/workspace --workdir /workspace tendermintdev/sdk-proto-gen sh ./scripts/protocgen-any.sh
+
+proto-swagger-gen:
+	@./scripts/protoc-swagger-gen.sh
+
+proto-lint:
+	@$(DOCKER_BUF) check lint --error-format=json
+
+proto-check-breaking:
+	@$(DOCKER_BUF) check breaking --against-input $(HTTPS_GIT)#branch=master

proto/sifnode/oracle/v1beta1/types.proto

@@ -0,0 +1,43 @@
+syntax = "proto3";
+package sifchain.oracle.v1beta1;
+
+import "gogoproto/gogo.proto";
+
+option go_package = "github.com/sifchain/sifnode/x/oracle/types";
+
+// GenesisState - all clp state that must be provided at genesis
+//TODO: Add parameters to Genesis state ,such as minimum liquidity required to create a pool
+message GenesisState {
+  repeated string address_whitelist = 1;
+  string          admin_address     = 2;
+}
+
+// Claim contrains an arbitrary claim with arbitrary content made by a given validator
+message Claim {
+  string id                = 1;
+  string validator_address = 2;
+  string content           = 3;
+}
+
+// DBProphecy is what the prophecy becomes when being saved to the database.
+//  Tendermint/Amino does not support maps so we must serialize those variables into bytes.
+message DBProphecy {
+  string id               = 1;
+  Status status           = 2 [(gogoproto.nullable) = false];
+  bytes  claim_validators = 3;
+  bytes  validator_claims = 4;
+}
+
+// Status is a struct that contains the status of a given prophecy
+message Status {
+  StatusText text        = 1;
+  string     final_claim = 2;
+}
+
+// StatusText is an enum used to represent the status of the prophecy
+enum StatusText {
+  UNKNOWN_STATUS_TEXT = 0;
+  PEDNING_STATUS_TEXT = 1;
+  SUCCESS_STATUS_TEXT = 2;
+  FAILED_STATUS_TEXT  = 3;
+}

scripts/protoc-swagger-gen.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+mkdir -p ./tmp-swagger-gen
+proto_dirs=$(find ./proto -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 protoc  \
+      -I "proto" \
+      -I "third_party/proto" \
+      "$query_file" \
+      --swagger_out=./tmp-swagger-gen \
+      --swagger_opt=logtostderr=true --swagger_opt=fqn_for_swagger_name=true --swagger_opt=simple_operation_ids=true
+  fi
+done
+
+# 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-any.sh

@@ -0,0 +1,18 @@
+#!/usr/bin/env bash
+
+# This script generates a custom wrapper for google.protobuf.Any in
+# codec/types/any.pb.go with a custom generated struct that lives in
+# codec/types/any.go
+
+set -eo pipefail
+
+go install github.com/gogo/protobuf/protoc-gen-gogotypes
+
+buf protoc -I "third_party/proto" --gogotypes_out=./codec/types third_party/proto/google/protobuf/any.proto
+mv codec/types/google/protobuf/any.pb.go codec/types
+rm -rf codec/types/third_party
+
+# This removes the call to RegisterType in the custom generated Any wrapper
+# so that only the Any type provided by gogo protobuf is registered in the
+# global gogo protobuf type registry, which we aren't actually using
+sed '/proto\.RegisterType/d' codec/types/any.pb.go > tmp && mv tmp codec/types/any.pb.go

scripts/protocgen.sh

@@ -0,0 +1,43 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+protoc_gen_gocosmos() {
+  if ! grep "github.com/gogo/protobuf => github.com/regen-network/protobuf" go.mod &>/dev/null ; then
+    echo -e "\tPlease run this command from somewhere inside the cosmos-sdk folder."
+    return 1
+  fi
+
+  go get github.com/regen-network/cosmos-proto/protoc-gen-gocosmos@latest 2>/dev/null
+}
+
+protoc_gen_gocosmos
+
+proto_dirs=$(find ./proto -path -prune -o -name '*.proto' -print0 | xargs -0 -n1 dirname | sort | uniq)
+for dir in $proto_dirs; do
+  buf protoc \
+    -I "proto" \
+    -I "third_party/proto" \
+    --gocosmos_out=plugins=interfacetype+grpc,\
+Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types:. \
+    --grpc-gateway_out=logtostderr=true,allow_colon_final_segments=true:. \
+  $(find "${dir}" -maxdepth 1 -name '*.proto')
+
+done
+
+# command to generate docs using protoc-gen-doc
+buf protoc \
+  -I "proto" \
+  -I "third_party/proto" \
+  --doc_out=./docs/core \
+  --doc_opt=./docs/protodoc-markdown.tmpl,proto-docs.md \
+  $(find "$(pwd)/proto" -maxdepth 5 -name '*.proto')
+go mod tidy
+
+# generate codec/testdata proto code
+buf protoc -I "proto" -I "third_party/proto" -I "testutil/testdata" --gocosmos_out=plugins=interfacetype+grpc,\
+Mgoogle/protobuf/any.proto=github.com/cosmos/cosmos-sdk/codec/types:. ./testutil/testdata/*.proto
+
+# move proto files to the right places
+cp -r github.com/cosmos/cosmos-sdk/* ./
+rm -rf github.com

third_party/proto/gogoproto/gogo.proto

@@ -0,0 +1,145 @@
+// Protocol Buffers for Go with Gadgets
+//
+// Copyright (c) 2013, The GoGo Authors. All rights reserved.
+// http://github.com/gogo/protobuf
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//     * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//     * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+syntax = "proto2";
+package gogoproto;
+
+import "google/protobuf/descriptor.proto";
+
+option java_package         = "com.google.protobuf";
+option java_outer_classname = "GoGoProtos";
+option go_package           = "github.com/gogo/protobuf/gogoproto";
+
+extend google.protobuf.EnumOptions {
+  optional bool   goproto_enum_prefix   = 62001;
+  optional bool   goproto_enum_stringer = 62021;
+  optional bool   enum_stringer         = 62022;
+  optional string enum_customname       = 62023;
+  optional bool   enumdecl              = 62024;
+}
+
+extend google.protobuf.EnumValueOptions {
+  optional string enumvalue_customname = 66001;
+}
+
+extend google.protobuf.FileOptions {
+  optional bool goproto_getters_all     = 63001;
+  optional bool goproto_enum_prefix_all = 63002;
+  optional bool goproto_stringer_all    = 63003;
+  optional bool verbose_equal_all       = 63004;
+  optional bool face_all                = 63005;
+  optional bool gostring_all            = 63006;
+  optional bool populate_all            = 63007;
+  optional bool stringer_all            = 63008;
+  optional bool onlyone_all             = 63009;
+
+  optional bool equal_all            = 63013;
+  optional bool description_all      = 63014;
+  optional bool testgen_all          = 63015;
+  optional bool benchgen_all         = 63016;
+  optional bool marshaler_all        = 63017;
+  optional bool unmarshaler_all      = 63018;
+  optional bool stable_marshaler_all = 63019;
+
+  optional bool sizer_all = 63020;
+
+  optional bool goproto_enum_stringer_all = 63021;
+  optional bool enum_stringer_all         = 63022;
+
+  optional bool unsafe_marshaler_all   = 63023;
+  optional bool unsafe_unmarshaler_all = 63024;
+
+  optional bool goproto_extensions_map_all = 63025;
+  optional bool goproto_unrecognized_all   = 63026;
+  optional bool gogoproto_import           = 63027;
+  optional bool protosizer_all             = 63028;
+  optional bool compare_all                = 63029;
+  optional bool typedecl_all               = 63030;
+  optional bool enumdecl_all               = 63031;
+
+  optional bool goproto_registration = 63032;
+  optional bool messagename_all      = 63033;
+
+  optional bool goproto_sizecache_all = 63034;
+  optional bool goproto_unkeyed_all   = 63035;
+}
+
+extend google.protobuf.MessageOptions {
+  optional bool goproto_getters  = 64001;
+  optional bool goproto_stringer = 64003;
+  optional bool verbose_equal    = 64004;
+  optional bool face             = 64005;
+  optional bool gostring         = 64006;
+  optional bool populate         = 64007;
+  optional bool stringer         = 67008;
+  optional bool onlyone          = 64009;
+
+  optional bool equal            = 64013;
+  optional bool description      = 64014;
+  optional bool testgen          = 64015;
+  optional bool benchgen         = 64016;
+  optional bool marshaler        = 64017;
+  optional bool unmarshaler      = 64018;
+  optional bool stable_marshaler = 64019;
+
+  optional bool sizer = 64020;
+
+  optional bool unsafe_marshaler   = 64023;
+  optional bool unsafe_unmarshaler = 64024;
+
+  optional bool goproto_extensions_map = 64025;
+  optional bool goproto_unrecognized   = 64026;
+
+  optional bool protosizer = 64028;
+  optional bool compare    = 64029;
+
+  optional bool typedecl = 64030;
+
+  optional bool messagename = 64033;
+
+  optional bool goproto_sizecache = 64034;
+  optional bool goproto_unkeyed   = 64035;
+}
+
+extend google.protobuf.FieldOptions {
+  optional bool   nullable   = 65001;
+  optional bool   embed      = 65002;
+  optional string customtype = 65003;
+  optional string customname = 65004;
+  optional string jsontag    = 65005;
+  optional string moretags   = 65006;
+  optional string casttype   = 65007;
+  optional string castkey    = 65008;
+  optional string castvalue  = 65009;
+
+  optional bool stdtime     = 65010;
+  optional bool stdduration = 65011;
+  optional bool wktpointer  = 65012;
+
+  optional string castrepeated = 65013;
+}