package state import ( "github.com/cosmos/cosmos-sdk/store" sdk "github.com/cosmos/cosmos-sdk/types" "github.com/cosmos/ethermint/types" ethcmn "github.com/ethereum/go-ethereum/common" ethstate "github.com/ethereum/go-ethereum/core/state" ethtrie "github.com/ethereum/go-ethereum/trie" lru "github.com/hashicorp/golang-lru" dbm "github.com/tendermint/tendermint/libs/db" ) // TODO: This functionality and implementation may be deprecated var ( // CodeKey is the key used for storing Ethereum contract code in the Cosmos // SDK multi-store. CodeKey = sdk.NewKVStoreKey("code") ) const ( // DefaultStoreCacheSize defines the default number of key/value pairs for // the state stored in memory. DefaultStoreCacheSize = 1024 * 1024 // codeSizeCacheSize is the number of codehash to size associations to // keep in cached memory. This is to address any DoS attempts on // EXTCODESIZE calls. codeSizeCacheSize = 100000 ) // Database implements the Ethereum state.Database interface. type Database struct { // stateStore will be used for the history of accounts (balance, nonce, // storage root hash, code hash) and for the history of contract data // (effects of SSTORE instruction). stateStore store.CommitMultiStore accountsCache store.CacheKVStore storageCache store.CacheKVStore // codeDB contains mappings of codeHash => code // // NOTE: This database will store the information in memory until is it // committed, using the function Commit. This function is called outside of // the ApplyTransaction function, therefore in Ethermint we need to make // sure this commit is invoked somewhere after each block or whatever the // appropriate time for it. codeDB dbm.DB ethTrieDB *ethtrie.Database // codeSizeCache contains an LRU cache of a specified capacity to cache // EXTCODESIZE calls. codeSizeCache *lru.Cache storeCache *lru.Cache Tracing bool } // NewDatabase returns a reference to an initialized Database type which // implements Ethereum's state.Database interface. An error is returned if the // latest state failed to load. The underlying storage structure is defined by // the Cosmos SDK IAVL tree. func NewDatabase(stateStore store.CommitMultiStore, codeDB dbm.DB, storeCacheSize int) (*Database, error) { db := &Database{stateStore: stateStore} // Set the persistent Cosmos SDK Database and initialize an Ethereum // trie.Database using an EthereumDB as the underlying implementation of // the ethdb.Database interface. It will be used to facilitate persistence // of contract byte code when committing state. db.codeDB = codeDB db.ethTrieDB = ethtrie.NewDatabase(&EthereumDB{CodeDB: codeDB}) var err error if db.codeSizeCache, err = lru.New(codeSizeCacheSize); err != nil { return nil, err } if db.storeCache, err = lru.New(storeCacheSize); err != nil { return nil, err } return db, nil } // LatestVersion returns the latest version of the underlying mult-store. func (db *Database) LatestVersion() int64 { return db.stateStore.LastCommitID().Version } // OpenTrie implements Ethereum's state.Database interface. It returns a Trie // type which implements the Ethereum state.Trie interface. It us used for // storage of accounts. An error is returned if state cannot load for a // given version. The account cache is reset if the state is successfully // loaded and the version is not the latest. // // CONTRACT: The root parameter is not interpreted as a state root hash, but as // an encoding of an Cosmos SDK IAVL tree version. func (db *Database) OpenTrie(root ethcmn.Hash) (ethstate.Trie, error) { if !isRootEmpty(root) { version := versionFromRootHash(root) if db.stateStore.LastCommitID().Version != version { if err := db.stateStore.LoadVersion(version); err != nil { return nil, err } db.accountsCache = nil } } if db.accountsCache == nil { db.accountsCache = store.NewCacheKVStore(db.stateStore.GetCommitKVStore(types.StoreKeyAccount)) db.storageCache = store.NewCacheKVStore(db.stateStore.GetCommitKVStore(types.StoreKeyStorage)) } return &Trie{ store: db.accountsCache, accountsCache: db.accountsCache, storageCache: db.storageCache, storeCache: db.storeCache, ethTrieDB: db.ethTrieDB, empty: isRootEmpty(root), root: rootHashFromVersion(db.stateStore.LastCommitID().Version), }, nil } // OpenStorageTrie implements Ethereum's state.Database interface. It returns // a Trie type which implements the Ethereum state.Trie interface. It is used // for storage of contract storage (state). Also, this trie is never committed // separately as all the data is in a single multi-store and is committed when // the account IAVL tree is committed. // // NOTE: It is assumed that the account state has already been loaded via // OpenTrie. // // CONTRACT: The root parameter is not interpreted as a state root hash, but as // an encoding of an IAVL tree version. func (db *Database) OpenStorageTrie(addrHash, root ethcmn.Hash) (ethstate.Trie, error) { // a contract storage trie does not need an accountCache, storageCache or // an Ethereum trie because it will not be used upon commitment. return &Trie{ store: db.storageCache, storeCache: db.storeCache, prefix: addrHash.Bytes(), empty: isRootEmpty(root), root: rootHashFromVersion(db.stateStore.LastCommitID().Version), }, nil } // CopyTrie implements Ethereum's state.Database interface. For now, it // performs a no-op as the underlying Cosmos SDK IAVL tree does not support // such an operation. // // TODO: Does the IAVL tree need to support this operation? If so, why and // how? func (db *Database) CopyTrie(ethstate.Trie) ethstate.Trie { return nil } // ContractCode implements Ethereum's state.Database interface. It will return // the contract byte code for a given code hash. It will not return an error. func (db *Database) ContractCode(addrHash, codeHash ethcmn.Hash) ([]byte, error) { code := db.codeDB.Get(codeHash[:]) if codeLen := len(code); codeLen != 0 { db.codeSizeCache.Add(codeHash, codeLen) } return code, nil } // ContractCodeSize implements Ethereum's state.Database interface. It will // return the contract byte code size for a given code hash. It will not return // an error. func (db *Database) ContractCodeSize(addrHash, codeHash ethcmn.Hash) (int, error) { if cached, ok := db.codeSizeCache.Get(codeHash); ok { return cached.(int), nil } code, err := db.ContractCode(addrHash, codeHash) return len(code), err } // Commit commits the underlying Cosmos SDK multi-store returning the commit // ID. func (db *Database) Commit() sdk.CommitID { return db.stateStore.Commit() } // TrieDB implements Ethereum's state.Database interface. It returns Ethereum's // trie.Database low level trie database used for contract state storage. In // the context of Ethermint, it'll be used to solely store mappings of // codeHash => code. func (db *Database) TrieDB() *ethtrie.Database { return db.ethTrieDB } // isRootEmpty returns true if a given root hash is empty or false otherwise. func isRootEmpty(root ethcmn.Hash) bool { return root == ethcmn.Hash{} }