add contract doc to scaling

evmos · Dec 19, 2024 · 08051bb · 08051bb
1 parent 069c5e6
commit 08051bb
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/x/evm/types/scaling.go b/x/evm/types/scaling.go
@@ -14,6 +14,9 @@ import (
 // MustConvertEvmCoinTo18Decimals converts the coin's Amount from its original
 // representation into a 18 decimals. The function panics if coin denom is
 // not the evm denom or in case of overflow.
+//
+// CONTRACT: The function should only be called when the coin denom is the EVM. This means that
+// should be called only when the code forces the denom to be the expected one.
 func MustConvertEvmCoinTo18Decimals(coin sdk.Coin) sdk.Coin {
 	if coin.Denom != GetEVMCoinDenom() {
 		panic(fmt.Sprintf("expected evm denom %s, received %s", GetEVMCoinDenom(), coin.Denom))