docs: clarify what is available in ctx.BlockHeader() (#23394)

2025-01-15 17:19:03 +00:00
parent 69defb4011
commit bbf813ccda
3 changed files with 19 additions and 0 deletions
@@ -92,6 +92,9 @@ func (c Context) CometInfo() comet.Info                         { return c.comet
 func (c Context) HeaderInfo() header.Info                       { return c.headerInfo }

 // BlockHeader returns the header by value.
+// Note, only ChainID, Time and Height are always filled by baseapp.
+// In finalize block, the proposer address, validator hash and app hash are also filled.
+// Use CometInfo service and/or the Consensus Keeper for getting more information.
 func (c Context) BlockHeader() cmtproto.Header {
 	return c.header
 }