artq 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e392049f9000bfe8a6b16ee2cad088a5fc7d2d4d76e0be088522ee6839e00822
-  data.tar.gz: '0904cfde265b254156d8a52cafbd6999a016d75e5ccad53a5bb5c1312efaae85'
+  metadata.gz: c9779a590a436cc490adf3f14a21c2a663c349a56cc2d3546fa3d7ca490ed157
+  data.tar.gz: 8c54bc4cdbc6e1626f13f5d445b39a0fa6d029f9330aefa030f37d7f8fa83558
 SHA512:
-  metadata.gz: dc71ccf9a977d4764218f3681ee72b3a34c3cd00638768c905c9037c77922fa4c3ad8dd154e195565b3d8d9b4e079b4b36cdda340036eb4d58f7456e668bfaa2
-  data.tar.gz: cf8653c6642afe656cad20b63e03b3689a315a246490dd6d7d153518f10f1269382a4a31d6b8eff0ed646bbc9828d538485730d52adb08d81597c9c19d1a5ba9
+  metadata.gz: c75af5b52d7b37b752f9e7de03b5e3d7f84f8ead09cc3f537c1897c2468990a812b2de9b6fd2a44c1c54237bf6cc4120e63ea0b31b1c4bd907db58c56412ef82
+  data.tar.gz: d37f4a40864b66dccf69b629f07572f10abb38036047bd35e04947499f7de767800f87f8fe852414b9201835782589a8e6d237a60748d36d22d558140b2f763c

data/Manifest.txt

@@ -2,5 +2,6 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
+bin/artq
 lib/artq.rb
 lib/artq/version.rb

data/README.md

@@ -1,6 +1,6 @@
 #  ArtQ
 
-artq - query (ethereum) blockchain contracts / services for data about art collections via json-rpc
+artq - query (ethereum) blockchain contracts / services for (meta) data about art collections via json-rpc
 
 
 * home  :: [github.com/pixelartexchange/artbase](https://github.com/pixelartexchange/artbase)
@@ -10,9 +10,178 @@ artq - query (ethereum) blockchain contracts / services for data about art colle
 
 
 
+
 ## Usage
 
-To be done
+
+### Step 0:  Setup JSON RPC Client
+
+The ArtQ command line tool
+gets the eth node uri via the INFURA_URI enviroment variable / key for now.
+Set the environment variable / key
+depending on your operating system (OS) e.g.:
+
+```
+set INFURA_URI=https://mainnet.infura.io/v3/<YOUR_KEY_HERE>
+```
+
+
+### Query (Token) Collection Info
+
+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
+
+Let's try Moonbirds - an ("off-blockchain") pixel art collection -
+with the token contract / service at [0x23581767a106ae21c074b2276d25e5c3e136a68b](https://etherscan.io/address/0x23581767a106ae21c074b2276d25e5c3e136a68b):
+
+```
+$ artq 0x23581767a106ae21c074b2276d25e5c3e136a68b
+```
+
+resulting in:
+
+```
+name: >Moonbirds<
+symbol: >MOONBIRD<
+totalSupply: >10000<
+
+tokenURIs 0..2:
+  tokenId: 0
+    https://live---metadata-5covpqijaa-uc.a.run.app/metadata/0
+  tokenId: 1
+    https://live---metadata-5covpqijaa-uc.a.run.app/metadata/1
+  tokenId: 2
+    https://live---metadata-5covpqijaa-uc.a.run.app/metadata/2
+```
+
+Note: By default the tokenURI method gets called / queried
+for the first tokens (e.g. 0, 1, 2, etc.).
+
+If you get a link back (e.g. starting with `https://` or `ipfs://`)
+than the art collection is "off-blockchain" and
+you MUST follow / request the link to get the token metadata.
+
+
+For example if you request  <https://live---metadata-5covpqijaa-uc.a.run.app/metadata/0>
+ you get back:
+
+``` json
+{"name":"#0",
+ "image":"https://live---metadata-5covpqijaa-uc.a.run.app/images/0",
+ "external_url":"https://moonbirds.xyz/",
+ "attributes":[
+  {"trait_type":"Eyes","value":"Angry"},
+  {"trait_type":"Outerwear","value":"Hoodie Down"},
+  {"trait_type":"Body","value":"Tabby"},
+  {"trait_type":"Feathers","value":"Gray"},
+  {"trait_type":"Background","value":"Green"},
+  {"trait_type":"Beak","value":"Small"}],
+ "x_debug":["orig:9650"]}
+```
+
+
+
+####  "On-Blockchain" Token Metadata (With Inline Image)  - Case No. 2
+
+
+
+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
+```
+
+resulting in:
+
+```
+name: >The Saudis<
+symbol: >SAUD<
+totalSupply: >5555<
+
+tokenURIs 0..2:
+  tokenId 0:
+```
+``` json
+{"name":"The Saudis #0",
+ "description":"Max Bidding",
+ "image_data": "...",
+ "external_url":"https://token.thesaudisnft.com/0",
+ "attributes":
+  [{"trait_type":"Head", "value":"Light 1"},
+   {"trait_type":"Hair", "value":"Bald"},
+   {"trait_type":"Facial Hair", "value":"Normal Brown Beard & Mustache"},
+   {"trait_type":"Headwear", "value":"Haram Police Cap"},
+   {"trait_type":"Eyewear", "value":"Regular Pixel Shades"},
+   {"trait_type":"Mouthpiece", "value":"None"}]}
+```
+
+```
+   tokenId 1:
+```
+``` json
+{"name":"The Saudis #1",
+ "description":"Max Bidding",
+ "image_data":  "...",
+ "external_url":"https://token.thesaudisnft.com/1",
+ "attributes":
+  [{"trait_type":"Head", "value":"Light 1"},
+   {"trait_type":"Hair", "value":"Long Widow's Peak"},
+   {"trait_type":"Facial Hair", "value":"Messy White Beard"},
+   {"trait_type":"Headwear", "value":"Brown Shemagh & Agal"},
+   {"trait_type":"Eyewear", "value":"Big Purple Shades"},
+   {"trait_type":"Mouthpiece", "value":"None"}]}
+```
+
+```
+  tokenId 2:
+```
+``` json
+{"name":"The Saudis #2 🛢" ,
+ "description":"Max Bidding",
+ "image_data":  "...",
+ "external_url":"https://token.thesaudisnft.com/2",
+ "attributes":
+  [{"trait_type":"Head", "value":"Dark 1"},
+   {"trait_type":"Hair", "value":"Short Buzz Cut"},
+   {"trait_type":"Facial Hair", "value":"Gradient Beard"},
+   {"trait_type":"Headwear", "value":"Brown Shemagh & Agal"},
+   {"trait_type":"Eyewear", "value":"Big Pixel Shades"},
+   {"trait_type":"Mouthpiece", "value":"Shadowless Vape"}]}
+```
+
+Note:  The artq command-line tool "auto-magically"
+decodes "on-blockchain"  metadata in the base64 format
+and inline svg images in the base64 format get "cut" from the metadata and "pasted" decoded.  Example for tokenId 0, that is, The Saudis #0:
+
+``` xml
+<svg xmlns="http://www.w3.org/2000/svg"
+      xmlns:xlink="http://www.w3.org/1999/xlink" image-rendering="pixelated"
+      height="336" width="336">
+  <foreignObject x="0" y="0" width="336" height="336">
+    <img xmlns="http://www.w3.org/1999/xhtml" height="336" width="336" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAJklEQVR42mNMbp32n4GGgHHUglELRi0YtWDUglELRi0YtWBoWAAAuD470bkESf4AAAAASUVORK5CYII="/>
+  </foreignObject>
+  <foreignObject x="0" y="0" width="336" height="336">
+     <img xmlns="http://www.w3.org/1999/xhtml" height="336" width="336" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAtklEQVRIiWNgGAXDHjASoeY/JfoJKfh/e2MDTklV/waCZjARYziPlCZWBVB5fD7EawHc8C/PrhNSRr4FlBhOlAWUAhZiFK3fdYqBgYGBIdDNDEOMEMDlA5TUUzZ1G4OHkRiKAmxi2ABRPsCWVPElX2SAMw6gaZxigMsCnJlH1b+BJMuJCiJkQGzQwMDgSKYwgBw0xPqEJAtIDR4GBgqDiJjSlGgf4Eg5BOsDUlMRMRUUCqB5KgIAHCwuITa/cDMAAAAASUVORK5CYII=" />
+  </foreignObject>
+  <foreignObject x="0" y="0" width="336" height="336">
+     <img xmlns="http://www.w3.org/1999/xhtml" height="336" width="336" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAaklEQVRIiWNgGAWjYBSMglEwBAAjPklnSZb/DAwMjDzCAgwbr7whywImItT8//L2Az4H4AUsRDqEoEGUWsDgLMnC8JSJFc6X/vebKhYwMiC5nlhDkQExcYAvIeBNJMRaADMI3TCChg8PAADd6xC7QG7FfAAAAABJRU5ErkJggg==" />
+  </foreignObject>
+  <foreignObject x="0" y="0" width="336" height="336">
+     <img xmlns="http://www.w3.org/1999/xhtml" height="336" width="336" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAcElEQVRIie2SsQ3AIAwEnwzDCpTMyiguGQEvQ5okQoljTNL6KiSes3gAnAlhIdu/nNOCoxAx5WvNlcyet40+CmccA0XXZrbcaIXQyuMm5gFBqEGEKyGmvFwRMLzBrC6tIvU3nGKu1LWcxeU4juP8YQdbhhrmTahwzwAAAABJRU5ErkJggg==" />
+  </foreignObject>
+  <foreignObject x="0" y="0" width="336" height="336">
+     <img xmlns="http://www.w3.org/1999/xhtml" height="336" width="336" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAATElEQVRIie2PwQoAIAhDXf//z+tQgYnWoVOwdxHm2NRMCPE/qBYkDQBfs1rpDuEk10SmV5QFPmh+k3lSfTv0UDAM7hNfGvVbkRDiZzpfrCH/gTYLqwAAAABJRU5ErkJggg==" />
+  </foreignObject>
+  <foreignObject x="0" y="0" width="336" height="336">
+     <img xmlns="http://www.w3.org/1999/xhtml" height="336" width="336" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAAJklEQVRIie3NMQEAAAjDMMC/52ECvlRA00nqs3m9AwAAAAAAAJy1C7oDLddyCRYAAAAASUVORK5CYII=" />
+     </foreignObject>
+  </svg>
+```
+
+
 
 
 ## License

data/Rakefile

@@ -6,7 +6,7 @@ Hoe.spec 'artq' do
 
   self.version = ArtQ::VERSION
 
-  self.summary = "artq - query (ethereum) blockchain contracts / services for data about art collections via json-rpc"
+  self.summary = "artq - query (ethereum) blockchain contracts / services for (meta) data about art collections via json-rpc"
   self.description = summary
 
   self.urls    = { home: 'https://github.com/pixelartexchange/artbase' }

data/bin/artq

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

data/lib/artq/version.rb

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

data/lib/artq.rb

@@ -1,6 +1,136 @@
+require 'ethlite'
+require 'optparse'
 
 
-require_relative 'artq/version'
+## our own code
+require_relative 'artq/version'   # let version go first
+
+
+
+module ArtQ
+
+class Tool
+
+  def self.main( args=ARGV )
+    puts "==> welcome to artq tool with args:"
+    pp args
+
+    options = {
+              }
+
+    parser = OptionParser.new do |opts|
+
+      opts.on("--rpc STRING",
+              "JSON RPC Host (default: nil)") do |str|
+          options[ :rpc]  = 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 collection found - use <collection> <command>..."
+      puts ""
+      exit
+    end
+
+    contract_address = args[0]   ## todo/check - use collection_name/slug or such?
+    command          = args[1] || 'info'
+
+
+    if ['i','inf','info'].include?( command )
+        do_info( contract_address )
+    else
+      puts "!! ERROR - unknown command >#{command}<, sorry"
+    end
+
+    puts "bye"
+  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}<:"
+
+    rpc = JsonRpc.new( ENV['INFURA_URI'] )
+
+    name         =  ETH_name.do_call( rpc, contract_address, [] )
+    symbol       =  ETH_symbol.do_call( rpc, contract_address,  [] )
+    totalSupply  =  ETH_totalSupply.do_call( rpc, contract_address,  [] )
+
+    meta = []
+    tokenIds = (0..2)
+    tokenIds.each do |tokenId|
+      tokenURI =        ETH_tokenURI.do_call( rpc, contract_address, [tokenId] )
+      meta << [tokenId, tokenURI]
+    end
+
+    puts "   name: >#{name}<"
+    puts "   symbol: >#{symbol}<"
+    puts "   totalSupply: >#{totalSupply}<"
+    puts
+    puts "   tokenURIs #{tokenIds}:"
+    meta.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
+          puts
+          puts "    image_data:"
+          puts image_data
+       else
+         puts "        #{tokenURI}"
+       end
+    end
+  end
+end  # class Tool
+
+
+end   # module ArtQ
+
 
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: artq
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -58,10 +58,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: artq - query (ethereum) blockchain contracts / services for data about
-  art collections via json-rpc
+description: artq - query (ethereum) blockchain contracts / services for (meta) data
+  about art collections via json-rpc
 email: wwwmake@googlegroups.com
-executables: []
+executables:
+- artq
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
@@ -72,6 +73,7 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/artq
 - lib/artq.rb
 - lib/artq/version.rb
 homepage: https://github.com/pixelartexchange/artbase
@@ -98,6 +100,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: artq - query (ethereum) blockchain contracts / services for data about art
-  collections via json-rpc
+summary: artq - query (ethereum) blockchain contracts / services for (meta) data about
+  art collections via json-rpc
 test_files: []