abibase 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 892b874b015e3b8aa49f47fbd86e11a36811b25a9b2dc96f8653ac6cac0ebed8
+  data.tar.gz: 245236223c5506416834085bf1999a4253380fbb5c2169e434b309154d574387
+SHA512:
+  metadata.gz: 2ea4084b2b2ad686bc18aa789772934ee7ea44d02947d48d4965ec3048963636b08c9e6f46893ae7a5e8d87a0db75b9632b1cf0b1d1abfcd8397e05e6d327943
+  data.tar.gz: 6ee51891fc973dc08c1fa373a6c50027a054212aa8ea2fdac116684b3551b141840a251bc2275f549609e92db13c6791a7834f6bca355d16c68412a25e118096

data/CHANGELOG.md

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

data/Manifest.txt

@@ -0,0 +1,5 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+lib/abibase.rb

data/README.md

@@ -0,0 +1,31 @@
+#  Application Binary Inteface (ABI) Command Line Tool For Ethereum & Co.
+
+abibase -  command line tool / helper to manage application binary interfaces (abis)
+
+
+* 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/abibase](https://rubygems.org/gems/abibase)
+* rdoc  :: [rubydoc.info/gems/abibase](http://rubydoc.info/gems/abibase)
+
+
+
+## Usage
+
+to be done
+
+
+
+
+## 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,43 @@
+require 'hoe'
+
+
+###
+# hack/ quick fix for broken intuit_values - overwrite with dummy
+class Hoe
+  def intuit_values( input ); end
+end
+
+
+Hoe.spec 'abibase' do
+
+  self.version = '0.0.1'
+
+  self.summary = "abibase -  command line tool / helper to manage application binary interfaces (abis)"
+  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 = [
+    ## ['ethlite'],
+    ['etherscan-lite'],
+    ['abiparser'],
+    ['natspec'],
+    ['abidoc'],
+    ['abigen'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/lib/abibase.rb

@@ -0,0 +1,390 @@
+################
+#   download ABIs via Etherscan
+
+require 'optparse'
+
+
+require 'etherscan-lite'
+require 'abidoc'
+
+
+
+def format_code( txt )
+  ##  {{ to {
+  ## and }} to }
+  txt = txt.strip.sub( /\A\{\{/, '{').sub( /\}\}\z/, '}' )
+
+  data = JSON.parse( txt )
+  ## pp data
+
+  language = data['language']
+  pp language
+  if language != 'Solidity'
+    puts "!! ERROR - expected Solidity for language; got: #{language}"
+    exit 1
+  end
+
+  sources = data['sources']
+  puts "  #{sources.size} source(s)"
+
+  buf = ''
+  sources.each do |name, h|
+     buf << "///////////////////////////////////////////\n"
+     buf << "// File: #{name}\n\n"
+     buf << h['content']
+     buf << "\n\n"
+  end
+  buf
+end
+
+
+
+
+
+class ContractDetailsCache
+
+  def initialize( path )
+    @path = path
+    @table = if File.exist?( path )
+                 build_table( read_csv( path ) )
+             else
+                 {}
+             end
+  end
+
+  def [](addr)
+     if @table.has_key?( addr )
+         @table[ addr ]
+     else  ## fetch missing data
+        data = Etherscan.getcontractdetails( contractaddress: addr )
+        ## note: add new data to cache
+        @table[ addr ] = data
+        data
+     end
+  end
+
+
+
+  def build_table( recs )
+    h = {}
+    recs.each do |rec|
+        ## (re)use contractdetails format / hash keys
+        h[ rec['address'] ] = {
+              'contractAddress' => rec['address'],
+              'contractCreator' => rec['creator'],
+              'txHash'          => rec['txid'],
+              'blockNumber'     => rec['blocknumber'],
+              'timestamp'       => rec['timestamp']
+           }
+    end
+    h
+  end
+
+  def save
+    ##############
+    ## save cache - sort by blocknumber
+    entries = @table.values.sort { |l,r| l['blockNumber'].to_i(16) <=> r['blockNumber'].to_i(16)  }
+    buf = ''
+    buf << ['blocknumber', 'timestamp', 'address', 'creator', 'txid'].join( ', ' )
+    buf << "\n"
+    entries.each do |entry|
+       buf << [entry['blockNumber'],
+               entry['timestamp'],
+               entry['contractAddress'],
+               entry['contractCreator'],
+               entry['txHash']
+               ].join( ', ' )
+       buf << "\n"
+    end
+    write_text( @path, buf )
+  end
+end  # class  ContractDetailsCache
+
+
+
+
+
+
+
+module Abi
+
+class Tool
+
+  def self.main( args=ARGV )
+    puts "==> welcome to abibase tool with args:"
+    pp args
+
+    options = {}
+
+    parser = OptionParser.new do |opts|
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    parser.parse!( args )
+    puts "options:"
+    pp options
+
+    puts "args:"
+    pp args
+
+    command          = args[0] || 'download'
+
+    if ['d', 'dl', 'download'].include?( command )
+      do_download_abis
+    elsif ['code'].include?( command )
+      do_download_code
+    elsif ['doc', 'docs'].include?( command )
+      do_generate_docs
+    elsif ['t', 'time', 'timeline'].include?( command )
+      do_generate_timeline   # & download contract details (txid,timestamp,etc.)
+    else
+      puts "!! ERROR - unknown command >#{command}<, sorry"
+    end
+
+    puts "bye"
+  end
+
+
+
+
+
+  def self.do_download_abis
+     puts "==> download abis..."
+
+     recs = read_csv( "./contracts.csv" )
+     puts "   #{recs.size} record(s)"
+
+     delay_in_s = 1
+
+     recs.each_with_index do |rec,i|
+       addr  = rec['address'].downcase
+       names = rec['names']
+       puts "==> [#{i+1}/#{recs.size}] #{names} @ #{addr}..."
+
+       outpath = "./address/#{addr}/abi.json"
+
+       if File.exist?( outpath )
+          # already download / found in cache
+       else
+         puts "  sleeping in #{delay_in_s} sec(s)..."
+         sleep( delay_in_s )
+         data = Etherscan.getabi( address: addr )
+         pp data   ## note: returns abi data as a json string (parse again!!)
+         abi = JSON.parse( data )
+         pp abi
+
+         write_json( outpath, abi )
+       end
+     end
+  end
+
+
+
+
+  def self.do_download_code
+    puts "==> download (source) code..."
+
+    recs = read_csv( "./contracts.csv" )
+    puts "   #{recs.size} record(s)"
+
+    delay_in_s = 1
+
+    recs.each_with_index do |rec,i|
+      addr  = rec['address'].downcase
+      names = rec['names']
+      puts "==> [#{i+1}/#{recs.size}] #{names} @ #{addr}..."
+
+      outpath_code = "./address/#{addr}/contract.sol"
+      outpath_meta = "./address/#{addr}/contract.yml"
+
+      if File.exist?( outpath_code )
+         # already download / found in cache
+      else
+        puts "  sleeping in #{delay_in_s} sec(s)..."
+        sleep( delay_in_s )
+
+        data = Etherscan.getsourcecode( address: addr )
+        pp data   ## note: returns abi data as a json string (parse again!!)
+
+        ## note: returns an array
+        if data.size != 1
+          puts "!! ERROR - expected array of size 1; got #{data.size}"
+          exit 1
+        end
+
+        code = data[0]['SourceCode']
+
+        ## note:  unroll multi-file format if present (starts with {{ .. }})
+        code = format_code( code )   if code.start_with?( /[ \t\n\r]*\{\{/ )
+
+
+        ## fix:  use "universal new line or such ?? - why lines get duplicated??"
+        ##  hack: use write_blob
+        write_blob( outpath_code, code )
+
+        ## remove SourceCode & ABI entries
+        data[0].delete('SourceCode')
+        data[0].delete('ABI')
+        puts "meta:"
+        pp data[0]
+
+        ##  save rest (remaining) as yml
+        write_text( outpath_meta, YAML.dump( data[0] ))
+      end
+    end
+  end
+
+
+
+  def self.do_generate_docs
+    puts "==> generate docs..."
+
+    paths = Dir.glob( "./address/**/abi.json" )
+    ## paths = paths[0..2]
+    paths.each do |path|
+       basename = File.basename( File.dirname( path ))
+
+       abi = ABI.read( path )
+
+       natspec =  if File.exist?( "./address/#{basename}/contract.md" )
+                     Natspec.read( "./address/#{basename}/contract.md" )
+                  else
+                    nil
+                  end
+
+       buf = abi.generate_doc( title: "Contract ABI - #{basename}",
+                               natspec: natspec )
+       puts buf
+       write_text( "./address/#{basename}/README.md", buf )
+
+       buf =  abi.generate_interface( name: '' )    # solidity interface declarations (source code)
+       write_text( "./address/#{basename}/interface.sol", buf )
+    end
+  end
+
+
+  def self.do_generate_timeline
+    puts "==> generate timeline..."
+
+    ## collection all addresses
+    addresses = []
+    paths = Dir.glob( "./address/**/abi.json" )
+    ## paths = paths[0..2]
+    paths.each do |path|
+       basename = File.basename( File.dirname( path ))
+
+       addresses <<  basename.downcase
+    end
+
+    pp addresses
+    puts "   #{addresses.size} record(s)"
+
+    ## update contractdetails.csv
+    ## build cache
+    cache = ContractDetailsCache.new( './contractdetails.csv' )
+
+    recs = []
+    addresses.each_with_index do |addr,i|
+       rec = cache[ addr ]
+       recs << rec
+    end
+    ### note:  save back contractdetails cache
+    cache.save
+
+    ############
+    ## sort by blocknumber  (reverse chronological)
+    recs = recs.sort do |l,r|
+                  l['blockNumber'].to_i(16) <=> r['blockNumber'].to_i(16)
+                end
+
+    pp recs
+
+## create report / page
+buf = <<TXT
+#  Awesome (Ethereum) Contracts  / Blockchain Services
+
+Cache of (ethereum) contract ABIs (application binary interfaces)
+and  open source code (if verified / available)
+
+
+TXT
+
+meta = read_csv( './contracts.csv')
+## build name lookup by address
+contracts = meta.reduce( {} ) {|h,rec| h[rec['address']]=rec['names']; h }
+pp contracts
+
+recs.each_with_index do |rec,i|
+  addr        = rec['contractAddress'].downcase
+  timestamp   = rec['timestamp'].to_i(16)
+  date = Time.at( timestamp).utc
+
+  tooltip = date.strftime('%b %-d, %Y')
+
+   names = contracts[addr]
+   if names.nil?
+    puts "!! ERROR: no name found for contract; sorry:"
+    pp rec
+    exit 1
+   end
+
+   names = names.split( '|' )
+   names = names.map { |name| name.gsub( /[ \t]+/, ' ' ).strip }
+   name  = names[0]
+
+   buf << " · "  if i > 0
+   buf << %Q{[#{name}](address/#{addr}  "#{tooltip}")}
+   buf << "\n"
+end
+
+
+buf << "\n"
+buf << "## Timeline\n\n"
+
+recs.each do |rec|
+
+  addr        = rec['contractAddress']
+  creator     = rec['contractCreator']
+  txid        = rec['txHash']
+  blocknumber = rec['blockNumber'].to_i(16)
+  timestamp   = rec['timestamp'].to_i(16)
+  date = Time.at( timestamp).utc
+
+  names = contracts[addr]
+  if names.nil?
+   puts "!! ERROR: no name found for contract; sorry:"
+   pp rec
+   exit 1
+  end
+
+  names = names.split( '|' )
+  names = names.map { |name| name.gsub( /[ \t]+/, ' ' ).strip }
+  name  = names[0]
+
+  buf << "###  #{names.join( ' | ')} - #{date.strftime('%b %-d, %Y')}\n\n"
+
+  buf << "contract @ [**#{addr}**](address/#{addr})"
+  buf << " - [Etherscan](https://etherscan.io/address/#{addr})"
+  buf << ", [Bloxy](https://bloxy.info/address/#{addr})"
+ ## buf << ", [ABIDocs](https://abidocs.dev/contracts/#{addr})"
+  buf << "\n\n"
+
+#  buf << "created by [#{creator}](https://etherscan.io/address/#{creator}))"
+#  buf << " at block no. #{blocknumber} (#{date})"
+#  buf << " - txid [#{txid}](https://etherscan.io/tx/#{txid})"
+#  buf << "\n\n"
+end
+
+
+write_text( './README.md', buf )
+
+
+
+
+
+  end
+end  # class Tool
+end  # module Abi

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: abibase
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: etherscan-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: abiparser
+  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: natspec
+  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: abidoc
+  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: abigen
+  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: abibase -  command line tool / helper to manage application binary interfaces
+  (abis)
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- lib/abibase.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: abibase -  command line tool / helper to manage application binary interfaces
+  (abis)
+test_files: []