[Chore] Single line for message logging (#779)

Author: Nicolás Tallar

src/main/scala/io/iohk/ethereum/blockchain/data/GenesisDataLoader.scala

@@ -102,7 +102,7 @@ class GenesisDataLoader(blockchain: Blockchain, blockchainConfig: BlockchainConf
 
     val header: BlockHeader = prepareHeader(genesisData, stateMptRootHash)
 
-    log.debug(s"prepared genesis header: $header, with hash ${header.hashAsHexString}")
+    log.debug(s"Prepared genesis header: $header")
 
     blockchain.getBlockHeaderByNumber(0) match {
       case Some(existingGenesisHeader) if existingGenesisHeader.hash == header.hash =>

src/main/scala/io/iohk/ethereum/blockchain/sync/regular/ImportMessages.scala

@@ -85,9 +85,9 @@ class NewBlockImportMessages(block: Block, peerId: PeerId) extends ImportMessage
     val lastHeader = newBranch.last.header
     (
       DebugLevel,
-      s"""Imported block $number ($hash) from $peerId
-         |resulting in chain reorganisation: new branch of length ${newBranch.size} with head at block
-         |${lastHeader.number} (${hash2string(lastHeader.hash)})""".stripMargin
+      s"Imported block $number ($hash) from $peerId " +
+        s"resulting in chain reorganisation: new branch of length ${newBranch.size} with head at block " +
+        s"${lastHeader.number} (${hash2string(lastHeader.hash)})"
     )
   }
   override def importFailed(error: String): LogEntry =

src/main/scala/io/iohk/ethereum/domain/Block.scala

@@ -11,12 +11,8 @@ import io.iohk.ethereum.rlp.{RLPEncodeable, RLPList, RLPSerializable, rawDecode}
   * @param body   Block body
   */
 case class Block(header: BlockHeader, body: BlockBody) {
-  override def toString: String = {
-    s"""BlockHeader {
-       | header: $header
-       | body: $body
-     """.stripMargin
-  }
+  override def toString: String =
+    s"Block { header: $header, body: $body }"
 
   def idTag: String =
     header.idTag

src/main/scala/io/iohk/ethereum/domain/BlockBody.scala

@@ -5,11 +5,7 @@ import io.iohk.ethereum.rlp.{RLPEncodeable, RLPList, RLPSerializable, rawDecode}
 
 case class BlockBody(transactionList: Seq[SignedTransaction], uncleNodesList: Seq[BlockHeader]) {
   override def toString: String =
-    s"""BlockBody{
-       |transactionList: $transactionList
-       |uncleNodesList: $uncleNodesList
-       |}
-    """.stripMargin
+    s"BlockBody{ transactionList: $transactionList, uncleNodesList: $uncleNodesList }"
 
   lazy val numberOfTxs: Int = transactionList.size
 

src/main/scala/io/iohk/ethereum/domain/BlockHeader.scala

@@ -59,26 +59,26 @@ case class BlockHeader(
         ("Pre-ECIP1098 block", "Pre-ECIP1097 block")
     }
 
-    s"""BlockHeader {
-       |hash: $hashAsHexString
-       |parentHash: ${ByteStringUtils.hash2string(parentHash)}
-       |ommersHash: ${ByteStringUtils.hash2string(ommersHash)}
-       |beneficiary: ${ByteStringUtils.hash2string(beneficiary)}
-       |stateRoot: ${ByteStringUtils.hash2string(stateRoot)}
-       |transactionsRoot: ${ByteStringUtils.hash2string(transactionsRoot)}
-       |receiptsRoot: ${ByteStringUtils.hash2string(receiptsRoot)}
-       |logsBloom: ${ByteStringUtils.hash2string(logsBloom)}
-       |difficulty: $difficulty,
-       |number: $number,
-       |gasLimit: $gasLimit,
-       |gasUsed: $gasUsed,
-       |unixTimestamp: $unixTimestamp,
-       |extraData: ${ByteStringUtils.hash2string(extraData)}
-       |mixHash: ${ByteStringUtils.hash2string(mixHash)}
-       |nonce: ${ByteStringUtils.hash2string(nonce)},
-       |treasuryOptOut: $treasuryOptOutString
-       |isCheckpointing: $checkpointString
-       |}""".stripMargin
+    s"BlockHeader { " +
+      s"hash: $hashAsHexString, " +
+      s"parentHash: ${ByteStringUtils.hash2string(parentHash)}, " +
+      s"ommersHash: ${ByteStringUtils.hash2string(ommersHash)}, " +
+      s"beneficiary: ${ByteStringUtils.hash2string(beneficiary)} " +
+      s"stateRoot: ${ByteStringUtils.hash2string(stateRoot)} " +
+      s"transactionsRoot: ${ByteStringUtils.hash2string(transactionsRoot)} " +
+      s"receiptsRoot: ${ByteStringUtils.hash2string(receiptsRoot)} " +
+      s"logsBloom: ${ByteStringUtils.hash2string(logsBloom)} " +
+      s"difficulty: $difficulty, " +
+      s"number: $number, " +
+      s"gasLimit: $gasLimit, " +
+      s"gasUsed: $gasUsed, " +
+      s"unixTimestamp: $unixTimestamp, " +
+      s"extraData: ${ByteStringUtils.hash2string(extraData)} " +
+      s"mixHash: ${ByteStringUtils.hash2string(mixHash)} " +
+      s"nonce: ${ByteStringUtils.hash2string(nonce)}, " +
+      s"treasuryOptOut: $treasuryOptOutString " +
+      s"isCheckpointing: $checkpointString" +
+      s"}"
   }
 
   /**

src/main/scala/io/iohk/ethereum/domain/Receipt.scala

@@ -48,13 +48,11 @@ case class Receipt(
       case _ => Array(0.toByte)
     }
 
-    s"""
-       |Receipt{
-       | postTransactionStateHash: ${Hex.toHexString(stateHash)}
-       | cumulativeGasUsed: $cumulativeGasUsed
-       | logsBloomFilter: ${Hex.toHexString(logsBloomFilter.toArray[Byte])}
-       | logs: $logs
-       |}
-       """.stripMargin
+    s"Receipt{ " +
+      s"postTransactionStateHash: ${Hex.toHexString(stateHash)}, " +
+      s"cumulativeGasUsed: $cumulativeGasUsed, " +
+      s"logsBloomFilter: ${Hex.toHexString(logsBloomFilter.toArray[Byte])}, " +
+      s"logs: $logs" +
+      s"}"
   }
 }

src/main/scala/io/iohk/ethereum/domain/SignedTransaction.scala

@@ -166,12 +166,11 @@ case class SignedTransaction(tx: Transaction, signature: ECDSASignature) {
   def safeSenderIsEqualTo(address: Address): Boolean =
     SignedTransaction.getSender(this).contains(address)
 
-  override def toString: String = {
-    s"""SignedTransaction {
-         |tx: $tx
-         |signature: $signature
-         |}""".stripMargin
-  }
+  override def toString: String =
+    s"SignedTransaction { " +
+      s"tx: $tx, " +
+      s"signature: $signature" +
+      s"}"
 
   def isChainSpecific: Boolean =
     signature.v != ECDSASignature.negativePointSign && signature.v != ECDSASignature.positivePointSign

src/main/scala/io/iohk/ethereum/domain/Transaction.scala

@@ -33,16 +33,16 @@ case class Transaction(
   def isContractInit: Boolean = receivingAddress.isEmpty
 
   override def toString: String = {
-    s"""Transaction {
-         |nonce: $nonce
-         |gasPrice: $gasPrice
-         |gasLimit: $gasLimit
-         |receivingAddress: ${if (receivingAddress.isDefined) Hex.toHexString(receivingAddress.get.toArray)
-    else "[Contract creation]"}
-         |value: $value wei
-         |payload: ${if (isContractInit) "ContractInit: " else "TransactionData: "}${Hex.toHexString(
-      payload.toArray[Byte]
-    )}
-         |}""".stripMargin
+    val receivingAddressString =
+      if (receivingAddress.isDefined) Hex.toHexString(receivingAddress.get.toArray) else "[Contract creation]"
+
+    s"Transaction {" +
+      s"nonce: $nonce " +
+      s"gasPrice: $gasPrice " +
+      s"gasLimit: $gasLimit " +
+      s"receivingAddress: $receivingAddressString " +
+      s"value: $value wei " +
+      s"payload: ${if (isContractInit) "ContractInit: " else "TransactionData: "}${Hex.toHexString(payload.toArray[Byte])} " +
+      s"}"
   }
 }

src/main/scala/io/iohk/ethereum/network/p2p/messages/CommonMessages.scala

@@ -111,16 +111,15 @@ object CommonMessages {
   ) extends Message {
     require(code == Status.code63 || code == Status.code64, s"Invalid code for Status: $code")
 
-    override def toString: String = {
-      s"""Status {
-         |code: $code
-         |protocolVersion: $protocolVersion
-         |networkId: $networkId
-         |chainWeight: $chainWeight
-         |bestHash: ${Hex.toHexString(bestHash.toArray[Byte])}
-         |genesisHash: ${Hex.toHexString(genesisHash.toArray[Byte])}
-         |}""".stripMargin
-    }
+    override def toString: String =
+      s"Status { " +
+        s"code: $code, " +
+        s"protocolVersion: $protocolVersion, " +
+        s"networkId: $networkId, " +
+        s"chainWeight: $chainWeight, " +
+        s"bestHash: ${Hex.toHexString(bestHash.toArray[Byte])}, " +
+        s"genesisHash: ${Hex.toHexString(genesisHash.toArray[Byte])}," +
+        s"}"
 
     def as63: Status =
       copy(code = Status.code63)
@@ -293,13 +292,12 @@ object CommonMessages {
   case class NewBlock(code: Int, block: Block, chainWeight: ChainWeight) extends Message {
     require(code == NewBlock.code63 || code == NewBlock.code64, s"Invalid code for NewBlock: $code")
 
-    override def toString: String = {
-      s"""NewBlock {
-         |code: $code
-         |block: $block
-         |chainWeight: $chainWeight
-         |}""".stripMargin
-    }
+    override def toString: String =
+      s"NewBlock { " +
+        s"code: $code, " +
+        s"block: $block, " +
+        s"chainWeight: $chainWeight" +
+        s"}"
 
     def as63: NewBlock =
       copy(code = NewBlock.code63)

src/main/scala/io/iohk/ethereum/network/p2p/messages/PV62.scala

@@ -30,12 +30,11 @@ object PV62 {
   }
 
   case class BlockHash(hash: ByteString, number: BigInt) {
-    override def toString: String = {
-      s"""BlockHash {
-         |hash: ${Hex.toHexString(hash.toArray[Byte])}
-         |number: $number
-         |}""".stripMargin
-    }
+    override def toString: String =
+      s"BlockHash { " +
+        s"hash: ${Hex.toHexString(hash.toArray[Byte])} " +
+        s"number: $number " +
+        s"}"
   }
 
   object NewBlockHashes {
@@ -101,15 +100,13 @@ object PV62 {
       extends Message {
     override def code: Int = GetBlockHeaders.code
 
-    override def toString: String = {
-      s"""GetBlockHeaders{
-          |block: ${block.fold(a => a, b => Hex.toHexString(b.toArray[Byte]))}
-          |maxHeaders: $maxHeaders
-          |skip: $skip
-          |reverse: $reverse
-          |}
-     """.stripMargin
-    }
+    override def toString: String =
+      s"GetBlockHeaders{ " +
+        s"block: ${block.fold(a => a, b => Hex.toHexString(b.toArray[Byte]))} " +
+        s"maxHeaders: $maxHeaders " +
+        s"skip: $skip " +
+        s"reverse: $reverse " +
+        s"}"
   }
 
   object BlockBodies {
@@ -189,11 +186,9 @@ object PV62 {
   case class GetBlockBodies(hashes: Seq[ByteString]) extends Message {
     override def code: Int = GetBlockBodies.code
 
-    override def toString: String = {
-      s"""GetBlockBodies {
-         |hashes: ${hashes.map(h => Hex.toHexString(h.toArray[Byte]))}
-         |}
-     """.stripMargin
-    }
+    override def toString: String =
+      s"GetBlockBodies { " +
+        s"hashes: ${hashes.map(h => Hex.toHexString(h.toArray[Byte]))} " +
+        s"}"
   }
 }

src/main/scala/io/iohk/ethereum/network/p2p/messages/PV63.scala

@@ -34,12 +34,8 @@ object PV63 {
   case class GetNodeData(mptElementsHashes: Seq[ByteString]) extends Message {
     override def code: Int = GetNodeData.code
 
-    override def toString: String = {
-      s"""GetNodeData{
-         |hashes: ${mptElementsHashes.map(e => Hex.toHexString(e.toArray[Byte]))}
-         |}
-       """.stripMargin
-    }
+    override def toString: String =
+      s"GetNodeData{ hashes: ${mptElementsHashes.map(e => Hex.toHexString(e.toArray[Byte]))} }"
   }
 
   object AccountImplicits {
@@ -111,12 +107,8 @@ object PV63 {
 
     override def code: Int = NodeData.code
 
-    override def toString: String = {
-      s"""NodeData{
-         |values: ${values.map(b => Hex.toHexString(b.toArray[Byte]))}
-         |}
-       """.stripMargin
-    }
+    override def toString: String =
+      s"NodeData{ values: ${values.map(b => Hex.toHexString(b.toArray[Byte]))} }"
   }
 
   object GetReceipts {
@@ -142,10 +134,7 @@ object PV63 {
     override def code: Int = GetReceipts.code
 
     override def toString: String = {
-      s"""GetReceipts{
-         |blockHashes: ${blockHashes.map(e => Hex.toHexString(e.toArray[Byte]))}
-         |}
-       """.stripMargin
+      s"GetReceipts{ blockHashes: ${blockHashes.map(e => Hex.toHexString(e.toArray[Byte]))} } "
     }
   }
 

src/main/scala/io/iohk/ethereum/network/p2p/messages/WireProtocol.scala

@@ -67,13 +67,13 @@ object WireProtocol {
     override val code: Int = Hello.code
 
     override def toString: String = {
-      s"""Hello {
-         |p2pVersion: $p2pVersion
-         |clientId: $clientId
-         |capabilities: $capabilities
-         |listenPort: $listenPort
-         |nodeId: ${Hex.toHexString(nodeId.toArray[Byte])}
-         |}""".stripMargin
+      s"Hello { " +
+        s"p2pVersion: $p2pVersion " +
+        s"clientId: $clientId " +
+        s"capabilities: $capabilities " +
+        s"listenPort: $listenPort " +
+        s"nodeId: ${Hex.toHexString(nodeId.toArray[Byte])} " +
+        s"}"
     }
   }
 
@@ -132,7 +132,7 @@ object WireProtocol {
     override val code: Int = Disconnect.code
 
     override def toString: String =
-      s"Disconnect(${Disconnect.reasonToString(reason)}"
+      s"Disconnect(${Disconnect.reasonToString(reason)})"
 
   }