artq 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0f00a597b6533cbdce4aa3286531d8533f9d3c0cf57b8147b7160d4b1d206d3
-  data.tar.gz: e192cfb230111adb5dd69a1213a1446a9dc629fc853cacb8b10e5d80ac723e8e
+  metadata.gz: 173bf8cbe3bc0e9db811e19b585bd04bc23956b28b1b4cb055c1697288472d7e
+  data.tar.gz: 90c2751c1028ca2986e12825f83d8afbb9055ce864228f5a611a9110481f1439
 SHA512:
-  metadata.gz: 6bf4be0a1990ce7c1d6d6e2c30b936cc0a145401b2992b32e4f2c83153881746fdaab77de434a38409bc17c6c0cbb93ee4673a589767197b314b11b935078426
-  data.tar.gz: 65db2f2e2d112926111cb05398dd992a28d64f793a6f5d955b01a4cf03f1f25d9334d998b16088302479a07e6a3191712bc41d932c1b87d821f5d68b3e7b9974
+  metadata.gz: 339f0a49d30a544ce53892ec7f3c1a04a3ddb47d279ddc938d995ae8efc7c25356db9920a44f06d61a5d3482efe9975a965ba791ca6c6603cc427a6353914ab1
+  data.tar.gz: db571cdfcd4e29e3486199ac775a5494e1f4a42256d7d7449c8adbc3fdf7d4259356863dd3f440b60b94bcc30cf104c365c727965226eefe6a9e1ee849aa23da

data/Manifest.txt

@@ -5,4 +5,6 @@ Rakefile
 bin/artq
 lib/artq.rb
 lib/artq/contract.rb
+lib/artq/layers.rb
+lib/artq/tokens.rb
 lib/artq/version.rb

data/README.md

@@ -184,7 +184,7 @@ and inline svg images in the base64 format get "cut" from the metadata and "past
 ```
 
 
-####  Bonus - Case No. 3 - "On-Blockchain" Layers (Incl. Metadata & Images)
+#### Case No. 3 - "On-Blockchain" Layers (Incl. Metadata & Images)
 
 
 Note:  Some "on-blockchain" pixel art collections
@@ -339,7 +339,42 @@ such as
 and many more.
 
 
-Tip:  See the [**Art Factory Sandbox**](https://github.com/pixelartexchange/artfactory.sandbox) for more art collections with "on-blockchain" layers.
+Tip: For more art collections with "on-blockchain" layers see the [**Art Factory Sandbox »**](https://github.com/pixelartexchange/artfactory.sandbox)
+
+
+
+
+
+###  Using the ArtQ Machinery in Your Own Scripts
+
+
+Yes, you can. Let's try the (crypto) marcs:
+
+
+``` ruby
+require 'artq'
+
+marcs_eth  = "0xe9b91d537c3aa5a3fa87275fbd2e4feaaed69bd0"
+
+marcs = ArtQ::Contract.new( marcs_eth )
+
+n = 0
+m = 0
+res = marcs.traitData( n, m )    ## note: return binary blob (for n,m-index)
+pp res
+#=> ["\x89PNG..."]
+
+res = marcs.traitDetails( n, m )  ## note: returns tuple (name, mimetype, hide?)
+pp res
+#=> ["Zombie", "image/png", false]
+
+
+
+## or with convenience download_layers helper
+ArtQ.download_layers( marcs_eth, outdir: './marcs' )
+```
+
+
 
 
 

data/lib/artq/contract.rb

@@ -50,13 +50,12 @@ class Contract
 
 
 
-   def self.rpc
-      @rpc ||= JsonRpc.new( ENV['INFURA_URI'] )
-   end
+  ## note: forward to Ethlite.config.rpc
+  ##   keep config here as a convenience shortcut - why? why not?
+  def self.rpc()        Ethlite.config.rpc; end
+  def self.rpc=(value)  Ethlite.config.rpc = value; end
+
 
-   def self.rpc=(value)
-      @rpc = value.is_a?( String ) ? JsonRpc.new( value ) : value
-   end
 
 
    def initialize( contract_address )
@@ -66,6 +65,7 @@ class Contract
 ######
 #   private helper to call method
    def _do_call( eth, args )
+     puts "  calling method >#{eth.name}< with args >#{args}<... "
      eth.do_call( self.class.rpc, @contract_address, args )
    end
 

data/lib/artq/layers.rb

@@ -0,0 +1,100 @@
+
+module ArtQ
+
+
+  ## use alternate Encoding::BINARY - why? why not?
+  ##   or just use .b  e.g. "GIF87".b or such !!!
+  JPGSIG   = "\xFF\xD8\xFF".force_encoding( Encoding::ASCII_8BIT )
+  PNGSIG   = "\x89PNG".force_encoding( Encoding::ASCII_8BIT )
+  GIF87SIG = "GIF87".force_encoding( Encoding::ASCII_8BIT )
+  GIF89SIG = "GIF89".force_encoding( Encoding::ASCII_8BIT )
+
+
+
+  def self.download_layers( contract_address,
+                            outdir: "./#{contract_address}" )
+
+    puts "==> download layers for art collection contract @ >#{contract_address}<:"
+
+    c = Contract.new( contract_address )
+
+    ## get some metadata - why? why not?
+    name         =  c.name
+    symbol       =  c.symbol
+    totalSupply  =  c.totalSupply
+
+    traitDetails = []
+    n=0
+    loop do
+      m=0
+      loop do
+        rec = c.traitDetails( n, m )
+        break  if rec == ['','',false]   ## note: assume end-of-list if all values are zeros / defaults.
+
+        traitDetails << [[n,m], rec ]
+        m += 1
+        sleep( 0.5 )
+      end
+      break  if m==0
+      n += 1
+    end
+
+
+    ## todo/check: include or drop hide (of any use?) - why? why not?
+    headers = ['index', 'name', 'type', 'hide']
+    recs = []
+    traitDetails.each do |t|
+      recs << [ t[0].join('/'),
+                t[1][0],
+                t[1][1],
+                t[1][2].to_s]
+    end
+
+    buf = String.new('')
+    buf << headers.join( ', ' )
+    buf << "\n"
+    recs.each do |rec|
+       buf << rec.join( ', ' )
+       buf << "\n"
+    end
+
+    write_text( "#{outdir}/cache/layers.csv", buf )
+
+    #####
+    #  try to download all images
+    traitDetails.each_with_index do |t,i|
+      puts "  [#{i+1}/#{traitDetails.size}] downloading #{t[1][1]} >#{t[1][0]}<..."
+
+      n,m  = t[0]
+      data = c.traitData( n, m )
+
+      basename = "#{n}_#{m}"
+      if data.start_with?( PNGSIG )
+        puts "BINGO!! it's a png blob - #{data.size} byte(s)"
+        write_blob( "#{outdir}/cache/#{basename}.png", data )
+      elsif data.start_with?( GIF87SIG ) || data.start_with?( GIF89SIG )
+        puts "BINGO!! it's a gif blob - #{data.size} byte(s)"
+        write_blob( "#{outdir}/cache/#{basename}.gif", data )
+      elsif data.start_with?( JPGSIG )
+        puts "BINGO!! it's a jpg blob - #{data.size} byte(s)"
+        write_blob( "#{outdir}/cache/#{basename}.jpg", data )
+      elsif data.index( /<svg[^>]*?>/i )    ## add more markers to find - why? why not?
+        puts "BINGO!! it's a svg (text) blob - #{data.size} byte(s)"
+        ## todo/check - save text as binary blob 1:1 - why? why not?
+        write_blob( "#{outdir}/cache/#{basename}.svg", data )
+      else
+        puts "!! ERROR - unknown image format; sorry"
+        exit 1
+      end
+      sleep( 0.5 )
+    end
+
+
+    puts "   name: >#{name}<"
+    puts "   symbol: >#{symbol}<"
+    puts "   totalSupply: >#{totalSupply}<"
+    puts
+    puts "   traitDetails:"
+    pp  traitDetails
+  end
+end  # module ArtQ

data/lib/artq/tokens.rb

@@ -0,0 +1,107 @@
+
+module ArtQ
+
+
+
+class Meta    ## check:  change/rename to MetaToken or such - why? why not?
+  def self.parse( tokenURI )
+    if tokenURI.start_with?( 'data:application/json;base64' )
+
+      str = tokenURI.sub( 'data:application/json;base64', '' )
+      str = Base64.decode64( str )
+      data = JSON.parse( str )
+
+      ## check for image_data - and replace if base64 encoded
+      image_data     = data['image_data']
+      svg_image_data = data['svg_image_data']
+
+      if svg_image_data && svg_image_data.start_with?( 'data:image/svg+xml;base64' )
+        data['svg_image_data'] = '...'
+        data['image_data'] = '...'   if image_data
+        ## note:  prefer svg_image_data if present over image_data - why? why not?
+        str = svg_image_data.sub( 'data:image/svg+xml;base64', '' )
+        image_data = Base64.decode64( str )
+      elsif image_data && image_data.start_with?( 'data:image/svg+xml;base64' )
+        data['image_data'] = '...'
+        str = image_data.sub( 'data:image/svg+xml;base64', '' )
+        image_data = Base64.decode64( str )
+      else
+        ## assume no inline image_data ??
+      end
+
+      new( data, image_data )
+    else
+      new   ## use new({},nil) - why? why not?
+    end
+   end
+
+   def initialize( data={},
+                   image_data=nil )
+      @data       = data
+      @image_data = image_data
+   end
+
+  def data()       @data; end
+  def image_data() @image_data; end
+end  # class Meta
+
+
+
+## download on-blockchain token metadata and (inline) images
+def self.download_tokens( contract_address,
+                          outdir: "./#{contract_address}",
+                          ids: (0..99) )
+
+  puts "==> download token (on-blockchain) metadata and (inline) images for art collection contract @ >#{contract_address}<:"
+
+  c = Contract.new( contract_address )
+
+  ## get some metadata - why? why not?
+  name         = c.name
+  symbol       = c.symbol
+  totalSupply  = c.totalSupply
+
+
+  warns = []   ## collect all warnings
+
+  tokenIds = ids
+  tokenIds.each do |tokenId|
+    tokenURI = c.tokenURI( tokenId )
+    sleep( 0.5 )
+
+
+    puts "     tokenId #{tokenId}:"
+    meta = Meta.parse( tokenURI )
+    if meta.data.empty?
+      ## todo/check: raise TypeError or such or return nil - why? why not?
+       warns << "token no. #{tokenId} metadata not 'on-blockchain'? expected json base64-encoded; got:"
+       puts "!! WARN - " + warns[-1]
+       pp tokenURI
+    else
+       path = "#{outdir}/token/#{tokenId}.json"
+       write_json( path, meta.data )
+
+       if meta.image_data
+          ## assume svg for now - always - why? why not?
+          path = "#{outdir}/token-i/#{tokenId}.svg"
+          write_text( path, meta.image_data )
+       else
+         warns << "token no. #{tokenId} (inline) image data not found in 'on-blockchain' metadata; got:"
+         puts "!! WARN - " + warns[-1]
+         pp meta.data
+       end
+    end
+  end
+
+  if warns.size > 0
+      puts "!!! #{warns.size} WARNING(S):"
+      pp warns
+  end
+
+  puts
+  puts "   name: >#{name}<"
+  puts "   symbol: >#{symbol}<"
+  puts "   totalSupply: >#{totalSupply}<"
+end
+
+end  # module ArtQ

data/lib/artq/version.rb

@@ -1,7 +1,7 @@
 
 
 module ArtQ
-  VERSION = '0.2.0'
+  VERSION = '0.3.1'
 end #  module ArtQ
 
 

data/lib/artq.rb

@@ -5,16 +5,25 @@ require 'optparse'
 ## our own code
 require_relative 'artq/version'   # let version go first
 require_relative 'artq/contract'
+require_relative 'artq/layers'
+require_relative 'artq/tokens'
 
 
 
 module ArtQ
 
+class Tool
 
 
+  def self.is_addr?( str )
+    ## e.g.
+    ##  must for now start with 0x (or 0X)
+    ##  and than 40 hexdigits (20 bytes)
+    ##  e.g. 0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1
+    str.match( /\A0x[0-9a-f]{40}\z/i )
+  end
 
 
-class Tool
 
   def self.main( args=ARGV )
     puts "==> welcome to artq tool with args:"
@@ -49,14 +58,38 @@ class Tool
       exit
     end
 
-    contract_address = args[0]   ## todo/check - use collection_name/slug or such?
+
+    ## todo/check - use collection_name/slug or such?
+    contract_address = nil
+    outdir           = nil
+
+    if is_addr?( args[0] ) ## do nothing; it's an address
+       contract_address = args[0]
+       outdir           = "./tmp/#{contract_address}"
+    else  ## try reading  collection.yml config
+      config_path = "./#{args[0]}/collection.yml"
+      if File.exist?( config_path )
+         config = read_yaml( config_path )
+         contract_address = config['token']['contract']
+         outdir           = "./#{args[0]}"
+      else
+        puts "!! ERROR - no config found for collection >#{contract_address}<; sorry"
+        exit 1
+      end
+    end
+
+
     command          = args[1] || 'info'
 
 
     if ['i','inf','info'].include?( command )
         do_info( contract_address )
     elsif ['l', 'layer', 'layers'].include?( command )
-        do_layers( contract_address )
+        ## note: outdir - save into cache for now
+        do_layers( contract_address, outdir: outdir )
+    elsif ['t', 'token', 'tokens'].include?( command )
+        ## note: outdir - saves into token (metadata) & token-i (images)
+        do_tokens( contract_address, outdir: outdir )
     else
       puts "!! ERROR - unknown command >#{command}<, sorry"
     end
@@ -77,11 +110,11 @@ class Tool
     symbol       =  c.symbol
     totalSupply  =  c.totalSupply
 
-    meta = []
+    recs = []
     tokenIds = (0..2)
     tokenIds.each do |tokenId|
       tokenURI =        c.tokenURI( tokenId )
-      meta << [tokenId, tokenURI]
+      recs << [tokenId, tokenURI]
     end
 
     puts "   name: >#{name}<"
@@ -89,122 +122,34 @@ class Tool
     puts "   totalSupply: >#{totalSupply}<"
     puts
     puts "   tokenURIs #{tokenIds}:"
-    meta.each do |tokenId, tokenURI|
+    recs.each do |tokenId, tokenURI|
        puts "     tokenId #{tokenId}:"
-       if tokenURI.start_with?( 'data:application/json;base64')
-          ## on-blockchain!!!
-          ## decode base64
-
-          str = tokenURI.sub( 'data:application/json;base64', '' )
-          str = Base64.decode64( str )
-          data = JSON.parse( str )
-
-
-          ## check for image_data - and replace if base64 encoded
-          image_data = data['image_data']
-
-          if image_data.start_with?( 'data:image/svg+xml;base64' )
-            data['image_data'] = '...'
-            str = image_data.sub( 'data:image/svg+xml;base64', '' )
-             image_data = Base64.decode64( str )
-          end
-
-          pp data
+       meta = Meta.parse( tokenURI )
+       if meta.data.empty?   ## assume "off-blockchain" if no "on-blockchain" data found
+         puts "        #{tokenURI}"
+       else   ## assume "on-blockchain" data
+          pp meta.data
           puts
           puts "    image_data:"
-          puts image_data
-       else
-         puts "        #{tokenURI}"
+          puts meta.image_data
        end
     end
   end
 
 
 
-  JPGSIG   = "\xFF\xD8\xFF".force_encoding( Encoding::ASCII_8BIT )
-  PNGSIG   = "\x89PNG".force_encoding( Encoding::ASCII_8BIT )
-  GIF87SIG = "GIF87".force_encoding( Encoding::ASCII_8BIT )
-  GIF89SIG = "GIF89".force_encoding( Encoding::ASCII_8BIT )
-
-
-  def self.do_layers( contract_address )
+  def self.do_layers( contract_address, outdir: )
     puts "==> query layers for art collection contract @ >#{contract_address}<:"
 
-    c = Contract.new( contract_address )
-
-    name         =  c.name
-    symbol       =  c.symbol
-    totalSupply  =  c.totalSupply
-
-
-    traitDetails = []
-    n=0
-    loop do
-      m=0
-      loop do
-        rec = c.traitDetails( n, m )
-        break  if rec == ['','',false]
-
-        traitDetails << [[n,m], rec ]
-        m += 1
-        sleep( 0.5 )
-      end
-      break  if m==0
-      n += 1
-    end
-
-    headers = ['index', 'name', 'type', 'hide']
-    recs = []
-    traitDetails.each do |t|
-      recs << [ t[0].join('/'),
-                t[1][0],
-                t[1][1],
-                t[1][2].to_s]
-    end
-
-    buf = String.new('')
-    buf << headers.join( ', ' )
-    buf << "\n"
-    recs.each do |rec|
-       buf << rec.join( ', ' )
-       buf << "\n"
-    end
-
-    outdir = "./tmp/#{contract_address}"
-    write_text( "#{outdir}/layers.csv", buf )
-
-    #####
-    #  try to download all images
-    traitDetails.each do |t|
-      n,m  = t[0]
-      data = c.traitData( n, m )
-
-      basename = "#{n}_#{m}"
-      if data.start_with?( PNGSIG )
-        puts "BINGO!! it's a png blob"
-        write_blob( "#{outdir}/#{basename}.png", data )
-      elsif data.start_with?( GIF87SIG ) || data.start_with?( GIF89SIG )
-        puts "BINGO!! it's a gif blob"
-        write_blob( "#{outdir}/#{basename}.gif", data )
-      elsif data.start_with?( JPGSIG )
-        puts "BINGO!! it's a jpg blob"
-        write_blob( "#{outdir}/#{basename}.jpg", data )
-      else
-        puts "!! ERROR - unknown image format; sorry"
-        exit 1
-      end
-      sleep( 0.5 )
-    end
-
-
-    puts "   name: >#{name}<"
-    puts "   symbol: >#{symbol}<"
-    puts "   totalSupply: >#{totalSupply}<"
-    puts
-    puts "   traitDetails:"
-    pp  traitDetails
+    ArtQ.download_layers( contract_address,
+                          outdir: outdir )
   end
 
+  def self.do_tokens( contract_address, outdir: )
+    puts "==> query inline 'on-blockchain' token metadata & images for art collection contract @ >#{contract_address}<:"
+    ArtQ.download_tokens( contract_address,
+                          outdir: outdir )
+  end
 
 end  # class Tool
 end   # module ArtQ

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: artq
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-23 00:00:00.000000000 Z
+date: 2022-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethlite
@@ -76,6 +76,8 @@ files:
 - bin/artq
 - lib/artq.rb
 - lib/artq/contract.rb
+- lib/artq/layers.rb
+- lib/artq/tokens.rb
 - lib/artq/version.rb
 homepage: https://github.com/pixelartexchange/artbase
 licenses: