ethname 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 450342f14ab626b337ad859811381f4185a11cfd805a887fb628be35427c6549
+  data.tar.gz: 45b92de48f56083fad1e94975f1dfb58f7afeb4d64ee55a12650104ae87372af
+SHA512:
+  metadata.gz: 6e37ff7f85701c927c9f5fb8f78b8174b003f7a521f1e6d705c565f919f1d437d5b467ac044484379a45be52669de8cb427b45cf4f3c02b31c75fa313c1eddbc
+  data.tar.gz: 0bcee46cf8ebb0b33de5e85c9ce93e7fc9b1dd33a40a6a771b92d99943362ef4758db0d9a022d838bdcbfdc127c8ce9fc33ab4e81233aff0ed7c43f50e0755bc

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.0.1 / 2022-12-16
+
+* Everything is new. First release

data/Manifest.txt

@@ -0,0 +1,10 @@
+CHANGELOG.md
+Manifest.txt
+README.md
+Rakefile
+config/contracts.2017.csv
+config/contracts.2021.csv
+config/contracts.2022.csv
+lib/ethname.rb
+lib/ethname/dictionary.rb
+lib/ethname/version.rb

data/README.md

@@ -0,0 +1,110 @@
+# Ethname - Free Crowd-Sourced "Off-Chain" Eth(erum) Name Service
+
+ethname - light-weight crowd-sourced "off-chain" ethereum name to (contract) address service / helper (incl. punks v1,v2,v3,v4; phunks v1,v2, synth punks, punk blocks, etc.)  - yes, you can! - add more names / contracts via git ;-)
+
+
+* home  :: [github.com/rubycocos/blockchain](https://github.com/rubycocos/blockchain)
+* bugs  :: [github.com/rubycocos/blockchain/issues](https://github.com/rubycocos/blockchain/issues)
+* gem   :: [rubygems.org/gems/ethname](https://rubygems.org/gems/ethname)
+* rdoc  :: [rubydoc.info/gems/ethname](http://rubydoc.info/gems/ethname)
+
+
+
+
+## Usage
+
+
+Lookup (contract) addresses by name via the `Ethname` helper:
+
+``` ruby
+require 'ethname'
+
+## let's try some punk (pixel art collection) contracts / services:
+Ethname['punks v1']     #=> "0x6ba6f2207e343923ba692e5cae646fb0f566db8d"
+Ethname['punks v2']     #=> "0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb"
+Ethname['punks v3']     #=> "0xd33c078c2486b7be0f7b4dda9b14f35163b949e0"
+Ethname['punks v4']     #=> "0xd12882c8b5d1bccca57c994c6af7d96355590dbd"
+
+Ethname['punks v1 wrapped i']  #=> "0xf4a4644e818c2843ba0aabea93af6c80b5984114"
+Ethname['punks v1 wrapped ii'] #=> "0x282bdd42f4eb70e7a9d9f40c8fea0825b7f68c5d"
+
+Ethname['phunks v1']   #=> "0xa82f3a61f002f83eba7d184c50bb2a8b359ca1ce"
+Ethname['phunks v2']   #=> "0xf07468ead8cf26c752c676e43c814fee9c8cf402"
+Ethname['phunks v3']   #=> "0xa19f0378a6f3f3361d8e962f3589ec28f4f8f159"
+
+Ethname['synth punks']  #=> "0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf"
+
+Ethname['punks data']   #=> "0x16f5a35647d6f03d5d3da7b35409d65ba03af3b2"
+Ethname['punk blocks']  #=> "0x58e90596c2065befd3060767736c829c18f3474c"
+
+# and so on
+```
+
+Note: The names internally get "normalized", that is,
+all characters except a-z and the digits 0-9 get stripped
+that includes spaces, dots (.), dashes (-), underline (_), and so on.
+Yes, for the lookup you can use all variants of uppercase (PUNKS)
+or lowercase (punks) spellings. Example:
+
+
+``` ruby
+Ethname['Synth Punks']   #=> "0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf"
+Ethname['SynthPunks']    #=> "0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf"
+Ethname['Synthpunks']    #=> "0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf"
+Ethname['SYNTH PUNKS']   #=> "0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf"
+Ethname['SYNTHPUNKS']    #=> "0xaf9ce4b327a3b690abea6f78eccbfefffbea9fdf"
+# and so on
+```
+
+
+
+## Inside the Crowd-Sourced "Off-Chain" Ethereum Name To (Contract) Address Service
+
+The name to address mappings are fow now stored
+in datafiles in the comma-separated value (.csv) format
+and split by year (e.g. 2017, 2018, ..., 2021, 2022, 2023, etc.)
+
+Example - [config/contracts.2017.csv](config/contracts.2017.csv):
+
+``` csv
+address, names
+0x6Ba6f2207e343923BA692e5Cae646Fb0F566DB8D,  punks v1 | crypto punks v1
+0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb,  punks v2 | crypto punks v2 | crypto punks market
+0x60cd862c9c687a9de49aecdc3a99b74a4fc54ab6,  mooncats | mooncatrescue
+...
+```
+
+Example - [config/contracts.2022.csv](config/contracts.2022.csv):
+
+``` csv
+address, names
+0x282bdd42f4eb70e7a9d9f40c8fea0825b7f68c5d, punks v1 wrapped ii
+0xD33c078C2486B7Be0F7B4DDa9B14F35163B949e0, punks v3
+0xd12882c8b5d1bccca57c994c6af7d96355590dbd, punks v4
+0xA19f0378A6F3f3361d8e962F3589Ec28f4f8F159,  phunks v3
+0xaf9CE4B327A3b690ABEA6F78eCCBfeFFfbEa9FDf, synthetic punks | synth punks
+0x58E90596C2065BEfD3060767736C829C18F3474c, punk blocks
+0x23581767a106ae21c074b2276D25e5C3e136a68b,  moonbirds
+...
+```
+
+###  Yes, You Can! - Add More Names / Contracts Via Git ;-)
+
+Your contributions welcome. You are welcome to join in and
+help to add more name to ethereum contract / service mappings.
+
+
+
+
+## License
+
+The scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.
+
+
+## Questions? Comments?
+
+
+Post them on the [D.I.Y. Punk (Pixel) Art reddit](https://old.reddit.com/r/DIYPunkArt). Thanks.
+
+

data/Rakefile

@@ -0,0 +1,32 @@
+require 'hoe'
+require './lib/ethname/version.rb'
+
+
+Hoe.spec 'ethname' do
+
+  self.version = Ethname::VERSION
+
+  self.summary = 'ethname - light-weight crowd-sourced "off-chain" ethereum name to (contract) address service / helper (incl. punks v1,v2,v3,v4; phunks v1,v2, synth punks, punk blocks, etc.)  - yes, you can! - add more names / contracts via git ;-)'
+  self.description = summary
+
+  self.urls    = { home: 'https://github.com/rubycocos/blockchain' }
+
+  self.author  = 'Gerald Bauer'
+  self.email   = 'wwwmake@googlegroups.com'
+
+  # switch extension to .markdown for gihub formatting
+  self.readme_file  = 'README.md'
+  self.history_file = 'CHANGELOG.md'
+
+  self.extra_deps = [
+    ['cocos'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+    required_ruby_version: '>= 2.3'
+  }
+
+end
+

data/config/contracts.2017.csv

@@ -0,0 +1,6 @@
+address, names
+0x6Ba6f2207e343923BA692e5Cae646Fb0F566DB8D,  punks v1 | crypto punks v1
+0xb47e3cd837ddf8e4c57f05d70ab865de6e193bbb,  punks v2 | crypto punks v2 | crypto punks market
+0x60cd862c9c687a9de49aecdc3a99b74a4fc54ab6,  mooncats | mooncatrescue
+
+

data/config/contracts.2021.csv

@@ -0,0 +1,11 @@
+address, names
+0x16f5a35647d6f03d5d3da7b35409d65ba03af3b2, punks data | crypto punks data
+0xf4a4644e818c2843ba0aabea93af6c80b5984114, punks v1 wrapped i | classic punks
+
+0xa82f3a61f002f83eba7d184c50bb2a8b359ca1ce, phunks v1 | philips
+0xf07468ead8cf26c752c676e43c814fee9c8cf402, phunks v2 | phunks
+
+0x031920cc2d9f5c10b444fd44009cd64f829e7be2, zunks
+
+0x0d0167a823c6619d430b1a96ad85b888bcf97c37, xpunks | expansion punks
+0x71eb5c179ceb640160853144cbb8df5bd24ab5cc, xphunks | expansion phunks

data/config/contracts.2022.csv

@@ -0,0 +1,15 @@
+address, names
+0x282bdd42f4eb70e7a9d9f40c8fea0825b7f68c5d, punks v1 wrapped ii
+
+0xD33c078C2486B7Be0F7B4DDa9B14F35163B949e0, punks v3
+0xd12882c8b5d1bccca57c994c6af7d96355590dbd, punks v4
+
+0xA19f0378A6F3f3361d8e962F3589Ec28f4f8F159,  phunks v3
+
+
+0xaf9CE4B327A3b690ABEA6F78eCCBfeFFfbEa9FDf, synthetic punks | synth punks
+
+0x58E90596C2065BEfD3060767736C829C18F3474c, punk blocks
+
+
+0x23581767a106ae21c074b2276D25e5C3e136a68b,  moonbirds

data/lib/ethname/dictionary.rb

@@ -0,0 +1,75 @@
+
+module Ethname
+
+  class Dictionary
+     ## let's you lookup up ethereum addresses by name
+
+     def self.read( *paths )    ## use load - why? why not?
+        dict = new
+        paths.each do |path|
+          recs = read_csv( path )
+          dict.add_recs( recs )
+        end
+        dict
+     end
+
+
+
+     def initialize
+       @recs          = []
+       @reverse_table = {}   ## lookup (address) by (normalized) name
+     end
+
+     def recs() @recs; end
+     def size() @recs.size; end
+
+
+
+     def lookup( q )
+        key = normalize( q )
+        addr = @reverse_table[ key ]
+        addr
+     end
+     alias_method :[], :lookup
+
+
+     def add_recs( recs )
+      recs.each do |rec|
+        ## note: always downcase addresses for now
+        ##   (do NOT use addresss checksum with mixed-hexchars) - why? why not?
+        addr =  rec['address'].downcase
+        names = rec['names'].split('|')
+        names.each do |name|
+          _add( addr, name )
+        end
+      end
+
+      @recs += recs
+    end
+
+
+     #################
+     #  convencience helpers
+     def self.normalize( str )
+         ## remove all non a-z (and 0-9) characters
+        str.downcase.gsub( /[^a-z0-9]/i, '' )
+     end
+
+     def normalize( str ) self.class.normalize( str ); end
+
+     ####
+     # private (internal) helpers
+     def _add( addr, name )
+      key = normalize( name )
+      addr2 = @reverse_table[ key ]
+
+      ## check for duplicates
+      raise ArgumentError, "duplicate (normalized) key >#{key} for addr >#{addr}<"  if addr == addr2
+      raise ArgumentError, "duplicate (normalized) key >#{key}< for addr >#{addr}; addr already in use >#{addr2}<"  if addr2
+      @reverse_table[ key ] = addr
+      self
+   end
+
+  end
+end  # module Ethname
+

data/lib/ethname/version.rb

@@ -0,0 +1,22 @@
+
+
+module Ethname
+  MAJOR = 0
+  MINOR = 0
+  PATCH = 1
+  VERSION = [MAJOR,MINOR,PATCH].join('.')
+
+  def self.version
+    VERSION
+  end
+
+  def self.banner
+    "ethname/#{VERSION} on Ruby #{RUBY_VERSION} (#{RUBY_RELEASE_DATE}) [#{RUBY_PLATFORM}] in (#{root})"
+  end
+
+  def self.root
+    File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )
+  end
+
+end # module Ethname
+

data/lib/ethname.rb

@@ -0,0 +1,30 @@
+require 'cocos'
+
+
+
+## our own code
+require_relative 'ethname/version'
+require_relative 'ethname/dictionary'
+
+
+module Ethname
+
+def self.dict
+   @dict ||= Dictionary.read( "#{root}/config/contracts.2017.csv",
+                              "#{root}/config/contracts.2021.csv",
+                              "#{root}/config/contracts.2022.csv",
+                            )
+end
+
+def self.lookup( q )
+  dict.lookup( q )
+end
+class << self
+  alias_method :[], :lookup
+end
+
+end  # module Ethname
+
+
+
+Ethname.banner   ## say hello

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: ethname
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Gerald Bauer
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocos
+  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: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: hoe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: ethname - light-weight crowd-sourced "off-chain" ethereum name to (contract)
+  address service / helper (incl. punks v1,v2,v3,v4; phunks v1,v2, synth punks, punk
+  blocks, etc.)  - yes, you can! - add more names / contracts via git ;-)
+email: wwwmake@googlegroups.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+files:
+- CHANGELOG.md
+- Manifest.txt
+- README.md
+- Rakefile
+- config/contracts.2017.csv
+- config/contracts.2021.csv
+- config/contracts.2022.csv
+- lib/ethname.rb
+- lib/ethname/dictionary.rb
+- lib/ethname/version.rb
+homepage: https://github.com/rubycocos/blockchain
+licenses:
+- Public Domain
+metadata: {}
+post_install_message:
+rdoc_options:
+- "--main"
+- README.md
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ethname - light-weight crowd-sourced "off-chain" ethereum name to (contract)
+  address service / helper (incl. punks v1,v2,v3,v4; phunks v1,v2, synth punks, punk
+  blocks, etc.)  - yes, you can! - add more names / contracts via git ;-)
+test_files: []