ledger-lite 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8bb00328da0a43ae0598c37a0fdf2bbfb10879b1
-  data.tar.gz: d86879ffe02cc2d2eb90995449de681855259903
+  metadata.gz: 2913a46758e571674fbeddb848ddfab228a2eace
+  data.tar.gz: 6783620e8081c675eb912810e8491ed781b53a8c
 SHA512:
-  metadata.gz: e90be7b13645162660fa2c0d1a0c19f816a97d1d8cd531e073039e27a24187a57526a8ca46c603229724ae3c25355416ab179810ea6c6f88573deea9ef7a698d
-  data.tar.gz: 522966950666004944338587eb7dfe07a2af5d9e3708d22913f4200ada59bfd432dd63ccf29f21c9781834617a745ec98634825e97854972386e6e460e46c7e1
+  metadata.gz: 3f71518005dbf46557c6dbc807dc23fd363dc872ec41129bdde74d7c91df69866b98503c58cf0debd5654162c665b15396c2b926d98535c4a1f49d56fe501901
+  data.tar.gz: afa5f7913b4d85a2b8c16bfbe46ab40d32c1f563f86c545c3cbb0593af5b643f91333f2da0477c95f944976460c74aaf9d4f60a9e21669642499f0a5787ca596

data/README.md

@@ -9,21 +9,22 @@ ledger-lite library / gem - hyper ledger book for the distributed blockchain int
 * rdoc  :: [rubydoc.info/gems/ledger-lite](http://rubydoc.info/gems/ledger-lite)
 
 
+
 ## Usage
 
 Let's add some transactions to the (hyper) ledger book:
 
-| From                | To           |   $ |
-|---------------------|--------------|----:|
-| Keukenhof (†)       | Vincent      |  11 |
-| Vincent             | Anne         |   3 |
-| Anne                | Julia        |   2 |
-| Julia               | Luuk         |   1 |
-|                     |              |     |
-| Dutchgrown (†)      | Ruben        |  11 |
-| Vincent             | Max          |   3 |
-| Ruben               | Julia        |   2 |
-| Anne                | Martijn      |   1 |
+| From                      | To           |   $ |
+|---------------------------|--------------|----:|
+| Central Bank (†)          | Vincent      |  11 |
+| Vincent                   | Anne         |   3 |
+| Anne                      | Julia        |   2 |
+| Julia                     | Luuk         |   1 |
+|                           |              |     |
+| De Nederlandsche Bank (†) | Ruben        |  11 |
+| Vincent                   | Max          |   3 |
+| Ruben                     | Julia        |   2 |
+| Anne                      | Martijn      |   1 |
 
 (†): Mining Transaction - New Dutch Gulden ($) on the Market!
 
@@ -35,15 +36,15 @@ Let's add some transactions to the (hyper) ledger book:
 
 ledger = Ledger.new
 
-ledger.send( "Keukenhof†",  "Vincent", 11 )
-ledger.send( "Vincent",     "Anne",     3 )
-ledger.send( "Anne",        "Julia",    2 )
-ledger.send( "Julia",       "Luuk",     1 )
+ledger.send( "Central Bank†",          "Vincent", 11 )
+ledger.send( "Vincent",                "Anne",     3 )
+ledger.send( "Anne",                   "Julia",    2 )
+ledger.send( "Julia",                  "Luuk",     1 )
 
-ledger.send( "Dutchgrown†", "Ruben",   11 )
-ledger.send( "Vincent",     "Max",      3 )
-ledger.send( "Ruben",       "Julia",    2 )
-ledger.send( "Anne",        "Martijn",  1 )
+ledger.send( "De Nederlandsche Bank†", "Ruben",   11 )
+ledger.send( "Vincent",                "Max",      3 )
+ledger.send( "Ruben",                  "Julia",    2 )
+ledger.send( "Anne",                   "Martijn",  1 )
 
 pp ledger   ## pp = pretty print
 
@@ -85,15 +86,15 @@ Or use transaction hashes:
 ``` ruby
 ledger = Ledger.new
 
-ledger.write(   from: "Keukenhof†",  to: "Vincent",  amount: 11 )
-ledger.write(   from: "Vincent",     to: "Anne",     amount:  3 )
-ledger.write(   from: "Anne",        to: "Julia",    amount:  2 )
-ledger.write(   from: "Julia",       to: "Luuk",     amount:  1 )
+ledger.write(   from: "Central Bank†",          to: "Vincent",  amount: 11 )
+ledger.write(   from: "Vincent",                to: "Anne",     amount:  3 )
+ledger.write(   from: "Anne",                   to: "Julia",    amount:  2 )
+ledger.write(   from: "Julia",                  to: "Luuk",     amount:  1 )
 
-ledger.write( { from: "Dutchgrown†", to: "Ruben",    amount: 11 },
-              { from: "Vincent",     to: "Max",      amount:  3 },
-              { from: "Ruben",       to: "Julia",    amount:  2 },
-              { from: "Anne",        to: "Martijn",  amount:  1 } )
+ledger.write( { from: "De Nederlandsche Bank†", to: "Ruben",    amount: 11 },
+              { from: "Vincent",                to: "Max",      amount:  3 },
+              { from: "Ruben",                  to: "Julia",    amount:  2 },
+              { from: "Anne",                   to: "Martijn",  amount:  1 } )
 
 pp ledger
 ```
@@ -103,15 +104,15 @@ Or use transaction (tx) classes/structs:
 ``` ruby
 ledger = Ledger.new
 
-ledger.write( Tx.new( "Keukenhof†",  "Vincent", 11 ))
-ledger.write( Tx.new( "Vincent",     "Anne",     3 ))
-ledger.write( Tx.new( "Anne",        "Julia",    2 ))
-ledger.write( Tx.new( "Julia",       "Luuk",     1 ))
+ledger.write( Tx.new( "Central Bank†",          "Vincent", 11 ))
+ledger.write( Tx.new( "Vincent",                "Anne",     3 ))
+ledger.write( Tx.new( "Anne",                   "Julia",    2 ))
+ledger.write( Tx.new( "Julia",                  "Luuk",     1 ))
 
-ledger.write( Tx.new( "Dutchgrown†", "Ruben",   11 ),
-              Tx.new( "Vincent",     "Max",      3 ),
-              Tx.new( "Ruben",       "Julia",    2 ),
-              Tx.new( "Anne",        "Martijn",  1 ))
+ledger.write( Tx.new( "De Nederlandsche Bank†", "Ruben",   11 ),
+              Tx.new( "Vincent",                "Max",      3 ),
+              Tx.new( "Ruben",                  "Julia",    2 ),
+              Tx.new( "Anne",                   "Martijn",  1 ))
 
 pp ledger
 ```
@@ -121,15 +122,15 @@ Or use the operator `<<` alias for `write`:
 ```ruby
 ledger = Ledger.new
 
-ledger <<  Tx.new( "Keukenhof†",  "Vincent", 11 )
-ledger <<  Tx.new( "Vincent",     "Anne",     3 )
-ledger <<  Tx.new( "Anne",        "Julia",    2 )
-ledger <<  Tx.new( "Julia",       "Luuk",     1 )
+ledger <<  Tx.new( "Central Bank†",          "Vincent", 11 )
+ledger <<  Tx.new( "Vincent",                "Anne",     3 )
+ledger <<  Tx.new( "Anne",                   "Julia",    2 )
+ledger <<  Tx.new( "Julia",                  "Luuk",     1 )
 
-ledger << [Tx.new( "Dutchgrown†", "Ruben",   11 ),
-           Tx.new( "Vincent",     "Max",      3 ),
-           Tx.new( "Ruben",       "Julia",    2 ),
-           Tx.new( "Anne",        "Martijn",  1 )]
+ledger << [Tx.new( "De Nederlandsche Bank†", "Ruben",   11 ),
+           Tx.new( "Vincent",                "Max",      3 ),
+           Tx.new( "Ruben",                  "Julia",    2 ),
+           Tx.new( "Anne",                   "Martijn",  1 )]
 
 pp ledger
 ```
@@ -141,14 +142,14 @@ Or use blocks of transaction hashes:
 
 ledger = Ledger.new
 
-ledger.write( Block.new( { from: "Keukenhof†",  to: "Vincent",    amount: 11 },
-                         { from: "Vincent",     to: "Anne",       amount:  3 },
-                         { from: "Anne",        to: "Julia",      amount:  2 },
-                         { from: "Julia",       to: "Luuk",       amount:  1 } ),
-              Block.new( { from: "Dutchgrown†", to: "Ruben",      amount: 11 },
-                         { from: "Vincent",     to: "Max",        amount:  3 },
-                         { from: "Ruben",       to: "Julia",      amount:  2 },
-                         { from: "Anne",        to: "Martijn",    amount:  1 } ))
+ledger.write( Block.new( { from: "Central Bank†",          to: "Vincent",    amount: 11 },
+                         { from: "Vincent",                to: "Anne",       amount:  3 },
+                         { from: "Anne",                   to: "Julia",      amount:  2 },
+                         { from: "Julia",                  to: "Luuk",       amount:  1 } ),
+              Block.new( { from: "De Nederlandsche Bank†", to: "Ruben",      amount: 11 },
+                         { from: "Vincent",                to: "Max",        amount:  3 },
+                         { from: "Ruben",                  to: "Julia",      amount:  2 },
+                         { from: "Anne",                   to: "Martijn",    amount:  1 } ))
 
 pp ledger
 ```
@@ -159,14 +160,14 @@ Or use blocks of transaction classes/structs:
 ``` ruby
 ledger = Ledger.new
 
-ledger.write( Block.new( Tx.new( "Keukenhof†",  "Vincent",  11 ),
-                         Tx.new( "Vincent",     "Anne",      3 ),
-                         Tx.new( "Anne",        "Julia",     2 ),
-                         Tx.new( "Julia",       "Luuk",      1 )),
-              Block.new( Tx.new( "Dutchgrown†", "Ruben",    11 ),
-                         Tx.new( "Vincent",     "Max",       3 ),
-                         Tx.new( "Ruben",       "Julia",     2 ),
-                         Tx.new( "Anne",        "Martijn",   1 )))
+ledger.write( Block.new( Tx.new( "Central Bank†",          "Vincent",  11 ),
+                         Tx.new( "Vincent",                "Anne",      3 ),
+                         Tx.new( "Anne",                   "Julia",     2 ),
+                         Tx.new( "Julia",                  "Luuk",      1 )),
+              Block.new( Tx.new( "De Nederlandsche Bank†", "Ruben",    11 ),
+                         Tx.new( "Vincent",                "Max",       3 ),
+                         Tx.new( "Ruben",                  "Julia",     2 ),
+                         Tx.new( "Anne",                   "Martijn",   1 )))
 
 pp ledger
 ```
@@ -176,23 +177,121 @@ Or use blocks of transaction classes/structs (with keyword arguments):
 ```ruby
 ledger = Ledger.new
 
-ledger.write( Block.new( Tx.new( from: "Keukenhof†",  to: "Vincent", amount: 11 ),
-                         Tx.new( from: "Vincent",     to: "Anne",    amount:  3 ),
-                         Tx.new( from: "Anne",        to: "Julia",   amount:  2 ),
-                         Tx.new( from: "Julia",       to: "Luuk",    amount:  1 )),
-              Block.new( Tx.new( from: "Dutchgrown†", to: "Ruben",   amount: 11 ),
-                         Tx.new( from: "Vincent",     to: "Max",     amount:  3 ),
-                         Tx.new( from: "Ruben",       to: "Julia",   amount:  2 ),
-                         Tx.new( from: "Anne",        to: "Martijn", amount:  1 )))
+ledger.write( Block.new( Tx.new( from: "Central Bank†",          to: "Vincent", amount: 11 ),
+                         Tx.new( from: "Vincent",                to: "Anne",    amount:  3 ),
+                         Tx.new( from: "Anne",                   to: "Julia",   amount:  2 ),
+                         Tx.new( from: "Julia",                  to: "Luuk",    amount:  1 )),
+              Block.new( Tx.new( from: "De Nederlandsche Bank†", to: "Ruben",   amount: 11 ),
+                         Tx.new( from: "Vincent",                to: "Max",     amount:  3 ),
+                         Tx.new( from: "Ruben",                  to: "Julia",   amount:  2 ),
+                         Tx.new( from: "Anne",                   to: "Martijn", amount:  1 )))
+
+pp ledger
+```
+
+# Bonus: Track Commodities, Collectibles or Assets
+
+Ledger Lite lets you design / create your own transactions. For example, let's use
+`from`, `to`, `qty` (quantity) and `name` (of commodity, collectible or asset).
+Override the `Ledger#unpack` method for "unpacking" arguments from transactions
+and the `Ledger#send` method for "committing" transactions:
+
+
+``` ruby
+def unpack( tx )
+  ## "unpack" from, to, qty, name values
+  if tx.is_a?( Hash )   ## support hashes
+    from   = tx[:from]
+    to     = tx[:to]
+    qty    = tx[:qty]
+    name   = tx[:name]
+  else   ## assume it's a transaction (tx) struct/class
+    from   = tx.from
+    to     = tx.to
+    qty    = tx.qty
+    name   = tx.name
+  end
+  [from,to,qty,name]
+end
+```
+
+and
+
+``` ruby
+def send( from, to, qty, name )
+  if sufficient?( from, qty, name )
+    if self.class.config.coinbase?( from )
+      # note: coinbase has unlimited supply!! magic happens here
+    else
+      @addr[ from ][ name ] -= qty
+    end
+    @addr[ to ] ||= {}     ## make sure addr exists (e.g. init with empty hash {})
+    @addr[ to ][ name ] ||= 0
+    @addr[ to ][ name ] += qty
+  end
+end
+```
+
+Now use the ledger with the new transaction format like:
+
+
+``` ruby
+ledger = Ledger.new
+
+ledger.send( "Keukenhof†",  "Vincent", 11, "Tulip Admiral van Eijck" )
+ledger.send( "Vincent",     "Anne",     3, "Tulip Admiral van Eijck" )
+ledger.send( "Anne",        "Julia",    2, "Tulip Admiral van Eijck" )
+ledger.send( "Julia",       "Luuk",     1, "Tulip Admiral van Eijck" )
+
+ledger.send( "Dutchgrown†", "Ruben",   11, "Tulip Semper Augustus"  )
+ledger.send( "Vincent",     "Max",      3, "Tulip Admiral van Eijck" )
+ledger.send( "Ruben",       "Julia",    2, "Tulip Semper Augustus" )
+ledger.send( "Anne",        "Martijn",  1, "Tulip Admiral van Eijck" )
+
+pp ledger   ## pp == pretty print
+```
+
+resulting in:
+
+```
+#<LedgerLite::Ledger
+ @addr={
+   "Vincent" => {"Tulip Admiral van Eijck" => 5},
+   "Anne"    => {"Tulip Admiral van Eijck" => 0},
+   "Julia"   => {"Tulip Admiral van Eijck" => 1, "Tulip Semper Augustus" => 2},
+   "Luuk"    => {"Tulip Admiral van Eijck" => 1},
+   "Ruben"   => {"Tulip Semper Augustus"   => 9},
+   "Max"     => {"Tulip Admiral van Eijck" => 3},
+   "Martijn" => {"Tulip Admiral van Eijck" => 1}}>
+```
+
+Or use blocks of transaction classes/structs (with keyword arguments):
+
+
+``` ruby
+ledger = Ledger.new
+
+ledger.write( Block.new( Tx.new( from: "Keukenhof†",  to: "Vincent", qty: 11, name: "Tulip Admiral van Eijck" ),
+                         Tx.new( from: "Vincent",     to: "Anne",    qty:  3, name: "Tulip Admiral van Eijck" ),
+                         Tx.new( from: "Anne",        to: "Julia",   qty:  2, name: "Tulip Admiral van Eijck" ),
+                         Tx.new( from: "Julia",       to: "Luuk",    qty:  1, name: "Tulip Admiral van Eijck" )),
+              Block.new( Tx.new( from: "Dutchgrown†", to: "Ruben",   qty: 11, name: "Tulip Semper Augustus" ),
+                         Tx.new( from: "Vincent",     to: "Max",     qty:  3, name: "Tulip Admiral van Eijck" ),
+                         Tx.new( from: "Ruben",       to: "Julia",   qty:  2, name: "Tulip Semper Augustus" ),
+                         Tx.new( from: "Anne",        to: "Martijn", qty:  1, name: "Tulip Admiral van Eijck" )))
 
 pp ledger
 ```
 
+And so on and on.
+
+
 
 
 ## Ledger Lite in the Real World
 
 - [**centralbank**](https://github.com/openblockchains/centralbank) - command line tool (and core library) - 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
+- [**tulipmania**](https://github.com/openblockchains/tulipmania) - command line tool (and core library) - tulips on the blockchain; learn by example from the real world (anno 1637) - buy! sell! hodl! enjoy the beauty of admiral of admirals, semper augustus, and more; run your own hyper ledger tulip exchange nodes on the blockchain peer-to-peer over HTTP; revolutionize the world one block at a time
 - [**shilling**](https://github.com/bitshilling/bitshilling.tools) - 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
 - You? Add your tool / service
 

data/lib/ledger-lite/base.rb

@@ -90,6 +90,11 @@ class Base
     if args.size == 1 && args[0].is_a?( Array )
       puts " unwrap array in array"
       blks_or_txns = args[0]   ## "unwrap" array in array
+    elsif args.size == 1 && defined?( Blockchain ) && args[0].is_a?( Blockchain )
+      ## support passing in of "top-level" defined blockchain class if defined
+      ##  pass along all blocks ("unwrapped" from blockchain)
+      blks_or_txns = []
+      args[0].each { |b| blks_or_txns << b }
     else
       blks_or_txns = args      ## use "auto-wrapped" splat array
     end

data/lib/ledger-lite/version.rb

@@ -5,7 +5,7 @@ module LedgerLite
 
   MAJOR = 1
   MINOR = 1
-  PATCH = 0
+  PATCH = 1
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 
   def self.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledger-lite
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Gerald Bauer