ciri 0.0.2 → 0.0.3

data/lib/ciri/evm.rb

@@ -1,46 +1,52 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+# Copyright 2018 Jiang Jinyang <https://justjjy.com>
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
+# Licensed 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
 #
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# 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.
 
 
 require 'forwardable'
 require 'ciri/forks'
+require 'ciri/core_ext'
+require 'ciri/utils'
 require_relative 'evm/op'
 require_relative 'evm/vm'
 require_relative 'evm/errors'
+require_relative 'evm/execution_context'
 require_relative 'types/account'
 require_relative 'types/receipt'
 
+using Ciri::CoreExt
+
 module Ciri
   class EVM
+    include Utils::Logger
     extend Forwardable
 
-    ExecutionResult = Struct.new(:status, :state_root, :logs, :gas_used, :gas_price, :exception, keyword_init: true)
+    ExecutionResult = Struct.new(:status, :state_root, :logs, :gas_used, :gas_price, :exception, keyword_init: true) do
+      def logs_hash
+        # return nil unless vm
+        Utils.keccak(RLP.encode_simple(logs))
+      end
+    end
 
     def_delegators :@state, :find_account, :account_dead?, :get_account_code, :state_root
 
-    attr_reader :state
+    attr_reader :state, :fork_schema
 
-    def initialize(state:)
+    def initialize(state:, fork_schema: Ciri::Forks::Frontier::Schema.new)
       @state = state
+      @fork_schema = fork_schema
     end
 
     # transition block
@@ -57,19 +63,9 @@ module Ciri
           raise InvalidTransition.new('reach block gas_limit')
         end
         if check_gas_used && total_gas_used > block.header.gas_used
-          raise InvalidTransition.new("incorrect gas_used, total_gas_used: #{total_gas_used}, block gas_used: #{block.header.gas_used}")
+          raise InvalidTransition.new("overflow header gas_used, total_gas_used: #{total_gas_used}, block gas_used: #{block.header.gas_used}")
         end
 
-        # calculate fee
-        fee = result.gas_used * result.gas_price
-
-        miner_account = find_account(block.header.beneficiary)
-        miner_account.balance += fee
-        state.set_balance(block.header.beneficiary, miner_account.balance)
-
-        # update actually state_root(after calculate fee)
-        result.state_root = state.state_root
-
         receipts << Types::Receipt.new(state_root: result.state_root, gas_used: total_gas_used, logs: result.logs)
       end
 
@@ -77,8 +73,7 @@ module Ciri
         raise InvalidTransition.new("incorrect gas_used, actual used: #{total_gas_used} header: #{block.header.gas_used}")
       end
 
-      fork_config = Ciri::Forks.detect_fork(header: block.header, number: block.header.number)
-      rewards = fork_config.mining_rewards_of_block(block)
+      rewards = fork_schema.mining_rewards_of_block(block)
 
       # apply rewards
       rewards.each do |address, value|
@@ -102,9 +97,13 @@ module Ciri
 
       # remove gas fee from account balance
       state.add_balance(t.sender, -1 * t.gas_limit * t.gas_price)
-      fork_config = Ciri::Forks.detect_fork(header: header, number: block_info&.number)
 
-      gas_limit = t.gas_limit - fork_config.intrinsic_gas_of_transaction(t)
+      intrinsic_gas = fork_schema.intrinsic_gas_of_transaction(t)
+      if intrinsic_gas > t.gas_limit
+        raise InvalidTransaction.new('intrinsic gas overflowed gas limit')
+      end
+
+      gas_limit = t.gas_limit - intrinsic_gas
 
       instruction = Instruction.new(
         origin: t.sender,
@@ -112,73 +111,66 @@ module Ciri
         sender: t.sender,
         value: t.value,
         header: header,
-        execute_depth: 0,
       )
 
       if t.contract_creation?
         instruction.bytes_code = t.data
-        instruction.address = t.sender
       else
         instruction.bytes_code = get_account_code(t.to)
         instruction.address = t.to
         instruction.data = t.data
       end
 
-      @vm = VM.spawn(
-        state: state,
-        gas_limit: gas_limit,
-        instruction: instruction,
-        header: header,
-        block_info: block_info,
-        fork_config: fork_config
+      block_info ||= header && BlockInfo.from_header(header)
+      context = Ciri::EVM::ExecutionContext.new(
+        instruction: instruction, gas_limit: gas_limit,
+        block_info: block_info, fork_schema: fork_schema
       )
+      vm = Ciri::EVM::VM.new(state: state, burn_gas_on_exception: true)
 
-      # transact ether
-      exception = nil
-      # begin
-      if t.contract_creation?
-        # contract creation
-        _, exception = @vm.create_contract(value: instruction.value, init: instruction.bytes_code)
-      else
-        _, _, exception = @vm.call_message(sender: t.sender, value: t.value, receipt: t.to, data: t.data)
-      end
-      # rescue ArgumentError => e
-      #   raise unless ignore_exception
-      #   exception = e
-      # end
-      raise exception if !ignore_exception && exception
-
-      # refund gas
-      refund_gas = fork_config.calculate_refund_gas(@vm)
-      gas_used = t.gas_limit - @vm.remain_gas
-      refund_gas = [refund_gas, gas_used / 2].min
-      state.add_balance(t.sender, (refund_gas + @vm.remain_gas) * t.gas_price)
-
-      # destroy accounts
-      @vm.sub_state.suicide_accounts.each do |address|
-        state.set_balance(address, 0)
-        state.delete_account(address)
+      unless instruction.value > state.find_account(instruction.sender).balance
+        state.increment_nonce(instruction.sender)
       end
 
-      ExecutionResult.new(status: @vm.status, state_root: state_root, logs: @vm.sub_state.log_series, gas_used: gas_used - refund_gas,
-                          gas_price: t.gas_price, exception: @vm.exception)
-    end
-
-    def logs_hash
-      # return nil unless @vm
-      Utils.sha3(RLP.encode_simple(vm.sub_state.log_series))
-    end
+      vm.with_context(context) do
+        if t.contract_creation?
+          # contract creation
+          vm.create_contract(context: context)
+        else
+          vm.call_message(context: context)
+        end
+        raise context.exception if !ignore_exception && context.exception
+
+        # refund gas
+        sub_state_refund_gas = fork_schema.calculate_refund_gas(vm)
+        context.refund_gas(sub_state_refund_gas)
+        refund_gas = context.reset_refund_gas
+        remain_gas = context.remain_gas
+        actually_gas_used = t.gas_limit - remain_gas
+        actually_refund_gas = [refund_gas, actually_gas_used / 2].min
+        refund_gas_amount = (actually_refund_gas + remain_gas) * t.gas_price
+        debug("Transaction refund #{refund_gas_amount} to #{t.sender.to_s.to_hex}")
+        state.add_balance(t.sender, refund_gas_amount)
+
+        # gas_used after refund gas
+        gas_used = actually_gas_used - actually_refund_gas
+
+        # miner fee
+        fee = gas_used * t.gas_price
+        debug("Transaction fee #{fee}")
+        miner_account = find_account(block_info.coinbase)
+        miner_account.balance += fee
+        state.set_balance(block_info.coinbase, miner_account.balance)
 
-    private
+        # destroy accounts
+        vm.execution_context.all_suicide_accounts.each do |address|
+          state.set_balance(address, 0)
+          state.delete_account(address)
+        end
 
-    def vm
-      @vm ||= VM.spawn(
-        state: state,
-        gas_limit: 0,
-        instruction: nil,
-        block_info: BlockInfo.new,
-        fork_config: nil
-      )
+        ExecutionResult.new(status: context.status, state_root: state_root, logs: context.all_log_series,
+                            gas_used: gas_used, gas_price: t.gas_price, exception: context.exception)
+      end
     end
 
   end

data/lib/ciri/forks/base.rb

@@ -1,24 +1,18 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+# Copyright 2018 Jiang Jinyang <https://justjjy.com>
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
+# Licensed 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
 #
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# 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.
 
 
 module Ciri
@@ -34,6 +28,10 @@ module Ciri
         raise NotImplementedError
       end
 
+      def gas_of_call(vm:, gas:, to:, value:)
+        raise NotImplementedError
+      end
+
       def intrinsic_gas_of_transaction(transaction)
         raise NotImplementedError
       end
@@ -49,6 +47,20 @@ module Ciri
       def calculate_refund_gas(vm)
         raise NotImplementedError
       end
+
+      # chain difficulty method
+      def difficulty_time_factor(header, parent_header)
+        raise NotImplementedError
+      end
+
+      def difficulty_virtual_height(height)
+        raise NotImplementedError
+      end
+
+      # EVM op code and contract
+      def find_precompile_contract(address)
+        raise NotImplementedError
+      end
     end
 
   end

data/lib/ciri/forks/byzantium.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Jiang Jinyang <https://justjjy.com>
+#
+# Licensed 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.
+
+
+require_relative 'base'
+require_relative 'homestead'
+
+module Ciri
+  module Forks
+    module Byzantium
+      class Schema < Forks::Frontier::Schema
+
+        include Forks::Frontier::Cost
+
+        # chain difficulty method
+        # https://github.com/ethereum/EIPs/blob/181867ae830df5419eb9982d2a24797b2dcad28f/EIPS/eip-609.md
+        # https://github.com/ethereum/EIPs/blob/984cf5de90bbf5fbe7e49be227b0c2f9567e661e/EIPS/eip-100.md
+        def difficulty_time_factor(header, parent_header)
+          y = header.ommers_hash == Utils::BLANK_SHA3 ? 1 : 2
+          [y - (header.timestamp - parent_header.timestamp) / 9, -99].max
+        end
+
+        def difficulty_virtual_height(height)
+          [(height - 3000000), 0].max
+        end
+
+      end
+    end
+  end
+end

data/lib/ciri/forks/config.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Copyright 2018 Jiang Jinyang <https://justjjy.com>
+#
+# Licensed 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.
+
+module Ciri
+  module Forks
+
+    class Config
+
+      # @schema_rule [[0, Frontier], [100, Homestead]]
+      def initialize(schema_rules)
+        @schema_rules = schema_rules
+      end
+
+      def choose_fork(number)
+        @schema_rules.reverse_each.find do |start_number, _schema|
+          number >= start_number
+        end[1]
+      end
+
+    end
+
+  end
+end

data/lib/ciri/forks/frontier/cost.rb

@@ -1,24 +1,18 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+# Copyright 2018 Jiang Jinyang <https://justjjy.com>
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
+# Licensed 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
 #
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# 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.
 
 
 require 'ciri/evm/op'
@@ -38,8 +32,8 @@ module Ciri
         G_LOW = 5
         G_MID = 8
         G_HIGH = 10
-        G_EXTCODE = 700
-        G_BALANCE = 400
+        G_EXTCODE = 20
+        G_BALANCE = 20
         G_SLOAD = 50
         G_JUMPDEST = 1
         G_SSET = 20000
@@ -49,7 +43,7 @@ module Ciri
         G_SELFDESTRUCT = 0
         G_CREATE = 32000
         G_CODEDEPOSIT = 200
-        G_CALL = 700
+        G_CALL = 40
         G_CALLVALUE = 9000
         G_CALLSTIPEND = 2300
         G_NEWACCOUNT = 25000
@@ -93,7 +87,7 @@ module Ciri
           def cost_of_operation(vm)
             ms = vm.machine_state
             instruction = vm.instruction
-            w = instruction.get_op(ms.pc)
+            w = instruction.get_op(vm.pc)
             if w == SSTORE
               cost_of_sstore(vm)
             elsif w == EXP && ms.get_stack(1, Integer) == 0
@@ -107,7 +101,7 @@ module Ciri
             elsif (LOG0..LOG4).include? w
               G_LOG + G_LOGDATA * ms.get_stack(1, Integer) + (w - LOG0) * G_TOPIC
             elsif w == CALL || w == CALLCODE || w == DELEGATECALL
-              1 # cost_of_call(state, ms)
+              G_CALL
             elsif w == SELFDESTRUCT
               cost_of_self_destruct(vm)
             elsif w == CREATE
@@ -151,14 +145,22 @@ module Ciri
             gas + G_TRANSACTION
           end
 
-          private
+          def gas_of_call(vm:, gas:, to:, value:)
+            # TODO handle gas calculation for all categories calls
+            account_exists = vm.account_exist?(to)
+            transfer_gas_fee = value > 0 ? G_CALLVALUE : 0
+            create_gas_fee = !account_exists ? G_NEWACCOUNT : 0
+            extra_gas = transfer_gas_fee + create_gas_fee
 
-          def cost_of_self_destruct(vm)
-            G_SELFDESTRUCT
+            total_fee = gas + extra_gas
+            child_gas_limit = gas + (value > 0 ? G_CALLSTIPEND : 0)
+            [child_gas_limit, total_fee]
           end
 
-          def cost_of_call
+          private
 
+          def cost_of_self_destruct(vm)
+            G_SELFDESTRUCT
           end
 
           def cost_of_sstore(vm)
@@ -168,14 +170,21 @@ module Ciri
             key = ms.get_stack(0, Integer)
             value = ms.get_stack(1, Integer)
 
-            stored_is_empty = vm.fetch(instruction.address, key).zero?
-            value_is_non_zero = value && !value.zero?
-
-            if value_is_non_zero && stored_is_empty
-              G_SSET
-            else
-              G_RESET
-            end
+            current_is_empty = vm.fetch(instruction.address, key).zero?
+            value_is_empty = value.nil? || value.zero?
+
+            gas_cost = if current_is_empty && !value_is_empty
+                         G_SSET
+                       else
+                         G_RESET
+                       end
+            gas_refund = if !current_is_empty && value_is_empty
+                           R_SCLEAR
+                         else
+                           0
+                         end
+
+            [gas_cost, gas_refund]
           end
 
         end

data/lib/ciri/forks/frontier.rb

@@ -1,33 +1,31 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2018, by Jiang Jinyang. <https://justjjy.com>
+# Copyright 2018 Jiang Jinyang <https://justjjy.com>
 #
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
+# Licensed 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
 #
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
+#     http://www.apache.org/licenses/LICENSE-2.0
 #
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
+# 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.
 
 
 require_relative 'base'
 require_relative 'frontier/cost'
+require 'ciri/core_ext'
+require 'ciri/evm/precompile_contract'
+
+using Ciri::CoreExt
 
 module Ciri
   module Forks
     module Frontier
-      class Config < Base
+      class Schema < Base
 
         BLOCK_REWARD = 5 * 10.pow(18) # 5 ether
 
@@ -40,6 +38,10 @@ module Ciri
           Cost.cost_of_memory word_count
         end
 
+        def gas_of_call(vm:, gas:, to:, value:)
+          Cost.gas_of_call(vm: vm, gas: gas, to: to, value: value)
+        end
+
         def intrinsic_gas_of_transaction(transaction)
           Cost.intrinsic_gas_of_transaction transaction
         end
@@ -49,7 +51,7 @@ module Ciri
         end
 
         def calculate_refund_gas(vm)
-          vm.sub_state.suicide_accounts.size * Cost::R_SELFDESTRUCT
+          vm.execution_context.all_suicide_accounts.size * Cost::R_SELFDESTRUCT
         end
 
         def mining_rewards_of_block(block)
@@ -64,6 +66,33 @@ module Ciri
           rewards
         end
 
+        def validate_transaction(transaction)
+          unless transaction.v >= 27 && transaction.v <= 28
+            "v can be only 27 or 28 in frontier schema, found: #{transaction.v}"
+          end
+        end
+
+        # chain difficulty method
+        def difficulty_time_factor(header, parent_header)
+          (header.timestamp - parent_header.timestamp) < 13 ? 1 : -1
+        end
+
+        def difficulty_virtual_height(height)
+          height
+        end
+
+        PRECOMPILE_CONTRACTS = {
+          "\x01".pad_zero(20).b => EVM::PrecompileContract::ECRecover.new,
+          "\x02".pad_zero(20).b => EVM::PrecompileContract::SHA256.new,
+          "\x03".pad_zero(20).b => EVM::PrecompileContract::RIPEMD160.new,
+          "\x04".pad_zero(20).b => EVM::PrecompileContract::Identity.new,
+        }.freeze
+
+        # EVM op code and contract
+        def find_precompile_contract(address)
+          PRECOMPILE_CONTRACTS[address.to_s]
+        end
+
       end
     end
   end