centralbank 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 202c231a695058fedcfd45734447b823ecec5943
-  data.tar.gz: 793bcbc06a672be4a32f417b2c0c145cca9dace8
+SHA256:
+  metadata.gz: 88f50459e3ecf1ffde61049250241fd50a9bd059662e3c823243ca74413ce6d6
+  data.tar.gz: bf0ebbf7e3d723e195f8cbc2eef52784a8d05340a782070dd2fd65b78fdba129
 SHA512:
-  metadata.gz: 8fd3ac2058c57dffcf3050124609d1fc6cad9f49a8e543e06a20d26b809d31b3ed5053f757e02fe736d0080c6c209736cb8afff9b0d230d325ac0b3a113cfd66
-  data.tar.gz: 6e7a6fad83c6cd24336ef5d074c7136f1e3f5153bd74d2979464fdfc914a1d859b25c1027ceac4570df7092a3ed23c12d8c356714ebedcbeecaf421cae7fd643
+  metadata.gz: ff627e08bec25b65d1d40dff8c40d73cc20cb2cab1ba6b3852159709c6ec7521e6bf0f6e5d4974ce7801b6f00c97162be2f1f9d3877b500fd7aab16e162d7c0f
+  data.tar.gz: 31c6a909d89ca88496f93134a8eb24b2b860f7d7e3e5f6bc14fc642f3319804ac509e77406193e15e94266aabe3fb74e9cb017c8005590f5b3534cb3391e1c97

data/Manifest.txt

@@ -1,5 +1,4 @@
-HISTORY.md
-LICENSE.md
+CHANGELOG.md
 Manifest.txt
 README.md
 Rakefile

data/README.md

@@ -1,112 +1,122 @@
-# centralbank library / gem and command line tool
-
-print your own money / cryptocurrency; run your own federated central bank nodes on the blockchain peer-to-peer over HTTP; revolutionize the world one block at a time
-
-
-* home  :: [github.com/openblockchains/centralbank](https://github.com/openblockchains/centralbank)
-* bugs  :: [github.com/openblockchains/centralbank/issues](https://github.com/openblockchains/centralbank/issues)
-* gem   :: [rubygems.org/gems/centralbank](https://rubygems.org/gems/centralbank)
-* rdoc  :: [rubydoc.info/gems/centralbank](http://rubydoc.info/gems/centralbank)
-
-
-## Command Line
-
-Use the `centralbank` command line tool. Try:
-
-```
-$ 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.:
-
-``` ruby
-# Gemfile
-
-source "https://rubygems.org"
-
-gem 'sinatra'
-gem 'sass'
-gem 'blockchain-lite'
-```
-
-run
-
-```
-$ bundle       ## will use the Gemfile (see above)
-```
-
-and now you're ready to run your own centralbank server node. Use the [`config.ru`](config.ru) script for rack:
-
-``` ruby
-# config.ru
-
-$LOAD_PATH << './lib'
-
-require 'centralbank'
-
-run Centralbank::Service
-```
-
-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! Happy mining!
-
-
-
-## License
-
-![](https://publicdomainworks.github.io/buttons/zero88x31.png)
-
-The `centralbank` scripts are dedicated to the public domain.
-Use it as you please with no restrictions whatsoever.
+# centralbank
+
+central bank library / gem and command line tool -
+print your own money / cryptocurrency; run your own federated central bank nodes on the blockchain peer-to-peer over HTTP; revolutionize the world one block at a time
+
+
+* home  :: [github.com/rubycoco/blockchain](https://github.com/rubycoco/blockchain)
+* bugs  :: [github.com/rubycoco/blockchain/issues](https://github.com/rubycoco/blockchain/issues)
+* gem   :: [rubygems.org/gems/centralbank](https://rubygems.org/gems/centralbank)
+* rdoc  :: [rubydoc.info/gems/centralbank](http://rubydoc.info/gems/centralbank)
+
+
+
+## Command Line
+
+Use the `centralbank` command line tool. Try:
+
+```
+$ 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.:
+
+``` ruby
+# Gemfile
+
+source "https://rubygems.org"
+
+gem 'sinatra'
+gem 'sass'
+gem 'blockchain-lite'
+```
+
+run
+
+```
+$ bundle       ## will use the Gemfile (see above)
+```
+
+and now you're ready to run your own centralbank server node. Use the [`config.ru`](config.ru) script for rack:
+
+``` ruby
+# config.ru
+
+$LOAD_PATH << './lib'
+
+require 'centralbank'
+
+run Centralbank::Service
+```
+
+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! Happy mining!
+
+
+
+
+## References
+
+[**Programming Cryptocurrencies and Blockchains (in Ruby)**](http://yukimotopress.github.io/blockchains) by Gerald Bauer et al, 2018, Yuki & Moto Press
+
+And many more @ [**Best of Crypto Books**](https://openblockchains.github.io/crypto-books/) - a collection of books, white papers & more about crypto and blockchains
+
+
+## License
+
+![](https://publicdomainworks.github.io/buttons/zero88x31.png)
+
+The `centralbank` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -8,14 +8,14 @@ Hoe.spec 'centralbank' do
   self.summary = 'centralbank - print your own money / cryptocurrency; run your own federated central bank nodes on the blockchain peer-to-peer over HTTP; revolutionize the world one block at a time'
   self.description = summary
 
-  self.urls    = ['https://github.com/openblockchains/centralbank']
+  self.urls    = { home: 'https://github.com/rubycoco/blockchain' }
 
   self.author  = 'Gerald Bauer'
   self.email   = 'ruby-talk@ruby-lang.org'
 
   # switch extension to .markdown for gihub formatting
   self.readme_file  = 'README.md'
-  self.history_file = 'History.md'
+  self.history_file = 'CHANGELOG.md'
 
   self.extra_deps = [
     ['sinatra', '>=2.0'],

data/lib/centralbank/bank.rb

@@ -1,109 +1,109 @@
-
-
-class Bank
-  attr_reader :pending, :chain, :ledger
-
-
-  def initialize( address )
-    @address = address
-
-    ## note: add address name for now to cache
-    ##          allows to start more nodes in same folder / directory
-    @cache = Cache.new( "data.#{address.downcase}.json" )
-    h = @cache.read
-    if h
-      ## restore blockchain
-      @chain = Blockchain.from_json( h['chain'] )
-      ## restore pending (unconfirmed) transactions pool too
-      @pending = Pool.from_json( h['transactions'] )
-    else
-      @chain   = Blockchain.new
-      @chain  << [Tx.new( Centralbank.config.rand_coinbase,
-                          @address,
-                          Centralbank.config.mining_reward )]    # genesis (big bang!) starter block
-      @pending = Pool.new
-    end
-
-    ## update ledger (balances) with confirmed transactions
-    @ledger = Ledger.new( @chain )
-  end
-
-
-
-  def mine_block!
-    add_transaction( Tx.new( Centralbank.config.rand_coinbase,
-                             @address,
-                             Centralbank.config.mining_reward ))
-
-    ## add mined (w/ computed/calculated hash) block
-    @chain << @pending.transactions
-    @pending = Pool.new   ## clear out/ empty pool (just create a new one for now)
-
-    ## update ledger (balances) with new confirmed transactions
-    @ledger = Ledger.new( @chain )
-
-    @cache.write as_json
-  end
-
-
-  def sufficient_funds?( wallet, amount )
-    ## (convenience) delegate for ledger
-    ##  todo/check: use address instead of wallet - why? why not?
-    ##   for now single address wallet (that is, wallet==address)
-    @ledger.sufficient_funds?( wallet, amount )
-  end
-
-
-  def add_transaction( tx )
-    if tx.valid? && transaction_is_new?( tx )
-      @pending << tx
-      @cache.write as_json
-      return true
-    else
-      return false
-    end
-  end
-
-
-  ##
-  #  check - how to name incoming chain  - chain_new, chain_candidate - why? why not?
-  #    what's an intuitive name - what's gets used most often???
-
-  def resolve!( chain_new )
-    # TODO this does not protect against invalid block shapes (bogus COINBASE transactions for example)
-
-    if !chain_new.empty? && chain_new.last.valid? && chain_new.size > @chain.size
-      @chain  = chain_new
-      ## update ledger (balances) with new confirmed transactions
-      @ledger = Ledger.new( @chain )
-
-      ## document - keep only pending transaction not  yet (confirmed) in (new) blockchain ????
-      @pending.update!( @chain.transactions )
-      @cache.write as_json
-      return true
-    else
-      return false
-    end
-  end
-
-
-
-  def as_json
-    { chain:        @chain.as_json,
-      transactions: @pending.as_json
-    }
-  end
-
-
-
-private
-
-  def transaction_is_new?( tx_new )
-    ## check if tx exists already in blockchain or pending tx pool
-
-    ## todo: use chain.include?  to check for include
-    ##   avoid loop and create new array for check!!!
-    (@chain.transactions + @pending.transactions).none? { |tx| tx_new.id == tx.id }
-  end
-
-end  ## class Bank
+
+
+class Bank
+  attr_reader :pending, :chain, :ledger
+
+
+  def initialize( address )
+    @address = address
+
+    ## note: add address name for now to cache
+    ##          allows to start more nodes in same folder / directory
+    @cache = Cache.new( "data.#{address.downcase}.json" )
+    h = @cache.read
+    if h
+      ## restore blockchain
+      @chain = Blockchain.from_json( h['chain'] )
+      ## restore pending (unconfirmed) transactions pool too
+      @pending = Pool.from_json( h['transactions'] )
+    else
+      @chain   = Blockchain.new
+      @chain  << [Tx.new( Centralbank.config.rand_coinbase,
+                          @address,
+                          Centralbank.config.mining_reward )]    # genesis (big bang!) starter block
+      @pending = Pool.new
+    end
+
+    ## update ledger (balances) with confirmed transactions
+    @ledger = Ledger.new( @chain )
+  end
+
+
+
+  def mine_block!
+    add_transaction( Tx.new( Centralbank.config.rand_coinbase,
+                             @address,
+                             Centralbank.config.mining_reward ))
+
+    ## add mined (w/ computed/calculated hash) block
+    @chain << @pending.transactions
+    @pending = Pool.new   ## clear out/ empty pool (just create a new one for now)
+
+    ## update ledger (balances) with new confirmed transactions
+    @ledger = Ledger.new( @chain )
+
+    @cache.write as_json
+  end
+
+
+  def sufficient_funds?( wallet, amount )
+    ## (convenience) delegate for ledger
+    ##  todo/check: use address instead of wallet - why? why not?
+    ##   for now single address wallet (that is, wallet==address)
+    @ledger.sufficient_funds?( wallet, amount )
+  end
+
+
+  def add_transaction( tx )
+    if tx.valid? && transaction_is_new?( tx )
+      @pending << tx
+      @cache.write as_json
+      return true
+    else
+      return false
+    end
+  end
+
+
+  ##
+  #  check - how to name incoming chain  - chain_new, chain_candidate - why? why not?
+  #    what's an intuitive name - what's gets used most often???
+
+  def resolve!( chain_new )
+    # TODO this does not protect against invalid block shapes (bogus COINBASE transactions for example)
+
+    if !chain_new.empty? && chain_new.last.valid? && chain_new.size > @chain.size
+      @chain  = chain_new
+      ## update ledger (balances) with new confirmed transactions
+      @ledger = Ledger.new( @chain )
+
+      ## document - keep only pending transaction not  yet (confirmed) in (new) blockchain ????
+      @pending.update!( @chain.transactions )
+      @cache.write as_json
+      return true
+    else
+      return false
+    end
+  end
+
+
+
+  def as_json
+    { chain:        @chain.as_json,
+      transactions: @pending.as_json
+    }
+  end
+
+
+
+private
+
+  def transaction_is_new?( tx_new )
+    ## check if tx exists already in blockchain or pending tx pool
+
+    ## todo: use chain.include?  to check for include
+    ##   avoid loop and create new array for check!!!
+    (@chain.transactions + @pending.transactions).none? { |tx| tx_new.id == tx.id }
+  end
+
+end  ## class Bank