artq 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c9779a590a436cc490adf3f14a21c2a663c349a56cc2d3546fa3d7ca490ed157
-  data.tar.gz: 8c54bc4cdbc6e1626f13f5d445b39a0fa6d029f9330aefa030f37d7f8fa83558
+  metadata.gz: c0f00a597b6533cbdce4aa3286531d8533f9d3c0cf57b8147b7160d4b1d206d3
+  data.tar.gz: e192cfb230111adb5dd69a1213a1446a9dc629fc853cacb8b10e5d80ac723e8e
 SHA512:
-  metadata.gz: c75af5b52d7b37b752f9e7de03b5e3d7f84f8ead09cc3f537c1897c2468990a812b2de9b6fd2a44c1c54237bf6cc4120e63ea0b31b1c4bd907db58c56412ef82
-  data.tar.gz: d37f4a40864b66dccf69b629f07572f10abb38036047bd35e04947499f7de767800f87f8fe852414b9201835782589a8e6d237a60748d36d22d558140b2f763c
+  metadata.gz: 6bf4be0a1990ce7c1d6d6e2c30b936cc0a145401b2992b32e4f2c83153881746fdaab77de434a38409bc17c6c0cbb93ee4673a589767197b314b11b935078426
+  data.tar.gz: 65db2f2e2d112926111cb05398dd992a28d64f793a6f5d955b01a4cf03f1f25d9334d998b16088302479a07e6a3191712bc41d932c1b87d821f5d68b3e7b9974

data/Manifest.txt

@@ -4,4 +4,5 @@ README.md
 Rakefile
 bin/artq
 lib/artq.rb
+lib/artq/contract.rb
 lib/artq/version.rb

data/README.md

@@ -31,13 +31,14 @@ set INFURA_URI=https://mainnet.infura.io/v3/<YOUR_KEY_HERE>
 To use the artq command line tool pass in the art collection contract address in the hex (string) format.
 
 
-#### "Off-Blockchain" Token Metadata - Case No. 1
+#### Case No. 1 - "Off-Blockchain" Token Metadata
 
-Let's try Moonbirds - an ("off-blockchain") pixel art collection -
+Let's try Moonbirds - an "off-blockchain" pixel art collection -
 with the token contract / service at [0x23581767a106ae21c074b2276d25e5c3e136a68b](https://etherscan.io/address/0x23581767a106ae21c074b2276d25e5c3e136a68b):
 
 ```
-$ artq 0x23581767a106ae21c074b2276d25e5c3e136a68b
+$ artq 0x23581767a106ae21c074b2276d25e5c3e136a68b           # or
+$ artq 0x23581767a106ae21c074b2276d25e5c3e136a68b info
 ```
 
 resulting in:
@@ -48,11 +49,11 @@ symbol: >MOONBIRD<
 totalSupply: >10000<
 
 tokenURIs 0..2:
-  tokenId: 0
+  tokenId 0:
     https://live---metadata-5covpqijaa-uc.a.run.app/metadata/0
-  tokenId: 1
+  tokenId 1:
     https://live---metadata-5covpqijaa-uc.a.run.app/metadata/1
-  tokenId: 2
+  tokenId 2:
     https://live---metadata-5covpqijaa-uc.a.run.app/metadata/2
 ```
 
@@ -83,15 +84,16 @@ For example if you request  <https://live---metadata-5covpqijaa-uc.a.run.app/met
 
 
 
-####  "On-Blockchain" Token Metadata (With Inline Image)  - Case No. 2
+####  Case No. 2 - "On-Blockchain" Token Metadata (With Inline Image)
 
 
 
-Let's try The Saudis - an ("on-blockchain") pixel art collection -
+Let's try The Saudis - an "on-blockchain" pixel art collection -
 with the token contract / service at [0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1](https://etherscan.io/address/0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1):
 
 ```
-$ artq 0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1
+$ artq 0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1       # or
+$ artq 0xe21ebcd28d37a67757b9bc7b290f4c4928a430b1 info
 ```
 
 resulting in:
@@ -182,6 +184,164 @@ 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)
+
+
+Note:  Some "on-blockchain" pixel art collections
+include all layers, that is, metadata and images
+to compose / make-up "on-blockchain" token images "on-demand / on-the-fly" from "trait" building blocks from scratch.
+
+
+If the contract uses / supports:
+
+-  `traitDetails(uint256 _layerIndex, uint256 _traitIndex) returns (string _name, string _mimetype, bool _hide)` and
+-  `traitData(uint256 _layerIndex, uint256 _traitIndex) returns string`
+
+than you can "auto-magically" download all "on-blockchain" layers, that is, all metadata triplets by repeatedly calling `traitDetails` starting
+with index `0/0`, `0/1`, ..., `1/0`, `1/1`, ... and so on e.g.
+
+- `traitDetails( 0, 0 )`  => `["Rainbow Puke", "image/png", false]`
+- `traitDetails( 0, 1 )`  => `["Bubble Gum", "image/png", false]`
+- ...
+- `traitDetails( 1, 0 )`  =>  `["Gold Chain", "image/png", false]`
+- `traitDetails( 2, 1 )`  =>  `["Bowtie", "image/png", false]`
+- ...
+
+
+and all images (as binary blobs) by calling `traitData` e.g.
+
+- `traitData( 0, 0 )`  => `"\x89PNG..."`
+- `traitData( 0, 1 )`  => `"\x89PNG..."`
+- ...
+
+and so on.
+
+
+
+Let's try Mad Camels - an "on-blockchain" pixel art collection -
+with the token contract / service at [0xad8474ba5a7f6abc52708f171f57fefc5cdc8c1c](https://etherscan.io/address/0xad8474ba5a7f6abc52708f171f57fefc5cdc8c1c):
+
+
+```
+$ artq 0xad8474ba5a7f6abc52708f171f57fefc5cdc8c1c layers
+```
+
+resulting in a temp(orary) directory holding
+all images:
+
+```
+/0_0.png
+ 0_1.png
+ ...
+ 1_0.png
+ 1_1.png
+ ...
+```
+
+![](i/madcamels-32x32.png)
+
+
+and a  datafile with all metadata in the comma-separated values (csv) format, that is, `layers.csv` e.g:
+
+```
+index, name, type, hide
+0/0, Rainbow Puke, image/png, false
+0/1, Bubble Gum, image/png, false
+0/2, Vape, image/png, false
+0/3, None, image/png, false
+0/4, Cigarette, image/png, false
+0/5, Pipe, image/png, false
+1/0, Gold Chain, image/png, false
+1/1, Bowtie, image/png, false
+1/2, Gold Necklace, image/png, false
+1/3, None, image/png, false
+2/0, Eye Patch, image/png, false
+2/1, Nerd Glasses, image/png, false
+2/2, Blue Beams, image/png, false
+2/3, Purple Eye Shadow, image/png, false
+2/4, Gold Glasses, image/png, false
+2/5, Holographic, image/png, false
+2/6, Clown Eyes Red, image/png, false
+2/7, Clown Eyes Green, image/png, false
+2/8, Eye Mask, image/png, false
+2/9, Laser Eye, image/png, false
+2/10, VR, image/png, false
+2/11, 3D Glasses, image/png, false
+2/12, None, image/png, false
+2/13, Yellow Glasses, image/png, false
+2/14, Cool Glasses, image/png, false
+2/15, Purple Glasses, image/png, false
+2/16, Green Glasses, image/png, false
+3/0, Diamond, image/png, false
+3/1, Silver, image/png, false
+3/2, Gold, image/png, false
+3/3, None, image/png, false
+4/0, Crown, image/png, false
+4/1, Wireless Earphone, image/png, false
+4/2, Flower, image/png, false
+4/3, Fez, image/png, false
+4/4, Fire, image/png, false
+4/5, Beanie, image/png, false
+4/6, Headphone, image/png, false
+4/7, White Shemagh, image/png, false
+4/8, Red And White Shemagh, image/png, false
+4/9, Angle Ring, image/png, false
+4/10, Blue Mohawk, image/png, false
+4/11, Sombrero, image/png, false
+4/12, Red Mohawk, image/png, false
+4/13, Blue Bandana, image/png, false
+4/14, Viking, image/png, false
+4/15, Pilot Helmet, image/png, false
+4/16, Top Hat, image/png, false
+4/17, Captain Hat, image/png, false
+4/18, Thief Hat, image/png, false
+4/19, Orange Cap, image/png, false
+4/20, Pirate Bandana, image/png, false
+4/21, Knitted Cap, image/png, false
+4/22, Purple Cap, image/png, false
+4/23, Black Cap, image/png, false
+4/24, Pirate Hat, image/png, false
+4/25, None, image/png, false
+4/26, Red Cap, image/png, false
+4/27, Cop Hat, image/png, false
+4/28, Cowboy Hat, image/png, false
+4/29, Fedora, image/png, false
+5/0, Mole, image/png, false
+5/1, Pimple, image/png, false
+5/2, None, image/png, false
+6/0, Gold, image/png, false
+6/1, Cyborg, image/png, false
+6/2, Skeleton, image/png, false
+6/3, Female, image/png, false
+6/4, Robot, image/png, false
+6/5, Zombie, image/png, false
+6/6, Alien, image/png, false
+6/7, Default, image/png, false
+7/0, Desert, image/png, false
+7/1, Cream, image/png, false
+7/2, Pink, image/png, false
+7/3, Purple, image/png, false
+7/4, Green, image/png, false
+7/5, Blue, image/png, false
+```
+
+
+Try some more art collections with "on-blockchain" layers
+such as
+[Long Live Kevin](https://etherscan.io/address/0x8ae5523f76a5711fb6bdca1566df3f4707aec1c4),
+[Aliens vs Punks](https://etherscan.io/address/0x2612c0375c47ee510a1663169288f2e9eb912947),
+[Chi Chis](https://etherscan.io/address/0x2204a94f96d39df3b6bc0298cf068c8c82dc8d61),
+[Chopper](https://etherscan.io/address/0x090c8034e6706994945049e0ede1bbdf21498e6e),
+[Inverse Punks](https://etherscan.io/address/0xf3a1befc9643f94551c24a766afb87383ef64dd4),
+[Marcs](https://etherscan.io/address/0xe9b91d537c3aa5a3fa87275fbd2e4feaaed69bd0),
+[Phunk Ape Origins](https://etherscan.io/address/0x9b66d03fc1eee61a512341058e95f1a68dc3a913),
+[Punkin Spicies](https://etherscan.io/address/0x34625ecaa75c0ea33733a05c584f4cf112c10b6b),
+and many more.
+
+
+Tip:  See the [**Art Factory Sandbox**](https://github.com/pixelartexchange/artfactory.sandbox) for more art collections with "on-blockchain" layers.
+
+
 
 
 ## License

data/lib/artq/contract.rb

@@ -0,0 +1,73 @@
+
+module ArtQ
+
+
+class Contract
+
+  ## auto-add "well-known" methods for contract methods - why? why not?
+  METHODS = {
+    name: { inputs: [],
+            outputs: ['string'] },
+    symbol: { inputs: [],
+              outputs: ['string'] },
+    totalSupply: { inputs: [],
+                   outputs: ['uint256'] },
+    tokenURI: { inputs: ['uint256'],
+                outputs: ['string'] },
+
+    traitData: { inputs: ['uint256', 'uint256'],
+                 outputs: ['string'] },
+    traitDetails: { inputs: ['uint256', 'uint256'],
+                    outputs: ['(string,string,bool)'] },
+  }
+
+
+   METHODS.each do |name, m|
+     eth = Ethlite::ContractMethod.new( name.to_s,
+                                          inputs: m[:inputs],
+                                          outputs: m[:outputs] )
+
+      arity = m[:inputs].size
+      if arity == 0
+        define_method( name ) do
+            args = []
+            _do_call( eth, args )
+        end
+      elsif arity == 1
+        define_method( name ) do |arg0|
+          args = [arg0]
+          _do_call( eth, args )
+        end
+      elsif arity == 2
+        define_method( name ) do |arg0,arg1|
+          args = [arg0, arg1]
+          _do_call( eth, args )
+        end
+      else
+         raise ArgumentError, "unsupported no. of arguments #{m[:inputs]} (arity); sorry"
+      end
+   end
+
+
+
+   def self.rpc
+      @rpc ||= JsonRpc.new( ENV['INFURA_URI'] )
+   end
+
+   def self.rpc=(value)
+      @rpc = value.is_a?( String ) ? JsonRpc.new( value ) : value
+   end
+
+
+   def initialize( contract_address )
+      @contract_address = contract_address
+   end
+
+######
+#   private helper to call method
+   def _do_call( eth, args )
+     eth.do_call( self.class.rpc, @contract_address, args )
+   end
+
+end  # class Contract
+end   # module ArtQ

data/lib/artq/version.rb

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

data/lib/artq.rb

@@ -4,11 +4,16 @@ require 'optparse'
 
 ## our own code
 require_relative 'artq/version'   # let version go first
+require_relative 'artq/contract'
 
 
 
 module ArtQ
 
+
+
+
+
 class Tool
 
   def self.main( args=ARGV )
@@ -50,6 +55,8 @@ class Tool
 
     if ['i','inf','info'].include?( command )
         do_info( contract_address )
+    elsif ['l', 'layer', 'layers'].include?( command )
+        do_layers( contract_address )
     else
       puts "!! ERROR - unknown command >#{command}<, sorry"
     end
@@ -58,37 +65,22 @@ class Tool
   end
 
 
-  ETH_name = Ethlite::ContractMethod.new( 'name',
-                         inputs: [],
-                         outputs: ['string'] )
-
-  ETH_symbol = Ethlite::ContractMethod.new( 'symbol',
-                         inputs: [],
-                         outputs: ['string'] )
-
-  ETH_totalSupply = Ethlite::ContractMethod.new( 'totalSupply',
-                         inputs: [],
-                         outputs: ['uint256'] )
-
-  ETH_tokenURI     = Ethlite::ContractMethod.new( 'tokenURI',
-                        inputs: ['uint256'],
-                        outputs: ['string'] )
 
 
 
   def self.do_info( contract_address )
-    puts "==> query art collection contract info @ >#{contract_address}<:"
+    puts "==> query info for art collection contract @ >#{contract_address}<:"
 
-    rpc = JsonRpc.new( ENV['INFURA_URI'] )
+    c = Contract.new( contract_address )
 
-    name         =  ETH_name.do_call( rpc, contract_address, [] )
-    symbol       =  ETH_symbol.do_call( rpc, contract_address,  [] )
-    totalSupply  =  ETH_totalSupply.do_call( rpc, contract_address,  [] )
+    name         =  c.name
+    symbol       =  c.symbol
+    totalSupply  =  c.totalSupply
 
     meta = []
     tokenIds = (0..2)
     tokenIds.each do |tokenId|
-      tokenURI =        ETH_tokenURI.do_call( rpc, contract_address, [tokenId] )
+      tokenURI =        c.tokenURI( tokenId )
       meta << [tokenId, tokenURI]
     end
 
@@ -126,9 +118,95 @@ class Tool
        end
     end
   end
-end  # class Tool
 
 
+
+  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 )
+    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
+  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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2022-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethlite
@@ -75,6 +75,7 @@ files:
 - Rakefile
 - bin/artq
 - lib/artq.rb
+- lib/artq/contract.rb
 - lib/artq/version.rb
 homepage: https://github.com/pixelartexchange/artbase
 licenses: