ordlite 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 349d70aaa528cdced0835181ca83ad5bb8815982bc60bc7f9d5535095131b322
-  data.tar.gz: 505f8f222ea148ca87f84080696cc0ec8d369a1a285aa50270ce8db6632ace96
+  metadata.gz: 238e3e5f3913821c8f0a70bdedb444deeea65da4ecdb5827f239b3b4a682a151
+  data.tar.gz: d01946f571d34b1b29ca7fe0216898f31fddc75e818d07300129af5d1a808c5e
 SHA512:
-  metadata.gz: 4a1ecae2ec91d531ae6ff660dea7861243569f7c2009cbf48315e88a406ddbc0b9cdf91a8b29291b8e64e2f99d5051188662356a3bbf70efd394d4f7e7f13cfa
-  data.tar.gz: 50cc3f57b2cade5086a12a9c459469a991a667fe9b30431f2b2f6c957c1462430a41bbd6e2e50b635631668d4f6f3ef70aa54a6f6ec7a9d812a17c920b1031f2
+  metadata.gz: 1545c336ad9d22d92235bbe7160b3224a311cf5dd06b8a944d18d5d2e80c62a24f342be5ed3b295dd9b99cddd7654f931893f811a9571ef80688956cdff27178
+  data.tar.gz: 7300eb7a35ddcf56a41e10cdbc8844d81f8340147b18125d62a528d1eb27e4f8854e72ff70ec3858723ce2da99a3105b80f4414ec1706a593e81915b1aec9fb5

data/CHANGELOG.md

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

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/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/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 = 1
+  PATCH = 2
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordlite
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  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