Skip to content

feat: cl get payload v4 #706

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

Merged
kant777 merged 9 commits into from
Jun 25, 2025
Merged

feat: cl get payload v4 #706

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ca65878
changing get payload from v3 to v4
Jun 19, 2025
049b964
merge from main
Jun 19, 2025
e11cabc
setting empty block generation to 1 minute
kant777 Jun 21, 2025
bf8012d
setting default fee receipent and adjusting test
kant777 Jun 25, 2025
d416143
fixing tests
kant777 Jun 25, 2025
fa7bfa9
Merge branch 'main' into feature/cl_get_payload_v4
kant777 Jun 25, 2025
738f895
go.work
kant777 Jun 25, 2025
ebea866
Merge branch 'feature/cl_get_payload_v2' of github.com:primev/mev-com…
kant777 Jun 25, 2025
f5af81c
removing redundant flag
kant777 Jun 25, 2025
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
8 changes: 6 additions & 2 deletions cl/blockbuilder/blockbuilder.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ type EngineClient interface {
ForkchoiceUpdatedV3(ctx context.Context, update engine.ForkchoiceStateV1,
payloadAttributes *engine.PayloadAttributes) (engine.ForkChoiceResponse, error)

GetPayloadV3(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)
GetPayloadV4(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)

HeaderByNumber(ctx context.Context, number *big.Int) (*etypes.Header, error)
}
Expand Down Expand Up @@ -203,7 +203,7 @@ func (bb *BlockBuilder) GetPayload(ctx context.Context) error {
var payloadResp *engine.ExecutionPayloadEnvelope
err = util.RetryWithBackoff(ctx, maxAttempts, bb.logger, func() error {
var err error
payloadResp, err = bb.engineCl.GetPayloadV3(ctx, *payloadID)
payloadResp, err = bb.engineCl.GetPayloadV4(ctx, *payloadID)
if isUnknownPayload(err) {
return backoff.Permanent(err)
} else if err != nil {
Expand Down Expand Up @@ -476,6 +476,10 @@ func (bb *BlockBuilder) pushNewPayload(ctx context.Context, executionPayload eng
emptyVersionHashes := []common.Hash{}
return retryFunc(func() error {
status, err := bb.engineCl.NewPayloadV4(ctx, executionPayload, emptyVersionHashes, &hash, []hexutil.Bytes{})
bb.logger.Debug("newPayload result",
"status", status.Status,
"validationError", status.ValidationError,
"latestValidHash", status.LatestValidHash)
Copy link
Copy Markdown
Collaborator

@aloknerurkar aloknerurkar Jun 25, 2025

Choose a reason for hiding this comment

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

nit: Indentation in this case should ideally be

Suggested change
"latestValidHash", status.LatestValidHash)
"latestValidHash", status.LatestValidHash,
)

Improves clarity with line between next control statement

if err != nil || isUnknown(status) {
bb.logger.Error("Failed to push new payload", "error", err)
return err // Will retry
Expand Down
6 changes: 3 additions & 3 deletions cl/blockbuilder/blockbuilder_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ func (m *MockEngineClient) ForkchoiceUpdatedV3(ctx context.Context, fcs engine.F
return args.Get(0).(engine.ForkChoiceResponse), args.Error(1)
}

func (m *MockEngineClient) GetPayloadV3(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error) {
func (m *MockEngineClient) GetPayloadV4(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error) {
args := m.Called(ctx, payloadID)
return args.Get(0).(*engine.ExecutionPayloadEnvelope), args.Error(1)
}
Expand Down Expand Up @@ -174,7 +174,7 @@ func TestBlockBuilder_getPayload(t *testing.T) {
ReceiptsRoot: hash,
},
}
mockEngineClient.On("GetPayloadV3", mock.Anything, *payloadID).Return(executionPayload, nil)
mockEngineClient.On("GetPayloadV4", mock.Anything, *payloadID).Return(executionPayload, nil)

blockBuilder.executionHead = executionHead
err = blockBuilder.GetPayload(ctx)
Expand Down Expand Up @@ -404,7 +404,7 @@ func TestBlockBuilder_getPayload_GetPayloadUnknownPayload(t *testing.T) {
}
mockEngineClient.On("ForkchoiceUpdatedV3", mock.Anything, expectedFCS, mock.MatchedBy(matchPayloadAttributes(hash, executionHead.BlockTime))).Return(forkChoiceResponse, nil)

mockEngineClient.On("GetPayloadV3", mock.Anything, *payloadID).Return(&engine.ExecutionPayloadEnvelope{}, errors.New("Unknown payload"))
mockEngineClient.On("GetPayloadV4", mock.Anything, *payloadID).Return(&engine.ExecutionPayloadEnvelope{}, errors.New("Unknown payload"))

blockBuilder.executionHead = executionHead
err = blockBuilder.GetPayload(ctx)
Expand Down
5 changes: 3 additions & 2 deletions cl/cmd/singlenode/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,21 +126,22 @@ var (
Name: "evm-build-delay",
Usage: "Delay after initiating payload construction before calling getPayload (e.g., '200ms')",
EnvVars: []string{"LEADER_EVM_BUILD_DELAY"},
Value: 100 * time.Millisecond,
Value: 1 * time.Millisecond,
})

evmBuildDelayEmptyBlockFlag = altsrc.NewDurationFlag(&cli.DurationFlag{
Name: "evm-build-delay-empty-block",
Usage: "Minimum time since last block to build an empty block (0 to disable skipping, e.g., '2s')",
EnvVars: []string{"LEADER_EVM_BUILD_DELAY_EMPTY_BLOCK"},
Value: 2 * time.Second,
Value: 1 * time.Minute,
})

priorityFeeReceiptFlag = altsrc.NewStringFlag(&cli.StringFlag{
Name: "priority-fee-recipient",
Usage: "Ethereum address for receiving priority fees (block proposer fee)",
EnvVars: []string{"LEADER_PRIORITY_FEE_RECIPIENT"},
Required: true,
Value: "0xfA0B0f5d298d28EFE4d35641724141ef19C05684",
Copy link
Copy Markdown
Collaborator

@aloknerurkar aloknerurkar Jun 25, 2025

Choose a reason for hiding this comment

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

Is this on purpose?

Copy link
Copy Markdown
Contributor Author

@kant777 kant777 Jun 25, 2025

Choose a reason for hiding this comment

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

Yes

Action: func(c *cli.Context, s string) error {
if !strings.HasPrefix(s, "0x") || len(s) != 42 {
return fmt.Errorf("priority-fee-recipient must be a 0x-prefixed 42-character hex string")
Expand Down
12 changes: 6 additions & 6 deletions cl/ethclient/engineclient.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ const (
forkchoiceUpdatedV3 = "engine_forkchoiceUpdatedV3"

getPayloadV2 = "engine_getPayloadV2"
getPayloadV3 = "engine_getPayloadV3"
getPayloadV4 = "engine_getPayloadV4"
)

// EngineClient defines the Engine API authenticated JSON-RPC endpoints.
Expand Down Expand Up @@ -53,7 +53,7 @@ type EngineClient interface {
// GetPayloadV2 returns a cached payload by id.
GetPayloadV2(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)
// GetPayloadV3 returns a cached payload by id.
GetPayloadV3(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)
GetPayloadV4(ctx context.Context, payloadID engine.PayloadID) (*engine.ExecutionPayloadEnvelope, error)
}

// engineClient implements EngineClient using JSON-RPC.
Expand Down Expand Up @@ -174,17 +174,17 @@ func (c engineClient) GetPayloadV2(ctx context.Context, payloadID engine.Payload
return &resp, nil
}

func (c engineClient) GetPayloadV3(ctx context.Context, payloadID engine.PayloadID) (
func (c engineClient) GetPayloadV4(ctx context.Context, payloadID engine.PayloadID) (
*engine.ExecutionPayloadEnvelope, error,
) {
const endpoint = "get_payload_v3"
const endpoint = "get_payload_v4"
defer latency(c.chain, endpoint)()

var resp engine.ExecutionPayloadEnvelope
err := c.cl.Client().CallContext(ctx, &resp, getPayloadV3, payloadID)
err := c.cl.Client().CallContext(ctx, &resp, getPayloadV4, payloadID)
if err != nil {
incError(c.chain, endpoint)
return nil, fmt.Errorf("rpc get payload v3: %w", err)
return nil, fmt.Errorf("rpc get payload v4: %w", err)
}

return &resp, nil
Expand Down
1 change: 0 additions & 1 deletion cl/singlenode/singlenode.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,7 +342,6 @@ func (app *SingleNodeApp) produceBlock() error {
if err := app.blockBuilder.FinalizeBlock(app.appCtx, currentState.PayloadID, currentState.ExecutionPayload, ""); err != nil {
return fmt.Errorf("failed to finalize block: %w", err)
}

return nil
}

Expand Down
6 changes: 6 additions & 0 deletions go.work.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -838,6 +838,7 @@ github.com/cilium/ebpf v0.9.1/go.mod h1:+OhNOIXx/Fnu1IE8bJz2dzOA+VSfyTfdNUVdlQnx
github.com/client9/misspell v0.3.4 h1:ta993UF76GwbvJcIo3Y68y/M3WxlpEHPWIGDkJYwzJI=
github.com/cloudflare/cloudflare-go v0.79.0 h1:ErwCYDjFCYppDJlDJ/5WhsSmzegAUe2+K9qgFyQDg3M=
github.com/cloudflare/cloudflare-go v0.79.0/go.mod h1:gkHQf9xEubaQPEuerBuoinR9P8bf8a05Lq0X6WKy1Oc=
github.com/cloudflare/cloudflare-go v0.114.0 h1:ucoti4/7Exo0XQ+rzpn1H+IfVVe++zgiM+tyKtf0HUA=
github.com/cloudflare/cloudflare-go v0.114.0/go.mod h1:O7fYfFfA6wKqKFn2QIR9lhj7FDw6VQCGOY6hd2TBtd0=
github.com/cncf/udpa/go v0.0.0-20191209042840-269d4d468f6f/go.mod h1:M8M6+tZqaGXZJjfX53e64911xZQV5JYwmTeXPW+k8Sc=
github.com/cncf/udpa/go v0.0.0-20200629203442-efcf912fb354/go.mod h1:WmhPx2Nbnhtbo57+VJT5O0JRkEi1Wbu0z5j0R8u5Hbk=
Expand Down Expand Up @@ -1009,6 +1010,7 @@ github.com/felixge/httpsnoop v1.0.4 h1:NFTV2Zj1bL4mc9sqWACXbQFVBBg2W3GPvqp8/ESS2
github.com/felixge/httpsnoop v1.0.4/go.mod h1:m8KPJKqk1gH5J9DgRY2ASl2lWCfGKXixSwevea8zH2U=
github.com/fjl/gencodec v0.0.0-20230517082657-f9840df7b83e h1:bBLctRc7kr01YGvaDfgLbTwjFNW5jdp5y5rj8XXBHfY=
github.com/fjl/gencodec v0.0.0-20230517082657-f9840df7b83e/go.mod h1:AzA8Lj6YtixmJWL+wkKoBGsLWy9gFrAzi4g+5bCKwpY=
github.com/fjl/gencodec v0.1.0 h1:B3K0xPfc52cw52BBgUbSPxYo+HlLfAgWMVKRWXUXBcs=
github.com/fjl/gencodec v0.1.0/go.mod h1:Um1dFHPONZGTHog1qD1NaWjXJW/SPB38wPv0O8uZ2fI=
github.com/flosch/pongo2 v0.0.0-20190707114632-bbf5a6c351f4 h1:GY1+t5Dr9OKADM64SYnQjw/w99HMYvQ0A8/JoUkxVmc=
github.com/flosch/pongo2 v0.0.0-20190707114632-bbf5a6c351f4/go.mod h1:T9YF2M40nIgbVgp3rreNmTged+9HrbNTIQf1PsaIiTA=
Expand Down Expand Up @@ -1112,6 +1114,7 @@ github.com/gobwas/ws v1.2.1/go.mod h1:hRKAFb8wOxFROYNsT1bqfWnhX+b5MFeJM9r2ZSwg/K
github.com/goccy/go-json v0.9.11/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
github.com/goccy/go-json v0.10.2 h1:CrxCmQqYDkv1z7lO7Wbh2HN93uovUHgrECaO5ZrCXAU=
github.com/goccy/go-json v0.10.2/go.mod h1:6MelG93GURQebXPDq3khkgXZkazVtN9CRI+MGFi0w8I=
github.com/goccy/go-json v0.10.4 h1:JSwxQzIqKfmFX1swYPpUThQZp/Ka4wzJdK0LWVytLPM=
github.com/goccy/go-json v0.10.4/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PULtXL6M=
github.com/gofiber/fiber/v2 v2.52.2 h1:b0rYH6b06Df+4NyrbdptQL8ifuxw/Tf2DgfkZkDaxEo=
github.com/gofiber/fiber/v2 v2.52.2/go.mod h1:KEOE+cXMhXG0zHc9d8+E38hoX+ZN7bhOtgeF2oT6jrQ=
Expand Down Expand Up @@ -1414,6 +1417,7 @@ github.com/kilic/bls12-381 v0.1.0/go.mod h1:vDTTHJONJ6G+P2R74EhnyotQDTliQDnFEwhd
github.com/kisielk/errcheck v1.1.0/go.mod h1:EZBBE59ingxPouuu3KfxchcWSUPOHkagtvWXihfKN4Q=
github.com/kisielk/errcheck v1.5.0 h1:e8esj/e4R+SAOwFwN+n3zr0nYeCyeweozKfO23MvHzY=
github.com/kisielk/gotool v1.0.0 h1:AV2c/EiW3KqPNT9ZKl07ehoAGi4C5/01Cfbblndcapg=
github.com/kisielk/sqlstruct v0.0.0-20201105191214-5f3e10d3ab46 h1:veS9QfglfvqAw2e+eeNT/SbGySq8ajECXJ9e4fPoLhY=
github.com/klauspost/asmfmt v1.3.2 h1:4Ri7ox3EwapiOjCki+hw14RyKk201CN4rzyCJRFLpK4=
github.com/klauspost/asmfmt v1.3.2/go.mod h1:AG8TuvYojzulgDAMCnYn50l/5QV3Bs/tp6j0HLHbNSE=
github.com/klauspost/compress v1.8.2/go.mod h1:RyIbtBH6LamlWaDj8nUwkbUhJ87Yi3uG0guNDohfE1A=
Expand Down Expand Up @@ -1683,6 +1687,7 @@ github.com/protolambda/messagediff v1.4.0 h1:fk6gxK7WybJCaeOFK1yuh2Ldplx7qYMLibi
github.com/protolambda/messagediff v1.4.0/go.mod h1:LboJp0EwIbJsePYpzh5Op/9G1/4mIztMRYzzwR0dR2M=
github.com/protolambda/zrnt v0.32.2 h1:KZ48T+3UhsPXNdtE/5QEvGc9DGjUaRI17nJaoznoIaM=
github.com/protolambda/zrnt v0.32.2/go.mod h1:A0fezkp9Tt3GBLATSPIbuY4ywYESyAuc/FFmPKg8Lqs=
github.com/protolambda/zrnt v0.34.1 h1:qW55rnhZJDnOb3TwFiFRJZi3yTXFrJdGOFQM7vCwYGg=
github.com/protolambda/zrnt v0.34.1/go.mod h1:A0fezkp9Tt3GBLATSPIbuY4ywYESyAuc/FFmPKg8Lqs=
github.com/protolambda/ztyp v0.2.2 h1:rVcL3vBu9W/aV646zF6caLS/dyn9BN8NYiuJzicLNyY=
github.com/protolambda/ztyp v0.2.2/go.mod h1:9bYgKGqg3wJqT9ac1gI2hnVb0STQq7p/1lapqrqY1dU=
Expand Down Expand Up @@ -2216,6 +2221,7 @@ golang.org/x/term v0.23.0 h1:F6D4vR+EHoL9/sWAWgAR1H2DcHr4PareCbAaCo1RpuU=
golang.org/x/term v0.23.0/go.mod h1:DgV24QBUrK6jhZXl+20l6UWznPlwAHm1Q1mGHtydmSk=
golang.org/x/term v0.25.0/go.mod h1:RPyXicDX+6vLxogjjRxjgD2TKtmAO6NZBsBRfrOLu7M=
golang.org/x/term v0.28.0/go.mod h1:Sw/lC2IAUZ92udQNf3WodGtn4k/XoLyZoh8v/8uiwek=
golang.org/x/term v0.29.0 h1:L6pJp37ocefwRRtYPKSWOWzOtWSxVajvz2ldH/xi3iU=
golang.org/x/term v0.29.0/go.mod h1:6bl4lRlvVuDgSf3179VpIxBF0o10JUpXWOnI7nErv7s=
golang.org/x/text v0.0.0-20170915032832-14c0d48ead0c/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
golang.org/x/text v0.3.4/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
Expand Down
Loading