ordinals 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99bcfe173a347fb795174d2fc8a38ed2e8bde67089ae0340edda7c146592107c
-  data.tar.gz: e916e620469af7171250c630e09fbeb8c223eb9e197643e109127d07eed27519
+  metadata.gz: e10555694ad5291381edc71af98ba868a6f1f51a42236445873a27e4afbcd177
+  data.tar.gz: a751e7a56a4437d162f055fcf838acbf926a8ab0d89ac7559e99ec2a6f312882
 SHA512:
-  metadata.gz: d15fc49964cfe2473a23ce61f36bed070d31e722afcb2110dfa33e0452f68ec6653a668b986c17924f0ce7b9ad20d9e8c63f594d4622dc2feb72641352b25f3e
-  data.tar.gz: 421f3eec03fd8cddbd290edae6eaec5a3d37b1448ce3736242fb58a28f0802c6fea6eea0d2ab49b635957aee103ebb5d9bc010830d947ac849f77a2e1ddf0ab4
+  metadata.gz: f40f08b9217c1b85a45b3310f21b5acdd14a01d051b989d8abc78cdd88198ec76184b35488fc1f4f5f849224c1793b8e6b23b3ac38b4f36e723b5518b6db8fd6
+  data.tar.gz: bf8d701dd8d75045dc049a7aad636328f616c3a07a5d2a14781b4ac1953dd8a29dfdbea830693ba3e75390fc598e5aa2e06f58d8e6d209e65a19058c5e18b901

data/Manifest.txt

@@ -4,3 +4,4 @@ README.md
 Rakefile
 lib/ordinals.rb
 lib/ordinals/api.rb
+lib/ordinals/stats.rb

data/README.md

@@ -3,8 +3,8 @@
 ordinals gem - ordinals (inscription) api wrapper & helpers for Bitcoin, Litcoin, Dogecoin & co.
 
 
-* home  :: [github.com/pixelartexchange/artbase](https://github.com/pixelartexchange/artbase)
-* bugs  :: [github.com/pixelartexchange/artbase/issues](https://github.com/pixelartexchange/artbase/issues)
+* home  :: [github.com/ordbase/ordbase](https://github.com/ordbase/ordbase)
+* bugs  :: [github.com/ordbase/ordbase/issues](https://github.com/ordbase/ordbase/issues)
 * gem   :: [rubygems.org/gems/ordinals](https://rubygems.org/gems/ordinals)
 * rdoc  :: [rubydoc.info/gems/ordinals](http://rubydoc.info/gems/ordinals)
 
@@ -12,16 +12,99 @@ ordinals gem - ordinals (inscription) api wrapper & helpers for Bitcoin, Litcoin
 ## Usage
 
 
-
-
-
+For now ordinal inscription api queries are supported on
+- Bitcoin  (via <https://ordinals.com>)
+- Litecoin (via <https://ordinalslite.com>) and
+- Dogecoin (via <https://doginals.com>)
+
+
+Let's start querying for bitcoin (btc) ordinal inscriptions:
+
+``` ruby
+require 'ordinals'
+
+
+# get the inscription binary blob / data by id
+#  e.g. GET https://ordinals.com/content/c41021cb11dce003e6a20a3420cf5954a1d104a1fe314393b915a62f020dcd0ai0...
+
+id = 'c41021cb11dce003e6a20a3420cf5954a1d104a1fe314393b915a62f020dcd0ai0'
+content = Ordinals.content( id )
+pp content
+#=> #<Ordinals::Api::Content:0x000001a1352df938
+#      @data="RIFF\xF8\v\x00\x00WEBPVP8 \xEC\v\x00\x00...",
+#      @length=3072,
+#      @type="image/png">
+
+# get the inscription meta data by id
+#  e.g.  https://ordinals.com/inscription/c41021cb11dce003e6a20a3420cf5954a1d104a1fe314393b915a62f020dcd0ai0...
+data = Ordinals.inscription( id )
+pp data
+#=> {"title"=>"Inscription 133993",
+#    "id"=>"c41021cb11dce003e6a20a3420cf5954a1d104a1fe314393b915a62f020dcd0ai0",
+#    "address"=>"bc1pyncs638hxfhaqjvnedw2lyc2jta6zuvr9erj6m9cwlghp6qqwvhqeq574l",
+#    "output value"=>"9667",
+#    "sat"=>"1391087135005306",
+#    "preview"=>"link",
+#    "content"=>"link",
+#    "content length"=>"3072 bytes",
+#    "content type"=>"image/png",
+#    "timestamp"=>"2023-02-18 03:02:18 UTC",
+#    "genesis height"=>"777099",
+#    "genesis fee"=>"1814",
+#    "genesis transaction"=>"c41021cb11dce003e6a20a3420cf5954a1d104a1fe314393b915a62f020dcd0a",
+#    "location"=>"6a57dedb854c9bcac3fd2daab1172dd9a45f24c366dd8db33fe80557f11c6b39:22:0",
+#    "output"=>"6a57dedb854c9bcac3fd2daab1172dd9a45f24c366dd8db33fe80557f11c6b39:22",
+#    "offset"=>"0"}
+```
+
+
+Let's try querying for litecoin (ltc) ordinal inscriptions:
+
+``` ruby
+Ordinals.chain = :ltc
+
+
+# get the inscription binary blob / data by id
+#  e.g. GET https://ordinalslite.com/inscription/f2b6adf7b2d0f128fb14817ff37f5f36e9176b17571e20c49871875553f937b4i0...
+
+id = 'f2b6adf7b2d0f128fb14817ff37f5f36e9176b17571e20c49871875553f937b4i0'
+content = Ordinals.content( id )
+pp content
+#=> #<Ordinals::Api::Content:0x000001a1357fd6e0
+#      @data="\x89PNG\r\n\x1A\n\x00\x00\x00...",
+#      @length=816,
+#      @type="image/png">
+
+
+# get the inscription meta data by id
+#  e.g GET https://ordinalslite.com/inscription/f2b6adf7b2d0f128fb14817ff37f5f36e9176b17571e20c49871875553f937b4i0...
+data = Ordinals.inscription( id )
+pp data
+#=> {"title"=>"Inscription 642",
+#    "id"=>"f2b6adf7b2d0f128fb14817ff37f5f36e9176b17571e20c49871875553f937b4i0",
+#    "address"=>"LSDz4fM4mLFyAZVoDuKyMHYq3af6cSZGSY",
+#    "output value"=>"9878",
+#    "preview"=>"link",
+#    "content"=>"link",
+#    "content length"=>"816 bytes",
+#    "content type"=>"image/png",
+#    "timestamp"=>"2023-02-21 05:29:33 UTC",
+#    "genesis height"=>"2426201",
+#    "genesis fee"=>"361",
+#    "genesis transaction"=>"f2b6adf7b2d0f128fb14817ff37f5f36e9176b17571e20c49871875553f937b4",
+#    "location"=>"6802c71b49f18aab91d0b363762b24afb1bf00c4820a5f782de6dd1b1cfbd68a:0:0",
+#    "output"=>"6802c71b49f18aab91d0b363762b24afb1bf00c4820a5f782de6dd1b1cfbd68a:0",
+#    "offset"=>"0"}
+```
+
+That's it for now.
 
 
 
 ## Bonus: Ordinal Pixel Art Collections
 
 
-See the [**Ordinals (Pixel Art) Sandbox (& Cache)**](https://github.com/pixelartexchange/ordinals.sandbox)
+See the [**Ordinals (Pixel Art) Sandbox (& Cache)**](https://github.com/ordbase/ordinals.sandbox)
 for collections incl. Ordinal Punks & Phunks (24×24), Bitcoin Punks (24×24), Ordinal Mini Doges (24×24), Ordinal Doggies (32×32),
 Extra Ordinal Women (32×32), Ordinal Penguins (35×35),
 Ordinal Birds (42×42), Bitcoin Bears (48×48) and much more.

data/Rakefile

@@ -10,15 +10,15 @@ end
 
 Hoe.spec 'ordinals' do
 
-  self.version = '1.0.1'
+  self.version = '1.0.3'
 
   self.summary = 'ordinals gem - ordinals (inscription) api wrapper & helpers for Bitcoin, Litecoin, Dogecoin & co.'
   self.description = summary
 
-  self.urls    = { home: 'https://github.com/pixelartexchange/artbase' }
+  self.urls    = { home: 'https://github.com/ordbase/ordbase' }
 
   self.author  = 'Gerald Bauer'
-  self.email   = 'wwwmake@googlegroups.com'
+  self.email   = 'gerald.bauer@gmail.com'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'

data/lib/ordinals/api.rb

@@ -5,7 +5,8 @@ module Ordinals
 
 class Api   ## change/rename Api to Client - why? why not?
   def self.litecoin
-    @litecoin ||= new( 'https://litecoin.earlyordies.com' )
+    ## @litecoin ||= new( 'https://litecoin.earlyordies.com' )
+    @litecoin ||= new( 'https://ordinalslite.com' )
     @litecoin
   end
 

data/lib/ordinals/stats.rb

@@ -0,0 +1,145 @@
+
+
+class InscriptionStats
+
+  TITLE_RX = /^(Inscription|Shibescription)[ ]+(?<ord>[0-9]+)$/
+  BYTES_RX = /^(?<bytes>[0-9]+)[ ]+bytes$/
+
+  def initialize
+    @stats = {
+      count: 0,
+      ord: { '<100'   => 0,
+             '<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 < 100     then  @stats[:ord]['<100'] += 1
+    elsif  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 << "     - <100 => #{stat[:ord]['<100']}\n"          if stat[:ord]["<100"] > 0
+     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.rb

@@ -54,8 +54,10 @@ module Ordinals
   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.client()      config.client; end
+  def self.chain()       config.chain; end
+  def self.chain=(value) config.chain = value; end
+
 
   def self.btc?()     config.chain == 'btc'; end
   def self.ltc?()     config.chain == 'ltc'; end
@@ -70,6 +72,12 @@ module Ordinals
     alias_method :dogecoin?, :doge?
     alias_method :dogecon?,  :doge?
   end
+
+
+  ###################
+  ### more convenience shortcuts
+  def self.inscription( id ) client.inscription( id ); end
+  def self.content( id )     client.content( id );     end
 end  # module Ordinals
 
 
@@ -77,5 +85,7 @@ end  # module Ordinals
 
 ## our own code
 require_relative 'ordinals/api'
+require_relative 'ordinals/stats'
+
 
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordinals
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-03-23 00:00:00.000000000 Z
+date: 2023-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos
@@ -74,7 +74,7 @@ dependencies:
         version: '3.23'
 description: ordinals gem - ordinals (inscription) api wrapper & helpers for Bitcoin,
   Litecoin, Dogecoin & co.
-email: wwwmake@googlegroups.com
+email: gerald.bauer@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -88,7 +88,8 @@ files:
 - Rakefile
 - lib/ordinals.rb
 - lib/ordinals/api.rb
-homepage: https://github.com/pixelartexchange/artbase
+- lib/ordinals/stats.rb
+homepage: https://github.com/ordbase/ordbase
 licenses:
 - Public Domain
 metadata: {}