upgradability: fixes to allow more easily to extend an existing driver #1154 (#1155)

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

Author: adecaro

cmd/tokengen/README.md

@@ -43,7 +43,7 @@ Usage:
   tokengen certifier-keygen [flags]
 
 Flags:
-  -d, --driver string   driver (dlog) (default "dlog")
+  -d, --driver string   driver (zkatdlognogh.v1) (default "zkatdlognogh.v1")
   -h, --help            help for certifier-keygen
   -o, --output string   output folder (default ".")
   -p, --pppath string   path to the public parameters file
@@ -53,56 +53,56 @@ Flags:
 
 The `tokengen gen` command has two subcommands, as follows:
 
-- fatoken: generates the public parameters for the fabtoken driver
-- dlog: generates the public parameters for the dlog driver
+- fabtoken.v1: generates the public parameters for the fabtoken driver
+- zkatdlog.v1: generates the public parameters for the zkatdlog.v1 driver
 
-## tokengen gen fabtoken
+## tokengen gen fabtoken.v1
 
 ```
 Usage:
-  tokengen gen fabtoken [flags]
+  tokengen gen fabtoken.v1 [flags]
 
 Flags:
   -a, --auditors strings   list of auditor MSP directories containing the corresponding auditor certificate
       --cc                 generate chaincode package
-  -h, --help               help for fabtoken
+  -h, --help               help for fabtoken.v1
   -s, --issuers strings    list of issuer MSP directories containing the corresponding issuer certificate
   -o, --output string      output folder (default ".")
 
 ```
 
 The public parameters are stored in the output folder with name `fabtoken_pp.json`.
 
-### tokengen gen dlog
+### tokengen gen zkatdlog.v1
 
 ```
 Usage:
-  tokengen gen dlog [flags]
+  tokengen gen zkatdlog.v1 [flags]
 
 Flags:
   -a, --auditors strings   list of auditor MSP directories containing the corresponding auditor certificate
   -b, --base int           base is used to define the maximum quantity a token can contain as Base^Exponent (default 100)
       --cc                 generate chaincode package
   -e, --exponent int       exponent is used to define the maximum quantity a token can contain as Base^Exponent (default 2)
-  -h, --help               help for dlog
+  -h, --help               help for zkatdlog.v1
   -i, --idemix string      idemix msp dir
   -s, --issuers strings    list of issuer MSP directories containing the corresponding issuer certificate
   -o, --output string      output folder (default ".")
 ``` 
 
-The public parameters are stored in the output folder with name `zkatdlog_pp.json`.
+The public parameters are stored in the output folder with name `zkatdlognoghv1_pp.json`.
 
-### tokengen update dlog
+### tokengen update zkatdlog.v1
 
-This command takes an existing `zkatdlog_pp.json` and allows you to update the issuer and/or auditor certificates, while keeping the public parameters intact.
+This command takes an existing `zkatdlognoghv1_pp.json` and allows you to update the issuer and/or auditor certificates, while keeping the public parameters intact.
 
 ```
 Usage:
-  tokengen update dlog [flags]
+  tokengen update zkatdlog.v1 [flags]
 
 Flags:
   -a, --auditors strings   list of auditor MSP directories containing the corresponding auditor certificate
-  -h, --help               help for dlog
+  -h, --help               help for zkatdlog.v1
   -i, --input string       path of the public param file
   -s, --issuers strings    list of issuer MSP directories containing the corresponding issuer certificate
   -o, --output string      output folder (default ".")

cmd/tokengen/cobra/certfier/keypairgen.go

@@ -11,9 +11,10 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
 	driver2 "github.com/hyperledger-labs/fabric-token-sdk/token/core"
 	fabtoken "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/v1/driver"
-	dlog "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/v1/driver"
+	dlogdriver "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/v1/driver"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
 )
@@ -26,7 +27,7 @@ var output string
 func KeyPairGenCmd() *cobra.Command {
 	// Set the flags on the node start command.
 	flags := cobraCommand.Flags()
-	flags.StringVarP(&driver, "driver", "d", "dlog", "driver (dlog)")
+	flags.StringVarP(&driver, "driver", "d", zkatdlognoghv1.DriverIdentifier, "driver (dlog)")
 	flags.StringVarP(&ppPath, "pppath", "p", "", "path to the public parameters file")
 	flags.StringVarP(&output, "output", "o", ".", "output folder")
 
@@ -56,7 +57,7 @@ func keyPairGen(args []string) error {
 	if err != nil {
 		return errors.Wrapf(err, "failed reading public parameters from [%s]", ppPath)
 	}
-	s := driver2.NewPPManagerFactoryService(fabtoken.NewPPMFactory(), dlog.NewPPMFactory())
+	s := driver2.NewPPManagerFactoryService(fabtoken.NewPPMFactory(), dlogdriver.NewPPMFactory())
 	pp, err := s.PublicParametersFromBytes(ppRaw)
 	if err != nil {
 		return errors.Wrapf(err, "failed unmarshalling public parameters loaded from [%s], len [%d]", ppPath, len(ppRaw))

cmd/tokengen/cobra/pp/fabtoken/gen.go cmd/tokengen/cobra/pp/fabtokenv1/gen.gocmd/tokengen/cobra/pp/fabtoken/gen.go renamed to cmd/tokengen/cobra/pp/fabtokenv1/gen.go

@@ -4,7 +4,7 @@ Copyright IBM Corp. All Rights Reserved.
 SPDX-License-Identifier: Apache-2.0
 */
 
-package fabtoken
+package fabtokenv1
 
 import (
 	"fmt"
@@ -13,6 +13,7 @@ import (
 
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/cc"
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/common"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/fabtokenv1"
 	v1 "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/v1/setup"
 
 	"github.com/pkg/errors"
@@ -44,7 +45,7 @@ func Cmd() *cobra.Command {
 }
 
 var cobraCommand = &cobra.Command{
-	Use:   "fabtoken",
+	Use:   fabtokenv1.DriverIdentifier,
 	Short: "Gen FabToken public parameters.",
 	Long:  `Generates FabToken public parameters.`,
 	RunE: func(cmd *cobra.Command, args []string) error {

cmd/tokengen/cobra/pp/gen.go

@@ -7,15 +7,15 @@ SPDX-License-Identifier: Apache-2.0
 package pp
 
 import (
-	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/dlog"
-	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/fabtoken"
+	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/fabtokenv1"
+	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/zkatdlognoghv1"
 	"github.com/spf13/cobra"
 )
 
 // GenCmd returns the Cobra Command for Public Params Generation
 func GenCmd() *cobra.Command {
-	genCobraCommand.AddCommand(fabtoken.Cmd())
-	genCobraCommand.AddCommand(dlog.Cmd())
+	genCobraCommand.AddCommand(fabtokenv1.Cmd())
+	genCobraCommand.AddCommand(zkatdlognoghv1.Cmd())
 
 	return genCobraCommand
 }

cmd/tokengen/cobra/pp/update.go

@@ -7,14 +7,14 @@ SPDX-License-Identifier: Apache-2.0
 package pp
 
 import (
-	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/dlog"
+	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/zkatdlognoghv1"
 	"github.com/spf13/cobra"
 )
 
 // UpdateCmd returns the Cobra Command for updating the config file
 func UpdateCmd() *cobra.Command {
 	// not implemented for fabtoken
-	updateCobraCommand.AddCommand(dlog.UpdateCmd())
+	updateCobraCommand.AddCommand(zkatdlognoghv1.UpdateCmd())
 
 	return updateCobraCommand
 }

cmd/tokengen/cobra/pp/dlog/gen.go …/tokengen/cobra/pp/zkatdlognoghv1/gen.gocmd/tokengen/cobra/pp/dlog/gen.go renamed to cmd/tokengen/cobra/pp/zkatdlognoghv1/gen.go cmd/tokengen/cobra/pp/dlog/gen.go renamed to cmd/tokengen/cobra/pp/zkatdlognoghv1/gen.go

@@ -4,7 +4,7 @@ Copyright IBM Corp. All Rights Reserved.
 SPDX-License-Identifier: Apache-2.0
 */
 
-package dlog
+package zkatdlognoghv1
 
 import (
 	"fmt"
@@ -15,6 +15,7 @@ import (
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/cc"
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/common"
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/idemix"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
 	v1 "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/v1/setup"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
@@ -77,7 +78,7 @@ func Cmd() *cobra.Command {
 }
 
 var cobraCommand = &cobra.Command{
-	Use:   "dlog",
+	Use:   zkatdlognoghv1.DriverIdentifier,
 	Short: "Gen ZKAT DLog public parameters.",
 	Long:  `Generates ZKAT DLog public parameters.`,
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -142,7 +143,7 @@ func Gen(args *GeneratorArgs) ([]byte, error) {
 	if err != nil {
 		return nil, errors.Wrap(err, "failed serializing public parameters")
 	}
-	path := filepath.Join(args.OutputDir, "zkatdlog_pp.json")
+	path := filepath.Join(args.OutputDir, "zkatdlognoghv1_pp.json")
 	if err := os.WriteFile(path, raw, 0755); err != nil {
 		return nil, errors.Wrap(err, "failed writing public parameters to file")
 	}

cmd/tokengen/cobra/pp/dlog/update.go …kengen/cobra/pp/zkatdlognoghv1/update.gocmd/tokengen/cobra/pp/dlog/update.go renamed to cmd/tokengen/cobra/pp/zkatdlognoghv1/update.go cmd/tokengen/cobra/pp/dlog/update.go renamed to cmd/tokengen/cobra/pp/zkatdlognoghv1/update.go

@@ -4,14 +4,15 @@ Copyright IBM Corp. All Rights Reserved.
 SPDX-License-Identifier: Apache-2.0
 */
 
-package dlog
+package zkatdlognoghv1
 
 import (
 	"fmt"
 	"os"
 	"path/filepath"
 
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/common"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
 	v1 "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/v1/setup"
 	"github.com/pkg/errors"
 	"github.com/spf13/cobra"
@@ -44,7 +45,7 @@ func UpdateCmd() *cobra.Command {
 }
 
 var cmd = &cobra.Command{
-	Use:   "dlog",
+	Use:   zkatdlognoghv1.DriverIdentifier,
 	Short: "Update certs in the public parameters file.",
 	Long:  "Update certs in the public parameters file without changing the parameters themselves.",
 	RunE: func(cmd *cobra.Command, args []string) error {
@@ -78,7 +79,7 @@ func Update(args *UpdateArgs) error {
 		return errors.Wrapf(err, "failed to read input file at [%s]", args.InputFile)
 	}
 
-	pp, err := v1.NewPublicParamsFromBytes(oldraw, v1.DLogIdentifier, v1.ProtocolV1)
+	pp, err := v1.NewPublicParamsFromBytes(oldraw, v1.DLogNoGHDriverName, v1.ProtocolV1)
 	if err != nil {
 		return errors.Wrapf(err, "failed to unmarshal pp from [%s]", args.InputFile)
 	}
@@ -103,9 +104,9 @@ func Update(args *UpdateArgs) error {
 	if err != nil {
 		return errors.Wrap(err, "failed serializing public parameters")
 	}
-	path := filepath.Join(args.OutputDir, "zkatdlog_pp.json")
+	path := filepath.Join(args.OutputDir, "zkatdlognoghv1_pp.json")
 	if _, err := os.Stat(path); err == nil {
-		return errors.New("zkatdlog_pp.json exists in current directory. Specify another output folder with -o")
+		return errors.New("zkatdlognoghv1_pp.json exists in current directory. Specify another output folder with -o")
 	}
 	if err := os.WriteFile(path, raw, 0755); err != nil {
 		return errors.Wrap(err, "failed writing public parameters to file")

cmd/tokengen/main_test.go

@@ -14,6 +14,8 @@ import (
 	"testing"
 
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/pp/common"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/fabtokenv1"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
 	v1 "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/v1/setup"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/utils"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/utils/slices"
@@ -22,7 +24,7 @@ import (
 )
 
 // To run this command, first make sure to install the tokengen tool. To do that run `make tokengen`.
-//go:generate tokengen gen dlog --idemix "./testdata/idemix" --issuers "./testdata/issuers/msp" --auditors "./testdata/auditors/msp" --output "./testdata"
+//go:generate tokengen gen zkatdlognogh.v1 --idemix "./testdata/idemix" --issuers "./testdata/issuers/msp" --auditors "./testdata/auditors/msp" --output "./testdata"
 
 func TestCompile(t *testing.T) {
 	gt := NewGomegaWithT(t)
@@ -45,7 +47,7 @@ func TestGenFullSuccess(t *testing.T) {
 		tokengen,
 		[]string{
 			"gen",
-			"dlog",
+			zkatdlognoghv1.DriverIdentifier,
 			"--idemix",
 			"./testdata/idemix",
 			"--issuers",
@@ -81,13 +83,13 @@ func TestFullUpdate(t *testing.T) {
 		tokengen,
 		[]string{
 			"update",
-			"dlog",
+			zkatdlognoghv1.DriverIdentifier,
 			"--issuers",
 			"./testdata/auditors/msp",
 			"--auditors",
 			"./testdata/issuers/msp",
 			"--input",
-			"./testdata/zkatdlog_pp.json",
+			"./testdata/zkatdlognoghv1_pp.json",
 			"--output",
 			tempOutput,
 		},
@@ -118,11 +120,11 @@ func TestPartialUpdate(t *testing.T) {
 		tokengen,
 		[]string{
 			"update",
-			"dlog",
+			zkatdlognoghv1.DriverIdentifier,
 			"--issuers",
 			"./testdata/auditors/msp",
 			"--input",
-			"./testdata/zkatdlog_pp.json",
+			"./testdata/zkatdlognoghv1_pp.json",
 			"--output",
 			tempOutput,
 		},
@@ -148,7 +150,7 @@ func TestGenFailure(t *testing.T) {
 		ErrMsg string
 	}
 	var tests []T
-	for _, driver := range []string{"fabtoken"} {
+	for _, driver := range []string{fabtokenv1.DriverIdentifier} {
 		tests = append(tests, []T{
 			{
 				Args: []string{
@@ -188,15 +190,15 @@ func TestGenFailure(t *testing.T) {
 		{
 			Args: []string{
 				"gen",
-				"dlog",
+				zkatdlognoghv1.DriverIdentifier,
 				"--issuers", "aOrg1MSP,b",
 			},
 			ErrMsg: "failed to generate public parameters: failed to load issuer public key: failed reading idemix issuer public key [msp/IssuerPublicKey]: open msp/IssuerPublicKey: no such file or directory",
 		},
 		{
 			Args: []string{
 				"gen",
-				"dlog",
+				zkatdlognoghv1.DriverIdentifier,
 				"--idemix", "./testdata/idemix",
 				"--issuers", "Error: failed to generate public parameters: failed to get issuer identity [aOrg1MSP]: invalid input [aOrg1MSP]",
 			},
@@ -213,10 +215,10 @@ func TestGenFailure(t *testing.T) {
 }
 
 func validateOutputEquivalent(gt *WithT, tempOutput, auditorsMSPdir, issuersMSPdir, idemixMSPdir string) {
-	ppRaw, err := os.ReadFile(filepath.Join(tempOutput, "zkatdlog_pp.json"))
+	ppRaw, err := os.ReadFile(filepath.Join(tempOutput, "zkatdlognoghv1_pp.json"))
 	gt.Expect(err).NotTo(HaveOccurred())
 
-	pp, err := v1.NewPublicParamsFromBytes(ppRaw, v1.DLogIdentifier, v1.ProtocolV1)
+	pp, err := v1.NewPublicParamsFromBytes(ppRaw, v1.DLogNoGHDriverName, v1.ProtocolV1)
 	gt.Expect(err).NotTo(HaveOccurred())
 	gt.Expect(pp.Validate()).NotTo(HaveOccurred())
 

cmd/tokengen/samples/topology/fungible.go

@@ -14,6 +14,7 @@ import (
 	"github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen/cobra/artifactgen"
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token"
 	fabric2 "github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/fabric"
+	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/token/fungible/views"
 	tokensdk "github.com/hyperledger-labs/fabric-token-sdk/token/sdk/dig"
 )
@@ -116,7 +117,7 @@ func Topology(tokenSDKDriver string, sdks ...node.SDK) []api.Topology {
 }
 
 func main() {
-	if err := artifactgen.WriteTopologies("fungible.yaml", Topology("dlog", &tokensdk.SDK{}), 0766); err != nil {
+	if err := artifactgen.WriteTopologies("fungible.yaml", Topology(zkatdlognoghv1.DriverIdentifier, &tokensdk.SDK{}), 0766); err != nil {
 		panic(err)
 	}
 }