Update StateDB godoc

This commit is contained in:
Aleksandr Bezobchuk 2018-10-04 16:11:50 -04:00
parent 1d6e70d01f
commit 4ca2b80812

View File

@ -72,6 +72,12 @@ type CommitStateDB struct {
// NewCommitStateDB returns a reference to a newly initialized CommitStateDB // NewCommitStateDB returns a reference to a newly initialized CommitStateDB
// which implements Geth's state.StateDB interface. // which implements Geth's state.StateDB interface.
//
// CONTRACT: Stores used for state must be cache-wrapped as the ordering of the
// key/value space matters in determining the merkle root.
//
// TODO: Eventually we'll have an EVM module that'll implement a keeper that we
// can pass into this constructor.
func NewCommitStateDB(ctx sdk.Context, am auth.AccountMapper, storageKey, codeKey sdk.StoreKey) (*CommitStateDB, error) { func NewCommitStateDB(ctx sdk.Context, am auth.AccountMapper, storageKey, codeKey sdk.StoreKey) (*CommitStateDB, error) {
return &CommitStateDB{ return &CommitStateDB{
ctx: ctx, ctx: ctx,