ciri 0.0.0 → 0.0.1

data/lib/ciri/evm.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+
+
+require_relative 'evm/op'
+require_relative 'evm/vm'
+require_relative 'evm/account'
+require 'ciri/forks'
+
+module Ciri
+  class EVM
+
+    BLOCK_REWARD = 3 * 10.pow(18) # 3 ether
+
+    attr_reader :state
+
+    def initialize(state:)
+      @state = state
+    end
+
+    # run block
+    def finalize_block(block)
+      # validate block
+      # transition
+      # apply_changes
+    end
+
+    def validate_block(block)
+      # valid ommers
+      # valid transactions(block.gas_used == transactions...gas)
+      # Reward miner, ommers(reward == block reward + ommers reward)
+      # apply changes
+      # verify state and block nonce
+      # 1. parent header root == trie(state[i]) 当前状态的 root 相等, 返回 state[i] otherwise state[0]
+    end
+
+    # transition block
+    # block -> new block(mining)
+    # return new_block and status change
+    def transition(block)
+      # execute transactions, we don't need to valid transactions, it should be done before evm(in Chain module).
+      block.transactions.each do |transaction|
+        execute_transaction(transaction, header: block.header)
+      end
+      # status transfer
+      # state[c].balance += mining reward
+      # ommers: state[u.c].balance += uncle reward
+      #
+      # block.nonce
+      # block.mix
+      # R[i].gas_used = gas_used(state[i - 1], block.transactions[i]) + R[i - 1].gas_used
+      # R[i].logs = logs(state[i - 1], block.transactions[i])
+      # R[i].z = z(state[i - 1], block.transactions[i])
+    end
+
+    # execute transaction
+    # @param t Transaction
+    # @param header Chain::Header
+    def execute_transaction(t, header: nil, block_info: nil, ignore_exception: false)
+      instruction = Instruction.new(
+        origin: t.sender,
+        price: t.gas_price,
+        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
+        if (account = find_account t.to)
+          instruction.bytes_code = account.code
+          instruction.address = account.address
+        end
+        instruction.data = t.data
+      end
+
+      @vm = VM.spawn(
+        state: state,
+        gas_limit: t.gas_limit,
+        instruction: instruction,
+        header: header,
+        block_info: block_info,
+        fork_config: Ciri::Forks.detect_fork(header: header, number: block_info&.number)
+      )
+
+      if t.contract_creation?
+        # contract creation
+        @vm.create_contract(value: instruction.value, init: instruction.bytes_code)
+      else
+        # transact ether
+        begin
+          @vm.transact(sender: t.sender, value: t.value, to: t.to)
+        rescue VM::VMError
+          raise unless ignore_exception
+          return nil
+        end
+        @vm.run(ignore_exception: ignore_exception)
+      end
+      nil
+    end
+
+    def logs_hash
+      return nil unless @vm
+      Utils.sha3(RLP.encode_simple(@vm.sub_state.log_series))
+    end
+
+    private
+
+    def account_dead?(address)
+      Account.account_dead?(state, address)
+    end
+
+    def find_account(address)
+      Account.find_account(state, address)
+    end
+
+  end
+end

data/lib/ciri/evm/account.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+
+
+require 'ciri/utils'
+
+module Ciri
+  class EVM
+
+    Account = Struct.new(:address, :balance, :code, :nonce, :storage, keyword_init: true) do
+      # EMPTY(σ,a) ≡ σ[a]c =KEC􏰁()􏰂∧σ[a]n =0∧σ[a]b =0
+      def empty?
+        code == Utils::BLANK_SHA3 && nonce == 0 && balance == 0
+      end
+
+      def self.new_empty(address)
+        Account.new(address: address, balance: 0, nonce: 0, storage: {})
+      end
+
+      def self.find_account(state, address)
+        state[address.to_s] || new_empty(address.to_s)
+      end
+
+      def self.account_dead?(state, address)
+        account = state[address.to_s]
+        account.nil? || account.empty?
+      end
+    end
+
+  end
+end

data/lib/ciri/evm/block_info.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+
+
+module Ciri
+  class EVM
+
+    # Block Info
+    BlockInfo = Struct.new(:coinbase, :difficulty, :gas_limit, :number, :timestamp, keyword_init: true)
+
+  end
+end

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

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+
+
+require 'ciri/evm/op'
+
+module Ciri
+  class EVM
+    module Forks
+      module Frontier
+
+        module Cost
+          #   fee schedule, start with G
+          G_ZERO = 0
+          G_BASE = 2
+          G_VERYLOW = 3
+          G_LOW = 5
+          G_MID = 8
+          G_HIGH = 10
+          G_EXTCODE = 700
+          G_BALANCE = 400
+          G_SLOAD = 50
+          G_JUMPDEST = 1
+          G_SSET = 20000
+          G_RESET = 5000
+          R_SCLEAR = 15000
+          R_SELFDESTRUCT = 24000
+          G_SELFDESTRUCT = 0
+          G_CREATE = 32000
+          G_CODEDEPOSIT = 200
+          G_CALL = 700
+          G_CALLVALUE = 9000
+          G_CALLSTIPEND = 2300
+          G_NEWACCOUNT = 25000
+          G_EXP = 10
+          G_EXPBYTE = 10
+          G_MEMORY = 3
+          G_TXCREATE = 32000
+          G_TXDATAZERO = 4
+          G_TXDATANONZERO = 68
+          G_TRANSACTION = 21000
+          G_LOG = 375
+          G_LOGDATA = 8
+          G_TOPIC = 375
+          G_SHA3 = 30
+          G_SHA3WORD = 6
+          G_COPY = 3
+          G_BLOCKHASH = 20
+          G_QUADDIVISOR = 100
+
+          # operation code by group, for later calculation
+          W_ZERO = [OP::STOP, OP::RETURN, OP::REVERT]
+          W_BASE = [OP::ADDRESS, OP::ORIGIN, OP::CALLER, OP::CALLVALUE, OP::CALLDATASIZE, OP::CODESIZE, OP::GASPRICE,
+                    OP::COINBASE, OP::TIMESTAMP, OP::NUMBER, OP::DIFFICULTY, OP::GASLIMIT, OP::RETURNDATASIZE,
+                    OP::POP, OP::PC, OP::MSIZE, OP::GAS]
+          W_VERYLOW = [OP::ADD, OP::SUB, OP::NOT, OP::LT, OP::GT, OP::SLT, OP::SGT, OP::EQ, OP::ISZERO, OP::AND, OP::OR,
+                       OP::XOR, OP::BYTE, OP::CALLDATALOAD, OP::MLOAD, OP::MSTORE, OP::MSTORE8,
+                       *(1..32).map {|i| OP.get(OP::PUSH1 + i - 1).code}, # push1 - push32
+                       *(1..16).map {|i| OP.get(OP::DUP1 + i - 1).code}, # dup1 - dup16
+                       *(1..16).map {|i| OP.get(OP::SWAP1 + i - 1).code}] # swap1 - swap16
+          W_LOW = [OP::MUL, OP::DIV, OP::SDIV, OP::MOD, OP::SMOD, OP::SIGNEXTEND]
+          W_MID = [OP::ADDMOD, OP::MULMOD, OP::JUMP]
+          W_HIGH = [OP::JUMPI]
+          W_EXTCODE = [OP::EXTCODESIZE]
+
+
+          class << self
+            # C(σ,μ,I)
+            # calculate cost of current operation
+            def cost_of_operation(vm)
+              ms = vm.machine_state
+              instruction = vm.instruction
+              w = instruction.get_op(ms.pc)
+              if w == OP::SSTORE
+                cost_of_sstore(vm)
+              elsif w == OP::EXP && ms.get_stack(1, Integer) == 0
+                G_EXP
+              elsif w == OP::EXP && (x = ms.get_stack(1, Integer)) > 0
+                G_EXP + G_EXPBYTE * Utils.ceil_div(x.bit_length, 8)
+              elsif w == OP::CALLDATACOPY || w == OP::CODECOPY || w == OP::RETURNDATACOPY
+                G_VERYLOW + G_COPY * Utils.ceil_div(ms.get_stack(2, Integer), 32)
+              elsif w == OP::EXTCODECOPY
+                G_EXTCODE + G_COPY * Utils.ceil_div(ms.get_stack(3, Integer), 32)
+              elsif (OP::LOG0..OP::LOG4).include? w
+                G_LOG + G_LOGDATA * ms.get_stack(1, Integer) + (w - OP::LOG0) * G_TOPIC
+              elsif w == OP::CALL || w == OP::CALLCODE || w == OP::DELEGATECALL
+                1# cost_of_call(state, ms)
+              elsif w == OP::SELFDESTRUCT
+                cost_of_self_destruct(vm)
+              elsif w == OP::CREATE
+                G_CREATE
+              elsif w == OP::SHA3
+                G_SHA3 + G_SHA3WORD * Utils.ceil_div(ms.get_stack(1, Integer), 32)
+              elsif w == OP::JUMPDEST
+                G_JUMPDEST
+              elsif w == OP::SLOAD
+                G_SLOAD
+              elsif W_ZERO.include? w
+                G_ZERO
+              elsif W_BASE.include? w
+                G_BASE
+              elsif W_VERYLOW.include? w
+                G_VERYLOW
+              elsif W_LOW.include? w
+                G_LOW
+              elsif W_MID.include? w
+                G_MID
+              elsif W_HIGH.include? w
+                G_HIGH
+              elsif W_EXTCODE.include? w
+                G_EXTCODE
+              elsif w == OP::BALANCE
+                G_BALANCE
+              elsif w == OP::BLOCKHASH
+                G_BLOCKHASH
+              else
+                raise "can't compute cost for unknown op #{w}"
+              end
+            end
+
+            def cost_of_memory(i)
+              G_MEMORY * i + (i ** 2) / 512
+            end
+
+            def intrinsic_gas_of_transaction(t)
+              gas = (t.data.each_byte || '').reduce(0) {|sum, i| sum + i.zero? ? G_TXDATAZERO : G_TXDATANONZERO}
+              gas + (t.to.empty? ? G_TXCREATE : 0) + G_TRANSACTION
+            end
+
+            private
+
+            def cost_of_self_destruct(vm)
+              G_SELFDESTRUCT
+            end
+
+            def cost_of_call
+
+            end
+
+            def cost_of_sstore(vm)
+              ms = vm.machine_state
+              instruction = vm.instruction
+
+              key = ms.stack[0]
+              value = ms.stack[1]
+              account = vm.find_account instruction.address
+
+              value_exists = !Ciri::Utils.blank_binary?(value)
+              has_key = account && account.storage[key]
+
+              if value_exists && !has_key
+                G_SSET
+              else
+                G_RESET
+              end
+            end
+
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/ciri/evm/instruction.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2018, by 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:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# 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.
+
+
+module Ciri
+  class EVM
+
+    # represent instruction
+    Instruction = Struct.new(:address, :origin, :price, :data, :sender, :value, :bytes_code, :header, :execute_depth,
+                             keyword_init: true) do
+
+      def initialize(*args)
+        super
+        self.data ||= ''.b
+        self.value ||= 0
+        self.bytes_code ||= ''.b
+        self.execute_depth ||= 0
+      end
+
+      def get_op(pos)
+        return OP::INVALID if pos >= (bytes_code || ''.b).size
+        bytes_code[pos].ord
+      end
+
+      # get data from instruction
+      def get_code(pos, size = 1)
+        if size > 0 && pos < bytes_code.size && pos + size - 1 < bytes_code.size
+          bytes_code[pos..(pos + size - 1)]
+        else
+          "\x00".b * size
+        end
+      end
+
+      def get_data(pos, size)
+        if pos < data.size && size > 0
+          data[pos..(pos + size - 1)].ljust(size, "\x00".b)
+        else
+          "\x00".b * size
+        end
+      end
+
+      # valid destinations of bytes_code
+      def destinations
+        @destinations ||= destinations_by_index(bytes_code, 0)
+      end
+
+      def next_valid_instruction_pos(pos, op_code)
+        if (OP::PUSH1..OP::PUSH32).include?(op_code)
+          pos + op_code - OP::PUSH1 + 2
+        else
+          pos + 1
+        end
+      end
+
+      private
+
+      def destinations_by_index(bytes_code, i)
+        destinations = []
+        loop do
+          if i > bytes_code.size
+            break
+          elsif bytes_code[i] == OP::JUMPDEST
+            destinations << i
+          end
+          i = next_valid_instruction_pos(i, bytes_code[i])
+        end
+        destinations
+      end
+
+    end
+
+  end
+end