dlog v1 finalization: unit-tests coverage above 80% - token

Makefile

@@ -147,12 +147,12 @@ clean-all-containers:
 .PHONY: lint
 lint:
 	@echo "Running Go Linters..."
-	golangci-lint run --color=always --timeout=4m
+	golangci-lint run --color=always --timeout=10m
 
 .PHONY: lint-auto-fix
 lint-auto-fix:
 	@echo "Running Go Linters with auto-fix..."
-	golangci-lint run --color=always --timeout=4m --fix
+	golangci-lint run --color=always --timeout=10m --fix
 
 .PHONY: install-linter-tool
 install-linter-tool:

docs/core/extension/zkatdlog/nogh/v2/driver/driver.go

@@ -119,7 +119,7 @@ func (d *Driver) NewTokenService(tmsID driver.TMSID, publicParams []byte) (drive
 		logger,
 		d.identityProvider.DefaultIdentity(),
 		networkLocalMembership.DefaultIdentity(),
-		ppm.PublicParams(),
+		pp,
 		false,
 		metricsProvider,
 	)
@@ -130,23 +130,23 @@ func (d *Driver) NewTokenService(tmsID driver.TMSID, publicParams []byte) (drive
 	ip := ws.IdentityProvider
 
 	authorization := common.NewAuthorizationMultiplexer(
-		common.NewTMSAuthorization(logger, ppm.PublicParams(), ws),
+		common.NewTMSAuthorization(logger, pp, ws),
 		htlc.NewScriptAuth(ws),
 		multisig.NewEscrowAuth(ws),
 	)
 
 	driverMetrics := v1.NewMetrics(metricsProvider)
-	tokensService, err := token3.NewTokensService(logger, ppm, deserializer)
+	tokensService, err := token3.NewTokensService(logger, pp, deserializer)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to initiliaze token service for [%s:%s]", tmsID.Network, tmsID.Namespace)
 	}
-	tokensUpgradeService, err := upgrade.NewService(logger, ppm.PublicParams().QuantityPrecision, deserializer, ip)
+	tokensUpgradeService, err := upgrade.NewService(logger, pp.QuantityPrecision, deserializer, ip)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to initiliaze token upgrade service for [%s:%s]", tmsID.Network, tmsID.Namespace)
 	}
 	validator, err := validator.New(
 		logger,
-		ppm.PublicParams(),
+		pp,
 		deserializer,
 		nil,
 		nil,

token/core/fabtoken/v1/tokens.go

@@ -26,7 +26,7 @@ type TokensService struct {
 }
 
 func NewTokensService(pp *setup.PublicParams, identityDeserializer driver.Deserializer) (*TokensService, error) {
-	supportedTokens, err := SupportedTokenFormat(pp.QuantityPrecision)
+	supportedTokens, err := ComputeTokenFormat(pp.QuantityPrecision)
 	if err != nil {
 		return nil, errors.WithMessagef(err, "failed getting supported token types")
 	}
@@ -90,7 +90,7 @@ func (s *TokensUpgradeService) CheckUpgradeProof(ctx context.Context, ch driver.
 	return false, errors.New("not supported")
 }
 
-func SupportedTokenFormat(precision uint64) (token2.Format, error) {
+func ComputeTokenFormat(precision uint64) (token2.Format, error) {
 	hasher := utils.NewSHA256Hasher()
 	if err := errors2.Join(
 		hasher.AddInt32(fabtoken.Type),

token/core/zkatdlog/nogh/v1/crypto/upgrade/service.go

@@ -57,7 +57,7 @@ func NewService(
 	// compute supported tokens
 	var upgradeSupportedTokenFormatList []token.Format
 	for _, precision := range []uint64{16, 32, 64} {
-		format, err := v1.SupportedTokenFormat(precision)
+		format, err := v1.ComputeTokenFormat(precision)
 		if err != nil {
 			return nil, errors.Wrapf(err, "failed computing fabtoken token format with precision [%d]", precision)
 		}

token/core/zkatdlog/nogh/v1/crypto/upgrade/service_test.go

@@ -47,7 +47,7 @@ func TestTokensService_GenUpgradeProof(t *testing.T) {
 	}
 	fabtokenOutputRaw, err := fabtokenOutput.Serialize()
 	assert.NoError(t, err)
-	formatFabtoken16, err := v1.SupportedTokenFormat(16)
+	formatFabtoken16, err := v1.ComputeTokenFormat(16)
 	assert.NoError(t, err)
 	validTokens := []token.LedgerToken{{
 		ID:            token.ID{TxId: "tx1", Index: 1},
@@ -178,7 +178,7 @@ func TestTokensService_CheckUpgradeProof(t *testing.T) {
 	}
 	fabtokenOutputRaw, err := fabtokenOutput.Serialize()
 	assert.NoError(t, err)
-	formatFabtoken16, err := v1.SupportedTokenFormat(16)
+	formatFabtoken16, err := v1.ComputeTokenFormat(16)
 	assert.NoError(t, err)
 	validTokens := []token.LedgerToken{{
 		ID:            token.ID{TxId: "tx1", Index: 1},

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

@@ -119,7 +119,7 @@ func (d *Driver) NewTokenService(tmsID driver.TMSID, publicParams []byte) (drive
 		logger,
 		d.identityProvider.DefaultIdentity(),
 		networkLocalMembership.DefaultIdentity(),
-		ppm.PublicParams(),
+		pp,
 		false,
 		metricsProvider,
 	)
@@ -130,17 +130,17 @@ func (d *Driver) NewTokenService(tmsID driver.TMSID, publicParams []byte) (drive
 	ip := ws.IdentityProvider
 
 	authorization := common.NewAuthorizationMultiplexer(
-		common.NewTMSAuthorization(logger, ppm.PublicParams(), ws),
+		common.NewTMSAuthorization(logger, pp, ws),
 		htlc.NewScriptAuth(ws),
 		multisig.NewEscrowAuth(ws),
 	)
 
 	driverMetrics := v1.NewMetrics(metricsProvider)
-	tokensService, err := v1token.NewTokensService(logger, ppm, deserializer)
+	tokensService, err := v1token.NewTokensService(logger, pp, deserializer)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to initiliaze token service for [%s:%s]", tmsID.Network, tmsID.Namespace)
 	}
-	tokensUpgradeService, err := upgrade.NewService(logger, ppm.PublicParams().QuantityPrecision, deserializer, ip)
+	tokensUpgradeService, err := upgrade.NewService(logger, pp.QuantityPrecision, deserializer, ip)
 	if err != nil {
 		return nil, errors.Wrapf(err, "failed to initiliaze token upgrade service for [%s:%s]", tmsID.Network, tmsID.Namespace)
 	}

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

@@ -8,16 +8,18 @@ package token
 
 import (
 	"github.com/hyperledger-labs/fabric-smart-client/pkg/utils/errors"
-	"github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/v1/actions"
+	fabtoken "github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/v1/actions"
 	"github.com/hyperledger-labs/fabric-token-sdk/token/token"
 )
 
-func ParseFabtokenToken(tok []byte, precision uint64, maxPrecision uint64) (*actions.Output, uint64, error) {
-	if precision < maxPrecision {
+// ParseFabtokenToken unmarshals tok as a fabtoken.Output using precision to parse the quantity.
+// If precision is larger than maxPrecision, it returns an error
+func ParseFabtokenToken(tok []byte, precision uint64, maxPrecision uint64) (*fabtoken.Output, uint64, error) {
+	if precision > maxPrecision {
 		return nil, 0, errors.Errorf("unsupported precision [%d], max [%d]", precision, maxPrecision)
 	}
 
-	output := &actions.Output{}
+	output := &fabtoken.Output{}
 	err := output.Deserialize(tok)
 	if err != nil {
 		return nil, 0, errors.Wrap(err, "failed to unmarshal fabtoken")

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

@@ -0,0 +1,113 @@
+/*
+Copyright IBM Corp. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
+package token
+
+import (
+	"testing"
+
+	"github.com/hyperledger-labs/fabric-token-sdk/token/core/fabtoken/v1/actions"
+	"github.com/stretchr/testify/assert"
+)
+
+func TestParseFabtokenToken(t *testing.T) {
+	nilGetTokFunc := func() (*actions.Output, []byte, error) {
+		return nil, nil, nil
+	}
+	tests := []struct {
+		name             string
+		tok              func() (*actions.Output, []byte, error)
+		precision        uint64
+		maxPrecision     uint64
+		wantErr          bool
+		expectedError    string
+		expectedQuantity uint64
+	}{
+		{
+			name:          "precision is langer than maxPrecision",
+			tok:           nilGetTokFunc,
+			precision:     10,
+			maxPrecision:  5,
+			wantErr:       true,
+			expectedError: "unsupported precision [10], max [5]",
+		},
+		{
+			name:          "invalid tok",
+			tok:           nilGetTokFunc,
+			precision:     5,
+			maxPrecision:  10,
+			wantErr:       true,
+			expectedError: "failed to unmarshal fabtoken: failed deserializing token: failed unmarshalling token: failed to unmarshal to TypedToken: asn1: syntax error: sequence truncated",
+		},
+		{
+			name: "invalid tok 2",
+			tok: func() (*actions.Output, []byte, error) {
+				return nil, []byte{}, nil
+			},
+			precision:     5,
+			maxPrecision:  10,
+			wantErr:       true,
+			expectedError: "failed to unmarshal fabtoken: failed deserializing token: failed unmarshalling token: failed to unmarshal to TypedToken: asn1: syntax error: sequence truncated",
+		},
+		{
+			name: "invalid tok 3",
+			tok: func() (*actions.Output, []byte, error) {
+				return nil, []byte{0, 1, 2}, nil
+			},
+			precision:     5,
+			maxPrecision:  10,
+			wantErr:       true,
+			expectedError: "failed to unmarshal fabtoken: failed deserializing token: failed unmarshalling token: failed to unmarshal to TypedToken: asn1: structure error: tags don't match (16 vs {class:0 tag:0 length:1 isCompound:false}) {optional:false explicit:false application:false private:false defaultValue:<nil> tag:<nil> stringType:0 timeType:0 set:false omitEmpty:false} TypedToken @2",
+		},
+		{
+			name: "invalid quantity",
+			tok: func() (*actions.Output, []byte, error) {
+				output := &actions.Output{
+					Owner:    nil,
+					Type:     "",
+					Quantity: "",
+				}
+				raw, err := output.Serialize()
+				return output, raw, err
+			},
+			precision:     5,
+			maxPrecision:  10,
+			wantErr:       true,
+			expectedError: "failed to create quantity: invalid input [,5]",
+		},
+		{
+			name: "success",
+			tok: func() (*actions.Output, []byte, error) {
+				output := &actions.Output{
+					Owner:    nil,
+					Type:     "",
+					Quantity: "10",
+				}
+				raw, err := output.Serialize()
+				return output, raw, err
+			},
+			precision:        5,
+			maxPrecision:     10,
+			wantErr:          false,
+			expectedQuantity: 10,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			tok, tokBytes, err := tt.tok()
+			assert.NoError(t, err)
+			output, quantity, err := ParseFabtokenToken(tokBytes, tt.precision, tt.maxPrecision)
+			if tt.wantErr {
+				assert.Error(t, err)
+				assert.EqualError(t, err, tt.expectedError)
+			} else {
+				assert.NoError(t, err)
+				assert.Equal(t, tok, output)
+				assert.Equal(t, tt.expectedQuantity, quantity)
+			}
+		})
+	}
+}