[ETCM-921] Add optional access lists to transactions (#1040)

* [ETCM-911] Rename Transaction to LegacyTransaction

* [ETCM-921] Introduce TypedTransaction ADT

* [ETCM-911] Use Transaction ADT in tooling

* [ETCM-911] Adjust unit tests with Transaction ADT

* [ETCM-911] Apply formatting rules

* Apply PR remarks

Author: dzajkowski

src/benchmark/scala/io/iohk/ethereum/rlp/RLPSpeedSuite.scala

@@ -11,8 +11,7 @@ import org.scalacheck.Gen
 import org.scalatest.funsuite.AnyFunSuite
 import org.scalatestplus.scalacheck.{ScalaCheckDrivenPropertyChecks, ScalaCheckPropertyChecks}
 
-/**
-  * Tests based on
+/** Tests based on
   *   - https://github.com/cryptape/ruby-rlp/blob/master/test/speed.rb
   *   - https://github.com/ethereum/pyrlp/blob/develop/tests/speed.py
   */
@@ -63,21 +62,21 @@ class RLPSpeedSuite
   }
 
   def doTestSerialize[T](toSerialize: T, encode: T => Array[Byte], rounds: Int): Array[Byte] = {
-    (1 until rounds).foreach(_ => {
+    (1 until rounds).foreach { _ =>
       encode(toSerialize)
-    })
+    }
     encode(toSerialize)
   }
 
   def doTestDeserialize[T](serialized: Array[Byte], decode: Array[Byte] => T, rounds: Int): T = {
-    (1 until rounds).foreach(_ => {
+    (1 until rounds).foreach { _ =>
       decode(serialized)
-    })
+    }
     decode(serialized)
   }
 
   val validTransaction = SignedTransaction(
-    Transaction(
+    LegacyTransaction(
       nonce = 172320,
       gasPrice = BigInt("50000000000"),
       gasLimit = 90000,

src/main/scala/io/iohk/ethereum/consensus/validators/std/StdSignedTransactionValidator.scala

@@ -42,7 +42,7 @@ class StdSignedTransactionValidator(blockchainConfig: BlockchainConfig) extends
     * @return Either the validated transaction or TransactionSyntaxError if an error was detected
     */
   private def checkSyntacticValidity(stx: SignedTransaction): Either[SignedTransactionError, SignedTransactionValid] = {
-    import Transaction._
+    import LegacyTransaction._
     import stx._
     import stx.tx._
 

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

@@ -50,7 +50,7 @@ object SignedTransaction {
   val valueForEmptyS = 0
 
   def apply(
-      tx: Transaction,
+      tx: LegacyTransaction,
       pointSign: Byte,
       signatureRandom: ByteString,
       signature: ByteString,
@@ -64,7 +64,12 @@ object SignedTransaction {
     SignedTransaction(tx, txSignature)
   }
 
-  def apply(tx: Transaction, pointSign: Byte, signatureRandom: ByteString, signature: ByteString): SignedTransaction = {
+  def apply(
+      tx: LegacyTransaction,
+      pointSign: Byte,
+      signatureRandom: ByteString,
+      signature: ByteString
+  ): SignedTransaction = {
     val txSignature = ECDSASignature(
       r = new BigInteger(1, signatureRandom.toArray),
       s = new BigInteger(1, signature.toArray),
@@ -73,11 +78,14 @@ object SignedTransaction {
     SignedTransaction(tx, txSignature)
   }
 
-  def sign(tx: Transaction, keyPair: AsymmetricCipherKeyPair, chainId: Option[Byte]): SignedTransactionWithSender = {
+  def sign(
+      tx: LegacyTransaction,
+      keyPair: AsymmetricCipherKeyPair,
+      chainId: Option[Byte]
+  ): SignedTransaction = {
     val bytes = bytesToSign(tx, chainId)
     val sig = ECDSASignature.sign(bytes, keyPair, chainId)
-    val address = Address(keyPair)
-    SignedTransactionWithSender(tx, sig, address)
+    SignedTransaction(tx, sig)
   }
 
   private def bytesToSign(tx: Transaction, chainId: Option[Byte]): Array[Byte] =
@@ -157,7 +165,7 @@ object SignedTransaction {
   }
 }
 
-case class SignedTransaction(tx: Transaction, signature: ECDSASignature) {
+case class SignedTransaction(tx: LegacyTransaction, signature: ECDSASignature) {
 
   def safeSenderIsEqualTo(address: Address): Boolean =
     SignedTransaction.getSender(this).contains(address)
@@ -184,6 +192,6 @@ object SignedTransactionWithSender {
       sender.fold(acc)(addr => SignedTransactionWithSender(stx, addr) :: acc)
     }
 
-  def apply(transaction: Transaction, signature: ECDSASignature, sender: Address): SignedTransactionWithSender =
+  def apply(transaction: LegacyTransaction, signature: ECDSASignature, sender: Address): SignedTransactionWithSender =
     SignedTransactionWithSender(SignedTransaction(transaction, signature), sender)
 }

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

@@ -4,7 +4,32 @@ import akka.util.ByteString
 
 import org.bouncycastle.util.encoders.Hex
 
+sealed trait Transaction {
+  def nonce: BigInt
+  def gasPrice: BigInt
+  def gasLimit: BigInt
+  def receivingAddress: Option[Address]
+  def value: BigInt
+  def payload: ByteString
+
+  def isContractInit: Boolean = receivingAddress.isEmpty
+
+  protected def receivingAddressString: String =
+    receivingAddress.map(_.toString).getOrElse("[Contract creation]")
+
+  protected def payloadString: String =
+    s"${if (isContractInit) "ContractInit: " else "TransactionData: "}${Hex.toHexString(payload.toArray[Byte])}"
+}
+
 object Transaction {
+  val Type01: Int = 1
+  val LegacyThresholdLowerBound: Int = 0xc0
+  val LegacyThresholdUpperBound: Int = 0xfe
+}
+
+sealed trait TypedTransaction extends Transaction
+
+object LegacyTransaction {
 
   val NonceLength = 32
   val GasLength = 32
@@ -17,33 +42,49 @@ object Transaction {
       receivingAddress: Address,
       value: BigInt,
       payload: ByteString
-  ): Transaction =
-    Transaction(nonce, gasPrice, gasLimit, Some(receivingAddress), value, payload)
+  ): LegacyTransaction =
+    LegacyTransaction(nonce, gasPrice, gasLimit, Some(receivingAddress), value, payload)
 
 }
 
-case class Transaction(
+case class LegacyTransaction(
     nonce: BigInt,
     gasPrice: BigInt,
     gasLimit: BigInt,
     receivingAddress: Option[Address],
     value: BigInt,
     payload: ByteString
-) {
-
-  def isContractInit: Boolean = receivingAddress.isEmpty
-
-  override def toString: String = {
-    val receivingAddressString =
-      receivingAddress.map(addr => Hex.toHexString(addr.toArray)).getOrElse("[Contract creation]")
+) extends Transaction {
+  override def toString: String =
+    s"LegacyTransaction {" +
+      s"nonce: $nonce " +
+      s"gasPrice: $gasPrice " +
+      s"gasLimit: $gasLimit " +
+      s"receivingAddress: $receivingAddressString " +
+      s"value: $value wei " +
+      s"payload: $payloadString " +
+      s"}"
+}
 
-    s"Transaction {" +
+case class TransactionWithAccessList(
+    nonce: BigInt,
+    gasPrice: BigInt,
+    gasLimit: BigInt,
+    receivingAddress: Option[Address],
+    value: BigInt,
+    payload: ByteString,
+    accessList: List[AccessListItem]
+) extends TypedTransaction {
+  override def toString: String =
+    s"TransactionWithAccessList {" +
       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"payload: $payloadString " +
+      s"accessList: $accessList" +
       s"}"
-  }
 }
+
+case class AccessListItem(address: Address, storageKeys: List[BigInt]) // bytes32

src/main/scala/io/iohk/ethereum/faucet/jsonrpc/WalletService.scala

@@ -7,7 +7,7 @@ import cats.data.EitherT
 import monix.eval.Task
 
 import io.iohk.ethereum.domain.Address
-import io.iohk.ethereum.domain.Transaction
+import io.iohk.ethereum.domain.LegacyTransaction
 import io.iohk.ethereum.faucet.FaucetConfig
 import io.iohk.ethereum.jsonrpc.client.RpcClient.RpcError
 import io.iohk.ethereum.keystore.KeyStore
@@ -36,7 +36,7 @@ class WalletService(walletRpcClient: WalletRpcClient, keyStore: KeyStore, config
 
   private def prepareTx(wallet: Wallet, targetAddress: Address, nonce: BigInt): ByteString = {
     val transaction =
-      Transaction(nonce, config.txGasPrice, config.txGasLimit, Some(targetAddress), config.txValue, ByteString())
+      LegacyTransaction(nonce, config.txGasPrice, config.txGasLimit, Some(targetAddress), config.txValue, ByteString())
 
     val stx = wallet.signTx(transaction, None)
     ByteString(rlp.encode(stx.tx.toRLPEncodable))

src/main/scala/io/iohk/ethereum/jsonrpc/EthInfoService.scala

@@ -175,7 +175,7 @@ class EthInfoService(
 
       val toAddress = req.tx.to.map(Address.apply)
 
-      val tx = Transaction(0, req.tx.gasPrice, gasLimit, toAddress, req.tx.value, req.tx.data)
+      val tx = LegacyTransaction(0, req.tx.gasPrice, gasLimit, toAddress, req.tx.value, req.tx.data)
       val fakeSignature = ECDSASignature(0, 0, 0.toByte)
       SignedTransactionWithSender(tx, fakeSignature, fromAddress)
     }

src/main/scala/io/iohk/ethereum/jsonrpc/TransactionRequest.scala

@@ -3,7 +3,7 @@ package io.iohk.ethereum.jsonrpc
 import akka.util.ByteString
 
 import io.iohk.ethereum.domain.Address
-import io.iohk.ethereum.domain.Transaction
+import io.iohk.ethereum.domain.LegacyTransaction
 import io.iohk.ethereum.utils.Config
 
 case class TransactionRequest(
@@ -19,8 +19,8 @@ case class TransactionRequest(
   private val defaultGasPrice: BigInt = 2 * BigInt(10).pow(10)
   private val defaultGasLimit: BigInt = 90000
 
-  def toTransaction(defaultNonce: BigInt): Transaction =
-    Transaction(
+  def toTransaction(defaultNonce: BigInt): LegacyTransaction =
+    LegacyTransaction(
       nonce = nonce.getOrElse(defaultNonce),
       gasPrice = gasPrice.getOrElse(defaultGasPrice),
       gasLimit = gasLimit.getOrElse(defaultGasLimit),

src/main/scala/io/iohk/ethereum/keystore/Wallet.scala

@@ -6,13 +6,13 @@ import org.bouncycastle.crypto.AsymmetricCipherKeyPair
 
 import io.iohk.ethereum.crypto._
 import io.iohk.ethereum.domain.Address
+import io.iohk.ethereum.domain.LegacyTransaction
 import io.iohk.ethereum.domain.SignedTransaction
 import io.iohk.ethereum.domain.SignedTransactionWithSender
-import io.iohk.ethereum.domain.Transaction
 
 case class Wallet(address: Address, prvKey: ByteString) {
   lazy val keyPair: AsymmetricCipherKeyPair = keyPairFromPrvKey(prvKey.toArray)
 
-  def signTx(tx: Transaction, chainId: Option[Byte]): SignedTransactionWithSender =
-    SignedTransaction.sign(tx, keyPair, chainId)
+  def signTx(tx: LegacyTransaction, chainId: Option[Byte]): SignedTransactionWithSender =
+    SignedTransactionWithSender(SignedTransaction.sign(tx, keyPair, chainId), Address(keyPair))
 }

src/main/scala/io/iohk/ethereum/ledger/BlockPreparator.scala

@@ -99,14 +99,14 @@ class BlockPreparator(
     * @param tx Target transaction
     * @return Upfront cost
     */
-  private[ledger] def calculateUpfrontGas(tx: Transaction): UInt256 = UInt256(tx.gasLimit * tx.gasPrice)
+  private[ledger] def calculateUpfrontGas(tx: LegacyTransaction): UInt256 = UInt256(tx.gasLimit * tx.gasPrice)
 
   /** v0 ≡ Tg (Tx gas limit) * Tp (Tx gas price) + Tv (Tx value). See YP equation number (65)
     *
     * @param tx Target transaction
     * @return Upfront cost
     */
-  private[ledger] def calculateUpfrontCost(tx: Transaction): UInt256 =
+  private[ledger] def calculateUpfrontCost(tx: LegacyTransaction): UInt256 =
     UInt256(calculateUpfrontGas(tx) + tx.value)
 
   /** Increments account nonce by 1 stated in YP equation (69) and

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

@@ -187,7 +187,7 @@ object BaseETH6XMessages {
             ) =>
           val receivingAddressOpt = if (receivingAddress.bytes.isEmpty) None else Some(Address(receivingAddress.bytes))
           SignedTransaction(
-            Transaction(nonce, gasPrice, gasLimit, receivingAddressOpt, value, payload),
+            LegacyTransaction(nonce, gasPrice, gasLimit, receivingAddressOpt, value, payload),
             (pointSign: Int).toByte,
             signatureRandom,
             signature,

src/main/scala/io/iohk/ethereum/utils/Picklers.scala

@@ -12,8 +12,8 @@ import io.iohk.ethereum.domain.BlockHeader
 import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields
 import io.iohk.ethereum.domain.BlockHeader.HeaderExtraFields._
 import io.iohk.ethereum.domain.Checkpoint
+import io.iohk.ethereum.domain.LegacyTransaction
 import io.iohk.ethereum.domain.SignedTransaction
-import io.iohk.ethereum.domain.Transaction
 
 object Picklers {
   implicit val byteStringPickler: Pickler[ByteString] =
@@ -30,9 +30,9 @@ object Picklers {
 
   implicit val addressPickler: Pickler[Address] =
     transformPickler[Address, ByteString](bytes => Address(bytes))(address => address.bytes)
-  implicit val transactionPickler: Pickler[Transaction] = generatePickler[Transaction]
+  implicit val transactionPickler: Pickler[LegacyTransaction] = generatePickler[LegacyTransaction]
   implicit val signedTransactionPickler: Pickler[SignedTransaction] =
-    transformPickler[SignedTransaction, (Transaction, ECDSASignature)] { case (tx, signature) =>
+    transformPickler[SignedTransaction, (LegacyTransaction, ECDSASignature)] { case (tx, signature) =>
       new SignedTransaction(tx, signature)
     }(stx => (stx.tx, stx.signature))
 

src/test/scala/io/iohk/ethereum/BlockHelpers.scala

@@ -23,7 +23,7 @@ object BlockHelpers extends SecureRandomBuilder {
     unixTimestamp = 0
   )
 
-  val defaultTx: Transaction = Transaction(
+  val defaultTx: LegacyTransaction = LegacyTransaction(
     nonce = 42,
     gasPrice = 1,
     gasLimit = 90000,
@@ -62,7 +62,7 @@ object BlockHelpers extends SecureRandomBuilder {
     val tx = defaultTx.copy(payload = randomHash())
     val stx = SignedTransaction.sign(tx, keyPair, None)
 
-    Block(header, BlockBody(List(stx.tx), List(ommer)))
+    Block(header, BlockBody(List(stx), List(ommer)))
   }
 
   def updateHeader(block: Block, updater: BlockHeader => BlockHeader): Block =