rubocoin 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 23ae9a1bfaaa6ec0518f256d1649f9cba77918ea
-  data.tar.gz: 858b1365052751d13e841dee809c60a120653493
+  metadata.gz: 365ffd4db337c10f99639d7526883d280435da29
+  data.tar.gz: a72276059952d79ec186c80508ea74d31fc53b85
 SHA512:
-  metadata.gz: 12ca76dcbbb042f28d7e30af56562304afbaa998d440b8de92d411d0628ddf4369a320802e3556f31e75f29ba391aaec806607aef798e2a3735471132924d741
-  data.tar.gz: e639fafe47e172fc48219b75e03fe5ed22f68d4a2bab778f1075e8b6337c83d78fdf14bf091cd3ebd907c5a25a3fafbf224b5f8449b887e302811ed15d6c8c7c
+  metadata.gz: 1df1a61ec58b94af660462e0ebb66209e3b4d61922a3c0a4387845259d3894fde1c22a2f5df6082426c74a63eac9b8f527f9176e87f5ad7b13f7e1afe18c8170
+  data.tar.gz: efe627cf10815684d5021bd93a3fc3cabd130aa9e675640b581c6d27dd2f333a3bcc2a6386479107443572d6b56c8e398de62bc1ac749c74d3eefb69fe75c942

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocoin (0.1.0)
+    rubocoin (0.1.1)
       colorize
       sinatra
 

data/README.md

@@ -7,12 +7,13 @@ This gem is the full node you can run on your machine to mine rubocoin and handl
 ## Installation
 
 You have 2 ways to get the rubocoin node (`rubocoind`). You can grab the source code
-or you can download the gem from (RubyGems)[https://rubygems.org].
+or you can download the gem from [RubyGems](https://rubygems.org).
 
 #### Installing from source
 
 ```
 $ git clone https://github.com/cbrnrd/RuboCoin
+$ cd RuboCoin
 $ bundle install
 $ bundle exec bin/rubocoind
 ```
@@ -28,7 +29,7 @@ $ rubocoind
 
 All you have to do is open port 44856 and run `rubocoind`.
 
-More command line options are coming in the near future.
+You can view the API documentation [here](http://www.rubydoc.info/gems/rubocoin/0.1.0)
 
 ## Development
 

data/lib/rubocoin.rb

@@ -1,6 +1,5 @@
 # Gems
 require 'sinatra'
-require 'json'
 require 'securerandom'
 require 'optparse'
 

data/lib/rubocoin/blockchain/blockchain.rb

@@ -45,18 +45,22 @@ class Blockchain
 
   #
   # Register a new node
+  # @param addr [String] the ip address of the node to add
   #
   def register_node(addr)
     url = URI.parse(addr)
     @nodes.add("#{url.host}:#{url.port}")
   end
 
-  # Return the most recent block in our chain
+  # Return the most recent block in the chain
   def last_block
     @chain[-1]
   end
 
+  #
   # Check whether a chain is valid
+  # @param chain [Array] the chain to validate
+  #
   def valid_chain(chain)
     last_block = chain[0]
     index = 1
@@ -80,6 +84,10 @@ class Blockchain
     true  # If we got here, all blocks are valid; therefore the chain is valid
   end
 
+  #
+  # Resolve conflicts with neighbour nodes. This gets the chain of each of
+  # the neighbour nodes and checks it with ours.
+  #
   def resolve_conflicts
     neighbour_nodes = @nodes
     new_chain = nil
@@ -113,6 +121,12 @@ class Blockchain
     return false
   end
 
+  #
+  # Adds a new block to the blockchain
+  # @see Blockchain#valid_proof
+  # @param proof [Integer] A valid value from the proof of work algorithm
+  # @param previous_hash [String] the hash of the previous block in the blockchain
+  #
   def new_block(proof, previous_hash=nil)
     # Define the block structure
     block =
@@ -174,11 +188,20 @@ class Blockchain
     last_block[:index] + 1
   end
 
+  #
+  # Hash the last block in the chain
+  # @param last_block [Hash] The last block in the chain
+  #
   def hash(last_block)
     block_string = last_block.sort.to_h.to_json
     return Digest::SHA256.hexdigest(block_string)
   end
 
+  #
+  # Iterates through integers until it finds a valid value
+  # @see Blockchain#valid_proof
+  # @param last_proof [Integer] the value of whatever the last PoW was
+  #
   def proof_of_work(last_proof)
     proof = -1
     proof += 1 until valid_proof(last_proof, proof)
@@ -186,6 +209,11 @@ class Blockchain
     return proof
   end
 
+  #
+  # Checks whether a value is a valid PoW
+  # @param last_proof [Integer] the value of whatever the last PoW was
+  # @param proof [Integer] the value to check
+  #
   def valid_proof(last_proof, proof)
     guess = "#{last_proof}#{proof}"
     guess_hash = Digest::SHA256.hexdigest(guess)

data/lib/rubocoin/core_extensions/json_ext.rb

@@ -1,6 +1,10 @@
 require 'json'
 
 module JSON
+  #
+  # Check whether the given json is valid
+  # @param json [String] the JSON to validate
+  #
   def self.is_valid?(json)
     begin
       JSON.parse(json)

data/lib/rubocoin/version.rb

@@ -1,3 +1,3 @@
 module Rubocoin
-  VERSION = "0.1.0"
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rubocoin
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - cbrnrd