abi_coder_rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72266c6750d4c8e137acebdc790350c7862d9c84453f1af99b1aaa9ee5e775f7
+  data.tar.gz: 045aa60cc688c8537290ffff047df35ceb17db5de978d8943d7db9b0725ca9af
+SHA512:
+  metadata.gz: 19822e060b76e17667c3deccf9ba9f2697b51b1ec0825fda594a6d4fcc3f3ed617ca15db6354b4e8702e994cadc58ee221b2b4823b5e93371bc2effd4858b3fc
+  data.tar.gz: 863775a35f5819bddee87bcfe0cbaafc0b59042c98eeff8c9ceaa254ae3e9543c2a8df95660a40e4ac25aa8902f04b50b8493762e729f8141bc35b216e3ea704

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at wuminzhe@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,61 @@
+PATH
+  remote: .
+  specs:
+    abi_coder_rb (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
+    parallel (1.23.0)
+    parser (3.2.2.4)
+      ast (~> 2.4.1)
+      racc
+    racc (1.7.3)
+    rainbow (3.1.1)
+    rake (13.1.0)
+    regexp_parser (2.8.2)
+    rexml (3.2.6)
+    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.6)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.1)
+    rubocop (1.57.2)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.2.2.4)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.30.0)
+      parser (>= 3.2.1.0)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  abi_coder_rb!
+  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 Aki Wu
+
+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,39 @@
+# AbiCoderRb
+
+modified from https://github.com/rubycocos/blockchain/blob/master/abicoder
+
+for better readability code and deep learning abi codec.
+
+The most significant difference from the original code is that 'data' to decode in every decode_* function is no longer exact but now includes both the data needed for decoding and the remaining data. This change means that in the entry point('AbiCoderRb.decode'), there's no longer a need to calculate the precise data required for decoding for each type. This simplification streamlines the code.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add abi_coder_rb
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install abi_coder_rb
+
+## Usage
+
+See tests
+
+## 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/wuminzhe/abi_coder_rb. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/abi_coder_rb/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the AbiCoderRb project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/abi_coder_rb/blob/main/CODE_OF_CONDUCT.md).

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/lib/abi_coder_rb/decode/decode_array.rb

@@ -0,0 +1,21 @@
+module AbiCoderRb
+  def decode_array(type, data)
+    l = decode_uint256(data[0, 32])
+    raise DecodingError, "Too long length: #{l}" if l > 100_000
+
+    subtype = type.subtype
+
+    if subtype.dynamic?
+      raise DecodingError, "Not enough data for head" unless data.size >= 32 + 32 * l
+
+      start_positions = (1..l).map { |i| 32 + decode_uint256(data[32 * i, 32]) }
+      start_positions.push(data.size)
+
+      outputs = (0...l).map { |i| data[start_positions[i]...start_positions[i + 1]] }
+
+      outputs.map { |out| decode_type(subtype, out) }
+    else
+      (0...l).map { |i| decode_type(subtype, data[(32 + subtype.size * i)..]) }
+    end
+  end
+end

data/lib/abi_coder_rb/decode/decode_fixed_array.rb

@@ -0,0 +1,16 @@
+module AbiCoderRb
+  def decode_fixed_array(type, data)
+    l = type.dim
+    subtype = type.subtype
+    if subtype.dynamic?
+      start_positions = (0...l).map { |i| decode_uint256(data[32 * i, 32]) }
+      start_positions.push(data.size)
+
+      outputs = (0...l).map { |i| data[start_positions[i]...start_positions[i + 1]] }
+
+      outputs.map { |out| decode_type(subtype, out) }
+    else
+      (0...l).map { |i| decode_type(subtype, data[subtype.size * i, subtype.size]) }
+    end
+  end
+end

data/lib/abi_coder_rb/decode/decode_primitive_type.rb

@@ -0,0 +1,35 @@
+module AbiCoderRb
+  def decode_primitive_type(type, data)
+    case type
+    when Uint
+      decode_uint256(data[0, 32])
+    when Int
+      u = decode_uint256(data[0, 32])
+      u >= 2**(type.bits - 1) ? (u - 2**type.bits) : u
+    when Bool
+      data[31] == BYTE_ONE
+    when String
+      size = decode_uint256(data[0, 32])
+      data[32...(32 + size)].force_encoding(Encoding::UTF_8)
+    when Bytes
+      size = decode_uint256(data[0, 32])
+      data[32...(32 + size)]
+    when FixedBytes
+      data[0, type.length]
+    when Address
+      data[12...32].unpack1("H*").force_encoding(Encoding::UTF_8)
+    else
+      raise DecodingError, "Unknown primitive type: #{type.class.name} #{type.format}"
+    end
+  end
+
+  private
+
+  def decode_uint256(bin)
+    # bin = bin.sub( /\A(\x00)+/, '' )   ## keep "performance" shortcut - why? why not?
+    ### todo/check - allow nil - why? why not?
+    ##  raise DeserializationError, "Invalid serialization (not minimal length)" if !@size && serial.size > 0 && serial[0] == BYTE_ZERO
+    # bin = bin || BYTE_ZERO
+    bin.unpack1("H*").to_i(16)
+  end
+end

data/lib/abi_coder_rb/decode/decode_tuple.rb

@@ -0,0 +1,5 @@
+module AbiCoderRb
+  def decode_tuple(type, data)
+    decode_types(type.types, data)
+  end
+end

data/lib/abi_coder_rb/decode.rb

@@ -0,0 +1,57 @@
+require_relative "decode/decode_tuple"
+require_relative "decode/decode_fixed_array"
+require_relative "decode/decode_array"
+require_relative "decode/decode_primitive_type"
+
+module AbiCoderRb
+  def decode(types, data)
+    # Convert types to ABI::Type if they are not already
+    types = types.map { |type| type.is_a?(Type) ? type : Type.parse(type) }
+
+    decode_types(types, data)
+  end
+
+  private
+
+  def decode_type(type, data)
+    return nil if data.nil? || data.empty?
+
+    case type
+    when Tuple ## todo: support empty (unit) tuple - why? why not?
+      decode_tuple(type, data)
+    when FixedArray # static-sized arrays
+      decode_fixed_array(type, data)
+    when Array
+      decode_array(type, data)
+    else
+      decode_primitive_type(type, data)
+    end
+  end
+
+  def decode_types(types, data)
+    start_positions = start_positions(types, data)
+
+    types.map.with_index do |type, index|
+      start_position = start_positions[index]
+      decode_type(type, data[start_position..])
+    end
+  end
+
+  def start_positions(types, data)
+    start_positions = ::Array.new(types.size)
+    offset = 0
+
+    types.each_with_index do |type, index|
+      if type.dynamic?
+        # 读取动态类型的偏移量
+        start_positions[index] = decode_uint256(data[offset, 32])
+        offset += 32
+      else
+        start_positions[index] = offset
+        offset += type.size
+      end
+    end
+
+    start_positions
+  end
+end

data/lib/abi_coder_rb/encode/encode_array.rb

@@ -0,0 +1,22 @@
+module AbiCoderRb
+  def encode_array(type, args)
+    raise ArgumentError, "arg must be an array" unless args.is_a?(::Array)
+
+    head = "".b
+    tail = "".b # 使用二进制字符串
+
+    head += encode_uint256(args.size)
+
+    subtype = type.subtype
+    args.each do |arg|
+      if subtype.dynamic?
+        head += encode_uint256(32 * args.size + tail.size)
+        tail += encode_type(subtype, arg)
+      else
+        head += encode_type(subtype, arg)
+      end
+    end
+
+    head + tail
+  end
+end

data/lib/abi_coder_rb/encode/encode_fixed_array.rb

@@ -0,0 +1,8 @@
+module AbiCoderRb
+  def encode_fixed_array(type, args)
+    raise ArgumentError, "arg must be an array" unless args.is_a?(::Array)
+    raise ArgumentError, "Wrong array size: found #{args.size}, expecting #{type.dim}" unless args.size == type.dim
+
+    args.map { |arg| encode_type(type.subtype, arg) }.join
+  end
+end

data/lib/abi_coder_rb/encode/encode_primitive_type.rb

@@ -0,0 +1,146 @@
+module AbiCoderRb
+  def encode_primitive_type(type, arg)
+    # 根据类型选择相应的编码方法
+    case type
+    when Uint
+      # NOTE: for now size in  bits always required
+      encode_uint(arg, type.bits)
+    when Int
+      # NOTE: for now size in  bits always required
+      encode_int(arg, type.bits)
+    when Bool
+      encode_bool(arg)
+    when String
+      encode_string(arg)
+    when FixedBytes
+      encode_bytes(arg, type.length)
+    when Bytes
+      encode_bytes(arg)
+    when Address
+      encode_address(arg)
+    else
+      raise EncodingError, "Unknown type: #{type}"
+    end
+  end
+
+  def encode_uint(arg, bits)
+    raise ArgumentError, "arg is not integer: #{arg}" unless arg.is_a?(Integer)
+    raise ValueOutOfBounds, arg unless arg >= 0 && arg < 2**bits
+
+    lpad_int(arg)
+  end
+
+  def encode_uint256(arg)
+    encode_uint(arg, 256)
+  end
+
+  def encode_int(arg, bits)
+    ## raise EncodingError or ArgumentError - why? why not?
+    raise ArgumentError, "arg is not integer: #{arg}" unless arg.is_a?(Integer)
+    raise ValueOutOfBounds, arg unless arg >= -2**(bits - 1) && arg < 2**(bits - 1)
+
+    lpad_int(arg % 2**bits)
+  end
+
+  def encode_bool(arg)
+    ## raise EncodingError or ArgumentError - why? why not?
+    raise ArgumentError, "arg is not bool: #{arg}" unless arg.is_a?(TrueClass) || arg.is_a?(FalseClass)
+
+    lpad(arg ? BYTE_ONE : BYTE_ZERO) ## was  lpad_int( arg ? 1 : 0 )
+  end
+
+  def encode_string(arg)
+    ## raise EncodingError or ArgumentError - why? why not?
+    raise EncodingError, "Expecting string: #{arg}" unless arg.is_a?(::String)
+
+    arg = arg.b if arg.encoding != Encoding::BINARY ## was: name == 'UTF-8'
+
+    raise ValueOutOfBounds, "Integer invalid or out of range: #{arg.size}" if arg.size > UINT_MAX
+
+    size  =  lpad_int(arg.size)
+    value =  rpad(arg, ceil32(arg.size))
+    size + value
+  end
+
+  def encode_bytes(arg, length = nil)
+    ## raise EncodingError or ArgumentError - why? why not?
+    raise EncodingError, "Expecting string: #{arg}" unless arg.is_a?(::String)
+
+    arg = arg.b if arg.encoding != Encoding::BINARY
+
+    if length # fixed length type
+      raise ValueOutOfBounds, "invalid bytes length #{length}" if arg.size > length
+      raise ValueOutOfBounds, "invalid bytes length #{length}" if length < 0 || length > 32
+
+      rpad(arg)
+    else # variable length type  (if length is nil)
+      raise ValueOutOfBounds, "Integer invalid or out of range: #{arg.size}" if arg.size > UINT_MAX
+
+      size =  lpad_int(arg.size)
+      value = rpad(arg, ceil32(arg.size))
+      size + value
+    end
+  end
+
+  def encode_address(arg)
+    if arg.is_a?(Integer)
+      lpad_int(arg)
+    elsif arg.size == 20
+      ## note: make sure encoding is always binary!!!
+      arg = arg.b if arg.encoding != Encoding::BINARY
+      lpad(arg)
+    elsif arg.size == 40
+      lpad_hex(arg)
+    elsif arg.size == 42 && arg[0, 2] == "0x" ## todo/fix: allow 0X too - why? why not?
+      lpad_hex(arg[2..-1])
+    else
+      raise EncodingError, "Could not parse address: #{arg}"
+    end
+  end
+
+  private
+
+  ###########
+  #  encoding helpers / utils
+  #    with "hard-coded" fill symbol as BYTE_ZERO
+
+  def rpad(bin, l = 32) ## note: same as builtin String#ljust !!!
+    # note: default l word is 32 bytes
+    return bin if bin.size >= l
+
+    bin + BYTE_ZERO * (l - bin.size)
+  end
+
+  ## rename to lpad32 or such - why? why not?
+  def lpad(bin) ## note: same as builtin String#rjust !!!
+    l = 32 # NOTE: default l word is 32 bytes
+    return bin  if bin.size >= l
+
+    BYTE_ZERO * (l - bin.size) + bin
+  end
+
+  ## rename to lpad32_int or such - why? why not?
+  def lpad_int(n)
+    raise ArgumentError, "Integer invalid or out of range: #{n}" unless n.is_a?(Integer) && n >= 0 && n <= UINT_MAX
+
+    hex = n.to_s(16)
+    hex = "0" + hex if hex.size.odd?
+    bin = [hex].pack("H*")
+
+    lpad(bin)
+  end
+
+  ## rename to lpad32_hex or such - why? why not?
+  def lpad_hex(hex)
+    raise TypeError, "Value must be a string" unless hex.is_a?(::String)
+    raise TypeError, "Non-hexadecimal digit found" unless hex =~ /\A[0-9a-fA-F]*\z/
+
+    bin = [hex].pack("H*")
+
+    lpad(bin)
+  end
+
+  def ceil32(x)
+    x % 32 == 0 ? x : (x + 32 - x % 32)
+  end
+end

data/lib/abi_coder_rb/encode/encode_tuple.rb

@@ -0,0 +1,5 @@
+module AbiCoderRb
+  def encode_tuple(tuple, args)
+    encode_types(tuple.types, args)
+  end
+end

data/lib/abi_coder_rb/encode.rb

@@ -0,0 +1,59 @@
+require_relative "encode/encode_tuple"
+require_relative "encode/encode_fixed_array"
+require_relative "encode/encode_array"
+require_relative "encode/encode_primitive_type"
+
+module AbiCoderRb
+  ##
+  # Encodes multiple arguments using the head/tail mechanism.
+  #     returns binary string (with BINARY / ASCII_8BIT encoding)
+  #
+  def encode(types, args)
+    # 如果 types 是字符串，则转换为 ABI::Type 实例
+    types = types.map { |type| type.is_a?(Type) ? type : Type.parse(type) }
+
+    encode_types(types, args)
+  end
+
+  private
+
+  def encode_type(type, arg)
+    if type.is_a?(Tuple)
+      encode_tuple(type, arg)
+    elsif type.is_a?(Array) || type.is_a?(FixedArray)
+      type.dynamic? ? encode_array(type, arg) : encode_fixed_array(type, arg)
+    else
+      encode_primitive_type(type, arg)
+    end
+  end
+
+  def encode_types(types, args)
+    raise ArgumentError, "args must be an array" unless args.is_a?(::Array)
+
+    unless args.size == types.size
+      raise ArgumentError,
+            "Wrong number of args: found #{args.size}, expecting #{types.size}"
+    end
+
+    # 计算头部大小
+    head_size = types.map { |type| type.size || 32 }.sum
+
+    # 初始化头部和尾部
+    head = "".b
+    tail = "".b # 使用二进制字符串
+
+    # 遍历类型并编码
+    types.each_with_index do |type, i|
+      if type.dynamic?
+        # 动态类型: 更新头部和尾部
+        head += encode_uint256(head_size + tail.size)
+        tail += encode_type(type, args[i])
+      else
+        # 静态类型: 只更新头部
+        head += encode_type(type, args[i])
+      end
+    end
+
+    head + tail
+  end
+end

data/lib/abi_coder_rb/parser.rb

@@ -0,0 +1,149 @@
+module AbiCoderRb
+  class Type
+    class ParseError < StandardError; end
+
+    ## nested inside Type - why? why not?
+    class Parser
+      TUPLE_TYPE_RX = /^\((.*)\)
+                       ((\[[0-9]*\])*)
+                     /x
+
+      def self.parse(type)
+        if type =~ TUPLE_TYPE_RX
+          types = _parse_tuple_type(::Regexp.last_match(1))
+          dims = _parse_dims(::Regexp.last_match(2))
+
+          parsed_types = types.map { |t| parse(t) }
+
+          return _parse_array_type(Tuple.new(parsed_types), dims)
+        end
+
+        base, sub, dims = _parse_base_type(type)
+
+        _validate_base_type(base, sub)
+
+        subtype =  case base
+                   when "string"  then   String.new
+                   when "bytes"   then   sub ? FixedBytes.new(sub) : Bytes.new
+                   when "uint"    then   Uint.new(sub)
+                   when "int"     then   Int.new(sub)
+                   when "address" then   Address.new
+                   when "bool"    then   Bool.new
+                   else
+                     ## puts "  type: >#{type}<"
+                     raise ParseError, "Unrecognized type base: #{base}"
+                   end
+
+        _parse_array_type(subtype, dims)
+      end
+
+      ##
+      # Crazy regexp to seperate out base type component (eg. uint), size (eg.
+      # 256, 128, nil), array component (eg. [], [45], nil)
+      #
+      BASE_TYPE_RX = /([a-z]*)
+                      ([0-9]*)
+                      ((\[[0-9]*\])*)
+                     /x
+
+      def self._parse_base_type(str)
+        _, base, subscript, dimension = BASE_TYPE_RX.match(str).to_a
+
+        ## note:  use [Integer,Integer] array in the future for sub
+        ##          for fixed  (e.g. 128x128 => [128,128]) or such
+        ##          for now always assume single integer (as string)
+        sub = subscript == "" ? nil : subscript.to_i
+
+        ## e.g. turn "[][1][2]" into [-1,1,2]
+        ##         or ""        into  []   -- that is, empty array
+        dims = _parse_dims(dimension)
+
+        [base, sub, dims]
+      end
+
+      def self._parse_dims(str)
+        dims = str.scan(/\[[0-9]*\]/)
+
+        ## note: return -1 for dynamic array size e.g. []
+        ##        e.g. "[]"[1...-1]  => ""
+        ##             "[0]"[1...-1]  => "0"
+        ##             "[1]"[1...-1]  => "1"
+        dims.map do |dim|
+          size = dim[1...-1]
+          size == "" ? -1 : size.to_i
+        end
+      end
+
+      def self._parse_array_type(subtype, dims)
+        ##
+        ## todo/check - double check if the order in reverse
+        ##                  in solidity / abi encoding / decoding?
+        ##
+        dims.each do |dim|
+          subtype = if dim == -1
+                      Array.new(subtype)
+                    else
+                      FixedArray.new(subtype, dim)
+                    end
+        end
+
+        subtype
+      end
+
+      def self._validate_base_type(base, sub)
+        case base
+        when "string"
+          # NOTE: string can not have any suffix
+          raise ParseError, "String cannot have suffix" if sub
+        when "bytes"
+          raise ParseError, "Maximum 32 bytes for fixed-length bytes"  if sub && sub > 32
+        when "uint", "int"
+          raise ParseError, "Integer type must have numerical suffix"  unless sub
+          raise ParseError, "Integer size out of bounds" unless sub >= 8 && sub <= 256
+          raise ParseError, "Integer size must be multiple of 8" unless sub % 8 == 0
+        when "address"
+          raise ParseError, "Address cannot have suffix" if sub
+        when "bool"
+          raise ParseError, "Bool cannot have suffix" if sub
+        else
+          ## puts "  type: >#{type}<"
+          raise ParseError, "Unrecognized type base: #{base}"
+        end
+      end
+
+      def self._parse_tuple_type(str)
+        ## note: types assumes string WITHOUT enclosing () e.g.
+        ##  tuple(string,string,bool)  =>  expected as "string,string,bool"
+
+        depth     = 0
+        collected = []
+        current   = ""
+
+        ### todo/fix: replace with a simple parser!!!
+        ##    allow  () and move verbose tuple() too!!!
+        str.each_char do |c|
+          case c
+          when ","
+            if depth == 0
+              collected << current
+              current = ""
+            else
+              current += c
+            end
+          when "("
+            depth += 1
+            current += c
+          when ")"
+            depth -= 1
+            current += c
+          else
+            current += c
+          end
+        end
+        collected << current unless current.empty?
+
+        collected
+      end
+    end # class Parser
+  end #  class Type
+end  # module ABI

data/lib/abi_coder_rb/types.rb

@@ -0,0 +1,230 @@
+module AbiCoderRb
+  #######
+  ## for now use (get inspired)
+  ##    by the type names used by abi coder in rust
+  ##      see  https://github.com/rust-ethereum/ethabi/blob/master/ethabi/src/param_type/param_type.rs
+
+  class Type
+    def self.parse(type) ## convenience helper
+      Parser.parse(type)
+    end
+
+    ##
+    # Get the static size of a type, or nil if dynamic.
+    #
+    # @return [Integer, NilClass]  size of static type, or nil for dynamic type
+    #
+    def size
+      ## check/todo: what error to raise for not implemented / method not defined???
+      raise ArgumentError, "no required size method defined for Type subclass #{self.class.name}; sorry"
+    end
+
+    def dynamic?
+      size.nil?
+    end
+
+    def format
+      ## check/todo: what error to raise for not implemented / method not defined???
+      raise ArgumentError, "no required format method defined for Type subclass #{self.class.name}; sorry"
+    end
+
+    ####
+    ##   default implementation
+    ##    assume equal if class match (e.g. Address == Address)
+    ##    - use format string for generic compare - why? why not?
+  end
+
+  class Address < Type
+    ## note: address is always 20 bytes;  BUT uses 32 bytes (with padding)
+    def size
+      32
+    end
+
+    def format
+      "address"
+    end
+
+    def ==(other)
+      other.is_a?(Address)
+    end
+  end # class Address
+
+  class Bytes < Type
+    ## note: dynamic (not known at compile-time)
+    def size
+      nil
+    end
+
+    def format
+      "bytes"
+    end
+
+    def ==(other)
+      other.is_a?(Bytes)
+    end
+  end # class Bytes
+
+  class FixedBytes < Type
+    attr_reader :length
+
+    def initialize(length)
+      @length = length # in bytes (1,2,...32)
+    end
+
+    ## note: always uses 32 bytes (with padding)
+    def size
+      32
+    end
+
+    def format
+      "bytes#{@length}"
+    end
+
+    def ==(other)
+      other.is_a?(FixedBytes) && @length == other.length
+    end
+  end # class FixedBytes
+
+  class Int < Type
+    attr_reader :bits
+
+    def initialize(bits = 256)
+      @bits = bits # in bits (8,16,...256)
+    end
+
+    ## note: always uses 32 bytes (with padding)
+    def size
+      32
+    end
+
+    def format
+      "int#{@bits}"
+    end
+
+    def ==(other)
+      other.is_a?(Int) && @bits == other.bits
+    end
+  end # class Int
+
+  class Uint < Type
+    attr_reader :bits
+
+    def initialize(bits = 256)
+      @bits = bits # in bits (8,16,...256)
+    end
+
+    ## note: always uses 32 bytes (with padding)
+    def size
+      32
+    end
+
+    def format
+      "uint#{@bits}"
+    end
+
+    def ==(other)
+      other.is_a?(Uint) && @bits == other.bits
+    end
+  end # class  Uint
+
+  class Bool < Type
+    ## note: always uses 32 bytes (with padding)
+    def size
+      32
+    end
+
+    def format
+      "bool"
+    end
+
+    def ==(other)
+      other.is_a?(Bool)
+    end
+  end # class Bool
+
+  class String < Type
+    ## note: dynamic (not known at compile-time)
+    def size
+      nil
+    end
+
+    def format
+      "string"
+    end
+
+    def ==(other)
+      other.is_a?(String)
+    end
+  end # class String
+
+  class Array < Type
+    attr_reader :subtype
+
+    def initialize(subtype)
+      @subtype = subtype
+    end
+
+    ## note: dynamic (not known at compile-time)
+    def size
+      nil
+    end
+
+    def format
+      "#{@subtype.format}[]"
+    end
+
+    def ==(other)
+      other.is_a?(Array) && @subtype == other.subtype
+    end
+  end  # class Array
+
+  class FixedArray < Type
+    attr_reader :subtype, :dim
+
+    def initialize(subtype, dim)
+      @subtype = subtype
+      @dim = dim
+    end
+
+    def size
+      @subtype.dynamic? ? nil : @dim * subtype.size
+    end
+
+    def format
+      "#{@subtype.format}[#{@dim}]"
+    end
+
+    def ==(other)
+      other.is_a?(FixedArray) &&
+        @dim == other.dim &&
+        @subtype == other.subtype
+    end
+  end  # class FixedArray
+
+  class Tuple < Type
+    attr_reader :types
+
+    def initialize(types)
+      @types = types
+    end
+
+    def size
+      s = 0
+      @types.each do |type|
+        ts = type.size
+        return nil if ts.nil?
+
+        s += ts
+      end
+      s
+    end
+
+    def format
+      "(#{@types.map { |t| t.format }.join(",")})" ## rebuild minimal string
+    end
+
+    def ==(other)
+      other.is_a?(Tuple) && @types == other.types
+    end
+  end # class Tuple
+end  # module ABI

data/lib/abi_coder_rb/version.rb

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

data/lib/abi_coder_rb.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "abi_coder_rb/version"
+
+require_relative "abi_coder_rb/parser"
+require_relative "abi_coder_rb/types"
+require_relative "abi_coder_rb/decode"
+require_relative "abi_coder_rb/encode"
+
+module AbiCoderRb
+  class DecodingError < StandardError; end
+  class EncodingError < StandardError; end
+  class ValueError < StandardError; end
+  class ValueOutOfBounds < ValueError; end
+
+  ###################
+  ### some (shared) constants  (move to constants.rb or such - why? why not?)
+
+  ## todo/check:  use auto-freeze string literals magic comment - why? why not?
+  ##
+  ## todo/fix: move  BYTE_EMPTY, BYTE_ZERO, BYTE_ONE to upstream to bytes gem
+  ##    and make "global" constants - why? why not?
+
+  ## BYTE_EMPTY = "".b.freeze
+  BYTE_ZERO  = "\x00".b.freeze
+  BYTE_ONE   = "\x01".b.freeze ## note: used for encoding bool for now
+
+  UINT_MAX = 2**256 - 1   ## same as 0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff
+  UINT_MIN = 0
+  INT_MAX  = 2**255 - 1   ## same as  57896044618658097711785492504343953926634992332820282019728792003956564819967
+  INT_MIN  = -2**255      ## same as -57896044618658097711785492504343953926634992332820282019728792003956564819968
+
+  def hex_to_bin(hex) # convert hex(adecimal) string  to binary string
+    hex = hex[2..] if %w[0x 0X].include?(hex[0, 2]) ## cut-of leading 0x or 0X if present
+    [hex].pack("H*")
+  end
+  alias hex hex_to_bin
+
+  def bin_to_hex(bin) # convert binary string to hex string
+    bin.unpack1("H*")
+  end
+  alias bin bin_to_hex
+end

data/sig/abi_coder_rb.rbs

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

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: abi_coder_rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aki Wu
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-11-13 00:00:00.000000000 Z
+dependencies: []
+description: An EVM ABI encoding and decoding tool
+email:
+- wuminzhe@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".rspec"
+- ".rubocop.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/.DS_Store
+- lib/abi_coder_rb.rb
+- lib/abi_coder_rb/.DS_Store
+- lib/abi_coder_rb/decode.rb
+- lib/abi_coder_rb/decode/decode_array.rb
+- lib/abi_coder_rb/decode/decode_fixed_array.rb
+- lib/abi_coder_rb/decode/decode_primitive_type.rb
+- lib/abi_coder_rb/decode/decode_tuple.rb
+- lib/abi_coder_rb/encode.rb
+- lib/abi_coder_rb/encode/encode_array.rb
+- lib/abi_coder_rb/encode/encode_fixed_array.rb
+- lib/abi_coder_rb/encode/encode_primitive_type.rb
+- lib/abi_coder_rb/encode/encode_tuple.rb
+- lib/abi_coder_rb/parser.rb
+- lib/abi_coder_rb/types.rb
+- lib/abi_coder_rb/version.rb
+- sig/abi_coder_rb.rbs
+homepage: https://github.com/wuminzhe/abi_coder_rb
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wuminzhe/abi_coder_rb
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: An EVM ABI encoding and decoding tool
+test_files: []