abi2sol 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8ae4954b393b297c829f3c6b04915ca618a70be4651d422e412aa0348a6f22f8
+  data.tar.gz: 69fce3be531ce078a95c1fd1d359817ff9291503ff9fd6a7cd40f4f67ec05135
+SHA512:
+  metadata.gz: 6c157cc040f6bccf94c6d0fc90ad2d0a3dacbdcb9b0ea28f3fae406c66fdd065db9a774035bf52bef1a5488aca1258ce32302f37ff4bd0bcdbff07e0a188c964
+  data.tar.gz: d87ed5a52b9d59eac1540f7b6672086e868f2915fbc7f4fe8d1036fbd88dea75517181d87e80b15f79206243597b5cafc92e3ccc31c947159042a6e780a6e172

data/CHANGELOG.md

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

data/Manifest.txt

@@ -0,0 +1,7 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+bin/abi2sol
+lib/abi2sol.rb
+lib/abi2sol/generate.rb

data/README.md

@@ -0,0 +1,136 @@
+# abi2sol
+
+
+abi2sol gem - command-line tool for application binary interface (abi) to solidity (contract) source code generation 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/abi2sol](https://rubygems.org/gems/abi2sol)
+* rdoc  :: [rubydoc.info/gems/abi2sol](http://rubydoc.info/gems/abi2sol)
+
+
+
+## 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:
+
+```
+$ abi2sol --help
+```
+
+resulting in:
+
+```
+abiparser/0.1.2 on Ruby 3.1.1
+==> welcome to the abi2parse tool
+
+Usage: abi2sol [options]
+        --name STRING                name of contract interface (default: nil)
+    -h, --help                       Prints this help
+```
+
+
+Let's try to generate the contract solidity source code
+for punks v1 (anno 2017):
+
+```
+$ abi2sol --name PunksV1 ./address/0x6ba6f2207e343923ba692e5cae646fb0f566db8d/abi.json
+```
+
+resulting in:
+
+
+``` solidity
+interface PunksV1 {
+// 1 Payable Function(s)
+function buyPunk(uint256 punkIndex) payable ;
+
+// 7 Transact Functions(s)
+function reservePunksForOwner(uint256 maxForThisRun);
+function withdraw();
+function transferPunk(address to, uint256 punkIndex);
+function offerPunkForSaleToAddress(uint256 punkIndex, uint256 minSalePriceInWei, address toAddress);
+function offerPunkForSale(uint256 punkIndex, uint256 minSalePriceInWei);
+function getPunk(uint256 punkIndex);
+function punkNoLongerForSale(uint256 punkIndex);
+
+// 14 Query Functions(s)
+function name() view  returns (string _);
+function punksOfferedForSale(uint256 _) view  returns (bool isForSale, uint256 punkIndex, address seller, uint256 minValue, address onlySellTo);
+function totalSupply() view  returns (uint256 _);
+function decimals() view  returns (uint8 _);
+function imageHash() view  returns (string _);
+function nextPunkIndexToAssign() view  returns (uint256 _);
+function punkIndexToAddress(uint256 _) view  returns (address _);
+function standard() view  returns (string _);
+function balanceOf(address _) view  returns (uint256 _);
+function symbol() view  returns (string _);
+function numberOfPunksToReserve() view  returns (uint256 _);
+function numberOfPunksReserved() view  returns (uint256 _);
+function punksRemainingToAssign() view  returns (uint256 _);
+function pendingWithdrawals(address _) view  returns (uint256 _);
+}
+```
+
+
+Let's try to generate the contract solidity source code
+for punk blocks (anno 2022):
+
+```
+$ abi2sol --name PunkBlocks ./address/0x58e90596c2065befd3060767736c829c18f3474c/abi.json
+```
+
+resulting in:
+
+``` solidity
+interface PunkBlocks {
+// 1 Transact Functions(s)
+function registerBlock(bytes _dataMale, bytes _dataFemale, uint8 _layer, string _name);
+
+// 8 Query Functions(s)
+function blocks(bytes32 _) view  returns (uint8 layer /* enum PunkBlocks.Layer */, bytes dataMale, bytes dataFemale);
+function getBlocks(uint256 _fromID, uint256 _count) view  returns ((uint8,bytes,bytes)[] _ /* struct PunkBlocks.Block[] */, uint256 _);
+function index(uint256 _) view  returns (bytes32 _);
+function nextId() view  returns (uint256 _);
+function svgFromIDs(uint256[] _ids) view  returns (string _);
+function svgFromKeys(bytes32[] _attributeKeys) view  returns (string _);
+function svgFromNames(string[] _attributeNames) view  returns (string _);
+function svgFromPunkID(uint256 _tokenID) view  returns (string _);
+}
+
+```
+
+
+and so on.
+
+
+
+## Bonus - Awesome Contracts
+
+See the [**Awesome (Ethereum) Contracts  / Blockchain Services @ Open Blockchains**](https://github.com/openblockchains/awesome-contracts) repo.
+that is a cache of (ethereum) contract ABIs (application binary interfaces)
+and  open source code (if verified / available)
+with auto-generated docs via abidoc & friends.
+
+
+
+## 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 'abi2sol' do
+
+  self.version = '0.1.0'
+
+  self.summary = "abi2sol gem - command-line tool for application binary interface (abi) to solidity (contract) source code generation 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 = [
+    ['abiparser'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/bin/abi2sol

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

data/lib/abi2sol/generate.rb

@@ -0,0 +1,57 @@
+
+module ABI
+class Contract
+
+
+  def generate_interface( name: )   ## interface declarations
+    buf = ''
+    buf << "interface #{name} {"
+
+
+#  include constructor - why? why not?
+#
+#   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/abi2sol.rb

@@ -0,0 +1,81 @@
+require 'abiparser'
+require 'optparse'
+
+
+
+##  our own code
+require_relative 'abi2sol/generate'
+
+
+
+module Abi2Sol
+class Tool
+
+  def self.main( args=ARGV )
+    puts "==> welcome to abi2parse tool with args:"
+    pp args
+
+    options = {
+              }
+
+    parser = OptionParser.new do |opts|
+
+      opts.on("--name STRING",
+              "name of contract interface (default: nil)") do |str|
+          options[ :name]  = str
+      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 contract found - use <contract>"
+      puts ""
+      exit
+    end
+
+    path = args[0]
+
+    do_generate( path, name: options[:name] )
+
+    puts "bye"
+  end
+
+
+
+  def self.do_generate( path, name:  )
+    abi = ABI.read( path )
+    ## pp abi
+
+    puts "==> generate contract interface from abi in (#{path})..."
+
+    buf =  abi.generate_interface( name: name )
+    puts buf
+    ## write_text( "./tmp/punks_v1.sol", buf )
+  end
+
+
+end  # class Tool
+end   # module Abi2Sol
+
+
+
+######
+#  add convience alternate spelling / names
+Abi2sol       = Abi2Sol
+Abi2solidity  = Abi2Sol
+Abi2Solidity  = Abi2Sol
+
+AbiToSol      = Abi2Sol
+AbiToSolidity = Abi2Sol
+

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: abi2sol
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-03 00:00:00.000000000 Z
+dependencies:
+- !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: 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: abi2sol gem - command-line tool for application binary interface (abi)
+  to solidity (contract) source code generation for Ethereum & Co.
+email: wwwmake@googlegroups.com
+executables:
+- abi2sol
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/abi2sol
+- lib/abi2sol.rb
+- lib/abi2sol/generate.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: abi2sol gem - command-line tool for application binary interface (abi) to
+  solidity (contract) source code generation for Ethereum & Co.
+test_files: []