Merge pull request #603 from singnet/new-err-codes

better logs, add custom errs for dev-portal

blockchain/serviceMetadata.go

@@ -4,8 +4,10 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"github.com/singnet/snet-daemon/v5/errs"
 	"math/big"
 	"os"
+	"slices"
 	"strings"
 
 	"github.com/bufbuild/protocompile"
@@ -253,15 +255,15 @@ func ServiceMetaData() *ServiceMetadata {
 	var metadata *ServiceMetadata
 	var err error
 	if config.GetBool(config.BlockchainEnabledKey) {
-		ipfsHash := string(getServiceMetaDataUrifromRegistry())
+		ipfsHash := string(getServiceMetaDataURIfromRegistry())
 		metadata, err = GetServiceMetaDataFromIPFS(ipfsHash)
 		if err != nil {
-			zap.L().Panic("error on determining service metadata from file", zap.Error(err))
+			zap.L().Panic("error on determining service metadata from file"+errs.ErrDescURL(errs.InvalidMetadata), zap.Error(err))
 		}
 	} else {
 		metadata = &ServiceMetadata{Encoding: "proto", ServiceType: "grpc"}
 	}
-	zap.L().Debug("service_type: " + metadata.GetServiceType())
+	zap.L().Debug("service type: " + metadata.GetServiceType())
 	return metadata
 }
 
@@ -300,7 +302,7 @@ func GetRegistryFilterer(ethWsClient *ethclient.Client) *RegistryFilterer {
 	return reg
 }
 
-func getServiceMetaDataUrifromRegistry() []byte {
+func getServiceMetaDataURIfromRegistry() []byte {
 	reg := getRegistryCaller()
 
 	orgId := StringToBytes32(config.GetString(config.OrganizationId))
@@ -408,7 +410,7 @@ func setFreeCallData(metaData *ServiceMetadata) error {
 		metaData.freeCallsAllowed = metaData.defaultGroup.FreeCalls
 		//If the signer address is not a valid address, then return back an error
 		if !common.IsHexAddress(metaData.defaultGroup.FreeCallSigner) {
-			return fmt.Errorf("MetaData does not have 'free_call_signer_address defined correctly")
+			return fmt.Errorf("MetaData does not have 'free_call_signer_address defined correctly" + errs.ErrDescURL(errs.InvalidMetadata))
 		}
 		metaData.freeCallSignerAddress = common.HexToAddress(ToChecksumAddress(metaData.defaultGroup.FreeCallSigner))
 	}
@@ -453,10 +455,10 @@ func (metaData *ServiceMetadata) GetLicenses() Licenses {
 
 // methodFullName , ex "/example_service.Calculator/add"
 func (metaData *ServiceMetadata) GetDynamicPricingMethodAssociated(methodFullName string) (pricingMethod string, isDynamicPricingEligible bool) {
-	//Check if Method Level Options are defined , for the given Service and method,
-	//If Defined check if its in the format supported , then return the full method Name
+	// Check if Method Level Options are defined, for the given Service and method,
+	// If Defined check if it's in the format supported, then return the full method Name
 	// i.e /package.service/method format , this will be directly fed in to the grpc called to made to
-	//determine dynamic pricing
+	// determine dynamic pricing
 	if !config.GetBool(config.EnableDynamicPricing) {
 		return
 	}
@@ -469,23 +471,12 @@ func (metaData *ServiceMetadata) GetDynamicPricingMethodAssociated(methodFullNam
 	return
 }
 
-// methodFullName , ex "/example_service.Calculator/add"
+// IsModelTraining methodFullName , ex "/example_service.Calculator/add"
 func (metaData *ServiceMetadata) IsModelTraining(methodFullName string) (useModelTrainingEndPoint bool) {
-
 	if !config.GetBool(config.ModelTrainingEnabled) {
 		return false
 	}
-	useModelTrainingEndPoint = isElementInArray(methodFullName, metaData.TrainingMethods)
-	return
-}
-
-func isElementInArray(a string, list []string) bool {
-	for _, b := range list {
-		if b == a {
-			return true
-		}
-	}
-	return false
+	return slices.Contains(metaData.TrainingMethods, methodFullName)
 }
 
 func setServiceProto(metaData *ServiceMetadata) (err error) {
@@ -594,8 +585,8 @@ func getFileDescriptor(protoContent string) protoreflect.FileDescriptor {
 		SourceInfoMode: protocompile.SourceInfoStandard,
 	}
 	fds, err := compiler.Compile(context.Background(), serviceProto)
-	if err != nil {
-		zap.L().Error(err.Error())
+	if err != nil || fds == nil {
+		zap.L().Fatal("failed to analyze protofile"+errs.ErrDescURL(errs.InvalidProto), zap.Error(err))
 	}
 	return fds.FindFileByPath(serviceProto)
 }

blockchain/serviceMetadata_test.go

@@ -3,6 +3,7 @@ package blockchain
 import (
 	"fmt"
 	"math/big"
+	"slices"
 	"strings"
 	"testing"
 
@@ -58,6 +59,7 @@ func TestTiers(t *testing.T) {
 	assert.Equal(t, metaData.GetLicenses().Tiers[0].Range[0].DiscountInPercentage,
 		1.0)
 }
+
 func TestInitServiceMetaDataFromJson(t *testing.T) {
 	//Parse Bad JSON
 	_, err := InitServiceMetaDataFromJson([]byte(strings.Replace(testJsonData, "{", "", 1)))
@@ -68,7 +70,7 @@ func TestInitServiceMetaDataFromJson(t *testing.T) {
 	//Parse Bad JSON
 	_, err = InitServiceMetaDataFromJson([]byte(strings.Replace(testJsonData, "0x7DF35C98f41F3Af0df1dc4c7F7D4C19a71Dd059F", "", 1)))
 	if err != nil {
-		assert.Equal(t, err.Error(), "MetaData does not have 'free_call_signer_address defined correctly")
+		assert.Contains(t, err.Error(), "MetaData does not have 'free_call_signer_address defined correctly")
 	}
 	_, err = InitServiceMetaDataFromJson([]byte(strings.Replace(testJsonData, "default_pricing", "dummy", 1)))
 	if err != nil {
@@ -84,11 +86,10 @@ func TestReadServiceMetaDataFromLocalFile(t *testing.T) {
 }
 
 func Test_getServiceMetaDataUrifromRegistry(t *testing.T) {
-	assert.Panics(t, func() { getServiceMetaDataUrifromRegistry() })
+	assert.Panics(t, func() { getServiceMetaDataURIfromRegistry() })
 	config.Vip().Set(config.BlockChainNetworkSelected, "sepolia")
 	config.Validate()
-	assert.Panics(t, func() { getServiceMetaDataUrifromRegistry() })
-
+	assert.Panics(t, func() { getServiceMetaDataURIfromRegistry() })
 }
 
 func Test_setDefaultPricing(t *testing.T) {
@@ -112,7 +113,7 @@ func TestServiceMetadata_parseServiceProto(t *testing.T) {
 	assert.NotNil(t, priceMethodMap)
 	assert.NotNil(t, trainingMethods)
 	dynamicPriceMethod, ok := priceMethodMap["/example_service.Calculator/add"]
-	isTrainingMethod := isElementInArray("/example_service.Calculator/train_add", trainingMethods)
+	isTrainingMethod := slices.Contains(trainingMethods, "/example_service.Calculator/train_add")
 	assert.Equal(t, dynamicPriceMethod, "/example_service.Calculator/dynamic_pricing_add")
 	assert.True(t, ok, "true")
 	assert.True(t, isTrainingMethod)

config/config.go

@@ -200,6 +200,7 @@ func Validate() error {
 	switch dType := vip.GetString(DaemonTypeKey); dType {
 	case "grpc":
 	case "http":
+		zap.L().Warn("daemon type http is not for production mode, be careful")
 	default:
 		return fmt.Errorf("unrecognized DAEMON_TYPE '%+v'", dType)
 	}

contract_event_listener/listen_organization_metadata_changing.go

@@ -13,7 +13,7 @@ import (
 )
 
 func (l *ContractEventListener) ListenOrganizationMetadataChanging() {
-	zap.L().Info("Starting contract event listener for organization metadata changing")
+	zap.L().Debug("Starting contract event listener for organization metadata changing")
 
 	watchOpts := &bind.WatchOpts{
 		Start:   nil,
@@ -29,7 +29,7 @@ func (l *ContractEventListener) ListenOrganizationMetadataChanging() {
 	sub, err := registryFilterer.WatchOrganizationModified(watchOpts, eventContractChannel, orgIdFilter)
 
 	if err != nil {
-		zap.L().Fatal("Failed to subscribe to logs", zap.Error(err))
+		zap.L().Error("Failed to subscribe to logs", zap.Error(err))
 	}
 
 	for {

errs/errs.go

@@ -0,0 +1,22 @@
+package errs
+
+import (
+	"fmt"
+)
+
+const devPortalURL = "https://dev.singularitynet.io/docs/products/DecentralizedAIPlatform/Daemon/error-codes/#_"
+
+const (
+	_ = iota
+	ServiceUnavailable
+	InvalidMetadata
+	InvalidProto
+	HTTPRequestBuildError
+	InvalidServiceCredentials
+	InvalidConfig
+	ReceiveMsgError
+)
+
+func ErrDescURL(code int) string {
+	return fmt.Sprintf("\nAbout error & possible fixes: %s%d", devPortalURL, code)
+}

escrow/free_call_storage.go

@@ -35,6 +35,7 @@ func serializeFreeCallKey(key any) (serialized string, err error) {
 	myKey := key.(*FreeCallUserKey)
 	return myKey.String(), nil
 }
+
 func (storage *FreeCallUserStorage) Get(key *FreeCallUserKey) (state *FreeCallUserData, ok bool, err error) {
 	value, ok, err := storage.delegate.Get(key)
 	if err != nil || !ok {