align code to token.Format

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

Author: adecaro

integration/token/fungible/support.go

@@ -207,7 +207,7 @@ func CheckAcceptedTransactions(network *integration.Infrastructure, id *token3.N
 
 func matchTransactionRecord(tx *ttxdb.TransactionRecord, txExpected TransactionRecord, i int) error {
 	if tx.TokenType != txExpected.TokenType {
-		return errors.Errorf("tx [%d] tx.TokenType: %s, txExpected.TokenType: %s", i, tx.TokenType, txExpected.TokenType)
+		return errors.Errorf("tx [%d] tx.TokenFormat: %s, txExpected.TokenFormat: %s", i, tx.TokenType, txExpected.TokenType)
 	}
 	if !strings.HasPrefix(tx.SenderEID, txExpected.SenderEID) {
 		return errors.Errorf("tx [%d] tx.SenderEID: %s, txExpected.SenderEID: %s", i, tx.SenderEID, txExpected.SenderEID)

token/core/common/loaders.go

@@ -116,9 +116,9 @@ func (s *VaultLedgerTokenLoader[T]) isAnyPending(ids ...*token.ID) (anyPending b
 }
 
 type LoadedToken[T any, M any] struct {
-	TokenType token.Format
-	Token     T
-	Metadata  M
+	TokenFormat token.Format
+	Token       T
+	Metadata    M
 }
 
 type VaultLedgerTokenAndMetadataLoader[T any, M any] struct {
@@ -162,9 +162,9 @@ func (s *VaultLedgerTokenAndMetadataLoader[T, M]) LoadTokens(ctx context.Context
 			return nil, errors.Wrapf(err, "failed deserializeing token info for id [%v]", id)
 		}
 		result[i] = LoadedToken[T, M]{
-			TokenType: types[i],
-			Token:     tok,
-			Metadata:  meta,
+			TokenFormat: types[i],
+			Token:       tok,
+			Metadata:    meta,
 		}
 	}
 

token/core/fabtoken/tokens.go

@@ -48,7 +48,7 @@ func (s *TokensService) Deobfuscate(output []byte, outputMetadata []byte) (*toke
 	}, metadata.Issuer, s.OutputTokenFormat, nil
 }
 
-func (s *TokensService) SupportedTokenTypes() []token2.Format {
+func (s *TokensService) SupportedTokenFormats() []token2.Format {
 	return []token2.Format{s.OutputTokenFormat}
 }
 

token/core/zkatdlog/nogh/tokens.go

@@ -51,16 +51,16 @@ func (s *TokensService) Deobfuscate(output []byte, outputMetadata []byte) (*toke
 	return tok, metadata.Issuer, s.OutputTokenFormat, nil
 }
 
-func (s *TokensService) SupportedTokenTypes() []token.Format {
+func (s *TokensService) SupportedTokenFormats() []token.Format {
 	return []token.Format{s.OutputTokenFormat}
 }
 
-func (s *TokensService) DeserializeToken(outputType token.Format, outputRaw []byte, metadataRaw []byte) (*token2.Token, *token2.Metadata, *token2.ConversionWitness, error) {
+func (s *TokensService) DeserializeToken(outputFormat token.Format, outputRaw []byte, metadataRaw []byte) (*token2.Token, *token2.Metadata, *token2.ConversionWitness, error) {
 	// Here we have to check if what we get in input is already as expected.
 	// If not, we need to check if a conversion is possible.
 	// If not, a failure is to be returned
-	if outputType != s.OutputTokenFormat {
-		return nil, nil, nil, errors.Errorf("invalid token type [%s], expected [%s]", outputType, s.OutputTokenFormat)
+	if outputFormat != s.OutputTokenFormat {
+		return nil, nil, nil, errors.Errorf("invalid token type [%s], expected [%s]", outputFormat, s.OutputTokenFormat)
 	}
 
 	// get zkatdlog token

token/core/zkatdlog/nogh/transfer.go

@@ -31,7 +31,7 @@ type TokenLoader interface {
 }
 
 type TokenDeserializer interface {
-	DeserializeToken(outputType token2.Format, outputRaw []byte, metadataRaw []byte) (*token.Token, *token.Metadata, *token.ConversionWitness, error)
+	DeserializeToken(outputFormat token2.Format, outputRaw []byte, metadataRaw []byte) (*token.Token, *token.Metadata, *token.ConversionWitness, error)
 }
 
 type TransferService struct {
@@ -257,7 +257,7 @@ func (s *TransferService) prepareInputs(loadedTokens []LoadedToken) ([]*token.To
 	metadata := make([]*token.Metadata, len(loadedTokens))
 	signers := make([]driver.Identity, len(loadedTokens))
 	for i, loadedToken := range loadedTokens {
-		tok, meta, _, err := s.TokenDeserializer.DeserializeToken(loadedToken.TokenType, loadedToken.Token, loadedToken.Metadata)
+		tok, meta, _, err := s.TokenDeserializer.DeserializeToken(loadedToken.TokenFormat, loadedToken.Token, loadedToken.Metadata)
 		if err != nil {
 			return nil, nil, nil, errors.Wrapf(err, "failed deserializing token [%s]", string(loadedToken.Token))
 		}

token/driver/mock/tss.go

@@ -11,10 +11,10 @@ import "github.com/hyperledger-labs/fabric-token-sdk/token/token"
 //go:generate counterfeiter -o mock/tss.go -fake-name TokensService . TokensService
 
 type TokensService interface {
-	// SupportedTokenTypes returns the supported token types
-	SupportedTokenTypes() []token.Format
+	// SupportedTokenFormats returns the supported token formats
+	SupportedTokenFormats() []token.Format
 
-	// Deobfuscate processes the passed output and metadata to derive a token.Token, its issuer (if any), and its token type tag
+	// Deobfuscate processes the passed output and metadata to derive a token.Token, its issuer (if any), and its token format
 	Deobfuscate(output []byte, outputMetadata []byte) (*token.Token, Identity, token.Format, error)
 
 	// ExtractMetadata extracts from the given token request metadata the metadata to the given target

token/driver/tokens.go

@@ -482,7 +482,7 @@ func (r *Request) extractIssueOutputs(i int, counter uint64, issueAction driver.
 		if len(issueAction.GetOutputs()) != len(issueMeta.OutputsMetadata) || len(issueMeta.ReceiversAuditInfos) != len(issueAction.GetOutputs()) {
 			return nil, 0, errors.Wrapf(err, "failed matching issue action with its metadata [%d]: invalid metadata", i)
 		}
-		tok, _, tokType, err := tms.TokensService().Deobfuscate(raw, issueMeta.OutputsMetadata[j])
+		tok, _, format, err := tms.TokensService().Deobfuscate(raw, issueMeta.OutputsMetadata[j])
 		if err != nil {
 			return nil, 0, errors.Wrapf(err, "failed getting issue action output in the clear [%d,%d]", i, j)
 		}
@@ -496,16 +496,16 @@ func (r *Request) extractIssueOutputs(i int, counter uint64, issueAction driver.
 		}
 
 		outputs = append(outputs, &Output{
-			ActionIndex:       i,
-			Index:             counter,
-			Owner:             tok.Owner,
-			OwnerAuditInfo:    issueMeta.ReceiversAuditInfos[j],
-			EnrollmentID:      eID,
-			RevocationHandler: rID,
-			Type:              tok.Type,
-			Quantity:          q,
-			LedgerOutput:      raw,
-			LedgerOutputType:  tokType,
+			ActionIndex:        i,
+			Index:              counter,
+			Owner:              tok.Owner,
+			OwnerAuditInfo:     issueMeta.ReceiversAuditInfos[j],
+			EnrollmentID:       eID,
+			RevocationHandler:  rID,
+			Type:               tok.Type,
+			Quantity:           q,
+			LedgerOutput:       raw,
+			LedgerOutputFormat: format,
 		})
 		counter++
 
@@ -564,16 +564,16 @@ func (r *Request) extractTransferOutputs(i int, counter uint64, transferAction d
 		}
 		r.TokenService.logger.Debugf("Transfer Action Output [%d,%d][%s:%d] is present, extract [%s]", i, j, r.Anchor, counter, Hashable(ledgerOutput))
 		outputs = append(outputs, &Output{
-			ActionIndex:       i,
-			Index:             counter,
-			Owner:             tok.Owner,
-			OwnerAuditInfo:    receiverAuditInfo,
-			EnrollmentID:      eID,
-			RevocationHandler: rID,
-			Type:              tok.Type,
-			Quantity:          q,
-			LedgerOutput:      ledgerOutput,
-			LedgerOutputType:  tokType,
+			ActionIndex:        i,
+			Index:              counter,
+			Owner:              tok.Owner,
+			OwnerAuditInfo:     receiverAuditInfo,
+			EnrollmentID:       eID,
+			RevocationHandler:  rID,
+			Type:               tok.Type,
+			Quantity:           q,
+			LedgerOutput:       ledgerOutput,
+			LedgerOutputFormat: tokType,
 		})
 		counter++
 	}

token/request.go

@@ -55,7 +55,7 @@ func (p *PostInitializer) PostInit(tms driver.TokenManagerService, networkID, ch
 	if err != nil {
 		return errors.WithMessagef(err, "failed to get tokens for [%s]", tmsID)
 	}
-	supportedTokens := tms.TokensService().SupportedTokenTypes()
+	supportedTokens := tms.TokensService().SupportedTokenFormats()
 	if err := tokens.SetSupportedTokenTypes(supportedTokens); err != nil {
 		return errors.WithMessagef(err, "failed to set supported tokens for [%s] to [%s]", tmsID, supportedTokens)
 	}

token/sdk/tms/tms.go

@@ -177,7 +177,7 @@ type ValidationRecordsIterator = collections.Iterator[*ValidationRecord]
 type TokenRequestIterator = collections.Iterator[*TokenRequestRecord]
 
 // QueryMovementsParams defines the parameters for querying movements.
-// Movement records will be filtered by EnrollmentID, TokenType, and Status.
+// Movement records will be filtered by EnrollmentID, TokenFormat, and Status.
 // SearchDirection tells if the search should start from the oldest to the newest records or vice versa.
 // MovementDirection which amounts to consider. Sent correspond to a negative amount,
 // Received to a positive amount, and All to both.