Feat/pubkeyconverter_refactor

cmd/keygenerator/converter/errors.go

@@ -2,4 +2,5 @@ package converter
 
 import "errors"
 
+// ErrNotImplemented is returned when a method is not implemented
 var errNotImplemented = errors.New("not implemented")

cmd/keygenerator/converter/pidPubkeyConverter.go

@@ -33,7 +33,7 @@ func (converter *pidPubkeyConverter) Decode(_ string) ([]byte, error) {
 }
 
 // Encode encodes a byte array in its string representation
-func (converter *pidPubkeyConverter) Encode(pkBytes []byte) string {
+func (converter *pidPubkeyConverter) Encode(pkBytes []byte) (string, error) {
 	pidString, err := converter.encode(pkBytes)
 	if err != nil {
 		log.Warn("pidPubkeyConverter.Encode encode",
@@ -42,10 +42,10 @@ func (converter *pidPubkeyConverter) Encode(pkBytes []byte) string {
 			"stack trace", string(debug.Stack()),
 		)
 
-		return ""
+		return "", err
 	}
 
-	return pidString
+	return pidString, nil
 }
 
 func (converter *pidPubkeyConverter) encode(pkBytes []byte) (string, error) {

cmd/keygenerator/converter/pidPubkeyConverter_test.go

@@ -30,7 +30,8 @@ func TestPidPubkeyConverter_Encode(t *testing.T) {
 			}
 		}()
 
-		encoded := converter.Encode([]byte("not a valid PK"))
+		encoded, err := converter.Encode([]byte("not a valid PK"))
+		assert.Contains(t, err.Error(), "parameter is invalid")
 		assert.Empty(t, encoded)
 	})
 	t.Run("valid public key should work", func(t *testing.T) {
@@ -40,7 +41,8 @@ func TestPidPubkeyConverter_Encode(t *testing.T) {
 		pkBytes, err := hex.DecodeString(pkHex)
 		assert.Nil(t, err)
 
-		encoded := converter.Encode(pkBytes)
+		encoded, err := converter.Encode(pkBytes)
+		assert.Nil(t, err)
 		assert.Equal(t, "16Uiu2HAmSHgyTYyawhsZv9opxTHX77vKjoPeGkyCYS5fYVMssHjN", encoded)
 	})
 }

cmd/keygenerator/main.go

@@ -41,6 +41,7 @@ const minedWalletPrefixKeys = "mined-wallet"
 const nopattern = "nopattern"
 const desiredpattern = "[0-f]+"
 const noshard = -1
+const pubkeyHrp = "erd"
 
 type key struct {
 	skBytes []byte
@@ -49,7 +50,7 @@ type key struct {
 
 type pubKeyConverter interface {
 	Decode(humanReadable string) ([]byte, error)
-	Encode(pkBytes []byte) string
+	Encode(pkBytes []byte) (string, error)
 	IsInterfaceNil() bool
 }
 
@@ -132,7 +133,7 @@ VERSION:
 
 	validatorPubKeyConverter, _ = pubkeyConverter.NewHexPubkeyConverter(blsPubkeyLen)
 	pidPubKeyConverter          = converter.NewPidPubkeyConverter()
-	walletPubKeyConverter, _    = pubkeyConverter.NewBech32PubkeyConverter(txSignPubkeyLen, log)
+	walletPubKeyConverter, _    = pubkeyConverter.NewBech32PubkeyConverter(txSignPubkeyLen, pubkeyHrp)
 )
 
 func main() {
@@ -365,7 +366,10 @@ func writeKeyToStream(writer io.Writer, key key, converter pubKeyConverter) erro
 		return fmt.Errorf("nil writer")
 	}
 
-	pkString := converter.Encode(key.pkBytes)
+	pkString, err := converter.Encode(key.pkBytes)
+	if err != nil {
+		return err
+	}
 
 	blk := pem.Block{
 		Type:  "PRIVATE KEY for " + pkString,

cmd/node/config/config.toml

@@ -599,6 +599,7 @@
     Length = 32
     Type = "bech32"
     SignatureLength = 64
+    Hrp = "erd"
 
 [ValidatorPubkeyConverter]
     Length = 96

common/factory/pubkeyConverterFactory.go

@@ -7,11 +7,8 @@ import (
 	"github.com/multiversx/mx-chain-core-go/core/pubkeyConverter"
 	"github.com/multiversx/mx-chain-go/config"
 	"github.com/multiversx/mx-chain-go/state"
-	logger "github.com/multiversx/mx-chain-logger-go"
 )
 
-var log = logger.GetOrCreate("state/factory")
-
 // HexFormat defines the hex format for the pubkey converter
 const HexFormat = "hex"
 
@@ -24,7 +21,7 @@ func NewPubkeyConverter(config config.PubkeyConfig) (core.PubkeyConverter, error
 	case HexFormat:
 		return pubkeyConverter.NewHexPubkeyConverter(config.Length)
 	case Bech32Format:
-		return pubkeyConverter.NewBech32PubkeyConverter(config.Length, log)
+		return pubkeyConverter.NewBech32PubkeyConverter(config.Length, config.Hrp)
 	default:
 		return nil, fmt.Errorf("%w unrecognized type %s", state.ErrInvalidPubkeyConverterType, config.Type)
 	}

common/factory/pubkeyConverterFactory_test.go

@@ -32,11 +32,13 @@ func TestNewPubkeyConverter_Bech32ShouldWork(t *testing.T) {
 		config.PubkeyConfig{
 			Length: 32,
 			Type:   "bech32",
+			Hrp:    "erd",
 		},
 	)
 
 	assert.Nil(t, err)
-	expected, _ := pubkeyConverter.NewBech32PubkeyConverter(32, log)
+	expected, err := pubkeyConverter.NewBech32PubkeyConverter(32, "erd")
+	assert.Nil(t, err)
 	assert.IsType(t, expected, pc)
 }
 

config/config.go

@@ -48,6 +48,7 @@ type PubkeyConfig struct {
 	Length          int
 	Type            string
 	SignatureLength int
+	Hrp             string
 }
 
 // TypeConfig will map the string type configuration

config/tomlConfig_test.go

@@ -493,208 +493,143 @@ func TestEnableEpochConfig(t *testing.T) {
 [EnableEpochs]
     # SCDeployEnableEpoch represents the epoch when the deployment of smart contracts will be enabled
     SCDeployEnableEpoch = 1
-
     # BuiltInFunctionsEnableEpoch represents the epoch when the built in functions will be enabled
     BuiltInFunctionsEnableEpoch = 2
-
     # RelayedTransactionsEnableEpoch represents the epoch when the relayed transactions will be enabled
     RelayedTransactionsEnableEpoch = 3
-
     # PenalizedTooMuchGasEnableEpoch represents the epoch when the penalization for using too much gas will be enabled
     PenalizedTooMuchGasEnableEpoch = 4
-
     # SwitchJailWaitingEnableEpoch represents the epoch when the system smart contract processing at end of epoch is enabled
     SwitchJailWaitingEnableEpoch = 5
-
     # BelowSignedThresholdEnableEpoch represents the epoch when the change for computing rating for validators below signed rating is enabled
     BelowSignedThresholdEnableEpoch = 6
-
     # SwitchHysteresisForMinNodesEnableEpoch represents the epoch when the system smart contract changes its config to consider
     # also (minimum) hysteresis nodes for the minimum number of nodes
     SwitchHysteresisForMinNodesEnableEpoch = 7
-
     # TransactionSignedWithTxHashEnableEpoch represents the epoch when the node will also accept transactions that are
     # signed with the hash of transaction
     TransactionSignedWithTxHashEnableEpoch = 8
-
     # MetaProtectionEnableEpoch represents the epoch when the transactions to the metachain are checked to have enough gas
     MetaProtectionEnableEpoch = 9
-
     # AheadOfTimeGasUsageEnableEpoch represents the epoch when the cost of smart contract prepare changes from compiler per byte to ahead of time prepare per byte
     AheadOfTimeGasUsageEnableEpoch = 10
-
     # GasPriceModifierEnableEpoch represents the epoch when the gas price modifier in fee computation is enabled
     GasPriceModifierEnableEpoch = 11
-
     # RepairCallbackEnableEpoch represents the epoch when the callback repair is activated for scrs
     RepairCallbackEnableEpoch = 12
-
     # BlockGasAndFeesReCheckEnableEpoch represents the epoch when gas and fees used in each created or processed block are re-checked
     BlockGasAndFeesReCheckEnableEpoch = 13
-
     # BalanceWaitingListsEnableEpoch represents the epoch when the shard waiting lists are balanced at the start of an epoch
     BalanceWaitingListsEnableEpoch = 14
-
     # ReturnDataToLastTransferEnableEpoch represents the epoch when returned data is added to last output transfer for callbacks
     ReturnDataToLastTransferEnableEpoch = 15
-
     # SenderInOutTransferEnableEpoch represents the epoch when the feature of having different senders in output transfer is enabled
     SenderInOutTransferEnableEpoch = 16
-
     # StakeEnableEpoch represents the epoch when staking is enabled
     StakeEnableEpoch = 17
-
     # StakingV2EnableEpoch represents the epoch when staking v2 is enabled
     StakingV2EnableEpoch = 18
-
     DoubleKeyProtectionEnableEpoch = 19
-
     # ESDTEnableEpoch represents the epoch when ESDT is enabled
     ESDTEnableEpoch = 20
-
     # GovernanceEnableEpoch represents the epoch when governance is enabled
     GovernanceEnableEpoch = 21
-
     # DelegationManagerEnableEpoch represents the epoch when the delegation manager is enabled
     # epoch should not be 0
     DelegationManagerEnableEpoch = 22
-
     # DelegationSmartContractEnableEpoch represents the epoch when delegation smart contract is enabled
     # epoch should not be 0
     DelegationSmartContractEnableEpoch = 23
-
     # CorrectLastUnjailedEnableEpoch represents the epoch when the fix regaring the last unjailed node should apply
     CorrectLastUnjailedEnableEpoch = 24
-
     # RelayedTransactionsV2EnableEpoch represents the epoch when the relayed transactions V2 will be enabled
     RelayedTransactionsV2EnableEpoch = 25
-
     # UnbondTokensV2EnableEpoch represents the epoch when the new implementation of the unbond tokens function is available
     UnbondTokensV2EnableEpoch = 26
-
     # SaveJailedAlwaysEnableEpoch represents the epoch when saving jailed status at end of epoch will happen in all cases
     SaveJailedAlwaysEnableEpoch = 27
-
     # ReDelegateBelowMinCheckEnableEpoch represents the epoch when the check for the re-delegated value will be enabled
     ReDelegateBelowMinCheckEnableEpoch = 28
-
     # ValidatorToDelegationEnableEpoch represents the epoch when the validator-to-delegation feature will be enabled
     ValidatorToDelegationEnableEpoch = 29
-
     # WaitingListFixEnableEpoch represents the epoch when the 6 epoch waiting list fix is enabled
     WaitingListFixEnableEpoch = 30
-
     # IncrementSCRNonceInMultiTransferEnableEpoch represents the epoch when the fix for preventing the generation of the same SCRs
     # is enabled. The fix is done by adding an extra increment.
     IncrementSCRNonceInMultiTransferEnableEpoch = 31
-
     # ESDTMultiTransferEnableEpoch represents the epoch when esdt multitransfer built in function is enabled
     ESDTMultiTransferEnableEpoch = 32
-
     # GlobalMintBurnDisableEpoch represents the epoch when the global mint and burn functions are disabled
     GlobalMintBurnDisableEpoch = 33
-
     # ESDTTransferRoleEnableEpoch represents the epoch when esdt transfer role set is enabled
     ESDTTransferRoleEnableEpoch = 34
-
     # BuiltInFunctionOnMetaEnableEpoch represents the epoch when built in function processing on metachain is enabled
     BuiltInFunctionOnMetaEnableEpoch = 35
-
     # ComputeRewardCheckpointEnableEpoch represents the epoch when compute rewards checkpoint epoch is enabled
     ComputeRewardCheckpointEnableEpoch = 36
-
     # SCRSizeInvariantCheckEnableEpoch represents the epoch when the scr size invariant check is enabled
     SCRSizeInvariantCheckEnableEpoch = 37
-
     # BackwardCompSaveKeyValueEnableEpoch represents the epoch when backward compatibility save key value is enabled
     BackwardCompSaveKeyValueEnableEpoch = 38
-
     # ESDTNFTCreateOnMultiShardEnableEpoch represents the epoch when esdt nft creation on multiple shards is enabled
     ESDTNFTCreateOnMultiShardEnableEpoch = 39
-
     # MetaESDTSetEnableEpoch represents the epoch when the backward compatibility for save key value error is enabled
     MetaESDTSetEnableEpoch = 40
-
     # AddTokensToDelegationEnableEpoch represents the epoch when adding tokens to delegation is enabled for whitelisted address
     AddTokensToDelegationEnableEpoch = 41
-
     # MultiESDTTransferFixOnCallBackOnEnableEpoch represents the epoch when multi esdt transfer on callback fix is enabled
     MultiESDTTransferFixOnCallBackOnEnableEpoch = 42
-
     # OptimizeGasUsedInCrossMiniBlocksEnableEpoch represents the epoch when gas used in cross shard mini blocks will be optimized
     OptimizeGasUsedInCrossMiniBlocksEnableEpoch = 43
-
     # FixOOGReturnCodeEnableEpoch represents the epoch when the backward compatibility returning out of gas error is enabled
     FixOOGReturnCodeEnableEpoch = 44
-
     # RemoveNonUpdatedStorageEnableEpoch represents the epoch when the backward compatibility for removing non updated storage is enabled
     RemoveNonUpdatedStorageEnableEpoch = 45
-
     # OptimizeNFTStoreEnableEpoch represents the epoch when optimizations on NFT metadata store and send are enabled
     OptimizeNFTStoreEnableEpoch = 46
-
     # CreateNFTThroughExecByCallerEnableEpoch represents the epoch when nft creation through execution on destination by caller is enabled
     CreateNFTThroughExecByCallerEnableEpoch = 47
-
     # IsPayableBySCEnableEpoch represents the epoch when a new flag isPayable by SC is enabled
     IsPayableBySCEnableEpoch = 48
-
     # CleanUpInformativeSCRsEnableEpoch represents the epoch when the scrs which contain only information are cleaned from miniblocks and logs are created from it
     CleanUpInformativeSCRsEnableEpoch = 49
-
     # StorageAPICostOptimizationEnableEpoch represents the epoch when new storage helper functions are enabled and cost is reduced in Wasm VM
     StorageAPICostOptimizationEnableEpoch = 50
-
     # TransformToMultiShardCreateEnableEpoch represents the epoch when the new function on esdt system sc is enabled to transfer create role into multishard
     TransformToMultiShardCreateEnableEpoch = 51
-
     # ESDTRegisterAndSetAllRolesEnableEpoch represents the epoch when new function to register tickerID and set all roles is enabled
     ESDTRegisterAndSetAllRolesEnableEpoch = 52
-
     # FailExecutionOnEveryAPIErrorEnableEpoch represent the epoch when new protection in VM is enabled to fail all wrong API calls
     FailExecutionOnEveryAPIErrorEnableEpoch = 53
-
     # ManagedCryptoAPIsEnableEpoch represents the epoch when the new managed crypto APIs are enabled
     ManagedCryptoAPIsEnableEpoch = 54
-
     # ESDTMetadataContinuousCleanupEnableEpoch represents the epoch when esdt metadata is automatically deleted according to inshard liquidity
     ESDTMetadataContinuousCleanupEnableEpoch = 55
-
     # FixAsyncCallBackArgsListEnableEpoch represents the epoch when the async callback arguments lists fix will be enabled
     FixAsyncCallBackArgsListEnableEpoch = 56
-
     # FixOldTokenLiquidityEnableEpoch represents the epoch when the fix for old token liquidity is enabled
     FixOldTokenLiquidityEnableEpoch = 57
-
     # SetSenderInEeiOutputTransferEnableEpoch represents the epoch when setting the sender in eei output transfers will be enabled
     SetSenderInEeiOutputTransferEnableEpoch = 58
-
     # MaxBlockchainHookCountersEnableEpoch represents the epoch when the max blockchainhook counters are enabled
     MaxBlockchainHookCountersEnableEpoch = 59
-
     # WipeSingleNFTLiquidityDecreaseEnableEpoch represents the epoch when the system account liquidity is decreased for wipeSingleNFT as well
     WipeSingleNFTLiquidityDecreaseEnableEpoch = 60
-
     # AlwaysSaveTokenMetaDataEnableEpoch represents the epoch when the token metadata is always saved
     AlwaysSaveTokenMetaDataEnableEpoch = 61
-
     # RuntimeCodeSizeFixEnableEpoch represents the epoch when the code size fix in the VM is enabled
     RuntimeCodeSizeFixEnableEpoch = 62
-
     # RuntimeMemStoreLimitEnableEpoch represents the epoch when the condition for Runtime MemStore is enabled
     RuntimeMemStoreLimitEnableEpoch = 63
-
     # MaxNodesChangeEnableEpoch holds configuration for changing the maximum number of nodes and the enabling epoch
     MaxNodesChangeEnableEpoch = [
         { EpochEnable = 44, MaxNumNodes = 2169, NodesToShufflePerShard = 80 },
         { EpochEnable = 45, MaxNumNodes = 3200, NodesToShufflePerShard = 80 }
     ]
-
     BLSMultiSignerEnableEpoch = [
         {EnableEpoch = 0, Type = "no-KOSK"},
         {EnableEpoch = 3, Type = "KOSK"}
     ]
-
 [GasSchedule]
     GasScheduleByEpochs = [
         { StartEpoch = 46, FileName = "gasScheduleV1.toml" },

dataRetriever/factory/dataPoolFactory_test.go

@@ -86,15 +86,15 @@ func TestNewDataPoolFromConfig_BadConfigShouldErr(t *testing.T) {
 	require.Nil(t, holder)
 	fmt.Println(err)
 	require.NotNil(t, err)
-	require.True(t, strings.Contains(err.Error(), "Must provide a positive size while creating the cache for the miniblocks"))
+	require.True(t, strings.Contains(err.Error(), "must provide a positive size while creating the cache for the miniblocks"))
 
 	args = getGoodArgs()
 	args.Config.PeerBlockBodyDataPool.Capacity = 0
 	holder, err = NewDataPoolFromConfig(args)
 	require.Nil(t, holder)
 	fmt.Println(err)
 	require.NotNil(t, err)
-	require.True(t, strings.Contains(err.Error(), "Must provide a positive size while creating the cache for the peer mini block body"))
+	require.True(t, strings.Contains(err.Error(), "must provide a positive size while creating the cache for the peer mini block body"))
 
 	args = getGoodArgs()
 	args.Config.TrieSyncStorage.Capacity = 0

epochStart/bootstrap/process_test.go

@@ -70,7 +70,7 @@ func createComponentsForEpochStart() (*mock.CoreComponentsMock, *mock.CryptoComp
 			Hash:                         &hashingMocks.HasherMock{},
 			TxSignHasherField:            &hashingMocks.HasherMock{},
 			UInt64ByteSliceConv:          &mock.Uint64ByteSliceConverterMock{},
-			AddrPubKeyConv:               &mock.PubkeyConverterMock{},
+			AddrPubKeyConv:               &testscommon.PubkeyConverterMock{},
 			PathHdl:                      &testscommon.PathManagerStub{},
 			EpochNotifierField:           &epochNotifier.EpochNotifierStub{},
 			TxVersionCheckField:          versioning.NewTxVersionChecker(1),

epochStart/bootstrap/syncEpochStartMeta_test.go

@@ -137,7 +137,7 @@ func getEpochStartSyncerArgs() ArgsNewEpochStartMetaSyncer {
 			Marsh:               &mock.MarshalizerMock{},
 			Hash:                &hashingMocks.HasherMock{},
 			UInt64ByteSliceConv: &mock.Uint64ByteSliceConverterMock{},
-			AddrPubKeyConv:      mock.NewPubkeyConverterMock(32),
+			AddrPubKeyConv:      testscommon.NewPubkeyConverterMock(32),
 			PathHdl:             &testscommon.PathManagerStub{},
 			ChainIdCalled: func() string {
 				return "chain-ID"

epochStart/metachain/baseRewards_test.go

@@ -1150,7 +1150,7 @@ func getBaseRewardsArguments() BaseRewardsCreatorArgs {
 
 	return BaseRewardsCreatorArgs{
 		ShardCoordinator:              shardCoordinator,
-		PubkeyConverter:               mock.NewPubkeyConverterMock(32),
+		PubkeyConverter:               testscommon.NewPubkeyConverterMock(32),
 		RewardsStorage:                mock.NewStorerMock(),
 		MiniBlockStorage:              mock.NewStorerMock(),
 		Hasher:                        &hashingMocks.HasherMock{},