Skip to content
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.

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

perf(state-transition): reduce amount of withdrawals processed #2110

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
b4a1077
skip zero amount withdrawals to reduce number of withdrawals processed
abi87 Oct 28, 2024
f4a7d79
wip: adding UTs to state transition package
abi87 Oct 29, 2024
0f46172
wip: completed simple UT for state transition package
abi87 Oct 29, 2024
22c7717
wip: minimal execution engine stub
abi87 Oct 29, 2024
05cba80
extended asserts
abi87 Oct 29, 2024
443ac1b
added test case
abi87 Oct 29, 2024
10efd5e
nits
abi87 Oct 29, 2024
099716d
tests for helpers in state transition using mock
nidhi-singh02 Oct 30, 2024
151a533
Revert "tests for helpers in state transition using mock"
nidhi-singh02 Oct 30, 2024
9818c7e
tests with only mock for execution engine
nidhi-singh02 Oct 30, 2024
160cc88
removed test for VerifyAndNotifyNewPayload
nidhi-singh02 Oct 30, 2024
4a9fe1c
nit
abi87 Oct 31, 2024
e048be4
improved unit tests asserts
abi87 Oct 31, 2024
8bf34db
appease linter
abi87 Oct 31, 2024
d90a95a
fix(state-transition): fix deposit index upon genesis processing (#2116)
abi87 Oct 31, 2024
e17d29c
fixed bad merge
abi87 Oct 31, 2024
8dfe59d
Merge branch 'main' into fix-maximum-number-withdrawals
abi87 Nov 1, 2024
daa9262
Merge branch 'state-transition-add-UTs' into fix-maximum-number-withd…
abi87 Nov 1, 2024
92d494f
added UTs to show no withdrawals are made when unnecessary
abi87 Nov 1, 2024
6286b20
Merge branch 'main' into state-transition-add-UTs
abi87 Nov 1, 2024
a1a3def
Merge branch 'state-transition-add-UTs' into fix-maximum-number-withd…
abi87 Nov 1, 2024
97fba5c
fix withdrawal index update
abi87 Nov 1, 2024
af8c5e0
fix(build): erigon repo
gummybera Nov 1, 2024
023ebfd
fix(build): bump erigon to recent version
gummybera Nov 1, 2024
d66b298
nits from code review
abi87 Nov 1, 2024
420f621
Merge branch 'state-transition-add-UTs' into fix-maximum-number-withd…
abi87 Nov 1, 2024
09eee8e
Merge branch 'fix-erigon' into fix-maximum-number-withdrawals
abi87 Nov 2, 2024
d8a267e
hacked fix for withdrawals SSZ serialization
abi87 Nov 4, 2024
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
5 changes: 5 additions & 0 deletions .mockery.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,8 @@ packages:
recursive: False
with-expecter: true
all: True
github.com/berachain/beacon-kit/mod/state-transition/pkg/core:
config:
recursive: False
with-expecter: true
include-regex: ExecutionEngine
4 changes: 2 additions & 2 deletions build/scripts/testing.mk
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@ start-erigon: ## start an ephemeral `erigon` node
docker run \
--rm -v $(PWD)/${TESTAPP_FILES_DIR}:/${TESTAPP_FILES_DIR} \
-v $(PWD)/.tmp:/.tmp \
thorax/erigon:latest init \
erigontech/erigon:latest init \
--datadir .tmp/erigon \
${ETH_GENESIS_PATH}

Expand All @@ -212,7 +212,7 @@ start-erigon: ## start an ephemeral `erigon` node
-p 8551:8551 \
--rm -v $(PWD)/${TESTAPP_FILES_DIR}:/${TESTAPP_FILES_DIR} \
-v $(PWD)/.tmp:/.tmp \
thorax/erigon:latest \
erigontech/erigon:latest \
--http \
--http.addr 0.0.0.0 \
--http.api eth,net \
Expand Down
2 changes: 1 addition & 1 deletion kurtosis/beaconkit-all.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ node_settings:
max_memory: 2048
images:
besu: hyperledger/besu:24.5.4
erigon: thorax/erigon:v2.60.1
erigon: erigontech/erigon:v2.60.9
ethereumjs: ethpandaops/ethereumjs:stable
geth: ethereum/client-go:latest
nethermind: nethermind/nethermind:latest
Expand Down
2 changes: 1 addition & 1 deletion kurtosis/beaconkit-base-gcp.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ node_settings:
max_memory: 32768
images:
besu: hyperledger/besu:latest
erigon: thorax/erigon:v2.60.1
erigon: erigontech/erigon:v2.60.9
ethereumjs: ethpandaops/ethereumjs:stable
geth: ethereum/client-go:latest
nethermind: nethermind/nethermind:latest
Expand Down
2 changes: 1 addition & 1 deletion kurtosis/src/nodes/nodes.star
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ EXECUTION_DEFAULT_SETTINGS = {
},
"images": {
"besu": "hyperledger/besu:latest",
"erigon": "thorax/erigon:v2.60.1",
"erigon": "erigontech/erigon:v2.60.9",
"ethereumjs": "ethpandaops/ethereumjs:stable",
"geth": "ethereum/client-go:latest",
"nethermind": "nethermind/nethermind:latest",
Expand Down
5 changes: 5 additions & 0 deletions mod/consensus-types/pkg/types/payload.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,6 +128,11 @@ func (p *ExecutionPayload) DefineSSZ(codec *ssz.Codec) {
constants.MaxBytesPerTx,
)
ssz.DefineSliceOfStaticObjectsContent(codec, &p.Withdrawals, 16)

// TODO: hack to avoid failure of EL checks on withdrawals
if p.Withdrawals == nil {
p.Withdrawals = make([]*engineprimitives.Withdrawal, 0)
}
Comment on lines +132 to +135
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

post Shangai an EL explicitly check that Withdrawals are not nil (instead empty slices are fine).
Currently BeaconKit duly builds a block with Withdrawals set to empty slice (if not withdrawals are available) but as soon as the block is returned by CometBFT for verification, the SSZ decoding sets the empty slice to nil.
This code change solves the issue.

}

// MarshalSSZ serializes the ExecutionPayload object into a slice of bytes.
Expand Down
138 changes: 138 additions & 0 deletions mod/state-transition/pkg/core/helpers_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
// SPDX-License-Identifier: BUSL-1.1
//
// Copyright (C) 2024, Berachain Foundation. All rights reserved.
// Use of this software is governed by the Business Source License included
// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
//
// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
// VERSIONS OF THE LICENSED WORK.
//
// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
//
// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
// TITLE.

package core_test

import (
"context"
"fmt"

corestore "cosmossdk.io/core/store"
"cosmossdk.io/log"
"cosmossdk.io/store"
"cosmossdk.io/store/metrics"
storetypes "cosmossdk.io/store/types"
"github.com/berachain/beacon-kit/mod/consensus-types/pkg/types"
engineprimitives "github.com/berachain/beacon-kit/mod/engine-primitives/pkg/engine-primitives"
"github.com/berachain/beacon-kit/mod/node-core/pkg/components"
statedb "github.com/berachain/beacon-kit/mod/state-transition/pkg/core/state"
"github.com/berachain/beacon-kit/mod/storage/pkg/beacondb"
"github.com/berachain/beacon-kit/mod/storage/pkg/db"
"github.com/berachain/beacon-kit/mod/storage/pkg/encoding"
dbm "github.com/cosmos/cosmos-db"
sdk "github.com/cosmos/cosmos-sdk/types"
)

type (
TestBeaconStateMarshallableT = types.BeaconState[
*types.BeaconBlockHeader,
*types.Eth1Data,
*types.ExecutionPayloadHeader,
*types.Fork,
*types.Validator,
types.BeaconBlockHeader,
types.Eth1Data,
types.ExecutionPayloadHeader,
types.Fork,
types.Validator,
]

TestKVStoreT = beacondb.KVStore[
*types.BeaconBlockHeader,
*types.Eth1Data,
*types.ExecutionPayloadHeader,
*types.Fork,
*types.Validator,
types.Validators,
]

TestBeaconStateT = statedb.StateDB[
*types.BeaconBlockHeader,
*TestBeaconStateMarshallableT,
*types.Eth1Data,
*types.ExecutionPayloadHeader,
*types.Fork,
*TestKVStoreT,
*types.Validator,
types.Validators,
*engineprimitives.Withdrawal,
types.WithdrawalCredentials,
]
)

type testKVStoreService struct {
ctx sdk.Context
}

func (kvs *testKVStoreService) OpenKVStore(context.Context) corestore.KVStore {
//nolint:contextcheck // fine with tests
return components.NewKVStore(
sdk.UnwrapSDKContext(kvs.ctx).KVStore(testStoreKey),
)
}

var (
testStoreKey = storetypes.NewKVStoreKey("state-transition-tests")
testCodec = &encoding.SSZInterfaceCodec[*types.ExecutionPayloadHeader]{}
)

func initTestStore() (
*beacondb.KVStore[
*types.BeaconBlockHeader,
*types.Eth1Data,
*types.ExecutionPayloadHeader,
*types.Fork,
*types.Validator,
types.Validators,
], error) {
db, err := db.OpenDB("", dbm.MemDBBackend)
if err != nil {
return nil, fmt.Errorf("failed opening mem db: %w", err)
}
var (
nopLog = log.NewNopLogger()
nopMetrics = metrics.NewNoOpMetrics()
)

cms := store.NewCommitMultiStore(
db,
nopLog,
nopMetrics,
)

ctx := sdk.NewContext(cms, true, nopLog)
cms.MountStoreWithDB(testStoreKey, storetypes.StoreTypeIAVL, nil)
if err = cms.LoadLatestVersion(); err != nil {
return nil, fmt.Errorf("failed to load latest version: %w", err)
}
testStoreService := &testKVStoreService{ctx: ctx}

return beacondb.New[
*types.BeaconBlockHeader,
*types.Eth1Data,
*types.ExecutionPayloadHeader,
*types.Fork,
*types.Validator,
types.Validators,
](
testStoreService,
testCodec,
), nil
}
86 changes: 86 additions & 0 deletions mod/state-transition/pkg/core/mocks/execution_engine.mock.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

36 changes: 19 additions & 17 deletions mod/state-transition/pkg/core/state/statedb.go
Original file line number Diff line number Diff line change
Expand Up @@ -225,10 +225,6 @@ func (s *StateDB[

// Iterate through indices to find the next validators to withdraw.
for range bound {
var (
withdrawal WithdrawalT
amount math.Gwei
)
validator, err = s.ValidatorByIndex(validatorIndex)
if err != nil {
return nil, err
Expand All @@ -247,24 +243,30 @@ func (s *StateDB[

// Set the amount of the withdrawal depending on the balance of the
// validator.
var withdrawal WithdrawalT
if validator.IsFullyWithdrawable(balance, epoch) {
amount = balance
withdrawals = append(withdrawals, withdrawal.New(
math.U64(withdrawalIndex),
validatorIndex,
withdrawalAddress,
balance,
))
abi87 marked this conversation as resolved.
Show resolved Hide resolved

// Increment the withdrawal index to process the next withdrawal.
withdrawalIndex++
} else if validator.IsPartiallyWithdrawable(
balance, math.Gwei(s.cs.MaxEffectiveBalance()),
) {
amount = balance - math.Gwei(s.cs.MaxEffectiveBalance())
withdrawals = append(withdrawals, withdrawal.New(
math.U64(withdrawalIndex),
validatorIndex,
withdrawalAddress,
balance-math.Gwei(s.cs.MaxEffectiveBalance()),
))

// Increment the withdrawal index to process the next withdrawal.
withdrawalIndex++
}
withdrawal = withdrawal.New(
math.U64(withdrawalIndex),
validatorIndex,
withdrawalAddress,
amount,
)

withdrawals = append(withdrawals, withdrawal)

// Increment the withdrawal index to process the next withdrawal.
withdrawalIndex++

// Cap the number of withdrawals to the maximum allowed per payload.
//#nosec:G701 // won't overflow in practice.
Expand Down
4 changes: 4 additions & 0 deletions mod/state-transition/pkg/core/state_processor.go
Original file line number Diff line number Diff line change
Expand Up @@ -85,6 +85,10 @@ type StateProcessor[
executionEngine ExecutionEngine[
ExecutionPayloadT, ExecutionPayloadHeaderT, WithdrawalsT,
]

// processingGenesis allows initializing correctly
// eth1 deposit index upon genesis
processingGenesis bool
}

// NewStateProcessor creates a new state processor.
Expand Down
Loading
Loading