Add a note in the Haddock of currencySymbolValueOf (#6444)

IntersectMBO · Sep 4, 2024 · 02e63ba · 02e63ba
1 parent 365a39d
commit 02e63ba
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/plutus-ledger-api/src/PlutusLedgerApi/V1/Value.hs b/plutus-ledger-api/src/PlutusLedgerApi/V1/Value.hs
@@ -359,6 +359,9 @@ valueOf (Value mp) cur tn =
 {-# INLINABLE currencySymbolValueOf #-}
 -- | Get the total value of the currency symbol in the 'Value' map.
 -- Assumes that the underlying map doesn't contain duplicate keys.
+--
+-- Note that each token of the currency symbol may have a value that is positive,
+-- zero or negative.
 currencySymbolValueOf :: Value -> CurrencySymbol -> Integer
 currencySymbolValueOf (Value mp) cur = case Map.lookup cur mp of
  Nothing -> 0