Skip to content

[codex] add dynamic custom precompile gas meter #3644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
codchen wants to merge 1 commit into
base: codex/evmonly-staking-precompile
Choose a base branch
from
+333 −27
Open

[codex] add dynamic custom precompile gas meter #3644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 32 additions & 2 deletions giga/evmonly/executor_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,12 +757,42 @@ func TestExecutorRegisteredCustomPrecompile(t *testing.T) {
require.NoError(t, err)
require.Len(t, result.Txs, 1)
require.Equal(t, ethtypes.ReceiptStatusSuccessful, result.Txs[0].Status)
require.Greater(t, result.Txs[0].GasUsed, uint64(21_000+100))
require.NotEmpty(t, result.ChangeSet.Storage)

state.ApplyChangeSet(result.ChangeSet)
require.Equal(t, encodedStoredLength(2), state.GetState(customAddr, storeBaseSlot([]byte("seen"))))
}

func TestExecutorRegisteredCustomPrecompileMetersDynamicStoreGas(t *testing.T) {
chainID := big.NewInt(713715)
key, err := crypto.GenerateKey()
require.NoError(t, err)
sender := crypto.PubkeyToAddress(key.PublicKey)
customAddr := common.HexToAddress("0x0000000000000000000000000000000000001005")

state := NewMemoryState()
state.SetBalance(sender, big.NewInt(200_000_000_000_000))

rawTx := signLegacyTxWithGas(t, key, chainID, 0, &customAddr, big.NewInt(0), []byte{0x01}, 30_000)
executor := NewExecutor(Config{
CustomPrecompiles: contractPrecompileRegistry{
customAddr: storeWritePrecompile{},
},
}, WithState(state))

result, err := executor.ExecuteBlock(context.Background(), BlockRequest{
Context: blockContext(chainID),
Txs: [][]byte{rawTx},
})

require.NoError(t, err)
require.Len(t, result.Txs, 1)
require.Equal(t, ethtypes.ReceiptStatusFailed, result.Txs[0].Status)
require.True(t, errors.Is(result.Txs[0].Err, vm.ErrOutOfGas))
require.Empty(t, result.ChangeSet.Storage)
}

func TestExecutorStakingPrecompileForwardsPayableValue(t *testing.T) {
chainID := big.NewInt(713715)
key, err := crypto.GenerateKey()
Expand All @@ -789,7 +819,7 @@ func TestExecutorStakingPrecompileForwardsPayableValue(t *testing.T) {
)
require.NoError(t, err)
value := sei(5)
rawTx := signLegacyTx(t, key, chainID, 0, &stakingAddr, value, input)
rawTx := signLegacyTxWithGas(t, key, chainID, 0, &stakingAddr, value, input, 8_000_000)
executor := NewExecutor(Config{
CustomPrecompiles: registry,
}, WithState(state))
Expand Down Expand Up @@ -841,7 +871,7 @@ func TestExecutorStakingDelegationLifecycleE2E(t *testing.T) {
nonces := map[common.Address]uint64{}
signStakingTx := func(key *ecdsa.PrivateKey, value *big.Int, input []byte) []byte {
sender := crypto.PubkeyToAddress(key.PublicKey)
raw := signLegacyTx(t, key, chainID, nonces[sender], &stakingAddr, value, input)
raw := signLegacyTxWithGas(t, key, chainID, nonces[sender], &stakingAddr, value, input, 8_000_000)
nonces[sender]++
return raw
}
Expand Down
84 changes: 67 additions & 17 deletions giga/evmonly/precompile_adapter.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,23 +36,22 @@ func (p registeredCustomPrecompile) RequiredGas(input []byte) uint64 {
}

func (p registeredCustomPrecompile) Run(evm *vm.EVM, caller common.Address, _ common.Address, input []byte, value *big.Int, readOnly bool, isFromDelegateCall bool, _ *tracing.Hooks) ([]byte, error) {
return p.run(evm, caller, input, value, readOnly, isFromDelegateCall, 0)
return p.run(evm, caller, input, value, readOnly, isFromDelegateCall, 0, nil)
}

func (p registeredCustomPrecompile) RunAndCalculateGas(evm *vm.EVM, caller common.Address, _ common.Address, input []byte, suppliedGas uint64, value *big.Int, hooks *tracing.Hooks, readOnly bool, isFromDelegateCall bool) ([]byte, uint64, error) {
gasCost := p.RequiredGas(input)
if suppliedGas < gasCost {
meter := newPrecompileGasMeter(suppliedGas, hooks)
if !meter.charge(p.RequiredGas(input), tracing.GasChangeCallPrecompiledContract) {
return nil, 0, vm.ErrOutOfGas
}
remainingGas := suppliedGas - gasCost
if hooks != nil && hooks.OnGasChange != nil {
hooks.OnGasChange(suppliedGas, remainingGas, tracing.GasChangeCallPrecompiledContract)
ret, err := p.run(evm, caller, input, value, readOnly, isFromDelegateCall, meter.remainingGas(), meter)
if meter.err != nil {
return nil, meter.remainingGas(), meter.err
}
ret, err := p.run(evm, caller, input, value, readOnly, isFromDelegateCall, remainingGas)
return ret, remainingGas, err
return ret, meter.remainingGas(), err
}

func (p registeredCustomPrecompile) run(evm *vm.EVM, caller common.Address, input []byte, value *big.Int, readOnly bool, isFromDelegateCall bool, remainingGas uint64) ([]byte, error) {
func (p registeredCustomPrecompile) run(evm *vm.EVM, caller common.Address, input []byte, value *big.Int, readOnly bool, isFromDelegateCall bool, remainingGas uint64, meter *precompileGasMeter) ([]byte, error) {
stateDB, ok := evm.StateDB.(*nativeStateDB)
if !ok {
return nil, errInvalidPrecompileStateDB
Expand All @@ -65,9 +64,9 @@ func (p registeredCustomPrecompile) run(evm *vm.EVM, caller common.Address, inpu
DelegateCall: isFromDelegateCall,
GasRemaining: remainingGas,
Block: evmPrecompileBlockContext(evm),
Store: storageBackedStore{db: stateDB, address: p.address},
Balances: nativeBalanceTransfer{db: stateDB},
Logs: stateDB,
Store: storageBackedStore{db: stateDB, address: p.address, meter: meter},
Balances: nativeBalanceTransfer{db: stateDB, meter: meter},
Logs: meteredLogSink{sink: stateDB, meter: meter},
}
return p.contract.Run(ctx, input)
}
Expand Down Expand Up @@ -155,13 +154,17 @@ func evmPrecompileBlockContext(evm *vm.EVM) precompiles.BlockContext {
}

type nativeBalanceTransfer struct {
db *nativeStateDB
db *nativeStateDB
meter *precompileGasMeter
}

func (t nativeBalanceTransfer) Transfer(from common.Address, to common.Address, amount *big.Int) error {
if amount == nil || amount.Sign() == 0 {
return nil
}
if t.meter != nil && !t.meter.chargeNativeTransfer(t.db, from, to, amount) {
return t.meter.err
}
if t.db.err != nil {
return t.db.err
}
Expand Down Expand Up @@ -207,9 +210,13 @@ const (
type storageBackedStore struct {
db *nativeStateDB
address common.Address
meter *precompileGasMeter
}

func (s storageBackedStore) Get(key []byte) ([]byte, bool) {
if !s.chargeStoreBaseSlot(key) {
return nil, false
}
baseSlot := storeBaseSlot(key)
length, ok := s.length(baseSlot)
if !ok {
Expand All @@ -221,13 +228,23 @@ func (s storageBackedStore) Get(key []byte) ([]byte, bool) {
chunks := chunkCount(length)
out := make([]byte, 0, int(chunks*32)) //nolint:gosec // length was bounded by max int above.
for i := uint64(0); i < chunks; i++ {
chunk := s.db.GetState(s.address, storeChunkSlot(baseSlot, i))
if !s.chargeStoreChunkSlot(baseSlot, i) {
return nil, false
}
chunkSlot := storeChunkSlot(baseSlot, i)
if !s.chargeSLoad(chunkSlot) {
return nil, false
}
chunk := s.db.GetState(s.address, chunkSlot)
out = append(out, chunk.Bytes()...)
}
return out[:int(length)], true //nolint:gosec // length was bounded by max int above.
}

func (s storageBackedStore) Set(key []byte, value []byte) {
if !s.chargeStoreBaseSlot(key) {
return
}
baseSlot := storeBaseSlot(key)
oldLength, oldOK := s.length(baseSlot)
oldChunks := uint64(0)
Expand All @@ -236,6 +253,9 @@ func (s storageBackedStore) Set(key []byte, value []byte) {
}
newLength := uint64(len(value)) //nolint:gosec // slices cannot exceed max int.
newChunks := chunkCount(newLength)
if !s.chargeSStore(baseSlot, encodedStoredLength(newLength)) {
return
}
s.db.SetState(s.address, baseSlot, encodedStoredLength(newLength))
for i := uint64(0); i < newChunks; i++ {
start := int(i * 32) //nolint:gosec // i is bounded by len(value) chunks.
Expand All @@ -245,26 +265,56 @@ func (s storageBackedStore) Set(key []byte, value []byte) {
}
var chunk common.Hash
copy(chunk[:], value[start:end])
s.db.SetState(s.address, storeChunkSlot(baseSlot, i), chunk)
if !s.chargeStoreChunkSlot(baseSlot, i) {
return
}
chunkSlot := storeChunkSlot(baseSlot, i)
if !s.chargeSStore(chunkSlot, chunk) {
return
}
s.db.SetState(s.address, chunkSlot, chunk)
}
for i := newChunks; i < oldChunks; i++ {
s.db.SetState(s.address, storeChunkSlot(baseSlot, i), common.Hash{})
if !s.chargeStoreChunkSlot(baseSlot, i) {
return
}
chunkSlot := storeChunkSlot(baseSlot, i)
if !s.chargeSStore(chunkSlot, common.Hash{}) {
return
}
s.db.SetState(s.address, chunkSlot, common.Hash{})
}
}

func (s storageBackedStore) Delete(key []byte) {
if !s.chargeStoreBaseSlot(key) {
return
}
baseSlot := storeBaseSlot(key)
length, ok := s.length(baseSlot)
if !ok {
return
}
for i := uint64(0); i < chunkCount(length); i++ {
s.db.SetState(s.address, storeChunkSlot(baseSlot, i), common.Hash{})
if !s.chargeStoreChunkSlot(baseSlot, i) {
return
}
chunkSlot := storeChunkSlot(baseSlot, i)
if !s.chargeSStore(chunkSlot, common.Hash{}) {
return
}
s.db.SetState(s.address, chunkSlot, common.Hash{})
}
if !s.chargeSStore(baseSlot, common.Hash{}) {
return
}
s.db.SetState(s.address, baseSlot, common.Hash{})
}

func (s storageBackedStore) length(baseSlot common.Hash) (uint64, bool) {
if !s.chargeSLoad(baseSlot) {
return 0, false
}
encoded := s.db.GetState(s.address, baseSlot)
if encoded == (common.Hash{}) {
return 0, false
Expand Down
Loading
Loading