Skip to content

Commit

Permalink
deposit receipts start index getters and setters (#13947)
Browse files Browse the repository at this point in the history
* adding in getters and setters for deposit receipts start index

* adding tests

* gaz
  • Loading branch information
james-prysm authored and prestonvanloon committed May 2, 2024
1 parent eed86c7 commit 5075f55
Show file tree
Hide file tree
Showing 6 changed files with 96 additions and 0 deletions.
2 changes: 2 additions & 0 deletions beacon-chain/state/interfaces.go
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,7 @@ type ReadOnlySyncCommittee interface {
type ReadOnlyElectra interface {
ConsolidationBalanceToConsume() (uint64, error)
DepositBalanceToConsume() (uint64, error)
DepositReceiptsStartIndex() (uint64, error)
EarliestConsolidationEpoch() (primitives.Epoch, error)
PendingBalanceDeposits() ([]*ethpb.PendingBalanceDeposit, error)
PendingConsolidations() ([]*ethpb.PendingConsolidation, error)
Expand Down Expand Up @@ -306,6 +307,7 @@ type WriteOnlyPendingBalanceDeposits interface {

type WriteOnlyElectra interface {
SetConsolidationBalanceToConsume(gwei uint64) error
SetDepositReceiptsStartIndex(index uint64) error
SetEarliestConsolidationEpoch(epoch primitives.Epoch) error
SetPendingBalanceDeposits(val []*ethpb.PendingBalanceDeposit) error
SetDepositBalanceToConsume(gwei uint64) error
Expand Down
4 changes: 4 additions & 0 deletions beacon-chain/state/state-native/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ go_library(
"getters_block.go",
"getters_checkpoint.go",
"getters_consolidation.go",
"getters_deposit_receipts.go",
"getters_eth1.go",
"getters_misc.go",
"getters_participation.go",
Expand All @@ -31,6 +32,7 @@ go_library(
"setters_checkpoint.go",
"setters_churn.go",
"setters_consolidation.go",
"setters_deposit_receipts.go",
"setters_eth1.go",
"setters_misc.go",
"setters_participation.go",
Expand Down Expand Up @@ -90,6 +92,7 @@ go_test(
"getters_block_test.go",
"getters_checkpoint_test.go",
"getters_consolidation_test.go",
"getters_deposit_receipts_test.go",
"getters_participation_test.go",
"getters_test.go",
"getters_validator_test.go",
Expand All @@ -103,6 +106,7 @@ go_test(
"setters_balance_deposits_test.go",
"setters_churn_test.go",
"setters_consolidation_test.go",
"setters_deposit_receipts_test.go",
"setters_eth1_test.go",
"setters_misc_test.go",
"setters_participation_test.go",
Expand Down
16 changes: 16 additions & 0 deletions beacon-chain/state/state-native/getters_deposit_receipts.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
package state_native

import (
"github.com/prysmaticlabs/prysm/v5/runtime/version"
)

// DepositReceiptsStartIndex is used for returning the deposit receipts start index which is used for eip6110
func (b *BeaconState) DepositReceiptsStartIndex() (uint64, error) {
if b.version < version.Electra {
return 0, errNotSupported("DepositReceiptsStartIndex", b.version)
}
b.lock.RLock()
defer b.lock.RUnlock()

return b.depositReceiptsStartIndex, nil
}
26 changes: 26 additions & 0 deletions beacon-chain/state/state-native/getters_deposit_receipts_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
package state_native_test

import (
"testing"

state_native "github.com/prysmaticlabs/prysm/v5/beacon-chain/state/state-native"
ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
"github.com/prysmaticlabs/prysm/v5/testing/require"
"github.com/prysmaticlabs/prysm/v5/testing/util"
)

func TestDepositReceiptsStartIndex(t *testing.T) {
t.Run("previous fork returns expected error", func(t *testing.T) {
dState, _ := util.DeterministicGenesisState(t, 1)
_, err := dState.DepositReceiptsStartIndex()
require.ErrorContains(t, "is not supported", err)
})
t.Run("electra returns expected value", func(t *testing.T) {
want := uint64(2)
dState, err := state_native.InitializeFromProtoElectra(&ethpb.BeaconStateElectra{DepositReceiptsStartIndex: want})
require.NoError(t, err)
got, err := dState.DepositReceiptsStartIndex()
require.NoError(t, err)
require.Equal(t, want, got)
})
}
21 changes: 21 additions & 0 deletions beacon-chain/state/state-native/setters_deposit_receipts.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
package state_native

import (
"github.com/prysmaticlabs/prysm/v5/beacon-chain/state/state-native/types"
"github.com/prysmaticlabs/prysm/v5/runtime/version"
)

// SetDepositReceiptsStartIndex for the beacon state. Updates the DepositReceiptsStartIndex
func (b *BeaconState) SetDepositReceiptsStartIndex(index uint64) error {
if b.version < version.Electra {
return errNotSupported("SetDepositReceiptsStartIndex", b.version)
}

b.lock.Lock()
defer b.lock.Unlock()

b.depositReceiptsStartIndex = index
b.markFieldAsDirty(types.DepositReceiptsStartIndex)
b.rebuildTrie[types.DepositReceiptsStartIndex] = true
return nil
}
27 changes: 27 additions & 0 deletions beacon-chain/state/state-native/setters_deposit_receipts_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
package state_native_test

import (
"testing"

state_native "github.com/prysmaticlabs/prysm/v5/beacon-chain/state/state-native"
ethpb "github.com/prysmaticlabs/prysm/v5/proto/prysm/v1alpha1"
"github.com/prysmaticlabs/prysm/v5/testing/require"
"github.com/prysmaticlabs/prysm/v5/testing/util"
)

func TestSetDepositReceiptsStartIndex(t *testing.T) {
t.Run("previous fork returns expected error", func(t *testing.T) {
dState, _ := util.DeterministicGenesisState(t, 1)
require.ErrorContains(t, "is not supported", dState.SetDepositReceiptsStartIndex(1))
})
t.Run("electra sets expected value", func(t *testing.T) {
old := uint64(2)
dState, err := state_native.InitializeFromProtoElectra(&ethpb.BeaconStateElectra{DepositReceiptsStartIndex: old})
require.NoError(t, err)
want := uint64(3)
require.NoError(t, dState.SetDepositReceiptsStartIndex(want))
got, err := dState.DepositReceiptsStartIndex()
require.NoError(t, err)
require.Equal(t, want, got)
})
}

0 comments on commit 5075f55

Please sign in to comment.