SealEVM是一个独立的EVM执行器，目标是实现一个完全与存储系统解耦的EVM执行环境，来为任意的区块链系统增加EVM支持。 当前版本已经实现了通过接口和缓存的方式实现了与存储系统的解耦，支持为任意使用golang实现的区块链系统增加EVM支持。
English | 中文
func main() {
//载入SealEVM模块，SealEVM没有使用golang的init特性，必须显式的在使用之前，全局执行一次
SealEVM.Load()
//根据需要，配置SealEVM实例参数，交易输入等参数都在该结构体中提供，参数结构体说明见后续章节
evmParam := SealEVM.EVMParam{}
//提供该参数来初始化一个SealEVM实例
evm := SealEVM.New(evmParam)
//evm执行，返回值中的result是一个ExecuteResult结构体
//该结构体存储了数据的原始状态、最终状态、合约Log、内部创建合约等信息，该结构体说明见后续章节
result, err := evm.Execute()
}example目录下，提供了一个简单的SealEVM的使用参考示例。该示例使用了内存作为外部存储，展示了简单的合约部署、调用、变量读取等功能。
//执行结果回调函数定义，接口中的result和err，与evm执行返回值是相同的
type EVMResultCallback func(result ExecuteResult, err error)
type EVMParam struct {
MaxStackDepth int //最大执行栈深度，注意，不是存储栈深度
ExternalStore storage.IExternalStorage //外部存储接口，说明见后续章节
ResultCallback EVMResultCallback //EVM执行完成后的回调函数，定义见本代码段开头
Context *environment.Context //EVM执行时的环境上下文结构体，说明见后续章节
GasSetting *gasSetting.Setting //Gas费用设置，nil时使用默认设置，说明见后续章节
NoteConfig *executionNote.NoteConfig //执行记录配置，nil时不会产生执行记录，说明见后续章节
}SealEVM将通过该接口，与外部存储进行交互，来实现必要的合约读取、状态读取、地址创建等功能。
type IExternalStorage interface {
//获取账户信息
GetAccount(address types.Address) (*environment.Account, error)
//获取指定高度的区块哈希
GetBlockHash(block *evmInt256.Int) (*evmInt256.Int, error)
//检查地址下的账户是否存在
AccountExist(address types.Address) bool
//检查地址下的账户是否为空，空的定义请参与EIP-161
AccountEmpty(address types.Address) bool
//返回给定合约代码的哈希值
HashOfCode(code []byte) types.Hash
//根据参数，返回创建的合约地址，操作码 CREATE（0xF0）创建合约时使用
CreateAddress(caller types.Address, tx environment.Transaction) types.Address
//根据参数，返回创建的合约地址，操作码 CREATE2（0xF5）创建合约时使用
CreateFixedAddress(caller types.Address, salt types.Hash, code []byte, tx environment.Transaction) types.Address
//在执行opcode SLOAD(0x54) 时，从外部存储获取指定位置的256位数据
Load(address types.Address, slot types.Slot) (*evmInt256.Int, error)
}该结构体在environment包内，是SealEVM执行时的执行上下文，包括区块、交易、消息、合约等参数。
//执行环境汇总结构体，Transaction的To字段为nil时，视为创建合约交易
//执行创建合约交易时，会使用本结构体中的Message.Data字段作为合约代码，生成合约结构体实例赋值给Contract字段
type Context struct {
Block Block //区块环境结构体，详细信息见本代码段下文
Transaction Transaction //交易结构体，详细信息见本代码段下文
Message Message //消息结构体，详细信息见本代码段下文
}
//区块环境结构体
type Block struct {
ChainID *evmInt256.Int //区块ID
Coinbase types.Address //出块人地址
Timestamp uint64 //区块的秒级时间戳
Number uint64 //区块高度，使用的是64位无符号整数
Difficulty *evmInt256.Int //难度
GasLimit *evmInt256.Int //区块gas限制
Hash types.Hash //区块哈希
BaseFee *evmInt256.Int //EIP-1559中定义的base-fee
BlobBaseFee *evmInt256.Int //EIP-7516中定义的blob base-fee
}
//交易环境结构体
type Transaction struct {
TxHash types.Hash //交易哈希
Origin types.Address //发起本次交易的地址，操作码ORIGIN(0x32)获取到的值
To *types.Address //交易调用的合约地址，SealEVM会从外部存储载入该地址的合约代码，该字段为空时代表是一个创建合约的交易
GasPrice *evmInt256.Int //交易的gas价格
GasLimit *evmInt256.Int //交易的gas限制
BlobHashes []types.Hash //EIP-4844中的tx.blob_versioned_hashes
}
//消息结构体
type Message struct {
Caller types.Address //合约调用者地址，操作码CALLER(0x33)获取到的值
Value *evmInt256.Int //合约调用时，发送的ETH数量
Data []byte //合约调用时，传递给合约的参数
}
//账户结构体，SealEVM通过账户来统一管理合约、余额、状态存储等数据
type Account struct {
Address types.Address //账户地址
Balance *evmInt256.Int //账户的余额
Contract *Contract //账户对应的合约信息，详细信息见本代码段下文，EOA账户中，该字段为nil
Slots map[types.Slot]*evmInt256.Int //账户下的KV存储槽
}
//合约结构体，用来存储账户下的合约信息
type Contract struct {
Code []byte //合约代码
CodeHash types.Hash //合约的哈希
CodeSize uint64 //合约代码字节大小
}SealEVM在执行交易完毕后，所有的最终账户数据、执行中产出的Log数据、自毁合约数据等，放入执行结果结构体的StorageCache中返回给调用者。
type ExecuteResult struct {
ContractAddress *types.Address //如果是创建合约的交易，且交易成功执行，该字段会存储创建后的合约地址
ResultData []byte //合约执行返回的数据
GasLeft uint64 //剩余gas
StorageCache storage.ResultCache //缓存结构体，说明见后续章节
ExitOpCode opcodes.OpCode //执行完毕时，最后一个执行的opcode
Note *executionNote.Note //执行记录结构体，说明见后续章节
}SealEVM设计了一个缓存包，将执行过程中以及执行完毕后，从外部获取的原始数据和需要最终存储结果数据，放入一个统一缓存结构体实例。 合约执行完毕后，调用者可以在返回信息结构体的StorageCache字段得到这些缓存数据用于后续处理。 这种设计让使用者只需要提供初始数据就能完成交易执行，不需要实现复杂的运行时状态管理。
//缓存汇总结构体
type ResultCache struct {
OriginalAccounts AccountCache //执行过程中，从外部存储载入的账户状态缓存
CachedAccounts AccountCache //执行完毕后，所有账户最终状态的缓存，包括下面NewContractAccount中的新合约账户
NewContractAccounts AccountCache //执行过程中，内部交易创建的合约的缓存，即由CREATE/CREATE2成功创建的合约的缓存
Logs *LogCache //操作码LOG0(0xA0)~LOG4(0xA4)产生的日志缓存
Destructs DestructCache //执行了SELFDESTRUCT(0xFF)的合约的缓存
}
//账户缓存类型，存放以地址索引的账户结构体，账户结构体请参阅执行环境结相关构体
type AccountCache map[types.Address]*environment.Account
//日志缓存类型，会顺序的存放合约执行过程中，依次产生的Log数据
type LogCache []*types.Log
//销毁合约地址缓存类型，存放执行了SELFDESTRUCT(0xFF)的合约地址
type DestructCache map[types.Address]types.AddressSealEVM通过gasSetting包来实现灵活的Gas设置，并且提供了一个尽可能与以太坊Gas系统一致的默认配置。
//交易固有Gas费用计算函数类型定义，data为交易的输入数据，也就是参数，to为合约结构体指针，to为nil时表示本次交易为创建合约交易
//返回值为针对交易的固有Gas消耗量(gasCost)
type intrinsicGasSetting.IntrinsicGas func(data []byte, to *environment.Contract) (gasCost uint64)
//通用的动态Gas消耗计算函数类型定义
//需要返回要扩展的内存大小(memExpSize)、gas消耗量(gasCost)
type dynamicGasSetting.CommonCalculator func(
acc *environment.Account, //操作码执行开始时的环境账户信息，也就是当前执行合约所属的账户
stx *stack.Stack, //操作码执行开始时的堆栈环境
mem *memory.Memory, //操作码执行开始时的内存环境
store *storage.Storage, //操作码开始执行时的存储环境
) (memExpSize uint64, gasCost uint64, err error)
//为CALL、CALLCODE、STATICCALL、DELEGATECALL设计的Gas消耗计算函数类型定义
//需要返回要扩展的内存大小(memExpSize)、gas消耗量(gasCost)、内部调用发送的gas量(sendGas)
type CallGas func(
code opcodes.OpCode, //当前的操作码
availableGas uint64, //当前可使用的Gas数量
stx *stack.Stack, //操作码执行开始时的堆栈环境
mem *memory.Memory, //操作码执行开始时的内存环境
store *storage.Storage, //操作码开始执行时的存储环境
) (expSize uint64, gasCost uint64, sendGas uint64, err error)
//为存储新合约设计的Gas消耗计算函数类型定义
//需要返回gas消耗量(gasCost)
type ContractStoreGas func(code []byte, gasRemaining uint64) (gasCost uint64, err error)
type Setting struct {
//每个交易的固定Gas费用计算函数，会在执行开始前调用一次，以扣除固定的交易费用
IntrinsicCost intrinsicGasSetting.IntrinsicGas
//动态Gas消耗计算函数配置，CALL、CALLCODE、STATICCALL、DELEGATECALL、SSTORE操作码将忽略该配置
CommonDynamicCost [opcodes.MaxOpCodesCount]dynamicGasSetting.CommonCalculator
//内部调用CALL、CALLCODE、STATICCALL、DELEGATECALL时的gas计算配置
CallCost [opcodes.MaxOpCodesCount]dynamicGasSetting.CallGas
//Create、Create2以及创建合约的交易，在存储合约代码时的Gas计算配置
ContractStoreCost dynamicGasSetting.ContractStoreGas
//操作码固定消耗配置，如果CommonDynamicCost、CallCost、SStoreCost都未被使用，则使用该操作码的固定消耗配置
ConstCost [opcodes.MaxOpCodesCount]uint64
}gasSetting包，为支持使用者自定义默认Gas配置，或者基于该默认Gas设置进行修改，以满足不同的需求场景。
//设置自定义的默认Gas配置
func Set(s *Setting)
//获取当前默认Gas配置
func Get() *SettingSealEVM通过executionNote包，来记录内部调用链路，为开发区块链浏览器、交易分析等功能的用户提供更加细节的交易执行数据。 执行记录模块会根据配置，顺序级联记录交易输入、返回结果以及账户中间状态，并将完整记录放置在执行结果结构体的Note字段，同时提供了一个Walk方法来方便用户对执行记录进行顺序遍历。
//执行记录配置结构体
type NoteConfig struct {
RecordCache bool //该字段为true时，开启中间状态缓存记录
}
//执行类型定义
type ExecutionType byte //使用byte作为调用类型的底层存储类型
const (
ExternalCall ExecutionType = 0 //0代表外部调用，也是调用链的最顶层调用
//执行记录的其余调用类型的值，均与产生调用的操作码相同
Call = ExecutionType(opcodes.CALL)
StaticCall = ExecutionType(opcodes.STATICCALL)
DelegateCall = ExecutionType(opcodes.DELEGATECALL)
CallCode = ExecutionType(opcodes.CALLCODE)
Create = ExecutionType(opcodes.CREATE)
Create2 = ExecutionType(opcodes.CREATE2)
)
//记录结构体
type Note struct {
Type ExecutionType //底层为byte的调用类型
From types.Address
To *types.Address
Gas uint64
Val *evmInt256.Int
Input []byte
ExecutionError error //SealEVM执行返回的错误信息
ReturnData []byte //SealEVM执行返回的数据
//如果在配置结构体中，将RecordCache字段设置为true，本字段会缓存本次交易完成时的中间状态，如果设置为false，则该字段为nil
StorageCache *cache.ResultCache
//子调用记录，当合约执行
//CALL，CALLCODE，DELEGATECALL，STATICCALL，CERATE，CREATE2
//操作码时，会产生子调用，也就是内部交易，SubNotes字段会顺序的级联存储调用链
SubNotes []*Note
}
//顺序遍历执行记录链
//Walk方法会按照交易执行的顺序，调用meetNote来遍历所有执行记录，MeetNote定义见下文
func (n *Note) Walk(meetNote MeetNote)
//遍历回调函数，需要在遍历时提供
//note是遍历到的执行记录结构体
//depth是从0开始的当前执行深度
type MeetNote func(note *Note, depth uint64)SealEVM在保留地址空间内，提供了自定义预编译合约注册接口，来为不同系统需求提供更好的扩展性。
保留地址空间:
0x0000000000000000000000000000000100000000 ~ 0x00000000000000000000000000000001FFFFFFFF。
SealEVM已经实现了与以太坊一致的预编译合约，来提供良好的应用兼容性。
//预编译合约接口定义，所有注册的预编译合约必须实现该接口
type PrecompiledContract interface {
GasCost(input []byte) uint64 //返回预编译合约的Gas消耗
Execute(input []byte) ([]byte, error) //预编译合约执行函数
}
//预编译合约注册函数
//addr为预编译合约注册的地址，范围必须在SealEVM保留地址空间内，否则会注册失败
func RegisterContracts(addr types.Address, c PrecompiledContract) errorSealEVM是一个独立的，灵活可配置，结构良好的EVM执行环境，因此如果您有以下需求，那么基于SealEVM进行开发，会是一个不错的选择：
- 模块化区块链系统中EVM环境
- Layer2、Layer3中的EVM环境
- 定制化GAS费用、预编译合约的EVM环境