abi_coder_rb 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae222b87f68b45367128a4cd07c5792208ed75ef4838dcf64e414fd60366ddff
-  data.tar.gz: 344f59862c11ffbbf6127a350cc5066093da24433914bad779f9b75e3e9e97e1
+  metadata.gz: 2446e20c68206c39fddd2cc887136d0188a74283c82240f95d9fd3d7fce19d15
+  data.tar.gz: '0158a5505f945dc0655a1c80cf8722ff4d15610bf2e027fea15cd21de917aa1c'
 SHA512:
-  metadata.gz: 92c783fb486a02c1df160acaf87c773ca9d2ef7e6637acdc441c69edf92c135f216d22708af285a0ebc02c3711c68f61b7d64cbbece681425c7fb82edee5ea16
-  data.tar.gz: a5ac737f20cb1b66128e57ab27786b40d36e646a7836baa2b374339ca56825c4c486cf08e615fadbe81ddb6cd96224c80025040d586e6648c69c72a6e92b0d1f
+  metadata.gz: 26d7209d606865c01c539a3e5611e25477ce8ba3f2f1e9e54eb0c879ac510ca047979c066905a430fceab5f23f18b8c680b594341834a900d03e983d2241be03
+  data.tar.gz: cac0312067c262e52808ff92b7b36e9a85e87660e306f1e13205a19eb1107bb1a9fb423b2fd6641949c0e4e130b3bb20adb114c1d0fa83f00b5e81923173b2b3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abi_coder_rb (0.2.7)
+    abi_coder_rb (0.2.8)
       activesupport
 
 GEM

data/lib/abi_coder_rb/encode/encode_array.rb

@@ -1,16 +1,25 @@
 module AbiCoderRb
-  def encode_array(type, args)
+  def encode_array(type, args, packed = false)
     raise ArgumentError, "arg must be an array" unless args.is_a?(::Array)
 
+    _encode_array(type: type, args: args, packed: packed)
+  end
+
+  private
+
+  def _encode_array(type:, args:, packed: false)
     head = "".b
-    tail = "".b # 使用二进制字符串
+    tail = "".b
 
-    head += encode_uint256(args.size)
+    # 数组长度
+    head += encode_uint256(args.size) if type.is_a?(Array) && !packed
 
     subtype = type.subtype
     args.each do |arg|
       if subtype.dynamic?
-        head += encode_uint256(32 * args.size + tail.size)
+        raise "#{type.class} with dynamic inner type is not supported in packed mode" if packed
+
+        head += encode_uint256(32 * args.size + tail.size) # 当前数据的位置指针
         tail += encode_type(subtype, arg)
       else
         head += encode_type(subtype, arg)

data/lib/abi_coder_rb/encode/encode_fixed_array.rb

@@ -1,22 +1,11 @@
 module AbiCoderRb
-  def encode_fixed_array(type, args)
+  def encode_fixed_array(type, args, packed = false)
     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
 
     # fixed_array，是没有元素数量的编码de
     # 如果内部类型是静态的，就是一个一个元素编码后加起来。
     # 如果内部类型是动态的，先用位置一个一个编码加起来，然后是元素本体
-    subtype = type.subtype
-    if subtype.dynamic?
-      head = "".b
-      tail = "".b
-      args.each do |arg|
-        head += encode_uint256(32 * args.size + tail.size)
-        tail += encode_type(subtype, arg)
-      end
-      head + tail
-    else
-      args.map { |arg| encode_type(type.subtype, arg) }.join
-    end
+    _encode_array(type: type, args: args, packed: packed)
   end
 end

data/lib/abi_coder_rb/encode/encode_primitive_type.rb

@@ -1,55 +1,67 @@
 module AbiCoderRb
-  def encode_primitive_type(type, arg)
+  def encode_primitive_type(type, arg, packed = false)
     arg = before_encoding_action.call(type.format, arg) if before_encoding_action
     # 根据类型选择相应的编码方法
     case type
     when Uint
       # NOTE: for now size in  bits always required
-      encode_uint(arg, type.bits)
+      encode_uint(arg, type.bits, packed)
     when Int
       # NOTE: for now size in  bits always required
-      encode_int(arg, type.bits)
+      encode_int(arg, type.bits, packed)
     when Bool
-      encode_bool(arg)
+      encode_bool(arg, packed)
     when String
-      encode_string(arg)
+      encode_string(arg, packed)
     when FixedBytes
-      encode_bytes(arg, type.length)
+      encode_bytes(arg, length: type.length, packed: packed)
     when Bytes
-      encode_bytes(arg)
+      encode_bytes(arg, packed: packed)
     when Address
-      encode_address(arg)
+      encode_address(arg, packed)
     else
       raise EncodingError, "Unknown type: #{type}"
     end
   end
 
-  def encode_uint(arg, bits)
+  def encode_uint(arg, bits, packed = false)
     raise ArgumentError, "arg is not integer: #{arg}" unless arg.is_a?(Integer)
     raise ValueOutOfBounds, arg unless arg >= 0 && arg < 2**bits
 
-    lpad_int(arg)
+    if packed
+      lpad_int(arg, bits / 8)
+    else
+      lpad_int(arg)
+    end
   end
 
   def encode_uint256(arg)
     encode_uint(arg, 256)
   end
 
-  def encode_int(arg, _bits)
+  def encode_int(arg, bits, packed = false)
     ## raise EncodingError or ArgumentError - why? why not?
     raise ArgumentError, "arg is not integer: #{arg}" unless arg.is_a?(Integer)
 
-    hex_to_bin(int_to_abi_signed_256bit(arg))
+    if packed
+      hex_to_bin(int_to_abi_signed(arg, bits))
+    else
+      hex_to_bin(int_to_abi_signed_256bit(arg))
+    end
   end
 
-  def encode_bool(arg)
+  def encode_bool(arg, packed = false)
     ## 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 )
+    if packed
+      arg ? BYTE_ONE : BYTE_ZERO
+    else
+      lpad(arg ? BYTE_ONE : BYTE_ZERO) ## was  lpad_int( arg ? 1 : 0 )
+    end
   end
 
-  def encode_string(arg)
+  def encode_string(arg, packed = false)
     ## raise EncodingError or ArgumentError - why? why not?
     raise EncodingError, "Expecting string: #{arg}" unless arg.is_a?(::String)
 
@@ -57,12 +69,16 @@ module AbiCoderRb
 
     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
+    if packed
+      arg
+    else
+      size = lpad_int(arg.size)
+      value = rpad(arg, ceil32(arg.size))
+      size + value
+    end
   end
 
-  def encode_bytes(arg, length = nil)
+  def encode_bytes(arg, length: nil, packed: false)
     ## raise EncodingError or ArgumentError - why? why not?
     raise EncodingError, "Expecting string: #{arg}" unless arg.is_a?(::String)
 
@@ -72,29 +88,36 @@ module AbiCoderRb
       raise ValueOutOfBounds, "invalid bytes length #{arg.size}, should be #{length}" if arg.size > length
       raise ValueOutOfBounds, "invalid bytes length #{length}" if length < 0 || length > 32
 
-      rpad(arg)
+      packed ? arg : 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
+      if packed
+        arg
+      else
+        size =  lpad_int(arg.size)
+        value = rpad(arg, ceil32(arg.size))
+        size + value
+      end
     end
   end
 
-  def encode_address(arg)
+  def encode_address(arg, packed = false)
     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}"
+      packed ? lpad_int(arg, 20) : lpad_int(arg)
+    elsif arg.is_a?(::String)
+      if arg.size == 20
+        ## note: make sure encoding is always binary!!!
+        arg = arg.b if arg.encoding != Encoding::BINARY
+        packed ? arg : lpad(arg)
+      elsif arg.size == 40
+        packed ? hex_to_bin(arg) : lpad_hex(arg)
+      elsif arg.size == 42 && arg[0, 2] == "0x" ## todo/fix: allow 0X too - why? why not?
+        arg = arg[2..-1] ## cut-off leading 0x
+        packed ? hex_to_bin(arg) : lpad_hex(arg)
+      else
+        raise EncodingError, "Could not parse address: #{arg}"
+      end
     end
   end
 end

data/lib/abi_coder_rb/encode/encode_tuple.rb

@@ -1,11 +1,13 @@
 module AbiCoderRb
-  def encode_tuple(tuple, args)
-    encode_types(tuple.types, args)
+  def encode_tuple(tuple, args, packed = false)
+    raise "#{tuple.class} with multi inner types is not supported in packed mode" if packed && tuple.types.size > 1
+
+    encode_types(tuple.types, args, packed)
   end
 
   private
 
-  def encode_types(types, args)
+  def encode_types(types, args, packed = false)
     raise ArgumentError, "args must be an array" unless args.is_a?(::Array)
 
     unless args.size == types.size
@@ -17,18 +19,18 @@ module AbiCoderRb
     head_size = types.map { |type| type.size || 32 }.sum
 
     # 初始化头部和尾部
-    head = "".b
+    head = "".b # 如果是动态类型，头部是指针；如果是静态类型，头部是数据
     tail = "".b # 使用二进制字符串
 
     # 遍历类型并编码
     types.each_with_index do |type, i|
-      if type.dynamic?
+      if !type.dynamic? || packed
+        # 只更新头部，也就是数据
+        head += encode_type(type, args[i], packed)
+      else
         # 动态类型: 更新头部和尾部
         head += encode_uint256(head_size + tail.size)
         tail += encode_type(type, args[i])
-      else
-        # 静态类型: 只更新头部
-        head += encode_type(type, args[i])
       end
     end
 

data/lib/abi_coder_rb/encode.rb

@@ -5,25 +5,38 @@ require_relative "encode/encode_primitive_type"
 
 module AbiCoderRb
   # returns byte array
-  def encode(type, value)
-    # TODO: more checks?
-    raise EncodingError, "Value can not be nil" if value.nil?
+  def encode(typestr_or_typestrs, value_or_values, packed = false)
+    if typestr_or_typestrs.is_a?(::Array)
+      raise EncodingError, "values should be an array" unless value_or_values.is_a?(::Array)
 
-    parsed = Type.parse(type)
-    encode_type(parsed, value)
+      typestrs = typestr_or_typestrs
+      values = value_or_values
+      typestrs.map.with_index do |typestr, i|
+        value = values[i]
+        encode(typestr, value, packed)
+      end.join
+    else
+      typestr = typestr_or_typestrs
+      value = value_or_values
+      # TODO: more checks?
+      raise EncodingError, "Value can not be nil" if value.nil?
+
+      parsed = Type.parse(typestr)
+      encode_type(parsed, value, packed)
+    end
   end
 
   private
 
-  def encode_type(type, value)
+  def encode_type(type, value, packed = false)
     if type.is_a?(Tuple)
-      encode_tuple(type, value)
+      encode_tuple(type, value, packed)
     elsif type.is_a?(Array)
-      encode_array(type, value)
+      encode_array(type, value, packed)
     elsif type.is_a?(FixedArray)
-      encode_fixed_array(type, value)
+      encode_fixed_array(type, value, packed)
     else
-      encode_primitive_type(type, value)
+      encode_primitive_type(type, value, packed)
     end
   end
 end

data/lib/abi_coder_rb/utils.rb

@@ -27,15 +27,14 @@ module AbiCoderRb
   ## rename to lpad32 or such - why? why not?
   # example:
   # lpad("hello", 'x', 10) => "xxxxxxhello"
-  def lpad(bin) ## note: same as builtin String#rjust !!!
-    l = 32 # NOTE: default l word is 32 bytes
+  def lpad(bin, l = 32) ## note: same as builtin String#rjust !!!
     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)
+  def lpad_int(n, l = 32)
     unless n.is_a?(Integer) && n >= 0 && n <= UINT_MAX
       raise ArgumentError,
             "Integer invalid or out of range: #{n}"
@@ -45,7 +44,7 @@ module AbiCoderRb
     hex = "0#{hex}" if hex.length.odd? # wasm, no .odd?
     bin = hex_to_bin(hex)
 
-    lpad(bin)
+    lpad(bin, l)
   end
 
   ## rename to lpad32_hex or such - why? why not?
@@ -62,6 +61,18 @@ module AbiCoderRb
     x % 32 == 0 ? x : (x + 32 - x % 32)
   end
 
+  def int_to_abi_signed(value, bits)
+    min = -2**(bits - 1)
+    max = 2**(bits - 1) - 1
+    raise "Value out of range" if value < min || value > max
+
+    value = (1 << bits) + value if value < 0
+
+    hex_str = value.to_s(16)
+
+    hex_str.rjust(bits / 4, "0")
+  end
+
   def int_to_abi_signed_256bit(value)
     # 确保值在256位有符号整数范围内
     min = -2**255

data/lib/abi_coder_rb/version.rb

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

data/tea.yaml

@@ -0,0 +1,6 @@
+# https://tea.xyz/what-is-this-file
+---
+version: 1.0.0
+codeOwners:
+  - '0x08D5966A5226C74f59407bC3aB3a63a68488Da1D'
+quorum: 1

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abi_coder_rb
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Aki Wu
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2024-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -74,6 +74,7 @@ files:
 - lib/abi_coder_rb/version.rb
 - lib/periphery/event_decoder.rb
 - sig/abi_coder_rb.rbs
+- tea.yaml
 homepage: https://github.com/wuminzhe/abi_coder_rb
 licenses:
 - MIT