scribelite 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8f774ffec5b1c7a02d7ff82d92e7dea2ca83aa918f498fb2d24969870e26d819
-  data.tar.gz: cf9faa2257cb17c595a01685f2dc1b97d4d6fb315f7e65a8e2b6b9663d59872d
+  metadata.gz: '0608ffa940a6f65b4432a6e8e494ec2213e20a6fb661e15eafb9f0408f1175be'
+  data.tar.gz: 5b019fbe73890c1b20a5c4106a617e2c573431e805b47825fb056f7bd50449aa
 SHA512:
-  metadata.gz: 272471a546baa300468d4dbc0558297930c12f20fd6447366dbd5b02bb6d34ff2aec04090731abcf7259447a389a1a0a20350c2c26659b95e2b9752808479f3d
-  data.tar.gz: 517b655428b5a043851c3bc0df41689648a9ca51839593d2f3a0284845a207e8570da852d36a165ef65fb6a6892ef1a0a5004490f4816823dd93d13cd977c6bb
+  metadata.gz: 3a363643f683a32c1ccbd04448d790b6582f5ccc7d8d3176ab65506ff92d826a5b54e37b41add46bb8c8b577a8f76aa9d8ee7800a7d946aa7cf5ce9802fb283b
+  data.tar.gz: 491db0258ff4a4dc27974f9e3e8e8147a9437690dfdd2c30bf8d81b8710aee0f7ee4a119cd3657b6d48f1cc3399570e4787ef9fbdc87d17ec4f4115acb79d1e7

data/CHANGELOG.md

@@ -1,4 +1,4 @@
-### 0.1.0
+### 0.2.0
 ### 0.0.1 / 2023-11-21
 
 * Everything is new. First release

data/Manifest.txt

@@ -3,8 +3,8 @@ Manifest.txt
 README.md
 Rakefile
 lib/scribelite.rb
-lib/scribelite/models/calldata.rb
 lib/scribelite/models/forward.rb
-lib/scribelite/models/inscribe.rb
+lib/scribelite/models/scribe.rb
+lib/scribelite/models/tx.rb
 lib/scribelite/schema.rb
 lib/scribelite/version.rb

data/README.md

@@ -19,11 +19,89 @@ See [Introducing Ethscriptions - A new way of creating and sharing digital artif
 
 ## Usage
 
+The work-in-progess database schema looks like:
+
+``` ruby
+ActiveRecord::Schema.define do
+
+create_table :scribes, :id => :string do |t|    
+    t.integer  :num, null: false, index: { unique: true, name: 'scribe_nums' }
+    t.integer  :bytes
+    t.string   :content_type
+    ## add allow duplicate opt-in protocol flag e.g. esip6
+    t.boolean    :duplicate      ## allows duplicates flag 
+    t.boolean    :flagged,  null: false,  default: false  ## censored flag / removed on request
+    ## move sha to tx - why? why not?
+    t.string     :sha,    null: false    ## sha hash as hexstring (but no leading 0)
+end
+
+create_table :txs, :id => :string do |t|
+    t.binary     :data     # ,  null: false
+    t.datetime   :date, null: false
+    t.integer    :block, null: false
+    t.integer    :idx,   null: false  ## transaction index (number)
+
+    t.string     :from, null: false
+    t.string     :to,   null: false   
+
+    t.integer    :fee
+    t.integer    :value
+end  
+end 
+```
+
+
+and to setup use it like:
+
+``` ruby
+require 'scribelite'
+
+ScribeDb.connect( adapter:  'sqlite3',
+                  database: './scribe.db' )
+
+ScribeDb.create_all   ## build schema
+```
+
+
+and to query use it like:
+
+``` ruby
+require 'scribelite'
+
+ScribeDb.open( './scribe.db' )
+
+puts
+puts "  #{Scribe.count} scribe(s)"
+puts "  #{Tx.count} tx(s)"
+
+
+## how many flagged in top 100?
+limit = 100
+
+flagged_count =  Scribe.order( :num ).limit(limit).where( flagged: true ).count
+pp flagged_count    #=> 75 !!!!!!!!!
+unflagged_count =  Scribe.order( :num).limit(limit).where( flagged: false ).count
+pp unflagged_count  #=> 25
+
+
+Scribe.order( :num ).limit(limit).each do |scribe|
+    if scribe.flagged?
+      print " xx "
+    else
+      print "==> "
+    end
+    print "#{scribe.num} / #{scribe.content_type}   -   #{scribe.tx.date} @ #{scribe.tx.block}"
+    print "\n"
+end
+```
+
+
 To be continued...
 
 
 
 
+
 ## Bonus - More Blockchain (Crypto) Tools, Libraries & Scripts In Ruby
 
 See [**/blockchain**](https://github.com/rubycocos/blockchain) 

data/Rakefile

@@ -18,7 +18,8 @@ Hoe.spec 'scribelite' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
-    ['ethscribe'],   
+    ['ethscribe'], 
+    ['calldata'],    ## todo - check if included via ethscribe in the future?  
     ['activerecord'],
     ['activerecord-utils'],
     ['logutils'],

data/lib/scribelite/models/forward.rb

@@ -10,8 +10,8 @@ module Model
 Prop      = ConfDb::Model::Prop
 
 
-class Inscribe    < ActiveRecord::Base ; end
-class Calldata    < ActiveRecord::Base ; end
+class Scribe      < ActiveRecord::Base ; end
+class Tx          < ActiveRecord::Base ; end
 
 
 end # module Model

data/lib/scribelite/models/{inscribe.rb → scribe.rb}

@@ -2,8 +2,8 @@
 module ScribeDb
     module Model
   
-  class Inscribe < ActiveRecord::Base
-    has_one :calldata, foreign_key: 'id'
+  class Scribe < ActiveRecord::Base
+    has_one :tx, foreign_key: 'id'
  
     ## convernience helper
     ##  forward to blob.content
@@ -182,7 +182,7 @@ def export( path=export_path )
 end
 =end
 
-  end  # class Inscribe
+  end  # class Scribe
   
     end # module Model
 end # module ScribeDb

data/lib/scribelite/models/{calldata.rb → tx.rb}

@@ -2,17 +2,16 @@
 module ScribeDb
     module Model
   
-  class Calldata < ActiveRecord::Base
-    self.table_name = 'calldatas'   ## check if infers data? why? why not?
+  class Tx < ActiveRecord::Base
+    self.table_name = 'txs'   ## note auto-infers txes change to txs
 
     belongs_to :inscribe, foreign_key: 'id'
-
 =begin    
     def text
        content.force_encoding(Encoding::UTF_8)
     end
 =end
-  end  # class Calldata
+  end  # class Tx
   
     end # module Model
 end # module ScribeDb

data/lib/scribelite/schema.rb

@@ -8,15 +8,15 @@ def up
 
 ActiveRecord::Schema.define do
 
-create_table :inscribes, :id => :string do |t|    
+create_table :scribes, :id => :string do |t|    
     ## "id": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5ci0",
     ## note: change to uuid (universally unique id) - why? why not?
     ##        id gets used by row_id (internal orm db machinery) and is int
-   ## t.string   :uuid,  null: false, index: { unique: true, name: 'inscribe_uuids' }
+   ## t.string   :uuid,  null: false, index: { unique: true, name: 'scribe_uuids' }
 
    ## "title": "Inscription 10371414",
    ##   note: use num/no. from title only - why? why not?
-    t.integer  :num, null: false, index: { unique: true, name: 'inscribe_nums' }
+    t.integer  :num, null: false, index: { unique: true, name: 'scribe_nums' }
    
     ##  "content length": "85 bytes",
     ## note:  extract bytes as integer!!!
@@ -25,11 +25,14 @@ create_table :inscribes, :id => :string do |t|
     ## "content type": "text/plain;charset=utf-8",
     ## note: make sure always lower/down case!!!
     t.string   :content_type
-    
- 
+
     ## add allow duplicate opt-in protocol flag e.g. esip6
-    ## t.boolean    :duplicate   -
- 
+    t.boolean    :duplicate      ## allows duplicates flag - make duplicate the default - why? why not?
+    t.boolean    :flagged,  null: false,  default: false  ## censored flag / removed on request
+
+    ## move sha to tx - why? why not?
+    t.string     :sha    # ,  null: false    ## sha hash as hexstring
+
   ## timestamp last
   t.timestamps
 end
@@ -37,14 +40,13 @@ end
 
 ## change to tx/txs or txn/txns - why? why not?
 
-create_table :calldatas, :id => :string do |t|
+create_table :txs, :id => :string do |t|
     ## "id": "0a3a4dbf6630338bc4df8e36bd081f8f7d2dee9441131cb03a18d43eb4882d5ci0",
     ## note: change to uuid (universally unique id) - why? why not?
     ##        id gets used by row_id (internal orm db machinery) and is int
     ## t.string   :id,  null: false, index: { unique: true, name: 'blob_uuids' }
  
-    t.binary     :data   # ,  null: false
-    t.string     :sha    # ,  null: false    ## sha hash as hexstring
+    t.binary     :data     # ,  null: false
  
     ## "timestamp": "2023-06-01 05:00:57 UTC"
     ##   or use date_utc ???
@@ -52,19 +54,16 @@ create_table :calldatas, :id => :string do |t|
     t.datetime    :date, null: false
 
     t.integer    :block, null: false
-    t.integer    :fee
-    t.integer    :value
+    t.integer    :idx,   null: false  ## transaction index (number)
 
-    ###
-    ## "address": "bc1p3h4eecuxjj2g72sq38gyva732866u5w29lhxgeqfe6c0sg8xmagsuau63k",
-    ##    is this minter/inscriber addr???
-    ##  change to minter?? or such - why? why not?
-    ##             creator 
     t.string     :from, null: false
+    t.string     :to,   null: false   
 
-    ## add to address too - why? why not?
-    t.string     :to   
-  ## timestamp last
+    t.integer    :fee
+    t.integer    :value
+
+  
+    ## timestamp last
   t.timestamps
 end
 

data/lib/scribelite/version.rb

@@ -1,7 +1,7 @@
 
 module Scribelite
   MAJOR = 0 ## todo: namespace inside version or something - why? why not??
-  MINOR = 1
+  MINOR = 2
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

data/lib/scribelite.rb

@@ -1,10 +1,11 @@
 
 # core and stlibs
 require 'ethscribe'  ## will pull-in cocos & friends
-
+require 'calldata'
 
 
 require 'logger'    # Note: use for ActiveRecord::Base.logger -- remove/replace later w/ LogUtils::Logger ???
+require 'date'      ## check if date & datetime required ??
 
 
 # 3rd party gems / libs
@@ -27,8 +28,8 @@ require_relative 'scribelite/version'   # always goes first
 
 require_relative 'scribelite/models/forward'
 
-require_relative 'scribelite/models/inscribe'
-require_relative 'scribelite/models/calldata'
+require_relative 'scribelite/models/scribe'
+require_relative 'scribelite/models/tx'
 
 
 require_relative 'scribelite/schema'      
@@ -66,7 +67,7 @@ module ScribeDb
       ConfDb.create    # add props table
     end
 
-    unless ScribeDb::Model::Inscribe.table_exists?
+    unless ScribeDb::Model::Scribe.table_exists?
       ScribeDb.create
     end
   end # method auto_migrate!
@@ -136,8 +137,8 @@ end  # module ScribeDb
 
 
 ## add convenience helpers
-Inscribe  = ScribeDb::Model::Inscribe
-Calldata  = ScribeDb::Model::Calldata
+Scribe    = ScribeDb::Model::Scribe
+Tx        = ScribeDb::Model::Tx
 
 
 # say hello

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scribelite
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-21 00:00:00.000000000 Z
+date: 2023-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ethscribe
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: calldata
+  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: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -171,9 +185,9 @@ files:
 - README.md
 - Rakefile
 - lib/scribelite.rb
-- lib/scribelite/models/calldata.rb
 - lib/scribelite/models/forward.rb
-- lib/scribelite/models/inscribe.rb
+- lib/scribelite/models/scribe.rb
+- lib/scribelite/models/tx.rb
 - lib/scribelite/schema.rb
 - lib/scribelite/version.rb
 homepage: https://github.com/s6ruby/rubidity