-
Notifications
You must be signed in to change notification settings - Fork 807
/
precompiles.go
276 lines (235 loc) · 8.6 KB
/
precompiles.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
package common
import (
"bytes"
"embed"
"errors"
"fmt"
"math/big"
storetypes "github.com/cosmos/cosmos-sdk/store/types"
sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/ethereum/go-ethereum/accounts/abi"
"github.com/ethereum/go-ethereum/common"
"github.com/ethereum/go-ethereum/core/tracing"
"github.com/ethereum/go-ethereum/core/vm"
"github.com/sei-protocol/sei-chain/utils/metrics"
"github.com/sei-protocol/sei-chain/x/evm/state"
"github.com/sei-protocol/sei-chain/x/evm/types"
)
const UnknownMethodCallGas uint64 = 3000
type Contexter interface {
Ctx() sdk.Context
}
type PrecompileExecutor interface {
RequiredGas([]byte, *abi.Method) uint64
Execute(ctx sdk.Context, method *abi.Method, caller common.Address, callingContract common.Address, args []interface{}, value *big.Int, readOnly bool, evm *vm.EVM) ([]byte, error)
}
type Precompile struct {
abi.ABI
address common.Address
name string
executor PrecompileExecutor
}
var _ vm.PrecompiledContract = &Precompile{}
func NewPrecompile(a abi.ABI, executor PrecompileExecutor, address common.Address, name string) *Precompile {
return &Precompile{ABI: a, executor: executor, address: address, name: name}
}
func (p Precompile) RequiredGas(input []byte) uint64 {
methodID, err := ExtractMethodID(input)
if err != nil {
return UnknownMethodCallGas
}
method, err := p.ABI.MethodById(methodID)
if err != nil {
// This should never happen since this method is going to fail during Run
return UnknownMethodCallGas
}
return p.executor.RequiredGas(input[4:], method)
}
func (p Precompile) Run(evm *vm.EVM, caller common.Address, callingContract common.Address, input []byte, value *big.Int, readOnly bool, isFromDelegateCall bool) (bz []byte, err error) {
operation := fmt.Sprintf("%s_unknown", p.name)
defer func() {
HandlePrecompileError(err, evm, operation)
if err != nil {
bz = []byte(err.Error())
err = vm.ErrExecutionReverted
}
}()
ctx, method, args, err := p.Prepare(evm, input)
if err != nil {
return nil, err
}
operation = method.Name
em := ctx.EventManager()
ctx = ctx.WithEventManager(sdk.NewEventManager())
ctx = ctx.WithEVMPrecompileCalledFromDelegateCall(isFromDelegateCall)
bz, err = p.executor.Execute(ctx, method, caller, callingContract, args, value, readOnly, evm)
if err != nil {
return bz, err
}
events := ctx.EventManager().Events()
if len(events) > 0 {
em.EmitEvents(ctx.EventManager().Events())
}
return bz, err
}
func HandlePrecompileError(err error, evm *vm.EVM, operation string) {
if err != nil {
evm.StateDB.(*state.DBImpl).SetPrecompileError(err)
metrics.IncrementErrorMetrics(operation, err)
}
}
func (p Precompile) Prepare(evm *vm.EVM, input []byte) (sdk.Context, *abi.Method, []interface{}, error) {
ctxer, ok := evm.StateDB.(Contexter)
if !ok {
return sdk.Context{}, nil, nil, errors.New("cannot get context from EVM")
}
methodID, err := ExtractMethodID(input)
if err != nil {
return sdk.Context{}, nil, nil, err
}
method, err := p.ABI.MethodById(methodID)
if err != nil {
return sdk.Context{}, nil, nil, err
}
argsBz := input[4:]
args, err := method.Inputs.Unpack(argsBz)
if err != nil {
return sdk.Context{}, nil, nil, err
}
return ctxer.Ctx(), method, args, nil
}
func (p Precompile) GetABI() abi.ABI {
return p.ABI
}
func (p Precompile) Address() common.Address {
return p.address
}
func (p Precompile) GetName() string {
return p.name
}
func (p Precompile) GetExecutor() PrecompileExecutor {
return p.executor
}
type DynamicGasPrecompileExecutor interface {
Execute(ctx sdk.Context, method *abi.Method, caller common.Address, callingContract common.Address, args []interface{}, value *big.Int, readOnly bool, evm *vm.EVM, suppliedGas uint64) (ret []byte, remainingGas uint64, err error)
EVMKeeper() EVMKeeper
}
type DynamicGasPrecompile struct {
*Precompile
executor DynamicGasPrecompileExecutor
}
var _ vm.DynamicGasPrecompiledContract = &DynamicGasPrecompile{}
func NewDynamicGasPrecompile(a abi.ABI, executor DynamicGasPrecompileExecutor, address common.Address, name string) *DynamicGasPrecompile {
return &DynamicGasPrecompile{Precompile: NewPrecompile(a, nil, address, name), executor: executor}
}
func (d DynamicGasPrecompile) RunAndCalculateGas(evm *vm.EVM, caller common.Address, callingContract common.Address, input []byte, suppliedGas uint64, value *big.Int, hooks *tracing.Hooks, readOnly bool, isFromDelegateCall bool) (ret []byte, remainingGas uint64, err error) {
operation := fmt.Sprintf("%s_unknown", d.name)
defer func() {
HandlePrecompileError(err, evm, operation)
if err != nil {
ret = []byte(err.Error())
err = vm.ErrExecutionReverted
}
}()
ctx, method, args, err := d.Prepare(evm, input)
if err != nil {
return nil, 0, err
}
ctx = ctx.WithGasMeter(sdk.NewGasMeterWithMultiplier(ctx, d.executor.EVMKeeper().GetCosmosGasLimitFromEVMGas(ctx, suppliedGas)))
operation = method.Name
em := ctx.EventManager()
ctx = ctx.WithEventManager(sdk.NewEventManager())
ctx = ctx.WithEVMPrecompileCalledFromDelegateCall(isFromDelegateCall)
ret, remainingGas, err = d.executor.Execute(ctx, method, caller, callingContract, args, value, readOnly, evm, suppliedGas)
if err != nil {
return ret, remainingGas, err
}
events := ctx.EventManager().Events()
if len(events) > 0 {
em.EmitEvents(ctx.EventManager().Events())
}
return ret, remainingGas, err
}
func (d DynamicGasPrecompile) GetExecutor() DynamicGasPrecompileExecutor {
return d.executor
}
func ValidateArgsLength(args []interface{}, length int) error {
if len(args) != length {
return fmt.Errorf("expected %d arguments but got %d", length, len(args))
}
return nil
}
func ValidateNonPayable(value *big.Int) error {
if value != nil && value.Sign() != 0 {
return errors.New("sending funds to a non-payable function")
}
return nil
}
func HandlePaymentUsei(ctx sdk.Context, precompileAddr sdk.AccAddress, payer sdk.AccAddress, value *big.Int, bankKeeper BankKeeper) (sdk.Coin, error) {
usei, wei := state.SplitUseiWeiAmount(value)
if !wei.IsZero() {
return sdk.Coin{}, fmt.Errorf("selected precompile function does not allow payment with non-zero wei remainder: received %s", value)
}
coin := sdk.NewCoin(sdk.MustGetBaseDenom(), usei)
// refund payer because the following precompile logic will debit the payments from payer's account
// this creates a new event manager to avoid surfacing these as cosmos events
if err := bankKeeper.SendCoins(ctx.WithEventManager(sdk.NewEventManager()), precompileAddr, payer, sdk.NewCoins(coin)); err != nil {
return sdk.Coin{}, err
}
return coin, nil
}
func HandlePaymentUseiWei(ctx sdk.Context, precompileAddr sdk.AccAddress, payer sdk.AccAddress, value *big.Int, bankKeeper BankKeeper) (sdk.Int, sdk.Int, error) {
usei, wei := state.SplitUseiWeiAmount(value)
// refund payer because the following precompile logic will debit the payments from payer's account
// this creates a new event manager to avoid surfacing these as cosmos events
if err := bankKeeper.SendCoinsAndWei(ctx.WithEventManager(sdk.NewEventManager()), precompileAddr, payer, usei, wei); err != nil {
return sdk.Int{}, sdk.Int{}, err
}
return usei, wei, nil
}
/*
*
sei gas = evm gas * multiplier
sei gas price = fee / sei gas = fee / (evm gas * multiplier) = evm gas / multiplier
*/
func GetRemainingGas(ctx sdk.Context, evmKeeper EVMKeeper) uint64 {
return evmKeeper.GetEVMGasLimitFromCtx(ctx)
}
func ExtractMethodID(input []byte) ([]byte, error) {
// Check if the input has at least the length needed for methodID
if len(input) < 4 {
return nil, errors.New("input too short to extract method ID")
}
return input[:4], nil
}
func DefaultGasCost(input []byte, isTransaction bool) uint64 {
if isTransaction {
return storetypes.KVGasConfig().WriteCostFlat + (storetypes.KVGasConfig().WriteCostPerByte * uint64(len(input)))
}
return storetypes.KVGasConfig().ReadCostFlat + (storetypes.KVGasConfig().ReadCostPerByte * uint64(len(input)))
}
func MustGetABI(f embed.FS, filename string) abi.ABI {
abiBz, err := f.ReadFile(filename)
if err != nil {
panic(err)
}
newAbi, err := abi.JSON(bytes.NewReader(abiBz))
if err != nil {
panic(err)
}
return newAbi
}
func GetSeiAddressByEvmAddress(ctx sdk.Context, evmAddress common.Address, evmKeeper EVMKeeper) (sdk.AccAddress, error) {
seiAddr, associated := evmKeeper.GetSeiAddress(ctx, evmAddress)
if !associated {
return nil, types.NewAssociationMissingErr(evmAddress.Hex())
}
return seiAddr, nil
}
func GetSeiAddressFromArg(ctx sdk.Context, arg interface{}, evmKeeper EVMKeeper) (sdk.AccAddress, error) {
addr := arg.(common.Address)
if addr == (common.Address{}) {
return nil, errors.New("invalid addr")
}
return GetSeiAddressByEvmAddress(ctx, addr, evmKeeper)
}