ordlite 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d227087815f81d4a3bc1791e2fd34639074c8000568ca1c378c865d5450e39a
-  data.tar.gz: c3697c7d069e85ade6dd427918796d5bf6cd302475299f5eb080287c80536508
+  metadata.gz: 238e3e5f3913821c8f0a70bdedb444deeea65da4ecdb5827f239b3b4a682a151
+  data.tar.gz: d01946f571d34b1b29ca7fe0216898f31fddc75e818d07300129af5d1a808c5e
 SHA512:
-  metadata.gz: 0b7d753c4767407663ff2e29f2eaf2efe2689e0283ae332ada7404e3fc797678664a91d285e79cb09abf3f73675615f729c6e653093d9d895f710def43954503
-  data.tar.gz: b85fd1bfe93b17dd26bd5e6e4e1c57b88cc2cad152405ef524a3a17dc3a9c50f740a9a83e2bc7c731dbf5b4a7b6fc7480c0881bf7ea174f86f593deb4f544f9a
+  metadata.gz: 1545c336ad9d22d92235bbe7160b3224a311cf5dd06b8a944d18d5d2e80c62a24f342be5ed3b295dd9b99cddd7654f931893f811a9571ef80688956cdff27178
+  data.tar.gz: 7300eb7a35ddcf56a41e10cdbc8844d81f8340147b18125d62a528d1eb27e4f8854e72ff70ec3858723ce2da99a3105b80f4414ec1706a593e81915b1aec9fb5

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 0.1.0 / 2023-07-01
+### 0.1.2 / 2023-07-02
 ### 0.0.1 / 2023-07-01
 
 * Everything is new. First release

data/Manifest.txt

@@ -3,6 +3,8 @@ Manifest.txt
 README.md
 Rakefile
 lib/ordlite.rb
+lib/ordlite/base.rb
+lib/ordlite/cache.rb
 lib/ordlite/models/blob.rb
 lib/ordlite/models/forward.rb
 lib/ordlite/models/inscribe.rb

data/README.md

@@ -11,13 +11,158 @@ ordlite - ordinals inscription (on bitcoin & co) database let's you query via sq
 
 
 
+##  SQL Database Model
+
+Insribes •  Blobs
+
+
+Table Inscribes
+
+``` sql
+CREATE TABLE "inscribes" (
+    "id" varchar NOT NULL PRIMARY KEY, 
+    "num" integer NOT NULL,
+    "bytes" integer NOT NULL,
+    "content_type" varchar NOT NULL,
+    "date" datetime(6) NOT NULL,
+    "sat" integer NOT NULL,
+    "block" integer NOT NULL,
+    "fee" integer NOT NULL,
+    "tx" varchar NOT NULL,
+    "offset" integer NOT NULL,
+    "address" varchar NOT NULL,
+    "output" varchar NOT NULL,
+    "value" integer NOT NULL,
+)
+```
+
+Table Blobs
+
+``` sql
+CREATE TABLE "blobs" (
+    "id" varchar NOT NULL PRIMARY KEY, 
+    "content" blob NOT NULL, 
+)
+```
+
+
 ##  Usage
 
-To be done
 
+### Step 0:  Setup Databae
+
+``` ruby
+require 'ordlite'
+
+OrdDb.connect( adapter:  'sqlite3',
+               database: './ord.db' )
+
+OrdDb.create_all     # build table schema
+
+puts
+puts "  #{Inscribe.count} inscribe(s)"
+puts "  #{Blob.count} blob(s)"
+
+#=>  0 inscribe(s)
+#=>  0 blob(s)
+```
+
+
+
+
+### Example No 1 - Query Ordgen Deploy / Mint Inscriptions
+
+``` ruby
+require 'ordlite'
+
+
+OrdDb.connect( adapter:  'sqlite3',
+               database: './ord.db' )
+
+
+####################
+## query for deploy candidates
+##
+##  e.g. sql where clause like
+##     content LIKE '%deploy%' 
+##       AND (   content LIKE '%orc-721%' 
+##            OR content LIKE '%og%')
+## 
+
+deploys = Inscribe.deploys
+puts "   #{deploys.size} deploy candidate(s)"
+
+deploys.each_with_index do |rec,i|
+    puts "==> deploy #{i} - num #{rec.num} - #{rec.bytes} bytes - #{rec.date}"
+    puts rec.content 
+end
+
+
+punks_deploys = Inscribe.deploys_by( slug: 'diypunks')
+puts "   #{punks_deploys.size} deploy candidate(s)"
+
+
+
+#######################
+## query for mint candidates
+##
+##  e.g. sql where clause like
+##     content LIKE '%mint%' 
+##       AND (   content LIKE '%orc-721%' 
+##            OR content LIKE '%og%')
+
+mints = Inscribe.mints
+puts "   #{mints.size} mint candidate(s)"
+
+## print last hundred mint candidates
+mints[-100,100].each_with_index do |rec,i|
+    puts "==> mint #{i} - num #{rec.num} - #{rec.bytes} bytes - #{rec.date}"
+    puts rec.content 
+end
+
+
+phunks_mints = Inscribe.mints_by( slug: 'diyphunks')
+puts "   #{phunks_mints.size} mint candidate(s)"
+
+
+puts "   #{deploys.size} deploy candidate(s)"
+puts "   #{mints.size} mint candidate(s)"
+
+#=> 123 deploy candidate(s)
+#=> 7453 mint candidate(s)
+```
+
+
+
+
+### Bonus:  Import (Cached) Inscription Datafiles (& Content)
+
+Let's import all cached 
+inscriptions metadata datafiles (& content)
+from  [/ordinals.cache](https://github.com/ordbase/ordinals.cache)   
+into an (sql) database e.g. `ord.db`: 
+
+
+``` ruby
+require 'ordlite'
+
+OrdDb.connect( adapter:  'sqlite3',
+               database: './ord.db' )
+
+OrdDb.create_all     # build table schema
+
+cache_dir = './ordinals.cache/btc'
+cache =  OrdDb::Cache.new( cache_dir )
+cache.import_all
 
 
+puts
+puts "  #{Inscribe.count} inscribe(s)"
+puts "  #{Blob.count} blob(s)"
 
+#=>  8505 inscribe(s)
+#=>  7611 blob(s)
+```
 
 
 ## License

data/lib/ordlite/base.rb

@@ -0,0 +1,106 @@
+# core and stlibs
+
+require 'pp'
+require 'fileutils'
+require 'uri'
+require 'json'
+require 'yaml'
+
+require 'logger'    # Note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
+
+
+# 3rd party gems / libs
+require 'props'           # see github.com/rubylibs/props
+require 'logutils'        # see github.com/rubylibs/logutils
+
+
+require 'active_record'   ## todo: add sqlite3? etc.
+
+## add more activerecords addons/utils
+# require 'tagutils'
+require 'activerecord/utils'
+require 'props/activerecord'      # includes ConfDb (ConfDb::Model::Prop, etc.)
+require 'logutils/activerecord'   # includes LogDb (LogDb::Model::Log, etc.)
+
+
+
+# our own code
+require_relative 'version'   # always goes first
+
+require_relative 'models/forward'
+
+require_relative 'models/inscribe'
+require_relative 'models/blob'
+
+
+require_relative 'schema'      
+
+require_relative 'cache'
+
+
+
+module OrdDb
+
+  def self.create
+    CreateDb.new.up
+    ConfDb::Model::Prop.create!( key: 'db.schema.ord.version', 
+                                 value: Ordlite::VERSION )
+  end
+
+  def self.create_all
+    LogDb.create    # add logs table
+    ConfDb.create   # add props table
+    OrdDb.create
+  end
+
+  def self.connect( config={} )
+
+    if config.empty?
+      puts "ENV['DATBASE_URL'] - >#{ENV['DATABASE_URL']}<"
+
+      ### change default to ./ord.db ?? why? why not?
+      db = URI.parse( ENV['DATABASE_URL'] || 'sqlite3:///ord.db' )
+
+      if db.scheme == 'postgres'
+        config = {
+          adapter: 'postgresql',
+          host: db.host,
+          port: db.port,
+          username: db.user,
+          password: db.password,
+          database: db.path[1..-1],
+          encoding: 'utf8'
+        }
+      else # assume sqlite3
+       config = {
+         adapter: db.scheme, # sqlite3
+         database: db.path[1..-1] # ord.db (NB: cut off leading /, thus 1..-1)
+      }
+      end
+    end
+
+    puts "Connecting to db using settings: "
+    pp config
+    ActiveRecord::Base.establish_connection( config )
+    # ActiveRecord::Base.logger = Logger.new( STDOUT )
+  end
+
+
+  def self.setup_in_memory_db
+
+    # Database Setup & Config
+    ActiveRecord::Base.logger = Logger.new( STDOUT )
+    ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
+
+    self.connect( adapter:  'sqlite3',
+                  database: ':memory:' )
+
+    ## build schema
+    OrdDb.create_all
+  end # setup_in_memory_db (using SQLite :memory:)
+
+end  # module OrdDb
+
+
+# say hello
+puts Ordlite.banner     ## if defined?($RUBYCOCOS_DEBUG) && $RUBCOCOS_DEBUG

data/lib/ordlite/cache.rb

@@ -0,0 +1,123 @@
+
+module OrdDb
+
+
+class  Cache   
+
+   Inscribe = Model::Inscribe
+   Blob     = Model::Blob
+
+def initialize( dir='.' )
+    @dir = dir
+end
+
+
+
+def import_all   
+   paths = Dir.glob( "#{@dir}/**.json" )
+   puts "  #{paths.size} inscribe datafile(s) found"
+
+   paths.each_with_index do |path, i|
+     puts "==> inscribe #{i+1}/#{paths.size}..."
+     data = _read_inscribe( path )
+     
+     Inscribe.create( _parse_inscribe( data ))
+   end
+
+
+   paths = Dir.glob( "#{@dir}/content/**.txt" )
+   puts "  #{paths.size} content datafile(s) found"
+
+   paths.each_with_index do |path, i|
+      puts "==> blob #{i+1}/#{paths.size}..."
+      content = _read_blob( path )
+      id      = File.basename( path, File.extname( path ))
+      
+      Blob.create( id: id,
+                   content: content )
+    end
+end
+
+
+def import( id )
+   data = read( id )  
+   rec = Inscribe.create( _parse_inscribe( data ))
+   rec
+end
+
+def read( id )
+   _read_inscribe( "#{@dir}/#{id}.json" ) 
+end
+
+def _read_inscribe( path )
+   JSON.parse( _read_text( path )) 
+end
+
+def _read_blob( path )
+   blob = File.open( path, 'rb' ) { |f| f.read } 
+   ## auto force to ASCII-7BIT if not already - why? why not?
+   blob
+end
+
+
+def _read_text( path )
+   File.open( path, 'r:utf-8' ){ |f| f.read } 
+end
+
+def _parse_inscribe( data )
+   ## num via title
+   attributes = {
+    id:  data['id'],
+    num: _title_to_num( data['title'] ),
+    bytes: _content_length_to_bytes( data['content length'] ), 
+    sat:  data['sat'].to_i(10),
+    content_type:  data['content type'],
+    block: data['genesis height'].to_i(10),
+    fee: data['genesis fee'].to_i(10),
+    tx: data['genesis transaction'],
+    address: data['address'],
+    output: data['output'],
+    value: data['output value'].to_i(10),
+    offset: data['offset'].to_i(10),
+    # "2023-06-01 05:00:57 UTC"
+    date:  DateTime.strptime( data['timestamp'], 
+                              '%Y-%m-%d %H:%M:%S %z')
+  }
+
+  attributes
+end
+
+
+
+    ##  "title": "Inscription 9992615",
+TITLE_RX = /^Inscription (?<num>[0-9]+)$/i
+
+def _title_to_num( str )
+   if m=TITLE_RX.match( str )
+      m[:num].to_i(10)    ## use base 10
+   else
+     puts "!! ERROR - no inscribe num found in title >#{str}<"
+     exit 1   ## not found - raise exception - why? why not?
+   end
+end
+
+CONTENT_LENGTH_RX = /^(?<num>[0-9]+) bytes$/i
+
+def _content_length_to_bytes( str )
+    if m=CONTENT_LENGTH_RX.match( str )
+       m[:num].to_i(10)    ## use base 10
+    else
+       puts "!! ERROR - bytes found in content lenght >#{str}<"
+       exit 1   ## not found - raise exception - why? why not?
+    end
+end
+ 
+
+
+
+end # class Cache
+end # module OrdDb
+
+
+
+

data/lib/ordlite/models/inscribe.rb

@@ -4,6 +4,56 @@ module OrdDb
   
   class Inscribe < ActiveRecord::Base
     has_one :blob, foreign_key: 'id'
+
+    def content
+      ## convernience helper
+      ##  forward to blob.content
+       blob.content
+    end
+
+    ################################
+    ### scope like helpers
+    def self.deploys 
+      where_clause =<<SQL 
+content LIKE '%deploy%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+SQL
+
+       joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+    def self.deploys_by( slug: )
+             where_clause =<<SQL 
+content LIKE '%deploy%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+AND content LIKE '%#{slug}%'     
+SQL
+
+      joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+    def self.mints 
+      where_clause =<<SQL 
+content LIKE '%mint%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+SQL
+
+       joins(:blob).where( where_clause ).order( 'num' )
+    end
+
+    def self.mints_by( slug: ) 
+      where_clause =<<SQL 
+content LIKE '%mint%' 
+AND (   content LIKE '%orc-721%' 
+     OR content LIKE '%og%')
+AND content LIKE '%#{slug}%'     
+SQL
+
+       joins(:blob).where( where_clause ).order( 'num' )
+    end
   end  # class Inscribe
   
     end # module Model

data/lib/ordlite/schema.rb

@@ -48,7 +48,8 @@ create_table :inscribes, :id => :string do |t|
    
     ##  "content length": "85 bytes",
     ## note:  extract bytes as integer!!!
-    t.integer  :content_length, null: false
+    ##    change to bytes - why? why not?
+    t.integer  :bytes, null: false
     ## "content type": "text/plain;charset=utf-8",
     ## note: make sure always lower/down case!!!
     t.string   :content_type, null: false
@@ -63,10 +64,11 @@ create_table :inscribes, :id => :string do |t|
 
     ##
     ## "genesis height": "792337",
+    ##   -> change height to block - why? why not?
     ## "genesis fee": "6118",
     ## "genesis transaction": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c",
     ## "offset": "0"
-    t.integer    :height, null: false
+    t.integer    :block, null: false
     t.integer    :fee, null: false
     t.string     :tx, null: false
     t.integer    :offset, null: false 
@@ -76,12 +78,15 @@ create_table :inscribes, :id => :string do |t|
     ##    is this minter/inscriber addr??? 
     t.string     :address, null: false
 
-    ## -- ignore for now - why? why not?
-    ##   what is output  ???
-    ## "location": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c:0:0",
     ## "output": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c:0",
     ##  "output value": "546",
-  
+    t.string   :output, null: false
+    t.integer  :value,  null: false
+
+    ## -- ignore for now - why? why not?
+    ##   what is location  ???
+    ## "location": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5c:0:0",
+
   ## timestamp at last
   t.timestamps
 end

data/lib/ordlite/version.rb

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

data/lib/ordlite.rb

@@ -1,105 +1,12 @@
-# core and stlibs
 
-require 'pp'
-require 'fileutils'
-require 'uri'
-require 'json'
-require 'yaml'
+require_relative 'ordlite/base'
 
-require 'logger'    # Note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
 
+## add convenience helpers
+##  use require 'ordlite/base' if you do NOT want automagic aliases
 
-# 3rd party gems / libs
-require 'props'           # see github.com/rubylibs/props
-require 'logutils'        # see github.com/rubylibs/logutils
 
+Inscribe = OrdDb::Model::Inscribe
+Blob     = OrdDb::Model::Blob
 
-require 'active_record'   ## todo: add sqlite3? etc.
 
-## add more activerecords addons/utils
-# require 'tagutils'
-require 'activerecord/utils'
-require 'props/activerecord'      # includes ConfDb (ConfDb::Model::Prop, etc.)
-require 'logutils/activerecord'   # includes LogDb (LogDb::Model::Log, etc.)
-
-
-
-# our own code
-
-require 'ordlite/version'   # always goes first
-
-require 'ordlite/models/forward'
-
-require 'ordlite/models/inscribe'
-require 'ordlite/models/blob'
-
-
-require 'ordlite/schema'      
-
-
-
-module OrdDb
-
-  def self.create
-    CreateDb.new.up
-    ConfDb::Model::Prop.create!( key: 'db.schema.ord.version', 
-                                 value: Ordlite::VERSION )
-  end
-
-  def self.create_all
-    LogDb.create    # add logs table
-    ConfDb.create   # add props table
-    OrdDb.create
-  end
-
-  def self.connect( config={} )
-
-    if config.empty?
-      puts "ENV['DATBASE_URL'] - >#{ENV['DATABASE_URL']}<"
-
-      ### change default to ./ord.db ?? why? why not?
-      db = URI.parse( ENV['DATABASE_URL'] || 'sqlite3:///ord.db' )
-
-      if db.scheme == 'postgres'
-        config = {
-          adapter: 'postgresql',
-          host: db.host,
-          port: db.port,
-          username: db.user,
-          password: db.password,
-          database: db.path[1..-1],
-          encoding: 'utf8'
-        }
-      else # assume sqlite3
-       config = {
-         adapter: db.scheme, # sqlite3
-         database: db.path[1..-1] # ord.db (NB: cut off leading /, thus 1..-1)
-      }
-      end
-    end
-
-    puts "Connecting to db using settings: "
-    pp config
-    ActiveRecord::Base.establish_connection( config )
-    # ActiveRecord::Base.logger = Logger.new( STDOUT )
-  end
-
-
-  def self.setup_in_memory_db
-
-    # Database Setup & Config
-    ActiveRecord::Base.logger = Logger.new( STDOUT )
-    ## ActiveRecord::Base.colorize_logging = false  - no longer exists - check new api/config setting?
-
-    self.connect( adapter:  'sqlite3',
-                  database: ':memory:' )
-
-    ## build schema
-    OrdDb.create_all
-  end # setup_in_memory_db (using SQLite :memory:)
-
-end  # module OrdDb
-
-
-# say hello
-puts Ordlite.banner     ## if defined?($RUBYCOCOS_DEBUG) && $RUBCOCOS_DEBUG

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordlite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-01 00:00:00.000000000 Z
+date: 2023-07-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -157,6 +157,8 @@ files:
 - README.md
 - Rakefile
 - lib/ordlite.rb
+- lib/ordlite/base.rb
+- lib/ordlite/cache.rb
 - lib/ordlite/models/blob.rb
 - lib/ordlite/models/forward.rb
 - lib/ordlite/models/inscribe.rb