evm/src/test/kotlin/org/apache/tuweni/evm/EthereumVirtualMachineTest.kt

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.tuweni.evm

import org.apache.lucene.index.IndexWriter
import org.apache.tuweni.bytes.Bytes
import org.apache.tuweni.eth.Address
import org.apache.tuweni.eth.repository.BlockchainIndex
import org.apache.tuweni.eth.repository.BlockchainRepository
import org.apache.tuweni.junit.BouncyCastleExtension
import org.apache.tuweni.junit.LuceneIndexWriter
import org.apache.tuweni.junit.LuceneIndexWriterExtension
import org.apache.tuweni.kv.MapKeyValueStore
import org.apache.tuweni.units.bigints.UInt256
import org.apache.tuweni.units.ethereum.Gas
import org.apache.tuweni.units.ethereum.Wei
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Assumptions.assumeFalse
import org.junit.jupiter.api.BeforeAll
import org.junit.jupiter.api.Test
import org.junit.jupiter.api.extension.ExtendWith
import java.nio.charset.StandardCharsets

@ExtendWith(LuceneIndexWriterExtension::class, BouncyCastleExtension::class)
class EthereumVirtualMachineTest {

  companion object {
    @JvmStatic
    @BeforeAll
    fun checkOS() {
      val osName = System.getProperty("os.name").toLowerCase()
      val isWindows = osName.startsWith("windows")
      assumeFalse(isWindows, "No Windows binaries available")
    }
  }

  private val evmcFile: String
  private val exampleVm: String

  init {
    val osName = System.getProperty("os.name").toLowerCase()
    val isMacOs = osName.startsWith("mac os x")

    if (isMacOs) {
      evmcFile = EthereumVirtualMachine::class.java.getResource("/libevmc.dylib").file
      exampleVm = EthereumVirtualMachine::class.java.getResource("/libexample-vm.dylib").file
    } else {
      evmcFile = EthereumVirtualMachine::class.java.getResource("/libevmc.so").file
      exampleVm = EthereumVirtualMachine::class.java.getResource("/libexample-vm.so").file
    }
  }

  @Test
  fun testVersion(@LuceneIndexWriter writer: IndexWriter) {
    val repository = BlockchainRepository(
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      BlockchainIndex(writer)
    )
    val vm = EthereumVirtualMachine(repository, evmcFile, exampleVm)
    vm.start()
    assertEquals("0.0.0", vm.version())
    vm.stop()
  }

  @Test
  fun testExecuteCall(@LuceneIndexWriter writer: IndexWriter) {
    val result = runCode(writer, Bytes.fromHexString("0x30600052596000f3"))
    assertEquals(EVMExecutionStatusCode.EVMC_SUCCESS, result.statusCode)
    assertEquals(0, result.gasLeft)
  }

  @Test
  fun testExecuteCounter(@LuceneIndexWriter writer: IndexWriter) {
    val result = runCode(writer, Bytes.fromHexString("0x600160005401600055"))
    assertEquals(EVMExecutionStatusCode.EVMC_SUCCESS, result.statusCode)
    assertEquals(0, result.gasLeft)
  }

  @Test
  fun testExecuteReturnBlockNumber(@LuceneIndexWriter writer: IndexWriter) {
    val result = runCode(writer, Bytes.fromHexString("0x43600052596000f3"))
    assertEquals(EVMExecutionStatusCode.EVMC_SUCCESS, result.statusCode)
    assertEquals(100000, result.gasLeft)
  }

  @Test
  fun testExecuteSaveReturnBlockNumber(@LuceneIndexWriter writer: IndexWriter) {
    val result = runCode(writer, Bytes.fromHexString("0x4360005543600052596000f3"))
    assertEquals(EVMExecutionStatusCode.EVMC_SUCCESS, result.statusCode)
    assertEquals(100000, result.gasLeft)
  }

  @Test
  @Throws(Exception::class)
  fun testGetCapabilities(@LuceneIndexWriter writer: IndexWriter) {
    val repository = BlockchainRepository(
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      BlockchainIndex(writer)
    )
    val vm = EthereumVirtualMachine(repository, evmcFile, exampleVm)
    vm.start()
    assertTrue(vm.capabilities() > 0)
    vm.stop()
  }

  @Test
  @Throws(Exception::class)
  fun testSetOption(@LuceneIndexWriter writer: IndexWriter) {
    val repository = BlockchainRepository(
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      BlockchainIndex(writer)
    )
    val vm = EthereumVirtualMachine(repository, evmcFile, exampleVm, mapOf(Pair("verbose", "1")))
    vm.start()
    vm.stop()
  }

  @Test
  private fun testCreate(writer: IndexWriter) {
    val repository = BlockchainRepository(
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      BlockchainIndex(writer)
    )

    val vm = EthereumVirtualMachine(repository, evmcFile, exampleVm)
    vm.start()
    try {
      val sender = Address.fromHexString("0x3339626637316465316237643762653362353100")
      val destination = Address.fromBytes(Bytes.fromHexString("3533636637373230346545656639353265323500"))
      val value = Bytes.fromHexString("0x3100")
      val inputData = Bytes.wrap("hello w\u0000".toByteArray(StandardCharsets.UTF_8))
      val gas = Gas.valueOf(200000)
      val result =
        vm.execute(sender, destination, value, Bytes.fromHexString("0x00"), inputData, gas,
          Wei.valueOf(0),
          Address.fromBytes(Bytes.random(20)),
          0,
          0,
          2,
          UInt256.valueOf(1), CallKind.EVMC_CREATE)
      assertEquals(EVMExecutionStatusCode.EVMC_SUCCESS, result.statusCode)
      assertEquals(20000, result.gasLeft)
    } finally {
      vm.stop()
    }
  }

  private fun runCode(writer: IndexWriter, code: Bytes): EVMResult {
    val repository = BlockchainRepository(
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      MapKeyValueStore(),
      BlockchainIndex(writer)
    )

    val vm = EthereumVirtualMachine(repository, evmcFile, exampleVm)
    vm.start()
    try {
      val sender = Address.fromHexString("0x3339626637316465316237643762653362353100")
      val destination = Address.fromBytes(Bytes.fromHexString("3533636637373230346545656639353265323500"))
      val value = Bytes.fromHexString("0x3100")
      val inputData = Bytes.wrap("hello w\u0000".toByteArray(StandardCharsets.UTF_8))
      val gas = Gas.valueOf(200000)
      val result = vm.execute(sender, destination, value, code, inputData, gas,
        Wei.valueOf(0),
        Address.fromBytes(Bytes.random(20)),
        0,
        0,
        2,
        UInt256.valueOf(1))
      return result
    } finally {
      vm.stop()
    }
  }
}