abidump 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4ffdb9017adf411045359acd07b66756f48f58339604ef43354e59b46430e27
+  data.tar.gz: 4b405724f017886a0fedb5662125358a068b916ae39b721abe476ed73e3b9c35
+SHA512:
+  metadata.gz: 7624386685f09523f23dc64b53cdecde1e88dae0b7c2c7e2ace3d8cc75b92f720ca1e49f50960b011538f84711ccc5380237803909f1cc2a748e50cfefadc0c5
+  data.tar.gz: 9f76dad3a9f5d83ae5db4ab1ce935c719edcbc9f7e5132567760dfefc8202841dd27b97e3b430207b4aeed5c22ea396ccfa0d590715c84c381f686d77aef5b14

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2023-02-06
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,6 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+bin/abidump
+lib/abidump.rb

data/README.md

@@ -0,0 +1,284 @@
+# abidump
+
+
+abidump gem - command-line tool to dump / pretty print or (re)format application binary interfaces (abi) for Ethereum & Co.
+
+
+* 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/abidump](https://rubygems.org/gems/abidump)
+* rdoc  :: [rubydoc.info/gems/abidump](http://rubydoc.info/gems/abidump)
+
+
+
+## New to the Solidity (Contract) Programming Language?
+
+See [**Awesome Solidity @ Open Blockchains »**](https://github.com/openblockchains/awesome-solidity)
+
+
+
+
+## Usage
+
+
+Let's try a dry run:
+
+```
+$ abidump --help
+```
+
+resulting in:
+
+```
+==> welcome to the abidump tool
+
+Usage: abidump [options]
+    -j, --json                       use json format (default: false)
+    -y, --yaml                       use yaml format (default: false)
+    -h, --help                       Prints this help
+```
+
+
+Let's pretty print (dump) the application binary interface (abi)
+for punks v1 (anno 2017):
+
+```
+$ abidump ./address/0x6ba6f2207e343923ba692e5cae646fb0f566db8d/abi.json
+```
+
+resulting in:
+
+
+```
+==> summary:
+    29 abi item(s):
+      1 constructor
+      6 events
+         Assign, Transfer, PunkTransfer, PunkOffered, PunkBought, PunkNoLongerForSale
+      22 functions
+         name, reservePunksForOwner, punksOfferedForSale, totalSupply, decimals, withdraw, imageHash, nextPunkIndexToAssign, punkIndexToAddress, standard, balanceOf, buyPunk, transferPunk, symbol, numberOfPunksToReserve, numberOfPunksReserved, offerPunkForSaleToAddress, punksRemainingToAssign, offerPunkForSale, getPunk, pendingWithdrawals, punkNoLongerForSale
+
+==> constructor:
+      payable: true
+    inputs (0):
+       []
+
+==> event Assign:
+      anonymous: false
+    inputs (2):
+      - type: address
+        indexed: true
+        name: to
+      - type: uint256
+        indexed: false
+        name: punkIndex
+
+==> event Transfer:
+      anonymous: false
+    inputs (3):
+      - type: address
+        indexed: true
+        name: from
+      - type: address
+        indexed: true
+        name: to
+      - type: uint256
+        indexed: false
+        name: value
+
+==> event PunkTransfer:
+      anonymous: false
+    inputs (3):
+      - type: address
+        indexed: true
+        name: from
+      - type: address
+        indexed: true
+        name: to
+      - type: uint256
+        indexed: false
+        name: punkIndex
+
+...
+
+==> function name:
+      constant: true
+      payable: false
+    inputs (0):
+       []
+    outputs (1):
+      - type: string
+        name: _
+
+==> function reservePunksForOwner:
+      constant: false
+      payable: false
+    inputs (1):
+      - type: uint256
+        name: maxForThisRun
+    outputs (0):
+       []
+
+==> function punksOfferedForSale:
+      constant: true
+      payable: false
+    inputs (1):
+      - type: uint256
+        name: _
+    outputs (5):
+      - type: bool
+        name: isForSale
+      - type: uint256
+        name: punkIndex
+      - type: address
+        name: seller
+      - type: uint256
+        name: minValue
+      - type: address
+        name: onlySellTo
+
+...
+```
+
+
+Let's try to dump (pretty print) the
+application binary interface (abi)
+for punk blocks (anno 2022):
+
+```
+$ abidump ./address/0x58e90596c2065befd3060767736c829c18f3474c/abi.json
+```
+
+resulting in:
+
+```
+==> summary:
+    11 abi item(s):
+      1 constructor
+      1 event
+         NewBlock
+      9 functions
+         blocks, getBlocks, index, nextId, registerBlock, svgFromIDs, svgFromKeys, svgFromNames, svgFromPunkID
+
+==> constructor:
+      stateMutability: nonpayable
+    inputs (0):
+       []
+
+==> event NewBlock:
+      anonymous: false
+    inputs (3):
+      - type: address
+        indexed: false
+        name: _
+      - type: uint256
+        indexed: false
+        name: _
+      - type: string
+        indexed: false
+        name: _
+
+==> function blocks:
+      stateMutability: view
+    inputs (1):
+      - type: bytes32
+        name: _
+    outputs (3):
+      - type: uint8 (enum PunkBlocks.Layer)
+        name: layer
+      - type: bytes
+        name: dataMale
+      - type: bytes
+        name: dataFemale
+
+==> function getBlocks:
+      stateMutability: view
+    inputs (2):
+      - type: uint256
+        name: _fromID
+      - type: uint256
+        name: _count
+    outputs (2):
+      - type: tuple[] (struct PunkBlocks.Block[])
+        name: _
+        components:
+        - type: uint8 (enum PunkBlocks.Layer)
+          name: layer
+        - type: bytes
+          name: dataMale
+        - type: bytes
+          name: dataFemale
+      - type: uint256
+        name: _
+
+==> function index:
+      stateMutability: view
+    inputs (1):
+      - type: uint256
+        name: _
+    outputs (1):
+      - type: bytes32
+        name: _
+
+==> function nextId:
+      stateMutability: view
+    inputs (0):
+       []
+    outputs (1):
+      - type: uint256
+        name: _
+
+==> function registerBlock:
+      stateMutability: nonpayable
+    inputs (4):
+      - type: bytes
+        name: _dataMale
+      - type: bytes
+        name: _dataFemale
+      - type: uint8
+        name: _layer
+      - type: string
+        name: _name
+    outputs (0):
+       []
+
+==> function svgFromIDs:
+      stateMutability: view
+    inputs (1):
+      - type: uint256[]
+        name: _ids
+    outputs (1):
+      - type: string
+        name: _
+
+...
+```
+
+
+and so on.
+
+
+Bonus - Using the `-j / --json` switch / flag
+or `-y / --yaml`   you can (re)export or (re)format
+the application binary interface (abi)
+to pretty printed json or yaml. Example.
+
+
+```
+$ abidump --json ./address/0x58e90596c2065befd3060767736c829c18f3474c/abi.json
+$ abidump --yaml ./address/0x58e90596c2065befd3060767736c829c18f3474c/abi.json
+```
+
+
+
+## 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,38 @@
+require 'hoe'
+
+
+###
+# hack/ quick fix for broken intuit_values - overwrite with dummy
+class Hoe
+  def intuit_values( input ); end
+end
+
+
+Hoe.spec 'abidump' do
+
+  self.version = '0.1.0'
+
+  self.summary = "abidump gem - command-line tool to dump / pretty print or (re)format application binary interfaces (abi) for Ethereum & Co."
+  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'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/bin/abidump

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/abidump
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/abidump
+#
+
+require 'abidump'
+
+ABIDump::Tool.main

data/lib/abidump.rb

@@ -0,0 +1,196 @@
+require 'cocos'
+require 'optparse'
+
+
+
+module ABIDump
+
+  class Tool
+
+    def self.main( args=ARGV )
+      puts "==> welcome to abidump tool with args:"
+      pp args
+
+      options = {
+                }
+
+      parser = OptionParser.new do |opts|
+
+        opts.on("-j", "--json", "use json format (default: false)") do |value|
+          options[ :json]  = true
+        end
+
+        opts.on("-y", "--yaml", "use yaml format (default: false)") do |value|
+            options[ :yaml]  = true
+        end
+
+        opts.on("-h", "--help", "Prints this help") do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!( args )
+      puts "options:"
+      pp options
+
+      puts "args:"
+      pp args
+
+      if args.size < 1
+        puts "!! ERROR - no abi contract path found - use  $ abidump <path>"
+        puts ""
+        exit
+      end
+
+      path = args[0]
+
+      ## read data
+      data = read_json( path )
+
+      if options[ :yaml ]
+         do_dump_yaml( data )
+      elsif options[ :json ]
+         do_dump_json( data )
+      else
+         do_dump( data )
+      end
+
+      puts "bye"
+    end
+
+
+
+
+    def self.do_dump_yaml( data )
+      buf = YAML.dump( data )
+      puts buf
+    end
+
+    def self.do_dump_json( data )
+      buf = JSON.pretty_generate( data )
+      puts buf
+    end
+
+    def self._norm_types( data )
+       ## hack:  remove items and re-add to sort key order!!!
+       ##
+       ## clean-up / normalize type
+       ##   if type && internalType is the same
+       ##      than delete internalType for now - why? why not?
+       data.each do |h|
+          name          = h.delete('name')
+          type          = h.delete('type')
+          internal_type = h.delete('internalType')
+          indexed       = h.delete('indexed')
+          components    = h.delete('components')
+
+          unless h.empty?
+            puts "!! ERROR - found unknown props in abi inputs/outpus:"
+            pp h
+            exit 1
+          end
+
+          h['type'] = type   if type
+          if type && internal_type && type != internal_type
+            h['type'] += " (#{internal_type})"
+          end
+
+          h['indexed'] = indexed   unless indexed.nil?  ## note: indexed is a true/false prop
+
+          ## note: change empty name e.g. '' to _  - why? why not?
+          if name
+            h['name']    = name.empty?  ? "_" : name
+          end
+
+          if components
+             h['components'] = components
+            _norm_types( components)
+          end
+       end
+    end
+
+
+    def self._dump( data, indent: 2 )
+      buf = YAML.dump( data )
+      buf = buf.sub( /^---\n?/, '' )   ## remove leading --- if present
+
+      # puts "---> debug:"
+      # pp buf
+      # puts "<---"
+
+      buf.each_line do |line|
+        print ' ' * indent
+        puts line
+      end
+    end
+
+
+    def self.do_dump( data )
+
+      ## calc summary stats
+      counter = {}
+      data.each do |h|
+         type = h['type']
+         stat = counter[ type ] ||= { count: 0, names: [] }
+         stat[:count] += 1
+
+         name = h['name']
+         stat[:names] << name   if name
+      end
+
+
+       data.each do |h|
+          type    = h.delete('type')
+          name    = h.delete('name')
+          inputs  = h.delete('inputs')
+          outputs = h.delete('outputs')
+
+          puts
+          print "==> #{type}"
+          print " #{name}"    if name
+          puts ":"
+          _dump( h, indent: 6 )
+
+          if inputs
+            puts "    inputs (#{inputs.size}):"
+            _norm_types( inputs )
+            _dump( inputs, indent: 6 )
+          end
+
+          if outputs
+            puts "    outputs (#{outputs.size}):"
+            _norm_types( outputs )
+            _dump( outputs, indent: 6 )
+          end
+       end
+
+     ## always dump stats at the end - why? why not?
+     puts
+     puts "==> summary: "
+     puts "    #{data.size} abi item(s):"
+     counter.each do |(type, h)|
+        count = h[:count]
+        print "      #{count}"
+        print " #{type}"
+        print "s" if count > 1
+        print "\n"
+
+        names = h[:names]
+        if names.size > 0
+           print "         "
+           print names.join( ', ' )
+           print "\n"
+        end
+     end
+    end
+  end # class Tool
+end  # module ABIDump
+
+
+
+
+##############
+#  add alternate spellings - why? why not?
+AbiDump = ABIDump
+Abidump = ABIDump

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: abidump
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-06 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: 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: abidump gem - command-line tool to dump / pretty print or (re)format
+  application binary interfaces (abi) for Ethereum & Co.
+email: wwwmake@googlegroups.com
+executables:
+- abidump
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/abidump
+- lib/abidump.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: abidump gem - command-line tool to dump / pretty print or (re)format application
+  binary interfaces (abi) for Ethereum & Co.
+test_files: []