ordinals 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dbc3bf008b7d878df205f804f9a30887c0602afc3e16ccb64ed3749be911d82
-  data.tar.gz: a5562501103ac3be5d475216c7c1ae45c5f4c1e519105dcdd8adf1250fe5184a
+  metadata.gz: b32e559e689e18de54615ab2528117193b41924127a6ea59ac1c62c4c9adf1a2
+  data.tar.gz: 8f2b06308775f509fe242e8a8c28ddde8864219a4315d051598f45dc7badc9d3
 SHA512:
-  metadata.gz: 0140e9330cff62dc983f91a5a851cbfc3d188d3711537304e538d3ea8664d7cfebc76d9f19596db60f51b9d23f117f18ec44e9fcebb5dfdf6e72131a8b87b8f6
-  data.tar.gz: 7605cf138cf69f8e7b1cf3f8e7e06c837623e1720c558b85f345bb02eb8da07b48c4882a8822ec6e7c9992756a8cb1d04089a27164e71374a26e1f3784e07943
+  metadata.gz: 81da575691583d7f05ff27dda111b80801cb15833a1a5a73f3366315e4e41bbe37e9d7e40bdc89027bf3c39e7b3de78918f356341d490b38ad071b09294a1ec7
+  data.tar.gz: 1f9b179ce9f9e4bd0f11802a94da1388ad5a62ef7357bcfbcecc0bd6c986be10c1c585c0937b6dd1d7db96f342d44d20f727029ddac1e283bb75eea935294d2d

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 1.2.0
+### 1.3.0
 
 ### 0.0.1 / 2023-03-23
 

data/README.md

@@ -15,6 +15,7 @@ ordinals gem - ordinals (inscription) api wrapper & helpers for Bitcoin, Litcoin
 For now ordinal inscription api queries are supported on
 - Bitcoin  (via <https://ordinals.com>) and
 - Litecoin (via <https://ordinalslite.com>) 
+- Dogecoin (via <https://wonky-ord.dogeord.io>)
 
 <!--
   chekc if doginals still in operation???
@@ -90,6 +91,10 @@ pp content
 ```
 
 
+Tip:  See [**Sub 1k - Inside The First Thousand (Bitcoin) Ordinal Inscriptions**](https://github.com/ordbase/ordbase/blob/master/programming-ordinals/sub1k.md) in the 
+Free (Online) Programming (Bitcoin) Ordinals - Step-by-Step Book(let) / Guide.
+
+
 
 Let's try querying for litecoin (ltc) ordinal inscriptions:
 
@@ -155,6 +160,71 @@ pp data
 #    "offset"=>"0"}
 ```
 
+
+Tip:  See [**Sub 1k - Inside The First Thousand (Litecoin) Ordinal Inscriptions**](https://github.com/ordbase/ordbase/blob/master/programming-ordinals/ltc_sub1k.md) in the 
+Free (Online) Programming (Litecoin) Ordinals - Step-by-Step Book(let) / Guide.
+
+
+
+
+Let's try querying for dogecoin (doge) ordinal shibescriptions:
+
+``` ruby
+Ordinals.chain = :doge
+
+id = '8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8i0'
+data = Ordinals.inscription( id )
+pp data
+# GET https://wonky-ord.dogeord.io/shibescription/8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8i0...
+#=> {"title"=>"Shibescription 35",
+#    "id"=>"8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8i0",
+#    "address"=>"D6tMqX2ZrjNunNfohgQPGLT9XpUCN56Zyj",
+#    "output-value"=>"100000",
+#    "content-length"=>"1077 bytes",
+#    "content-type"=>"image/png",
+#    "timestamp"=>"2023-02-24 09:23:06 UTC",
+#    "genesis-height"=>"4609819",
+#    "genesis-fee"=>"34200000",
+#    "genesis-transaction"=>"8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8",
+#    "location"=>"8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8:0:0",
+#    "output"=>"8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8:0",
+#    "offset"=>"0"}
+
+content = Ordinals.content( id )
+pp content
+# GET https://wonky-ord.dogeord.io/content/8f7219639800fdddd510f35bcda52471828ded43753b1d2a42f2a054d006edd8i0...
+#=> #<Ordinals::Api::Content:0x000001cced0740e8
+#     @data="\x89PNG\r\n\x1A\n\x00\x00\x00...",
+#     @length=1077,
+#     @type="image/png">
+
+data = Ordinals.inscription( 0 )
+pp data
+# GET https://wonky-ord.dogeord.io/shibescription/15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62ei0...
+#=> {"title"=>"Shibescription 0",
+#    "id"=>"15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62ei0",
+#    "address"=>"DCagMX5GccdpaBFJwDqmPcCaNqSzXtYoVf",
+#    "output-value"=>"100000",
+#    "content-length"=>"1461 bytes",
+#    "content-type"=>"image/png",
+#    "timestamp"=>"2023-02-24 07:45:34 UTC",
+#    "genesis-height"=>"4609723",
+#    "genesis-fee"=>"34200000",
+#    "genesis-transaction"=>"15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62e",
+#    "location"=>"15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62e:0:0",
+#    "output"=>"15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62e:0",
+#    "offset"=>"0"}
+
+content = Ordinals.content( 0 )
+pp content
+# GET https://wonky-ord.dogeord.io/content/15f3b73df7e5c072becb1d84191843ba080734805addfccb650929719080f62ei0...
+#=> #<Ordinals::Api::Content:0x000001cceda012a0
+#     @data="\x89PNG\r\n\x1A\n\x00\x00...",
+#     @length=1461,
+#     @type="image/png">
+```
+
+
 That's it.
 
 

data/lib/ordinals/api.rb

@@ -19,7 +19,9 @@ class Api   ## change/rename Api to Client - why? why not?
   def self.dogecoin
     ## note: "doginals" call inscriptions
     ##                     shibescriptions
-    @dogecoin ||= new( 'https://doginals.com', inscription: 'shibescription' )
+    ##
+    ##  note: https://doginals.com no longer in operation / working
+    @dogecoin ||= new( 'https://wonky-ord.dogeord.io', inscription: 'shibescription' )
     @dogecoin
   end
 
@@ -29,8 +31,16 @@ class Api   ## change/rename Api to Client - why? why not?
   def initialize( base, inscription: 'inscription' )
     @base          = base
     @inscription   = inscription
+
+    ## e.g. inscriptions or shibescriptions (dogecoin)
+    @inscriptions  = "#{@inscription}s"
+ 
     @requests      = 0  ## count requests (for delay_in_s sleeping/throttling)
     @pages = {}   ## (0-)99, (100-)199, (200-)299 etc.  
+
+    @inscribe_id_rx = %r{
+      (#{@inscription})/(?<id>[a-fi0-9]+)
+     }ix
   end
 
 
@@ -72,19 +82,15 @@ end  ## (nested) class Content
   end
 
 
-  INSCRIBE_ID_RX = %r{
-    inscription/(?<id>[a-fi0-9]+)
-   }ix
-
 
   def inscription_ids( offset: )  ## note: page size is for now fixed 100
     ids = []
 
-    src = "#{@base}/inscriptions/#{offset}"
+    src = "#{@base}/#{@inscriptions}/#{offset}"
     res = get( src )
 
     page = res.text  ### assumes utf-8 for now
-    page.scan( INSCRIBE_ID_RX ) do |_|
+    page.scan( @inscribe_id_rx ) do |_|
       m = Regexp.last_match
       ids << m[:id]
     end       
@@ -93,19 +99,28 @@ end  ## (nested) class Content
     ids
   end
 
-  def sub10k_ids
+  def _batch_inscription_ids( batch )
     ids = []
     limit  = 100
 
-    100.times do |i|   ## fetch first hundred (100*100=10000) inscribe ids
+    batch.times do |i|   
       offset = 99 + limit*i
+
       puts "==> #{i} - @ #{offset}..."
-      ids += inscription_ids( offset: offset )
+      ## auto-add to page cache - why? why not?
+      ids += (@pages[ offset ] ||= inscription_ids( offset: offset ))      
     end
     puts "   #{ids.size} inscribe id(s) - total"
     ids
   end
 
+  ## convenience sub1k & frens clubs / helpers
+  def sub1k_ids()   _batch_inscription_ids( 10 ); end
+  def sub2k_ids()   _batch_inscription_ids( 20 ); end
+  def sub5k_ids()   _batch_inscription_ids( 50 ); end
+  def sub10k_ids()  _batch_inscription_ids( 100 ); end
+  def sub20k_ids()  _batch_inscription_ids( 200 ); end
+ 
   
   def _num_to_id( num )
     limit = 100

data/lib/ordinals/cache.rb

@@ -6,10 +6,14 @@ class Cache
 def initialize( dir )
   @dir   = dir   
   @force = false
-  @delay_in_s = 0.5  ## wait 0.5s before next (possible) request
-  @requests = 0
 end
 
+##########
+## config helpers
+def force?() @force; end
+def force=(value) @force=value; end
+
+
 
 
 def json_to_txt( data )
@@ -56,7 +60,6 @@ def add( id )
       print "."
    else
       print " meta-#{id} "
-      sleep( @delay_in_s )   if @delay_in_s && @requests > 0 
  
       ## fetch and cache in cache
       meta = Ordinals.inscription( id )
@@ -64,7 +67,6 @@ def add( id )
       meta_txt = json_to_txt( meta )
       
       write_text( meta_path, meta_txt )
-      @requests += 1
    end
       
       
@@ -88,7 +90,6 @@ def add( id )
        print "."
    else
        print " blob-#{id} "
-       sleep( @delay_in_s )   if @delay_in_s && @requests > 0 
        
        ## note: save text as blob - byte-by-byte as is  (might be corrupt text)
        content = Ordinals.content( id )

data/lib/ordinals/sandbox.rb

@@ -5,8 +5,6 @@ class Sandbox
    def initialize( dir='./content' )
       @dir   = dir
       @force      = false
-      @delay_in_s = 0.5  ## wait 0.5s before next (possible) request
-      @requests = 0
    end   
 
 
@@ -24,9 +22,7 @@ class Sandbox
       path = "#{@dir}/#{id}"
       if !@force && File.exist?( path )
          ## puts "  in sandbox"
-      else
-        sleep( @delay_in_s )   if @delay_in_s && @requests > 0 
-        
+      else        
         ## note: save text as blob - byte-by-byte as is  (might be corrupt text)
         content = Ordinals.content( id )
         ## pp content
@@ -38,7 +34,6 @@ class Sandbox
         ## puts "data:"
         ## puts content.data
         write_blob( path, content.data )
-        @requests += 1
       end
    end
 

data/lib/ordinals/version.rb

@@ -2,7 +2,7 @@
 module Ordinals
   # sync version w/ sport.db n friends - why? why not?
   MAJOR = 1 ## todo: namespace inside version or something - why? why not??
-  MINOR = 2
+  MINOR = 3
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordinals
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-04 00:00:00.000000000 Z
+date: 2023-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos