shilling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7c48c6763c71aa3e8a80d954e1369691d06d1434
+  data.tar.gz: 3ef89982be97773871b268c382282d64ea044b6e
+SHA512:
+  metadata.gz: 5c0b2c9a620f33779d21027211ea77f46707ee365490a9870dc7f09da8c114fc470c47b2b95bc6b569d8fbb67b45bf28fea883128ff1c5b61e64259b79bf9439
+  data.tar.gz: 8959cd16c9f051b037c0a7a403cac66f1c617e1efe2a0d6542eee4b1d008a8bf2f5dbb83fb5b70e3ecb0dc90c4f687285f6f862f7792ee1241d55586c3336720

data/HISTORY.md

@@ -0,0 +1,3 @@
+### 0.1.0 / 2017-12-26
+
+* Everything is new. First release.

data/LICENSE.md

@@ -0,0 +1,116 @@
+CC0 1.0 Universal
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator and
+subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for the
+purpose of contributing to a commons of creative, cultural and scientific
+works ("Commons") that the public can reliably and without fear of later
+claims of infringement build upon, modify, incorporate in other works, reuse
+and redistribute as freely as possible in any form whatsoever and for any
+purposes, including without limitation commercial purposes. These owners may
+contribute to the Commons to promote the ideal of a free culture and the
+further production of creative, cultural and scientific works, or to gain
+reputation or greater distribution for their Work in part through the use and
+efforts of others.
+
+For these and/or other purposes and motivations, and without any expectation
+of additional consideration or compensation, the person associating CC0 with a
+Work (the "Affirmer"), to the extent that he or she is an owner of Copyright
+and Related Rights in the Work, voluntarily elects to apply CC0 to the Work
+and publicly distribute the Work under its terms, with knowledge of his or her
+Copyright and Related Rights in the Work and the meaning and intended legal
+effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not limited
+to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display, communicate,
+  and translate a Work;
+
+  ii. moral rights retained by the original author(s) and/or performer(s);
+
+  iii. publicity and privacy rights pertaining to a person's image or likeness
+  depicted in a Work;
+
+  iv. rights protecting against unfair competition in regards to a Work,
+  subject to the limitations in paragraph 4(a), below;
+
+  v. rights protecting the extraction, dissemination, use and reuse of data in
+  a Work;
+
+  vi. database rights (such as those arising under Directive 96/9/EC of the
+  European Parliament and of the Council of 11 March 1996 on the legal
+  protection of databases, and under any national implementation thereof,
+  including any amended or successor version of such directive); and
+
+  vii. other similar, equivalent or corresponding rights throughout the world
+  based on applicable law or treaty, and any national implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention of,
+applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and
+unconditionally waives, abandons, and surrenders all of Affirmer's Copyright
+and Related Rights and associated claims and causes of action, whether now
+known or unknown (including existing as well as future claims and causes of
+action), in the Work (i) in all territories worldwide, (ii) for the maximum
+duration provided by applicable law or treaty (including future time
+extensions), (iii) in any current or future medium and for any number of
+copies, and (iv) for any purpose whatsoever, including without limitation
+commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes
+the Waiver for the benefit of each member of the public at large and to the
+detriment of Affirmer's heirs and successors, fully intending that such Waiver
+shall not be subject to revocation, rescission, cancellation, termination, or
+any other legal or equitable action to disrupt the quiet enjoyment of the Work
+by the public as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason be
+judged legally invalid or ineffective under applicable law, then the Waiver
+shall be preserved to the maximum extent permitted taking into account
+Affirmer's express Statement of Purpose. In addition, to the extent the Waiver
+is so judged Affirmer hereby grants to each affected person a royalty-free,
+non transferable, non sublicensable, non exclusive, irrevocable and
+unconditional license to exercise Affirmer's Copyright and Related Rights in
+the Work (i) in all territories worldwide, (ii) for the maximum duration
+provided by applicable law or treaty (including future time extensions), (iii)
+in any current or future medium and for any number of copies, and (iv) for any
+purpose whatsoever, including without limitation commercial, advertising or
+promotional purposes (the "License"). The License shall be deemed effective as
+of the date CC0 was applied by Affirmer to the Work. Should any part of the
+License for any reason be judged legally invalid or ineffective under
+applicable law, such partial invalidity or ineffectiveness shall not
+invalidate the remainder of the License, and in such case Affirmer hereby
+affirms that he or she will not (i) exercise any of his or her remaining
+Copyright and Related Rights in the Work or (ii) assert any associated claims
+and causes of action with respect to the Work, in either case contrary to
+Affirmer's express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+  a. No trademark or patent rights held by Affirmer are waived, abandoned,
+  surrendered, licensed or otherwise affected by this document.
+
+  b. Affirmer offers the Work as-is and makes no representations or warranties
+  of any kind concerning the Work, express, implied, statutory or otherwise,
+  including without limitation warranties of title, merchantability, fitness
+  for a particular purpose, non infringement, or the absence of latent or
+  other defects, accuracy, or the present or absence of errors, whether or not
+  discoverable, all to the greatest extent permissible under applicable law.
+
+  c. Affirmer disclaims responsibility for clearing rights of other persons
+  that may apply to the Work or any use thereof, including without limitation
+  any person's Copyright and Related Rights in the Work. Further, Affirmer
+  disclaims responsibility for obtaining any necessary consents, permissions
+  or other rights required for any use of the Work.
+
+  d. Affirmer understands and acknowledges that Creative Commons is not a
+  party to this document and has no duty or obligation with respect to this
+  CC0 or use of the Work.
+
+For more information, please see
+<http://creativecommons.org/publicdomain/zero/1.0/>

data/Manifest.txt

@@ -0,0 +1,26 @@
+HISTORY.md
+LICENSE.md
+Manifest.txt
+README.md
+Rakefile
+bin/shilling
+lib/shilling.rb
+lib/shilling/bank.rb
+lib/shilling/block.rb
+lib/shilling/blockchain.rb
+lib/shilling/cache.rb
+lib/shilling/ledger.rb
+lib/shilling/node.rb
+lib/shilling/pool.rb
+lib/shilling/service.rb
+lib/shilling/tool.rb
+lib/shilling/transaction.rb
+lib/shilling/version.rb
+lib/shilling/views/_blockchain.erb
+lib/shilling/views/_ledger.erb
+lib/shilling/views/_peers.erb
+lib/shilling/views/_pending_transactions.erb
+lib/shilling/views/_wallet.erb
+lib/shilling/views/index.erb
+lib/shilling/views/style.scss
+lib/shilling/wallet.rb

data/README.md

@@ -0,0 +1,115 @@
+# shilling (or schilling) command line tool (and core library)
+
+shilling (or schilling) on the blockchain! rock-solid alpine dollar from austria;
+print (mine) your own shillings; run your own federated shilling central bank nodes
+w/ public distributed (hyper) ledger book on the blockchain peer-to-peer over HTTP; revolutionize the world one block at a time with cryptos
+
+
+
+* home  :: [github.com/blockchainaustria/shilling.tools](https://github.com/blockchainaustria/shilling.tools)
+* bugs  :: [github.com/blockchainaustria/shilling.tools/issues](https://github.com/blockchainaustria/shilling.tools/issues)
+* gem   :: [rubygems.org/gems/shilling](https://rubygems.org/gems/shilling)
+* rdoc  :: [rubydoc.info/gems/shilling](http://rubydoc.info/gems/shilling)
+
+
+## Command Line
+
+Use the `shilling` command line tool. Try:
+
+```
+$ shilling -h     
+```
+
+resulting in:
+
+```
+Usage: shilling [options]
+
+  Wallet options:
+    -n, --name=NAME                  Address name (default: Theresa)
+
+  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, Theresa) and the default server host and port settings
+use:
+
+```
+$ shilling
+```
+
+Stand back ten feets :-) while starting up the machinery.
+Ready to print (mine) shillings on the blockchain?
+In your browser open up the page e.g. `http://localhost:4567`. Voila!
+
+![](shilling.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:
+
+```
+$ shilling -p 5678 -n Franz
+```
+
+Happy mining!
+
+
+
+## Local Development Setup
+
+For local development - clone or download (and unzip) the shilling.tools 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 shilling server node. Use the [`config.ru`](config.ru) script for rack:
+
+``` ruby
+# config.ru
+
+$LOAD_PATH << './lib'
+
+require 'shilling'
+
+run Shilling::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 `shilling` scripts are dedicated to the public domain.
+Use it as you please with no restrictions whatsoever.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'hoe'
+require './lib/shilling/version.rb'
+
+Hoe.spec 'shilling' do
+
+  self.version = Shilling::VERSION
+
+  self.summary = 'shilling (or schilling) on the blockchain! rock-solid alpine dollar from austria; print (mine) your own shillings; run your own federated shilling central bank nodes w/ public distributed (hyper) ledger book on the blockchain peer-to-peer over HTTP; revolutionize the world one block at a time with cryptos'
+  self.description = summary
+
+  self.urls    = ['https://github.com/blockchainaustria/shilling.tools']
+
+  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.extra_deps = [
+    ['sinatra', '>=2.0'],
+    ['sass'],   ## used for css style preprocessing (scss)
+    ['blockchain-lite', '>=1.3.1'],
+  ]
+
+  self.licenses = ['Public Domain']
+
+  self.spec_extras = {
+   required_ruby_version: '>= 2.3'
+  }
+
+end

data/bin/shilling

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

data/lib/shilling.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+# stdlibs
+require 'json'
+require 'digest'
+require 'net/http'
+require 'set'
+require 'pp'
+require 'optparse'    ## note: used for command line tool (see Tool in tool.rb)
+
+
+### 3rd party gems
+require 'sinatra/base'                         # note: use "modular" sinatra app / service
+
+require 'merkletree'
+require 'blockchain-lite/proof_of_work/block'  # note: use proof-of-work block only (for now)
+
+
+### our own code
+require 'shilling/version'    ## let version always go first
+require 'shilling/block'
+require 'shilling/cache'
+require 'shilling/transaction'
+require 'shilling/blockchain'
+require 'shilling/pool'
+require 'shilling/bank'
+require 'shilling/ledger'
+require 'shilling/wallet'
+
+require 'shilling/node'
+require 'shilling/service'
+
+require 'shilling/tool'    ## add (optional) command line tool
+
+
+
+
+
+module Shilling
+
+
+  class Configuration
+     ## user/node settings
+     attr_accessor :address   ## single wallet address (for now "clear" name e.g.Sepp, Franz, etc.)
+
+     WALLET_ADDRESSES = %w[Theresa Franz Antonia Maximilan Maria Ferdinand Elisabeth Adam Eva]
+
+     ## system/blockchain settings
+     attr_accessor :coinbase
+     attr_accessor :mining_reward
+
+     ## note: add a (†) coinbase  marker
+     COINBASE = ['Großglockner†', 'Wildspitze†', 'Großvenediger†',
+                 'Hochfeiler†', 'Zuckerhütl†', 'Hochalmspitze†',
+                 'Gr. Muntanitz†', 'Hoher Riffler†',
+                 'Parseierspitze†', 'Hoher Dachstein†'
+                ]
+
+
+     def initialize
+       ## try default setup via ENV variables
+       ## pick "random" address if nil (none passed in)
+       @address = ENV[ 'SHILLING_NAME'] || rand_address()
+
+       @coinbase = COINBASE         ## use a different name - why? why not?
+                                    ##  note: for now is an array (multiple coinbases)
+       @mining_reward = 43     ## use country code for austria (43)
+     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
+
+
+  ## lets you use
+  ##   Shilling.configure do |config|
+  ##      config.address = 'Sepp'
+  ##   end
+
+  def self.configure
+    yield( config )
+  end
+
+  def self.config
+    @config ||= Configuration.new
+  end
+
+
+  ## add command line binary (tool) e.g. $ try shilling -h
+  def self.main
+   Tool.new.run(ARGV)
+  end
+
+end # module Shilling
+
+
+# say hello
+puts Shilling::Service.banner

data/lib/shilling/bank.rb

@@ -0,0 +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( Shilling.config.rand_coinbase,
+                          @address,
+                          Shilling.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( Shilling.config.rand_coinbase,
+                             @address,
+                             Shilling.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