synthpunks 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0c5233aa985d25b010831dca85d14e481489665af2e69f428959d4db3a56228
-  data.tar.gz: 6f1e5ee50bb527fcdc4baa1e82673885a1883d3dc06b982d3c9f018f58045899
+  metadata.gz: c3aae408a71fa7dbdfab23739506a0c91e0b8188ba7c861357c7a8bbd01b3348
+  data.tar.gz: 181b42cea65ea801c0aa4bb776d0ba203e152fec8583082428626a5d6961a820
 SHA512:
-  metadata.gz: 90b18b54a84d472b62c0694389ca633b948f0ac45e5f63219f08e7ce63f0994542930e29ad86c6d1a97ae1483d10995c9603aa1fc7c8212d158c139fad5d823d
-  data.tar.gz: b0e77cb3d73d74a124628ea7da1af8f63c9ed5f5e595dbdffbf1a126e4bc29971236f3a7443006b081a2fbac7efeddbecbb2be49047a6abdf61f1706670f16fd
+  metadata.gz: b13f3dcadfab9ec10274ba0b20f41ab22f9124697f8aeb8ea46070fba5522264a62d4eb917c6462d5c254396a6a67aa02c233b5c387937bbf7d17d07b6c5a540
+  data.tar.gz: 369a320361c500376c5ddab5c715ae9a593b2692325d6b96cc5ab14a9987ac2e35f7546f4caae9decf85de4dcd0de5127303d92c75cf902ecc17904c39a40542

data/README.md

@@ -11,9 +11,285 @@ synthpunks - (free unlimited) 24×24 pixel punks for everyone - yes, you can - g
 
 
 
-## Usage
+##  What are Synthetic (Crypto) Punks V1?
 
-...
+> Fully on-chain (crypto) punks for every ethereum address. Check yours out for free!
+>
+>  -- [**syntheticpunks.com**](https://syntheticpunks.com)
+
+
+[Stephan Cilliers](https://github.com/stephancill) (from South Africa)
+has put together an open-source blockchain service ( - see [**stephancill/synthetic-punks**](https://github.com/stephancill/synthetic-punks) - )
+to generate for free¹ 24×24 punk pixel heads for every ethereum address (account).
+
+¹: and optionally clain / mint a (non-fungible) token for a 0.02 ether fee.
+
+
+The F.A.Q. reads:
+
+> Q: What are Synthetic Punks?
+>
+> A: Synthetic Punks is inspired by the historical
+> collection of 10 000  Matt & John's® Punks [Anno 2017]
+> by Larva Labs and Synthetic Loot by Dom Hofmann.
+> It generates a unique, fully on-blockchain punk for each Ethereum address.
+>
+> They are free to view for any address, but can be claimed [minted]
+> as an ERC-721 non-fungible token (NFT)
+> for a price of 0.02 ether.
+>
+> Features - Each Synthetic Punk
+> - Is generated from assets stored fully on-blockchain
+> - Is uniquely associated with an ethereum wallet address
+> - Supports Ethereum Name Service (ENS) in its metadata
+
+
+
+
+## "Off-Chain" Usage In Your Script
+
+
+Anyways, the synthpunks gem / library is inspired by Synthetic Punks V1
+by Stephan Cilliers (see above)
+and lets you generate punks using the "original"
+Synthetic Punks V1 pseudo-random number and image generation formula
+"off-blockchain"¹
+using the "original" Synthetic Punks V1 spritesheet
+
+![](config/spritesheet.png)
+
+and attribute categories (ranges) and names.
+
+
+Let's try
+the (ethereum) address 0x054f3b6eadc9631ccd60246054fdb0fcfe99b322:
+
+
+``` ruby
+require 'synthpunks'
+
+punk = Synthpunks::Image.generate('0x054f3b6eadc9631ccd60246054fdb0fcfe99b322' )
+punk.save( 'punk1.png' )
+punk.zoom(8).save( 'punk1@8x.png' )
+```
+
+resulting in:
+
+![](i/punk1.png)  8x
+![](i/punk1@8x.png)
+
+
+Tip:  Use `Synthpunks.getTokenID( addr )`
+to get the "official" token id
+from the address (that really is only a "convenience" helper that converts the 40-digit / 20-byte hexstring to a decimal (big) integer number). Example:
+
+``` ruby
+Synthpunks.getTokenID('0x054f3b6eadc9631ccd60246054fdb0fcfe99b322' )
+#=> 30311890011735557186986086868537068337617285922
+
+# note: yes, Synthpunks.getTokenID same as String#to_i(16)
+'0x054f3b6eadc9631ccd60246054fdb0fcfe99b322'.to_i( 16 )
+#=> 30311890011735557186986086868537068337617285922
+```
+
+And use the new exclusive "off-chain" only `Synthpunks.getAssetNames( id )`
+helper
+to get all (random) punk attributes by name.
+
+``` ruby
+Synthpunks.getAttributeNames( 30311890011735557186986086868537068337617285922 )
+#=> ["Alien", "Clown Nose", "Frown", "Vape", "Eyebrows"]
+```
+
+
+Now lookup the minted
+Synthetic (Crypto) Punks V1 on the open sea (secondary)
+market:
+
+[Minted Synthetic Punk for 0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf
+with Token ID #30311890011735557186986086868537068337617285922 @ Open Sea](https://opensea.io/assets/ethereum/0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf/30311890011735557186986086868537068337617285922)
+
+Or see
+[Synthetic Punk for 0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf](https://syntheticpunks.com/#/address/0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf)
+
+
+And spot the differencence - hint: none other
+than the "dark / black-ish" background is missing.
+
+
+Let's retry  and let's add the "dark / black-ish" background
+that is, #1A1A1A,  using the rgb hex color code:
+
+``` ruby
+punk = Synthpunks::Image.generate('0x054f3b6eadc9631ccd60246054fdb0fcfe99b322' )
+punk = punk.background( '#1A1A1A' )
+punk.save( 'punk1b.png' )
+punk.zoom(8).save( 'punk1b@8x.png' )
+```
+
+resulting in:
+
+![](i/punk1b.png)  8x
+![](i/punk1b@8x.png)
+
+
+Or for fun let's try some more new "custom" backgrounds.
+Example:  Stand with Ukraine / Ukraine Flag:
+
+``` ruby
+punk = Synthpunks::Image.generate('0x054f3b6eadc9631ccd60246054fdb0fcfe99b322' )
+punk = punk.background( 'ukraine' )
+punk.save( 'punk1c.png' )
+punk.zoom(8).save( 'punk1c@8x.png' )
+```
+
+resulting in:
+
+![](i/punk1c.png)  8x
+![](i/punk1c@8x.png)
+
+
+or
+
+``` ruby
+punk = punk.background( 'rainbow' )
+```
+
+resulting in:
+
+![](i/punk1d.png)  8x
+![](i/punk1d@8x.png)
+
+and so on.
+
+Tip:  Looking for left-looking phunks?  Try `Image#mirror`.
+Example:
+
+``` ruby
+punk = Synthpunks::Image.generate('0x054f3b6eadc9631ccd60246054fdb0fcfe99b322' )
+phunk = punk.mirror
+phunk.save( 'phunk1.png' )
+phunk.zoom(8).save( 'phunk1@8x.png' )
+```
+
+resulting in:
+
+![](i/phunk1.png)  8x
+![](i/phunk1@8x.png)
+
+
+Bonus Tip:  Derive your own custom default profile pictures
+using `Image#silhouette`. Example:
+
+
+``` ruby
+punk = Synthpunks::Image.generate('0x054f3b6eadc9631ccd60246054fdb0fcfe99b322' )
+punk = punk.silhouette( '0x647785' ).background( '0xCCD5DE' )
+punk.save( 'punk1-default1.png' )
+punk.zoom(8).save( 'punk1-default1@8x.png' )
+```
+
+resulting in:
+
+![](i/punk1-default1.png)  8x
+![](i/punk1-default1@8x.png)
+
+or is blue the new gray?
+
+``` ruby
+punk = punk.silhouette( '0x4474E0' ).background( '0xA0C2FF' )
+```
+
+resulting in:
+
+![](i/punk1-default2.png)  8x
+![](i/punk1-default2@8x.png)
+
+and so on.
+
+
+
+
+Yes, you can.
+Let's try some more
+the (ethereum) addresses.
+
+``` ruby
+punk = Synthpunks::Image.generate( '0x7a80ee32044f496a7bfef65af738fdda3a02cf02' )
+punk.save( "punk2.png" )
+punk.zoom(8).save( "punk2@8x.png" )
+```
+
+resulting in:
+
+![](i/punk2.png)  8x
+![](i/punk2@8x.png)
+
+
+and the attributes
+
+``` ruby
+tokenID = Synthpunks.getTokenID( '0x7a80ee32044f496a7bfef65af738fdda3a02cf02' )
+#=> 699372119169819039191610289391678040975564001026
+Synthpunks.getAttributeNames( tokenID )
+#=> ["Human 1", "Rosy Cheeks", "Shadow Beard", "Wild Hair", "VR"]
+```
+
+and compare with the "original" with the attributes:
+- Human 1
+- Rosy Cheeks
+- Wild Hair
+- VR
+- Shadow Beard
+
+
+[Minted Synthetic Punk for 0x7a80Ee32044F496A7bFeF65Af738FddA3a02CF02
+with Token ID #699372119169819039191610289391678040975564001026 @ Open Sea](https://opensea.io/assets/ethereum/0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf/699372119169819039191610289391678040975564001026)
+
+Or see [Synthetic Punk for 0x7a80Ee32044F496A7bFeF65Af738FddA3a02CF02](https://syntheticpunks.com/#/address/0x7a80Ee32044F496A7bFeF65Af738FddA3a02CF02)
+
+and so on.
+
+
+
+
+
+
+¹:  Yes, the (on-chain) solidity  contract code
+got translated "by-hand" to (off-chain) ruby script.
+
+Example -  the entropy pseudo-random number generator source:
+
+``` solidity
+function randomUint(uint256 seed, uint256 offset) public view returns (uint256)
+{
+    require(offset < 32, "Offset out of bounds");
+    bytes32 entropy = keccak256(abi.encodePacked(address(this), seed));
+    bytes32 mask = bytes32(0xff << (offset * 8));
+    uint256 out = uint256((entropy & mask) >> (offset * 8));
+    return out;
+}
+```
+
+and the matching ruby version:
+
+``` ruby
+ADDRESS = '0xaf9CE4B327A3b690ABEA6F78eCCBfeFFfbEa9FDf'
+
+## note:
+##   returns a random unit number between 0-255 (0-ff)
+##     use offset (0-31),that is, byte out of byte32 entropy buffer/hash
+
+def randomUint( seed, offset )
+  # assert( offset < 32, "Offset out of bounds")
+  entropy = keccak256( hex_to_bin( ADDRESS ) +
+                       hex_to_bin( uint256_to_hex(seed)) )
+
+  ##  note: pick a uint/byte (shorter version)
+  bytes = entropy.bytes.reverse
+  bytes[offset]
+end
+```
 
 
 

data/Rakefile

@@ -26,8 +26,9 @@ Hoe.spec 'synthpunks' do
   self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
-    ['pixelart', '>= 1.3.6'],
-    ['etherlite', '>= 0.3.1'],
+    ['backgrounds', '>= 0.2.1'],
+    ['pixelart',    '>= 1.3.6'],
+    ['etherlite',   '>= 0.3.1'],
   ]
 
   self.licenses = ['Public Domain']

data/lib/synthpunks/version.rb

@@ -3,9 +3,9 @@ module Pixelart
 module Module
 module Synthpunks
 
-  MAJOR = 0
+  MAJOR = 1
   MINOR = 0
-  PATCH = 1
+  PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

data/lib/synthpunks.rb

@@ -1,4 +1,5 @@
 require 'pixelart'
+require 'backgrounds'
 require 'ethlite'     ## needed for Digest::Keccak (otherwise no dep for now)
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: synthpunks
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -10,6 +10,20 @@ bindir: bin
 cert_chain: []
 date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: backgrounds
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 - !ruby/object:Gem::Dependency
   name: pixelart
   requirement: !ruby/object:Gem::Requirement