abi_coder_rb 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72266c6750d4c8e137acebdc790350c7862d9c84453f1af99b1aaa9ee5e775f7
-  data.tar.gz: 045aa60cc688c8537290ffff047df35ceb17db5de978d8943d7db9b0725ca9af
+  metadata.gz: 1df03ba4a67d09da186cb3326798ef5f2bbbebb48dedb7fb3f30170eac01283e
+  data.tar.gz: 92cada88c754227fb404dc6ae6198be216eb1db19c39d47e69e15b210fd58095
 SHA512:
-  metadata.gz: 19822e060b76e17667c3deccf9ba9f2697b51b1ec0825fda594a6d4fcc3f3ed617ca15db6354b4e8702e994cadc58ee221b2b4823b5e93371bc2effd4858b3fc
-  data.tar.gz: 863775a35f5819bddee87bcfe0cbaafc0b59042c98eeff8c9ceaa254ae3e9543c2a8df95660a40e4ac25aa8902f04b50b8493762e729f8141bc35b216e3ea704
+  metadata.gz: 9d1621232bdabc3ee622786cafcef42260fac404df806b53a534791fed8a97884d3d0faca5ab153332b1b02665e95465667678e02d20098218178ef909f09f66
+  data.tar.gz: 93f19691b3d14cfeaac06b001f24e5910b4160acb90bc06df5066616666b7148701c8d62d5511bacfd716143f49299fc039b46c1896c61f84505cf8179deae01

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abi_coder_rb (0.1.0)
+    abi_coder_rb (0.2.0)
 
 GEM
   remote: https://rubygems.org/
@@ -9,6 +9,7 @@ GEM
     ast (2.4.2)
     diff-lcs (1.5.0)
     json (2.6.3)
+    keccak (1.3.1)
     language_server-protocol (3.17.0.3)
     parallel (1.23.0)
     parser (3.2.2.4)
@@ -53,6 +54,7 @@ PLATFORMS
 
 DEPENDENCIES
   abi_coder_rb!
+  keccak (~> 1.3)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

data/README.md

@@ -4,7 +4,13 @@ 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.
+1. 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.
+
+2. Added type encoding pre- and type decoding post- callbacks to facilitate transforming before encoding and after decoding. See [test](./spec/web3_js_abitests_spec.rb)
+
+3. pass all web3.js tests in [encodeDecodeParams.test.ts](https://github.com/web3/web3.js/blob/c490c1814da646a83c6a5f7fee643e35507c9344/packages/web3-eth-abi/test/unit/encodeDecodeParams.test.ts). That is about 1024 unit tests from fixture [abitestsdata.json](https://github.com/web3/web3.js/blob/c490c1814da646a83c6a5f7fee643e35507c9344/packages/web3-eth-abi/test/fixtures/abitestsdata.json).
+
+Also, some code was modified to compile to wasm. Try it online: https://wuminzhe.github.io/abi.html
 
 ## Installation
 
@@ -18,7 +24,59 @@ If bundler is not being used to manage dependencies, install the gem by executin
 
 ## Usage
 
-See tests
+### Way 1: extend AbiCoderRb
+
+```ruby
+require 'abi_coder_rb'
+
+module ABI
+  extend AbiCoderRb
+end
+
+type = "(bytes4)"
+value = ["\x124Vx"] # or ABI.hex "0x12345678"
+data = ABI.hex "1234567800000000000000000000000000000000000000000000000000000000"
+ABI.decode(type, data) == value # => true
+ABI.encode(type, value) == data # => true
+```
+
+You can transform the value according to the type before encoding it. For example, you can convert the hex string to bytes before encoding it. Here is same example but the value for "bytes4" is a hex string. 
+```ruby
+require 'abi_coder_rb'
+
+module ABI
+  extend AbiCoderRb
+
+  before_encoding ->(type, value) { 
+    if type.start_with?("bytes")
+      hex(value)
+    else
+      value
+    end
+  }
+end
+
+type = "(bytes4)"
+value = ["0x12345678"]
+data = ABI.hex "1234567800000000000000000000000000000000000000000000000000000000"
+ABI.encode(type, value) == data # => true
+```
+
+### Way 2: include AbiCoderRb
+```ruby
+class Hello
+  include AbiCoderRb
+
+  def world
+    data = hex "0000000000000000000000000000000000000000000000000000000000000020" \
+               "000000000000000000000000000000000000000000000000000000000000000b" \
+               "48656c6c6f20576f726c64000000000000000000000000000000000000000000"
+    decode("(string)", data)
+  end
+end
+
+Hello.new.world # => ["Hello World"]
+```
 
 ## Development
 

data/flatten.rb

@@ -0,0 +1,8 @@
+content = "# Generated from https://github.com/wuminzhe/abi_coder_rb\n"
+Dir["./lib/**/*.rb"].each do |f|
+  File.open(f, "r").each_line do |line|
+    content += line unless line.include?("require") || line.strip.start_with?("#") || line.strip.empty?
+  end
+end
+
+puts content