ordinals 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24a92228c4c130bdb9083c1fa9dea7d458d827d99533935191fe5f31c4c750c8
-  data.tar.gz: 1807eb1c8472696cff5c46ef41b8e7126517e56a7f458e352e5aa39aaa537d65
+  metadata.gz: 8713aa7b98dcb5356b762898b13ab4539313ef8621f2930b5291519edd759f50
+  data.tar.gz: 6c4a9f720237c5e6468eede3f7b69988ecbdcf5fd347749cd9f18dd9de0fdb6a
 SHA512:
-  metadata.gz: 1b40c581901fe69993d189bcd520a9c6d47cb90a7d1e5512764cc79842e21f3651b8862f3b2de62ca131ca721eaf73745721a775e80b7ec0b064e10da530bc7e
-  data.tar.gz: '036823aabca7d9c3d5deb3dfa404a7d4bfe22caecec84ff21f61fac10f44ae3f18217bbc0f80cb269aad35e6e61c74b375de3615bebe0b02e97482f0ccecabaa'
+  metadata.gz: 803d2f9357b35101f2572767de7f7176966d077b2b87bef45b2cb6c1f90c80ec4513d71aad231e08ddc5a112683ac0c24139a40e832f714dac05b47039654b3f
+  data.tar.gz: 64071daa9c9c4352174a4be0c5cce8a7ee5d407920c922f29cadf8d015ab5ce963cc922f665039bfa3397142383aeeef3cff4e8c4650ec96faec32a33f6bddf3

data/Manifest.txt

@@ -2,4 +2,6 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
+bin/ordbase
 lib/ordinals.rb
+lib/ordinals/collection.rb

data/README.md

@@ -1,6 +1,6 @@
 # ordinals
 
-ordinals gem - (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin & co.
+ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin & co.
 
 
 * home  :: [github.com/pixelartexchange/ordinals.sandbox](https://github.com/pixelartexchange/ordinals.sandbox)
@@ -9,9 +9,151 @@ ordinals gem - (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin
 * rdoc  :: [rubydoc.info/gems/ordinals](http://rubydoc.info/gems/ordinals)
 
 
-## Usage
+## Comand-Line Usage
 
-To be done
+Let's use the 100 Ordinal Punks collection to try out the
+`ordbase` command-line tool shipping with the ordinals package.
+
+Tip: New to Ordinal Punks? For some background see [**Awesome 100 Ordinal Punks (Anno 2023) Notes - 24×24 Pixel Art on the (Bitcoin) Blockchain »**](https://github.com/cryptopunksnotdead/cryptopunks/tree/master/awesome-ordinalpunks)
+
+
+### Step 0:   Prepare A Tabular Dataset (List) Of All Ordinals w/ ID
+
+For now a manual step - prepare a list of all ordinals with id in the comma-separated values (.csv) tabular dataset format.
+Example - [ordinalpunks/ordinals.csv](https://github.com/pixelartexchange/ordinals.sandbox/blob/master/ordinalpunks/ordinals.csv):
+
+``` csv
+num, id
+1, 96d87d7e59d75ebc0e6144b09fdd96355fcdaa86fd098d64c46f19a424012bbei0
+2, acda637db995df796b35035fd978cc1a947f1e6fd5215968da88b7e38a7e4b37i0
+3, 0406654dffdd01a49794bd8531bf33721986cc7c6546f871962adee921a39a9di0
+4, 2fe9bb034f60db694701acb23a76c3d7d5aba4328dbd315764f6ee406ba41786i0
+5, dcfa240f2681d1e4a8948120a3a64567262e3c78d5497cb4e97351bfa836b638i0
+6, 16df62c86321895df2b93236d103c935015ed77e189485be649ce2c7e6ac8a4ei0
+7, 81e8d9159b8e9a27c692a5bb3ba18ca037757e94e975b53e175eaaeb2c52f15ai0
+8, c2e15fe87c4b1fd61de65f2804858e6d1152b6316bcb9c2b39b69c9c21638f5di0
+9, 3ed569f3a92ade9f1b47031eb2db2045e7dee3e00787954a88c67ed2ad9854bbi0
+...
+```
+
+
+### Step 1:  Download All Pixel Art Images Via Ordinals.com
+
+Use
+
+```
+$ ordbase ordinalpunks image   # or
+$ ordbase ordinalpunks img
+```
+
+to download all images via the ordinals.com (web) service.
+All images get stored in the (temporary) `token-i/` directory.
+Resulting in:
+
+```
+/ordinalpunks
+   ordinals.csv
+   /token-i
+     1.png
+     2.png
+     3.png
+     ...
+```
+
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinals/i/1.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinals/i/2.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinals/i/3.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinals/i/4.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinals/i/5.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinals/i/6.png)
+...
+
+
+
+
+### Step 2:  Downsample ("Pixelate")  All Pixel Art Images
+
+Note: Most pixel art collections upload / inscribe images with a zoom.
+The ordinal punks, for example, use a 8x zoom factor for the 24×24px originals, thus,
+resulting in 192×192px.
+
+
+Add a ["artbase-compatible"](https://github.com/pixelartexchange/artbase) collection configuration file to lists the source format(s)
+and the minimal true pixel format.
+Example - [ordinalpunks/collection.yml](https://github.com/pixelartexchange/ordinals.sandbox/blob/master/ordinalpunks/collection.yml):
+
+``` yaml
+slug:       ordinalpunks
+count:      100
+format:     24x24
+source:     192x192
+offset:     1
+```
+
+Use
+
+```
+$ ordbase ordinalpunks pixelate   # or
+$ ordbase ordinalpunks px
+```
+
+to downsample ("pixelate") all images
+in the (temporary) `token-i/` directory.
+Resulting in a `24x24`/ directory with all images
+in the "minimal" `24x24` format:
+
+```
+/ordinalpunks
+   ordinals.csv
+   collections.yml
+   /24x24
+     1.png
+     2.png
+     3.png
+     ...
+```
+
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinalpunks/24x24/1.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinalpunks/24x24/2.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinalpunks/24x24/3.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinalpunks/24x24/4.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinalpunks/24x24/5.png)
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/ordinalpunks/24x24/6.png)
+...
+
+
+
+### Bonus: Step 3:  Make An All-In-One Collect'Em All Composite Image
+
+
+Use
+
+```
+$ ordbase ordinalpunks composite   # or
+$ ordbase ordinalpunks comp
+```
+
+to make an all-in-one image composite for the complete collection.
+Resulting in `/tmp/ordinalpunks.png` (~11kb).
+
+
+![](https://github.com/pixelartexchange/ordinals.sandbox/raw/master/i/ordinalpunks.png)
+
+
+That's it for now.
+
+
+
+
+## Bonus:  More Ordinal Pixel Art Collections
+
+
+See the [**Ordinals (Pixel Art) Sandbox (& Cache)**](https://github.com/pixelartexchange/ordinals.sandbox)
+for more collections incl. Bitcoin Punks (24×24), Ordinal Mini Doges (24×24),
+Extra Ordinal Women (32×32), Ordinal Penguins (35×35),
+Ordinal Birds (42×42), Bitcoin Bears (48×48) and much more.
+
+Add your sandbox or "right-clicker" ordinal backup / archive / gallery here. Yes, you can.
 
 
 

data/Rakefile

@@ -10,9 +10,9 @@ end
 
 Hoe.spec 'ordinals' do
 
-  self.version = '0.0.1'
+  self.version = '0.1.0'
 
-  self.summary = "ordinals gem - (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin & co."
+  self.summary = 'ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin & co.'
   self.description = summary
 
   self.urls    = { home: 'https://github.com/pixelartexchange/ordinals.sandbox' }

data/bin/ordbase

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+###################
+# == DEV TIPS:
+#
+# For local testing run like:
+#
+#    ruby -Ilib bin/ordbase
+#
+# Set the executable bit in Linux. Example:
+#
+#    % chmod a+x bin/ordbase
+#
+
+require 'ordinals'
+
+Ordinals::Tool.main

data/lib/ordinals/collection.rb

@@ -0,0 +1,194 @@
+
+module Ordinals
+
+
+class Collection
+  attr_reader :slug,
+              :width, :height,
+              :sources
+
+
+  def initialize( slug )
+      @slug = slug
+
+      ## read config if present
+      config_path = "./#{@slug}/collection.yml"
+      if File.exist?( config_path )
+        config = read_yaml( config_path )
+        pp config
+
+        @width, @height = _parse_dimension( config['format'] )
+
+        ## note: allow multiple source formats / dimensions
+        ### e.g. convert   512x512 into  [ [512,512] ]
+        ##
+        source = config['source']
+        source = [source]  unless source.is_a?( Array )
+        @sources = source.map { |dimension| _parse_dimension( dimension ) }
+      end
+  end
+
+
+def ordinals
+   @ordinals ||= begin
+                     recs = read_csv( "./#{@slug}/ordinals.csv" )
+                     puts "  #{recs.size} record(s)"
+                     recs
+                 end
+   @ordinals
+end
+
+def count() ordinals.size; end
+alias_method :size, :count
+
+
+
+def each_ordinal( &block )
+  ordinals.each do |rec|   ## pass along hash rec for now - why? why not?
+    block.call( rec )
+  end
+end
+
+## add each_source_image or each_token_image or each_original_image or such - why? why not??
+
+
+
+def each_image( &block )
+  each_ordinal do |rec|
+    id  = rec['id']
+    num = rec['num'].to_i(10)
+
+    path = "./#{@slug}/#{@width}x#{@height}/#{num}.png"
+    img = Image.read( path )
+
+    block.call( img, num )
+  end
+end
+
+
+
+def image_dir()  "./#{@slug}/token-i";  end
+
+
+
+## e.g. convert dimension (width x height) "24x24" or "24 x 24" to  [24,24]
+def _parse_dimension( str )
+    str.split( /x/i ).map { |str| str.strip.to_i }
+end
+
+
+def pixelate
+  each_ordinal do |rec|
+    id  = rec['id']
+    num = rec['num']
+
+    outpath = "./#{@slug}/#{@width}x#{@height}/#{num}.png"
+    next if File.exist?( outpath )
+
+    path = "#{image_dir}/#{num}.png"
+    puts "==> reading #{path}..."
+
+    img = Image.read( path )
+    puts "   #{img.width}x#{img.height}"
+
+    ## check for source images
+    if !@sources.include?( [img.width, img.height] )
+      puts "  !! ERROR - unexpected image size; sorry - expected:"
+      pp @sources
+      exit 1
+    end
+
+    ## check for special case   source == format!!
+    if [img.width,img.height] == [@width,@height]
+      puts "   note: saving image as is - no downsampling"
+      img.save( outpath )
+    else
+      steps_x = Image.calc_sample_steps( img.width, @width )
+      steps_y = Image.calc_sample_steps( img.height, @height )
+
+      img = img.sample( steps_x, steps_y )
+      img.save( outpath )
+    end
+  end
+end
+
+
+def make_composite
+  cols, rows = case count
+               when    10 then   [5,   2]
+               when    15 then   [5,   3]
+               when    69 then   [10,  7]
+               when    99 then   [10,  10]
+               when   100 then   [10,  10]
+               when   111 then   [11,  11]
+               else
+                   raise ArgumentError, "sorry - unknown composite count #{count} for now"
+               end
+
+  composite = ImageComposite.new( cols, rows,
+                                  width:  @width,
+                                  height: @height )
+
+
+  each_image do |img, num|
+    puts "==> #{num}"
+    composite << img
+  end
+
+   composite.save( "./#{@slug}/tmp/#{@slug}.png" )
+end
+
+
+
+def convert_images
+  ## todo: check for gifs too - why? why not?
+  Image.convert( image_dir, from: 'jpg',
+                            to:   'png' )
+end
+
+
+def download_images
+  each_ordinal do |rec|
+    id  = rec['id']
+    num = rec['num']
+
+    next if File.exist?( "#{image_dir}/#{num}.png" )
+
+    puts "==> downloading image ##{num}..."
+
+    image_url = "https://ordinals.com/content/#{id}"
+
+    res = Webclient.get( image_url )
+
+    if res.status.ok?
+      content_type   = res.content_type
+      content_length = res.content_length
+
+      puts "  content_type: #{content_type}, content_length: #{content_length}"
+
+      format = if content_type =~ %r{image/jpeg}i
+                 'jpg'
+               elsif content_type =~ %r{image/png}i
+                'png'
+               elsif content_type =~ %r{image/gif}i
+                 'gif'
+               else
+                 puts "!! ERROR:"
+                 puts " unknown image format content type: >#{content_type}<"
+                 exit 1
+               end
+
+      ## save image - using b(inary) mode
+      write_blob( "#{image_dir}/#{num}.#{format}", res.blob )
+
+      sleep( 1.0 )  ## sleep (delay_in_s)
+    else
+      puts "!! ERROR - failed to download image; sorry - #{res.status.code} #{res.status.message}"
+      exit 1
+    end
+  end
+end
+
+end   # class Collection
+end   # module Ordinals
+

data/lib/ordinals.rb

@@ -1,3 +1,95 @@
 
-puts "hello ordinals"
+require 'cocos'
+require 'pixelart'
 
+require 'optparse'
+
+
+
+## our own code
+require_relative 'ordinals/collection'
+
+
+
+module Ordinals
+class Tool
+
+  def self.main( args=ARGV )
+    puts "==> welcome to ordinals/ordbase tool with args:"
+    pp args
+
+    options = {
+              }
+
+    parser = OptionParser.new do |opts|
+
+      opts.on("-h", "--help", "Prints this help") do
+        puts opts
+        exit
+      end
+    end
+
+    parser.parse!( args )
+    puts "options:"
+    pp options
+
+    puts "args:"
+    pp args
+
+    if args.size < 1
+      puts "!! ERROR - no collection found - use <collection> <command>..."
+      puts ""
+      exit
+    end
+
+    slug             = args[0]
+    command          = args[1] || 'image'
+
+    if ['i','img', 'image'].include?( command )
+      do_download_images( slug )
+    elsif ['conv','convert'].include?( command )
+      do_convert_images( slug )
+    elsif ['px','pixelate' ].include?( command )
+      do_pixelate( slug )
+    elsif ['comp','composite' ].include?( command )
+      do_make_composite( slug )
+    else
+      puts "!! ERROR - unknown command >#{command}<, sorry"
+    end
+
+    puts "bye"
+  end
+
+
+
+  def self.do_download_images( slug )
+    puts "==> download images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.download_images
+  end
+
+
+  def self.do_convert_images( slug )
+    puts "==> convert images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.convert_images
+  end
+
+  def self.do_pixelate( slug )
+    puts "==> downsample / pixelate images for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.pixelate
+  end
+
+  def self.do_make_composite( slug )
+    puts "==> make composite for collection >#{slug}<..."
+
+    col = Collection.new( slug )
+    col.make_composite
+  end
+
+end  # class Tool
+end   # module Ordinals

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ordinals
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-11 00:00:00.000000000 Z
+date: 2023-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cocos
@@ -72,10 +72,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.23'
-description: ordinals gem - (off-chain) ordinals (pixel art) machinery & helpers for
-  Bitcoin & co.
+description: ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery
+  & helpers for Bitcoin & co.
 email: wwwmake@googlegroups.com
-executables: []
+executables:
+- ordbase
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
@@ -86,7 +87,9 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/ordbase
 - lib/ordinals.rb
+- lib/ordinals/collection.rb
 homepage: https://github.com/pixelartexchange/ordinals.sandbox
 licenses:
 - Public Domain
@@ -111,6 +114,6 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: ordinals gem - (off-chain) ordinals (pixel art) machinery & helpers for Bitcoin
-  & co.
+summary: ordinals gem - "right-clicker" (off-chain) ordinals (pixel art) machinery
+  & helpers for Bitcoin & co.
 test_files: []