lisk 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5ae0ec3ce26db828b0aae312d3caaa44a0c4dce7
-  data.tar.gz: ea7aab7e631ce1324b4be92fd364392c7dbc1b5c
+  metadata.gz: 915e70fda8a22aecbe253bfc7af695ce480f0411
+  data.tar.gz: 4936943b9255d984bc0669f6056c2294742643fb
 SHA512:
-  metadata.gz: 1602e278569adf67a0219260721333fd93218c4d8249f5c076647bf6719353f6a1e1004708f40c7ffff64a1138efbc696e750d8b798716f7123c2de95a1f1469
-  data.tar.gz: ce32d974e5623ca732af30f88813ca5734c6e01be2097cf9791386f9b67321c856d6e7a06220a248be6e544090858e7c731598aba7966d1097f5e8bc444ac221
+  metadata.gz: e1bbda2e1c0b9e08207ad2986483815884b5d7d947d613b3c94b74240b7da8ede1981b8e5a0c8301323ff62abea1ac4ae1a6b86ffb39e61939dffb282748266c
+  data.tar.gz: fc4bba4a3049851f79df439beeb9cab8852c08ad6b8929878248560af50dffef3e7b1748ad770825b86b548f7529ffc027cf470e89be94cb63659415f79d35b9

data/bin/debug

@@ -6,4 +6,5 @@ gem uninstall lisk
 rm pkg/*.gem
 git add -A
 bundle exec rake install
-ruby example.rb
+ruby examples/status.rb
+ruby examples/payout.rb

data/examples/payout.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'lisk'
+
+# Try to connect a local Lisk client on test network.
+# Warning: Think twice and test thoroughly before enabling this on main network!
+client = Lisk::Client.new "127.0.0.1", 7000
+
+# The pre-1.0.0 legacy API connected to the client.
+legacy_api = Lisk::Legacy.new client
+
+# Only proceed if the client is connected, active, and fully synchronized.
+if legacy_api.ping
+
+  # Get the desired delegate by name.
+  delegate = legacy_api.delegates_get_by_name "4fryn"
+  p "Delegate #{delegate["username"]} is rank \##{delegate["rank"]} with #{delegate["approval"]}\% approval and #{delegate["productivity"]}\% productivity."
+
+  # Get a list of voters for a delegate.
+  deleagte_public_key = delegate["publicKey"]
+  deleagte_address = delegate["address"]
+  deleagte_voters = legacy_api.delegates_voters deleagte_public_key
+
+  # Get the total vote weight of our delegate
+  deleagte_total_weight = delegate["vote"].to_f
+
+  # Get the forging rewards from balance
+  payout_balance = legacy_api.accounts_get_balance deleagte_address
+  payout_balance = payout_balance["balance"].to_f
+
+  # Our pool is sharing 80%, and keeping 20%
+  pool_share = 0.80
+
+  # Filter out voters with out any Lisk
+  voter_threshold = 0
+
+  _debug_payout_sum = 0
+
+  # Iterate all voters
+  deleagte_voters.each do | voter |
+    voter_balance = voter["balance"].to_f
+
+    # Only handle voters with balance above threshold
+    if voter_balance > voter_threshold # and not voter["address"].eql? deleagte_address
+      voter_share = voter["balance"].to_f / deleagte_total_weight
+      payout = voter_share * payout_balance * pool_share
+      # @TODO: do some handling of dust amounts
+      # @TODO: do sanity checks and create transactions here ...
+      p "Sending #{payout / 1e8} LSK to voter #{voter["address"]}..."
+      _debug_payout_sum += payout
+    end
+  end
+
+  # @TODO: sending 20% delegate share to her private address
+  p "Sending #{payout_balance * 0.20 / 1e8} LSK to delegate private funds..."
+
+  # Should not fail
+  _debug_payout_sum += payout_balance * 0.20
+  _debug_payout_diff = payout_balance - _debug_payout_sum
+  fail if not _debug_payout_diff === 0
+
+
+else
+  p 'Lisk node disconnected, inactive, or not fully synchronized ...'
+end
+
+#account = Lisk::Account.new("14524922419337843943L")
+#client.get_address(account)
+#block = Lisk::Block.new("11145685198263496703")
+#delegate = Lisk::Delegate.new("lightcurve")
+#client.get_address(delegate)
+#client.get_voters(delegate)
+#transaction = Lisk::Transaction.new("10153999325502978458")

data/{example.rb → examples/status.rb}

@@ -6,22 +6,31 @@ require 'lisk'
 client = Lisk::Client.new
 
 # Configure host and port of the Lisk client
-client.configure "127.0.0.1", 8000
+client = client.configure "127.0.0.1", 8000
 
 # Same as above, just in one line
 client = Lisk::Client.new "127.0.0.1", 8000
 
-if client.ping
-  version = client.version
+# The pre-1.0.0 legacy API connected to the client
+legacy_api = Lisk::Legacy.new client
+
+# Only proceed if the client is connected, active, and fully synchronized
+if legacy_api.ping
+
+  # Lisk version API example
+  version = legacy_api.version
   p "Lisk node version #{version["version"]} build #{version["build"]}..."
 
-  status = client.status
+  # Lisk node status API example
+  status = legacy_api.status
   p "Lisk node is connected: #{status["success"]}... Blockchain loaded: #{status["loaded"]}..."
 
-  syncing = client.sync
+  # Lisk node syncing API example
+  syncing = legacy_api.sync
   p "Lisk node is syncing: #{syncing["syncing"]}... #{syncing["blocks"]} remaining blocks to latest block #{syncing["height"]}..."
 
-  peers = client.peers
+  # Lisk node peers API example
+  peers = legacy_api.peers
   cond = 0
   disd = 0
   band = 0
@@ -37,16 +46,10 @@ if client.ping
   end
   p "Lisk node saw #{peers.count} peers... #{cond} connected, #{disd} disconnected, #{band} banned..."
 
-  chain = client.chain
+  # Lisk blockchain API example
+  chain = legacy_api.chain
   p "Lisk chain latest block: #{chain["height"]}... total supply: #{chain["supply"] / 1e8}... block reward: #{chain["reward"] / 1e8}"
+
 else
-  p 'Lisk node disconnected or inactive ...'
+  p 'Lisk node disconnected, inactive, or not fully synchronized ...'
 end
-
-#account = Lisk::Account.new("14524922419337843943L")
-#client.get_address(account)
-#block = Lisk::Block.new("11145685198263496703")
-#delegate = Lisk::Delegate.new("lightcurve")
-#client.get_address(delegate)
-#client.get_voters(delegate)
-#transaction = Lisk::Transaction.new("10153999325502978458")

data/lib/lisk.rb

@@ -1,10 +1,12 @@
 require "lisk/version"
 require "todonotes"
 
+# The Lisk API Ruby wrapper gem.
 module Lisk
   require "lisk/client"
+  require "lisk/legacy"
 
-  # Unimplemented methods
+  # Handles unimplemented methods
   def self.method_missing
     todo "#{self}::#{__method__} METHOD MISSING"
   end

data/lib/lisk/client.rb

@@ -2,69 +2,116 @@ require "net/http"
 require "uri"
 require "json"
 
+# The Lisk API Ruby wrapper gem.
 module Lisk
+
+  # A simple HTTP client connecting to a Lisk Core API node.
   class Client
 
-    attr_accessor :host, :port
+    # Host and port of the API endpoint.
+    attr_accessor :host, :port, :ssl
 
+    # Initializes the Lisk HTTP client and defaults to localhost port 8000.
     def initialize host = "127.0.0.1", port = 8000
       @host = host
       @port = port
+      @ssl = false
+      if self.is_alive?
+        return self
+      else
+        return nil
+      end
     end
 
+    # Allows reconfiguring of the Lisk HTTP client's host and port.
     def configure host, port
       if not host.empty? or not port.empty?
         @host = host
         @port = port
+        @ssl = false
+        if self.is_alive?
+          return self
+        else
+          return nil
+        end
+      else
+        return nil
       end
     end
 
-    def query endpoint
-      node = ::Net::HTTP.new @host, @port
-      uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
-      request = ::Net::HTTP::Get.new uri
-      response = node.request request
-      result = JSON::parse response.body
-    end
-
     # Get the status of last received block.
     # Returns true if block was received in the past 120 seconds.
-    def ping
-      ping = self.query "loader/status/ping"
-      ping["success"]
+    def is_alive?
+      connected = self.query_get "loader/status/ping"
+      connected["success"]
     end
 
-    # Returns the sync status of the blockchain.
-    def status
-      status = self.query "loader/status"
-    end
-
-    # Get the synchronization status of the client.
-    def sync
-      sync = self.query "loader/status/sync"
-    end
-
-    # Gets list of peers.
-    def peers
-      peers = self.query "peers"
-      if peers["success"]
-        return peers["peers"]
-      else
-        return peers
+    # Handles GET requests to the given Lisk Core API endpoint
+    def query_get endpoint, params = nil
+      if not @ssl
+        # fixme "#{self}::#{__method__} Allow HTTPS requests"
+        begin
+          node = ::Net::HTTP.new @host, @port
+          uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
+          if not params.nil?
+            uri.query = URI.encode_www_form params
+          end
+          request = ::Net::HTTP::Get.new uri
+          response = node.request request
+          result = JSON::parse response.body
+        rescue Timeout::Error => e
+          p "Can't connect to the Lisk node: Timeout!"
+        rescue Errno::EHOSTUNREACH => e
+          p "Can't connect to the Lisk node: Host Unreachable!"
+        rescue Errno::ECONNREFUSED => e
+          p "Can't connect to the Lisk node: Connection Refused!"
+        end
       end
     end
 
-    # Gets version and build time.
-    def version
-      version = self.query "peers/version"
+    # Handles POST requests to the given Lisk Core API endpoint
+    def query_post endpoint, params
+      if not @ssl
+        # fixme "#{self}::#{__method__} Allow HTTPS requests"
+        begin
+          node = ::Net::HTTP.new @host, @port
+          uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
+          uri.query = URI.encode_www_form params
+          request = ::Net::HTTP::POST.new uri
+          response = node.request request
+          result = JSON::parse response.body
+        rescue Timeout::Error => e
+          p "Can't connect to the Lisk node: Timeout!"
+        rescue Errno::EHOSTUNREACH => e
+          p "Can't connect to the Lisk node: Host Unreachable!"
+        rescue Errno::ECONNREFUSED => e
+          p "Can't connect to the Lisk node: Connection Refused!"
+        end
+      end
     end
 
-    # Gets status of height, fee, milestone, blockreward and supply.
-    def chain
-      chain = self.query "blocks/getStatus"
+    # Handles PUT requests to the given Lisk Core API endpoint
+    def query_put endpoint, params
+      if not @ssl
+        # fixme "#{self}::#{__method__} Allow HTTPS requests"
+        begin
+          node = ::Net::HTTP.new @host, @port
+          uri = URI.parse "http://#{host}:#{port}/api/#{endpoint}"
+          uri.query = URI.encode_www_form params
+          request = ::Net::HTTP::Put.new uri
+          response = node.request request
+          result = JSON::parse response.body
+        rescue Timeout::Error => e
+          p "Can't connect to the Lisk node: Timeout!"
+        rescue Errno::EHOSTUNREACH => e
+          p "Can't connect to the Lisk node: Host Unreachable!"
+        rescue Errno::ECONNREFUSED => e
+          p "Can't connect to the Lisk node: Connection Refused!"
+        end
+      end
     end
 
-    # Unimplemented methods
+    # Handles unimplemented methods
     def method_missing(name, *args, &block)
       todo "#{self}::#{name} METHOD MISSING"
     end

data/lib/lisk/legacy.rb

@@ -0,0 +1,102 @@
+# The Lisk API Ruby wrapper gem.
+module Lisk
+
+  # Implements legacy APIs of the Lisk Core pre-1.0.0 node
+  class Legacy
+
+    # A "lisk/client" connecting to a Lisk Core API node.
+    attr_accessor :client
+
+    # Initializing the legacy API with a legacy Lisk Core API client.
+    def initialize client
+      if not client.nil?
+        @client = client
+        return self
+      else
+        return nil
+      end
+    end
+
+    # Get the status of last received block.
+    # Returns true if block was received in the past 120 seconds.
+    def ping
+      ping = @client.query_get "loader/status/ping"
+      ping["success"]
+    end
+
+    # Returns the sync status of the blockchain.
+    def status
+      status = @client.query_get "loader/status"
+    end
+
+    # Get the synchronization status of the client.
+    def sync
+      sync = @client.query_get "loader/status/sync"
+    end
+
+    # Gets list of peers.
+    def peers
+      peers = @client.query_get "peers"
+      if peers["success"]
+        return peers["peers"]
+      else
+        return nil
+      end
+    end
+
+    # Gets version and build time.
+    def version
+      version = @client.query_get "peers/version"
+    end
+
+    # Gets status of height, fee, milestone, blockreward and supply.
+    def chain
+      chain = @client.query_get "blocks/getStatus"
+    end
+
+    # Gets delegate by username.
+    def delegates_get_by_name user_name
+      params = { :username => user_name }
+      delegate = @client.query_get "delegates/get", params
+      if delegate["success"]
+        return delegate["delegate"]
+      else
+        return nil
+      end
+    end
+
+    # Gets delegate by public key.
+    def delegates_get_by_key public_key
+      params = { :publicKey => public_key }
+      delegate = @client.query_get "delegates/get", params
+      if delegate["success"]
+        return delegate["delegate"]
+      else
+        return nil
+      end
+    end
+
+    # Gets voters of delegate.
+    def delegates_voters public_key
+      params = { :publicKey => public_key }
+      voters = @client.query_get "delegates/voters", params
+      if voters["success"]
+        return voters["accounts"]
+      else
+        return nil
+      end
+    end
+
+    # Request the balance of an account.
+    def accounts_get_balance address
+      params = { :address => address }
+      balance = @client.query_get "accounts/getBalance", params
+    end
+
+    # Handles unimplemented methods
+    def method_missing(name, *args, &block)
+      todo "#{self}::#{name} METHOD MISSING"
+    end
+
+  end
+end

data/lib/lisk/version.rb

@@ -1,3 +1,3 @@
 module Lisk
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lisk
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - 4fryn Dings
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,9 +84,11 @@ files:
 - bin/console
 - bin/debug
 - bin/setup
-- example.rb
+- examples/payout.rb
+- examples/status.rb
 - lib/lisk.rb
 - lib/lisk/client.rb
+- lib/lisk/legacy.rb
 - lib/lisk/version.rb
 - lisk.gemspec
 homepage: https://github.com/4fryn/lisk.rb