tokengen: version override #1197 (#1198)

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

Author: adecaro

cmd/tokengen/README.md

@@ -68,10 +68,11 @@ Flags:
   -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 ".")
-
+  -v, --version uint       allows the caller of tokengen to override the version number put in the public params
 ```
 
-The public parameters are stored in the output folder with name `fabtoken_pp.json`.
+The public parameters are stored in the output folder with name `fabtokenv1_pp.json`.
+If version is overridden, then file name will be `("fabtokenv%d_pp.json", version)`.
 
 ### tokengen gen zkatdlog.v1
 
@@ -88,9 +89,11 @@ Flags:
   -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 ".")
+  -v, --version uint       allows the caller of tokengen to override the version number put in the public params
 ``` 
 
 The public parameters are stored in the output folder with name `zkatdlognoghv1_pp.json`.
+If version is overridden, then file name will be `("zkatdlognogh%d_pp.json", version)`.
 
 ### tokengen update zkatdlog.v1
 
@@ -106,6 +109,7 @@ Flags:
   -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 ".")
+  -v, --version uint       allows the caller of tokengen to override the version number put in the public params
 ```
 
 ## tokengen pp

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

@@ -15,6 +15,7 @@ import (
 	"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/hyperledger-labs/fabric-token-sdk/token/driver"
 
 	"github.com/hyperledger-labs/fabric-smart-client/pkg/utils/errors"
 	"github.com/spf13/cobra"
@@ -31,6 +32,8 @@ var (
 	Issuers []string
 	// 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
 )
 
 // Cmd returns the Cobra Command for Version
@@ -41,6 +44,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")
 	return cobraCommand
 }
 
@@ -88,7 +92,11 @@ type GeneratorArgs struct {
 // Gen generates the public parameters for the FabToken driver
 func Gen(args *GeneratorArgs) ([]byte, error) {
 	// Setup
-	pp, err := v1.Setup(v1.DefaultPrecision)
+	ver := v1.ProtocolV1
+	if Version != 0 {
+		ver = driver.TokenDriverVersion(Version)
+	}
+	pp, err := v1.SetupWithVersion(v1.DefaultPrecision, ver)
 	if err != nil {
 		return nil, errors.Wrap(err, "failed setting up public parameters")
 	}
@@ -100,7 +108,10 @@ func Gen(args *GeneratorArgs) ([]byte, error) {
 	if err != nil {
 		return nil, errors.Wrap(err, "failed serializing public parameters")
 	}
-	path := filepath.Join(args.OutputDir, "fabtoken_pp.json")
+	path := filepath.Join(
+		args.OutputDir,
+		fmt.Sprintf("fabtoken%d_pp.json", ver),
+	)
 	if err := os.WriteFile(path, raw, 0755); err != nil {
 		return nil, errors.Wrap(err, "failed writing public parameters to file")
 	}

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

@@ -18,6 +18,7 @@ import (
 	"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/hyperledger-labs/fabric-token-sdk/token/driver"
 	"github.com/spf13/cobra"
 )
 
@@ -38,6 +39,8 @@ type GeneratorArgs struct {
 	Exponent uint
 	// 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
 }
 
 var (
@@ -59,6 +62,8 @@ var (
 	Exponent uint
 	// 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
 )
 
 // Cmd returns the Cobra Command for Version
@@ -73,6 +78,7 @@ func Cmd() *cobra.Command {
 	flags.UintVarP(&Base, "base", "b", 100, "base is used to define the maximum quantity a token can contain as Base^Exponent")
 	flags.UintVarP(&Exponent, "exponent", "e", 2, "exponent is used to define the maximum quantity a token can contain as Base^Exponent")
 	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")
 
 	return cobraCommand
 }
@@ -96,6 +102,7 @@ var cobraCommand = &cobra.Command{
 			Base:              Base,
 			Exponent:          Exponent,
 			Aries:             Aries,
+			Version:           Version,
 		})
 		if err != nil {
 			fmt.Printf("failed to generate public parameters [%s]\n", err)
@@ -127,7 +134,11 @@ func Gen(args *GeneratorArgs) ([]byte, error) {
 		curveID = math3.BLS12_381_BBS
 	}
 	// todo range is hardcoded, to be changed
-	pp, err := v1.Setup(64, ipkBytes, curveID)
+	ver := v1.ProtocolV1
+	if args.Version != 0 {
+		ver = driver.TokenDriverVersion(args.Version)
+	}
+	pp, err := v1.SetupWithVersion(64, ipkBytes, curveID, ver)
 	if err != nil {
 		return nil, errors.Wrap(err, "failed setting up public parameters")
 	}
@@ -143,7 +154,10 @@ func Gen(args *GeneratorArgs) ([]byte, error) {
 	if err != nil {
 		return nil, errors.Wrap(err, "failed serializing public parameters")
 	}
-	path := filepath.Join(args.OutputDir, "zkatdlognoghv1_pp.json")
+	path := filepath.Join(
+		args.OutputDir,
+		fmt.Sprintf("zkatdlognoghv%d_pp.json", ver),
+	)
 	if err := os.WriteFile(path, raw, 0755); err != nil {
 		return nil, errors.Wrap(err, "failed writing public parameters to file")
 	}

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

@@ -15,6 +15,7 @@ import (
 	"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/hyperledger-labs/fabric-token-sdk/token/driver"
 	"github.com/spf13/cobra"
 )
 
@@ -30,6 +31,8 @@ type UpdateArgs struct {
 	Issuers []string
 	// 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
 }
 
 // UpdateCmd returns the Cobra Command for Update
@@ -40,6 +43,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")
 
 	return cmd
 }
@@ -59,6 +63,7 @@ var cmd = &cobra.Command{
 			OutputDir: OutputDir,
 			Issuers:   Issuers,
 			Auditors:  Auditors,
+			Version:   Version,
 		})
 		if err != nil {
 			return errors.Wrap(err, "failed to generate public parameters")
@@ -99,14 +104,25 @@ func Update(args *UpdateArgs) error {
 		return err
 	}
 
+	// update version if needed
+	ver := v1.ProtocolV1
+	if args.Version != 0 {
+		ver = driver.TokenDriverVersion(args.Version)
+	}
+	pp.DriverVersion = ver
+
 	// Store Public Params
 	raw, err := pp.Serialize()
 	if err != nil {
 		return errors.Wrap(err, "failed serializing public parameters")
 	}
-	path := filepath.Join(args.OutputDir, "zkatdlognoghv1_pp.json")
+	fileName := fmt.Sprintf("zkatdlognoghv%d_pp.json", ver)
+	path := filepath.Join(
+		args.OutputDir,
+		fileName,
+	)
 	if _, err := os.Stat(path); err == nil {
-		return errors.New("zkatdlognoghv1_pp.json exists in current directory. Specify another output folder with -o")
+		return errors.Errorf("%s exists in current directory. Specify another output folder with -o", fileName)
 	}
 	if err := os.WriteFile(path, raw, 0755); err != nil {
 		return errors.Wrap(err, "failed writing public parameters to file")

cmd/tokengen/main_test.go

@@ -17,6 +17,7 @@ import (
 	"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/driver"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/utils"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/utils/slices"
 	. "github.com/onsi/gomega"
@@ -65,6 +66,45 @@ func TestGenFullSuccess(t *testing.T) {
 		"./testdata/auditors/msp",
 		"./testdata/issuers/msp",
 		"./testdata/idemix/msp/IssuerPublicKey",
+		v1.ProtocolV1,
+	)
+}
+
+func TestGenFullSuccessWithVersionOverride(t *testing.T) {
+	gt := NewGomegaWithT(t)
+	tokengen, err := gexec.Build("github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen")
+	gt.Expect(err).NotTo(HaveOccurred())
+	defer gexec.CleanupBuildArtifacts()
+
+	tempOutput := t.TempDir()
+	defer utils.IgnoreErrorWithOneArg(os.RemoveAll, tempOutput)
+
+	testGenRun(
+		gt,
+		tokengen,
+		[]string{
+			"gen",
+			zkatdlognoghv1.DriverIdentifier,
+			"--idemix",
+			"./testdata/idemix",
+			"--issuers",
+			"./testdata/issuers/msp",
+			"--auditors",
+			"./testdata/auditors/msp",
+			"--output",
+			tempOutput,
+			"--version",
+			"2",
+		},
+	)
+
+	validateOutputEquivalent(
+		gt,
+		tempOutput,
+		"./testdata/auditors/msp",
+		"./testdata/issuers/msp",
+		"./testdata/idemix/msp/IssuerPublicKey",
+		driver.TokenDriverVersion(2),
 	)
 }
 
@@ -101,6 +141,7 @@ func TestFullUpdate(t *testing.T) {
 		"./testdata/issuers/msp",
 		"./testdata/auditors/msp",
 		"./testdata/idemix/msp/IssuerPublicKey",
+		v1.ProtocolV1,
 	)
 }
 
@@ -136,6 +177,45 @@ func TestPartialUpdate(t *testing.T) {
 		"./testdata/auditors/msp",
 		"./testdata/auditors/msp",
 		"./testdata/idemix/msp/IssuerPublicKey",
+		v1.ProtocolV1,
+	)
+}
+
+func TestPartialUpdateWithVersion(t *testing.T) {
+	gt := NewWithT(t)
+	tokengen, err := gexec.Build("github.com/hyperledger-labs/fabric-token-sdk/cmd/tokengen")
+	gt.Expect(err).NotTo(HaveOccurred())
+	defer gexec.CleanupBuildArtifacts()
+
+	tempOutput := t.TempDir()
+	defer utils.IgnoreErrorWithOneArg(os.RemoveAll, tempOutput)
+
+	// Only changing the issuer cert to also use the auditor cert.
+	// The other auditor cert should stay the same.
+	testGenRun(
+		gt,
+		tokengen,
+		[]string{
+			"update",
+			zkatdlognoghv1.DriverIdentifier,
+			"--issuers",
+			"./testdata/auditors/msp",
+			"--input",
+			"./testdata/zkatdlognoghv1_pp.json",
+			"--output",
+			tempOutput,
+			"--version",
+			"2",
+		},
+	)
+
+	validateOutputEquivalent(
+		gt,
+		tempOutput,
+		"./testdata/auditors/msp",
+		"./testdata/auditors/msp",
+		"./testdata/idemix/msp/IssuerPublicKey",
+		driver.TokenDriverVersion(2),
 	)
 }
 
@@ -214,11 +294,18 @@ func TestGenFailure(t *testing.T) {
 	}
 }
 
-func validateOutputEquivalent(gt *WithT, tempOutput, auditorsMSPdir, issuersMSPdir, idemixMSPdir string) {
-	ppRaw, err := os.ReadFile(filepath.Join(tempOutput, "zkatdlognoghv1_pp.json"))
+func validateOutputEquivalent(
+	gt *WithT,
+	tempOutput, auditorsMSPdir, issuersMSPdir, idemixMSPdir string,
+	version driver.TokenDriverVersion,
+) {
+	ppRaw, err := os.ReadFile(filepath.Join(
+		tempOutput,
+		fmt.Sprintf("zkatdlognoghv%d_pp.json", version),
+	))
 	gt.Expect(err).NotTo(HaveOccurred())
 
-	pp, err := v1.NewPublicParamsFromBytes(ppRaw, v1.DLogNoGHDriverName, v1.ProtocolV1)
+	pp, err := v1.NewPublicParamsFromBytes(ppRaw, v1.DLogNoGHDriverName, version)
 	gt.Expect(err).NotTo(HaveOccurred())
 	gt.Expect(pp.Validate()).NotTo(HaveOccurred())
 

token/core/fabtoken/v1/setup/setup.go

@@ -47,6 +47,11 @@ func Setup(precision uint64) (*PublicParams, error) {
 	return NewWith(FabTokenDriverName, ProtocolV1, precision)
 }
 
+// SetupWithVersion is like Setup with the additional possibility to specify the version number
+func SetupWithVersion(precision uint64, version driver.TokenDriverVersion) (*PublicParams, error) {
+	return NewWith(FabTokenDriverName, version, precision)
+}
+
 // NewPublicParamsFromBytes deserializes the raw bytes into public parameters
 // The resulting public parameters are labeled with the passed label
 func NewPublicParamsFromBytes(raw []byte, driverName driver.TokenDriverName, driverVersion driver.TokenDriverVersion) (*PublicParams, error) {

token/core/zkatdlog/nogh/v1/setup/setup.go

@@ -30,7 +30,7 @@ import (
 
 const (
 	DLogNoGHDriverName = "zkatdlognogh"
-	ProtocolV1         = 1
+	ProtocolV1         = driver.TokenDriverVersion(1)
 )
 
 var (
@@ -198,6 +198,11 @@ func Setup(bitLength uint64, idemixIssuerPK []byte, idemixCurveID mathlib.CurveI
 	return NewWith(DLogNoGHDriverName, ProtocolV1, bitLength, idemixIssuerPK, idemixCurveID)
 }
 
+// SetupWithVersion is like Setup with the additional possibility to specify the version number
+func SetupWithVersion(bitLength uint64, idemixIssuerPK []byte, idemixCurveID mathlib.CurveID, version driver.TokenDriverVersion) (*PublicParams, error) {
+	return NewWith(DLogNoGHDriverName, version, bitLength, idemixIssuerPK, idemixCurveID)
+}
+
 func NewWith(driverName driver.TokenDriverName, driverVersion driver.TokenDriverVersion, bitLength uint64, idemixIssuerPK []byte, idemixCurveID mathlib.CurveID) (*PublicParams, error) {
 	if bitLength > 64 {
 		return nil, errors.Errorf("invalid bit length [%d], should be smaller than 64", bitLength)