imp: mark GetTimestamp as deprecated (cosmos#5353)

Co-authored-by: DimitrisJim <d.f.hilliard@gmail.com>
notional-labs · Dec 11, 2023 · b07010d · b07010d
1 parent 55966e0
commit b07010d
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/docs/docs/03-light-clients/01-developer-guide/03-consensus-state.md b/docs/docs/03-light-clients/01-developer-guide/03-consensus-state.md
@@ -20,6 +20,8 @@ This is the type of client consensus. It should be the same as the `ClientType`
 
 ## `GetTimestamp` method
 
+*Deprecated*: soon to be removed from interface
+
 `GetTimestamp` should return the timestamp (in nanoseconds) of the consensus state snapshot.
 
 ## `ValidateBasic` method

diff --git a/modules/core/exported/client.go b/modules/core/exported/client.go
@@ -148,6 +148,9 @@ type ConsensusState interface {
 	ClientType() string // Consensus kind
 
 	// GetTimestamp returns the timestamp (in nanoseconds) of the consensus state
+	//
+	// Deprecated: GetTimestamp is not used outside of the light client implementations,
+	// and therefore it doesn't need to be an interface function.
 	GetTimestamp() uint64
 
 	ValidateBasic() error