ordinals 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8713aa7b98dcb5356b762898b13ab4539313ef8621f2930b5291519edd759f50
-  data.tar.gz: 6c4a9f720237c5e6468eede3f7b69988ecbdcf5fd347749cd9f18dd9de0fdb6a
+  metadata.gz: 23ab1c1b894f3d7d528d90943d890e07c40d878cc56b54206384be335ae47fa6
+  data.tar.gz: f3ca9276b04d13052424d9a4834204d7153a92681507efac9c8511949e6ec362
 SHA512:
-  metadata.gz: 803d2f9357b35101f2572767de7f7176966d077b2b87bef45b2cb6c1f90c80ec4513d71aad231e08ddc5a112683ac0c24139a40e832f714dac05b47039654b3f
-  data.tar.gz: 64071daa9c9c4352174a4be0c5cce8a7ee5d407920c922f29cadf8d015ab5ce963cc922f665039bfa3397142383aeeef3cff4e8c4650ec96faec32a33f6bddf3
+  metadata.gz: a91a05ebbaf2ab66030ef45bf9a8da6744df0f40d3014451364f1d802a0193c0a7450f90647612e95c6469b7c21a6f8c6f04a10e3a354d820cafa88de32ccc6b
+  data.tar.gz: 30ca5d81426d13f3149a37f9eb8a7bc3a703c22d9cf0685c991033273ae81efe4917fce3d00f68aadfaf9742ab0d626bdc6e290a2f52c8b2c967b0453ebaa475

data/Manifest.txt

@@ -4,4 +4,7 @@ README.md
 Rakefile
 bin/ordbase
 lib/ordinals.rb
+lib/ordinals/api.rb
 lib/ordinals/collection.rb
+lib/ordinals/stats.rb
+lib/ordinals/tool.rb

data/README.md

@@ -1,6 +1,6 @@
 # ordinals
 
-ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin & co.
+ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin, Litcoin, Dogecoin & co.
 
 
 * home  :: [github.com/pixelartexchange/ordinals.sandbox](https://github.com/pixelartexchange/ordinals.sandbox)
@@ -9,7 +9,8 @@ ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & help
 * rdoc  :: [rubydoc.info/gems/ordinals](http://rubydoc.info/gems/ordinals)
 
 
-## Comand-Line Usage
+
+## Command-Line Usage
 
 Let's use the 100 Ordinal Punks collection to try out the
 `ordbase` command-line tool shipping with the ordinals package.
@@ -165,6 +166,6 @@ Use it as you please with no restrictions whatsoever.
 
 ## Questions? Comments?
 
+Post them over at the [Help & Support](https://github.com/geraldb/help) page. Thanks.
 
-Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
 

data/Rakefile

@@ -10,9 +10,9 @@ end
 
 Hoe.spec 'ordinals' do
 
-  self.version = '0.1.0'
+  self.version = '1.0.0'
 
-  self.summary = 'ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin & co.'
+  self.summary = 'ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin, Litecoin, Dogecoin & co.'
   self.description = summary
 
   self.urls    = { home: 'https://github.com/pixelartexchange/ordinals.sandbox' }
@@ -27,6 +27,7 @@ Hoe.spec 'ordinals' do
   self.extra_deps = [
     ['cocos'],
     ['pixelart'],
+    ['nokogiri'],   ## required / used by api support (html parsing)
   ]
 
   self.licenses = ['Public Domain']

data/lib/ordinals/api.rb

@@ -0,0 +1,224 @@
+
+
+module Ordinals
+
+
+class Api   ## change/rename Api to Client - why? why not?
+  def self.litecoin
+    @litecoin ||= new( 'https://litecoin.earlyordies.com' )
+    @litecoin
+  end
+
+  def self.bitcoin
+    @bitcoin ||= new( 'https://ordinals.com' )
+    @bitcoin
+  end
+  ## todo:  add ltc and btc alias - why? why not?
+
+  def self.dogecoin
+    ## note: "doginals" call inscriptions
+    ##                     shibescriptions
+    @dogecoin ||= new( 'https://doginals.com', inscription: 'shibescription' )
+    @dogecoin
+  end
+
+
+  def initialize( base, inscription: 'inscription' )
+    @base        = base
+    @inscription = inscription
+  end
+
+
+###
+# use a struct-like content class - why? why not?
+class Content
+  attr_reader :data,
+              :type,
+              :length
+  def initialize( data, type, length )
+    @data   = data
+    @type   = type
+    @length = length
+  end
+
+  alias_method :blob, :data
+end  ## (nested) class Content
+
+
+
+  def content( id )
+     src = "#{@base}/content/#{id}"
+     res = get( src )
+
+     content_type   = res.content_type
+     content_length = res.content_length
+
+     ## note - content_length -- returns an integer (number)
+     ## puts "content_length:"
+     ## print content_length.inspect
+     ## print " - #{content_length.class.name}\n"
+
+     content = Content.new(
+                    res.blob,
+                    content_type,
+                    content_length )
+     content
+  end
+
+
+=begin
+<dl>
+  <dt>id</dt>
+  <dd class=monospace>d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2i0</dd>
+  <dt>address</dt>
+  <dd class=monospace>bc1pqapcyswesvccgqsmuncd96ylghs9juthqeshdr8smmh9w7azn8zsghjjar</dd>
+  <dt>output value</dt>
+  <dd>10000</dd>
+  <dt>sat</dt>
+  <dd><a href=/sat/1320953397332258>1320953397332258</a></dd>
+  <dt>preview</dt>
+  <dd><a href=/preview/d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2i0>link</a></dd>
+  <dt>content</dt>
+  <dd><a href=/content/d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2i0>link</a></dd>
+  <dt>content length</dt>
+  <dd>71997 bytes</dd>
+  <dt>content type</dt>
+  <dd>text/plain;charset=utf-8</dd>
+  <dt>timestamp</dt>
+  <dd><time>2023-02-11 21:39:00 UTC</time></dd>
+  <dt>genesis height</dt>
+  <dd><a href=/block/776090>776090</a></dd>
+  <dt>genesis fee</dt>
+  <dd>273630</dd>
+  <dt>genesis transaction</dt>
+  <dd><a class=monospace href=/tx/d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2>d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2</a></dd>
+  <dt>location</dt>
+  <dd class=monospace>d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2:0:0</dd>
+  <dt>output</dt>
+  <dd><a class=monospace href=/output/d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2:0>d026ac5994f698dba475681359b6c29d6d39a895484b95e06b7ae49921d80df2:0</a></dd>
+  <dt>offset</dt>
+  <dd>0</dd>
+</dl>
+
+<dl>
+  <dt>id</dt>
+  <dd class=monospace>acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37i0</dd>
+  <dt>address</dt>
+  <dd class=monospace>bc1qx3scwushtwenxtxlnjet4x2w5vg35etdtse5u0</dd>
+  <dt>output value</dt>
+  <dd>8020</dd>
+  <dt>sat</dt>
+  <dd><a href=/sat/1883186433806857>1883186433806857</a></dd>
+  <dt>preview</dt>
+  <dd><a href=/preview/acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37i0>link</a></dd>
+  <dt>content</dt>
+  <dd><a href=/content/acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37i0>link</a></dd>
+  <dt>content length</dt>
+  <dd>529 bytes</dd>
+  <dt>content type</dt>
+  <dd>image/png</dd>
+  <dt>timestamp</dt>
+  <dd><time>2023-01-31 19:34:47 UTC</time></dd>
+  <dt>genesis height</dt>
+  <dd><a href=/block/774489>774489</a></dd>
+  <dt>genesis fee</dt>
+  <dd>5340</dd>
+  <dt>genesis transaction</dt>
+  <dd><a class=monospace href=/tx/acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37>acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37</a></dd>
+  <dt>location</dt>
+  <dd class=monospace>6630ff2153985504b180fc16721d559a4cecdc66f4be6acf33509ec2100c0aa5:0:0</dd>
+  <dt>output</dt>
+  <dd><a class=monospace href=/output/6630ff2153985504b180fc16721d559a4cecdc66f4be6acf33509ec2100c0aa5:0>6630ff2153985504b180fc16721d559a4cecdc66f4be6acf33509ec2100c0aa5:0</a></dd>
+  <dt>offset</dt>
+  <dd>0</dd>
+</dl>
+
+
+
+<title>Inscription 407</title>
+
+id =
+ genesis transaction + offset ???
+
+genesis transaction: acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37
+id:                  acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37i0
+address:      bc1qx3scwushtwenxtxlnjet4x2w5vg35etdtse5u0
+output value: 8020
+sat:          1883186433806857
+content length: 529 bytes
+content type:  image/png
+timestamp: 2023-01-31 19:34:47 UTC
+genesis height: 774489
+genesis fee:  5340
+genesis transaction: acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37>acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37
+location: 6630ff2153985504b180fc16721d559a4cecdc66f4be6acf33509ec2100c0aa5:0:0
+output:   6630ff2153985504b180fc16721d559a4cecdc66f4be6acf33509ec2100c0aa5:0
+offset: 0
+
+=end
+
+  def inscription( id )
+    src = "#{@base}/#{@inscription}/#{id}"
+    res = get( src )
+
+    data = _parse_inscription( res.text )
+    data
+  end
+
+
+  def _parse_inscription( html )
+    doc = Nokogiri::HTML( html )
+
+    items = []
+
+    title = doc.css( 'head title' )
+    items << ['title', title.text]
+
+
+    dls = doc.css( 'body dl' )
+    dls[0].css( 'dt,dd' ).each do |el|
+       if el.name == 'dt'
+            items << [el.text]
+       elsif el.name == 'dd'
+            items[-1] << el.text
+       else
+         puts "!! ERROR - unexpected tag; expected dd|dl; got: #{el.name}"
+         exit 1
+       end
+    end
+    items
+
+    ## convert to hash
+    ##   and check for duplicate
+    data = {}
+    items.each do |k,v|
+        k = k.strip
+        v = v.strip
+        if data.has_key?( k )
+           puts "!! ERROR - duplicate key >#{k}< in:"
+           pp items
+           exit 1
+        end
+        data[ k ] = v
+    end
+    data
+  end
+
+
+  def get( src )
+    res = Webclient.get( src )
+    if res.status.ok?
+      res
+    else
+      puts "!! ERROR - HTTP #{res.status.code} #{res.status.message} - failed web request >#{src}<; sorry"
+      exit 1
+    end
+  end
+end  # class Api
+
+##
+##  add convenience alias
+API = Api
+
+end   ## module Ordinals
+

data/lib/ordinals/collection.rb

@@ -44,8 +44,8 @@ alias_method :size, :count
 
 
 def each_ordinal( &block )
-  ordinals.each do |rec|   ## pass along hash rec for now - why? why not?
-    block.call( rec )
+  ordinals.each_with_index do |rec, i|   ## pass along hash rec for now - why? why not?
+    block.call( rec, i )
   end
 end
 
@@ -54,9 +54,9 @@ end
 
 
 def each_image( &block )
-  each_ordinal do |rec|
-    id  = rec['id']
-    num = rec['num'].to_i(10)
+  each_ordinal do |rec, i|
+    id   = rec['id']
+    num  = rec.has_key?('num') ? rec['num'].to_i(10) : i+1
 
     path = "./#{@slug}/#{@width}x#{@height}/#{num}.png"
     img = Image.read( path )
@@ -78,9 +78,9 @@ end
 
 
 def pixelate
-  each_ordinal do |rec|
-    id  = rec['id']
-    num = rec['num']
+  each_ordinal do |rec, i|
+    id   = rec['id']
+    num  = rec.has_key?('num') ? rec['num'].to_i(10) : i+1
 
     outpath = "./#{@slug}/#{@width}x#{@height}/#{num}.png"
     next if File.exist?( outpath )
@@ -113,14 +113,24 @@ def pixelate
 end
 
 
+
+
 def make_composite
   cols, rows = case count
                when    10 then   [5,   2]
+               when    12 then   [4,   3]
                when    15 then   [5,   3]
+               when    20 then   [5,   4]
+               when    50 then   [10,  5]
                when    69 then   [10,  7]
-               when    99 then   [10,  10]
+               when    80 then   [10,  8]
+               when    88 then   [10,  9]
+               when 98,99 then   [10,  10]
                when   100 then   [10,  10]
+               when   101 then   [11,  10]
                when   111 then   [11,  11]
+               when   130 then   [10,  13]
+               when   512 then   [20,  26]
                else
                    raise ArgumentError, "sorry - unknown composite count #{count} for now"
                end
@@ -141,51 +151,103 @@ end
 
 
 def convert_images
-  ## todo: check for gifs too - why? why not?
   Image.convert( image_dir, from: 'jpg',
                             to:   'png' )
+
+  Image.convert( image_dir, from: 'gif',
+                            to:   'png' )
+
+  Image.convert( image_dir, from: 'webp',
+                            to:   'png' )
+end
+
+
+
+def fix_images   ## todo - find a different names for resaving png images?
+  ##  "repair" png images
+  ##    starting w/
+  ##  - why?
+  ##
+  ## verify_signature! - ChunkyPNG::SignatureMismatch:
+  ##  PNG signature not found,
+  ##  found     "RIFF\\xFE\\b\\x00\\x00"
+  ##  instead of "\\x89PNG\\r\\n\\x1A\\n"
+
+  Image.convert( image_dir, from: 'png',
+                            to:   'png' )
+end
+
+
+def download_meta   ## inscription metadata
+  each_ordinal do |rec, i|
+    id   = rec['id']
+    num  = rec.has_key?('num') ? rec['num'].to_i(10) : i+1
+
+    chain = Ordinals.config.chain
+    path = "../ordinals.cache/#{chain}/#{id}.json"
+    next if File.exist?( path )
+
+    puts "==> downloading #{chain} inscription meta #{num} w/ id #{id}..."
+
+    data = Ordinals.client.inscription( id )
+
+    write_json( path, data )
+
+    sleep( 1.0 )  ## sleep (delay_in_s)
+  end
+end
+
+def dump_stats
+  stats = InscriptionStats.new
+
+  each_ordinal do |rec, i|
+    id   = rec['id']
+
+    chain = Ordinals.config.chain
+    path = "../ordinals.cache/#{chain}/#{id}.json"
+
+    data = read_json( path )
+    stats.update( data )
+  end
+
+  pp stats.data
+  puts
+  puts stats.format
 end
 
 
 def download_images
-  each_ordinal do |rec|
-    id  = rec['id']
-    num = rec['num']
+  each_ordinal do |rec, i|
+    id   = rec['id']
+    num  = rec.has_key?('num') ? rec['num'].to_i(10) : i+1
 
     next if File.exist?( "#{image_dir}/#{num}.png" )
 
     puts "==> downloading image ##{num}..."
 
-    image_url = "https://ordinals.com/content/#{id}"
 
-    res = Webclient.get( image_url )
+    content = Ordinals.client.content( id )
 
-    if res.status.ok?
-      content_type   = res.content_type
-      content_length = res.content_length
+      puts "  content_type: #{content.type}, content_length: #{content.length}"
 
-      puts "  content_type: #{content_type}, content_length: #{content_length}"
-
-      format = if content_type =~ %r{image/jpeg}i
+      format = if content.type =~ %r{image/jpeg}i
                  'jpg'
-               elsif content_type =~ %r{image/png}i
+               elsif content.type =~ %r{image/png}i
                 'png'
-               elsif content_type =~ %r{image/gif}i
+               elsif content.type =~ %r{image/gif}i
                  'gif'
+               elsif content.type =~ %r{image/webp}i
+                 'webp'
                else
                  puts "!! ERROR:"
-                 puts " unknown image format content type: >#{content_type}<"
+                 puts " unknown image format content type: >#{content.type}<"
                  exit 1
                end
 
       ## save image - using b(inary) mode
-      write_blob( "#{image_dir}/#{num}.#{format}", res.blob )
+      write_blob( "#{image_dir}/#{num}.#{format}", content.blob )
 
       sleep( 1.0 )  ## sleep (delay_in_s)
-    else
-      puts "!! ERROR - failed to download image; sorry - #{res.status.code} #{res.status.message}"
-      exit 1
-    end
   end
 end
 

data/lib/ordinals/stats.rb

@@ -0,0 +1,142 @@
+
+
+class InscriptionStats
+
+  TITLE_RX = /^Inscription[ ]+(?<ord>[0-9]+)$/
+  BYTES_RX = /^(?<bytes>[0-9]+)[ ]+bytes$/
+
+  def initialize
+    @stats = {
+      count: 0,
+      ord: { '<1000'  => 0,
+             '<10000' => 0,
+             '<100000' => 0,
+             '<1000000' => 0,
+             'min' => nil,
+             'max' => nil, },
+      type: Hash.new(0),
+      bytes:  {  '<100'  => 0,
+                 '<1000' => 0,
+                 '<10000' => 0,
+                 '<100000' => 0,
+                 '<1000000' => 0,
+                 'min' => nil,
+                 'max' => nil, },
+    }
+
+    @days = Hash.new(0)
+  end
+
+  def size()  @stats[:count]; end
+
+
+
+  def update( data )
+    data = JSON.parse( data)   if data.is_a?( String )
+
+    @stats[ :count ] += 1
+
+
+    ord = nil
+    if m=TITLE_RX.match( data['title'] )
+        ord = m[:ord].to_i(10)
+    else
+        puts "!! ERROR - cannot find ord in inscription title; sorry"
+        pp data
+        exit 1
+    end
+
+    if     ord < 1000    then  @stats[:ord]['<1000'] += 1
+    elsif  ord < 10000   then  @stats[:ord]['<10000'] += 1
+    elsif  ord < 100000  then  @stats[:ord]['<100000'] += 1
+    elsif  ord < 1000000 then  @stats[:ord]['<1000000'] += 1
+    else
+      puts "!! ERROR ord out-of-bounds"
+      exit 1
+    end
+
+    ## update min/max
+    @stats[:ord]['min'] = ord   if ord < (@stats[:ord]['min'] || 9999999)
+    @stats[:ord]['max'] = ord   if ord > (@stats[:ord]['max'] || -1)
+
+
+    bytes = nil
+    if m=BYTES_RX.match( data['content length'] )
+        bytes = m[:bytes].to_i(10)
+    else
+        puts "!! ERROR - cannot find bytes in inscription content length; sorry"
+        pp data
+        exit 1
+    end
+
+    if     bytes < 100     then  @stats[:bytes]['<100'] += 1
+    elsif  bytes < 1000    then  @stats[:bytes]['<1000'] += 1
+    elsif  bytes < 10000   then  @stats[:bytes]['<10000'] += 1
+    elsif  bytes < 100000  then  @stats[:bytes]['<100000'] += 1
+    elsif  bytes < 1000000 then  @stats[:bytes]['<1000000'] += 1
+    else
+      puts "!! ERROR bytes (content-length) out-of-bounds"
+      exit 1
+    end
+
+    ## update min/max
+    @stats[:bytes]['min'] = bytes   if bytes < (@stats[:bytes]['min'] || 9999999)
+    @stats[:bytes]['max'] = bytes   if bytes > (@stats[:bytes]['max'] || -1)
+
+
+    type = data['content type']
+
+    @stats[:type][ type ] += 1
+
+    ## "timestamp"=>"2023-02-05 01:45:22 UTC",
+    ts = Time.strptime( data['timestamp'], '%Y-%m-%d %H:%M:%S' )
+
+    @days[ ts.strftime('%Y-%m-%d') ] +=1
+  end  # method update
+
+
+  def data   ## rename to model or such - why? why not?
+     ## sort days
+     days = @days.sort {|l,r|  l[0] <=> r[0] }
+     ## add to stats
+     @stats[:days] = {}
+     days.each {|k,v| @stats[:days][k] = v }
+     @stats
+  end
+
+=begin
+{:count=>101,
+ :ord=>{"<1000"=>0, "<10000"=>0, "<100000"=>101, "<1000000"=>0, "min"=>14343, "max"=>42901},
+ :type=>{"image/png"=>101},
+ :bytes=>{"<100"=>0, "<1000"=>101, "<10000"=>0, "<100000"=>0, "<1000000"=>0, "min"=>274, "max"=>512},
+ :days=>{"2023-02-22"=>10, "2023-02-25"=>17, "2023-02-26"=>74}}
+=end
+
+  def format   ## rename to pretty_print or such - why? why not?
+     stat = data
+
+     buf = String.new('')
+     buf << "#{stat[:count]} inscription(s)\n"
+
+     buf << "- from ##{stat[:ord]['min']} to ##{stat[:ord]['max']} (min. to max.)\n"
+     buf << "     - <1000 => #{stat[:ord]['<1000']}\n"         if stat[:ord]["<1000"] > 0
+     buf << "     - <10000 => #{stat[:ord]['<10000']}\n"      if stat[:ord]["<10000"] > 0
+     buf << "     - <100000 => #{stat[:ord]['<100000']}\n"    if stat[:ord]["<100000"] > 0
+     buf << "     - <1000000 => #{stat[:ord]['<1000000']}\n"  if stat[:ord]["<1000000"] > 0
+
+     buf << "- format(s)\n"
+     stat[:type].each do |k,v|
+        buf << "     - #{k} => #{v}\n"
+     end
+
+     buf << "- day(s)\n"
+     stat[:days].each do |k,v|
+       buf << "     - #{k} => #{v}\n"
+     end
+
+     buf
+  end
+
+end  ## class InscriptionStats
+
+

data/lib/ordinals/tool.rb

@@ -0,0 +1,121 @@
+module Ordinals
+class Tool
+
+  def self.main( args=ARGV )
+    puts "==> welcome to ordinals/ordbase tool with args:"
+    pp args
+
+    options = {
+              }
+
+    parser = OptionParser.new do |opts|
+      opts.on( "--doge", "--dogecoin", "Use Dogecoin / DOGE") do
+        ## switch to doge
+        Ordinals.config.chain = :doge
+      end
+      opts.on( "--ltc", "--litecoin", "Use Litecoin / LTC") do
+          ## switch to ltc
+          Ordinals.config.chain = :ltc
+      end
+      opts.on( "--btc", "--bitcoin", "Use Bitcoin / BTC") do
+          ## switch to btc  (default)
+          Ordinals.config.chain = :btc
+      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
+
+    slug             = args[0]
+    command          = args[1] || 'image'
+
+    if ['m', 'meta'].include?( command )
+      do_download_meta( slug )
+    elsif ['stat', 'stats'].include?( command )
+      do_dump_stats( slug )
+    elsif ['i','img', 'image'].include?( command )
+      do_download_images( slug )
+    elsif ['conv','convert'].include?( command )
+      do_convert_images( slug )
+    elsif ['fix'].include?( command )
+      do_fix_images( slug )
+    elsif ['px','pix', 'pixelate' ].include?( command )
+      do_pixelate( slug )
+    elsif ['comp','composite' ].include?( command )
+      do_make_composite( slug )
+    else
+      puts "!! ERROR - unknown command >#{command}<, sorry"
+    end
+
+    puts "bye"
+  end
+
+
+  def self.do_dump_stats( slug )
+    puts "==> dump inscription stats for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.dump_stats
+  end
+
+  def self.do_download_meta( slug )
+    puts "==> download meta for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.download_meta
+  end
+
+  def self.do_download_images( slug )
+    puts "==> download images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.download_images
+  end
+
+
+  def self.do_convert_images( slug )
+    puts "==> convert images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.convert_images
+  end
+
+  def self.do_fix_images( slug )
+    puts "==> fix images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.fix_images
+  end
+
+
+  def self.do_pixelate( slug )
+    puts "==> downsample / pixelate images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.pixelate
+  end
+
+  def self.do_make_composite( slug )
+    puts "==> make composite for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.make_composite
+  end
+
+end  # class Tool
+end   # module Ordinals

data/lib/ordinals.rb

@@ -5,91 +5,88 @@ require 'pixelart'
 require 'optparse'
 
 
-
-## our own code
-require_relative 'ordinals/collection'
-
+## add nokogiri for api (html parsing)
+require 'nokogiri'
 
 
-module Ordinals
-class Tool
-
-  def self.main( args=ARGV )
-    puts "==> welcome to ordinals/ordbase tool with args:"
-    pp args
 
-    options = {
-              }
 
-    parser = OptionParser.new do |opts|
 
-      opts.on("-h", "--help", "Prints this help") do
-        puts opts
-        exit
-      end
+module Ordinals
+  class Configuration
+
+    #######################
+    ## accessors
+    def chain=(value)
+        if value.is_a?( String ) || value.is_a?( Symbol )
+            case value.downcase.to_s
+            when 'btc', 'bitcoin', 'bitcon'
+               @chain  = 'btc'
+               @client = Ordinals::Api.bitcoin
+            when 'ltc', 'litecoin', 'litecon'
+               @chain = 'ltc'
+               @client = Ordinals::Api.litecoin
+            when 'doge', 'dogecoin', 'dogecon'
+               @chain = 'doge'
+               @client = Ordinals::Api.dogecoin
+            else
+              raise ArgumentError, "unknown chain - expected btc | ltc | doge; got #{value}"
+            end
+        else
+            raise ArgumentError, "only string or symbol supported for now; sorry - got: #{value.inspect} : #{value.class.name}"
+        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
+    def chain
+      ## note - default to btc/bitcon if not set
+      self.chain = 'btc'   unless defined?( @chain )
+      @chain
     end
 
-    slug             = args[0]
-    command          = args[1] || 'image'
-
-    if ['i','img', 'image'].include?( command )
-      do_download_images( slug )
-    elsif ['conv','convert'].include?( command )
-      do_convert_images( slug )
-    elsif ['px','pixelate' ].include?( command )
-      do_pixelate( slug )
-    elsif ['comp','composite' ].include?( command )
-      do_make_composite( slug )
-    else
-      puts "!! ERROR - unknown command >#{command}<, sorry"
+    ## note: read-only for now - why? why not?
+    def client
+      ## note - default to btc/bitcon if not set
+      self.chain = 'btc'   unless defined?( @client )
+      @client
     end
+  end # class Configuration
 
-    puts "bye"
-  end
 
+  ## lets you use
+  ##   Ordinals.configure do |config|
+  ##      config.chain = :btc
+  ##   end
+  def self.configure() yield( config ); end
+  def self.config()    @config ||= Configuration.new;  end
 
+  ##  add some convenience shortcut helpers (no config. required) - why? why not?
+  def self.client()   config.client; end
+  def self.chain()    config.chain; end
 
-  def self.do_download_images( slug )
-    puts "==> download images for collection >#{slug}<..."
+  def self.btc?()     config.chain == 'btc'; end
+  def self.ltc?()     config.chain == 'ltc'; end
+  def self.doge?()    config.chain == 'doge'; end
+  class << self
+    alias_method :bitcoin?, :btc?
+    alias_method :bitcon?,  :btc?
 
-    col = Collection.new( slug )
-    col.download_images
+    alias_method :litecoin?, :ltc?
+    alias_method :litecon?,  :ltc?
+
+    alias_method :dogecoin?, :doge?
+    alias_method :dogecon?,  :doge?
   end
+end  # module Ordinals
 
 
-  def self.do_convert_images( slug )
-    puts "==> convert images for collection >#{slug}<..."
 
-    col = Collection.new( slug )
-    col.convert_images
-  end
 
-  def self.do_pixelate( slug )
-    puts "==> downsample / pixelate images for collection >#{slug}<..."
+## our own code
+require_relative 'ordinals/api'
+require_relative 'ordinals/collection'
+require_relative 'ordinals/stats'
 
-    col = Collection.new( slug )
-    col.pixelate
-  end
+require_relative 'ordinals/tool'
 
-  def self.do_make_composite( slug )
-    puts "==> make composite for collection >#{slug}<..."
 
-    col = Collection.new( slug )
-    col.make_composite
-  end
 
-end  # class Tool
-end   # module Ordinals

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordinals
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-13 00:00:00.000000000 Z
+date: 2023-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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
@@ -73,7 +87,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.23'
 description: ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery
-  & helpers for Bitcoin & co.
+  & helpers for Bitcoin, Litecoin, Dogecoin & co.
 email: wwwmake@googlegroups.com
 executables:
 - ordbase
@@ -89,7 +103,10 @@ files:
 - Rakefile
 - bin/ordbase
 - lib/ordinals.rb
+- lib/ordinals/api.rb
 - lib/ordinals/collection.rb
+- lib/ordinals/stats.rb
+- lib/ordinals/tool.rb
 homepage: https://github.com/pixelartexchange/ordinals.sandbox
 licenses:
 - Public Domain
@@ -115,5 +132,5 @@ rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery
-  & helpers for Bitcoin & co.
+  & helpers for Bitcoin, Litecoin, Dogecoin & co.
 test_files: []