more comments

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

Author: adecaro

token/core/fabtoken/v1/driver/base.go

@@ -16,7 +16,6 @@ import (
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/config"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/deserializer"
-	driver2 "github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/driver"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/membership"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/role"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/wallet"
@@ -43,7 +42,7 @@ func (d *base) DefaultValidator(pp driver.PublicParameters) (driver.Validator, e
 
 func (d *base) newWalletService(
 	tmsConfig core.Config,
-	binder driver2.NetworkBinderService,
+	binder identity.NetworkBinderService,
 	storageProvider identity.StorageProvider,
 	qe driver.QueryEngine,
 	logger logging.Logger,

token/core/zkatdlog/nogh/v1/driver/base.go

@@ -17,7 +17,6 @@ import (
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/config"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/deserializer"
-	idriver "github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/driver"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/idemix"
 	msp2 "github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/idemix/crypto"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/services/identity/membership"
@@ -58,7 +57,7 @@ func (d *Base) DefaultValidator(pp driver.PublicParameters) (driver.Validator, e
 
 func (d *Base) NewWalletService(
 	tmsConfig core.Config,
-	binder idriver.NetworkBinderService,
+	binder identity.NetworkBinderService,
 	storageProvider identity.StorageProvider,
 	qe driver.QueryEngine,
 	logger logging.Logger,

token/driver/wallet.go

@@ -131,6 +131,7 @@ type CertifierWallet interface {
 	GetCertifierIdentity() (Identity, error)
 }
 
+// IdentityConfiguration contains configuration-related information of an identity
 type IdentityConfiguration struct {
 	ID     string
 	Type   string

token/services/identity/driver/common.go

@@ -6,23 +6,37 @@ SPDX-License-Identifier: Apache-2.0
 
 package driver
 
+// ConfiguredIdentity describes an identity entry parsed from configuration.
+//
+// Fields:
+//   - ID: the unique identifier for the identity
+//   - Default: whether this identity should be considered the default
+//   - Path: file-system path or location where credentials/configuration live
+//   - CacheSize: per-identity cache size used by the identity service; 0 means no cache
+//   - Opts: provider-specific options (opaque)
 type ConfiguredIdentity struct {
 	ID        string      `yaml:"id"`
 	Default   bool        `yaml:"default,omitempty"`
 	Path      string      `yaml:"path"`
 	CacheSize int         `yaml:"cacheSize"`
-	Type      string      `yaml:"type,omitempty"`
 	Opts      interface{} `yaml:"opts,omitempty"`
 }
 
+// String returns the identity's ID and satisfies fmt.Stringer.
 func (i *ConfiguredIdentity) String() string {
 	return i.ID
 }
 
+// Config is a read-only view over identity service configuration.
+// Implementors provide lookup helpers used by the identity service to resolve configured
+// identities and to normalize configured paths.
 type Config interface {
 	// CacheSizeForOwnerID returns the cache size to be used for the given owner wallet.
-	// If not defined, the function returns -1
+	// If not defined for the given id, the function returns -1.
 	CacheSizeForOwnerID(id string) int
+
+	// TranslatePath maps a configured relative or templated path to an absolute
+	// runtime path. Implementations should resolve variables and perform any
+	// environment-specific transformations required to locate credential files.
 	TranslatePath(path string) string
-	IdentitiesForRole(role IdentityRoleType) ([]ConfiguredIdentity, error)
 }

token/services/identity/driver/config.go

@@ -0,0 +1,48 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package driver
+
+import (
+	"context"
+
+	tdriver "github.com/hyperledger-labs/fabric-token-sdk/token/driver"
+)
+
+// IdentityType identifies the type of identity.
+// It is an alias for tdriver.IdentityType and is used by deserializers to choose the correct
+// decoding logic for different identity representations.
+type IdentityType = tdriver.IdentityType
+
+// TypedSignerDeserializer converts a raw byte representation into a concrete
+// Signer for a given IdentityType.
+// Implementations should validate the raw data and return an error on invalid input or decoding failure.
+type TypedSignerDeserializer interface {
+	// DeserializeSigner deserializes the provided raw bytes into a tdriver.Signer
+	// appropriate for the supplied identity type.
+	// The context may carry ancillary information required for deserialization.
+	DeserializeSigner(ctx context.Context, typ IdentityType, raw []byte) (tdriver.Signer, error)
+}
+
+// AuditInfo represents the audit-related information for an identity.
+// It exposes the enrollment id and the revocation handle necessary for audit
+// and revocation operations.
+type AuditInfo interface {
+	// EnrollmentID returns the enrollment identifier associated with this audit info.
+	EnrollmentID() string
+	// RevocationHandle returns the revocation handle associated with this audit info.
+	RevocationHandle() string
+}
+
+// AuditInfoDeserializer converts a raw byte representation into an AuditInfo instance.
+// Implementations should validate and parse the raw bytes and return an error on failure.
+//
+//go:generate counterfeiter -o mock/aides.go -fake-name AuditInfoDeserializer . AuditInfoDeserializer
+type AuditInfoDeserializer interface {
+	// DeserializeAuditInfo deserializes the provided raw bytes into an AuditInfo value.
+	// The context may carry ancillary information required for deserialization.
+	DeserializeAuditInfo(ctx context.Context, raw []byte) (AuditInfo, error)
+}

token/services/identity/driver/deserialization.go

@@ -9,7 +9,7 @@ package driver
 import (
 	"context"
 
-	"github.com/hyperledger-labs/fabric-token-sdk/token/driver"
+	tdriver "github.com/hyperledger-labs/fabric-token-sdk/token/driver"
 )
 
 // IdentityRoleType is the role of an identity
@@ -55,10 +55,12 @@ type IdentityInfo interface {
 type (
 	// WalletLookupID defines the type of identifiers that can be used to retrieve a given wallet.
 	// It can be a string, as the name of the wallet, or an identity contained in that wallet.
-	// Ultimately, it is the token driver to decide which types are allowed.
-	WalletLookupID        = driver.WalletLookupID
-	Identity              = driver.Identity
-	IdentityConfiguration = driver.IdentityConfiguration
+	// Ultimately, it is the token tdriver to decide which types are allowed.
+	WalletLookupID = tdriver.WalletLookupID
+	// Identity represents a generic identity
+	Identity = tdriver.Identity
+	// IdentityConfiguration contains configuration-related information of an identity
+	IdentityConfiguration = tdriver.IdentityConfiguration
 )
 
 // Role is a container of long-term identities.