accounts: lint comments (#25726)

accounts/abi/abi_test.go

@@ -165,8 +165,9 @@ func TestInvalidABI(t *testing.T) {
 
 // TestConstructor tests a constructor function.
 // The test is based on the following contract:
-// 	contract TestConstructor {
+//
-// 		constructor(uint256 a, uint256 b) public{}
+//	contract TestConstructor {
+//		constructor(uint256 a, uint256 b) public{}
 //	}
 func TestConstructor(t *testing.T) {
 	json := `[{	"inputs": [{"internalType": "uint256","name": "a","type": "uint256"	},{	"internalType": "uint256","name": "b","type": "uint256"}],"stateMutability": "nonpayable","type": "constructor"}]`
@@ -727,12 +728,12 @@ func TestBareEvents(t *testing.T) {
 // TestUnpackEvent is based on this contract:
 //
 //	contract T {
-//	  event received(address sender, uint amount, bytes memo);
+//		event received(address sender, uint amount, bytes memo);
-//	  event receivedAddr(address sender);
+//		event receivedAddr(address sender);
-//	  function receive(bytes memo) external payable {
+//		function receive(bytes memo) external payable {
-//	    received(msg.sender, msg.value, memo);
+//			received(msg.sender, msg.value, memo);
-//	    receivedAddr(msg.sender);
+//			receivedAddr(msg.sender);
-//	  }
+//		}
 //	}
 //
 // When receive("X") is called with sender 0x00... and value 1, it produces this tx receipt:
@@ -1113,8 +1114,9 @@ func TestDoubleDuplicateMethodNames(t *testing.T) {
 // TestDoubleDuplicateEventNames checks that if send0 already exists, there won't be a name
 // conflict and that the second send event will be renamed send1.
 // The test runs the abi of the following contract.
-// 	contract DuplicateEvent {
+//
-// 		event send(uint256 a);
+//	contract DuplicateEvent {
+//		event send(uint256 a);
 //		event send0();
 //		event send();
 //	}
@@ -1141,7 +1143,8 @@ func TestDoubleDuplicateEventNames(t *testing.T) {
 // TestUnnamedEventParam checks that an event with unnamed parameters is
 // correctly handled.
 // The test runs the abi of the following contract.
-// 	contract TestEvent {
+//
+//	contract TestEvent {
 //		event send(uint256, uint256);
 //	}
 func TestUnnamedEventParam(t *testing.T) {

accounts/abi/bind/backends/simulated_test.go

@@ -95,7 +95,8 @@ func TestSimulatedBackend(t *testing.T) {
 
 var testKey, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
 
-//	 the following is based on this contract:
+// the following is based on this contract:
+//
 //	 contract T {
 //	 	event received(address sender, uint amount, bytes memo);
 //	 	event receivedAddr(address sender);
@@ -103,7 +104,7 @@ var testKey, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d
 //	 	function receive(bytes calldata memo) external payable returns (string memory res) {
 //	 		emit received(msg.sender, msg.value, memo);
 //	 		emit receivedAddr(msg.sender);
-//			    return "hello world";
+//			return "hello world";
 //	 	}
 //	 }
 const abiJSON = `[ { "constant": false, "inputs": [ { "name": "memo", "type": "bytes" } ], "name": "receive", "outputs": [ { "name": "res", "type": "string" } ], "payable": true, "stateMutability": "payable", "type": "function" }, { "anonymous": false, "inputs": [ { "indexed": false, "name": "sender", "type": "address" }, { "indexed": false, "name": "amount", "type": "uint256" }, { "indexed": false, "name": "memo", "type": "bytes" } ], "name": "received", "type": "event" }, { "anonymous": false, "inputs": [ { "indexed": false, "name": "sender", "type": "address" } ], "name": "receivedAddr", "type": "event" } ]`
@@ -412,12 +413,13 @@ func TestEstimateGas(t *testing.T) {
 	/*
 		pragma solidity ^0.6.4;
 		contract GasEstimation {
-		    function PureRevert() public { revert(); }
+			function PureRevert() public { revert(); }
-		    function Revert() public { revert("revert reason");}
+			function Revert() public { revert("revert reason");}
-		    function OOG() public { for (uint i = 0; ; i++) {}}
+			function OOG() public { for (uint i = 0; ; i++) {}}
-		    function Assert() public { assert(false);}
+			function Assert() public { assert(false);}
-		    function Valid() public {}
+			function Valid() public {}
-		}*/
+		}
+	*/
 	const contractAbi = "[{\"inputs\":[],\"name\":\"Assert\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"OOG\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"PureRevert\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"Revert\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"},{\"inputs\":[],\"name\":\"Valid\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"}]"
 	const contractBin = "0x60806040523480156100115760006000fd5b50610017565b61016e806100266000396000f3fe60806040523480156100115760006000fd5b506004361061005c5760003560e01c806350f6fe3414610062578063aa8b1d301461006c578063b9b046f914610076578063d8b9839114610080578063e09fface1461008a5761005c565b60006000fd5b61006a610094565b005b6100746100ad565b005b61007e6100b5565b005b6100886100c2565b005b610092610135565b005b6000600090505b5b808060010191505061009b565b505b565b60006000fd5b565b600015156100bf57fe5b5b565b6040517f08c379a000000000000000000000000000000000000000000000000000000000815260040180806020018281038252600d8152602001807f72657665727420726561736f6e0000000000000000000000000000000000000081526020015060200191505060405180910390fd5b565b5b56fea2646970667358221220345bbcbb1a5ecf22b53a78eaebf95f8ee0eceff6d10d4b9643495084d2ec934a64736f6c63430006040033"
 
@@ -1029,28 +1031,29 @@ func TestPendingAndCallContract(t *testing.T) {
 // This test is based on the following contract:
 /*
 contract Reverter {
-    function revertString() public pure{
+	function revertString() public pure{
-        require(false, "some error");
+		require(false, "some error");
-    }
+	}
-    function revertNoString() public pure {
+	function revertNoString() public pure {
-        require(false, "");
+		require(false, "");
-    }
+	}
-    function revertASM() public pure {
+	function revertASM() public pure {
-        assembly {
+		assembly {
-            revert(0x0, 0x0)
+			revert(0x0, 0x0)
-        }
+		}
-    }
+	}
-    function noRevert() public pure {
+	function noRevert() public pure {
-        assembly {
+		assembly {
-            // Assembles something that looks like require(false, "some error") but is not reverted
+			// Assembles something that looks like require(false, "some error") but is not reverted
-            mstore(0x0, 0x08c379a000000000000000000000000000000000000000000000000000000000)
+			mstore(0x0, 0x08c379a000000000000000000000000000000000000000000000000000000000)
-            mstore(0x4, 0x0000000000000000000000000000000000000000000000000000000000000020)
+			mstore(0x4, 0x0000000000000000000000000000000000000000000000000000000000000020)
-            mstore(0x24, 0x000000000000000000000000000000000000000000000000000000000000000a)
+			mstore(0x24, 0x000000000000000000000000000000000000000000000000000000000000000a)
-            mstore(0x44, 0x736f6d65206572726f7200000000000000000000000000000000000000000000)
+			mstore(0x44, 0x736f6d65206572726f7200000000000000000000000000000000000000000000)
-            return(0x0, 0x64)
+			return(0x0, 0x64)
-        }
+		}
-    }
+	}
-}*/
+}
+*/
 func TestCallContractRevert(t *testing.T) {
 	testAddr := crypto.PubkeyToAddress(testKey.PublicKey)
 	sim := simTestBackend(testAddr)
@@ -1176,11 +1179,10 @@ func TestFork(t *testing.T) {
 /*
 Example contract to test event emission:
 
-pragma solidity >=0.7.0 <0.9.0;
+	pragma solidity >=0.7.0 <0.9.0;
-
 	contract Callable {
-	    event Called();
+		event Called();
-	    function Call() public { emit Called(); }
+		function Call() public { emit Called(); }
 	}
 */
 const callableAbi = "[{\"anonymous\":false,\"inputs\":[],\"name\":\"Called\",\"type\":\"event\"},{\"inputs\":[],\"name\":\"Call\",\"outputs\":[],\"stateMutability\":\"nonpayable\",\"type\":\"function\"}]"
@@ -1199,8 +1201,7 @@ const callableBin = "6080604052348015600f57600080fd5b5060998061001e6000396000f3f
 //  7. Mine two blocks to trigger a reorg.
 //  8. Check that the event was removed.
 //  9. Re-send the transaction and mine a block.
-//
+//  10. Check that the event was reborn.
-// 10. Check that the event was reborn.
 func TestForkLogsReborn(t *testing.T) {
 	testAddr := crypto.PubkeyToAddress(testKey.PublicKey)
 	sim := simTestBackend(testAddr)

accounts/abi/reflect.go

@@ -25,9 +25,9 @@ import (
 )
 
 // ConvertType converts an interface of a runtime type into a interface of the
-// given type
+// given type, e.g. turn this code:
-// e.g. turn
+//
-// var fields []reflect.StructField
+//	var fields []reflect.StructField
 //
 //	fields = append(fields, reflect.StructField{
 //			Name: "X",
@@ -35,8 +35,9 @@ import (
 //			Tag:  reflect.StructTag("json:\"" + "x" + "\""),
 //	}
 //
-// into
+// into:
-// type TupleT struct { X *big.Int }
+//
+//	type TupleT struct { X *big.Int }
 func ConvertType(in interface{}, proto interface{}) interface{} {
 	protoType := reflect.TypeOf(proto)
 	if reflect.TypeOf(in).ConvertibleTo(protoType) {
@@ -154,7 +155,7 @@ func setArray(dst, src reflect.Value) error {
 		dst.Set(array)
 		return nil
 	}
-	return errors.New("Cannot set array, destination not settable")
+	return errors.New("cannot set array, destination not settable")
 }
 
 func setStruct(dst, src reflect.Value) error {
@@ -162,7 +163,7 @@ func setStruct(dst, src reflect.Value) error {
 		srcField := src.Field(i)
 		dstField := dst.Field(i)
 		if !dstField.IsValid() || !srcField.IsValid() {
-			return fmt.Errorf("Could not find src field: %v value: %v in destination", srcField.Type().Name(), srcField)
+			return fmt.Errorf("could not find src field: %v value: %v in destination", srcField.Type().Name(), srcField)
 		}
 		if err := set(dstField, srcField); err != nil {
 			return err
@@ -172,11 +173,13 @@ func setStruct(dst, src reflect.Value) error {
 }
 
 // mapArgNamesToStructFields maps a slice of argument names to struct fields.
-// first round: for each Exportable field that contains a `abi:""` tag
+//
-// and this field name exists in the given argument name list, pair them together.
+// first round: for each Exportable field that contains a `abi:""` tag and this field name
-// second round: for each argument name that has not been already linked,
+// exists in the given argument name list, pair them together.
-// find what variable is expected to be mapped into, if it exists and has not been
+//
-// used, pair them.
+// second round: for each argument name that has not been already linked, find what
+// variable is expected to be mapped into, if it exists and has not been used, pair them.
+//
 // Note this function assumes the given value is a struct value.
 func mapArgNamesToStructFields(argNames []string, value reflect.Value) (map[string]string, error) {
 	typ := value.Type()

accounts/abi/utils.go

@@ -21,15 +21,14 @@ import "fmt"
 // ResolveNameConflict returns the next available name for a given thing.
 // This helper can be used for lots of purposes:
 //
-// - In solidity function overloading is supported, this function can fix
+//   - In solidity function overloading is supported, this function can fix
-//   the name conflicts of overloaded functions.
+//     the name conflicts of overloaded functions.
-// - In golang binding generation, the parameter(in function, event, error,
+//   - In golang binding generation, the parameter(in function, event, error,
-//	 and struct definition) name will be converted to camelcase style which
+//     and struct definition) name will be converted to camelcase style which
-//	 may eventually lead to name conflicts.
+//     may eventually lead to name conflicts.
 //
-// Name conflicts are mostly resolved by adding number suffix.
+// Name conflicts are mostly resolved by adding number suffix. e.g. if the abi contains
-// 	 e.g. if the abi contains Methods send, send1
+// Methods "send" and "send1", ResolveNameConflict would return "send2" for input "send".
-//   ResolveNameConflict would return send2 for input send.
 func ResolveNameConflict(rawName string, used func(string) bool) string {
 	name := rawName
 	ok := used(name)

accounts/usbwallet/ledger.go

@@ -392,30 +392,28 @@ func (w *ledgerDriver) ledgerSign(derivationPath []uint32, tx *types.Transaction
 //
 // The signing protocol is defined as follows:
 //
-//   CLA | INS | P1 | P2                          | Lc  | Le
+//	CLA | INS | P1 | P2                          | Lc  | Le
-//   ----+-----+----+-----------------------------+-----+---
+//	----+-----+----+-----------------------------+-----+---
-//    E0 | 0C  | 00 | implementation version : 00 | variable | variable
+//	 E0 | 0C  | 00 | implementation version : 00 | variable | variable
 //
 // Where the input is:
 //
-//   Description                                      | Length
+//	Description                                      | Length
-//   -------------------------------------------------+----------
+//	-------------------------------------------------+----------
-//   Number of BIP 32 derivations to perform (max 10) | 1 byte
+//	Number of BIP 32 derivations to perform (max 10) | 1 byte
-//   First derivation index (big endian)              | 4 bytes
+//	First derivation index (big endian)              | 4 bytes
-//   ...                                              | 4 bytes
+//	...                                              | 4 bytes
-//   Last derivation index (big endian)               | 4 bytes
+//	Last derivation index (big endian)               | 4 bytes
-//   domain hash                                      | 32 bytes
+//	domain hash                                      | 32 bytes
-//   message hash                                     | 32 bytes
+//	message hash                                     | 32 bytes
-//
-//
 //
 // And the output data is:
 //
-//   Description | Length
+//	Description | Length
-//   ------------+---------
+//	------------+---------
-//   signature V | 1 byte
+//	signature V | 1 byte
-//   signature R | 32 bytes
+//	signature R | 32 bytes
-//   signature S | 32 bytes
+//	signature S | 32 bytes
 func (w *ledgerDriver) ledgerSignTypedMessage(derivationPath []uint32, domainHash []byte, messageHash []byte) ([]byte, error) {
 	// Flatten the derivation path into the Ledger request
 	path := make([]byte, 1+4*len(derivationPath))