abigen 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2af88adfb037b066adbcdb376f41d9c7b22f90ac72832ed0804b6f14de2964e3
-  data.tar.gz: f95aee9a46c98b9896d9c9c09587ddfe55b1ac1b81d4e6d1a9905b07b5e5d9a5
+  metadata.gz: 9a948cfdd420f7932b5c5de6874ebef9ab871156414d4d2651ab37ff31a23a66
+  data.tar.gz: b64a28f7fd83a273dfad24388dabc365f7804ed0df394633cc3da3be179fdf08
 SHA512:
-  metadata.gz: 3395ab689b6efc2b354287940f376567c5b7c0e34e6693662931150a7c19da0768c377ab1187a82563a5d33f667c1684d4aedc720b9a7da0fdfed484a5b33097
-  data.tar.gz: 470b580d57671302f73b10abaebf83e1519096c6e93d4843626160a30b4dd268ad4f45c8ff5f9e895eb48f9973955e72ced6b434745e7027a0bc884f9bb0626f
+  metadata.gz: cf7be52392d9df4ca66e08253d706bfedaa91731b458a41ea4b08150968ba69073777f637fcd341c9fe9c7ecf0aa2c91658825b527f2326911a274b97b4ac550
+  data.tar.gz: 190826558f10b3f9845a5461016186be1f1d12f42b12c09527e02d188b210f35a7732d52d47f8e786964bc99d724feee5450990e8cf855174bdf2f1b149c921e

data/CHANGELOG.md

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

data/README.md

@@ -1,6 +1,6 @@
-#  Application Binary Interface (ABI) Contract Generator
+#  abigen
 
-abigen - generate ready-to-use (blockchain) contract services / function calls for ethereum & co. via application binary inferfaces (abis)
+abigen - "high-level" all-in-one umbrella quick starter gem for easy installation & usage application binary interface (abi) code or doc(umentation) gen(eration) for ethereum & co.
 
 
 * home  :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
@@ -10,9 +10,23 @@ abigen - generate ready-to-use (blockchain) contract services / function calls f
 
 
 
-## Usage
+##  Download & Install The Ruby Package(s)
 
-To be done
+To install use the ruby package manager (also known as rubygems):
+
+```
+$ gem install abigen
+```
+
+
+### Gems
+
+For now ethers includes / bundles-up:
+
+
+- [abi2ruby](../abi2ruby) - generate ready-to-use (blockchain) contract services / function calls for ethereum & co. via application binary inferfaces (abis)
+- [abi2sol](../abi2sol) - command-line tool for application binary interface (abi) to solidity (contract) source code generation for Ethereum & Co.
+- [abidoc](../abidoc) - application binary interface (abi) documentation generator for Ethereum & Co. (blockchain) contracts
 
 
 

data/Rakefile

@@ -3,8 +3,8 @@ require 'hoe'
 
 Hoe.spec 'abigen' do
 
-  self.version = '0.0.1'
-  self.summary = "abigen  - generate ready-to-use (blockchain) contract services / function calls for ethereum & co. via application binary inferfaces (abis)"
+  self.version = '0.1.1'
+  self.summary = '"high-level" all-in-one umbrella quick starter gem for easy installation & usage application binary interface (abi) code or doc(umentation) gen(eration) for ethereum & co.'
   self.description = summary
 
   self.urls    = { home: 'https://github.com/rubycocos/blockchain' }
@@ -17,7 +17,9 @@ Hoe.spec 'abigen' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
-    ['abiparser'],
+    ['abi2ruby'],
+    ['abi2sol'],
+    ['abidoc'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/abigen.rb

@@ -1,99 +1,6 @@
-require 'abiparser'
+## all-in-one prelude/prolog
 
+require 'abi2ruby'
+require 'abi2sol'
+require 'abidoc'
 
-## our own code
-## require_relative 'abidoc/version'    # note: let version always go first
-
-
-
-module ABI
-  class Contract
-
-
-def generate_code( name: 'Contract', address: nil )
-  buf = ''
-  buf << "#########################\n"
-  buf << "# #{name} contract / (blockchain) services / function calls\n"
-  buf << "#    auto-generated via abigen (see https://rubygems.org/gems/abigen) on #{Time.now.utc}\n"
-  buf << "#    - #{query_functions.size} query functions(s)\n\n"
-
-
-  buf << "class  #{name} <  Ethlite::Contract\n\n"
-
-  if address
-    buf << "  address "
-    buf << %Q{"#{address}"}
-    buf << "\n"
-  end
-
-
-  if query_functions.size > 0
-    buf << "\n"
-    query_functions.each do |func|
-      buf << "#  #{func.doc} _readonly_\n"
-
-      buf << %Q{sig "#{func.name}"}
-
-      if func.inputs.size > 0
-          quoted_types = func.inputs.map {|param| %Q{"#{param.sig}"} }
-          buf << ", inputs: [#{quoted_types.join(',')}]"
-      end
-
-      if func.outputs.size > 0
-        quoted_types = func.outputs.map {|param| %Q{"#{param.sig}"} }
-        buf << ", outputs: [#{quoted_types.join(',')}]"
-      end
-      buf << "\n"
-
-      buf << "def #{func.name}("
-
-      func.inputs.each_with_index do |param,i|
-          buf << ", "  if i > 0
-          if param.name
-             buf << "#{param.name}"
-          else
-             buf << "arg#{i}"
-          end
-      end
-
-      buf << ")\n"
-
-      buf << "  do_call("
-      buf << %Q{"#{func.name}"}
-
-      func.inputs.each_with_index do |param,i|
-        buf << ", "
-        if param.name
-           buf << "#{param.name}"
-        else
-           buf << "arg#{i}"
-        end
-      end
-
-      buf << ")\n"
-
-      buf << "end\n"
-      buf << "\n"
-    end
-  end
-
-
-### todo: add (pure) helper functions too!!!
-=begin
-  if helper_functions.size > 0
-    buf << "\n"
-    buf << "# #{helper_functions.size} Helper Functions(s)\n\n"
-    helper_functions.each do |func|
-      buf << "# - #{func.doc}\n"
-      ## buf << "  - sig #{func.sig}  =>  0x#{sig(func.sig).hexdigest}\n"
-    end
-  end
-=end
-
-   buf << "end   ## class #{name}\n"
-   buf << "\n"
-   buf
-end
-
-end  ## class Contract
-end ##  module ABI

metadata

@@ -1,17 +1,45 @@
 --- !ruby/object:Gem::Specification
 name: abigen
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-10 00:00:00.000000000 Z
+date: 2023-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: abiparser
+  name: abi2ruby
+  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: abi2sol
+  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:
     - - ">="
@@ -58,8 +86,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: abigen  - generate ready-to-use (blockchain) contract services / function
-  calls for ethereum & co. via application binary inferfaces (abis)
+description: '"high-level" all-in-one umbrella quick starter gem for easy installation
+  & usage application binary interface (abi) code or doc(umentation) gen(eration)
+  for ethereum & co.'
 email: wwwmake@googlegroups.com
 executables: []
 extensions: []
@@ -97,6 +126,7 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: abigen  - generate ready-to-use (blockchain) contract services / function
-  calls for ethereum & co. via application binary inferfaces (abis)
+summary: '"high-level" all-in-one umbrella quick starter gem for easy installation
+  & usage application binary interface (abi) code or doc(umentation) gen(eration)
+  for ethereum & co.'
 test_files: []