centralbank 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2515cd5ffc9b10106967ee1a9a9debb055f903ed
-  data.tar.gz: 66659648d73015c121fb89fe5e9b1027efd80480
+  metadata.gz: 202c231a695058fedcfd45734447b823ecec5943
+  data.tar.gz: 793bcbc06a672be4a32f417b2c0c145cca9dace8
 SHA512:
-  metadata.gz: eddc4d10f787ba4e3822f794f1bcf9fe2eb3fe45d01abddd9a6ec46d19d4d34d6097c7a6d93045d33b5576f8c36d6b8e9594a821a79920d8aa31b185e6792824
-  data.tar.gz: ac3528bc56a2e997e273696e334bfdefa6fc5bd614a6b64cae09cec5bd2cb05011502d229b155c97d50faecd61215e7ce2dc9b1eab11bbcebd34eee82021e981
+  metadata.gz: 8fd3ac2058c57dffcf3050124609d1fc6cad9f49a8e543e06a20d26b809d31b3ed5053f757e02fe736d0080c6c209736cb8afff9b0d230d325ac0b3a113cfd66
+  data.tar.gz: 6e7a6fad83c6cd24336ef5d074c7136f1e3f5153bd74d2979464fdfc914a1d859b25c1027ceac4570df7092a3ed23c12d8c356714ebedcbeecaf421cae7fd643

data/README.md

@@ -9,9 +9,59 @@ print your own money / cryptocurrency; run your own federated central bank nodes
 * rdoc  :: [rubydoc.info/gems/centralbank](http://rubydoc.info/gems/centralbank)
 
 
+## Command Line
 
+Use the `centralbank` command line tool. Try:
 
-## Development 
+```
+$ centralbank -h     
+```
+
+resulting in:
+
+```
+Usage: centralbank [options]
+
+  Wallet options:
+    -n, --name=NAME                  Address name (default: Alice)
+
+  Server (node) options:
+    -o, --host HOST                  listen on HOST (default: 0.0.0.0)
+    -p, --port PORT                  use PORT (default: 4567)
+    -h, --help                       Prints this help
+```
+
+To start a new (network) node using the default wallet
+address (that is, Alice) and the default server host and port settings
+use:
+
+```
+$ centralbank
+```
+
+Stand back ten feets :-) while starting up the machinery.
+Ready to print (mine) money on the blockchain?
+In your browser open up the page e.g. `http://localhost:4567`. Voila!
+
+![](centralbank.png)
+
+
+
+Note: You can start a second node on your computer -
+make sure to use a different port (use the `-p/--port` option)
+and (recommended)
+a different wallet address (use the `-n/--name` option).
+Example:
+
+```
+$ centralbank -p 5678 -n Bob
+```
+
+Happy mining!
+
+
+
+## Local Development Setup
 
 For local development - clone or download (and unzip) the centralbank code repo.
 Next install all dependencies using bundler with a Gemfile e.g.:
@@ -50,12 +100,7 @@ and startup the money printing machine using rackup - the rack command line tool
 $ rackup       ## will use the config.ru - rackup configuration script (see above).
 ```
 
-In your browser open up the page e.g. `http://localhost:9292`. Voila!
-
-![](centralbank.png)
-
-
-Happy mining! 
+In your browser open up the page e.g. `http://localhost:9292`. Voila! Happy mining!
 
 
 

data/lib/centralbank.rb

@@ -49,15 +49,31 @@ module Centralbank
      attr_accessor :coinbase
      attr_accessor :mining_reward
 
+     ## note: add a (†) coinbase  marker
+     COINBASE = ['Everest†', 'Aconcagua†', 'Denali†',
+                 'Kilimanjaro†', 'Elbrus†', 'Vinson†',
+                 'Puncak Jaya†', 'Kosciuszko†',
+                 'Mont Blanc†'
+                ]
+
 
      def initialize
        ## try default setup via ENV variables
        ## pick "random" address if nil (none passed in)
-       @address = ENV[ 'CENTRALBANK_NAME'] || WALLET_ADDRESSES[rand( WALLET_ADDRESSES.size )]
+       @address = ENV[ 'CENTRALBANK_NAME'] || rand_address()
 
-       @coinbase      = 'COINBASE'   ## use a different name - why? why not?
+       @coinbase = COINBASE         ## use a different name - why? why not?
+                                    ##  note: for now is an array (multiple coinbases)
        @mining_reward = 5
      end
+
+     def rand_address()      WALLET_ADDRESSES[rand( WALLET_ADDRESSES.size )];  end
+     def rand_coinbase()     @coinbase[rand( @coinbase.size )];  end
+
+     def coinbase?( address )    ## check/todo: use wallet - why? why not? (for now wallet==address)
+       @coinbase.include?( address )
+     end
+
   end # class Configuration
 
 

data/lib/centralbank/bank.rb

@@ -18,7 +18,7 @@ class Bank
       @pending = Pool.from_json( h['transactions'] )
     else
       @chain   = Blockchain.new
-      @chain  << [Tx.new( Centralbank.config.coinbase,
+      @chain  << [Tx.new( Centralbank.config.rand_coinbase,
                           @address,
                           Centralbank.config.mining_reward )]    # genesis (big bang!) starter block
       @pending = Pool.new
@@ -31,7 +31,7 @@ class Bank
 
 
   def mine_block!
-    add_transaction( Tx.new( Centralbank.config.coinbase,
+    add_transaction( Tx.new( Centralbank.config.rand_coinbase,
                              @address,
                              Centralbank.config.mining_reward ))
 

data/lib/centralbank/cache.rb

@@ -6,14 +6,14 @@ class Cache
   end
 
   def write( data )
-    File.open( @name, 'w' ) do |f|        ## use utf8 - why? why not??
+    File.open( @name, 'w:utf-8' ) do |f|
       f.write JSON.pretty_generate( data )
     end
   end
 
   def read
     if File.exists?( @name )
-      data = File.read( @name )   ## use utf8 - why? why not??
+      data = File.open( @name, 'r:bom|utf-8' ).read
       JSON.parse( data )
     else
       nil

data/lib/centralbank/ledger.rb

@@ -10,7 +10,7 @@ class Ledger
   end
 
   def sufficient_funds?( wallet, amount )
-    return true   if wallet == Centralbank.config.coinbase
+    return true   if Centralbank.config.coinbase?( wallet )
     @wallets.has_key?( wallet ) && @wallets[wallet] - amount >= 0
   end
 
@@ -20,7 +20,7 @@ private
   def apply_transactions( transactions )
     transactions.each do |tx|
       if sufficient_funds?(tx.from, tx.amount)
-        @wallets[tx.from] -= tx.amount   unless tx.from == Centralbank.config.coinbase
+        @wallets[tx.from] -= tx.amount   unless Centralbank.config.coinbase?( tx.from )
         @wallets[tx.to] ||= 0
         @wallets[tx.to] += tx.amount
       end

data/lib/centralbank/service.rb

@@ -12,9 +12,6 @@ module Centralbank
   PUBLIC_FOLDER = "#{Centralbank.root}/lib/centralbank/public"
   VIEWS_FOLDER  = "#{Centralbank.root}/lib/centralbank/views"
 
-  puts "[centralbank] boot - setting public folder to: #{PUBLIC_FOLDER}"
-  puts "[centralbank] boot - setting views folder to: #{VIEWS_FOLDER}"
-
   set :public_folder, PUBLIC_FOLDER # set up the static dir (with images/js/css inside)
   set :views, VIEWS_FOLDER # set up the views dir
 
@@ -24,24 +21,6 @@ module Centralbank
   set connections: []
 
 
-    #########
-    ## return network node (built and configured on first use)
-    ##   fix: do NOT use @@ - use a class level method or something
-    def node
-      if defined?( @@node )
-        @@node
-      else
-        puts "[debug] centralbank - build (network) node (address: #{Centralbank.config.address})"
-        @@node = Node.new( address: Centralbank.config.address )
-        @@node
-      end
-      ####
-      ## check why this is a syntax error:
-      ## @node ||= do
-      ##   puts "[debug] centralbank - build (network) node (address: #{Centralbank.config.address})"
-      ##   @node = Node.new( address: Centralbank.config.address )
-      ## end
-    end
 
   get '/style.css' do
     scss :style    ## note: converts (pre-processes) style.scss to style.css
@@ -107,7 +86,27 @@ module Centralbank
       out.callback { settings.connections.delete(out) }
     end
   end
-  
+
+private
+
+#########
+## return network node (built and configured on first use)
+##   fix: do NOT use @@ - use a class level method or something
+def node
+  if defined?( @@node )
+    @@node
+  else
+    puts "[debug] centralbank - build (network) node (address: #{Centralbank.config.address})"
+    @@node = Node.new( address: Centralbank.config.address )
+    @@node
+  end
+  ####
+  ## check why this is a syntax error:
+  ## @node ||= do
+  ##   puts "[debug] centralbank - build (network) node (address: #{Centralbank.config.address})"
+  ##   @node = Node.new( address: Centralbank.config.address )
+  ## end
+end
 
   end # class Service
 

data/lib/centralbank/version.rb

@@ -2,7 +2,7 @@
 
 module Centralbank
 
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 
   def self.root
     "#{File.expand_path( File.dirname(File.dirname(File.dirname(__FILE__))) )}"

data/lib/centralbank/views/_blockchain.erb

@@ -23,7 +23,7 @@
                 $<%= tx.amount %>
               </td>
               <td>
-                <%= tx.from[0..7] %> → <%= tx.to[0..7] %>
+                <%= tx.from[0..15] %> → <%= tx.to[0..15] %>
               </td>
             </tr>
           <% end %>
@@ -31,4 +31,7 @@
       </div>
     <% end %>
   </div>
+  <p>
+    †: Miner Transaction - New $$ on the Market!
+  </p>
 </div>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: centralbank
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Gerald Bauer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-24 00:00:00.000000000 Z
+date: 2017-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra