Temporary Commit

x/evm/keeper/precompile.go

@@ -51,24 +51,6 @@ func (k *Keeper) SyncEnabledPrecompiles(ctx sdk.Context, enabledPrecompiles []co
 	return nil
 }
 
-func HexToAddresses(hexAddrs []string) []common.Address {
-	addrs := make([]common.Address, len(hexAddrs))
-	for i, hexAddr := range hexAddrs {
-		addrs[i] = common.HexToAddress(hexAddr)
-	}
-
-	return addrs
-}
-
-func AddressesToHex(addrs []common.Address) []string {
-	hexAddrs := make([]string, len(addrs))
-	for i, addr := range addrs {
-		hexAddrs[i] = addr.Hex()
-	}
-
-	return hexAddrs
-}
-
 func SyncEnabledPrecompiles(stateDB StateDB, old []common.Address, new []common.Address) error {
 	cfg := DetermineInitializationConfig(old, new)
 	return ApplyInitializationConfig(stateDB, cfg)
@@ -97,6 +79,10 @@ func ApplyInitializationConfig(stateDB StateDB, cfg *InitializationConfig) error
 	return nil
 }
 
+// SetDifference returns difference between two sets, example can be:
+// a   : {1, 2, 3}
+// b   : {1, 3}
+// diff: {2}
 func SetDifference(a []common.Address, b []common.Address) []common.Address {
 	bMap := make(map[common.Address]struct{}, len(b))
 	for _, elem := range b {
@@ -113,6 +99,7 @@ func SetDifference(a []common.Address, b []common.Address) []common.Address {
 	return diff
 }
 
+// ValidatePrecompilesInitialized validates that precompiles at specified addresses are initialized.
 func ValidatePrecompilesInitialized(stateDB StateDB, addrs []common.Address) error {
 	for _, addr := range addrs {
 		nonce := stateDB.GetNonce(addr)
@@ -127,6 +114,7 @@ func ValidatePrecompilesInitialized(stateDB StateDB, addrs []common.Address) err
 	return nil
 }
 
+// ValidatePrecompilesUninitialized validates that precompiles at specified addresses are uninitialized.
 func ValidatePrecompilesUninitialized(stateDB StateDB, addrs []common.Address) error {
 	for _, addr := range addrs {
 		nonce := stateDB.GetNonce(addr)
@@ -141,6 +129,9 @@ func ValidatePrecompilesUninitialized(stateDB StateDB, addrs []common.Address) e
 	return nil
 }
 
+// InitializePrecompiles initializes list of precompiles at specified addresses.
+// Initialization of precompile sets non-zero nonce and non-empty code at specified address to resemble behaviour of
+// regular smart contract.
 func InitializePrecompiles(stateDB StateDB, addrs []common.Address) {
 	for _, addr := range addrs {
 		// Set the nonce of the precompile's address (as is done when a contract is created) to ensure
@@ -153,9 +144,29 @@ func InitializePrecompiles(stateDB StateDB, addrs []common.Address) {
 	}
 }
 
+// UninitializePrecompiles uninitializes list of precompiles at specified addresses.
+// Uninitialization of precompile sets zero nonce and empty code at specified address.
 func UninitializePrecompiles(stateDB StateDB, addrs []common.Address) {
 	for _, addr := range addrs {
 		stateDB.SetNonce(addr, 0)
 		stateDB.SetCode(addr, nil)
 	}
 }
+
+func HexToAddresses(hexAddrs []string) []common.Address {
+	addrs := make([]common.Address, len(hexAddrs))
+	for i, hexAddr := range hexAddrs {
+		addrs[i] = common.HexToAddress(hexAddr)
+	}
+
+	return addrs
+}
+
+func AddressesToHex(addrs []common.Address) []string {
+	hexAddrs := make([]string, len(addrs))
+	for i, addr := range addrs {
+		hexAddrs[i] = addr.Hex()
+	}
+
+	return hexAddrs
+}