fix(transcation):#195 fixed min_confirmation bug on verify transaction

core/conf/conf.go

@@ -0,0 +1,23 @@
+// pakcage conf provide config helpers for ~/.zcn/config.yaml, ～/.zcn/network.yaml and ~/.zcn/wallet.json
+
+package conf
+
+import (
+ "errors"
+)
+
+var (
+ // ErrMssingConfig config file is missing
+ ErrMssingConfig = errors.New("[conf]missing config file")
+ // ErrInvalidValue invalid value in config
+ ErrInvalidValue = errors.New("[conf]invalid value")
+ // ErrBadParsing fail to parse config via spf13/viper
+ ErrBadParsing = errors.New("[conf]bad parsing")
+)
+
+// Reader a config reader
+type Reader interface {
+ GetString(key string) string
+ GetInt(key string) int
+ GetStringSlice(key string) []string
+}

core/conf/config.go

@@ -0,0 +1,151 @@
+package conf
+
+import (
+ "errors"
+ "net/url"
+ "os"
+ "strings"
+
+ thrown "github.com/0chain/errors"
+ "github.com/spf13/viper"
+)
+
+const (
+ // DefaultMinSubmit default value for min_submit
+ DefaultMinSubmit = 50
+ // DefaultMinConfirmation default value for min_confirmation
+ DefaultMinConfirmation = 50
+ // DefaultMaxTxnQuery default value for max_txn_query
+ DefaultMaxTxnQuery = 5
+ // DefaultConfirmationChainLength default value for confirmation_chain_length
+ DefaultConfirmationChainLength = 3
+ // DefaultQuerySleepTime default value for query_sleep_time
+ DefaultQuerySleepTime = 5
+)
+
+// Config settings from ~/.zcn/config.yaml
+// block_worker: http://198.18.0.98:9091
+// signature_scheme: bls0chain
+// min_submit: 50
+// min_confirmation: 50
+// confirmation_chain_length: 3
+// max_txn_query: 5
+// query_sleep_time: 5
+// # # OPTIONAL - Uncomment to use/ Add more if you want
+// # preferred_blobbers:
+// # - http://one.devnet-0chain.net:31051
+// # - http://one.devnet-0chain.net:31052
+// # - http://one.devnet-0chain.net:31053
+type Config struct {
+ // BlockWorker the url of 0dns's network api
+ BlockWorker string
+ // PreferredBlobbers preferred blobbers on new allocation
+ PreferredBlobbers []string
+
+ // MinSubmit mininal submit from blobber
+ MinSubmit int
+ // MinConfirmation mininal confirmation from sharders
+ MinConfirmation int
+ // CconfirmationChainLength minial confirmation chain length
+ ConfirmationChainLength int
+
+ // additional settings depending network latency
+ // MaxTxnQuery maximum transcation query from sharders
+ MaxTxnQuery int
+ // QuerySleepTime sleep time before transcation query
+ QuerySleepTime int
+
+ // SignatureScheme signature scheme
+ SignatureScheme string
+ // ChainID which blockchain it is working
+ ChainID string
+}
+
+// LoadConfigFile load and parse Config from file
+func LoadConfigFile(file string) (Config, error) {
+
+ var cfg Config
+ var err error
+
+ _, err = os.Stat(file)
+
+ if err != nil {
+ if errors.Is(err, os.ErrNotExist) {
+ return cfg, thrown.Throw(ErrMssingConfig, file)
+ }
+ return cfg, err
+ }
+
+ v := viper.New()
+
+ v.SetConfigFile(file)
+
+ if err := v.ReadInConfig(); err != nil {
+ return cfg, thrown.Throw(ErrBadParsing, err.Error())
+ }
+
+ return LoadConfig(v)
+}
+
+// LoadConfig load and parse config
+func LoadConfig(v Reader) (Config, error) {
+
+ var cfg Config
+
+ blockWorker := strings.TrimSpace(v.GetString("block_worker"))
+
+ if !isURL(blockWorker) {
+ return cfg, thrown.Throw(ErrInvalidValue, "block_worker="+blockWorker)
+ }
+
+ minSubmit := v.GetInt("min_submit")
+ if minSubmit < 1 {
+ minSubmit = DefaultMinSubmit
+ } else if minSubmit > 100 {
+ minSubmit = 100
+ }
+
+ minCfm := v.GetInt("min_confirmation")
+
+ if minCfm < 1 {
+ minCfm = DefaultMinConfirmation
+ } else if minCfm > 100 {
+ minCfm = 100
+ }
+
+ CfmChainLength := v.GetInt("confirmation_chain_length")
+
+ if CfmChainLength < 1 {
+ CfmChainLength = DefaultConfirmationChainLength
+ }
+
+ // additional settings depending network latency
+ maxTxnQuery := v.GetInt("max_txn_query")
+ if maxTxnQuery < 1 {
+ maxTxnQuery = DefaultMaxTxnQuery
+ }
+
+ querySleepTime := v.GetInt("query_sleep_time")
+ if querySleepTime < 1 {
+ querySleepTime = DefaultQuerySleepTime
+ }
+
+ cfg.BlockWorker = blockWorker
+ cfg.PreferredBlobbers = v.GetStringSlice("preferred_blobbers")
+ cfg.MinSubmit = minSubmit
+ cfg.MinConfirmation = minCfm
+ cfg.ConfirmationChainLength = CfmChainLength
+ cfg.MaxTxnQuery = maxTxnQuery
+ cfg.QuerySleepTime = querySleepTime
+
+ cfg.SignatureScheme = v.GetString("signature_scheme")
+ cfg.ChainID = v.GetString("chain_id")
+
+ return cfg, nil
+
+}
+
+func isURL(s string) bool {
+ u, err := url.Parse(s)
+ return err == nil && u.Scheme != "" && u.Host != ""
+}

core/conf/config_test.go

@@ -0,0 +1,183 @@
+package conf
+
+import (
+ "testing"
+
+ "github.com/0chain/gosdk/core/conf/mocks"
+ "github.com/stretchr/testify/require"
+)
+
+func TestLoadConfig(t *testing.T) {
+
+ var mockDefaultReader = func() Reader {
+ reader := &mocks.Reader{}
+ reader.On("GetString", "block_worker").Return("http://127.0.0.1:9091/dns")
+ reader.On("GetInt", "min_submit").Return(0)
+ reader.On("GetInt", "min_confirmation").Return(0)
+ reader.On("GetInt", "max_txn_query").Return(0)
+ reader.On("GetInt", "query_sleep_time").Return(0)
+ reader.On("GetInt", "confirmation_chain_length").Return(0)
+ reader.On("GetStringSlice", "preferred_blobbers").Return(nil)
+ reader.On("GetString", "signature_scheme").Return("")
+ reader.On("GetString", "chain_id").Return("")
+
+ return reader
+
+ }
+
+ tests := []struct {
+ name string
+ exceptedErr error
+
+ setup func(*testing.T) Reader
+ run func(*require.Assertions, Config)
+ }{
+ {
+ name: "Test_Config_Invalid_BlockWorker",
+ exceptedErr: ErrInvalidValue,
+ setup: func(t *testing.T) Reader {
+
+ reader := &mocks.Reader{}
+ reader.On("GetString", "block_worker").Return("")
+ reader.On("GetInt", "min_submit").Return(0)
+ reader.On("GetInt", "min_confirmation").Return(0)
+ reader.On("GetInt", "max_txn_query").Return(0)
+ reader.On("GetInt", "query_sleep_time").Return(0)
+ reader.On("GetInt", "confirmation_chain_length").Return(0)
+ reader.On("GetStringSlice", "preferred_blobbers").Return(nil)
+ reader.On("GetString", "signature_scheme").Return("")
+ reader.On("GetString", "chain_id").Return("")
+
+ return reader
+ },
+ run: func(r *require.Assertions, cfg Config) {
+
+ },
+ },
+ {
+ name: "Test_Config_BlockWorker",
+
+ setup: func(t *testing.T) Reader {
+ return mockDefaultReader()
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal("http://127.0.0.1:9091/dns", cfg.BlockWorker)
+ },
+ },
+ {
+ name: "Test_Config_Min_Submit_Less_Than_1",
+
+ setup: func(t *testing.T) Reader {
+ return mockDefaultReader()
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(50, cfg.MinSubmit)
+ },
+ },
+ {
+ name: "Test_Config_Min_Submit_Greater_Than_100",
+
+ setup: func(t *testing.T) Reader {
+
+ reader := &mocks.Reader{}
+ reader.On("GetString", "block_worker").Return("https://127.0.0.1:9091/dns")
+ reader.On("GetInt", "min_submit").Return(101)
+ reader.On("GetInt", "min_confirmation").Return(0)
+ reader.On("GetInt", "max_txn_query").Return(0)
+ reader.On("GetInt", "query_sleep_time").Return(0)
+ reader.On("GetInt", "confirmation_chain_length").Return(0)
+ reader.On("GetStringSlice", "preferred_blobbers").Return(nil)
+ reader.On("GetString", "signature_scheme").Return("")
+ reader.On("GetString", "chain_id").Return("")
+
+ return reader
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(100, cfg.MinSubmit)
+ },
+ },
+ {
+ name: "Test_Config_Min_Confirmation_Less_Than_1",
+
+ setup: func(t *testing.T) Reader {
+ return mockDefaultReader()
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(50, cfg.MinConfirmation)
+ },
+ },
+ {
+ name: "Test_Config_Min_Confirmation_Greater_100",
+
+ setup: func(t *testing.T) Reader {
+
+ reader := &mocks.Reader{}
+ reader.On("GetString", "block_worker").Return("https://127.0.0.1:9091/dns")
+ reader.On("GetInt", "min_submit").Return(0)
+ reader.On("GetInt", "min_confirmation").Return(101)
+ reader.On("GetInt", "max_txn_query").Return(0)
+ reader.On("GetInt", "query_sleep_time").Return(0)
+ reader.On("GetInt", "confirmation_chain_length").Return(0)
+ reader.On("GetStringSlice", "preferred_blobbers").Return(nil)
+ reader.On("GetString", "signature_scheme").Return("")
+ reader.On("GetString", "chain_id").Return("")
+
+ return reader
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(100, cfg.MinConfirmation)
+ },
+ }, {
+ name: "Test_Config_Nax_Txn_Query_Less_Than_1",
+
+ setup: func(t *testing.T) Reader {
+
+ return mockDefaultReader()
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(5, cfg.QuerySleepTime)
+ },
+ }, {
+ name: "Test_Config_Max_Txn_Query_Less_Than_1",
+
+ setup: func(t *testing.T) Reader {
+
+ return mockDefaultReader()
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(5, cfg.MaxTxnQuery)
+ },
+ }, {
+ name: "Test_Config_Confirmation_Chain_Length_Less_Than_1",
+
+ setup: func(t *testing.T) Reader {
+ return mockDefaultReader()
+ },
+ run: func(r *require.Assertions, cfg Config) {
+ r.Equal(3, cfg.ConfirmationChainLength)
+ },
+ },
+ }
+ for _, tt := range tests {
+ t.Run(tt.name, func(t *testing.T) {
+
+ require := require.New(t)
+
+ reader := tt.setup(t)
+
+ cfg, err := LoadConfig(reader)
+
+ // test it by predefined error variable instead of error message
+ if tt.exceptedErr != nil {
+ require.ErrorIs(err, tt.exceptedErr)
+ } else {
+ require.Equal(nil, err)
+ }
+
+ if tt.run != nil {
+ tt.run(require, cfg)
+ }
+
+ })
+ }
+}