protobuf refactoring + cascading services refactoring and update

Signed-off-by: Angelo De Caro <adc@zurich.ibm.com>

Author: adecaro

Makefile

@@ -257,4 +257,15 @@ docs-serve:
 .PHONY: docs-build
 # Build the static documentation site for production
 docs-build:
-	mkdocs build --strict
+	mkdocs build --strict
+
+.PHONY: protos-format
+protos-format: ## Run buf format to fix protobuf files
+	@echo "Fixing protobuf formatting..."
+	@buf format -w
+
+.PHONY: protos
+# generate protobuf files
+protos:
+	@echo "Generating protobuf files..."
+	@buf generate

buf.gen.yaml

@@ -0,0 +1,6 @@
+version: v2
+plugins:
+  - local: protoc-gen-go
+    out: .
+    opt:
+      - module=github.com/hyperledger-labs/fabric-token-sdk

buf.yaml

@@ -0,0 +1,24 @@
+version: v2
+modules:
+  - path: token/core/fabtoken/protos/v1
+  - path: token/core/zkatdlog/nogh/protos/v1
+  - path: token/driver/protos/v1
+  - path: token/services/identity/x509/crypto/protos/v1
+  - path: token/services/identity/idemix/crypto/protos
+lint:
+  use:
+    - STANDARD
+    - PACKAGE_DIRECTORY_MATCH
+    - PACKAGE_VERSION_SUFFIX
+    - FIELD_LOWER_SNAKE_CASE
+    - ENUM_ZERO_VALUE_SUFFIX
+    - ENUM_VALUE_PREFIX
+    - COMMENTS # Enforce documentation standards
+  except:
+    - PACKAGE_DIRECTORY_MATCH
+    - PACKAGE_SAME_GO_PACKAGE
+  ignore:
+    - token/services/identity/idemix/crypto/protos/idemix_config.proto
+breaking:
+  use:
+    - FILE

checks.mk

@@ -1,16 +1,16 @@
 .PHONY: checks
-checks: licensecheck gofmt goimports govet misspell ineffassign staticcheck
+checks: licensecheck gofmt goimports govet misspell ineffassign staticcheck protos-lint buf-format
 
 .PHONY: licensecheck
 licensecheck:
 	@echo Running license check
-	@find . -path './.git' -prune -o -name '*.go' -print | xargs addlicense -check || (echo "Missing license headers"; exit 1)
+	@find . -path './.git' -prune -o -name '*.go' -not -name '*.pb.go' -print | xargs addlicense -check || (echo "Missing license headers"; exit 1)
 
 .PHONY: gofmt
 gofmt:
 	@echo Running gofmt
 	@{ \
-	OUTPUT="$$(find . -path './.git' -prune -o -name '*.go' -print | xargs gofmt -l -s || true)"; \
+	OUTPUT="$$(find . -path './.git' -prune -o -name '*.go' -not -name '*.pb.go' -print | xargs gofmt -l -s || true)"; \
 	if [ -n "$$OUTPUT" ]; then \
 		echo "The following gofmt issues were flagged:"; \
 		echo "$$OUTPUT"; \
@@ -23,7 +23,7 @@ gofmt:
 goimports:
 	@echo Running goimports
 	@{ \
-	OUTPUT="$$(find . -path './.git' -prune -o -name '*.go' -print | xargs goimports -l || true)"; \
+	OUTPUT="$$(find . -path './.git' -prune -o -name '*.go' -not -name '*.pb.go' -print | xargs goimports -l || true)"; \
 	if [ -n "$$OUTPUT" ]; then \
     	echo "The following files contain goimports errors"; \
     	echo "$$OUTPUT"; \
@@ -71,6 +71,12 @@ ineffassign:
 	@echo Running ineffassign
 	@ineffassign $(shell go list -f '{{.Dir}}' ./...)
 
+.PHONY: protos-lint
+protos-lint:
+	@echo "Linting protobuf files..."
+	@buf lint
 
-
-
+.PHONY: buf-format
+buf-format:
+	@echo "Checking protobuf formatting..."
+	@buf format -d --exit-code

cmd/artifactgen/go.sum

@@ -1299,6 +1299,7 @@ github.com/quic-go/qpack v0.6.0 h1:g7W+BMYynC1LbYLSqRt8PBg5Tgwxn214ZZR34VIOjz8=
 github.com/quic-go/qpack v0.6.0/go.mod h1:lUpLKChi8njB4ty2bFLX2x4gzDqXwUpaO1DP9qMDZII=
 github.com/quic-go/quic-go v0.59.1 h1:0Gmua0HW1Tv7ANR7hUYwRyD0MG5OJfgvYSZasGZzBic=
 github.com/quic-go/quic-go v0.59.1/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU=
+github.com/quic-go/quic-go v0.59.1/go.mod h1:upnsH4Ju1YkqpLXC305eW3yDZ4NfnNbmQRCMWS58IKU=
 github.com/quic-go/webtransport-go v0.10.0 h1:LqXXPOXuETY5Xe8ITdGisBzTYmUOy5eSj+9n4hLTjHI=
 github.com/quic-go/webtransport-go v0.10.0/go.mod h1:LeGIXr5BQKE3UsynwVBeQrU1TPrbh73MGoC6jd+V7ow=
 github.com/remyoudompheng/bigfft v0.0.0-20200410134404-eec4a21b6bb0/go.mod h1:qqbHyh8v60DhA7CoWK5oRCqLrMHRGoxYCSS9EjAz6Eo=

cmd/tokengen/cobra/pp/fabtokenv1/gen.go

@@ -33,7 +33,7 @@ var (
 	// Auditors is the list of auditor MSP directories containing the corresponding auditor certificate.
 	Auditors []string
 	// Version allows the caller of tokengen to override the version number put in the public parameters.
-	Version uint
+	Version uint32
 	// Extras allows the caller to add extra parameters to the public parameters.
 	Extras []string
 )
@@ -46,7 +46,7 @@ func Cmd() *cobra.Command {
 	flags.BoolVarP(&GenerateCCPackage, "cc", "", false, "generate chaincode package")
 	flags.StringSliceVarP(&Auditors, "auditors", "a", nil, "list of auditor MSP directories containing the corresponding auditor certificate")
 	flags.StringSliceVarP(&Issuers, "issuers", "s", nil, "list of issuer MSP directories containing the corresponding issuer certificate")
-	flags.UintVarP(&Version, "version", "v", 0, "allows the caller of tokengen to override the version number put in the public params")
+	flags.Uint32VarP(&Version, "version", "v", 0, "allows the caller of tokengen to override the version number put in the public params")
 	flags.StringArrayVarP(&Extras, "extra", "x", []string{}, "extra data in key=value format, where value is the path to a file containing the data to load and store in the key")
 
 	return cobraCommand

cmd/tokengen/cobra/pp/zkatdlognoghv1/gen.go

@@ -39,7 +39,7 @@ type GeneratorArgs struct {
 	// Aries is a flag to indicate that aries should be used as backend for idemix
 	Aries bool
 	// Version allows the caller of tokengen to override the version number put in the public params
-	Version uint
+	Version uint32
 }
 
 var (
@@ -59,7 +59,7 @@ var (
 	// Aries is a flag to indicate that aries should be used as backend for idemix
 	Aries bool
 	// Version allows the caller of tokengen to override the version number put in the public params
-	Version uint
+	Version uint32
 	// Extras allows the caller to add extra parameters to the public parameters
 	Extras []string
 )
@@ -75,7 +75,7 @@ func Cmd() *cobra.Command {
 	flags.StringVarP(&IdemixMSPDir, "idemix", "i", "", "idemix msp dir")
 	flags.Uint64VarP(&BitLength, "bits", "b", 64, "bits is used to define the maximum quantity a token can contain")
 	flags.BoolVarP(&Aries, "aries", "r", false, "flag to indicate that aries should be used as backend for idemix")
-	flags.UintVarP(&Version, "version", "v", 0, "allows the caller of tokengen to override the version number put in the public params")
+	flags.Uint32VarP(&Version, "version", "v", 0, "allows the caller of tokengen to override the version number put in the public params")
 	flags.StringArrayVarP(&Extras, "extra", "x", []string{}, "extra data in key=value format, where value is the path to a file containing the data to load and store in the key")
 
 	return cobraCommand

cmd/tokengen/cobra/pp/zkatdlognoghv1/update.go

@@ -33,7 +33,7 @@ type UpdateArgs struct {
 	// Auditors is the list of auditor MSP directories containing the corresponding auditor certificate
 	Auditors []string
 	// Version allows the caller of tokengen to override the version number put in the public params
-	Version uint
+	Version uint32
 }
 
 // UpdateCmd returns the Cobra Command for updating public parameters.
@@ -44,7 +44,7 @@ func UpdateCmd() *cobra.Command {
 	flags.StringVarP(&OutputDir, "output", "o", ".", "output folder")
 	flags.StringSliceVarP(&Auditors, "auditors", "a", nil, "list of auditor MSP directories containing the corresponding auditor certificate")
 	flags.StringSliceVarP(&Issuers, "issuers", "s", nil, "list of issuer MSP directories containing the corresponding issuer certificate")
-	flags.UintVarP(&Version, "version", "v", 0, "allows the caller of tokengen to override the version number put in the public params")
+	flags.Uint32VarP(&Version, "version", "v", 0, "allows the caller of tokengen to override the version number put in the public params")
 	flags.StringArrayVarP(&Extras, "extra", "x", []string{}, "extra data in key=value format, where is the path to a file containing the data to load and store in the key")
 
 	return cmd