protobuf refactoring

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

Author: adecaro

.golangci.yml

@@ -1,87 +1,42 @@
 version: "2"
 linters:
   enable:
+    - asasalint # Check for pass []any as any in variadic func(...any).
     - canonicalheader # Canonicalheader checks whether net/http.Header uses canonical header. [auto-fix]
+    - copyloopvar # A linter detects places where loop variables are copied. [fast, auto-fix]
+    - depguard # Go linter that checks if package imports are in a list of acceptable packages. [fast]
     - dupword # Checks for duplicate words in the source code. [fast, auto-fix]
+    - durationcheck # Check for two durations multiplied together.
     - errorlint # Find code that can cause problems with the error wrapping scheme introduced in Go 1.13. [auto-fix]
     - exptostd # Detects functions from golang.org/x/exp/ that can be replaced by std functions. [auto-fix]
     - ginkgolinter # Enforces standards of using ginkgo and gomega. [auto-fix]
     - goheader # Check if file header matches to pattern. [fast, auto-fix]
+    - gosec # Inspects source code for security problems.
     - govet # Vet examines Go source code and reports suspicious constructs. It is roughly the same as 'go vet' and uses its passes. [auto-fix]
     - importas # Enforces consistent import aliases. [auto-fix]
+    - intrange # Intrange is a linter to find places where for loops could make use of an integer range. [auto-fix]
+    - loggercheck # Checks key value pairs for common logger libraries (kitlog,klog,logr,slog,zap).
     - mirror # Reports wrong mirror patterns of bytes/strings usage. [auto-fix]
     - misspell # Finds commonly misspelled English words. [fast, auto-fix]
     - nakedret # Checks that functions with naked returns are not longer than a maximum size (can be zero). [fast, auto-fix]
+    - nilerr # Find the code that returns nil even if it checks that the error is not nil.
+    - nilnesserr # Reports constructs that checks for err != nil, but returns a different nil value error.
+    - nlreturn # Checks for a new line before return and branch statements to increase code clarity. [fast, auto-fix]
     - nolintlint # Reports ill-formed or insufficient nolint directives. [fast, auto-fix]
+    - perfsprint # Checks that fmt.Sprintf can be replaced with a faster alternative. [auto-fix]
+    - reassign # Checks that package variables are not reassigned.
     - sloglint # Ensure consistent code style when using log/slog. [auto-fix]
+    - spancheck # Checks for mistakes with OpenTelemetry/Census spans.
     - staticcheck # It's the set of rules from staticcheck. [auto-fix]
+    - tagalign # Check that struct tags are well aligned. [fast, auto-fix]
+    - testifylint # Checks usage of github.com/stretchr/testify. [auto-fix]
+    - thelper # Thelper detects tests helpers which do not start with the t.Helper() method.
+    - unconvert # Remove unnecessary type conversions.
     - usestdlibvars # A linter that detect the possibility to use variables/constants from the Go standard library. [fast, auto-fix]
     - usetesting # Reports uses of functions with replacement inside the testing package. [auto-fix]
+    - wastedassign # Finds wasted assignment statements.
     - whitespace # Whitespace is a linter that checks for unnecessary newlines at the start and end of functions, if, for, etc. [fast, auto-fix]
-    - copyloopvar # A linter detects places where loop variables are copied. [fast, auto-fix]
-#    - err113 # Check errors handling expressions. [auto-fix]
-#    - fatcontext # Detects nested contexts in loops and function literals. [auto-fix]
-#    - gocritic # Provides diagnostics that check for bugs, performance and style issues. [auto-fix]
-#    - iface # Detect the incorrect use of interfaces, helping developers avoid interface pollution. [auto-fix]
-    - intrange # Intrange is a linter to find places where for loops could make use of an integer range. [auto-fix]
-    - nlreturn # Checks for a new line before return and branch statements to increase code clarity. [fast, auto-fix]
-    - perfsprint # Checks that fmt.Sprintf can be replaced with a faster alternative. [auto-fix]
-#    - protogetter # Reports direct reads from proto message fields when getters should be used. [auto-fix]
-#    - revive # Fast, configurable, extensible, flexible, and beautiful linter for Go. Drop-in replacement of golint. [auto-fix]
-    - tagalign # Check that struct tags are well aligned. [fast, auto-fix]
-    - testifylint # Checks usage of github.com/stretchr/testify. [auto-fix]
-#    - wsl_v5 # Add or remove empty lines. [auto-fix]
-#    - containedctx
-#    - contextcheck
-    - depguard
-#    - dupl
-#    - errname
-    - errorlint
-#    - fatcontext
-#    - forcetypeassert
-    - ginkgolinter
-#    - gocognit
-#    - goconst
-#    - gocritic
-#    - godot
-    - gosec
-#    - intrange
-#    - ireturn
-#    - lll
-#    - maintidx
-    - mirror
-    - misspell
-    - nilerr
-    - nilnesserr
-    - nolintlint
-#    - paralleltest
-#    - prealloc
-#    - promlinter
-#    - revive
-#    - rowserrcheck
-#    - sqlclosecheck
-#    - testifylint
-    - thelper
-    - unconvert
-#    - unparam
-    - usetesting
-    - wastedassign
-    - whitespace
-    - govet
-#    - staticcheck
-    - canonicalheader
-#    - copyloopvar
-    - dupword
-#    - err113
-    - exptostd
-    - goheader
-    - importas
-#    - intrange
-    - nakedret
-    - sloglint
-    - usestdlibvars
-    # wrapcheck is not working as expected. It is categorizing internal packages as external.
-    #- wrapcheck
+    - zerologlint # Detects the wrong usage of `zerolog` that a user forgets to dispatch with `Send` or `Msg`.
   settings:
     depguard:
       rules:
@@ -91,19 +46,13 @@ linters:
               desc: github.com/pkg/errors is no longer maintained
     errcheck:
       # Report about not checking of errors in type assertions: `a := b.(MyStruct)`.
-      # Such cases aren't reported by default.
-#      Default: false
       check-type-assertions: false
     errorlint:
       # Check whether fmt.Errorf uses the %w verb for formatting errors.
-      # See the https://github.com/polyfloyd/go-errorlint for caveats.
-      # Default: true
       errorf: true
       # Check for plain type assertions and type switches.
-      # Default: true
       asserts: false
       # Check for plain error comparisons.
-      # Default: true
       comparison: true
     fatcontext:
       check-struct-pointers: true
@@ -118,7 +67,6 @@ linters:
       disable:
         - fieldalignment
       # Enable all analyzers.
-      # Default: false
       enable-all: false
     iface:
       enable:
@@ -141,8 +89,6 @@ linters:
         - github.com/prometheus/client_golang/prometheus.Histogram
     lll:
       # Max line length, lines longer will be reported.
-      # '\t' is counted as 1 character by default, and can be changed with the tab-width option.
-      # Default: 120.
       line-length: 240
     maintidx:
       under: 20
@@ -191,18 +137,11 @@ linters:
         - github.com/jackc/pgx/v4
     wrapcheck:
       # An array of strings specifying additional substrings of signatures to ignore.
-      # Unlike 'ignoreSigs', this option extends the default set (or the set specified in 'ignoreSigs') without replacing it entirely.
-      # This allows you to add specific signatures to the ignore list
-      # while retaining the defaults or any items in 'ignoreSigs'.
-      # Default: []
       extra-ignore-sigs:
         - .CustomError(
         - .SpecificWrap(
 
       # An array of strings that specify substrings of signatures to ignore.
-      # If this set, it will override the default set of ignored signatures.
-      # See https://github.com/tomarrell/wrapcheck#configuration for more information.
-      # Default: [".Errorf(", "errors.New(", "errors.Unwrap(", "errors.Join(", ".Wrap(", ".Wrapf(", ".WithMessage(", ".WithMessagef(", ".WithStack("]
       ignore-sigs:
         - errors.New(
         - errors.Newf(
@@ -211,36 +150,15 @@ linters:
         - .Wrap(
         - .Wrapf(
         - status.Error(
-        - .Wait() # The error reported by errorgroup.Wait() (external) actually
-                  # originates from the internal code.
+        - .Wait() # The error reported by errorgroup.Wait() (external) actually originates from the internal code.
       # An array of strings that specify regular expressions of signatures to ignore.
-      # Default: []
       ignore-sig-regexps:
         - \.New.*Error\(
-      # An array of strings that specify globs of packages to ignore.
-      # Default: []
-      ignore-package-globs:
-        - github.ibm.com/decentralized-trust-research/scalable-committer/utils/grpcerror
-      # An array of strings that specify regular expressions of interfaces to ignore.
-      # Default: []
-      # ignoreInterfaceRegexps:
-      #   - ^(?i)c(?-i)ach(ing|e)
   exclusions:
-      # Mode of the generated files analysis.
-      #
-      # - `strict`: sources are excluded by strictly following the Go generated file convention.
-      #    Source files that have lines matching only the following regular expression will be excluded: `^// Code generated .* DO NOT EDIT\.$`
-      #    This line must appear before the first non-comment, non-blank text in the file.
-      #    https://go.dev/s/generatedcode
-      # - `lax`: sources are excluded if they contain lines like `autogenerated file`, `code generated`, `do not edit`, etc.
-      # - `disable`: disable the generated files exclusion.
-      #
-      # Default: lax
-      generated: lax
-      # Log a warning if an exclusion rule is unused.
-      # Default: false
-      warn-unused: true
-      # Predefined exclusion rules.
-      # Default: []
-      presets:
-        - common-false-positives
+    # Mode of the generated files analysis.
+    generated: lax
+    # Log a warning if an exclusion rule is unused.
+    warn-unused: true
+    # Predefined exclusion rules.
+    presets:
+      - common-false-positives

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/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