Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactoring for encoding logic #309

Merged
merged 7 commits into from
Nov 13, 2023
Merged

refactoring for encoding logic #309

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
6de679f
replace base58, base64, gob to internal function
rabbitprincess Nov 3, 2023
5709ea0
replace hex to internal function
rabbitprincess Nov 3, 2023
14d8832
add base64check test
rabbitprincess Nov 3, 2023
c676909
move gob common to enc
rabbitprincess Nov 5, 2023
c5fcd89
enc - split packages
rabbitprincess Nov 6, 2023
04c5a26
move proto encode to internal
rabbitprincess Nov 6, 2023
1b6364b
Merge branch 'develop' into feature/encoding
kroggen Nov 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions account/key/crypto/v1strategy.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@ import (
"crypto/cipher"
"crypto/rand"
"crypto/sha256"
"encoding/hex"
"encoding/json"
"errors"
"io"
"reflect"

"github.com/aergoio/aergo/v2/internal/enc/hex"
"github.com/aergoio/aergo/v2/types"
"github.com/btcsuite/btcd/btcec"
"golang.org/x/crypto/scrypt"
Expand Down Expand Up @@ -105,9 +105,9 @@ func (ks *v1Strategy) Encrypt(key *PrivateKey, passphrase string) ([]byte, error
cipher := v1CipherJSON{
Algorithm: cipherAlgorithm,
Params: v1CipherParamsJSON{
Iv: hex.EncodeToString(iv),
Iv: hex.Encode(iv),
},
Ciphertext: hex.EncodeToString(ciphertext),
Ciphertext: hex.Encode(ciphertext),
}
// json: kdf
kdf := v1KdfJson{
Expand All @@ -117,9 +117,9 @@ func (ks *v1Strategy) Encrypt(key *PrivateKey, passphrase string) ([]byte, error
N: scryptN,
P: scryptP,
R: scryptR,
Salt: hex.EncodeToString(salt),
Salt: hex.Encode(salt),
},
Mac: hex.EncodeToString(mac),
Mac: hex.Encode(mac),
}
rawAddress := GenerateAddress(&(key.ToECDSA().PublicKey))
encodedAddress := types.EncodeAddress(rawAddress)
Expand Down Expand Up @@ -155,11 +155,11 @@ func (ks *v1Strategy) Decrypt(encrypted []byte, passphrase string) (*PrivateKey,
}

// check mac
mac, err := hex.DecodeString(kdf.Mac)
mac, err := hex.Decode(kdf.Mac)
if nil != err {
return nil, err
}
cipherText, err := hex.DecodeString(cipher.Ciphertext)
cipherText, err := hex.Decode(cipher.Ciphertext)
if nil != err {
return nil, err
}
Expand All @@ -170,7 +170,7 @@ func (ks *v1Strategy) Decrypt(encrypted []byte, passphrase string) (*PrivateKey,

// decrypt
decryptKey := derivedKey[:16]
iv, err := hex.DecodeString(cipher.Params.Iv)
iv, err := hex.Decode(cipher.Params.Iv)
if nil != err {
return nil, err
}
Expand Down Expand Up @@ -207,7 +207,7 @@ func checkKeyFormat(keyFormat *v1KeyStoreFormat) error {
}

func deriveCipherKey(passphrase []byte, kdf v1KdfJson) ([]byte, error) {
salt, err := hex.DecodeString(kdf.Params.Salt)
salt, err := hex.Decode(kdf.Params.Salt)
if err != nil {
return nil, err
}
Expand Down
22 changes: 11 additions & 11 deletions chain/blockvalidator.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import (
"errors"
"fmt"

"github.com/aergoio/aergo/v2/internal/enc"
"github.com/aergoio/aergo/v2/internal/enc/base58"
"github.com/aergoio/aergo/v2/pkg/component"
"github.com/aergoio/aergo/v2/state"
"github.com/aergoio/aergo/v2/types"
Expand Down Expand Up @@ -90,7 +90,7 @@ func (t validateReport) toString() string {
result = "failed"
}

msgStr = fmt.Sprintf("%s : %s. block= %s, computed=%s", t.name, result, enc.ToString(t.src), enc.ToString(t.target))
msgStr = fmt.Sprintf("%s : %s. block= %s, computed=%s", t.name, result, base58.Encode(t.src), base58.Encode(t.target))

return msgStr
}
Expand All @@ -99,7 +99,7 @@ func (bv *BlockValidator) ValidateBody(block *types.Block) error {
txs := block.GetBody().GetTxs()

// TxRootHash
logger.Debug().Int("Txlen", len(txs)).Str("TxRoot", enc.ToString(block.GetHeader().GetTxsRootHash())).
logger.Debug().Int("Txlen", len(txs)).Str("TxRoot", base58.Encode(block.GetHeader().GetTxsRootHash())).
Msg("tx root verify")

hdrRootHash := block.GetHeader().GetTxsRootHash()
Expand All @@ -112,8 +112,8 @@ func (bv *BlockValidator) ValidateBody(block *types.Block) error {

if !ret {
logger.Error().Str("block", block.ID()).
Str("txroot", enc.ToString(hdrRootHash)).
Str("compute txroot", enc.ToString(computeTxRootHash)).
Str("txroot", base58.Encode(hdrRootHash)).
Str("compute txroot", base58.Encode(computeTxRootHash)).
Msg("tx root validation failed")

return ErrorBlockVerifyTxRoot
Expand Down Expand Up @@ -160,13 +160,13 @@ func (bv *BlockValidator) ValidatePost(sdbRoot []byte, receipts *types.Receipts,
}
if !ret {
logger.Error().Str("block", block.ID()).
Str("hdrroot", enc.ToString(hdrRoot)).
Str("sdbroot", enc.ToString(sdbRoot)).
Str("hdrroot", base58.Encode(hdrRoot)).
Str("sdbroot", base58.Encode(sdbRoot)).
Msg("block root hash validation failed")
return ErrorBlockVerifyStateRoot
}

logger.Debug().Str("sdbroot", enc.ToString(sdbRoot)).
logger.Debug().Str("sdbroot", base58.Encode(sdbRoot)).
Msg("block root hash validation succeed")

hdrRoot = block.GetHeader().ReceiptsRootHash
Expand All @@ -177,12 +177,12 @@ func (bv *BlockValidator) ValidatePost(sdbRoot []byte, receipts *types.Receipts,
bv.report(validateReport{name: "Verify receipt merkle root", pass: ret, src: hdrRoot, target: receiptsRoot})
} else if !ret {
logger.Error().Str("block", block.ID()).
Str("hdrroot", enc.ToString(hdrRoot)).
Str("receipts_root", enc.ToString(receiptsRoot)).
Str("hdrroot", base58.Encode(hdrRoot)).
Str("receipts_root", base58.Encode(receiptsRoot)).
Msg("receipts root hash validation failed")
return ErrorBlockVerifyReceiptRoot
}
logger.Debug().Str("receipts_root", enc.ToString(receiptsRoot)).
logger.Debug().Str("receipts_root", base58.Encode(receiptsRoot)).
Msg("receipt root hash validation succeed")

return nil
Expand Down
6 changes: 3 additions & 3 deletions chain/chainanchor.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
package chain

import (
"github.com/aergoio/aergo/v2/internal/enc"
"github.com/aergoio/aergo/v2/internal/enc/base58"
"github.com/aergoio/aergo/v2/types"
)

Expand Down Expand Up @@ -72,7 +72,7 @@ func (cs *ChainService) getAnchorsFromHash(blockHash []byte) ChainAnchor {
return nil
}

logger.Debug().Uint64("no", latestNo).Str("hash", enc.ToString(blockHash)).Msg("anchor")
logger.Debug().Uint64("no", latestNo).Str("hash", base58.Encode(blockHash)).Msg("anchor")

anchors = append(anchors, blockHash)
if latestNo == 0 {
Expand All @@ -91,7 +91,7 @@ func (cs *ChainService) getAnchorsFromHash(blockHash []byte) ChainAnchor {
return nil
}

logger.Debug().Uint64("no", latestNo).Str("hash", enc.ToString(blockHash)).Msg("anchor")
logger.Debug().Uint64("no", latestNo).Str("hash", base58.Encode(blockHash)).Msg("anchor")

anchors = append(anchors, blockHash)
if latestNo <= dec {
Expand Down
33 changes: 12 additions & 21 deletions chain/chaindb.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ package chain

import (
"bytes"
"encoding/gob"
"encoding/json"
"errors"
"fmt"
Expand All @@ -17,7 +16,8 @@ import (
"github.com/aergoio/aergo/v2/config"
"github.com/aergoio/aergo/v2/consensus"
"github.com/aergoio/aergo/v2/internal/common"
"github.com/aergoio/aergo/v2/internal/enc"
"github.com/aergoio/aergo/v2/internal/enc/base58"
"github.com/aergoio/aergo/v2/internal/enc/gob"
"github.com/aergoio/aergo/v2/types"
"github.com/aergoio/aergo/v2/types/dbkey"
"github.com/golang/protobuf/proto"
Expand Down Expand Up @@ -45,7 +45,7 @@ func (e ErrNoBlock) Error() string {

switch id := e.id.(type) {
case []byte:
idStr = fmt.Sprintf("blockHash=%v", enc.ToString(id))
idStr = fmt.Sprintf("blockHash=%v", base58.Encode(id))
default:
idStr = fmt.Sprintf("blockNo=%v", id)
}
Expand Down Expand Up @@ -445,7 +445,7 @@ func (cdb *ChainDB) addTxsOfBlock(dbTx *db.Transaction, txs []*types.Tx, blockHa

for i, txEntry := range txs {
if err := cdb.addTx(dbTx, txEntry, blockHash, i); err != nil {
logger.Error().Err(err).Str("hash", enc.ToString(blockHash)).Int("txidx", i).
logger.Error().Err(err).Str("hash", base58.Encode(blockHash)).Int("txidx", i).
Msg("failed to add tx")

return err
Expand Down Expand Up @@ -611,7 +611,7 @@ func (cdb *ChainDB) getTx(txHash []byte) (*types.Tx, *types.TxIdx, error) {

err := cdb.loadData(txHash, txIdx)
if err != nil {
return nil, nil, fmt.Errorf("tx not found: txHash=%v", enc.ToString(txHash))
return nil, nil, fmt.Errorf("tx not found: txHash=%v", base58.Encode(txHash))
}
block, err := cdb.getBlock(txIdx.BlockHash)
if err != nil {
Expand All @@ -622,7 +622,7 @@ func (cdb *ChainDB) getTx(txHash []byte) (*types.Tx, *types.TxIdx, error) {
return nil, nil, fmt.Errorf("wrong tx idx: %d", txIdx.Idx)
}
tx := txs[txIdx.Idx]
logger.Debug().Str("hash", enc.ToString(txHash)).Msg("getTx")
logger.Debug().Str("hash", base58.Encode(txHash)).Msg("getTx")

return tx, txIdx, nil
}
Expand All @@ -649,13 +649,10 @@ func (cdb *ChainDB) getReceipts(blockHash []byte, blockNo types.BlockNo,
if len(data) == 0 {
return nil, errors.New("cannot find a receipt")
}
var b bytes.Buffer
b.Write(data)
var receipts types.Receipts

receipts.SetHardFork(hardForkConfig, blockNo)
decoder := gob.NewDecoder(&b)
err := decoder.Decode(&receipts)
err := gob.Decode(data, &receipts)

return &receipts, err
}
Expand Down Expand Up @@ -683,9 +680,9 @@ func (cdb *ChainDB) GetChainTree() ([]byte, error) {
hash, _ := cdb.getHashByNo(i)
tree = append(tree, ChainInfo{
Height: i,
Hash: enc.ToString(hash),
Hash: base58.Encode(hash),
})
logger.Info().Str("hash", enc.ToString(hash)).Msg("GetChainTree")
logger.Info().Str("hash", base58.Encode(hash)).Msg("GetChainTree")
}
jsonBytes, err := json.Marshal(tree)
if err != nil {
Expand All @@ -698,11 +695,8 @@ func (cdb *ChainDB) writeReceipts(blockHash []byte, blockNo types.BlockNo, recei
dbTx := cdb.store.NewTx()
defer dbTx.Discard()

var val bytes.Buffer
gobEncoder := gob.NewEncoder(&val)
gobEncoder.Encode(receipts)

dbTx.Set(dbkey.Receipts(blockHash, blockNo), val.Bytes())
val, _ := gob.Encode(receipts)
dbTx.Set(dbkey.Receipts(blockHash, blockNo), val)

dbTx.Commit()
}
Expand Down Expand Up @@ -743,10 +737,7 @@ func (cdb *ChainDB) getReorgMarker() (*ReorgMarker, error) {
}

var marker ReorgMarker
var b bytes.Buffer
b.Write(data)
decoder := gob.NewDecoder(&b)
err := decoder.Decode(&marker)
err := gob.Decode(data, &marker)

return &marker, err
}
Expand Down
21 changes: 6 additions & 15 deletions chain/chaindbForRaft.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
package chain

import (
"bytes"
"encoding/gob"
"errors"

"github.com/aergoio/aergo-lib/db"
"github.com/aergoio/aergo/v2/consensus"
"github.com/aergoio/aergo/v2/internal/enc/gob"
"github.com/aergoio/aergo/v2/types"
"github.com/aergoio/aergo/v2/types/dbkey"
"github.com/aergoio/etcd/raft/raftpb"
Expand Down Expand Up @@ -235,10 +234,7 @@ func (cdb *ChainDB) GetRaftEntry(idx uint64) (*consensus.WalEntry, error) {
}

var entry consensus.WalEntry
var b bytes.Buffer
b.Write(data)
decoder := gob.NewDecoder(&b)
if err := decoder.Decode(&entry); err != nil {
if err := gob.Decode(data, &entry); err != nil {
return nil, err
}

Expand Down Expand Up @@ -425,14 +421,12 @@ func (cdb *ChainDB) WriteIdentity(identity *consensus.RaftIdentity) error {

logger.Info().Str("id", identity.ToString()).Msg("save raft identity")

var val bytes.Buffer

enc := gob.NewEncoder(&val)
if err := enc.Encode(identity); err != nil {
enc, err := gob.Encode(identity)
if err != nil {
return ErrEncodeRaftIdentity
}

dbTx.Set(dbkey.RaftIdentity(), val.Bytes())
dbTx.Set(dbkey.RaftIdentity(), enc)
dbTx.Commit()

return nil
Expand All @@ -445,10 +439,7 @@ func (cdb *ChainDB) GetIdentity() (*consensus.RaftIdentity, error) {
}

var id consensus.RaftIdentity
var b bytes.Buffer
b.Write(data)
decoder := gob.NewDecoder(&b)
if err := decoder.Decode(&id); err != nil {
if err := gob.Decode(data, &id); err != nil {
return nil, ErrDecodeRaftIdentity
}

Expand Down
14 changes: 7 additions & 7 deletions chain/chainhandle.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import (
"github.com/aergoio/aergo/v2/contract"
"github.com/aergoio/aergo/v2/contract/name"
"github.com/aergoio/aergo/v2/contract/system"
"github.com/aergoio/aergo/v2/internal/enc"
"github.com/aergoio/aergo/v2/internal/enc/base58"
"github.com/aergoio/aergo/v2/message"
"github.com/aergoio/aergo/v2/state"
"github.com/aergoio/aergo/v2/types"
Expand Down Expand Up @@ -55,7 +55,7 @@ type ErrBlock struct {
}

func (ec *ErrBlock) Error() string {
return fmt.Sprintf("Error: %s. block(%s, %d)", ec.err.Error(), enc.ToString(ec.block.Hash), ec.block.No)
return fmt.Sprintf("Error: %s. block(%s, %d)", ec.err.Error(), base58.Encode(ec.block.Hash), ec.block.No)
}

type ErrTx struct {
Expand All @@ -64,7 +64,7 @@ type ErrTx struct {
}

func (ec *ErrTx) Error() string {
return fmt.Sprintf("error executing tx:%s, tx=%s", ec.err.Error(), enc.ToString(ec.tx.GetHash()))
return fmt.Sprintf("error executing tx:%s, tx=%s", ec.err.Error(), base58.Encode(ec.tx.GetHash()))
}

func (cs *ChainService) getBestBlockNo() types.BlockNo {
Expand Down Expand Up @@ -288,7 +288,7 @@ func (cp *chainProcessor) addBlock(blk *types.Block) error {
Uint64("latest", cp.cdb.getBestBlockNo()).
Uint64("blockNo", blk.BlockNo()).
Str("hash", blk.ID()).
Str("prev_hash", enc.ToString(blk.GetHeader().GetPrevBlockHash())).
Str("prev_hash", base58.Encode(blk.GetHeader().GetPrevBlockHash())).
Msg("block added to the block indices")
}
cp.lastBlock = blk
Expand Down Expand Up @@ -637,7 +637,7 @@ func NewTxExecutor(execCtx context.Context, ccc consensus.ChainConsensusCluster,

err := executeTx(execCtx, ccc, cdb, bState, tx, bi, preloadService)
if err != nil {
logger.Error().Err(err).Str("hash", enc.ToString(tx.GetHash())).Msg("tx failed")
logger.Error().Err(err).Str("hash", base58.Encode(tx.GetHash())).Msg("tx failed")
if err2 := bState.Rollback(blockSnap); err2 != nil {
logger.Panic().Err(err).Msg("failed to rollback block state")
}
Expand Down Expand Up @@ -949,7 +949,7 @@ func executeTx(execCtx context.Context, ccc consensus.ChainConsensusCluster, cdb
txFee = new(big.Int).SetUint64(0)
events, err = executeGovernanceTx(ccc, bs, txBody, sender, receiver, bi)
if err != nil {
logger.Warn().Err(err).Str("txhash", enc.ToString(tx.GetHash())).Msg("governance tx Error")
logger.Warn().Err(err).Str("txhash", base58.Encode(tx.GetHash())).Msg("governance tx Error")
}
case types.TxType_FEEDELEGATION:
balance := receiver.Balance()
Expand All @@ -970,7 +970,7 @@ func executeTx(execCtx context.Context, ccc consensus.ChainConsensusCluster, cdb
tx.GetHash(), txBody.GetAccount(), txBody.GetAmount())
if err != nil {
if err != types.ErrNotAllowedFeeDelegation {
logger.Warn().Err(err).Str("txhash", enc.ToString(tx.GetHash())).Msg("checkFeeDelegation Error")
logger.Warn().Err(err).Str("txhash", base58.Encode(tx.GetHash())).Msg("checkFeeDelegation Error")
return err
}
return types.ErrNotAllowedFeeDelegation
Expand Down
Loading