Add deprecation notes to test clients.

attestantio · Dec 4, 2023 · cddc7a4 · cddc7a4
1 parent 7b70672
commit cddc7a4
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/testclients/erroring.go b/testclients/erroring.go
@@ -82,6 +82,8 @@ func (s *Erroring) maybeError(_ context.Context) error {
 }
 
 // EpochFromStateID converts a state ID to its epoch.
+//
+// Deprecated: use chaintime.
 func (s *Erroring) EpochFromStateID(ctx context.Context, stateID string) (phase0.Epoch, error) {
 	if err := s.maybeError(ctx); err != nil {
 		return 0, err
@@ -95,6 +97,8 @@ func (s *Erroring) EpochFromStateID(ctx context.Context, stateID string) (phase0
 }
 
 // SlotFromStateID converts a state ID to its slot.
+//
+// Deprecated: use chaintime.
 func (s *Erroring) SlotFromStateID(ctx context.Context, stateID string) (phase0.Slot, error) {
 	if err := s.maybeError(ctx); err != nil {
 		return 0, err

diff --git a/testclients/sleepy.go b/testclients/sleepy.go
@@ -79,6 +79,8 @@ func (s *Sleepy) sleep(_ context.Context) {
 }
 
 // EpochFromStateID converts a state ID to its epoch.
+//
+// Deprecated: use chaintime.
 func (s *Sleepy) EpochFromStateID(ctx context.Context, stateID string) (phase0.Epoch, error) {
 	s.sleep(ctx)
 	next, isNext := s.next.(consensusclient.EpochFromStateIDProvider)
@@ -90,6 +92,8 @@ func (s *Sleepy) EpochFromStateID(ctx context.Context, stateID string) (phase0.E
 }
 
 // SlotFromStateID converts a state ID to its slot.
+//
+// Deprecated: use chaintime.
 func (s *Sleepy) SlotFromStateID(ctx context.Context, stateID string) (phase0.Slot, error) {
 	s.sleep(ctx)
 	next, isNext := s.next.(consensusclient.SlotFromStateIDProvider)