cryptopunks 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92192671eaee8d69d5a4e56b28a6d38d0fd2140739fab1a11053d4f4b2fe82ab
-  data.tar.gz: 9d803e337667a543a6438f8b22e937153965d31fbb4be8ac2420f9427d2f0710
+  metadata.gz: 3babd0420946592ca224951eacf1b9b14e6fea52917796bb550d86e4c05d13b1
+  data.tar.gz: e301d2ff4f5b84648d9cf7ba61fafbddc9383eca269563ff85a840c21a032159
 SHA512:
-  metadata.gz: 374886a9f63aca0c2ff6149b3c8e9ad906555c43fa3a917eb8a6dd6f997bd67a6c419dabd179f0c15b2874e65bd69bf640fbd33dd0654864865a53161265f9bd
-  data.tar.gz: 9e2942c55b95b628bf1b205405cf203b28f83ae90d0a79cf61feacfa1ec96baa0e95ec4e55deec38a2260209998d6b92bec0255461f469e7318767909170145c
+  metadata.gz: c152187a308be9c17a8cd165f2a059abbbc34f39f81ac4e88a4e1d1d0aee597a583675895ee9b8e5f577b3e2752fd0d2dfabf705eebc1d247efbc9c8e2b1de85
+  data.tar.gz: 238114795788bdf2685ffc093fd3c25960fd268738722810ac1bd524a3be2708c3388606da3ddce2bf6c6c2762f0f9401e3d768c7f19bcdaa8bdefe45b73ba1d

data/Manifest.txt

@@ -2,5 +2,7 @@ CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile
+bin/cryptopunk
+bin/punk
 lib/cryptopunks.rb
 lib/cryptopunks/version.rb

data/README.md

@@ -1,15 +1,184 @@
-# cryptopunks
+# Crypto Punks
 
-mint your own 24×24 pixel punk images off chain from the True Official Genuine CryptoPunks™ sha256-verified original; incl. 2x/4x/8x zoom for bigger sizes
+cryptopunks - mint your own 24×24 pixel punk images off chain from the True Official Genuine CryptoPunks™ sha256-verified original 10 000 unique character collection; incl. 2x/4x/8x zoom for bigger sizes
 
+* home  :: [github.com/rubycoco/cryptopunks](https://github.com/rubycoco/cryptopunks)
+* bugs  :: [github.com/rubycoco/cryptopunks/issues](https://github.com/rubycoco/cryptopunks/issues)
+* gem   :: [rubygems.org/gems/cryptopunks](https://rubygems.org/gems/cryptopunks)
+* rdoc  :: [rubydoc.info/gems/cryptopunks](http://rubydoc.info/gems/cryptopunks)
 
 
-## Usage
 
-to be done
+> Someday, owning a CryptoPunk might signify just how early of an
+> adopter you were into the world of blockchain and its thriving digital
+> art scene. Or, they could just be a bunch of [24×24 pixel] images.
+>
+> -- [June 2017](https://mashable.com/2017/06/16/cryptopunks-ethereum-art-collectibles/)
+>
+>
+> There will be a desire and need to buy expensive [status symbols]
+> in the digital realm [to "flex" how rich I am].
+> What could be more desirable than a small [24×24]
+> pixelated [knitted cap-wearing ape] face?
+> CryptoPunk artwork [![](i/punk-8219.png) [#8219](https://www.larvalabs.com/cryptopunks/details/8219)] just sold for $176,000.
+>
+> -- [January 2021](https://decrypt.co/53519/an-ethereum-based-cryptopunk-artwork-just-sold-for-176000)
+>
+>
+> Ultra-rare alien [24×24 pixel] CryptoPunk
+> sells for 605 ETH, or $750,000.
+> The investment thesis. "Aliens are the rarest form of CryptoPunk and
+> we believe that the acquired Alien [![](i/punk-2890.png) [#2890](https://www.larvalabs.com/cryptopunks/details/2890), one of nine]
+> will be prized by collectors over
+> time and mature into an iconic digital art piece."
+>
+> -- [January 2021](https://cointelegraph.com/news/ultra-rare-alien-cryptopunk-nft-sells-for-605-eth-or-750-000)
+>
+>
+> The [CryptoPunksMarket] contract now holds 4,095 ETH (~$5.4M USD) in open bids and pending withdrawals.
+>
+> -- [January 2021](https://twitter.com/larvalabs/status/1353915659453870080)
 
 
 
+New to Crypto Punks?
+See the [**Awesome CryptoPunks Bubble (Anno 2021) - Modern 24×24 Pixel Crypto Art on the Blockchain** »](https://github.com/openblockchains/awesome-cryptopunks-bubble)
+
+
+
+## Command Line
+
+Use the `punk` (or `cryptopunk`) command line tool. Try:
+
+```
+$ punk -h
+```
+
+resulting in:
+
+```
+Usage: cryptopunks [options] IDs
+  Mint punk characters from composite (./punks.png) - for IDs use 0 to 9999
+
+  Options:
+    -z, --zoom=ZOOM        Zoom factor x2, x4, x8, etc. (default: 1)
+    -d, --dir=DIR          Output directory (default: .)
+    -f, --file=FILE        True Official Genuine CryptoPunks™ composite image (default: ./punks.png)
+    -h, --help             Prints this help
+```
+
+
+Step 0 -  Download the True Official Genuine CryptoPunks™ composite image
+
+One time / first time only - Download the True Official Genuine CryptoPunks™ composite
+housing all 10 000 CryptoPunks
+in a single 2400×2400 image (~830 kb) for free.
+See [`punks.png` »](https://github.com/larvalabs/cryptopunks/blob/master/punks.png)
+
+
+![](i/punks-zoom.png)
+
+
+
+Now let's give it a try.  Let's mint punk #0, #2890, and #8219:
+
+```
+$ punk 0 2890 8219
+```
+
+printing:
+
+```
+==> reading >./punks.png<...
+     >ac39af4793119ee46bbff351d8cb6b5f23da60222126add4268e261199a2921b< SHA256 hash matching
+         ✓ True Official Genuine CryptoPunks™ verified
+==> (1/3) minting punk #0; writing to >./punk-0000.png<...
+==> (2/3) minting punk #2890; writing to >./punk-2890.png<...
+==> (3/3) minting punk #8219; writing to >./punk-8219.png<...
+```
+
+And voila!
+
+![](i/punk-0000.png)
+![](i/punk-2890.png)
+![](i/punk-8219.png)
+
+
+Bonus:  Try the -z/--zoom factor x2, x4, x8, etc.
+
+Now let's give it a try.  Let's mint punk #0, #2890, and #8219 in 2x format:
+
+```
+$ punk --zoom 2 0 2890 8219
+# -or-
+$ punk -z2 0 2890 8219
+```
+
+printing:
+
+```
+==> reading >./punks.png<...
+     >ac39af4793119ee46bbff351d8cb6b5f23da60222126add4268e261199a2921b< SHA256 hash matching
+         ✓ True Official Genuine CryptoPunks™ verified
+    setting zoom to 2x
+==> (1/3) minting punk #0; writing to >punk-0000x2.png<...
+==> (2/3) minting punk #2890; writing to >punk-2890x2.png<...
+==> (3/3) minting punk #8219; writing to >punk-8219x2.png<...
+```
+
+And voila!
+
+![](i/punk-0000x2.png)
+![](i/punk-2890x2.png)
+![](i/punk-8219x2.png)
+
+And x4:
+
+![](i/punk-0000x4.png)
+![](i/punk-2890x4.png)
+![](i/punk-8219x4.png)
+
+
+And x8:
+
+![](i/punk-0000x8.png)
+![](i/punk-2890x8.png)
+![](i/punk-8219x8.png)
+
+
+And so on.
+
+
+## Usage in Your Scripts
+
+
+Yes, you can mint punks in your own scripts.
+Example:
+
+``` ruby
+require 'cryptopunks'
+
+# step 1: read True Official Genuine CryptoPunks™ composite image
+punks = Punks::Image.read( './punks.png' )
+
+# step 2: start minting
+
+punks[0].save( './punk-0000.png' )
+punks[2890].save( './punk-2890.png' )
+punks[8219].save( './punk-8219.png')
+
+# or change the zoom factor
+punks.zoom = 4   # use x4
+
+punks[0].save( './punk-0000x4.png' )
+punks[2890].save( './punk-2890x4.png' )
+punks[8219].save( './punk-8219x4.png')
+```
+
+and so on. Happy miniting.
+That's all for now.
+
+
 
 ## Install
 

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'cryptopunks' do
 
   self.version = Cryptopunks::VERSION
 
-  self.summary = "cryptopunks - mint your own 24×24 pixel punk images off chain from the True Official Genuine CryptoPunks™ sha256-verified original; incl. 2x/4x/8x zoom for bigger sizes"
+  self.summary = "cryptopunks - mint your own 24×24 pixel punk images off chain from the True Official Genuine CryptoPunks™ sha256-verified original 10 000 unique character collection; incl. 2x/4x/8x zoom for bigger sizes"
   self.description = summary
 
   self.urls    = { home: 'https://github.com/rubycoco/blockchain' }

data/bin/cryptopunk

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

data/bin/punk

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

data/lib/cryptopunks.rb

@@ -1,9 +1,181 @@
-require 'pp'
+## 3rd party
+require 'crypto-lite'
+require 'chunky_png'
+
+## extra stdlibs
+require 'fileutils'
+require 'optparse'
+
 
 
 ## our own code
 require 'cryptopunks/version'    # note: let version always go first
 
 
-pp Cryptopunks.banner
-pp Cryptopunks.root
+module Cryptopunks
+class Image
+  def self.read( path='./punks.png' )
+    data = File.open( path, 'rb' ) { |f| f.read }
+    new( data )
+  end
+
+
+  attr_accessor :zoom
+
+  PUNK_ROWS   = 100
+  PUNK_COLS   = 100
+  PUNK_COUNT  = PUNK_ROWS * PUNK_COLS    ## 10_000 = 100x100  (24000x24000 pixel)
+
+  PUNK_HEIGHT = 24
+  PUNK_WIDTH  = 24
+
+  PUNK_HASH   = 'ac39af4793119ee46bbff351d8cb6b5f23da60222126add4268e261199a2921b'
+
+
+  def initialize( data )
+    @punks = ChunkyPNG::Image.from_blob( data )
+    puts "     #{@punks.height}x#{@punks.width} (height x width)"
+
+    ## check sha256 checksum
+    @hexdigest = sha256( data )
+    if original?
+       puts "     >#{@hexdigest}< SHA256 hash matching"
+       puts "         ✓ True Official Genuine CryptoPunks™ verified"
+    else
+       puts " !! ERROR: >#{hexdigest}< SHA256 hash NOT matching"
+       puts "           >#{PUNK_HASH}< expected for True Official Genuine CryptoPunks™."
+       puts ""
+       puts "     Sorry, please download the original."
+       exit 1
+    end
+
+    @zoom  = 1
+  end
+
+
+  def hexdigest()  @hexdigest end
+
+  def verify?()  @hexdigest == PUNK_HASH; end
+  alias_method :genuine?,  :verify?
+  alias_method :original?, :verify?
+
+
+
+  def size() PUNK_COUNT; end
+
+  def []( index )
+    @zoom == 1 ? crop( index ) : scale( index, @zoom )
+  end
+
+
+  def crop( index  )
+    y, x = index.divmod( PUNK_ROWS )
+    @punks.crop( x*PUNK_WIDTH, y*PUNK_HEIGHT, PUNK_WIDTH, PUNK_HEIGHT )
+  end
+
+
+  def scale( index, zoom )
+    punk = ChunkyPNG::Image.new( PUNK_WIDTH*zoom, PUNK_HEIGHT*zoom,
+                                 ChunkyPNG::Color::WHITE )
+
+    ## (x,y) offset in big all-in-one punks image
+    y, x = index.divmod( PUNK_ROWS )
+
+    ## copy all 24x24 pixels
+    PUNK_WIDTH.times do |i|
+      PUNK_HEIGHT.times do |j|
+        pixel = @punks[i+x*PUNK_WIDTH, j+y*PUNK_HEIGHT]
+        zoom.times do |n|
+          zoom.times do |m|
+            punk[n+zoom*i,m+zoom*j] = pixel
+          end
+        end
+      end
+    end
+    punk
+  end
+end ## class Image
+
+
+
+class Tool
+  def run( args )
+    opts = { zoom: 1,
+             outdir: '.',
+             file:  './punks.png',
+           }
+
+    parser = OptionParser.new do |cmd|
+      cmd.banner = "Usage: cryptopunks [options] IDs"
+
+      cmd.separator "  Mint punk characters from composite (#{opts[:file]}) - for IDs use 0 to 9999"
+      cmd.separator ""
+      cmd.separator "  Options:"
+
+      cmd.on("-z", "--zoom=ZOOM", "Zoom factor x2, x4, x8, etc. (default: #{opts[:zoom]})", Integer ) do |zoom|
+        opts[:zoom] = zoom
+      end
+
+      cmd.on("-d", "--dir=DIR", "Output directory (default: #{opts[:outdir]})", String ) do |outdir|
+        opts[:outdir] = outdir
+      end
+
+      cmd.on("-f", "--file=FILE", "True Official Genuine CryptoPunks™ composite image (default: #{opts[:file]})", String ) do |file|
+        opts[:file] = file
+      end
+
+
+      cmd.on("-h", "--help", "Prints this help") do
+        puts cmd
+        exit
+      end
+    end
+
+    parser.parse!( args )
+
+    puts "opts:"
+    pp opts
+
+    puts "==> reading >#{opts[:file]}<..."
+    punks = Image.read( opts[:file] )
+
+
+    puts "    setting zoom to #{opts[:zoom]}x"   if opts[:zoom] != 1
+    punks.zoom = opts[:zoom]   ## note: always reset zoom even if 1
+
+    ## make sure outdir exits (default is current working dir e.g. .)
+    FileUtils.mkdir_p( opts[:outdir] )  unless Dir.exist?( opts[:outdir] )
+
+    args.each_with_index do |arg,index|
+      punk_index = arg.to_i
+      punk_name  = "punk-" + "%04d" % punk_index
+
+      ##  if zoom - add x2,x4 or such
+      punk_name << "x#{opts[:zoom]}"   if opts[:zoom] != 1
+
+      path  = "#{opts[:outdir]}/#{punk_name}.png"
+      puts "==> (#{index+1}/#{args.size}) minting punk ##{punk_index}; writing to >#{path}<..."
+
+      punks[ punk_index ].save( path )
+    end
+
+    puts "done"
+  end  ## method run
+end # class Tool
+
+
+def self.main( args=ARGV )
+  Tool.new.run( args )
+end
+end ## module Cryptopunks
+
+
+
+### add some convenience shortcuts
+CryptoPunks = Cryptopunks
+Punks       = Cryptopunks
+
+
+
+
+puts Cryptopunks.banner    # say hello

data/lib/cryptopunks/version.rb

@@ -2,9 +2,9 @@
 
 module Cryptopunks
 
-  MAJOR = 0
+  MAJOR = 1
   MINOR = 0
-  PATCH = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cryptopunks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -73,10 +73,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.22'
 description: cryptopunks - mint your own 24×24 pixel punk images off chain from the
-  True Official Genuine CryptoPunks™ sha256-verified original; incl. 2x/4x/8x zoom
-  for bigger sizes
+  True Official Genuine CryptoPunks™ sha256-verified original 10 000 unique character
+  collection; incl. 2x/4x/8x zoom for bigger sizes
 email: wwwmake@googlegroups.com
-executables: []
+executables:
+- cryptopunk
+- punk
 extensions: []
 extra_rdoc_files:
 - CHANGELOG.md
@@ -87,6 +89,8 @@ files:
 - Manifest.txt
 - README.md
 - Rakefile
+- bin/cryptopunk
+- bin/punk
 - lib/cryptopunks.rb
 - lib/cryptopunks/version.rb
 homepage: https://github.com/rubycoco/blockchain
@@ -114,6 +118,6 @@ rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: cryptopunks - mint your own 24×24 pixel punk images off chain from the True
-  Official Genuine CryptoPunks™ sha256-verified original; incl. 2x/4x/8x zoom for
-  bigger sizes
+  Official Genuine CryptoPunks™ sha256-verified original 10 000 unique character collection;
+  incl. 2x/4x/8x zoom for bigger sizes
 test_files: []