abiparser 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 77899a7da00b8be7b61c97d2f1ebad297a6d33f74bd081c59b17f8b66bca78f1
+  data.tar.gz: 15a102dc8505eb359fcb5d117de026e9308641e714ea50096895ee15fb4d655e
+SHA512:
+  metadata.gz: 2bf5a3d5928df6f9d5a650f50ca05df22edb82f0d305a5ef66c552b36fee9b33d6166b63dfd4e878c8a32f7a86e042517159cc6b0155cf96734b36a0ab596817
+  data.tar.gz: 8181ddd11ad89481204f1796ef4eebc854d10ec83fb8cd6d3fd45ce8da830cff2fd1273c726c507853843442c174c603bd66fcb735ae4aabf433141827befebb

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2022-12-26
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,11 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/abiparser.rb
+lib/abiparser/constructor.rb
+lib/abiparser/contract.rb
+lib/abiparser/export/interface.rb
+lib/abiparser/function.rb
+lib/abiparser/param.rb
+lib/abiparser/version.rb

data/README.md

@@ -0,0 +1,29 @@
+#  Application Binary Inteface (ABI) Parser For Ethereum & Co.
+
+abiparser - application binary interface (abi) parser machinery / helper for Ethereum & Co. (blockchain) contracts
+
+
+* home  :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
+* bugs  :: [github.com/rubycocos/blockchain/issues](https://github.com/rubycocos/blockchain/issues)
+* gem   :: [rubygems.org/gems/abiparser](https://rubygems.org/gems/abiparser)
+* rdoc  :: [rubydoc.info/gems/abiparser](http://rubydoc.info/gems/abiparser)
+
+
+
+## Usage
+
+
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+require 'hoe'
+require './lib/abiparser/version.rb'
+
+
+Hoe.spec 'abiparser' do
+
+  self.version = ABIParser::VERSION
+
+  self.summary = "abiparser - application binary interface (abi) parser machinery / helper for Ethereum & Co. (blockchain) contracts"
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycocos/blockchain' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['cocos'],
+    ['bytes'],
+    ['digest-lite'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/lib/abiparser/constructor.rb

@@ -0,0 +1,109 @@
+module ABI
+class Constructor
+
+  def self.parse( o )
+      ## note:
+      ##  - has no name
+      ##  - has no ouptputs
+      ## e.g.
+      ##   {"inputs":[],
+      ##    "stateMutability":"nonpayable",
+      ##    "type":"constructor"}
+
+    inputs  = o['inputs'].map {|param| Param.parse( param ) }
+    payable = nil
+
+    ## old soliditity before v0.6
+    ##  newer version uses stateMutability
+    if o.has_key?( 'stateMutability' )
+      case o[ 'stateMutability' ]
+      when 'nonpayable'    ## default
+        payable  = false
+      when 'payable'
+        payable  = true
+      else
+         pp o
+         ## todo/fix: change to ParseError
+         raise ArgumentError, "unexpected stateMutability (constructor) value ; got: #{ o[ 'stateMutability' ]}"
+      end
+    end
+
+    ## check - assert "strict" abi version keys - why? why not?
+    if o.has_key?( 'stateMutability' ) && (o.has_key?( 'payable') || o.has_key?( 'constant'))
+      pp o
+      puts "!! WARN:  ABI version mismatch? got stateMutability AND payable OR constant"
+      exit 1
+    end
+
+    if o.has_key?( 'constant')
+      pp o
+      puts "!! WARN: constant for constructor possible?"
+      exit 1
+    end
+
+    payable = o['payable']    if o.has_key?( 'payable')
+
+    new( inputs: inputs,  payable: payable )
+  end
+
+
+  attr_reader :inputs
+
+  def initialize( inputs: [],
+                  payable: false )
+     @inputs  = inputs
+     @payable = payable
+  end
+
+  ##  add - why? why not?
+  ## def constant?() false; end
+  ## alias_method :readonly?, :constant?
+
+  def payable?() @payable; end
+
+  def sig
+    ## note: signature
+    ##  only includes name and inputs
+    ##   excludes / drops outputs!!!
+
+    buf = "constructor"
+    if @inputs.empty?
+      buf << "()"
+    else
+      buf2 = @inputs.map {|param| param.sig }
+      buf << "(#{buf2.join(',')})"
+    end
+    buf
+ end
+
+
+  def doc
+      buf = "constructor"
+      if @inputs.empty?
+        buf << "()"
+      else
+        buf2 = @inputs.map {|param| param.doc }
+        buf << "(#{buf2.join(', ')})"
+      end
+      buf
+  end
+
+  def decl
+    buf = "constructor"
+    if @inputs.empty?
+      buf << "()"
+    else
+      buf2 = @inputs.map {|param| param.decl }
+      buf << "(#{buf2.join(', ')})"
+    end
+    buf << ";"
+    buf
+end
+
+
+
+
+end  # class Constructor
+end  # module ABI
+
+

data/lib/abiparser/contract.rb

@@ -0,0 +1,91 @@
+module ABI
+class Contract
+
+  def self.read( path )
+    data = read_json( path )
+    ## pp data
+    parse( data )
+  end
+
+  def self.parse( data )
+    ## note: auto-convert (parse) from json if string passed-in
+    data = JSON.parse( data )  if data.is_a?( String )
+
+    ctor =  nil
+    funcs = []
+    has_fallback = false
+    has_receive  = true
+
+    data.each do |o|
+       if o['type'] == 'function'
+          funcs <<  Function.parse( o )
+       elsif o['type'] == 'constructor'
+          raise ArgumentError, "constructor already defined; only one declaration allowed"   if ctor
+          ctor =  Constructor.parse( o )
+       elsif o['type'] == 'event'
+       elsif o['type'] == 'receive'
+          ## skip for now
+          ## e.g.
+          ##  {"stateMutability": "payable",
+          ##   "type": "receive"}
+       elsif o['type'] == 'fallback'
+          ## skip for now
+          ## e.g.
+          ##  {"stateMutability"=>"nonpayable",
+          ##   "type"=>"fallback"}
+       elsif o['type'] == 'error'
+          ##  skip for now
+          ## e.g.
+          ##  {"inputs":[],
+          ##    "name":"ApprovalCallerNotOwnerNorApproved",
+          ##    "type":"error"}
+       else
+         pp o
+         raise TypeError, "expected function or event; sorry: got #{o['type']}"
+       end
+     end
+     new( constructor: ctor,
+          functions: funcs,
+          events: [],
+          has_receive: has_receive,
+          has_fallback: has_fallback  )
+  end
+
+
+
+  def initialize( constructor: nil,
+                  functions: [],
+                  events: [],
+                  has_receive: false,
+                  has_fallback: false )
+      @ctor  =  constructor
+      @funcs  = functions
+      @events = events
+      @has_receive = has_receive
+      @has_fallback = has_fallback
+  end
+
+  def constructor() @ctor; end
+  def functions() @funcs; end
+
+  ###
+  ##  how to name functions categories ???
+  ##  - use  pay, writer, reader, helper  - why? why not?
+  def payable_functions
+     @funcs.select { |func| func.payable? }
+  end
+
+  def transact_functions    ## add write funcs alias - why? why not?
+     @funcs.select { |func| !func.payable? && !func.constant? }
+  end
+
+  def query_functions    ## add read funcs alias - why? why not?
+    @funcs.select { |func| !func.payable? && !func.pure? && func.constant?  }
+  end
+
+  def helper_functions    ## add pure ?? funcs alias - why? why not?
+    @funcs.select { |func| func.pure? }
+  end
+
+end  # class Contract
+end # module ABI

data/lib/abiparser/export/interface.rb

@@ -0,0 +1,53 @@
+module ABI
+class Contract
+
+
+  def generate_interface( name: )   ## interface declarations
+    buf = ''
+    buf << "interface #{name} {"
+
+    if @ctor
+      buf << "\n"
+      buf << "// Constructor\n"
+      buf << "#{@ctor.decl}\n"
+    end
+
+    if payable_functions.size > 0
+      buf << "\n"
+      buf << "// #{payable_functions.size} Payable Function(s)\n"
+      payable_functions.each do |func|
+        buf << "#{func.decl}\n"
+      end
+    end
+
+    if transact_functions.size > 0
+      buf << "\n"
+      buf << "// #{transact_functions.size} Transact Functions(s)\n"
+      transact_functions.each do |func|
+        buf << "#{func.decl}\n"
+      end
+    end
+
+    if query_functions.size > 0
+      buf << "\n"
+      buf << "// #{query_functions.size} Query Functions(s)\n"
+      query_functions.each do |func|
+        buf << "#{func.decl}\n"
+      end
+    end
+
+    if helper_functions.size > 0
+      buf << "\n"
+      buf << "// #{helper_functions.size} Helper Functions(s)\n\n"
+      helper_functions.each do |func|
+        buf << "#{func.decl}\n"
+      end
+    end
+
+    buf << "}\n"
+    buf
+  end
+
+
+end  ## class Contract
+end  ## module ABI

data/lib/abiparser/function.rb

@@ -0,0 +1,148 @@
+module ABI
+class Function
+
+  def self.parse( o )
+    ## todo/fix: assert type  function (or contructor) ??
+    name    = o['name']
+    inputs  = o['inputs'].map {|param| Param.parse( param ) }
+    outputs = o['outputs'].map {|param| Param.parse( param ) }
+
+    payable = nil
+    contant = nil
+    pure    = nil
+
+    ## old soliditity before v0.6
+    ##  newer version uses stateMutability
+    if o.has_key?( 'stateMutability' )
+      case o[ 'stateMutability' ]
+      when 'nonpayable'    ## default
+        payable  = false
+        constant = false
+      when 'payable'
+        payable  = true
+        constant = false
+      when 'view'
+        payable  = false
+        constant = true
+      when 'pure'
+        payable  = false
+        constant = true
+        pure     = true
+      else
+         pp o
+         ## todo/fix: change to ParseError
+         raise ArgumentError, "unexpected stateMutability value; got: #{ o[ 'stateMutability' ]}"
+      end
+    end
+
+    ## check - assert "strict" abi version keys - why? why not?
+    if o.has_key?( 'stateMutability' ) && (o.has_key?( 'payable') || o.has_key?( 'constant'))
+       pp o
+       puts "!! WARN:  ABI version mismatch? got stateMutability AND payable OR constant"
+       exit 1
+    end
+
+    payable = o['payable']    if o.has_key?( 'payable')
+    constant = o['constant']  if o.has_key?( 'constant')
+
+
+    new( name, inputs: inputs, outputs: outputs,
+         payable: payable,
+         constant: constant,
+         pure: pure )
+  end
+
+
+  attr_reader :name,
+              :inputs, :outputs
+
+  def initialize( name,
+                  inputs: [],
+                  outputs: [],
+                  payable: false,
+                  constant: false,
+                  pure: false )
+     @name    = name
+     @inputs  = inputs
+     @outputs = outputs
+
+     @payable = payable
+     @constant = constant
+     @pure = pure
+  end
+
+
+  def constant?() @constant; end
+  alias_method :readonly?, :constant?
+
+  def payable?() @payable; end
+  def pure?() @pure; end
+
+
+  def sig
+    ## note: signature
+    ##  only includes name and inputs
+    ##   excludes / drops outputs!!!
+
+    buf = "#{@name}"
+    if @inputs.empty?
+      buf << "()"
+    else
+      buf2 = @inputs.map {|param| param.sig }
+      buf << "(#{buf2.join(',')})"
+    end
+    buf
+ end
+
+
+  def doc
+      buf = "function #{@name}"
+      if @inputs.empty?
+        buf << "()"
+      else
+        buf2 = @inputs.map {|param| param.doc }
+        buf << "(#{buf2.join(', ')})"
+      end
+      if @outputs.empty?
+         ## do nothing
+      else
+        buf << " ⇒ "
+        buf2 = @outputs.map {|param| param.doc }
+        buf << "(#{buf2.join(', ')})"
+      end
+      buf
+  end
+
+  def decl
+    buf = "function #{@name}"
+    if @inputs.empty?
+      buf << "()"
+    else
+      buf2 = @inputs.map {|param| param.decl }
+      buf << "(#{buf2.join(', ')})"
+    end
+    buf << " payable "  if @payable
+    buf << " view "     if @constant && !@pure
+    buf << " pure "     if @constant && @pure
+
+    if @outputs.empty?
+       ## do nothing
+    else
+      buf << " returns "
+      buf2 = @outputs.map {|param| param.decl }
+      buf << "(#{buf2.join(', ')})"
+    end
+    buf << ";"
+    buf
+end
+
+
+def types
+    ## for debugging / analytics return all used types (input+output)
+    @inputs.map {|param| param.type } +
+    @outputs.map {|param| param.type }
+end
+
+end  ## class Function
+end  ## module ABI
+

data/lib/abiparser/param.rb

@@ -0,0 +1,36 @@
+module ABI
+class Param
+
+    attr_reader :type, :name
+
+    def self.parse( o )
+      type = o['type']
+      name = o['name']
+      new( type, name )
+    end
+
+    def initialize( type, name )  ## note: type goes first!!!
+      @type = type
+      @name = name
+    end
+
+    def sig
+      buf = "#{@type}"
+      buf
+    end
+
+    def doc
+        buf = ''
+        buf << "#{@type} "
+        buf <<  (@name.empty? ?  '_' : @name)
+        buf
+    end
+
+    def decl
+      buf = ''
+      buf << "#{@type} "
+      buf <<  (@name.empty? ?  '_' : @name)
+      buf
+    end
+end  ## class Param
+end  ## module ABI

data/lib/abiparser/version.rb

@@ -0,0 +1,25 @@
+
+module ABIParser
+
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "abiparser/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module ABIParser
+
+## add convenience alternate spellings - why? why not?
+AbiParser = ABIParser
+

data/lib/abiparser.rb

@@ -0,0 +1,45 @@
+require 'cocos'
+require 'bytes'
+require 'digest-lite'
+
+
+## extend String
+class String
+  alias_method :hexdigest, :bin_to_hex   ## note: bin_to_hex added via Bytes!!!
+end  # class String
+
+
+def keccak256( bin )
+  Digest::KeccakLite.new( 256 ).digest( bin )
+end
+
+def sig( bin )
+  keccak256( bin )[0,4]
+end
+
+
+
+## our own code
+require_relative 'abiparser/version'    # note: let version always go first
+require_relative 'abiparser/param'
+require_relative 'abiparser/constructor'
+require_relative 'abiparser/function'
+require_relative 'abiparser/contract'
+
+require_relative 'abiparser/export/interface.rb'
+
+
+
+module ABI
+  def self.read( path )  Contract.read( path ); end
+
+  def self.parse( data ) Contract.parse( data ); end
+end  # module ABI
+
+
+## add convenience alternate spellings - why? why not?
+Abi = ABI
+
+
+puts AbiParser.banner
+

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: abiparser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocos
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bytes
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: digest-lite
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: abiparser - application binary interface (abi) parser machinery / helper
+  for Ethereum & Co. (blockchain) contracts
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/abiparser.rb
+- lib/abiparser/constructor.rb
+- lib/abiparser/contract.rb
+- lib/abiparser/export/interface.rb
+- lib/abiparser/function.rb
+- lib/abiparser/param.rb
+- lib/abiparser/version.rb
+homepage: https://github.com/rubycocos/blockchain
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+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: abiparser - application binary interface (abi) parser machinery / helper
+  for Ethereum & Co. (blockchain) contracts
+test_files: []