Add comment to safemath.SafeSub usage

iotaledger · Nov 6, 2023 · 2394969 · 2394969
1 parent 885ff43
commit 2394969
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/pkg/protocol/engine/ledger/ledger/ledger.go b/pkg/protocol/engine/ledger/ledger/ledger.go
@@ -181,7 +181,7 @@ func (l *Ledger) CommitSlot(slot iotago.SlotIndex) (stateRoot iotago.Identifier,
 	// Update the Accounts ledger
 	// first, get the RMC corresponding to this slot
 	protocolParams := l.apiProvider.APIForSlot(slot).ProtocolParameters()
-	rmcSlot, _ := safemath.SafeSub(slot, protocolParams.MaxCommittableAge())
+	rmcSlot, _ := safemath.SafeSub(slot, protocolParams.MaxCommittableAge()) // We can safely ignore the underflow error and use the default 0 return value
 	if rmcSlot < protocolParams.GenesisSlot() {
 		rmcSlot = protocolParams.GenesisSlot()
 	}