evm-tx-input-decoder 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11939dbfa42b580fe869a7cd33784265d6a273e978077dca73592e77523e8899
+  data.tar.gz: 62e1f39ce8521f75a5c9d5261219f409e28ae40bce42d982c04bfeefb2b909c5
+SHA512:
+  metadata.gz: e299efb283d3c00107cbe730765603ce0a4fd52ba53099b15de3987bcf43ecad2bb72a182842b8f29e4f47212f5d89aeaa9559e9798d5f2457dd8aaadd110d10
+  data.tar.gz: 9c5fea8ca9640afe2456350e3c16ce91ff58925fb81f5ecf7bb2b1253e022e95f93ab2ace296e35be50fa877f61519dbcfb75fa64e1bb079f77dab0601eafb9a

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.7.0
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Style/Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-07-24
+
+- Initial release

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in evm-tx-input-decoder.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+gem 'rspec', '~> 3.0'
+gem 'rubocop', '~> 1.21'

data/Gemfile.lock

@@ -0,0 +1,81 @@
+PATH
+  remote: .
+  specs:
+    evm-tx-input-decoder (0.1.0)
+      eth (~> 0.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    eth (0.5.10)
+      keccak (~> 1.3)
+      konstructor (~> 1.0)
+      openssl (>= 2.2, < 4.0)
+      rbsecp256k1 (~> 5.1)
+      scrypt (~> 3.0)
+    ffi (1.15.5)
+    ffi-compiler (1.0.1)
+      ffi (>= 1.0.0)
+      rake
+    json (2.6.3)
+    keccak (1.3.1)
+    konstructor (1.0.2)
+    mini_portile2 (2.8.4)
+    openssl (3.1.0)
+    parallel (1.22.1)
+    parser (3.2.1.1)
+      ast (~> 2.4.1)
+    pkg-config (1.5.2)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    rbsecp256k1 (5.1.1)
+      mini_portile2 (~> 2.8)
+      pkg-config (~> 1.5)
+      rubyzip (~> 2.3)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    rubyzip (2.3.2)
+    scrypt (3.0.7)
+      ffi-compiler (>= 1.0, < 2.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  evm-tx-input-decoder!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ruslan Kotov
+
+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.

data/README.md

@@ -0,0 +1,67 @@
+# EVM Transactions Input Decoder
+
+This is a simple gem that helps decoding and encoding transactions input data for EVM based blockchains like Ethereum and Tron.
+
+## Installation
+Run
+```bash
+gem install evm-tx-input-decoder
+```
+or add
+```ruby
+gem 'evm-tx-input-decoder', require: 'evm_tx_input'
+```
+to your Gemfile.
+
+## Usage
+
+### Decoding
+Let's consider decoding process by example [USDT transaction](https://etherscan.io/tx/0x93ae1b191189aa27833b65f3668ae7704f9b7d9badabf4a9a16e53d84e1a3472) in an Ethereum blockchain.
+
+The input data is `0xa9059cbb00000000000000000000000003cb76e200ba785f6008c12933aa3640536d2011000000000000000000000000000000000000000000000000000000a083712e00`, which can be found in `More details` section.
+
+The USDT token ABI can be found by [this url](http://api.etherscan.io/api?module=contract&action=getabi&address=0xdac17f958d2ee523a2206206994597c13d831ec7&format=raw)
+
+```ruby
+require 'evm_tx'
+
+json = URI.open('http://api.etherscan.io/api?module=contract&action=getabi&address=0xdac17f958d2ee523a2206206994597c13d831ec7&format=raw') { |file| jsonfile.read }
+abi = JSON.parse(json)
+input = '0xa9059cbb00000000000000000000000003cb76e200ba785f6008c12933aa3640536d2011000000000000000000000000000000000000000000000000000000a083712e00'
+
+function = EvmTxInput::Decoder.new(abi).decode_input(input)
+function.id #=> "a9059cbb"
+function.name #=> "transfer"
+function.arguments
+# [#<EvmTxInput::Argument:0x00000001107ffa60 @name="_to", @type="address", @value="0x03cb76e200ba785f6008c12933aa3640536d2011">,
+#  #<EvmTxInput::Argument:0x00000001107ffa10 @name="_value", @type="uint256", @value=689400000000>]
+```
+
+### Encoding
+Following decoding procedure let's encode the previous result.
+
+```ruby
+require 'evm_tx'
+
+function_name = 'transfer'
+types = %w[address uint256]
+args = ['0x03cb76e200ba785f6008c12933aa3640536d2011', 689400000000]
+EvmTxInput::Encoder.encode_input(function_name, types, args)
+#=> "0xa9059cbb00000000000000000000000003cb76e200ba785f6008c12933aa3640536d2011000000000000000000000000000000000000000000000000000000a083712e00"
+```
+
+For more details read the [documentation](https://rubydoc.info/github/rkotov93/evm-tx-input-decoder/main/EvmTx).
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/rkotov93/evm-tx-input-decoder.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/evm-tx-input-decoder.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'lib/evm_tx_input/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'evm-tx-input-decoder'
+  spec.version = EvmTxInput::VERSION
+  spec.authors = ['Ruslan Kotov']
+  spec.email = ['rkotov93@gmail.com']
+
+  spec.summary = 'Simple gem to decode and encode EVM transactions input data'
+  spec.description = 'This is a simple gem that helps decoding and encoding transactions input data'\
+                     'for EVM based blockchains like Ethereum and Tron.'
+  spec.homepage = 'https://github.com/rkotov93/evm-tx-input-decoder'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  # spec.metadata['allowed_push_host'] = "Set to your gem server 'https://example.com'"
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/rkotov93/evm-tx-input-decoder'
+  spec.metadata['changelog_uri'] = 'https://github.com/rkotov93/evm-tx-input-decoder/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) || f.start_with?(*%w[bin/ test/ spec/ features/ .git .circleci appveyor])
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = %w[lib]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency 'eth', '~> 0.5'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/evm_tx_input/argument.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EvmTxInput
+  # Represents decoded smart contract function arguments
+  #
+  # @attr_reader name [String] name of function argument
+  # @attr_reader type [String] type of function argument
+  # @attr_reader value [String, Integer] value of function argument
+  class Argument
+    attr_reader :name, :type, :value
+
+    def initialize(name, type, value)
+      @name = name
+      @type = type
+      @value = value
+    end
+  end
+end

data/lib/evm_tx_input/decoder.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module EvmTxInput
+  # A class containing a set of helpers to decode transactions input data
+  # into human-readable values by provided contract's ABI
+  #
+  # @attr_reader abi [Hash] parsed contract ABI
+  # @attr_reader method_definition [Hash] parsed contract ABI
+  class Decoder
+    attr_reader :abi, :method_definitions
+
+    # Constructor of EvmTxInput::Decoder
+    #
+    # @param abi [Hash] parsed contract ABI
+    def initialize(abi = {})
+      @abi = abi
+      @method_definitions = method_definitions_by_id(abi)
+    end
+
+    # Decodes transaction input data
+    #
+    # @param input_data [String] binary encoded input data from transaction
+    # @return [EvmTxInput::Function]
+    def decode_input(input_data)
+      input_data = input_data[2..] if input_data.start_with?('0x')
+      method_id = input_data[0...8]
+      definition = method_definitions[method_id]
+      raise Error, "ABI does not contain method with #{method_id} ID" unless definition
+
+      Function.new(method_id, definition['name'], extract_arguments(input_data, definition))
+    end
+
+    private
+
+    def method_definitions_by_id(abi)
+      abi.each_with_object({}) do |method_definition, obj|
+        type = method_definition['type']
+        next if type == 'event'
+
+        method_id = calculate_method_id(method_definition)
+        obj[method_id] = method_definition
+      end
+    end
+
+    def calculate_method_id(method_definition)
+      function_name = method_definition['name']
+      arg_types = method_definition['inputs'].map { |input| input['type'] }.join(',')
+      function_signature = "#{function_name}(#{arg_types})"
+
+      Eth::Util.bin_to_hex(Eth::Util.keccak256(function_signature)[0...4])
+    end
+
+    def extract_arguments(input_data, definition)
+      args_data = input_data[8..]
+      arg_types = definition['inputs'].map { |input| input['type'] }
+      arg_values = Eth::Abi.decode(arg_types, args_data)
+
+      definition['inputs'].map.with_index do |input, i|
+        Argument.new(input['name'], input['type'], arg_values[i])
+      end
+    end
+  end
+end

data/lib/evm_tx_input/encoder.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module EvmTxInput
+  # A class containing a set of helpers to encode human-readable values
+  # to binary transactions input data
+  class Encoder
+    class << self
+      # Encodes function, types and arguments into binary input data
+      #
+      # @param function_name [String] the name of calling smart contract function, e.g. `transfer`
+      # @param types [Array<String>] list of argument types, e.g. `['address', 'uint256']`
+      # @param types [Array<String>] list of arguments, e.g. `['0x21a31ee1afc51d94c2efccaa2092ad1028285549', 100000]`
+      # @return [String] binary representation of input data
+      def encode_input(function_name, types = [], args = [])
+        encoded_function_signature = encode_function_signature(function_name, types)
+        encoded_params = encode_parameters(types, args)
+
+        "0x#{encoded_function_signature}#{encoded_params}"
+      end
+
+      # Encodes function into binary representation (first 8 symbols at input data)
+      #
+      # @param function_name [String] the name of calling smart contract function, e.g. `transfer`
+      # @param types [Array<String>] list of argument types, e.g. `['address', 'uint256']`
+      # @return [String] binary representation of function
+      def encode_function_signature(function_name, types = [])
+        function_signature = "#{function_name}(#{types.join(",")})"
+        Eth::Util.bin_to_hex(Eth::Util.keccak256(function_signature)[0...4])
+      end
+
+      # Encodes arguments into binary input data
+      #
+      # @param types [Array<String>] list of argument types, e.g. `['address', 'uint256']`
+      # @param types [Array<String>] list of arguments, e.g. `['0x21a31ee1afc51d94c2efccaa2092ad1028285549', 100000]`
+      # @return [String] binary representation of arguments
+      def encode_parameters(types = [], args = [])
+        Eth::Abi.encode(types, args).unpack1('H*')
+      end
+    end
+  end
+end

data/lib/evm_tx_input/error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EvmTxInput
+  class Error < StandardError; end
+end

data/lib/evm_tx_input/function.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EvmTxInput
+  # Represent decoded smart contract function call
+  #
+  # @attr_reader id [String] first 8 symbols of transaction input data
+  # @attr_reader name [String] name of smart contract function
+  # @attr_reader arguments [Array<EvmTxInput::Argument>] a list of function arguments
+  class Function
+    attr_reader :id, :name, :arguments
+
+    def initialize(id, name, arguments = [])
+      @id = id
+      @name = name
+      @arguments = arguments
+    end
+  end
+end

data/lib/evm_tx_input/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EvmTxInput
+  VERSION = '0.1.0'
+end

data/lib/evm_tx_input.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'eth'
+
+require_relative 'evm_tx_input/version'
+require_relative 'evm_tx_input/decoder'
+require_relative 'evm_tx_input/encoder'
+require_relative 'evm_tx_input/function'
+require_relative 'evm_tx_input/argument'
+require_relative 'evm_tx_input/error'
+
+module EvmTxInput
+  class Error < StandardError; end
+end

data/sig/evm_tx.rbs

@@ -0,0 +1,4 @@
+module EvmTxInput
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: evm-tx-input-decoder
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ruslan Kotov
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: This is a simple gem that helps decoding and encoding transactions input
+  datafor EVM based blockchains like Ethereum and Tron.
+email:
+- rkotov93@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- evm-tx-input-decoder.gemspec
+- lib/evm_tx_input.rb
+- lib/evm_tx_input/argument.rb
+- lib/evm_tx_input/decoder.rb
+- lib/evm_tx_input/encoder.rb
+- lib/evm_tx_input/error.rb
+- lib/evm_tx_input/function.rb
+- lib/evm_tx_input/version.rb
+- sig/evm_tx.rbs
+homepage: https://github.com/rkotov93/evm-tx-input-decoder
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rkotov93/evm-tx-input-decoder
+  source_code_uri: https://github.com/rkotov93/evm-tx-input-decoder
+  changelog_uri: https://github.com/rkotov93/evm-tx-input-decoder/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: Simple gem to decode and encode EVM transactions input data
+test_files: []