laconicd/x/evm/types/journal_test.go
Federico Kunze cb2ab3d95d
more fixes
2021-04-18 18:39:15 +02:00

353 lines
9.4 KiB
Go

package types
import (
"fmt"
"os"
"testing"
ethermint "github.com/cosmos/ethermint/types"
"github.com/stretchr/testify/suite"
tmlog "github.com/tendermint/tendermint/libs/log"
tmproto "github.com/tendermint/tendermint/proto/tendermint/types"
tmdb "github.com/tendermint/tm-db"
"github.com/cosmos/cosmos-sdk/store"
sdk "github.com/cosmos/cosmos-sdk/types"
authkeeper "github.com/cosmos/cosmos-sdk/x/auth/keeper"
authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
banktypes "github.com/cosmos/cosmos-sdk/x/bank/types"
paramkeeper "github.com/cosmos/cosmos-sdk/x/params/keeper"
paramtypes "github.com/cosmos/cosmos-sdk/x/params/types"
ethcmn "github.com/ethereum/go-ethereum/common"
ethtypes "github.com/ethereum/go-ethereum/core/types"
ethcrypto "github.com/ethereum/go-ethereum/crypto"
"github.com/cosmos/cosmos-sdk/codec"
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
ethcodec "github.com/cosmos/ethermint/codec"
"github.com/cosmos/ethermint/crypto/ethsecp256k1"
)
func newTestCodec() (codec.BinaryMarshaler, *codec.LegacyAmino) {
interfaceRegistry := codectypes.NewInterfaceRegistry()
cdc := codec.NewProtoCodec(interfaceRegistry)
amino := codec.NewLegacyAmino()
sdk.RegisterLegacyAminoCodec(amino)
ethcodec.RegisterInterfaces(interfaceRegistry)
return cdc, amino
}
type JournalTestSuite struct {
suite.Suite
address ethcmn.Address
journal *journal
ctx sdk.Context
stateDB *CommitStateDB
}
func (suite *JournalTestSuite) SetupTest() {
suite.setup()
privkey, err := ethsecp256k1.GenerateKey()
suite.Require().NoError(err)
suite.address = ethcmn.BytesToAddress(privkey.PubKey().Address().Bytes())
suite.journal = newJournal()
balance := ethermint.NewPhotonCoin(sdk.NewInt(100))
acc := &ethermint.EthAccount{
BaseAccount: authtypes.NewBaseAccount(sdk.AccAddress(suite.address.Bytes()), nil, 0, 0),
CodeHash: ethcrypto.Keccak256(nil),
}
suite.stateDB.accountKeeper.SetAccount(suite.ctx, acc)
suite.stateDB.bankKeeper.SetBalance(suite.ctx, sdk.AccAddress(suite.address.Bytes()), balance)
suite.stateDB.SetLogs(ethcmn.BytesToHash([]byte("txhash")), []*ethtypes.Log{
{
Address: suite.address,
Topics: []ethcmn.Hash{ethcmn.BytesToHash([]byte("topic_0"))},
Data: []byte("data_0"),
BlockNumber: 1,
TxHash: ethcmn.BytesToHash([]byte("tx_hash")),
TxIndex: 1,
BlockHash: ethcmn.BytesToHash([]byte("block_hash")),
Index: 1,
Removed: false,
},
{
Address: suite.address,
Topics: []ethcmn.Hash{ethcmn.BytesToHash([]byte("topic_1"))},
Data: []byte("data_1"),
BlockNumber: 10,
TxHash: ethcmn.BytesToHash([]byte("tx_hash")),
TxIndex: 0,
BlockHash: ethcmn.BytesToHash([]byte("block_hash")),
Index: 0,
Removed: false,
},
})
}
// setup performs a manual setup of the GoLevelDB and mounts the required IAVL stores. We use the manual
// setup here instead of the Ethermint app test setup because the journal methods are private and using
// the latter would result in a cycle dependency. We also want to avoid declaring the journal methods public
// to maintain consistency with the Geth implementation.
func (suite *JournalTestSuite) setup() {
authKey := sdk.NewKVStoreKey(authtypes.StoreKey)
paramsKey := sdk.NewKVStoreKey(paramtypes.StoreKey)
paramsTKey := sdk.NewTransientStoreKey(paramtypes.TStoreKey)
bankKey := sdk.NewKVStoreKey(banktypes.StoreKey)
storeKey := sdk.NewKVStoreKey(StoreKey)
db, err := tmdb.NewDB("state", tmdb.GoLevelDBBackend, "temp")
suite.Require().NoError(err)
defer func() {
os.RemoveAll("temp")
}()
cms := store.NewCommitMultiStore(db)
cms.MountStoreWithDB(authKey, sdk.StoreTypeIAVL, db)
cms.MountStoreWithDB(bankKey, sdk.StoreTypeIAVL, db)
cms.MountStoreWithDB(paramsKey, sdk.StoreTypeIAVL, db)
cms.MountStoreWithDB(storeKey, sdk.StoreTypeIAVL, db)
cms.MountStoreWithDB(paramsTKey, sdk.StoreTypeTransient, db)
err = cms.LoadLatestVersion()
suite.Require().NoError(err)
cdc, amino := newTestCodec()
paramsKeeper := paramkeeper.NewKeeper(cdc, amino, paramsKey, paramsTKey)
authSubspace := paramsKeeper.Subspace(authtypes.ModuleName)
bankSubspace := paramsKeeper.Subspace(banktypes.ModuleName)
evmSubspace := paramsKeeper.Subspace(ModuleName).WithKeyTable(ParamKeyTable())
ak := authkeeper.NewAccountKeeper(cdc, authKey, authSubspace, ethermint.ProtoAccount, nil)
bk := bankkeeper.NewBaseKeeper(cdc, bankKey, ak, bankSubspace, nil)
suite.ctx = sdk.NewContext(cms, tmproto.Header{ChainID: "ethermint-8"}, false, tmlog.NewNopLogger())
suite.stateDB = NewCommitStateDB(suite.ctx, storeKey, evmSubspace, ak, bk).WithContext(suite.ctx)
suite.stateDB.SetParams(DefaultParams())
}
func TestJournalTestSuite(t *testing.T) {
suite.Run(t, new(JournalTestSuite))
}
func (suite *JournalTestSuite) TestJournal_append_revert() {
testCases := []struct {
name string
entry journalEntry
}{
{
"createObjectChange",
createObjectChange{
account: &suite.address,
},
},
{
"resetObjectChange",
resetObjectChange{
prev: &stateObject{
address: suite.address,
balance: sdk.OneInt(),
},
},
},
{
"suicideChange",
suicideChange{
account: &suite.address,
prev: false,
prevBalance: sdk.OneInt(),
},
},
{
"balanceChange",
balanceChange{
account: &suite.address,
prev: sdk.OneInt(),
},
},
{
"nonceChange",
nonceChange{
account: &suite.address,
prev: 1,
},
},
{
"storageChange",
storageChange{
account: &suite.address,
key: ethcmn.BytesToHash([]byte("key")),
prevValue: ethcmn.BytesToHash([]byte("value")),
},
},
{
"codeChange",
codeChange{
account: &suite.address,
prevCode: []byte("code"),
prevHash: []byte("hash"),
},
},
{
"touchChange",
touchChange{
account: &suite.address,
},
},
{
"refundChange",
refundChange{
prev: 1,
},
},
{
"addPreimageChange",
addPreimageChange{
hash: ethcmn.BytesToHash([]byte("hash")),
},
},
{
"addLogChange",
addLogChange{
txhash: ethcmn.BytesToHash([]byte("hash")),
},
},
{
"addLogChange - 2 logs",
addLogChange{
txhash: ethcmn.BytesToHash([]byte("txhash")),
},
},
{
"accessListAddAccountChange",
accessListAddAccountChange{
address: &suite.address,
},
},
}
var dirtyCount int
for i, tc := range testCases {
suite.journal.append(tc.entry)
suite.Require().Equal(suite.journal.length(), i+1, tc.name)
if tc.entry.dirtied() != nil {
dirtyCount++
suite.Require().Equal(dirtyCount, suite.journal.getDirty(suite.address), tc.name)
}
}
// revert to the initial journal state
suite.journal.revert(suite.stateDB, 0)
// verify the dirty entry has been deleted
idx, ok := suite.journal.addressToJournalIndex[suite.address]
suite.Require().False(ok)
suite.Require().Zero(idx)
}
func (suite *JournalTestSuite) TestJournal_preimage_revert() {
suite.stateDB.preimages = []preimageEntry{
{
hash: ethcmn.BytesToHash([]byte("hash")),
preimage: []byte("preimage0"),
},
{
hash: ethcmn.BytesToHash([]byte("hash1")),
preimage: []byte("preimage1"),
},
{
hash: ethcmn.BytesToHash([]byte("hash2")),
preimage: []byte("preimage2"),
},
}
for i, preimage := range suite.stateDB.preimages {
suite.stateDB.hashToPreimageIndex[preimage.hash] = i
}
change := addPreimageChange{
hash: ethcmn.BytesToHash([]byte("hash")),
}
// delete first entry
change.revert(suite.stateDB)
suite.Require().Len(suite.stateDB.preimages, 2)
suite.Require().Equal(len(suite.stateDB.preimages), len(suite.stateDB.hashToPreimageIndex))
for i, entry := range suite.stateDB.preimages {
suite.Require().Equal(fmt.Sprintf("preimage%d", i+1), string(entry.preimage), entry.hash.String())
idx, found := suite.stateDB.hashToPreimageIndex[entry.hash]
suite.Require().True(found)
suite.Require().Equal(i, idx)
}
}
func (suite *JournalTestSuite) TestJournal_createObjectChange_revert() {
addr := ethcmn.BytesToAddress([]byte("addr"))
suite.stateDB.stateObjects = []stateEntry{
{
address: addr,
stateObject: &stateObject{
address: addr,
},
},
{
address: ethcmn.BytesToAddress([]byte("addr1")),
stateObject: &stateObject{
address: ethcmn.BytesToAddress([]byte("addr1")),
},
},
{
address: ethcmn.BytesToAddress([]byte("addr2")),
stateObject: &stateObject{
address: ethcmn.BytesToAddress([]byte("addr2")),
},
},
}
for i, so := range suite.stateDB.stateObjects {
suite.stateDB.addressToObjectIndex[so.address] = i
}
change := createObjectChange{
account: &addr,
}
// delete first entry
change.revert(suite.stateDB)
suite.Require().Len(suite.stateDB.stateObjects, 2)
suite.Require().Equal(len(suite.stateDB.stateObjects), len(suite.stateDB.addressToObjectIndex))
for i, entry := range suite.stateDB.stateObjects {
suite.Require().Equal(ethcmn.BytesToAddress([]byte(fmt.Sprintf("addr%d", i+1))).String(), entry.address.String())
idx, found := suite.stateDB.addressToObjectIndex[entry.address]
suite.Require().True(found)
suite.Require().Equal(i, idx)
}
}
func (suite *JournalTestSuite) TestJournal_dirty() {
// dirty entry hasn't been set
idx, ok := suite.journal.addressToJournalIndex[suite.address]
suite.Require().False(ok)
suite.Require().Zero(idx)
// update dirty count
suite.journal.dirty(suite.address)
suite.Require().Equal(1, suite.journal.getDirty(suite.address))
}