make generators versioned, add input interface for validator context

arner · arner · commit 125d10a65ecb · 2025-11-05T15:34:46.000+01:00
Signed-off-by: Arne Rutjes &lt;arne123@gmail.com&gt;
diff --git a/integration/nwo/token/generators/pp/fabtokenv1/gen.go b/integration/nwo/token/generators/pp/fabtokenv1/gen.go
@@ -13,16 +13,26 @@ import (
 	"github.com/hyperledger-labs/fabric-smart-client/pkg/utils/errors"
 	"github.com/hyperledger-labs/fabric-smart-client/platform/common/utils/collections"
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/topology"
+	"github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/v1/setup"
 	fabtokenv1 "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-token-sdk/token/services/identity"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/storage/kvs"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/x509"
 )
 
-type FabTokenPublicParamsGenerator struct{}
+type FabTokenPublicParamsGenerator struct {
+	DriverVersion driver.TokenDriverVersion
+}
 
-func NewFabTokenPublicParamsGenerator() *FabTokenPublicParamsGenerator {
-	return &FabTokenPublicParamsGenerator{}
+func NewFabTokenPublicParamsGenerator(version driver.TokenDriverVersion) *FabTokenPublicParamsGenerator {
+	gen := &FabTokenPublicParamsGenerator{
+		DriverVersion: setup.ProtocolV1,
+	}
+	if version > 0 {
+		gen.DriverVersion = version
+	}
+	return gen
 }
 
 func (f *FabTokenPublicParamsGenerator) Generate(tms *topology.TMS, wallets *topology.Wallets, args ...interface{}) ([]byte, error) {
@@ -41,7 +51,7 @@ func (f *FabTokenPublicParamsGenerator) Generate(tms *topology.TMS, wallets *top
 			return nil, errors.Wrapf(err, "failed to parse max token value [%s] to uint64", precisionStr)
 		}
 	}
-	pp, err := fabtokenv1.Setup(precision)
+	pp, err := fabtokenv1.WithVersion(precision, f.DriverVersion)
 	if err != nil {
 		return nil, err
 	}
diff --git a/integration/nwo/token/generators/pp/zkatdlognoghv1/gen.go b/integration/nwo/token/generators/pp/zkatdlognoghv1/gen.go
@@ -19,17 +19,24 @@ import (
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"
 	"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/topology"
 	dlognoghv1 "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/identity"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/storage/kvs"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/x509"
 )
 
 type DLogPublicParamsGenerator struct {
 	DefaultCurveID math3.CurveID
+	DriverVersion  driver.TokenDriverVersion
 }
 
-func NewDLogPublicParamsGenerator(defaultCurveID math3.CurveID) *DLogPublicParamsGenerator {
-	return &DLogPublicParamsGenerator{DefaultCurveID: defaultCurveID}
+// NewDLogPublicParamsGenerator creates a new generator. The version is optional and defaults to v1.
+func NewDLogPublicParamsGenerator(defaultCurveID math3.CurveID, version driver.TokenDriverVersion) *DLogPublicParamsGenerator {
+	gen := &DLogPublicParamsGenerator{DefaultCurveID: defaultCurveID, DriverVersion: dlognoghv1.ProtocolV1}
+	if version > 0 {
+		gen.DriverVersion = version
+	}
+	return gen
 }
 
 func (d *DLogPublicParamsGenerator) Generate(tms *topology.TMS, wallets *topology.Wallets, args ...interface{}) ([]byte, error) {
@@ -63,7 +70,7 @@ func (d *DLogPublicParamsGenerator) Generate(tms *topology.TMS, wallets *topolog
 			return nil, err
 		}
 	}
-	pp, err := dlognoghv1.Setup(bits, ipkBytes, curveID)
+	pp, err := dlognoghv1.WithVersion(bits, ipkBytes, curveID, d.DriverVersion)
 	if err != nil {
 		return nil, err
 	}
diff --git a/integration/nwo/token/platform.go b/integration/nwo/token/platform.go
@@ -84,8 +84,8 @@ func NewPlatform(ctx api2.Context, t api2.Topology, builder api2.Builder) *Platf
 		TokenGenPath:           DefaultTokenGenPath,
 		NetworkHandlers:        map[string]NetworkHandler{},
 	}
-	p.PublicParamsGenerators[fabtokenv1.DriverIdentifier] = fabtokenv2.NewFabTokenPublicParamsGenerator()
-	p.PublicParamsGenerators[zkatdlognoghv1.DriverIdentifier] = common2.NewDLogPublicParamsGenerator(math3.BN254)
+	p.PublicParamsGenerators[fabtokenv1.DriverIdentifier] = fabtokenv2.NewFabTokenPublicParamsGenerator(0)
+	p.PublicParamsGenerators[zkatdlognoghv1.DriverIdentifier] = common2.NewDLogPublicParamsGenerator(math3.BN254, 0)
 
 	return p
 }
diff --git a/token/core/common/authorization.go b/token/core/common/authorization.go
diff --git a/token/core/common/validator.go b/token/core/common/validator.go
@@ -22,7 +22,7 @@ const (
 	TokenRequestSignatures driver.ValidationAttributeID = "sigs"
 )
 
-type Context[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] struct {
+type Context[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] struct {
 	Logger            logging.Logger
 	PP                P
 	Anchor            driver.TokenRequestAnchor
@@ -42,17 +42,17 @@ func (c *Context[P, T, TA, IA, DS]) CountMetadataKey(key string) {
 	c.MetadataCounter[key] = c.MetadataCounter[key] + 1
 }
 
-type ValidateTransferFunc[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] func(c context.Context, ctx *Context[P, T, TA, IA, DS]) error
+type ValidateTransferFunc[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] func(c context.Context, ctx *Context[P, T, TA, IA, DS]) error
 
-type ValidateIssueFunc[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] func(c context.Context, ctx *Context[P, T, TA, IA, DS]) error
+type ValidateIssueFunc[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] func(c context.Context, ctx *Context[P, T, TA, IA, DS]) error
 
-type ValidateAuditingFunc[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] func(c context.Context, ctx *Context[P, T, TA, IA, DS]) error
+type ValidateAuditingFunc[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] func(c context.Context, ctx *Context[P, T, TA, IA, DS]) error
 
 type ActionDeserializer[TA driver.TransferAction, IA driver.IssueAction] interface {
 	DeserializeActions(tr *driver.TokenRequest) ([]IA, []TA, error)
 }
 
-type Validator[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] struct {
+type Validator[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer] struct {
 	Logger             logging.Logger
 	PublicParams       P
 	Deserializer       DS
@@ -63,7 +63,7 @@ type Validator[P driver.PublicParameters, T any, TA driver.TransferAction, IA dr
 	IssueValidators    []ValidateIssueFunc[P, T, TA, IA, DS]
 }
 
-func NewValidator[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](
+func NewValidator[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](
 	Logger logging.Logger,
 	publicParams P,
 	deserializer DS,
diff --git a/token/core/common/validator_auditing.go b/token/core/common/validator_auditing.go
@@ -19,7 +19,7 @@ var (
 	ErrAuditorSignaturesPresent = errors.New("auditor signatures present")
 )
 
-func AuditingSignaturesValidate[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {
+func AuditingSignaturesValidate[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {
 	if len(ctx.PP.Auditors()) == 0 {
 		// enforce no auditor signatures are attached
 		if len(ctx.TokenRequest.AuditorSignatures) != 0 {
diff --git a/token/core/common/validator_auditing_test.go b/token/core/common/validator_auditing_test.go
@@ -17,7 +17,7 @@ import (
 )
 
 type (
-	TestContext = Context[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]
+	TestContext = Context[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]
 	TestCheck   = func() bool
 )
 
diff --git a/token/core/common/validator_issue.go b/token/core/common/validator_issue.go
@@ -16,7 +16,7 @@ import (
 
 // IssueApplicationDataValidate accepts any metadata in the "pub" namespace.
 // This gives the user of the Token SDK the option to attach public data to the token transaction.
-func IssueApplicationDataValidate[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {
+func IssueApplicationDataValidate[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {
 	for key := range ctx.IssueAction.GetMetadata() {
 		if strings.HasPrefix(key, meta.PublicMetadataPrefix) {
 			ctx.CountMetadataKey(key)
diff --git a/token/core/common/validator_test.go b/token/core/common/validator_test.go
@@ -21,29 +21,29 @@ import (
 func TestAnchorInContext(t *testing.T) {
 	anchor := driver.TokenRequestAnchor("hello world")
 	anotherAnchor := driver.TokenRequestAnchor("another anchor")
-	v := NewValidator[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer](
+	v := NewValidator[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer](
 		nil,
 		nil,
 		nil,
 		nil,
-		[]ValidateTransferFunc[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]{
-			func(c context.Context, ctx *Context[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]) error {
+		[]ValidateTransferFunc[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]{
+			func(c context.Context, ctx *Context[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]) error {
 				if anchor != ctx.Anchor {
 					return fmt.Errorf("transfer, anchor does not match, expected %s, got %s", anchor, ctx.Anchor)
 				}
 				return nil
 			},
 		},
-		[]ValidateIssueFunc[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]{
-			func(c context.Context, ctx *Context[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]) error {
+		[]ValidateIssueFunc[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]{
+			func(c context.Context, ctx *Context[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]) error {
 				if anchor != ctx.Anchor {
 					return fmt.Errorf("issue, anchor does not match, expected %s, got %s", anchor, ctx.Anchor)
 				}
 				return nil
 			},
 		},
-		[]ValidateAuditingFunc[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]{
-			func(c context.Context, ctx *Context[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]) error {
+		[]ValidateAuditingFunc[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]{
+			func(c context.Context, ctx *Context[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]) error {
 				if anchor != ctx.Anchor {
 					return fmt.Errorf("audit, anchor does not match, expected %s, got %s", anchor, ctx.Anchor)
 				}
diff --git a/token/core/common/validator_transfer.go b/token/core/common/validator_transfer.go
@@ -16,7 +16,7 @@ import (
 
 // TransferApplicationDataValidate accepts any metadata in the "pub" namespace.
 // This gives the user of the Token SDK the option to attach public data to the token transaction.
-func TransferApplicationDataValidate[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {
+func TransferApplicationDataValidate[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {
 	for key := range ctx.TransferAction.GetMetadata() {
 		if strings.HasPrefix(key, meta.PublicMetadataPrefix) {
 			ctx.CountMetadataKey(key)
diff --git a/token/core/fabtoken/v1/driver/driver.go b/token/core/fabtoken/v1/driver/driver.go
@@ -132,7 +132,7 @@ func (d *Driver) NewTokenService(tmsID driver.TMSID, publicParams []byte) (drive
 	)
 	tokensService, err := v1.NewTokensService(publicParamsManager.PublicParams(), deserializer)
 	if err != nil {
-		return nil, errors.Wrapf(err, "failed to initiliaze token service for [%s:%s]", tmsID.Network, tmsID.Namespace)
+		return nil, errors.Wrapf(err, "failed to initialize token service for [%s:%s]", tmsID.Network, tmsID.Namespace)
 	}
 	validator := validator.NewValidator(
 		logger,
diff --git a/token/driver/action.go b/token/driver/action.go
@@ -39,6 +39,12 @@ type IssueAction interface {
 	ExtraSigners() []Identity
 }
 
+// Input models an input of an action
+type Input interface {
+	// GetOwner returns the owner of this token
+	GetOwner() []byte
+}
+
 // Output models an output of an action
 type Output interface {
 	// Serialize returns the serialized version of the output

Original file line number	Diff line number	Diff line change
`@@ -19,17 +19,24 @@ import (`
`19`	`19`	`"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/generators/crypto/zkatdlognoghv1"`
`20`	`20`	`"github.com/hyperledger-labs/fabric-token-sdk/integration/nwo/token/topology"`
`21`	`21`	`dlognoghv1 "github.com/hyperledger-labs/fabric-token-sdk/token/core/zkatdlog/nogh/v1/setup"`
	`22`	`+ "github.com/hyperledger-labs/fabric-token-sdk/token/driver"`
`22`	`23`	`"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity"`
`23`	`24`	`"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/storage/kvs"`
`24`	`25`	`"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/x509"`
`25`	`26`	`)`
`26`	`27`
`27`	`28`	`type DLogPublicParamsGenerator struct {`
`28`	`29`	`DefaultCurveID math3.CurveID`
	`30`	`+ DriverVersion driver.TokenDriverVersion`
`29`	`31`	`}`
`30`	`32`
`31`		`-func NewDLogPublicParamsGenerator(defaultCurveID math3.CurveID) *DLogPublicParamsGenerator {`
`32`		`- return &DLogPublicParamsGenerator{DefaultCurveID: defaultCurveID}`
	`33`	`+// NewDLogPublicParamsGenerator creates a new generator. The version is optional and defaults to v1.`
	`34`	`+func NewDLogPublicParamsGenerator(defaultCurveID math3.CurveID, version driver.TokenDriverVersion) *DLogPublicParamsGenerator {`
	`35`	`+ gen := &DLogPublicParamsGenerator{DefaultCurveID: defaultCurveID, DriverVersion: dlognoghv1.ProtocolV1}`
	`36`	`+ if version > 0 {`
	`37`	`+ gen.DriverVersion = version`
	`38`	`+ }`
	`39`	`+ return gen`
`33`	`40`	`}`
`34`	`41`
`35`	`42`	`func (d DLogPublicParamsGenerator) Generate(tms topology.TMS, wallets *topology.Wallets, args ...interface{}) ([]byte, error) {`
`@@ -63,7 +70,7 @@ func (d DLogPublicParamsGenerator) Generate(tms topology.TMS, wallets *topolog`
`63`	`70`	`return nil, err`
`64`	`71`	`}`
`65`	`72`	`}`
`66`		`- pp, err := dlognoghv1.Setup(bits, ipkBytes, curveID)`
	`73`	`+ pp, err := dlognoghv1.WithVersion(bits, ipkBytes, curveID, d.DriverVersion)`
`67`	`74`	`if err != nil {`
`68`	`75`	`return nil, err`
`69`	`76`	`}`
Original file line number	Diff line number	Diff line change
`@@ -84,8 +84,8 @@ func NewPlatform(ctx api2.Context, t api2.Topology, builder api2.Builder) *Platf`
`84`	`84`	`TokenGenPath: DefaultTokenGenPath,`
`85`	`85`	`NetworkHandlers: map[string]NetworkHandler{},`
`86`	`86`	`}`
`87`		`- p.PublicParamsGenerators[fabtokenv1.DriverIdentifier] = fabtokenv2.NewFabTokenPublicParamsGenerator()`
`88`		`- p.PublicParamsGenerators[zkatdlognoghv1.DriverIdentifier] = common2.NewDLogPublicParamsGenerator(math3.BN254)`
	`87`	`+ p.PublicParamsGenerators[fabtokenv1.DriverIdentifier] = fabtokenv2.NewFabTokenPublicParamsGenerator(0)`
	`88`	`+ p.PublicParamsGenerators[zkatdlognoghv1.DriverIdentifier] = common2.NewDLogPublicParamsGenerator(math3.BN254, 0)`
`89`	`89`
`90`	`90`	`return p`
`91`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ var (`
`19`	`19`	`ErrAuditorSignaturesPresent = errors.New("auditor signatures present")`
`20`	`20`	`)`
`21`	`21`
`22`		`-func AuditingSignaturesValidate[P driver.PublicParameters, T any, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {`
	`22`	`+func AuditingSignaturesValidate[P driver.PublicParameters, T driver.Input, TA driver.TransferAction, IA driver.IssueAction, DS driver.Deserializer](c context.Context, ctx *Context[P, T, TA, IA, DS]) error {`
`23`	`23`	`if len(ctx.PP.Auditors()) == 0 {`
`24`	`24`	`// enforce no auditor signatures are attached`
`25`	`25`	`if len(ctx.TokenRequest.AuditorSignatures) != 0 {`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import (`
`17`	`17`	`)`
`18`	`18`
`19`	`19`	`type (`
`20`		`- TestContext = Context[driver.PublicParameters, any, driver.TransferAction, driver.IssueAction, driver.Deserializer]`
	`20`	`+ TestContext = Context[driver.PublicParameters, driver.Input, driver.TransferAction, driver.IssueAction, driver.Deserializer]`
`21`	`21`	`TestCheck = func() bool`
`22`	`22`	`)`
`23`	`23`