Skip to content

Commit

Permalink
Fix misleading doc, return variable name (#13789)
Browse files Browse the repository at this point in the history
- Fix Min -> Max in doc
- Fix return variable name bc it is confusing when it autocompletes (min
function, but returns max?)
  • Loading branch information
wmitsuda authored Feb 14, 2025
1 parent cc17bd0 commit 07c6d32
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions erigon-lib/kv/rawdbv3/txnum.go
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ func (TxNumsReader) WithCustomReadTxNumFunc(f ReadTxNumFunc) TxNumsReader {
return TxNumsReader{readTxNumFunc: f}
}

// Min - returns maxTxNum in given block. If block not found - return last available value (`latest`/`pending` state)
// Max - returns maxTxNum in given block. If block not found - return last available value (`latest`/`pending` state)
func (t TxNumsReader) Max(tx kv.Tx, blockNum uint64) (maxTxNum uint64, err error) {
var k [8]byte
binary.BigEndian.PutUint64(k[:], blockNum)
Expand Down Expand Up @@ -110,7 +110,7 @@ func (t TxNumsReader) Max(tx kv.Tx, blockNum uint64) (maxTxNum uint64, err error
}

// Min = `max(blockNum-1)+1` returns minTxNum in given block. If block not found - return last available value (`latest`/`pending` state)
func (t TxNumsReader) Min(tx kv.Tx, blockNum uint64) (maxTxNum uint64, err error) {
func (t TxNumsReader) Min(tx kv.Tx, blockNum uint64) (minTxNum uint64, err error) {
if blockNum == 0 {
return 0, nil
}
Expand All @@ -120,7 +120,7 @@ func (t TxNumsReader) Min(tx kv.Tx, blockNum uint64) (maxTxNum uint64, err error
}
defer c.Close()

maxTxNum, ok, err := t.readTxNumFunc(tx, c, blockNum-1)
minTxNum, ok, err := t.readTxNumFunc(tx, c, blockNum-1)
if err != nil {
return 0, err
}
Expand All @@ -135,7 +135,7 @@ func (t TxNumsReader) Min(tx kv.Tx, blockNum uint64) (maxTxNum uint64, err error
}
return binary.BigEndian.Uint64(v) + 1, nil
}
return maxTxNum + 1, nil
return minTxNum + 1, nil
}

func (t TxNumsReader) Append(tx kv.RwTx, blockNum, maxTxNum uint64) (err error) {
Expand Down

0 comments on commit 07c6d32

Please sign in to comment.