以太坊源码分析：statedb

前言

就如以太坊黄皮书讲的，以太坊是状态机，区块的产生，实际是状态迁移的过程。那以太坊

1. 是如何定义状态的？
2. 是如何迁移状态的？
3. 是怎么存储状态的？

这篇文章就介绍什么是状态，以及是怎么存储的。

状态基本知识

状态的定义

一个账户的信息，就是一个状态，而以太坊是所有状态的集合。比如，最开始的状态是：{A有10元，B有0元}，后来A发起了交易，给B2元，状态变成{A有8元，B有2元}，这中间的过程就是状态转移。

以太坊实际最初的状态是创世块，没产生一个新区块就转移到一个新的状态。

状态表示

以太坊使用root表示状态。以太坊使用Trie组织状态，Trie可以理解为是字典树和默克尔树的结合，它有一个树根root，有这个root，你就可以访问所有的状态数据，即每个账户的信息，所以用root来表示一个状态。

获取状态

区块头中有一个字段Root，所以找到区块头，就能获取区块链的状态。

状态存在哪

状态不存在区块中。区块头中存放了root，这只是一个地址，从区块中并不能找到状态的数据。

状态只是临时的数据，可以再生成。创世块是最初的状态，把第一个区块中的交易都执行一遍，就得到了一个新的状态，把这个状态的root存到第一个区块头的Root中。如果有所有的区块，就可以把所有的交易都执行，然后生成最新区块中的状态。

状态存放在外部数据库。以太坊底层的数据库是LevelDB，区块存放在里面，状态也存放在里面。但状态是一个Trie，不能直接存在LevelDB里面。

StateDB

StateDB，从名字就能看出来，是用来存储状态的数据库。它把Trie和DB结合了起来，实现了对状态的存储、更新、回滚。我们先介绍它的设计思路，然后再介绍一些它的骨干实现。

StateDB的设计

以太坊使用LevelDB作为底层的存储数据库，虽然这能够满足存取状态，但没有缓存功，快速访问和修改状态等特性，以太坊实现了StateDB，来满足自身的需求。

我们就介绍下，它是如何设计来实现以上特性的。

底层存储设计

使用Trie实现快速访问。上文提到了，Trie是字典树和默克尔树的结合，可以实现快速查找，这里就看它是如何使用Trie的。

使用内存实现缓存。常用的数据，会被计算机留在内存中，同样，常用的状态也被留在内存中，并且使用StateDB把它们管理起来。

StateDB定义了2个接口：Trie和Database：Trie建立在Database之上，Trie的数据存放在Database中。

• Trie被定义为带有缓存的KV数据库。你可以通过它快速存储、更新、删除数据。
• Database被定义为一个打开Trie、拷贝Trie的数据库。它不直接对外访问，不能直接使用它存取数据。

在代码实现上，cachedTrie实现了Trie，cachingDB实现了Databse，他们定义在core/state/database.go。

// 实现Database接口，缓存常用的trie
type cachingDB struct {
   
   //保存trie数据的db
   db *trie.Database
   mu sync.Mutex
   // 缓存过去的trie，队列类型
   pastTries     []*trie.SecureTrie
   codeSizeCache *lru.Cache
}

// 包含了trie和缓存db，trie实际是存在db中的
type cachedTrie struct {
   
   *trie.SecureTrie
   db *cachingDB
}

//从db中打开一个trie，如果不是最近使用过，则创建一个新的，存到db
func (db *cachingDB) OpenTrie(root common.Hash) (Trie, error) {
   
   db.mu.Lock()
   defer db.mu.Unlock()

   for i := len(db.pastTries) - 1; i >= 0; i-- {
   
      if db.pastTries[i].Hash() == root {
   
         return cachedTrie{
   db.pastTries[i].Copy(), db}, nil
      }
   }
   tr, err := trie.NewSecure(root, db.db, MaxTrieCacheGen)
   if err != nil {
   
      return nil, err
   }
   return cachedTrie{
   tr, db}, nil
}

StateDB的状态组织设计

StateDB使用Trie存放stateObject，是账户地址到账户信息的映射，每个stateObject都是一个账户的信息。

stateObject使用Trie存放数据，这些数据被称为storage，实现对某个账户的状态数据的存储和修改，key是数据的hash值，value是状态数据。

StateDB和stateObject都使用Database存放了自己的Trie，他们使用的是同一个DB。
但从逻辑层次上看，他们满足这种关系：

事务和回滚设计

stateDB这个KV数据库，实现了类似传统数据库的事务和回滚设计。每一个交易都是一个事务，每一个交易的执行，都是一次状态转移，在执行交易之前，先创建当前的快照，执行交易的过程中，会记录状态数据的每一次修改，如果交易执行失败，则进行回滚，交易执行完毕，会把所有修改的状态数据写入到Trie，然后更新Trie的根。
在生成1个区块的时候，会进行很多次Finalise，回滚是不能跨越交易的，也就是说，当前交易失败了，我不能回滚到上上一条交易。生成区块的时候，最后一次Finalize的Trie的Root，会保存到区块头的Header.Root。当区块要写入到区块链的时候，会执行一次Commit。

关于Finalise和Commit的主要调用关系如下图：

Finalise的主要调用场景是：

1. 执行交易/合约，进行一次状态转移。
2. 给矿工计算奖励后，进行一次状态转移。

Commit的主要调用场景是插入区块链，有2种情况：

1. 自己挖到区块。
2. 收到他人的区块。

StateDB的骨干实现

基于上面对StateDB设计的了解，我们再介绍一下StateDB一些主要的实现。这一小节主要覆盖以下内容：

1. state所在的目录和文件划分。
2. stateObject实现。
3. stateDB的实现。

state目录和文件划分

state所在的目录是：core/state，它的文件和每个文件的主要功能如下：

core/state
├── database.go，底层的存储设计，`Trie`和`Database`定义在此文件。
├── dump.go，用来dumpstateDB数据。
├── iterator.go，用来遍历`Trie`。
├── journal.go，用来记录状态的每一步改变。
├── managed_state.go，给txpool使用，具体功能未研究。
├── state_object.go，每一个账户的状态。
├── statedb.go，以太坊整个的状态。
├── sync.go，用来和downloader结合起来同步state。

关于stateDB如何存储状态，主要关注这3个文件：

1. database.go
2. state_object.go
3. statedb.go

接下来通过源码介绍这3个文件的功能和实现。

database.go

database.go的主要代码和设计，已经在底层存储设计的时候介绍过了，这里补充介绍另外一个重要的函数OpenStorageTrie它与OpenTrie的区别：

1. 实现区别，OpenTrie会先从db中查找，如果每找到才创建一个，而OpenStorageTrie是直接创建一个。
2. 功能区别，OpenTrie创建的stateDB的Trie，而OpenStorageTrie创建的是stateObject的Trie。

把1和2合并：cachingDB会缓存stateDB使用的Trie，而不会缓存stateObject使用的Trie。

// OpenStorageTrie opens the storage trie of an account.
// 创建一个账户的存储trie，但实际没有使用到addrHash
func (db *cachingDB) OpenStorageTrie(addrHash, root common.Hash) (Trie, error) {
   
   return trie.NewSecure(root, db.db, 0)
}

// OpenTrie opens the main account trie.
// 从db中打开一个trie，如果不是最近使用过，则创建一个新的，存到db
func (db *cachingDB) OpenTrie(root common.Hash) (Trie, error) {
   
   db.mu.Lock()
   defer db.mu.Unlock()

   for i := len(db.pastTries) - 1; i >= 0; i-- {
   
      if db.pastTries[i].Hash() == root {
   
         return cachedTrie{
   db.pastTries[i].Copy(), db}, nil
      }
   }
   tr, err := trie.NewSecure(root, db.db, MaxTrieCacheGen)
   if err != nil {
   
      return nil, err
   }
   return cachedTrie{
   tr, db}, nil
}

state_object.go

该文件主要实现最小状态的存储和修改。stateObject代表最小粒度的状态，它是一个账户的状态信息。我们先看下基础的数据结构定义，再看它实现的主要功能。

账户和stateObject

以太坊的账户分为普通账户和合约账户，在代码上，他们都是用Account来表示，它记录了账户的数据，有：Nonce，余额，状态树根Root和合约代码的哈希值CodeHash。

// Account is the Ethereum consensus representation of accounts.
// These objects are stored in the main account trie.
// Account是账户的数据，不包含账户地址
// 账户需要使用地址来表示，地址在stateObject中
type Account struct {
   
    // 每执行1次交易，Nonce+1
    Nonce uint64
    Balance *big.Int
    // 该账户的状态，即trie的根
    Root common.Hash // merkle root of the storage trie
    // 合约账户专属，合约代码编译后的Hash值
    CodeHash []byte
}

以上是账户的数据，那如何表示一个账户呢？
使用账户地址表示账户，它记录在stateObject中:

// stateObject represents an Ethereum account which is being modified.
//
// The usage pattern is as follows:
// First you need to obtain a state object.</